#include <ButtonController.h>

Inheritance diagram for CONTROLLER_CLASS_NAME:

Public Member Functions
void	setup (EnigmaIOTNodeClass node, void data=NULL)
	Initialize data structures. More...

bool	processRxCommand (const uint8_t address, const uint8_t buffer, uint8_t length, nodeMessageType_t command, nodePayloadEncoding_t payloadEncoding) override
	Called to process a downlink command. More...

void	loop () override
	This should be called periodically for module handling. More...

	~CONTROLLER_CLASS_NAME ()

void	configManagerStart () override
	Called when wifi manager starts config portal. More...

void	configManagerExit (bool status) override
	Called when wifi manager exits config portal. More...

bool	loadConfig () override
	Loads output module configuration. More...

void	connectInform ()
	Used to notify controller that it is registered on EnigmaIOT network. More...

void	setup (EnigmaIOTNodeClass node, void data=NULL)
	Initialize data structures. More...

bool	processRxCommand (const uint8_t address, const uint8_t buffer, uint8_t length, nodeMessageType_t command, nodePayloadEncoding_t payloadEncoding)
	Called to process a downlink command. More...

void	loop ()
	This should be called periodically for module handling. More...

	~CONTROLLER_CLASS_NAME ()

void	configManagerStart ()
	Called when wifi manager starts config portal. More...

void	configManagerExit (bool status)
	Called when wifi manager exits config portal. More...

bool	loadConfig ()
	Loads output module configuration. More...

void	connectInform ()
	Used to notify controller that it is registered on EnigmaIOT network. More...

void	setup (EnigmaIOTNodeClass node, void data=NULL)
	Initializes controller structures. More...

bool	processRxCommand (const uint8_t address, const uint8_t buffer, uint8_t length, nodeMessageType_t command, nodePayloadEncoding_t payloadEncoding)
	Processes received GET or SET commands. More...

void	loop ()
	Executes repetitive tasks on controller. More...

	~CONTROLLER_CLASS_NAME ()
	Default destructor. More...

void	configManagerStart ()
	Called when wifi manager starts config portal. More...

void	configManagerExit (bool status)
	Called when wifi manager exits config portal. More...

bool	loadConfig ()
	Loads output module configuration. More...

void	connectInform ()
	Executed as soon as node is registered on EnigmaIOT network. More...

void	setup (EnigmaIOTNodeClass node, void data=NULL)
	Initialize data structures. More...

bool	processRxCommand (const uint8_t address, const uint8_t buffer, uint8_t length, nodeMessageType_t command, nodePayloadEncoding_t payloadEncoding)
	Called to process a downlink command. More...

void	loop ()
	This should be called periodically for module handling. More...

	~CONTROLLER_CLASS_NAME ()

void	configManagerStart ()
	Called when wifi manager starts config portal. More...

void	configManagerExit (bool status)
	Called when wifi manager exits config portal. More...

bool	loadConfig ()
	Loads output module configuration. More...

void	connectInform ()
	Used to notify controller that it is registered on EnigmaIOT network. More...

void	setup (EnigmaIOTNodeClass node, void data=NULL)
	Initialize data structures. More...

bool	processRxCommand (const uint8_t address, const uint8_t buffer, uint8_t length, nodeMessageType_t command, nodePayloadEncoding_t payloadEncoding)
	Called to process a downlink command. More...

void	loop ()
	This should be called periodically for module handling. More...

	~CONTROLLER_CLASS_NAME ()

void	configManagerStart ()
	Called when wifi manager starts config portal. More...

void	configManagerExit (bool status)
	Called when wifi manager exits config portal. More...

bool	loadConfig ()
	Loads output module configuration. More...

void	connectInform ()
	Used to notify controller that it is registered on EnigmaIOT network. More...

void	setup (EnigmaIOTNodeClass node, void data=NULL)
	Initialize data structures. More...

bool	processRxCommand (const uint8_t address, const uint8_t buffer, uint8_t length, nodeMessageType_t command, nodePayloadEncoding_t payloadEncoding)
	Called to process a downlink command. More...

void	loop ()
	This should be called periodically for module handling. More...

	~CONTROLLER_CLASS_NAME ()

void	configManagerStart ()
	Called when wifi manager starts config portal. More...

void	configManagerExit (bool status)
	Called when wifi manager exits config portal. More...

bool	loadConfig ()
	Loads output module configuration. More...

void	connectInform ()
	Used to notify controller that it is registered on EnigmaIOT network. More...

Protected Member Functions
bool	saveConfig () override
	Saves output module configuration. More...

bool	sendCommandResp (const char *command, bool result) override
	Sends command processing response acknowledge. More...

