Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opatut/obs-firmware-lite
https://github.com/opatut/obs-firmware-lite
Last synced: 14 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/opatut/obs-firmware-lite
- Owner: opatut
- Created: 2023-01-26T11:50:52.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-31T19:06:57.000Z (9 months ago)
- Last Synced: 2024-04-01T18:41:33.533Z (9 months ago)
- Language: C++
- Size: 13.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OpenBikeSensor Lite Firmware
This is the firmware repository for the up-and-coming "Lite" version of the OpenBikeSensor.
If you are looking for the firmware for the existing, "Classic" OpenBikeSensor, you can find it here: https://github.com/openbikesensor/OpenBikeSensorFirmware
The OpenBikeSensor Lite is currently in development and not available to build yet. There are no build instructions, and this firmware, the recording software, data format and enclosure are not completed. Please go over to the [OpenBikeSensor Website](https://www.openbikesensor.org/docs/hardware/) if you're interested in building your own device, it contains all information for the Classic version of the OpenBikeSensor.
## Building
Required:
- recent python version installed
- possibly drivers for usb-serial installed
To build and upload to obs-lite do the following:
```bash
# take care to clone including submodules
git clone --recurse-submodules https://github.com/opatut/obs-firmware-lite.git
cd obs-firmware-lite/
# create a venv to not pollute the global interpreter
python3 -m venv venv
# install platformio
venv/bin/pip install platformio
# build and upload to obs lite
venv/bin/platformio run -t upload
```
## Quickstart
* Install PlatformIO, either the IDE version or just the CLI tools are fine.
* Wire up the sensors and buttons according to the schematics from [the obs-lite branch of the PCB repository](https://github.com/openbikesensor/OpenBikeSensor_PCB_Board/tree/obs-lite/OpenBikeSensorLite). That is:
* Sensor A Echo: GPIO 4 / Pin 20
* Sensor A Trigger: GPIO 15 / Pin 18
* Sensor B Echo: GPIO 26 / Pin 8
* Sensor B Trigger: GPIO 25 / Pin 9
* Button: GPIO 2 / Pin 19 -- button connects the pin to ground (internal pull-up)
* Attach your ESP32 to the USB Port of your computer.
* Build and run the PlatformIO project. It should upload the binary, then start running.
* You should be able to decode the data stream on the serial port using the [OpenBikeSensor Recording Format](https://github.com/openbikesensor/proto), for example with the included [`examples/reader.py`](https://github.com/openbikesensor/proto/blob/main/examples/reader.py) script.