rbxii3/firmware
1
0
Fork 0
mirror of https://github.com/meshtastic/firmware.git synced 2025-12-19 09:12:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add doc note about threading and use OSThread to make GPIO watching work

Browse Source 
Thanks to @mc-hamster for the idea
This commit is contained in:
Kevin Hester
2020-12-11 18:29:32 +08:00
parent af88a34f75
commit 1e5d0b25ad
4 changed files with 104 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/software/plugin-api.md
View File

@@ -49,6 +49,11 @@ The easiest way to get started is:
* Rebuild with your new messaging goodness and install on the device
* Use the [meshtastic commandline tool](https://github.com/meshtastic/Meshtastic-python) to send a packet to your board "meshtastic --dest 1234 --ping"
## Threading
It is very common that you would like your plugin to be invoked periodically.
We use a crude/basic cooperative threading system to allow this on any of our supported platforms. Simply inherit from OSThread and implement runOnce(). See the OSThread [documentation](/src/concurrency/OSThread.h) for more details. For an example consumer of this API see RemoteHardwarePlugin::runOnce.
## Picking a port number
For any new 'apps' that run on the device or via sister apps on phones/PCs they should pick and use a unique 'portnum' for their application.