bool	sendStartAnouncement () override
	Send a message to notify node has started running. More...

void	buildHADiscovery ()

bool	saveConfig ()
	Saves output module configuration. More...

bool	sendCommandResp (const char *command, bool result)
	Sends command processing response acknowledge. More...

bool	sendStartAnouncement ()
	Send a message to notify node has started running. More...

void	buildHADiscovery ()

bool	saveConfig ()
	Saves output module configuration. More...

bool	sendCommandResp (const char *command, bool result)
	Send response to commands to gateway. More...

bool	sendStartAnouncement ()
	Sends a notification message including configurable controller name and protocol version. More...

void	buildHADiscovery ()
	Sends a HA discovery message for a single entity. Add as many functions like this as number of entities you need to create. More...

bool	saveConfig ()
	Saves output module configuration. More...

bool	sendCommandResp (const char *command, bool result)
	Sends command processing response acknowledge. More...

bool	sendStartAnouncement ()
	Send a message to notify node has started running. More...

void	buildHADiscovery ()

bool	sendLedStatus ()

bool	saveConfig ()
	Saves output module configuration. More...

bool	sendCommandResp (const char *command, bool result)
	Sends command processing response acknowledge. More...

bool	sendStartAnouncement ()
	Send a message to notify node has started running. More...

bool	sendTemperature (float temp)

bool	saveConfig ()
	Saves output module configuration. More...

bool	sendCommandResp (const char *command, bool result)
	Sends command processing response acknowledge. More...

bool	sendStartAnouncement ()
	Send a message to notify node has started running. More...

void	buildHASwitchDiscovery ()
	Sends a HA discovery message for a single entity. Add as many functions like this as number of entities you need to create. More...

void	buildHATriggerDiscovery ()

void	buildHALinkDiscovery ()

void	defaultConfig ()

void	toggleRelay ()

void	setRelay (bool state)

bool	sendRelayStatus ()

void	setLinked (bool state)

bool	sendLinkStatus ()

void	setBoot (int state)

bool	sendBootStatus ()

Protected Attributes
bool	pushTriggered = false

bool	pushReleased = true

bool	buttonPressSent = false

int	led = _LED_OFF

OneWire *	oneWire

DallasTemperature *	sensors

DeviceAddress	insideThermometer

bool	tempSent = false

float	tempC

smartSwitchControllerHw_t	config

AsyncWiFiManagerParameter *	buttonPinParam

AsyncWiFiManagerParameter *	relayPinParam

AsyncWiFiManagerParameter *	bootStatusParam

AsyncWiFiManagerParameter *	bootStatusListParam

Additional Inherited Members
Private Member Functions inherited from EnigmaIOTjsonController
void	sendDataCallback (sendData_cb cb)
	Register send data callback to run when module needs to send a message. More...

virtual void	disconnectInform (nodeInvalidateReason_t reason)
	Used to notify controller that it is unregistered on EnigmaIOT network. More...

bool	sendJson (DynamicJsonDocument &json)
	Sends a JSON encoded message to lower layer. More...

Private Attributes inherited from EnigmaIOTjsonController
sendData_cb	sendData

EnigmaIOTNodeClass *	enigmaIotNode

Detailed Description

Definition at line 27 of file ButtonController.h.

Constructor & Destructor Documentation

◆ ~CONTROLLER_CLASS_NAME() [1/6]

CONTROLLER_CLASS_NAME::~CONTROLLER_CLASS_NAME ( )

Definition at line 98 of file ButtonController.cpp.

◆ ~CONTROLLER_CLASS_NAME() [2/6]

CONTROLLER_CLASS_NAME::~CONTROLLER_CLASS_NAME ( )

◆ ~CONTROLLER_CLASS_NAME() [3/6]

CONTROLLER_CLASS_NAME::~CONTROLLER_CLASS_NAME ( )

Default destructor.

◆ ~CONTROLLER_CLASS_NAME() [4/6]

CONTROLLER_CLASS_NAME::~CONTROLLER_CLASS_NAME ( )

◆ ~CONTROLLER_CLASS_NAME() [5/6]

CONTROLLER_CLASS_NAME::~CONTROLLER_CLASS_NAME ( )

◆ ~CONTROLLER_CLASS_NAME() [6/6]

CONTROLLER_CLASS_NAME::~CONTROLLER_CLASS_NAME ( )

Member Function Documentation

◆ buildHADiscovery() [1/4]

void CONTROLLER_CLASS_NAME::buildHADiscovery ( )

protected

Definition at line 124 of file ButtonController.cpp.

