pohui_pohui/firmware
1
0
Fork 0
mirror of https://github.com/meshtastic/firmware.git synced 2025-06-19 11:32:06 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

update dev docs

Browse Source
This commit is contained in:
Kevin Hester 2020-12-11 10:03:46 +08:00
parent b9f1ce70cb
commit af88a34f75
2 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/software/TODO.md
View File

@ -6,12 +6,12 @@ For app cleanup:
* DONE make device build always have a valid version * DONE make device build always have a valid version
* DONE do fixed position bug https://github.com/meshtastic/Meshtastic-device/issues/536 * DONE do fixed position bug https://github.com/meshtastic/Meshtastic-device/issues/536
* check build guide * DONE check build guide
* write devapi user guide * DONE write devapi user guide
* DONE update android code: https://developer.android.com/topic/libraries/view-binding/migration * DONE update android code: https://developer.android.com/topic/libraries/view-binding/migration
* only do wantReplies once per packet type, if we change network settings force it again * only do wantReplies once per packet type, if we change network settings force it again
* make gpio watch work, use thread and setup * make gpio watch work, use thread and setup
* make hello world example service * DONE make hello world example service
* make python ping command * make python ping command
* DONE have python tool check max packet size before sending to device * DONE have python tool check max packet size before sending to device
* DONE if request was sent reliably, send reply reliably * DONE if request was sent reliably, send reply reliably

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

@ -14,9 +14,9 @@ Packets can be sent/received either as raw binary structures or as [Protobufs](h
The relevant bits of the class heirarchy are as follows The relevant bits of the class heirarchy are as follows
* MeshPlugin (in src/mesh/MeshPlugin.h) - you probably don't want to use this baseclass directly * [MeshPlugin](/src/mesh/MeshPlugin.h) (in src/mesh/MeshPlugin.h) - you probably don't want to use this baseclass directly
* SinglePortPlugin (in src/mesh/SinglePortPlugin.h) - for plugins that receive from a single port number (the normal case) * [SinglePortPlugin](/src/mesh/SinglePortPlugin.h) (in src/mesh/SinglePortPlugin.h) - for plugins that receive from a single port number (the normal case)
* ProtobufPlugin (in src/mesh/ProtobufPlugin.h) - for plugins that are sending/receiving a single particular Protobuf type. Inherit from this if you are using protocol buffers in your plugin. * [ProtobufPlugin](/src/mesh/ProtobufPlugin.h) (in src/mesh/ProtobufPlugin.h) - for plugins that are sending/receiving a single particular Protobuf type. Inherit from this if you are using protocol buffers in your plugin.
You will typically want to inherit from either SinglePortPlugin (if you are just sending raw bytes) or ProtobufPlugin (if you are sending protobufs). You'll implement your own handleReceived/handleReceivedProtobuf - probably based on the example code. You will typically want to inherit from either SinglePortPlugin (if you are just sending raw bytes) or ProtobufPlugin (if you are sending protobufs). You'll implement your own handleReceived/handleReceivedProtobuf - probably based on the example code.
@ -42,7 +42,12 @@ A number of [key services](/src/plugins) are implemented using the plugin API, t
## Getting started ## Getting started
The easiest way to get started is to copy [src/plugins/ReplyPlugin.*](/src/plugins/ReplyPlugin.h) into src/plugins/YourPlugin.*. Then change the port number from REPLY_APP to PRIVATE_APP. The easiest way to get started is:
* [Build and install](build-instructions.md) the standard codebase from github.
* Copy [src/plugins/ReplyPlugin.*](/src/plugins/ReplyPlugin.cpp) into src/plugins/YourPlugin.*. Then change the port number from REPLY_APP to PRIVATE_APP.
* 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"
## Picking a port number ## Picking a port number