summaryrefslogtreecommitdiff
path: root/doc/ble.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ble.md')
-rw-r--r--doc/ble.md32
1 files changed, 22 insertions, 10 deletions
diff --git a/doc/ble.md b/doc/ble.md
index 8573166f..d2502636 100644
--- a/doc/ble.md
+++ b/doc/ble.md
@@ -2,13 +2,14 @@
## Introduction
This page describes the BLE implementation and API built in this firmware.
-**Note** : I'm a beginner in BLE related technologies and the information in this document reflects my current knowledge and understanding of the BLE stack. This information might be erroneous or incomplete. Feel free to submit a PR if you think you can improve it.
+**Note**: I'm a beginner in BLE related technologies and the information in this document reflects my current knowledge and understanding of the BLE stack. This information might be erroneous or incomplete. Feel free to submit a PR if you think you can improve it.
---
### Table of Contents
- [BLE Connection](#ble-connection)
+- [BLE FS](#ble-fs)
- [BLE UUIDs](#ble-uuids)
- [BLE Services](#ble-services)
- [CTS](#cts)
@@ -51,6 +52,13 @@ If **CTS** is detected, it'll request the current time to the companion applicat
---
+## BLE FS
+
+The documentation for BLE FS can be found here:
+[BLEFS.md](./BLEFS.md)
+
+---
+
## BLE UUIDs
When possible, InfiniTime tries to implement BLE services defined by the BLE specification.
@@ -72,12 +80,16 @@ The following custom services are implemented in InfiniTime:
* [Navigation Service](NavigationService.md) : 00010000-78fc-48fe-8e23-433b3a1942d0
- - Since InfiniTime 0.13
- * Call characteristic (extension to the Alert Notification Service): 00020001-78fc-48fe-8e23-433b3a1942d0
-
-
- - Since InfiniTime 1.7:
- * [Motion Service](MotionService.md) : 00030000-78fc-48fe-8e23-433b3a1942d0
+- Since InfiniTime 0.13
+ * Call characteristic (extension to the Alert Notification Service): 00020001-78fc-48fe-8e23-433b3a1942d0
+
+
+- Since InfiniTime 1.7:
+ * [Motion Service](MotionService.md): 00030000-78fc-48fe-8e23-433b3a1942d0
+
+
+- Since InfiniTime 1.8:
+ * [Weather Service](/src/components/ble/weather/WeatherService.h): 00040000-78fc-48fe-8e23-433b3a1942d0
---
@@ -108,11 +120,11 @@ Reading a value from the firmware version characteristic will yield a UTF-8 enco
#### Battery Level
-Reading from the battery level characteristic yields a single byte of data. This byte can be converted to an unsigned 8-bit integer which will be the battery percentage. This characteristic allows notify for updates as the value changes.
+Reading from the battery level characteristic yields a single byte of data. This byte can be converted to an unsigned 8-bit integer which will be the battery percentage. This characteristic allows notifications for updates as the value changes.
#### Heart Rate
-Reading from the heart rate characteristic yields two bytes of data. I am not sure of the function of the first byte. It appears to always be zero. The second byte can be converted to an unsigned 8-bit integer which is the current heart rate. This characteristic also allows notify for updates as the value changes.
+Reading from the heart rate characteristic yields two bytes of data. I am not sure of the function of the first byte. It appears to always be zero. The second byte can be converted to an unsigned 8-bit integer which is the current heart rate. This characteristic also allows notifications for updates as the value changes.
---
@@ -285,4 +297,4 @@ This characteristic expects a particular format:
- Microsecond divided by `1e6*256` (`uint8`)
- Binary 0001 (`uint8`)
-Write all of these together, encoded as little-endian, to the current time characteristic. \ No newline at end of file
+Write all of these together, encoded as little-endian, to the current time characteristic.