◆ buildHADiscovery() [2/4]

void CONTROLLER_CLASS_NAME::buildHADiscovery ( )

protected

◆ buildHADiscovery() [3/4]

void CONTROLLER_CLASS_NAME::buildHADiscovery ( )

protected

Sends a HA discovery message for a single entity. Add as many functions like this as number of entities you need to create.

◆ buildHADiscovery() [4/4]

void CONTROLLER_CLASS_NAME::buildHADiscovery ( )

protected

◆ buildHALinkDiscovery()

void CONTROLLER_CLASS_NAME::buildHALinkDiscovery ( )

protected

◆ buildHASwitchDiscovery()

void CONTROLLER_CLASS_NAME::buildHASwitchDiscovery ( )

protected

Sends a HA discovery message for a single entity. Add as many functions like this as number of entities you need to create.

◆ buildHATriggerDiscovery()

void CONTROLLER_CLASS_NAME::buildHATriggerDiscovery ( )

protected

◆ configManagerExit() [1/6]

void CONTROLLER_CLASS_NAME::configManagerExit ( bool status )

virtual

Called when wifi manager exits config portal.

Parameters

status true if configuration was successful

Implements EnigmaIOTjsonController.

◆ configManagerExit() [2/6]

void CONTROLLER_CLASS_NAME::configManagerExit ( bool status )

virtual

Called when wifi manager exits config portal.

Parameters

status true if configuration was successful

Implements EnigmaIOTjsonController.

◆ configManagerExit() [3/6]

void CONTROLLER_CLASS_NAME::configManagerExit ( bool status )

virtual

Called when wifi manager exits config portal.

Parameters

status true if configuration was successful

Implements EnigmaIOTjsonController.

◆ configManagerExit() [4/6]

void CONTROLLER_CLASS_NAME::configManagerExit ( bool status )

virtual

Called when wifi manager exits config portal.

Parameters

status true if configuration was successful

Implements EnigmaIOTjsonController.

◆ configManagerExit() [5/6]

void CONTROLLER_CLASS_NAME::configManagerExit ( bool status )

virtual

Called when wifi manager exits config portal.

Parameters

status true if configuration was successful

Implements EnigmaIOTjsonController.

◆ configManagerExit() [6/6]

void CONTROLLER_CLASS_NAME::configManagerExit ( bool status )

overridevirtual

Called when wifi manager exits config portal.

Parameters

status true if configuration was successful

Implements EnigmaIOTjsonController.

Definition at line 109 of file ButtonController.cpp.

◆ configManagerStart() [1/6]

void CONTROLLER_CLASS_NAME::configManagerStart ( )

virtual

Called when wifi manager starts config portal.

Implements EnigmaIOTjsonController.

◆ configManagerStart() [2/6]

void CONTROLLER_CLASS_NAME::configManagerStart ( )

virtual

Called when wifi manager starts config portal.

Implements EnigmaIOTjsonController.

◆ configManagerStart() [3/6]

void CONTROLLER_CLASS_NAME::configManagerStart ( )

virtual

Called when wifi manager starts config portal.

Parameters

node	Pointer to EnigmaIOT gateway instance

Implements EnigmaIOTjsonController.

◆ configManagerStart() [4/6]

void CONTROLLER_CLASS_NAME::configManagerStart ( )

virtual

Called when wifi manager starts config portal.

Parameters

node	Pointer to EnigmaIOT gateway instance

Implements EnigmaIOTjsonController.

◆ configManagerStart() [5/6]

void CONTROLLER_CLASS_NAME::configManagerStart ( )

virtual

Called when wifi manager starts config portal.

Parameters

node< Pointer to EnigmaIOT gateway instance

Implements EnigmaIOTjsonController.

◆ configManagerStart() [6/6]

void CONTROLLER_CLASS_NAME::configManagerStart ( )

overridevirtual

Called when wifi manager starts config portal.

Implements EnigmaIOTjsonController.

Definition at line 103 of file ButtonController.cpp.

◆ connectInform() [1/6]

void CONTROLLER_CLASS_NAME::connectInform ( )

virtual

Used to notify controller that it is registered on EnigmaIOT network.

Reimplemented from EnigmaIOTjsonController.

Definition at line 31 of file ButtonController.cpp.

◆ connectInform() [2/6]

void CONTROLLER_CLASS_NAME::connectInform ( )

virtual

Used to notify controller that it is registered on EnigmaIOT network.

Reimplemented from EnigmaIOTjsonController.

◆ connectInform() [3/6]

void CONTROLLER_CLASS_NAME::connectInform ( )

virtual

Executed as soon as node is registered on EnigmaIOT network.

