From 0a685a66e3881ec993fadbd64865029e3590a757 Mon Sep 17 00:00:00 2001 From: Dennis Guse Date: Sun, 14 Jun 2020 11:58:45 +0200 Subject: [PATCH] Added list of tested Bluetooth LE sensors. Fixes #202. --- README.md | 12 +++++++++--- README_DEVELOPER.md => README_API.md | 3 --- README_TESTED_SENSORS.md | 20 ++++++++++++++++++++ 3 files changed, 29 insertions(+), 6 deletions(-) rename README_DEVELOPER.md => README_API.md (83%) create mode 100644 README_TESTED_SENSORS.md diff --git a/README.md b/README.md index 957788ecf..52faaf0ab 100644 --- a/README.md +++ b/README.md @@ -51,13 +51,19 @@ _OpenTracks_ is a sport tracking application that completely respects your priva __Only required permissions:__ * _ACCESS_FINE_LOCATION_: required to use the GPS. +An overview of Bluetooth LE sensors that are known to work with OpenTracks is in [README_TESTED_SENSORS.md](README_TESTED_SENSORS.md). + _Please note:_ _OpenTracks_ does not contain a _map_ (as this would required Internet access). -To show your tracks on a map, a 3rd party application (e.g., [OsmAnd](https://play.google.com/store/apps/details?id=net.osmand) or [MAPS.ME](https://play.google.com/store/apps/details?id=com.mapswithme.maps.pro)) needs to be installed. -## Custom Dashboards +## Custom Dashboards (incl. Map) As of v3.3.1 OpenTracks enables to use custom dashboards. The reference implementation is [OSMDashboard](https://github.com/OpenTracksApp/OSMDashboard), which presents an OpenStreetMap map (showing the current track, incl. updates). +The developer documentation is in [README_API.md](README_API.md). + +Alternatively, recorded tracks can be shared as KMZ/GPX to installed applications (e.g., [OsmAnd](https://play.google.com/store/apps/details?id=net.osmand) or [MAPS.ME](https://play.google.com/store/apps/details?id=com.mapswithme.maps.pro)). +However, this is rather slow and does not provide updates while recording. + ## Screenshots
@@ -87,7 +93,7 @@ Rework of _OpenTracks_ included: * removing calorie estimation and activity estimation, * removing support for ANT+ and Classic Bluetooth, * adding support for Bluetooth LE heart rate sensors, -* removing Protobuf (store sensor data in SQLite columns directly), and +* removing Protobuf (store sensosensorr data in SQLite columns directly), and * removing Android Service API for other apps. Artwork, logos and user interface remained more or less unchanged. diff --git a/README_DEVELOPER.md b/README_API.md similarity index 83% rename from README_DEVELOPER.md rename to README_API.md index 545364a24..97a53925a 100644 --- a/README_DEVELOPER.md +++ b/README_API.md @@ -7,9 +7,6 @@ Although this might be (mostly) sufficient, it has some limitations. This include limited configurability (e.g., ordering of shown elements) and the lack of Internet access. In fact, the later is considered a feature but severely limits the implementation presenting a map (at least in an easy way). -_NOTE:_ for showing a track on a map a workaround was implemented in OpenTracks. -Data could be exported as KMZ and presented in 3rd-party application (e.g., [OsmAnd](https://play.google.com/store/apps/details?id=net.osmand) or [MAPS.ME](https://play.google.com/store/apps/details?id=com.mapswithme.maps.pro)). - For the time being, the OpenTracks Data API can be used to implement mainly custom dashboards. ## Implementation diff --git a/README_TESTED_SENSORS.md b/README_TESTED_SENSORS.md new file mode 100644 index 000000000..ca88f98bb --- /dev/null +++ b/README_TESTED_SENSORS.md @@ -0,0 +1,20 @@ +# Overview of tested Bluetooth LE sensors + +## HRS: Heartrate Service +* Decathlon|Geonaute|Kalenji Dual HRM Belt +* Polar H7 +* Polar OH1 + Has updatable firmware that requires a user account at polar.com +* Wahoo Tickr (Model: WFBTHR02) + +## CSCP: Cycling Cadence and Speed Service +Please note that the according to the specification these sensors _may_ provide speed as well as cadence. +However, often only one value is provided. + +### Speed +* Wahoo Speed (Model: WFRPMSPD) + +### Cadence +* Wahoo Cadence (Model: WFPODCAD2) + This sensor reports cadence data as speed. + A workaround is in place.