Add documentation about BLE connection and services.

This commit is contained in:
JF
2020-04-05 17:03:06 +02:00
parent 26fb9ed1cd
commit 932c0479ee
6 changed files with 75 additions and 1 deletions

BIN
doc/ble/ans_sequence.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

29
doc/ble/ans_sequence.puml Normal file
View File

@@ -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

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

View File

@@ -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