Klagarge/MSE-PI-E2EEDA-Plein-de-eeeeeeeeeee
Archived
1
0
Fork 0
Code Releases 1 Activity

docs(gateway): update diagrams for battery level support

Browse Source 
- Add KEY_BATTERY (0x05) to class diagram
- Update EXPECTED_PAYLOAD_SIZE from 12 to 14 in class diagram
- Update payload size check from 12 to 14 in sequence diagram
This commit is contained in:
DjeAvd
2026-05-22 00:01:54 +02:00
committed by Klagarge
parent d4acdb76b5
commit a70a3e3933
2 changed files with 3 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc_resources/gateway/class_diagram.puml
View File

@@ -1,6 +1,5 @@
@startuml @startuml
skinparam linestyle ortho skinparam linestyle ortho
class Gateway { class Gateway {
- gateway_id: str - gateway_id: str
- mqtt_broker: str - mqtt_broker: str
@@ -11,8 +10,9 @@ class Gateway {
+ KEY_HUMIDITY: 0x02 + KEY_HUMIDITY: 0x02
+ KEY_TEMP: 0x03 + KEY_TEMP: 0x03
+ KEY_CO2: 0x04 + KEY_CO2: 0x04
+ KEY_BATTERY: 0x05
+ INVALID_VALUE: 0xFFFFFFFF + INVALID_VALUE: 0xFFFFFFFF
+ EXPECTED_PAYLOAD_SIZE: 12 + EXPECTED_PAYLOAD_SIZE: 14
-- --
+ decode_payload(data: bytes): dict + decode_payload(data: bytes): dict
+ publish(mac: str, data: dict) + publish(mac: str, data: dict)
@@ -21,12 +21,10 @@ class Gateway {
+ on_publish(client, userdata, mid, reason_code, properties) + on_publish(client, userdata, mid, reason_code, properties)
+ run() + run()
} }
class BleakScanner { class BleakScanner {
+ start() + start()
+ stop() + stop()
} }
class MQTTClient { class MQTTClient {
+ connect() + connect()
+ publish() + publish()
@@ -34,8 +32,6 @@ class MQTTClient {
+ username_pw_set() + username_pw_set()
+ loop_start() + loop_start()
} }
Gateway o-- BleakScanner Gateway o-- BleakScanner
Gateway o-- MQTTClient Gateway o-- MQTTClient
@enduml @enduml

2
doc_resources/gateway/sequence_data_collection.puml
View File

@@ -14,7 +14,7 @@ alt company_id != 0xffff
else company_id == 0xffff else company_id == 0xffff
gw -> gw : check payload size gw -> gw : check payload size
alt payload size != 12 bytes alt payload size != 14 bytes
gw -> gw : discard packet\n(non-Thingy device) gw -> gw : discard packet\n(non-Thingy device)
else else
gw -> gw : decode_payload() gw -> gw : decode_payload()