painlessmesh::plugin Namespace Reference

Namespaces
namespace	ota
namespace	performance
namespace	remote

Classes
class	BridgeCoordinationPackage
class	BroadcastPackage
class	NeighbourPackage
class	PackageHandler
class	SinglePackage

Detailed Description

Plugin interface for painlessMesh packages/messages

This interface allows one to design their own messages types/packages, and add handlers that are called when the new package type arrives at a node. Here you can think of things like sensor packages, which hold the measurements done by the sensors. The packages related to OTA updates are also implemented as a plugin system (see plugin::ota). Each package type is uniquely identified using the protocol::PackageInterface::type. Currently default package types use numbers up to 12, so to be on the safe side we recommend your own packages to use higher type values, e.g. start counting at 20 at the lowest.

An important piece of information is how a package should be routed. Currently we have three main routing algorithms (router::Type).

using namespace painlessmesh;
 
// Inherit from SinglePackage, the most basic package with
router::Type::SINGLE class SensorPackage : public plugin::SinglePackage {
 
};