From 932c0479ee7c501bc224435943c73a368001845e Mon Sep 17 00:00:00 2001 From: JF Date: Sun, 5 Apr 2020 17:03:06 +0200 Subject: Add documentation about BLE connection and services. --- doc/ble/ans_sequence.png | Bin 0 -> 36606 bytes doc/ble/ans_sequence.puml | 29 +++++++++++++++++++++++++++++ doc/ble/connection_sequence.png | Bin 0 -> 17958 bytes doc/ble/connection_sequence.puml | 14 ++++++++++++++ 4 files changed, 43 insertions(+) create mode 100644 doc/ble/ans_sequence.png create mode 100644 doc/ble/ans_sequence.puml create mode 100644 doc/ble/connection_sequence.png create mode 100644 doc/ble/connection_sequence.puml (limited to 'doc/ble') diff --git a/doc/ble/ans_sequence.png b/doc/ble/ans_sequence.png new file mode 100644 index 00000000..99cf8493 Binary files /dev/null and b/doc/ble/ans_sequence.png differ diff --git a/doc/ble/ans_sequence.puml b/doc/ble/ans_sequence.puml new file mode 100644 index 00000000..c3819059 --- /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 00000000..7e8babcb Binary files /dev/null and b/doc/ble/connection_sequence.png differ diff --git a/doc/ble/connection_sequence.puml b/doc/ble/connection_sequence.puml new file mode 100644 index 00000000..55531829 --- /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 -- cgit v1.2.3