Skip to content

Latest commit

 

History

History
executable file
·
91 lines (63 loc) · 5.77 KB

README.md

File metadata and controls

executable file
·
91 lines (63 loc) · 5.77 KB
Raw

OpenBikeSensor

GitHub version GitHub version GitHub downloads GitHub commits since latest release (by date)

GitHub version GitHub version GitHub last commit GitHub downloads

GitHub downloads OpenBikeSensor - CI Open Issues Contributors quality gate bugs Slack

Platform for measuring data on a bicycle and collecting it. Currently, we measure the distance with either HC-SR04 or JSN-SR04T ultrasonic sensors connected to an ESP32.

Description

Inspired by the Berlin project Radmesser. This version uses a simple push button at the handle bar to confirm distance-measures were actually overtaking vehicles. It has its own GPS, and a SD card for logging, so it does not require any additional hardware (like a smartphone).

Starting with version v0.3 the firmware also exposes the measured data via BLE bluetooth. You can use this to feed data to the SimRa App or any other app collecting heart-rate BLE data.

Unfortunately we had to temporarily remove the bluetooth code in v0.5.x because of resource limitations. Plan is to enable this again as soon as we manage the resource limitations.

Updating

update functionality. For the 1st flashing of the firmware or the update from a version prior v0.3.x you have to plug in USB. See flash documentation
for a documentation how to do a manual flash it if you do not want to set up an IDE as described below.

Find the documentation

You can find the OpenBikeSensor documentation under:

Getting Started

  1. You need a OpenBikeSensor in order to try work on the Firmware. Head over to our Hardware Guide to assemble one.
  2. Clone this repo: git clone https://github.com/openbikesensor/OpenBikeSensorFirmware.git and cd into it.
  3. Choose between developing with recommended VSCode, or CLion (license required), respectively Arduino IDE (discouraged).
  4. Happy Coding! 🎉 We are open for your pull request.

License

Copyright (C) 2020-2021 OpenBikeSensor Contributors
Contact: https://openbikesensor.org

This file is part of the OpenBikeSensor firmware.

The OpenBikeSensor firmware is free software: you can
redistribute it and/or modify it under the terms of the GNU Lesser General
Public License as published by the Free Software Foundation, either version
3 of the License, or (at your option) any later version.

The OpenBikeSensor Website and Documentation is distributed in the hope
that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with the OpenBikeSensor Website and Documentation. If not, see
<http://www.gnu.org/licenses/>.