Reimplemented from EnigmaIOTjsonController.

◆ connectInform() [4/6]

void CONTROLLER_CLASS_NAME::connectInform ( )

virtual

Used to notify controller that it is registered on EnigmaIOT network.

Reimplemented from EnigmaIOTjsonController.

◆ connectInform() [5/6]

void CONTROLLER_CLASS_NAME::connectInform ( )

virtual

Used to notify controller that it is registered on EnigmaIOT network.

Reimplemented from EnigmaIOTjsonController.

◆ connectInform() [6/6]

void CONTROLLER_CLASS_NAME::connectInform ( )

virtual

Used to notify controller that it is registered on EnigmaIOT network.

Reimplemented from EnigmaIOTjsonController.

◆ defaultConfig()

void CONTROLLER_CLASS_NAME::defaultConfig ( )

protected

Definition at line 382 of file SmartSwitchController.cpp.

◆ loadConfig() [1/6]

bool CONTROLLER_CLASS_NAME::loadConfig ( )

virtual

Loads output module configuration.

Returns: Returns true if load was successful. false otherwise

Implements EnigmaIOTjsonController.

◆ loadConfig() [2/6]

bool CONTROLLER_CLASS_NAME::loadConfig ( )

virtual

Loads output module configuration.

Returns: Returns true if load was successful. false otherwise

Implements EnigmaIOTjsonController.

◆ loadConfig() [3/6]

bool CONTROLLER_CLASS_NAME::loadConfig ( )

virtual

Loads output module configuration.

Returns: Returns true if load was successful. false otherwise

Implements EnigmaIOTjsonController.

◆ loadConfig() [4/6]

bool CONTROLLER_CLASS_NAME::loadConfig ( )

virtual

Loads output module configuration.

Returns: Returns true if load was successful. false otherwise

Implements EnigmaIOTjsonController.

◆ loadConfig() [5/6]

bool CONTROLLER_CLASS_NAME::loadConfig ( )

virtual

Loads output module configuration.

Returns: Returns true if load was successful. false otherwise

Implements EnigmaIOTjsonController.

◆ loadConfig() [6/6]

bool CONTROLLER_CLASS_NAME::loadConfig ( )

overridevirtual

Loads output module configuration.

Returns: Returns true if load was successful. false otherwise

Implements EnigmaIOTjsonController.

Definition at line 114 of file ButtonController.cpp.

◆ loop() [1/6]

void CONTROLLER_CLASS_NAME::loop ( )

virtual

This should be called periodically for module handling.

Implements EnigmaIOTjsonController.

◆ loop() [2/6]

void CONTROLLER_CLASS_NAME::loop ( )

virtual

Executes repetitive tasks on controller.

Implements EnigmaIOTjsonController.

◆ loop() [3/6]

void CONTROLLER_CLASS_NAME::loop ( )

virtual

This should be called periodically for module handling.

Implements EnigmaIOTjsonController.

◆ loop() [4/6]

void CONTROLLER_CLASS_NAME::loop ( )

virtual

This should be called periodically for module handling.

Implements EnigmaIOTjsonController.

◆ loop() [5/6]

void CONTROLLER_CLASS_NAME::loop ( )

virtual

This should be called periodically for module handling.

Implements EnigmaIOTjsonController.

◆ loop() [6/6]

void CONTROLLER_CLASS_NAME::loop ( )

overridevirtual

This should be called periodically for module handling.

Implements EnigmaIOTjsonController.

Definition at line 53 of file ButtonController.cpp.

◆ processRxCommand() [1/6]

bool CONTROLLER_CLASS_NAME::processRxCommand	(	const uint8_t *	mac,
		const uint8_t *	buffer,
		uint8_t	length,
		nodeMessageType_t	command,
		nodePayloadEncoding_t	payloadEncoding
	)

virtual

Called to process a downlink command.

Parameters

mac	Address of sender
buffer	Message bytes
length	Message length
command	Type of command. nodeMessageType_t
payloadEncoding	Payload encoding of type nodePayloadEncoding_t

Returns: true on success

Implements EnigmaIOTjsonController.

◆ processRxCommand() [2/6]

bool CONTROLLER_CLASS_NAME::processRxCommand	(	const uint8_t *	address,
		const uint8_t *	buffer,
		uint8_t	length,
		nodeMessageType_t	command,
		nodePayloadEncoding_t	payloadEncoding
	)

virtual

Processes received GET or SET commands.

Parameters

address	Origin MAC address
buffer	Command payload
length	Payload length in bytes
command	Command type. nodeMessageType_t::DOWNSTREAM_DATA_GET or nodeMessageType_t::DOWNSTREAM_DATA_SET
payloadEncoding	Payload encoding. MSG_PACK is recommended

