Skip to content

Commit eebd43d

Browse files
committed
clarify which devices use this firmware
fixes #373
1 parent b8fe1ff commit eebd43d

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# OpenBikeSensor
1+
# Firmware for OpenBikeSensor Classic and OpenBikeSensor Pro
22

33
[![GitHub version](https://img.shields.io/github/v/release/openbikesensor/OpenBikeSensorFirmware)](https://github.com/openbikesensor/OpenBikeSensorFirmware/releases/latest)
44
[![GitHub version](https://img.shields.io/github/release-date/openbikesensor/OpenBikeSensorFirmware)](https://github.com/openbikesensor/OpenBikeSensorFirmware/releases/latest)
@@ -29,10 +29,8 @@ ultrasonic sensors connected to an ESP32.
2929

3030
## Description
3131

32-
Inspired by the Berlin project Radmesser. This version uses a simple push
33-
button at the handle bar to confirm distance-measures were actually overtaking
34-
vehicles. It has its own GPS, and a SD card for logging, so it does not
35-
require any additional hardware (like a smartphone).
32+
This is the firmware used for the [OpenBikeSensor Classic](https://www.openbikesensor.org/docs/classic/), our old and trusty yet complex-to-assemble workhorse
33+
as well as the [OpenBikeSensor Pro](https://www.openbikesensor.org/device/) (of which thus far only a few prototypes exist).
3634

3735
Starting with version v0.3 the firmware also exposes the measured data via
3836
[BLE bluetooth](https://github.com/openbikesensor/OpenBikeSensorFirmware/blob/master/docs/software/firmware/bluetooth_services.md).
@@ -56,14 +54,16 @@ documentation with different variants in the former
5654
For a more none technical description of the process switch to
5755
https://www.openbikesensor.org/docs/firmware/.
5856

59-
### Updating to 0.14.x
60-
Updating to 0.14.x will require you to download the latest release
57+
### Updating to 0.19.x
58+
Updating to 0.19.x will require you to download the latest release
6159
``firmware.bin`` and flash it using the **file upload** section in
6260
the firmware update screen.
6361

6462
The reason for this is that Github changed their SSL Certificate Root
6563
and the old Firmware did not trust the new certicate. Once you are
66-
at 0.14.x, updates will work as usual again.
64+
at 0.19.x, updates will work as usual again. For the future we have
65+
improved the upgrade mechanism to avoid the issue even when Github
66+
changes their authority again.
6767

6868
### Step By Step with version v0.7.x and above
6969

@@ -127,12 +127,13 @@ You can find the OpenBikeSensor documentation under:
127127

128128
## Getting Started Coding
129129

130-
1. You need a OpenBikeSensor in order to try work on the Firmware. [Head over to our Hardware Guide to assemble one](https://www.openbikesensor.org/docs/hardware/).
130+
1. You need an OpenBikeSensor Classic (or, in the near future alternatively an OpenBikeSensor Pro) in order to work on the firmware. [Head over to our hardware guide to assemble one](https://www.openbikesensor.org/docs/hardware/).
131131
2. Clone this repo: `git clone https://github.com/openbikesensor/OpenBikeSensorFirmware.git` and `cd` into it.
132132
3. Choose between developing with recommended [VSCode](https://www.openbikesensor.org/software/firmware/setup.html#vscode),
133133
or [CLion](https://www.openbikesensor.org/software/firmware/setup.html#clion) (license required),
134134
respectively [Arduino IDE](https://www.openbikesensor.org/software/firmware/setup.html#clion) (discouraged).
135-
4. Happy Coding! :tada: We are open for your pull request.
135+
4. While flashing with platformio use either `pio run -t upload -e obs` or `pio run -t upload -e obspro` matching the Hardware you work with.
136+
5. Happy Coding! :tada: We are open for your pull request.
136137

137138

138139
## License

0 commit comments

Comments
 (0)