mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-09-19 23:57:31 -07:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge pull request #1321 from geeksville/pr-doclogble

Browse source 
document the new BLE logging characteristic
This commit is contained in:
Ben Meadors 2024-07-13 06:20:12 -05:00 committed by GitHub
parent e32612e823 0ba9460a90
commit 8bbe4b9d54
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/development/device/client-api.mdx
View file

@ -78,6 +78,15 @@ read,notify,write
fromnum - the current packet # in the message waiting inside fromradio, if the phone sees this notify it should read messages
until it catches up with this number.
6c6fd238-78fa-436b-aacf-15c5be1ef2e3
notify
A log message as LogRecord protobuf. Clients are encouraged to listen for this notification and give the option of logging these
debug messages.
6c6fd238-78fa-436b-aacf-15c5be1ef2e2
notify
A raw log message as a string (with a newline). This characteristic is DEPRECATED and shouldn't be used on new client code.
The phone can write to this register to go backwards up to FIXME packets, to handle the rare case of a fromradio packet was dropped after the ESP32 callback was called, but before it arrives at the phone. If the phone writes to this register the ESP32 will discard older packets and put the next packet >= fromnum in fromradio.
When the ESP32 advances fromnum, it will delay doing the notify by 100ms, in the hopes that the notify will never actually need to be sent if the phone is already pulling from fromradio.