Implements EnigmaIOTjsonController.

◆ processRxCommand() [3/6]

bool CONTROLLER_CLASS_NAME::processRxCommand	(	const uint8_t *	mac,
		const uint8_t *	buffer,
		uint8_t	length,
		nodeMessageType_t	command,
		nodePayloadEncoding_t	payloadEncoding
	)

virtual

Called to process a downlink command.

Parameters

mac	Address of sender
buffer	Message bytes
length	Message length
command	Type of command. nodeMessageType_t
payloadEncoding	Payload encoding of type nodePayloadEncoding_t

Returns: true on success

Implements EnigmaIOTjsonController.

◆ processRxCommand() [4/6]

bool CONTROLLER_CLASS_NAME::processRxCommand	(	const uint8_t *	mac,
		const uint8_t *	buffer,
		uint8_t	length,
		nodeMessageType_t	command,
		nodePayloadEncoding_t	payloadEncoding
	)

virtual

Called to process a downlink command.

Parameters

mac	Address of sender
buffer	Message bytes
length	Message length
command	Type of command. nodeMessageType_t
payloadEncoding	Payload encoding of type nodePayloadEncoding_t

Returns: true on success

Implements EnigmaIOTjsonController.

◆ processRxCommand() [5/6]

bool CONTROLLER_CLASS_NAME::processRxCommand	(	const uint8_t *	mac,
		const uint8_t *	buffer,
		uint8_t	length,
		nodeMessageType_t	command,
		nodePayloadEncoding_t	payloadEncoding
	)

virtual

Called to process a downlink command.

Parameters

mac	Address of sender
buffer	Message bytes
length	Message length
command	Type of command. nodeMessageType_t
payloadEncoding	Payload encoding of type nodePayloadEncoding_t

Returns: true on success

Implements EnigmaIOTjsonController.

◆ processRxCommand() [6/6]

bool CONTROLLER_CLASS_NAME::processRxCommand	(	const uint8_t *	mac,
		const uint8_t *	buffer,
		uint8_t	length,
		nodeMessageType_t	command,
		nodePayloadEncoding_t	payloadEncoding
	)

overridevirtual

Called to process a downlink command.

Parameters

mac	Address of sender
buffer	Message bytes
length	Message length
command	Type of command. nodeMessageType_t
payloadEncoding	Payload encoding of type nodePayloadEncoding_t

Returns: true on success

Implements EnigmaIOTjsonController.

Definition at line 19 of file ButtonController.cpp.

◆ saveConfig() [1/6]

bool CONTROLLER_CLASS_NAME::saveConfig ( )

protectedvirtual

Saves output module configuration.

Returns: Returns true if save was successful. false otherwise

Implements EnigmaIOTjsonController.

◆ saveConfig() [2/6]

bool CONTROLLER_CLASS_NAME::saveConfig ( )

protectedvirtual

Saves output module configuration.

Returns: Returns true if save was successful. false otherwise

Implements EnigmaIOTjsonController.

◆ saveConfig() [3/6]

bool CONTROLLER_CLASS_NAME::saveConfig ( )

protectedvirtual

Saves output module configuration.

Returns: Returns true if save was successful. false otherwise

Implements EnigmaIOTjsonController.

◆ saveConfig() [4/6]

bool CONTROLLER_CLASS_NAME::saveConfig ( )

protectedvirtual

Saves output module configuration.

Returns: Returns true if save was successful. false otherwise

Implements EnigmaIOTjsonController.

◆ saveConfig() [5/6]

bool CONTROLLER_CLASS_NAME::saveConfig ( )

protectedvirtual

Saves output module configuration.

Returns: Returns true if save was successful. false otherwise

Implements EnigmaIOTjsonController.

◆ saveConfig() [6/6]

bool CONTROLLER_CLASS_NAME::saveConfig ( )

overrideprotectedvirtual

Saves output module configuration.

Returns: Returns true if save was successful. false otherwise

Implements EnigmaIOTjsonController.

Definition at line 119 of file ButtonController.cpp.

◆ sendBootStatus()

bool CONTROLLER_CLASS_NAME::sendBootStatus ( )

protected

Definition at line 160 of file SmartSwitchController.cpp.

◆ sendCommandResp() [1/6]

bool CONTROLLER_CLASS_NAME::sendCommandResp	(	const char *	command,
		bool	result
	)

protectedvirtual

Sends command processing response acknowledge.

Parameters

command	Command name
result	Command execution success

Returns: Returns true if message sending was successful. false otherwise

