Addon Class Reference

#include <Addon.h>

Inheritance diagram for Addon:

Static Public Attributes
static const int	ADDON_FLAGS_DEFAULT = 1 << OBJECT_RUN_FLAGS::E_OF_LOOP | 1 << OBJECT_RUN_FLAGS::E_OF_INFO | 1 << OBJECT_RUN_FLAGS::E_OF_SETUP
Static Public Attributes inherited from Component
static const int	COMPONENT_DEFAULT = 1 << OBJECT_RUN_FLAGS::E_OF_LOOP | 1 << OBJECT_RUN_FLAGS::E_OF_SETUP
	The default run flags for a component.
static const int	COMPONENT_NO_ID = 0
	The default ID for a component.

Additional Inherited Members
Public Member Functions inherited from Component
void	clearFlag (byte flag)
	Clears a specific flag for the component.
	Component ()
	Default constructor for the Component class.
	Component (String _name)
	Constructor for the Component class with a specified name.
	Component (String _name, short _id)
	Constructor for the Component class with a specified name and ID.
	Component (String _name, short _id, int _flags)
	Constructor for the Component class with a specified name, ID, and flags.
	Component (String _name, short _id, int _flags, Component *_owner)
	Constructor for the Component class with a specified name, ID, flags, and owner.
virtual short	debug ()
	Virtual function to debug the component.
virtual short	debug (short val0, short val1)
	Virtual function to debug the component.
virtual short	destroy ()
	Virtual function to destroy the component.
void	disable ()
	Disables the component.
void	enable ()
	Enables the component.
bool	enabled ()
	Checks if the component is enabled.
bool	hasFlag (byte flag)
	Checks if the component has a specific flag.
virtual short	info ()
	Virtual function to display information about the component.
virtual short	info (short val0, short val1)
	Virtual function to display information about the component.
virtual short	loop ()
	Virtual function to run the component in a loop.
virtual short	onError (short id, short error)
virtual short	onMessage (int id, E_CALLS verb, E_MessageFlags flags, const void *user, Component *src)
	Handles incoming messages.
virtual short	onRawResponse (short size, uint8_t rxBuffer[])
virtual short	onRegisterMethods (Bridge *bridge)
virtual short	onResponse (short error)
void	setFlag (byte flag)
	Sets a specific flag for the component.
virtual short	setup ()
	Virtual function to set up the component.
	~Component ()
	Destructor for the Component class.
Public Member Functions inherited from ModbusGateway
short	getAddress ()
MB_FC	getFunctionCode ()
short	getNumberAddresses ()
virtual String	getRegisterDescription (short flags=0)
const char *	getRegisterMode ()
	ModbusGateway ()
	ModbusGateway (short _addr)
	ModbusGateway (short _addr, short _fc)
void	setAddress (short _addr)
void	setFunctionCode (MB_FC fc)
void	setGateway (Mudbus *mudbus)
void	setNumberAddresses (short _nbAddr)
void	setRegisterMode (MB_REGISTER_MODE mode)
Public Attributes inherited from Component
int	flags
	The run flags for the component.
const short	id
	The ID of the component.
millis_t	last
	The last tick time in milliseconds.
String	name
	The name of the component.
int	nFlags
	The network capabilities of the component.
millis_t	now
	The current time in milliseconds.
Component *	owner
	The owner of the component.
Public Attributes inherited from ModbusGateway
short	addr
MB_FC	fn
uchar	lastMQSlot
Mudbus *	mudbus
short	nbAddr
short	registerMode

Detailed Description

Definition at line 13 of file Addon.h.

Member Data Documentation

ADDON_FLAGS_DEFAULT

const int Addon::ADDON_FLAGS_DEFAULT = 1 << OBJECT_RUN_FLAGS::E_OF_LOOP | 1 << OBJECT_RUN_FLAGS::E_OF_INFO | 1 << OBJECT_RUN_FLAGS::E_OF_SETUP

static

Definition at line 17 of file Addon.h.

---

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

• Addon.h