Easy MqttObj class for automatically publishing and subscribing hardware GPIO pins to/from an MQTT topic. Use like a normal PinIO. More...

#include <mqtt.h>

Inherits MQTT::mqtt_leaf.

Inherited by MQTT::mqtt_IO_Input, and MQTT::mqtt_IO_Output.

Public Member Functions
	mqtt_IO (PinIO ioPin, const char topic, Client mClient=NULL, uint16_t flags=(eObj_Flag_PubOnWrite\|eObj_Flag_Subscribe\|eObj_Flag_Sub_NoLocal))
	Constructor for a standalone mqtt_IO object.

	mqtt_IO (mqtt_leaf &parent, PinIO ioPin, const char topic, Client mClient=NULL, uint16_t flags=(eObj_Flag_PubOnWrite\|eObj_Flag_Subscribe\|eObj_Flag_Sub_NoLocal))
	Constructor for a mqtt_IO object that has a parent.

virtual void	SetFlags (uint16_t newFlags) override
	additional behavioral flags for this object

virtual void	ClearFlags (uint16_t delFlags) override
	behavioral flags from this object

int	SetFixedDirection (int direction)
	Set a fixed direction for the GPIO pin.

mqtt_IO &	operator= (bool val)
	Assignment operator for mqtt_IO. Assigns the value to the hardware GPIO, then performs any post assignment operations.

	operator bool ()
	Boolean conversion operator for mqtt_IO. Returns the current state of the underlying GPIO.

bool	operator! ()
	Boolean Not operator for mqtt_IO. Returns the negation of the current state of the underlying GPIO.

virtual ValueTestResult	TestOrSetValue (ParsedJsonDataSet &pjs, bool setVal) override
	whether the current index of a JSON dataset is valid for this object, or assign the value at the current index of the dataset to this object.

virtual int	SubscribeEvent (int mqttFd, PacketInfo::Msg *msg) override
	Handle a message sent by the Broker triggered by this object's Subscription.

virtual int	RenderToBuffer (eObj_Serialize_t form, uint8_t *buf, int buflen) override
	Render this object to an output buffer.

virtual int	RenderToFd (eObj_Serialize_t form, int fd) override
	Render this object to an output socket.

Public Member Functions inherited from MQTT::mqtt_leaf
	~mqtt_leaf ()
	~mqtt_leaf Destructor for base mqtt_leaf

void	RemoveFromTree ()
	Remove this object from it's parent tree.

bool	NameMatch (const char *cp)
	Determine whether a given name matches this object.

virtual int	GetPubTopicName (NBString &s)
	Get the Topic Name this object Publishes to.

virtual int	GetSubTopicFilter (NBString &s)
	Get the Subscription Topic Filter this object Subscribes to.

virtual int	GetRenderLength (eObj_Serialize_t form=eObj_Serialize_CURRENT_FORM)
	Get the number of bytes used to serialize this object in a particular format.

int	Publish (int waitForCompletion=-1)
	Publishes the current MQTT object, optionally waiting for completion.

void	SetPublishInterval (uint32_t intervalPeriodTicks)
	Sets or clears an automatic publishing interval for this MQTT object.

virtual void	SetSerializationForm (eObj_Serialize_t form)
	Set the default serialization format for this object.

eObj_Serialize_t	GetSerializationForm ()
	Get the default serialization format for this object.

uint16_t	GetFlags ()
	Get the behavioral flags set for this object.

int	getPriority ()
	Get the message priority for this object.

Static Public Member Functions
static void	PinNotify (int port_num, int pin, void *ctx)
	Static notification function for pin state changes.

Static Public Member Functions inherited from MQTT::mqtt_leaf
static int	MqttRxPublish (Client mClient, int mqttFd, PacketInfo::Msg msg, void *ctx)
	Static message handler for Publish messages received by the registered Client.

Protected Member Functions
virtual int	ParseFd (int mqttFd) override
	the data from a file descriptor according to this object's current default serialization method and assign the value.