Implements EnigmaIOTjsonController.

◆ sendCommandResp() [2/6]

bool CONTROLLER_CLASS_NAME::sendCommandResp	(	const char *	command,
		bool	result
	)

protectedvirtual

Send response to commands to gateway.

Parameters

command	Refered command
result	`true` if command was correctly executed, `false` otherwise

Implements EnigmaIOTjsonController.

◆ sendCommandResp() [3/6]

bool CONTROLLER_CLASS_NAME::sendCommandResp	(	const char *	command,
		bool	result
	)

protectedvirtual

Sends command processing response acknowledge.

Parameters

command	Command name
result	Command execution success

Returns: Returns true if message sending was successful. false otherwise

Implements EnigmaIOTjsonController.

◆ sendCommandResp() [4/6]

bool CONTROLLER_CLASS_NAME::sendCommandResp	(	const char *	command,
		bool	result
	)

protectedvirtual

Sends command processing response acknowledge.

Parameters

command	Command name
result	Command execution success

Returns: Returns true if message sending was successful. false otherwise

Implements EnigmaIOTjsonController.

◆ sendCommandResp() [5/6]

bool CONTROLLER_CLASS_NAME::sendCommandResp	(	const char *	command,
		bool	result
	)

protectedvirtual

Sends command processing response acknowledge.

Parameters

command	Command name
result	Command execution success

Returns: Returns true if message sending was successful. false otherwise

Implements EnigmaIOTjsonController.

◆ sendCommandResp() [6/6]

bool CONTROLLER_CLASS_NAME::sendCommandResp	(	const char *	command,
		bool	result
	)

overrideprotectedvirtual

Sends command processing response acknowledge.

Parameters

command	Command name
result	Command execution success

Returns: Returns true if message sending was successful. false otherwise

Implements EnigmaIOTjsonController.

Definition at line 26 of file ButtonController.cpp.

◆ sendLedStatus()

bool CONTROLLER_CLASS_NAME::sendLedStatus ( )

protected

Definition at line 105 of file LedController.cpp.

◆ sendLinkStatus()

bool CONTROLLER_CLASS_NAME::sendLinkStatus ( )

protected

Definition at line 150 of file SmartSwitchController.cpp.

◆ sendRelayStatus()

bool CONTROLLER_CLASS_NAME::sendRelayStatus ( )

protected

Definition at line 138 of file SmartSwitchController.cpp.

◆ sendStartAnouncement() [1/6]

bool CONTROLLER_CLASS_NAME::sendStartAnouncement ( )

inlineprotectedvirtual

Send a message to notify node has started running.

Returns: Returns true if message sending was successful. false otherwise

Implements EnigmaIOTjsonController.

Definition at line 73 of file DashButtonController.h.

◆ sendStartAnouncement() [2/6]

bool CONTROLLER_CLASS_NAME::sendStartAnouncement ( )

inlineprotectedvirtual

Sends a notification message including configurable controller name and protocol version.

Implements EnigmaIOTjsonController.

Definition at line 99 of file BasicController.h.

◆ sendStartAnouncement() [3/6]

bool CONTROLLER_CLASS_NAME::sendStartAnouncement ( )

inlineprotectedvirtual

Send a message to notify node has started running.

Returns: Returns true if message sending was successful. false otherwise

Implements EnigmaIOTjsonController.

Definition at line 78 of file LedController.h.

◆ sendStartAnouncement() [4/6]

bool CONTROLLER_CLASS_NAME::sendStartAnouncement ( )

inlineprotectedvirtual

Send a message to notify node has started running.

Returns: Returns true if message sending was successful. false otherwise

Implements EnigmaIOTjsonController.

Definition at line 81 of file ds18b20Controller.h.

◆ sendStartAnouncement() [5/6]

bool CONTROLLER_CLASS_NAME::sendStartAnouncement ( )

inlineprotectedvirtual

Send a message to notify node has started running.

Returns: Returns true if message sending was successful. false otherwise

Implements EnigmaIOTjsonController.

Definition at line 101 of file SmartSwitchController.h.

◆ sendStartAnouncement() [6/6]

bool CONTROLLER_CLASS_NAME::sendStartAnouncement ( )

inlineoverrideprotectedvirtual

Send a message to notify node has started running.

Returns: Returns true if message sending was successful. false otherwise

Implements EnigmaIOTjsonController.

Definition at line 72 of file ButtonController.h.

◆ sendTemperature()

bool CONTROLLER_CLASS_NAME::sendTemperature ( float temp )

protected

Definition at line 35 of file ds18b20Controller.cpp.

◆ setBoot()

