diff options
| author | The King <27705324+jlukanc1@users.noreply.github.com> | 2021-01-24 21:01:14 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-24 21:01:14 (GMT) |
| commit | 8c3df5f0211e0cc31de90039a73fe48b9a9aafe0 (patch) | |
| tree | 88fc0671a629b27793a418df76f543c7913b644a /doc | |
| parent | 51c8cadcb78bdbe9013f5aace629c96ed3dfd06f (diff) | |
| parent | 80838d1e42e83b50188d6237d16c81cfa27781a6 (diff) | |
Merge branch 'develop' into upstream-dev
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/NavigationService.md | 118 | ||||
| -rw-r--r-- | doc/ble.md | 23 | ||||
| -rw-r--r-- | doc/openOCD.md | 6 |
3 files changed, 144 insertions, 3 deletions
diff --git a/doc/NavigationService.md b/doc/NavigationService.md new file mode 100644 index 0000000..d089981 --- /dev/null +++ b/doc/NavigationService.md @@ -0,0 +1,118 @@ +# Navigation Service +## Introduction +The navigation ble service provides 4 characteristics to allow the the watch to display navigation instructions from a companion application. The intended purpose is when performing some outdoor activities, for example running or cycling. + +The 4 characteristics are: +flag (string) - Upcoming icon name +narrative (string) - Textual description of instruction +manDist (string) - Manouvre Distance, the distance to the upcoming change +progress (uint8) - Percent complete of total route, value 0-100 + +## Service +The service UUID is c7e60001-78fc-48fe-8e23-433b3a1942d0 + +## Characteristics +## Flags (UUID c7e60002-78fc-48fe-8e23-433b3a1942d0) +All included icons are from pure-maps, which provides the actual routing from the client. The icon names ultimately come from the mapbox project "direction-icons", See https://github.com/rinigus/pure-maps/tree/master/qml/icons/navigation See the end of this document for the full lsit of supported icon names. + +## Narrative (UUID c7e60003-78fc-48fe-8e23-433b3a1942d0) +This is a client supplied string describing the upcoming instruction such as "At the roundabout take the first exit". + +## Man Dist (UUID c7e60004-78fc-48fe-8e23-433b3a1942d0) +This is a short string describing the distance to the upcoming instruction such as "50 m". + +## Progress (UUID c7e60001=5-78fc-48fe-8e23-433b3a1942d0) +The percent complete in a uint8. The watch displays this as an overall progress in a progress bar. + +## Full icon list +* arrive +* arrive-left +* arrive-right +* arrive-straight +* close +* continue +* continue-left +* continue-right +* continue-slight-left +* continue-slight-right +* continue-straight +* continue-uturn +* depart +* depart-left +* depart-right +* depart-straight +* end-of-road-left +* end-of-road-right +* ferry +* flag +* fork +* fork-left +* fork-right +* fork-slight-left +* fork-slight-right +* fork-straight +* invalid +* invalid-left +* invalid-right +* invalid-slight-left +* invalid-slight-right +* invalid-straight +* invalid-uturn +* merge-left +* merge-right +* merge-slight-left +* merge-slight-right +* merge-straight +* new-name-left +* new-name-right +* new-name-sharp-left +* new-name-sharp-right +* new-name-slight-left +* new-name-slight-right +* new-name-straight +* notification-left +* notification-right +* notification-sharp-left +* notification-sharp-right +* notification-slight-left +* notification-slight-right +* notification-straight +* off-ramp-left +* off-ramp-right +* off-ramp-sharp-left +* off-ramp-sharp-right +* off-ramp-slight-left +* off-ramp-slight-right +* off-ramp-straight +* on-ramp-left +* on-ramp-right +* on-ramp-sharp-left +* on-ramp-sharp-right +* on-ramp-slight-left +* on-ramp-slight-right +* on-ramp-straight +* rotary +* rotary-left +* rotary-right +* rotary-sharp-left +* rotary-sharp-right +* rotary-slight-left +* rotary-slight-right +* rotary-straight +* roundabout +* roundabout-left +* roundabout-right +* roundabout-sharp-left +* roundabout-sharp-right +* roundabout-slight-left +* roundabout-slight-right +* roundabout-straight +* turn-left +* turn-right +* turn-sharp-left +* turn-sharp-right +* turn-slight-left +* turn-slight-right +* turn-stright +* updown +* uturn @@ -15,6 +15,29 @@ If **CTS** is detected, it'll request the current time to the companion applicat  +## BLE UUIDs +When possible, InfiniTime tries to implement BLE services defined by the BLE specification. + +When the service does not exist in the BLE specification, InfiniTime implement custom services. As all BLE services, custom services are identified by a UUID. Here is how to define the UUID of custom services in InfiniTime: + +``` + - Base UUID : xxxxxxxx-78fc-48fe-8e23-433b3a1942d0 + - Service UUID : SSSS0000-78fc-48fe-8e23-433b3a1942d0 where SSSS is the service ID + - Characteristic UUID : SSSSCCCC-78fc-48fe-8e23-433b3a1942d0 where CCCC is the characteristic ID for the service SSSS and is different than 0 +``` + +The following custom services are implemented in InfiniTime: + + - Since InfiniTime 0.8: + ``` + * Music Service : 00000000-78fc-48fe-8e23-433b3a1942d0 + ``` + + - Since InfiniTime 0.11: + ``` + * Navigation Service : 00010000-78fc-48fe-8e23-433b3a1942d0 + ``` + ## BLE services [List of standard BLE services](https://www.bluetooth.com/specifications/gatt/services/) diff --git a/doc/openOCD.md b/doc/openOCD.md index a199bd7..b3661ce 100644 --- a/doc/openOCD.md +++ b/doc/openOCD.md @@ -89,12 +89,12 @@ reset ## Examples ### Flash bootloader and application ``` -openocd -f ./openocd-stlink.cfg -f ./flash_bootloader_app.ocd +openocd -f ./openocd-stlink.ocd -f ./flash_bootloader_app.ocd ``` ### Flash graphics flasher ``` -openocd -f ./openocd-stlink.cfg -f ./flash_graphics.ocd +openocd -f ./openocd-stlink.ocd -f ./flash_graphics.ocd ``` ## Connect the STLinkV2 to the PineTime @@ -102,4 +102,4 @@ Here is an example using the pogo pins:   -You can find more information about the SWD wiring [on the wiki](https://wiki.pine64.org/index.php?title=PineTime_devkit_wiring).
\ No newline at end of file +You can find more information about the SWD wiring [on the wiki](https://wiki.pine64.org/index.php?title=PineTime_devkit_wiring). |