Protected Member Functions inherited from MQTT::mqtt_leaf
	mqtt_leaf (const char topic, Client mClient, uint16_t flags=(eObj_Flag_PubOnWrite\|eObj_Flag_Subscribe\|eObj_Flag_Sub_NoLocal))
	Constructor for mqtt_leaf objects.

	mqtt_leaf (mqtt_leaf &parent, const char topic, Client mClient, uint16_t flags=(eObj_Flag_PubOnWrite\|eObj_Flag_Subscribe\|eObj_Flag_Sub_NoLocal))
	Constructor for mqtt_leaf objects.

virtual mqtt_leaf *	GetChildren ()
	Get the first child of this object.

virtual mqtt_leaf *	AddChild (mqtt_leaf *child)
	Add an MqttObj as a child to this object.

virtual mqtt_leaf *	RemoveFirstChild ()
	Remove the first child from this object.

void	ForEachLeaf (LeafCallBack p, void pd)
	Call a function on each element of the MqttObj tree with this object as the root.

void	RootParse (ParsedJsonDataSet &pjs)
	Assign to this object tree from a JSON dataset.

bool	MatchId (ParsedJsonDataSet &pjs)
	Determine whether the JSON dataset's current index matches this object's name.

int	QueuePublish ()
	Queue this object to be Published via the registered Client.

int	QueueSubscribe ()
	Queue this object to be Subscribed via the registered Client.

int	QueueUnsubscribe ()
	Queue this object to be Unsubscribed via the registered Client.

int	Assign ()
	Perform post assignemnt operations.

uint8_t	PubState ()
	Get the Publish state.

uint8_t	SubState ()
	Get the Subscribe state of this object.

virtual void	SetPubState (uint8_t newState)
	Set the Publish state.

virtual void	SetSubState (uint8_t newState)
	Set the Subscribe state.

int	HandleSubAck (int mqttFd, PacketInfo::Msg *msg)
	Handle a Subscribe Acknowledge message from the broker for our Subscribe request.

int	HandleUnsubAck (int mqttFd, PacketInfo::Msg *msg)
	Handle an Unsubscribe Acknowledge message from the broker for our Unsubscribe request.

int	HandlePubAck (int mqttFd, PacketInfo::Msg *msg)
	Handle an Publish Acknowledge message from the broker for our Publish request.

Additional Inherited Members
Public Types inherited from MQTT::mqtt_leaf
enum	eObj_State_t
	Mqtt Object Publication/Subscription States.

Protected Attributes inherited from MQTT::mqtt_leaf
NBInterpolatedString	topicName
	Topic name or additional branch.

eObj_Serialize_t	publishForm
	Default serialization form.

uint16_t	mFlags
	Behavioral flags.

Detailed Description

Easy MqttObj class for automatically publishing and subscribing hardware GPIO pins to/from an MQTT topic. Use like a normal PinIO.

Constructor & Destructor Documentation

◆ mqtt_IO() [1/2]

MQTT::mqtt_IO::mqtt_IO	(	PinIO	ioPin,
		const char *	topic,
		Client *	mClient = NULL,
		uint16_t	flags = (eObj_Flag_PubOnWrite\|eObj_Flag_Subscribe\|eObj_Flag_Sub_NoLocal) )

Constructor for a standalone mqtt_IO object.

Parameters

ioPin	GPIO pin to control/report
*topic	Mqtt Topic Name to use for Publish/Subcribe.
*mClient	Pointer to Client to register with. If NULL, it will be registered with the first created Client.
flags	Behavioral flags to set on the created object

◆ mqtt_IO() [2/2]

MQTT::mqtt_IO::mqtt_IO	(	mqtt_leaf &	parent,
		PinIO	ioPin,
		const char *	topic,
		Client *	mClient = NULL,
		uint16_t	flags = (eObj_Flag_PubOnWrite\|eObj_Flag_Subscribe\|eObj_Flag_Sub_NoLocal) )

Constructor for a mqtt_IO object that has a parent.

Parameters

&parent	Reference to parent MqttObj
ioPin	GPIO pin to control/report
*topic	Mqtt Topic Name to use for Publish/Subcribe.
*mClient	Pointer to Client to register with. If NULL, it will be registered with the first created Client.
flags	Behavioral flags to set on the created object

Member Function Documentation

◆ ClearFlags()

virtual void MQTT::mqtt_IO::ClearFlags ( uint16_t delFlags )

overridevirtual

behavioral flags from this object

Parameters

delFlags The flags to be cleared from this object

