sforkowany z mirror/meshtastic-firmware
commit
f4afa6931b
|
@ -46,6 +46,7 @@ The easiest way to get started is:
|
||||||
|
|
||||||
* [Build and install](build-instructions.md) the standard codebase from github.
|
* [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 *PortNum_REPLY_APP* to *PortNum_PRIVATE_APP*.
|
* Copy [src/plugins/ReplyPlugin.*](/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)
|
||||||
* Rebuild with your new messaging goodness and install on the device
|
* 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, for example "*meshtastic --dest 1234 --sendping*", where *1234* is another mesh node to send the ping to.
|
* Use the [meshtastic commandline tool](https://github.com/meshtastic/Meshtastic-python) to send a packet to your board, for example "*meshtastic --dest 1234 --sendping*", where *1234* is another mesh node to send the ping to.
|
||||||
|
|
||||||
|
@ -54,6 +55,10 @@ The easiest way to get started is:
|
||||||
It is very common that you would like your plugin to be invoked periodically.
|
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.
|
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.
|
||||||
|
|
||||||
|
## Sending messages
|
||||||
|
|
||||||
|
If you would like to proactively send messages (rather than just responding to them), just call service.sendToMesh(). For an example of this see [NodeInfoPlugin::sendOurNodeInfo(...)](/src/plugins/NodeInfoPlugin.cpp).
|
||||||
|
|
||||||
## Picking a port number
|
## 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.
|
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.
|
||||||
|
|
2
proto
2
proto
|
@ -1 +1 @@
|
||||||
Subproject commit 75078afe43934f4ce15ef86ebc6950658a170145
|
Subproject commit dfe7bc1217a00c23eecb9dfcf1d56fe95ebddc3b
|
|
@ -28,6 +28,8 @@ void OSThread::setup()
|
||||||
OSThread::OSThread(const char *_name, uint32_t period, ThreadController *_controller)
|
OSThread::OSThread(const char *_name, uint32_t period, ThreadController *_controller)
|
||||||
: Thread(NULL, period), controller(_controller)
|
: Thread(NULL, period), controller(_controller)
|
||||||
{
|
{
|
||||||
|
assertIsSetup();
|
||||||
|
|
||||||
ThreadName = _name;
|
ThreadName = _name;
|
||||||
|
|
||||||
if (controller)
|
if (controller)
|
||||||
|
@ -81,4 +83,36 @@ void OSThread::run()
|
||||||
currentThread = NULL;
|
currentThread = NULL;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This flag is set **only** when setup() starts, to provide a way for us to check for sloppy static constructor calls.
|
||||||
|
* Call assertIsSetup() to force a crash if someone tries to create an instance too early.
|
||||||
|
*
|
||||||
|
* it is super important to never allocate those object statically. instead, you should explicitly
|
||||||
|
* new them at a point where you are guaranteed that other objects that this instance
|
||||||
|
* depends on have already been created.
|
||||||
|
*
|
||||||
|
* in particular, for OSThread that means "all instances must be declared via new() in setup() or later" -
|
||||||
|
* this makes it guaranteed that the global mainController is fully constructed first.
|
||||||
|
*/
|
||||||
|
bool hasBeenSetup;
|
||||||
|
|
||||||
|
void assertIsSetup()
|
||||||
|
{
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Dear developer comrade - If this assert fails() that means you need to fix the following:
|
||||||
|
*
|
||||||
|
* This flag is set **only** when setup() starts, to provide a way for us to check for sloppy static constructor calls.
|
||||||
|
* Call assertIsSetup() to force a crash if someone tries to create an instance too early.
|
||||||
|
*
|
||||||
|
* it is super important to never allocate those object statically. instead, you should explicitly
|
||||||
|
* new them at a point where you are guaranteed that other objects that this instance
|
||||||
|
* depends on have already been created.
|
||||||
|
*
|
||||||
|
* in particular, for OSThread that means "all instances must be declared via new() in setup() or later" -
|
||||||
|
* this makes it guaranteed that the global mainController is fully constructed first.
|
||||||
|
*/
|
||||||
|
assert(hasBeenSetup);
|
||||||
|
}
|
||||||
|
|
||||||
} // namespace concurrency
|
} // namespace concurrency
|
||||||
|
|
|
@ -42,7 +42,6 @@ class OSThread : public Thread
|
||||||
static bool showWaiting;
|
static bool showWaiting;
|
||||||
|
|
||||||
public:
|
public:
|
||||||
|
|
||||||
/// For debug printing only (might be null)
|
/// For debug printing only (might be null)
|
||||||
static const OSThread *currentThread;
|
static const OSThread *currentThread;
|
||||||
|
|
||||||
|
@ -71,4 +70,19 @@ class OSThread : public Thread
|
||||||
virtual void run();
|
virtual void run();
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This flag is set **only** when setup() starts, to provide a way for us to check for sloppy static constructor calls.
|
||||||
|
* Call assertIsSetup() to force a crash if someone tries to create an instance too early.
|
||||||
|
*
|
||||||
|
* it is super important to never allocate those object statically. instead, you should explicitly
|
||||||
|
* new them at a point where you are guaranteed that other objects that this instance
|
||||||
|
* depends on have already been created.
|
||||||
|
*
|
||||||
|
* in particular, for OSThread that means "all instances must be declared via new() in setup() or later" -
|
||||||
|
* this makes it guaranteed that the global mainController is fully constructed first.
|
||||||
|
*/
|
||||||
|
extern bool hasBeenSetup;
|
||||||
|
|
||||||
|
void assertIsSetup();
|
||||||
|
|
||||||
} // namespace concurrency
|
} // namespace concurrency
|
||||||
|
|
|
@ -746,7 +746,7 @@ void Screen::setup()
|
||||||
powerStatusObserver.observe(&powerStatus->onNewStatus);
|
powerStatusObserver.observe(&powerStatus->onNewStatus);
|
||||||
gpsStatusObserver.observe(&gpsStatus->onNewStatus);
|
gpsStatusObserver.observe(&gpsStatus->onNewStatus);
|
||||||
nodeStatusObserver.observe(&nodeStatus->onNewStatus);
|
nodeStatusObserver.observe(&nodeStatus->onNewStatus);
|
||||||
textMessageObserver.observe(&textMessagePlugin);
|
textMessageObserver.observe(textMessagePlugin);
|
||||||
}
|
}
|
||||||
|
|
||||||
void Screen::forceDisplay()
|
void Screen::forceDisplay()
|
||||||
|
|
|
@ -22,6 +22,7 @@
|
||||||
#include "meshwifi/meshhttp.h"
|
#include "meshwifi/meshhttp.h"
|
||||||
#include "meshwifi/meshwifi.h"
|
#include "meshwifi/meshwifi.h"
|
||||||
#include "sleep.h"
|
#include "sleep.h"
|
||||||
|
#include "plugins/Plugins.h"
|
||||||
#include "target_specific.h"
|
#include "target_specific.h"
|
||||||
#include <OneButton.h>
|
#include <OneButton.h>
|
||||||
#include <Wire.h>
|
#include <Wire.h>
|
||||||
|
@ -275,6 +276,8 @@ RadioInterface *rIf = NULL;
|
||||||
|
|
||||||
void setup()
|
void setup()
|
||||||
{
|
{
|
||||||
|
concurrency::hasBeenSetup = true;
|
||||||
|
|
||||||
#ifdef SEGGER_STDOUT_CH
|
#ifdef SEGGER_STDOUT_CH
|
||||||
SEGGER_RTT_ConfigUpBuffer(SEGGER_STDOUT_CH, NULL, NULL, 1024, SEGGER_RTT_MODE_NO_BLOCK_TRIM);
|
SEGGER_RTT_ConfigUpBuffer(SEGGER_STDOUT_CH, NULL, NULL, 1024, SEGGER_RTT_MODE_NO_BLOCK_TRIM);
|
||||||
#endif
|
#endif
|
||||||
|
@ -439,6 +442,9 @@ void setup()
|
||||||
|
|
||||||
service.init();
|
service.init();
|
||||||
|
|
||||||
|
// Now that the mesh service is created, create any plugins
|
||||||
|
setupPlugins();
|
||||||
|
|
||||||
// Do this after service.init (because that clears error_code)
|
// Do this after service.init (because that clears error_code)
|
||||||
#ifdef AXP192_SLAVE_ADDRESS
|
#ifdef AXP192_SLAVE_ADDRESS
|
||||||
if (!axp192_found)
|
if (!axp192_found)
|
||||||
|
|
|
@ -60,7 +60,8 @@ static int32_t sendOwnerCb()
|
||||||
currentGeneration = radioGeneration;
|
currentGeneration = radioGeneration;
|
||||||
|
|
||||||
DEBUG_MSG("Sending our nodeinfo to mesh (wantReplies=%d)\n", requestReplies);
|
DEBUG_MSG("Sending our nodeinfo to mesh (wantReplies=%d)\n", requestReplies);
|
||||||
nodeInfoPlugin.sendOurNodeInfo(NODENUM_BROADCAST, requestReplies); // Send our info (don't request replies)
|
assert(nodeInfoPlugin);
|
||||||
|
nodeInfoPlugin->sendOurNodeInfo(NODENUM_BROADCAST, requestReplies); // Send our info (don't request replies)
|
||||||
|
|
||||||
return getPref_send_owner_interval() * getPref_position_broadcast_secs() * 1000;
|
return getPref_send_owner_interval() * getPref_position_broadcast_secs() * 1000;
|
||||||
}
|
}
|
||||||
|
@ -134,7 +135,8 @@ bool MeshService::reloadConfig()
|
||||||
/// The owner User record just got updated, update our node DB and broadcast the info into the mesh
|
/// The owner User record just got updated, update our node DB and broadcast the info into the mesh
|
||||||
void MeshService::reloadOwner()
|
void MeshService::reloadOwner()
|
||||||
{
|
{
|
||||||
nodeInfoPlugin.sendOurNodeInfo();
|
assert(nodeInfoPlugin);
|
||||||
|
nodeInfoPlugin->sendOurNodeInfo();
|
||||||
nodeDB.saveToDisk();
|
nodeDB.saveToDisk();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -193,10 +195,11 @@ void MeshService::sendNetworkPing(NodeNum dest, bool wantReplies)
|
||||||
assert(node);
|
assert(node);
|
||||||
|
|
||||||
DEBUG_MSG("Sending network ping to 0x%x, with position=%d, wantReplies=%d\n", dest, node->has_position, wantReplies);
|
DEBUG_MSG("Sending network ping to 0x%x, with position=%d, wantReplies=%d\n", dest, node->has_position, wantReplies);
|
||||||
|
assert(positionPlugin && nodeInfoPlugin);
|
||||||
if (node->has_position)
|
if (node->has_position)
|
||||||
positionPlugin.sendOurPosition(dest, wantReplies);
|
positionPlugin->sendOurPosition(dest, wantReplies);
|
||||||
else
|
else
|
||||||
nodeInfoPlugin.sendOurNodeInfo(dest, wantReplies);
|
nodeInfoPlugin->sendOurNodeInfo(dest, wantReplies);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@ -264,7 +267,8 @@ int MeshService::onGPSChanged(const meshtastic::GPSStatus *unused)
|
||||||
currentGeneration = radioGeneration;
|
currentGeneration = radioGeneration;
|
||||||
|
|
||||||
DEBUG_MSG("Sending position to mesh (wantReplies=%d)\n", requestReplies);
|
DEBUG_MSG("Sending position to mesh (wantReplies=%d)\n", requestReplies);
|
||||||
positionPlugin.sendOurPosition(NODENUM_BROADCAST, requestReplies);
|
assert(positionPlugin);
|
||||||
|
positionPlugin->sendOurPosition(NODENUM_BROADCAST, requestReplies);
|
||||||
}
|
}
|
||||||
|
|
||||||
return 0;
|
return 0;
|
||||||
|
|
|
@ -5,6 +5,7 @@
|
||||||
#include "FS.h"
|
#include "FS.h"
|
||||||
|
|
||||||
#include "CryptoEngine.h"
|
#include "CryptoEngine.h"
|
||||||
|
#include "FSCommon.h"
|
||||||
#include "GPS.h"
|
#include "GPS.h"
|
||||||
#include "MeshRadio.h"
|
#include "MeshRadio.h"
|
||||||
#include "NodeDB.h"
|
#include "NodeDB.h"
|
||||||
|
@ -16,7 +17,6 @@
|
||||||
#include "error.h"
|
#include "error.h"
|
||||||
#include "mesh-pb-constants.h"
|
#include "mesh-pb-constants.h"
|
||||||
#include "meshwifi/meshwifi.h"
|
#include "meshwifi/meshwifi.h"
|
||||||
#include "FSCommon.h"
|
|
||||||
#include <pb_decode.h>
|
#include <pb_decode.h>
|
||||||
#include <pb_encode.h>
|
#include <pb_encode.h>
|
||||||
|
|
||||||
|
@ -41,8 +41,6 @@ DeviceState versions used to be defined in the .proto file but really only this
|
||||||
#define DEVICESTATE_CUR_VER 11
|
#define DEVICESTATE_CUR_VER 11
|
||||||
#define DEVICESTATE_MIN_VER DEVICESTATE_CUR_VER
|
#define DEVICESTATE_MIN_VER DEVICESTATE_CUR_VER
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
// FIXME - move this somewhere else
|
// FIXME - move this somewhere else
|
||||||
extern void getMacAddr(uint8_t *dmac);
|
extern void getMacAddr(uint8_t *dmac);
|
||||||
|
|
||||||
|
@ -148,18 +146,26 @@ bool NodeDB::resetRadioConfig()
|
||||||
if (!*channelName) { // emptystring
|
if (!*channelName) { // emptystring
|
||||||
// Per mesh.proto spec, if bandwidth is specified we must ignore modemConfig enum, we assume that in that case
|
// Per mesh.proto spec, if bandwidth is specified we must ignore modemConfig enum, we assume that in that case
|
||||||
// the app fucked up and forgot to set channelSettings.name
|
// the app fucked up and forgot to set channelSettings.name
|
||||||
|
|
||||||
|
if (channelSettings.bandwidth != 0)
|
||||||
channelName = "Unset";
|
channelName = "Unset";
|
||||||
if(channelSettings.bandwidth == 0) switch(channelSettings.modem_config) {
|
else
|
||||||
|
switch (channelSettings.modem_config) {
|
||||||
case ChannelSettings_ModemConfig_Bw125Cr45Sf128:
|
case ChannelSettings_ModemConfig_Bw125Cr45Sf128:
|
||||||
channelName = "Medium"; break;
|
channelName = "Medium";
|
||||||
|
break;
|
||||||
case ChannelSettings_ModemConfig_Bw500Cr45Sf128:
|
case ChannelSettings_ModemConfig_Bw500Cr45Sf128:
|
||||||
channelName = "ShortFast"; break;
|
channelName = "ShortFast";
|
||||||
|
break;
|
||||||
case ChannelSettings_ModemConfig_Bw31_25Cr48Sf512:
|
case ChannelSettings_ModemConfig_Bw31_25Cr48Sf512:
|
||||||
channelName = "LongAlt"; break;
|
channelName = "LongAlt";
|
||||||
|
break;
|
||||||
case ChannelSettings_ModemConfig_Bw125Cr48Sf4096:
|
case ChannelSettings_ModemConfig_Bw125Cr48Sf4096:
|
||||||
channelName = "LongSlow"; break;
|
channelName = "LongSlow";
|
||||||
|
break;
|
||||||
default:
|
default:
|
||||||
channelName = "Invalid"; break;
|
channelName = "Invalid";
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -271,7 +277,8 @@ void NodeDB::init()
|
||||||
myNodeInfo.node_num_bits = sizeof(NodeNum) * 8;
|
myNodeInfo.node_num_bits = sizeof(NodeNum) * 8;
|
||||||
myNodeInfo.packet_id_bits = sizeof(PacketId) * 8;
|
myNodeInfo.packet_id_bits = sizeof(PacketId) * 8;
|
||||||
|
|
||||||
myNodeInfo.error_code = CriticalErrorCode_None; // For the error code, only show values from this boot (discard value from flash)
|
myNodeInfo.error_code =
|
||||||
|
CriticalErrorCode_None; // For the error code, only show values from this boot (discard value from flash)
|
||||||
myNodeInfo.error_address = 0;
|
myNodeInfo.error_address = 0;
|
||||||
|
|
||||||
// likewise - we always want the app requirements to come from the running appload
|
// likewise - we always want the app requirements to come from the running appload
|
||||||
|
|
|
@ -6,7 +6,7 @@
|
||||||
#include "configuration.h"
|
#include "configuration.h"
|
||||||
#include "main.h"
|
#include "main.h"
|
||||||
|
|
||||||
NodeInfoPlugin nodeInfoPlugin;
|
NodeInfoPlugin *nodeInfoPlugin;
|
||||||
|
|
||||||
bool NodeInfoPlugin::handleReceivedProtobuf(const MeshPacket &mp, const User &p)
|
bool NodeInfoPlugin::handleReceivedProtobuf(const MeshPacket &mp, const User &p)
|
||||||
{
|
{
|
||||||
|
|
|
@ -29,4 +29,4 @@ class NodeInfoPlugin : public ProtobufPlugin<User>
|
||||||
virtual MeshPacket *allocReply();
|
virtual MeshPacket *allocReply();
|
||||||
};
|
};
|
||||||
|
|
||||||
extern NodeInfoPlugin nodeInfoPlugin;
|
extern NodeInfoPlugin *nodeInfoPlugin;
|
|
@ -0,0 +1,20 @@
|
||||||
|
#include "plugins/NodeInfoPlugin.h"
|
||||||
|
#include "plugins/PositionPlugin.h"
|
||||||
|
#include "plugins/ReplyPlugin.h"
|
||||||
|
#include "plugins/RemoteHardwarePlugin.h"
|
||||||
|
#include "plugins/TextMessagePlugin.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create plugin instances here. If you are adding a new plugin, you must 'new' it here (or somewhere else)
|
||||||
|
*/
|
||||||
|
void setupPlugins() {
|
||||||
|
nodeInfoPlugin = new NodeInfoPlugin();
|
||||||
|
positionPlugin = new PositionPlugin();
|
||||||
|
textMessagePlugin = new TextMessagePlugin();
|
||||||
|
|
||||||
|
// Note: if the rest of meshtastic doesn't need to explicitly use your plugin, you do not need to assign the instance
|
||||||
|
// to a global variable.
|
||||||
|
|
||||||
|
new RemoteHardwarePlugin();
|
||||||
|
new ReplyPlugin();
|
||||||
|
}
|
|
@ -0,0 +1,6 @@
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create plugin instances here. If you are adding a new plugin, you must 'new' it here (or somewhere else)
|
||||||
|
*/
|
||||||
|
void setupPlugins();
|
|
@ -5,7 +5,7 @@
|
||||||
#include "Router.h"
|
#include "Router.h"
|
||||||
#include "configuration.h"
|
#include "configuration.h"
|
||||||
|
|
||||||
PositionPlugin positionPlugin;
|
PositionPlugin *positionPlugin;
|
||||||
|
|
||||||
bool PositionPlugin::handleReceivedProtobuf(const MeshPacket &mp, const Position &p)
|
bool PositionPlugin::handleReceivedProtobuf(const MeshPacket &mp, const Position &p)
|
||||||
{
|
{
|
||||||
|
|
|
@ -30,4 +30,4 @@ class PositionPlugin : public ProtobufPlugin<Position>
|
||||||
virtual MeshPacket *allocReply();
|
virtual MeshPacket *allocReply();
|
||||||
};
|
};
|
||||||
|
|
||||||
extern PositionPlugin positionPlugin;
|
extern PositionPlugin *positionPlugin;
|
|
@ -6,8 +6,6 @@
|
||||||
#include "configuration.h"
|
#include "configuration.h"
|
||||||
#include "main.h"
|
#include "main.h"
|
||||||
|
|
||||||
RemoteHardwarePlugin remoteHardwarePlugin;
|
|
||||||
|
|
||||||
#define NUM_GPIOS 64
|
#define NUM_GPIOS 64
|
||||||
|
|
||||||
// Because (FIXME) we currently don't tell API clients status on sent messages
|
// Because (FIXME) we currently don't tell API clients status on sent messages
|
||||||
|
|
|
@ -5,9 +5,6 @@
|
||||||
|
|
||||||
#include <assert.h>
|
#include <assert.h>
|
||||||
|
|
||||||
// Create an a static instance of our plugin - this registers with the plugin system
|
|
||||||
ReplyPlugin replyPlugin;
|
|
||||||
|
|
||||||
MeshPacket *ReplyPlugin::allocReply()
|
MeshPacket *ReplyPlugin::allocReply()
|
||||||
{
|
{
|
||||||
assert(currentRequest); // should always be !NULL
|
assert(currentRequest); // should always be !NULL
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
#include "NodeDB.h"
|
#include "NodeDB.h"
|
||||||
#include "PowerFSM.h"
|
#include "PowerFSM.h"
|
||||||
|
|
||||||
TextMessagePlugin textMessagePlugin;
|
TextMessagePlugin *textMessagePlugin;
|
||||||
|
|
||||||
bool TextMessagePlugin::handleReceived(const MeshPacket &mp)
|
bool TextMessagePlugin::handleReceived(const MeshPacket &mp)
|
||||||
{
|
{
|
||||||
|
|
|
@ -22,4 +22,4 @@ class TextMessagePlugin : public SinglePortPlugin, public Observable<const MeshP
|
||||||
virtual bool handleReceived(const MeshPacket &mp);
|
virtual bool handleReceived(const MeshPacket &mp);
|
||||||
};
|
};
|
||||||
|
|
||||||
extern TextMessagePlugin textMessagePlugin;
|
extern TextMessagePlugin *textMessagePlugin;
|
Ładowanie…
Reference in New Issue