mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-02-02 08:42:11 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix broken links

Browse source
This commit is contained in:
apt105 2021-05-17 23:11:43 +01:00
parent 23c5d7b64b
commit d7c75e25ec
3 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
website/docs/developers/device/plugin-api.md
View file

@ -41,14 +41,14 @@ A number of [key services](http://github.com/meshtastic/meshtastic-device/tree/m
- [TextMessagePlugin](http://github.com/meshtastic/meshtastic-device/tree/master/src/plugins/TextMessagePlugin.h) - receives text messages and displays them on the LCD screen/stores them in the local DB - [TextMessagePlugin](http://github.com/meshtastic/meshtastic-device/tree/master/src/plugins/TextMessagePlugin.h) - receives text messages and displays them on the LCD screen/stores them in the local DB
- [NodeInfoPlugin](http://github.com/meshtastic/meshtastic-device/tree/master/src/plugins/NodeInfoPlugin.h) - receives/sends User information to other nodes so that usernames are available in the databases - [NodeInfoPlugin](http://github.com/meshtastic/meshtastic-device/tree/master/src/plugins/NodeInfoPlugin.h) - receives/sends User information to other nodes so that usernames are available in the databases
- [RemoteHardwarePlugin](http://github.com/meshtastic/meshtastic-device/tree/master/src/plugins/RemoteHardwarePlugin.h) - a plugin that provides easy remote access to device hardware (for things like turning GPIOs on or off). Intended to be a more extensive example and provide a useful feature of its own. See [remote-hardware](remote-hardware-service.md) for details. - [RemoteHardwarePlugin](http://github.com/meshtastic/meshtastic-device/tree/master/src/plugins/RemoteHardwarePlugin.h) - a plugin that provides easy remote access to device hardware (for things like turning GPIOs on or off). Intended to be a more extensive example and provide a useful feature of its own. See [remote-hardware](/docs/software/other/remote-hardware-service.md) for details.
- [ReplyPlugin](http://github.com/meshtastic/meshtastic-device/tree/master/src/plugins/ReplyPlugin.h) - a simple plugin that just replies to any packet it receives (provides a 'ping' service). - [ReplyPlugin](http://github.com/meshtastic/meshtastic-device/tree/master/src/plugins/ReplyPlugin.h) - a simple plugin that just replies to any packet it receives (provides a 'ping' service).
## Getting started ## Getting started
The easiest way to get started is: The easiest way to get started is:
- [Build and install](build-instructions.md) the standard codebase from github. - [Build and install](/docs/software/other/build-instructions.md) the standard codebase from github.
- Copy [src/plugins/ReplyPlugin.\*](http://github.com/meshtastic/meshtastic-device/tree/master/src/plugins/ReplyPlugin.cpp) into src/plugins/YourPlugin.*. Then change the port number from *PortNum_REPLY_APP* to *PortNum_PRIVATE_APP\*. - Copy [src/plugins/ReplyPlugin.\*](http://github.com/meshtastic/meshtastic-device/tree/master/src/plugins/ReplyPlugin.cpp) into src/plugins/YourPlugin.*. Then change the port number from *PortNum_REPLY_APP* to *PortNum_PRIVATE_APP\*.
- Edit plugins/Plugins.cpp:setupPlugins() to add a call to create an instance of your plugin (see comment at head of that function) - Edit plugins/Plugins.cpp:setupPlugins() to add a call to create an instance of your plugin (see comment at head of that function)
- Rebuild with your new messaging goodness and install on the device - Rebuild with your new messaging goodness and install on the device

2
website/docs/software/other/mqtt.md
View file

@ -44,7 +44,7 @@ FIXME - explain this more, talk about how useful for users and security domains.
## On device API ## On device API
For information on the related on-device API see [here](device-api.md). For information on the related on-device API see [here](/doc/developers/device/device-api.md).
## MQTT transport ## MQTT transport

6
website/docs/software/other/sw-design.md
View file

@ -7,9 +7,9 @@ sidebar_label: Software Design
This is a mini design doc for developing the meshtastic software. This is a mini design doc for developing the meshtastic software.
- [Build instructions](build-instructions.md) - [Build instructions](build-instructions.md)
- [On device plugin API](plugin-api.md) - a tutorial on how to write small Plugins which run on the device and can message other nodes. - [On device plugin API](/doc/developers/device/plugin-api.md) - a tutorial on how to write small Plugins which run on the device and can message other nodes.
- Our [project board](https://github.com/orgs/meshtastic/projects/1) - shows what things we are currently working on and remaining work items for the current release. - Our [project board](https://github.com/orgs/meshtastic/projects/1) - shows what things we are currently working on and remaining work items for the current release.
- [Power Management](power.md) - [Power Management](power.md)
- [Mesh algorithm](mesh-alg.md) - [Mesh algorithm](/doc/developers/device/mesh-alg.md)
- [External client API](device-api.md) and porting guide for new clients (iOS, python, etc...) - [External client API](/doc/developers/device/device-api.md) and porting guide for new clients (iOS, python, etc...)
- TODO: how to port the device code to a new device. - TODO: how to port the device code to a new device.