GatewayOutput_dummy Class Reference

#include <GwOutput_dummy.h>

Inheritance diagram for GatewayOutput_dummy:

Public Member Functions
void	configManagerStart (EnigmaIOTGatewayClass *enigmaIotGw)
	Called when wifi manager starts config portal. More...
void	configManagerExit (bool status)
	Called when wifi manager exits config portal. More...
bool	begin ()
	Starts output module. More...
bool	loadConfig ()
	Loads output module configuration. More...
bool	outputControlSend (char *address, uint8_t *data, size_t length)
	Send control data from nodes. More...
bool	newNodeSend (char *address, uint16_t node_id)
	Send new node notification. More...
bool	nodeDisconnectedSend (char *address, gwInvalidateReason_t reason)
	Send node disconnection notification. More...
bool	outputDataSend (char *address, char *data, size_t length, GwOutput_data_type_t type=data)
	Send data from nodes. More...
void	loop ()
	Should be called often for module management. More...
void	setDlCallback (onDlData_t cb)
	Set data processing function. More...
Public Member Functions inherited from GatewayOutput_generic
void	setDlCallback (onDlData_t cb)
	Set data processing function. More...

Public Attributes
String	netName
	EnigmaIOT network name. More...
String	clientId
	clientId More...
String	gwTopic
	topic for gateway More...
Public Attributes inherited from GatewayOutput_generic
String	netName
	EnigmaIOT network name. More...
String	clientId
	MQTT clientId. More...
String	gwTopic
	MQTT topic for gateway. More...

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

Protected Attributes
EnigmaIOTGatewayClass *	enigmaIotGateway
	Pointer to EnigmaIOT gateway instance. More...
onDlData_t	downlinkCb
	downlink processing function handle More...
Protected Attributes inherited from GatewayOutput_generic
EnigmaIOTGatewayClass *	enigmaIotGateway
	Pointer to EnigmaIOT gateway instance. More...
onDlData_t	downlinkCb
	downlink processing function handle More...

Detailed Description

Definition at line 22 of file GwOutput_dummy.h.

Member Function Documentation

begin()

bool GatewayOutput_dummy::begin ( )

virtual

Starts output module.

Returns

Returns true if successful. false otherwise

Implements GatewayOutput_generic.

Definition at line 48 of file GwOutput_dummy.cpp.

configManagerExit()

void GatewayOutput_dummy::configManagerExit ( bool  status )

virtual

Called when wifi manager exits config portal.

Parameters

status

true if configuration was successful

Implements GatewayOutput_generic.

Definition at line 44 of file GwOutput_dummy.cpp.

configManagerStart()

void GatewayOutput_dummy::configManagerStart ( EnigmaIOTGatewayClass *  enigmaIotGw )

virtual

Called when wifi manager starts config portal.

Parameters

enigmaIotGw

Pointer to EnigmaIOT gateway instance

Implements GatewayOutput_generic.

Definition at line 31 of file GwOutput_dummy.cpp.

loadConfig()

bool GatewayOutput_dummy::loadConfig ( )

virtual

Loads output module configuration.

Returns

Returns true if load was successful. false otherwise

Implements GatewayOutput_generic.

Definition at line 39 of file GwOutput_dummy.cpp.

loop()

void GatewayOutput_dummy::loop ( )

virtual

Should be called often for module management.

Implements GatewayOutput_generic.

Definition at line 54 of file GwOutput_dummy.cpp.

newNodeSend()

bool GatewayOutput_dummy::newNodeSend ( char *  address, uint16_t  node_id  )

virtual

Send new node notification.

Parameters

address	Node Address
node_id	Node Id

Returns

Returns true if sending was successful. false otherwise

Implements GatewayOutput_generic.

Definition at line 68 of file GwOutput_dummy.cpp.

nodeDisconnectedSend()

bool GatewayOutput_dummy::nodeDisconnectedSend ( char *  address, gwInvalidateReason_t  reason  )

virtual

Send node disconnection notification.

Parameters

address	Node Address
reason	Disconnection reason code

Returns

Returns true if sending was successful. false otherwise

Implements GatewayOutput_generic.

Definition at line 73 of file GwOutput_dummy.cpp.

outputControlSend()

bool GatewayOutput_dummy::outputControlSend ( char *  address, uint8_t *  data, size_t  length  )

virtual

Send control data from nodes.

Parameters

address	Node Address
data	Message data buffer
length	Data buffer length

Returns

Returns true if sending was successful. false otherwise

Implements GatewayOutput_generic.

Definition at line 63 of file GwOutput_dummy.cpp.

outputDataSend()

bool GatewayOutput_dummy::outputDataSend ( char *  address, char *  data, size_t  length, GwOutput_data_type_t  type = data  )

virtual

Send data from nodes.

Parameters

address	Node Address
data	Message data buffer
length	Data buffer length
type	Type of message

Returns

Returns true if sending was successful. false otherwise

Implements GatewayOutput_generic.

Definition at line 58 of file GwOutput_dummy.cpp.

saveConfig()

bool GatewayOutput_dummy::saveConfig ( )

protectedvirtual

Saves output module configuration.

Returns

Returns true if save was successful. false otherwise

Implements GatewayOutput_generic.

Definition at line 35 of file GwOutput_dummy.cpp.

setDlCallback()

void GatewayOutput_dummy::setDlCallback ( onDlData_t  cb )

inline

Set data processing function.

Parameters

cb	Function handle

Definition at line 109 of file GwOutput_dummy.h.

Member Data Documentation

clientId

String GatewayOutput_dummy::clientId

clientId

Definition at line 35 of file GwOutput_dummy.h.

downlinkCb

onDlData_t GatewayOutput_dummy::downlinkCb

protected

downlink processing function handle

Definition at line 25 of file GwOutput_dummy.h.

enigmaIotGateway

EnigmaIOTGatewayClass* GatewayOutput_dummy::enigmaIotGateway

protected

Pointer to EnigmaIOT gateway instance.

Definition at line 24 of file GwOutput_dummy.h.

gwTopic

String GatewayOutput_dummy::gwTopic

topic for gateway

Definition at line 36 of file GwOutput_dummy.h.

netName

String GatewayOutput_dummy::netName

EnigmaIOT network name.

Definition at line 34 of file GwOutput_dummy.h.

---

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

• examples/EnigmaIOTGatewayDummy/GwOutput_dummy.h
• examples/EnigmaIOTGatewayDummy/GwOutput_dummy.cpp