summaryrefslogtreecommitdiff
path: root/doc/ble
diff options
context:
space:
mode:
authorJF <jf@codingfield.com>2020-04-05 15:03:06 (GMT)
committerJF <jf@codingfield.com>2020-04-05 15:03:06 (GMT)
commit932c0479ee7c501bc224435943c73a368001845e (patch)
tree42e02ec27abd978fbd8bf0a3f9b94c4d2cc21d12 /doc/ble
parent26fb9ed1cd8752438ed0ca9be3c286ddfc696b40 (diff)
Add documentation about BLE connection and services.
Diffstat (limited to 'doc/ble')
-rw-r--r--doc/ble/ans_sequence.pngbin0 -> 36606 bytes
-rw-r--r--doc/ble/ans_sequence.puml29
-rw-r--r--doc/ble/connection_sequence.pngbin0 -> 17958 bytes
-rw-r--r--doc/ble/connection_sequence.puml14
4 files changed, 43 insertions, 0 deletions
diff --git a/doc/ble/ans_sequence.png b/doc/ble/ans_sequence.png
new file mode 100644
index 0000000..99cf849
--- /dev/null
+++ b/doc/ble/ans_sequence.png
Binary files differ
diff --git a/doc/ble/ans_sequence.puml b/doc/ble/ans_sequence.puml
new file mode 100644
index 0000000..c381905
--- /dev/null
+++ b/doc/ble/ans_sequence.puml
@@ -0,0 +1,29 @@
+@startuml
+group Get configuration from server
+Pinetime -> CompanionApp : Read request (Supported 'new' notification categories - 0x2A47)
+CompanionApp --> Pinetime: Response (0xff = all categories)
+
+Pinetime -> CompanionApp : Read request (Supported 'unread' notification categories - 0x2A48)
+CompanionApp --> Pinetime: Response (0xff = all categories)
+end
+
+group Configure the server
+Pinetime -> CompanionApp : Configure 'new' notifications categories : Accept all (Write [0, 0xFF] to Control Point - 0x2A44)
+activate CompanionApp
+deactivate CompanionApp
+Pinetime -> CompanionApp : Configure 'unread' notifications categories : Accept all (Write [1, 0xFF] to Control Point - 0x2A44)
+activate CompanionApp
+deactivate CompanionApp
+end
+
+group Server sends a notification
+CompanionApp -> Pinetime : Notify new_alert (0x2A46)
+activate Pinetime
+note over Pinetime
+ Pinetime FW handles the
+ notification (display on UI)
+end note
+deactivate Pinetime
+end
+
+@enduml \ No newline at end of file
diff --git a/doc/ble/connection_sequence.png b/doc/ble/connection_sequence.png
new file mode 100644
index 0000000..7e8babc
--- /dev/null
+++ b/doc/ble/connection_sequence.png
Binary files differ
diff --git a/doc/ble/connection_sequence.puml b/doc/ble/connection_sequence.puml
new file mode 100644
index 0000000..5553182
--- /dev/null
+++ b/doc/ble/connection_sequence.puml
@@ -0,0 +1,14 @@
+@startuml
+Pinetime --> CompanionApp: Start advertising
+
+group BLE Connection
+CompanionApp -> Pinetime: Connection request
+CompanionApp <-> Pinetime: Connection parameters negociation, security procedure,...
+end
+
+group Service Discovery
+CompanionApp <-> Pinetime: Discover service 0x1805 (CTS)
+CompanionApp <-> Pinetime: Discover service 0x1811 (ANS)
+end
+
+@enduml \ No newline at end of file