Reimplemented from MQTT::mqtt_leaf.

◆ operator bool()

MQTT::mqtt_IO::operator bool ( )

inline

Boolean conversion operator for mqtt_IO. Returns the current state of the underlying GPIO.

Returns: The state of the underlying GPIO

◆ operator!()

bool MQTT::mqtt_IO::operator! ( )

inline

Boolean Not operator for mqtt_IO. Returns the negation of the current state of the underlying GPIO.

Returns: The negation of the current state of the underlying GPIO

◆ operator=()

mqtt_IO & MQTT::mqtt_IO::operator= ( bool val )

Assignment operator for mqtt_IO. Assigns the value to the hardware GPIO, then performs any post assignment operations.

Parameters

val	The value to assign to the pin.

Returns: A reference to the object being assigned to.

◆ ParseFd()

virtual int MQTT::mqtt_IO::ParseFd ( int mqttFd )

overrideprotectedvirtual

the data from a file descriptor according to this object's current default serialization method and assign the value.

Parameters

mqttFd File descriptor to read from.

Returns: eResult_t return code

Implements MQTT::mqtt_leaf.

◆ PinNotify()

static void MQTT::mqtt_IO::PinNotify	(	int	port_num,
		int	pin,
		void *	ctx )

static

Static notification function for pin state changes.

Parameters

port_num	The GPIO port number that triggered this call.
pin	The GPIO pin index of the pin that triggered this call.
ctx	The notification context associated with this call.

◆ RenderToBuffer()

virtual int MQTT::mqtt_IO::RenderToBuffer	(	eObj_Serialize_t	form,
		uint8_t *	buf,
		int	buflen )

overridevirtual

Render this object to an output buffer.

Parameters

form	Serialization format to render as
*buf	Pointer to output buffer
buflen	Size of the output buffer

Returns: Length of the rendered data

Implements MQTT::mqtt_leaf.

◆ RenderToFd()

virtual int MQTT::mqtt_IO::RenderToFd	(	eObj_Serialize_t	form,
		int	fd )

overridevirtual

Render this object to an output socket.

Parameters

form	Serialization format to render as
fd	File descriptor to render to

Returns: Length of the rendered data

Implements MQTT::mqtt_leaf.

◆ SetFixedDirection()

int MQTT::mqtt_IO::SetFixedDirection ( int direction )

Set a fixed direction for the GPIO pin.

Parameters

direction The direction to point: <0: input, 0: unfixed, >0: output

Returns: The direction the GPIO is fixed to: <0: input, 0: unfixed, >0: output

◆ SetFlags()

virtual void MQTT::mqtt_IO::SetFlags ( uint16_t newFlags )

overridevirtual

additional behavioral flags for this object

Parameters

newFlags The set of new flags to be set

Reimplemented from MQTT::mqtt_leaf.

◆ SubscribeEvent()

virtual int MQTT::mqtt_IO::SubscribeEvent	(	int	mqttFd,
		PacketInfo::Msg *	msg )

overridevirtual

Handle a message sent by the Broker triggered by this object's Subscription.

Parameters

mqttFd	File Descriptor to read any additional message data from
*msg	Pointer to message received from the Broker

Returns: eResult_t return code

Reimplemented from MQTT::mqtt_leaf.

◆ TestOrSetValue()

virtual ValueTestResult MQTT::mqtt_IO::TestOrSetValue	(	ParsedJsonDataSet &	pjs,
		bool	setVal )

overridevirtual

whether the current index of a JSON dataset is valid for this object, or assign the value at the current index of the dataset to this object.

Parameters

&pjs	The JSON dataset to use
setVal	true: Assign from the value at the current index, false: test if current index is valid for this object

Returns: ValueTestResult indicating the validity of the current index

Implements MQTT::mqtt_leaf.

The documentation for this class was generated from the following file:

mqtt.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ mqtt_IO() [1/2]

◆ mqtt_IO() [2/2]

Member Function Documentation

◆ ClearFlags()

◆ operator bool()

◆ operator!()

◆ operator=()

◆ ParseFd()

◆ PinNotify()

◆ RenderToBuffer()

◆ RenderToFd()

◆ SetFixedDirection()

◆ SetFlags()

◆ SubscribeEvent()

◆ TestOrSetValue()