void CONTROLLER_CLASS_NAME::setBoot ( int state )

protected

Definition at line 250 of file SmartSwitchController.cpp.

◆ setLinked()

void CONTROLLER_CLASS_NAME::setLinked ( bool state )

protected

Definition at line 240 of file SmartSwitchController.cpp.

◆ setRelay()

void CONTROLLER_CLASS_NAME::setRelay ( bool state )

protected

Definition at line 227 of file SmartSwitchController.cpp.

◆ setup() [1/6]

void CONTROLLER_CLASS_NAME::setup	(	EnigmaIOTNodeClass *	node,
		void *	config = `NULL`
	)

virtual

Initialize data structures.

Parameters

node	Pointer to EnigmaIOT node instance
config	Pointer to configuration structure. If it is `NULL` then it tries to load configuration from flash

Implements EnigmaIOTjsonController.

Definition at line 40 of file ButtonController.cpp.

◆ setup() [2/6]

void CONTROLLER_CLASS_NAME::setup	(	EnigmaIOTNodeClass *	node,
		void *	config = `NULL`
	)

virtual

Initialize data structures.

Parameters

node	Pointer to EnigmaIOT node instance
config	Pointer to configuration structure. If it is `NULL` then it tries to load configuration from flash

Implements EnigmaIOTjsonController.

◆ setup() [3/6]

void CONTROLLER_CLASS_NAME::setup	(	EnigmaIOTNodeClass *	node,
		void *	data = `NULL`
	)

virtual

Initializes controller structures.

Parameters

node	Pointer to EnigmaIOT gateway instance
data	Parameter data for controller

Implements EnigmaIOTjsonController.

◆ setup() [4/6]

void CONTROLLER_CLASS_NAME::setup	(	EnigmaIOTNodeClass *	node,
		void *	config = `NULL`
	)

virtual

Initialize data structures.

Parameters

node	Pointer to EnigmaIOT node instance
config	Pointer to configuration structure. If it is `NULL` then it tries to load configuration from flash

Implements EnigmaIOTjsonController.

◆ setup() [5/6]

void CONTROLLER_CLASS_NAME::setup	(	EnigmaIOTNodeClass *	node,
		void *	config = `NULL`
	)

virtual

Initialize data structures.

Parameters

node	Pointer to EnigmaIOT node instance
config	Pointer to configuration structure. If it is `NULL` then it tries to load configuration from flash

Implements EnigmaIOTjsonController.

◆ setup() [6/6]

void CONTROLLER_CLASS_NAME::setup	(	EnigmaIOTNodeClass *	node,
		void *	config = `NULL`
	)

virtual

Initialize data structures.

Parameters

node	Pointer to EnigmaIOT node instance
config	Pointer to configuration structure. If it is `NULL` then it tries to load configuration from flash

Implements EnigmaIOTjsonController.

◆ toggleRelay()

void CONTROLLER_CLASS_NAME::toggleRelay ( )

protected

Definition at line 213 of file SmartSwitchController.cpp.

Member Data Documentation

◆ bootStatusListParam

AsyncWiFiManagerParameter* CONTROLLER_CLASS_NAME::bootStatusListParam

protected

Definition at line 61 of file SmartSwitchController.h.

◆ bootStatusParam

AsyncWiFiManagerParameter* CONTROLLER_CLASS_NAME::bootStatusParam

protected

Definition at line 60 of file SmartSwitchController.h.

◆ buttonPinParam

AsyncWiFiManagerParameter* CONTROLLER_CLASS_NAME::buttonPinParam

protected

Definition at line 58 of file SmartSwitchController.h.

◆ buttonPressSent

bool CONTROLLER_CLASS_NAME::buttonPressSent = false

protected

Definition at line 35 of file DashButtonController.h.

◆ config

smartSwitchControllerHw_t CONTROLLER_CLASS_NAME::config

protected

Definition at line 57 of file SmartSwitchController.h.

◆ insideThermometer

DeviceAddress CONTROLLER_CLASS_NAME::insideThermometer

protected

Definition at line 39 of file ds18b20Controller.h.

◆ led

int CONTROLLER_CLASS_NAME::led = _LED_OFF

protected

Definition at line 38 of file LedController.h.

◆ oneWire

OneWire* CONTROLLER_CLASS_NAME::oneWire

protected

Definition at line 37 of file ds18b20Controller.h.

◆ pushReleased

bool CONTROLLER_CLASS_NAME::pushReleased = true

protected

Definition at line 33 of file ButtonController.h.

◆ pushTriggered

bool CONTROLLER_CLASS_NAME::pushTriggered = false

protected

Definition at line 32 of file ButtonController.h.

◆ relayPinParam

AsyncWiFiManagerParameter* CONTROLLER_CLASS_NAME::relayPinParam

protected

Definition at line 59 of file SmartSwitchController.h.

◆ sensors

DallasTemperature* CONTROLLER_CLASS_NAME::sensors

protected

Definition at line 38 of file ds18b20Controller.h.

◆ tempC

float CONTROLLER_CLASS_NAME::tempC

protected

Definition at line 41 of file ds18b20Controller.h.

◆ tempSent

bool CONTROLLER_CLASS_NAME::tempSent = false

protected

Definition at line 40 of file ds18b20Controller.h.

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

examples/EnigmaIOT-Button-Controller/ButtonController.h
examples/EnigmaIOT-DashButton-Controller/DashButtonController.h
examples/EnigmaIOT-Led-Controller/LedController.h
examples/EnigmaIOT-Sensor-Controller/ds18b20Controller.h
examples/EnigmaIOT-SmartSwitch-Controller/SmartSwitchController.h
examples/EnigmaIOT-Json-Controller-Template/BasicController.h
examples/EnigmaIOT-Button-Controller/ButtonController.cpp
examples/EnigmaIOT-DashButton-Controller/DashButtonController.cpp
examples/EnigmaIOT-Json-Controller-Template/BasicController.cpp
examples/EnigmaIOT-Led-Controller/LedController.cpp
examples/EnigmaIOT-Sensor-Controller/ds18b20Controller.cpp
examples/EnigmaIOT-SmartSwitch-Controller/SmartSwitchController.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~CONTROLLER_CLASS_NAME() [1/6]

◆ ~CONTROLLER_CLASS_NAME() [2/6]

◆ ~CONTROLLER_CLASS_NAME() [3/6]

◆ ~CONTROLLER_CLASS_NAME() [4/6]

◆ ~CONTROLLER_CLASS_NAME() [5/6]

◆ ~CONTROLLER_CLASS_NAME() [6/6]

Member Function Documentation

◆ buildHADiscovery() [1/4]

◆ buildHADiscovery() [2/4]

◆ buildHADiscovery() [3/4]

◆ buildHADiscovery() [4/4]

◆ buildHALinkDiscovery()

◆ buildHASwitchDiscovery()

◆ buildHATriggerDiscovery()

◆ configManagerExit() [1/6]

◆ configManagerExit() [2/6]

◆ configManagerExit() [3/6]

◆ configManagerExit() [4/6]

◆ configManagerExit() [5/6]

◆ configManagerExit() [6/6]

◆ configManagerStart() [1/6]

◆ configManagerStart() [2/6]

◆ configManagerStart() [3/6]

◆ configManagerStart() [4/6]

◆ configManagerStart() [5/6]

◆ configManagerStart() [6/6]

◆ connectInform() [1/6]

◆ connectInform() [2/6]

◆ connectInform() [3/6]

◆ connectInform() [4/6]

◆ connectInform() [5/6]

◆ connectInform() [6/6]

◆ defaultConfig()

◆ loadConfig() [1/6]

◆ loadConfig() [2/6]

◆ loadConfig() [3/6]

◆ loadConfig() [4/6]

◆ loadConfig() [5/6]

◆ loadConfig() [6/6]

◆ loop() [1/6]

◆ loop() [2/6]

◆ loop() [3/6]

◆ loop() [4/6]

◆ loop() [5/6]

◆ loop() [6/6]

◆ processRxCommand() [1/6]

◆ processRxCommand() [2/6]

◆ processRxCommand() [3/6]

◆ processRxCommand() [4/6]

◆ processRxCommand() [5/6]

◆ processRxCommand() [6/6]

◆ saveConfig() [1/6]

◆ saveConfig() [2/6]

◆ saveConfig() [3/6]

◆ saveConfig() [4/6]

◆ saveConfig() [5/6]

◆ saveConfig() [6/6]

◆ sendBootStatus()

◆ sendCommandResp() [1/6]

◆ sendCommandResp() [2/6]

◆ sendCommandResp() [3/6]

◆ sendCommandResp() [4/6]

◆ sendCommandResp() [5/6]

◆ sendCommandResp() [6/6]

◆ sendLedStatus()

◆ sendLinkStatus()

◆ sendRelayStatus()

◆ sendStartAnouncement() [1/6]

◆ sendStartAnouncement() [2/6]

◆ sendStartAnouncement() [3/6]

◆ sendStartAnouncement() [4/6]

◆ sendStartAnouncement() [5/6]

◆ sendStartAnouncement() [6/6]

◆ sendTemperature()