enums.h File Reference

Go to the source code of this file.

Typedefs
typedef enum E_CALLS	E_CALLS
typedef enum E_MessageFlags	E_MessageFlags
	Enumeration representing different message flags.
typedef enum MB_REGISTER_MODE	MB_REGISTER_MODE
typedef enum MODBUS_ERRORS	MODBUS_ERRORS
typedef enum OBJECT_NET_CAPS	OBJECT_NET_CAPS
typedef enum OBJECT_RUN_FLAGS	OBJECT_RUN_FLAGS

Enumerations
enum	E_CALLS {   EC_NONE = 0x00000000 , EC_COMMAND = 0x00000001 , EC_METHOD = 0x00000002 , EC_FUNC = 0x00000004 ,   EC_USER = 0x00000008 }
enum	E_MessageFlags {   E_MF_NONE = 0x00000000 , E_MF_NEW = 0x00000001 , E_MF_PROCESSING = 0x00000002 , E_MF_PROCESSED = 0x00000004 ,   E_MF_DEBUG = 0x00000008 , E_MF_RECEIPT = 0x0000010 , E_MF_STATE = 0x00000020 }
	Enumeration representing different message flags. More...
enum	MB_FC {   MB_FC_NONE = 0 , MB_FC_READ_COILS = 1 , MB_FC_READ_DISCRETE_INPUT = 2 , MB_FC_READ_REGISTERS = 3 ,   MB_FC_READ_INPUT_REGISTER = 4 , MB_FC_WRITE_COIL = 5 , MB_FC_WRITE_REGISTER = 6 , MB_FC_WRITE_MULTIPLE_COILS = 15 ,   MB_FC_WRITE_MULTIPLE_REGISTERS = 16 }
enum	MB_REGISTER_MODE { E_MB_REGISTER_MODE_NONE = 0 , E_MB_REGISTER_MODE_READ = 1 , E_MB_REGISTER_MODE_WRITE = 2 , E_MB_REGISTER_MODE_READ_WRITE = 3 }
enum	MODBUS_ERRORS {   MODBUS_ERROR_NONE = 0 , MODBUS_ERROR_ILLEGAL_FUNCTION = 1 , MODBUS_ERROR_ILLEGAL_DATA_ADDRESS = 2 , MODBUS_ERROR_ILLEGAL_DATA_VALUE = 3 ,   MODBUS_ERROR_SLAVE_DEVICE_FAILURE = 4 , MODBUS_ERROR_ACKNOWLEDGE = 5 , MODBUS_ERROR_SLAVE_DEVICE_BUSY = 6 , MODBUS_ERROR_MEMORY_PARITY = 8 ,   MODBUS_ERROR_GATEWAY_PATH_UNAVAILABLE = 10 , MODBUS_ERROR_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11 }
enum	OBJECT_NET_CAPS { E_NCAPS_NONE = 0 , E_NCAPS_MODBUS = 1 , E_NCAPS_SERIAL = 2 }
enum	OBJECT_RUN_FLAGS {   E_OF_NONE = 0 , E_OF_DEBUG = 1 , E_OF_INFO = 2 , E_OF_LOOP = 3 ,   E_OF_DISABLED = 4 , E_OF_SETUP = 5 , E_OF_MAIN = 6 , E_OF_BRIDGE = 7 }

Typedef Documentation

E_CALLS

typedef enum E_CALLS E_CALLS

E_MessageFlags

typedef enum E_MessageFlags E_MessageFlags

Enumeration representing different message flags.

This enumeration defines the possible flags that can be associated with a message. Each flag represents a different state or attribute of the message.

MB_REGISTER_MODE

typedef enum MB_REGISTER_MODE MB_REGISTER_MODE

MODBUS_ERRORS

typedef enum MODBUS_ERRORS MODBUS_ERRORS

OBJECT_NET_CAPS

typedef enum OBJECT_NET_CAPS OBJECT_NET_CAPS

OBJECT_RUN_FLAGS

typedef enum OBJECT_RUN_FLAGS OBJECT_RUN_FLAGS

Enumeration Type Documentation

E_CALLS

enum E_CALLS

Enumerator
EC_NONE	Call a global registered command . Call a global registered command .
EC_COMMAND	Call component method (See Bridge::registerMemberFunction & Component::onRegisterMethods)
EC_METHOD	Function call type.
EC_FUNC	User-defined call type.
EC_USER

Definition at line 31 of file enums.h.

{
 
    EC_NONE = 0x00000000,
 
    EC_COMMAND = 0x00000001,
 
    EC_METHOD = 0x00000002,
 
    EC_FUNC = 0x00000004,
 
    EC_USER = 0x00000008
} E_CALLS;

E_MessageFlags

enum E_MessageFlags

Enumeration representing different message flags.

This enumeration defines the possible flags that can be associated with a message. Each flag represents a different state or attribute of the message.

Enumerator
E_MF_NONE	Internal: no flags Internal: flag designating an unprocessed message
E_MF_NEW	Internal: Processing message flag
E_MF_PROCESSING	Internal: Processed message flag
E_MF_PROCESSED	Internal: Debug message during processing
E_MF_DEBUG	Sender: Instruct to send a receipt - Default:On
E_MF_RECEIPT	Sender: Instruct to return component state
E_MF_STATE

Definition at line 51 of file enums.h.

{
 
    E_MF_NONE = 0x00000000,
 
    E_MF_NEW = 0x00000001,
 
    E_MF_PROCESSING = 0x00000002,
 
    E_MF_PROCESSED = 0x00000004,
 
    E_MF_DEBUG = 0x00000008,
 
    E_MF_RECEIPT = 0x0000010,
 
    E_MF_STATE = 0x00000020
} E_MessageFlags;

MB_FC

enum MB_FC

Enumerator
MB_FC_NONE	null operator
MB_FC_READ_COILS	FCT=1 -> read coils or digital outputs
MB_FC_READ_DISCRETE_INPUT	FCT=2 -> read digital inputs
MB_FC_READ_REGISTERS	FCT=3 -> read registers or analog outputs
MB_FC_READ_INPUT_REGISTER	FCT=4 -> read analog inputs
MB_FC_WRITE_COIL	FCT=5 -> write single coil or output
MB_FC_WRITE_REGISTER	FCT=6 -> write single register
MB_FC_WRITE_MULTIPLE_COILS	FCT=15 -> write multiple coils or outputs
MB_FC_WRITE_MULTIPLE_REGISTERS	FCT=16 -> write multiple registers

Definition at line 69 of file enums.h.

{
    MB_FC_NONE = 0,                     
    MB_FC_READ_COILS = 1,               
    MB_FC_READ_DISCRETE_INPUT = 2,      
    MB_FC_READ_REGISTERS = 3,           
    MB_FC_READ_INPUT_REGISTER = 4,      
    MB_FC_WRITE_COIL = 5,               
    MB_FC_WRITE_REGISTER = 6,           
    MB_FC_WRITE_MULTIPLE_COILS = 15,    
    MB_FC_WRITE_MULTIPLE_REGISTERS = 16 
} MB_FC;

MB_REGISTER_MODE

enum MB_REGISTER_MODE

Enumerator
E_MB_REGISTER_MODE_NONE
E_MB_REGISTER_MODE_READ
E_MB_REGISTER_MODE_WRITE
E_MB_REGISTER_MODE_READ_WRITE

Definition at line 23 of file enums.h.

{
    E_MB_REGISTER_MODE_NONE = 0,
    E_MB_REGISTER_MODE_READ = 1,
    E_MB_REGISTER_MODE_WRITE = 2,
    E_MB_REGISTER_MODE_READ_WRITE = 3,
} MB_REGISTER_MODE;

MODBUS_ERRORS

enum MODBUS_ERRORS

Enumerator
MODBUS_ERROR_NONE	No error
MODBUS_ERROR_ILLEGAL_FUNCTION	Illegal function error
MODBUS_ERROR_ILLEGAL_DATA_ADDRESS	Illegal data address error
MODBUS_ERROR_ILLEGAL_DATA_VALUE	Illegal data value error
MODBUS_ERROR_SLAVE_DEVICE_FAILURE	Slave device failure error
MODBUS_ERROR_ACKNOWLEDGE	Acknowledge error
MODBUS_ERROR_SLAVE_DEVICE_BUSY	Slave device busy error
MODBUS_ERROR_MEMORY_PARITY	Memory parity error
MODBUS_ERROR_GATEWAY_PATH_UNAVAILABLE	Gateway path unavailable error
MODBUS_ERROR_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND	Gateway target device failed to respond error

Definition at line 82 of file enums.h.

{
    MODBUS_ERROR_NONE = 0,                                    
    MODBUS_ERROR_ILLEGAL_FUNCTION = 1,                        
    MODBUS_ERROR_ILLEGAL_DATA_ADDRESS = 2,                    
    MODBUS_ERROR_ILLEGAL_DATA_VALUE = 3,                      
    MODBUS_ERROR_SLAVE_DEVICE_FAILURE = 4,                    
    MODBUS_ERROR_ACKNOWLEDGE = 5,                             
    MODBUS_ERROR_SLAVE_DEVICE_BUSY = 6,                       
    MODBUS_ERROR_MEMORY_PARITY = 8,                           
    MODBUS_ERROR_GATEWAY_PATH_UNAVAILABLE = 10,               
    MODBUS_ERROR_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11 
} MODBUS_ERRORS;

OBJECT_NET_CAPS

enum OBJECT_NET_CAPS

Enumerator
E_NCAPS_NONE
E_NCAPS_MODBUS
E_NCAPS_SERIAL

Definition at line 16 of file enums.h.

{
    E_NCAPS_NONE = 0,
    E_NCAPS_MODBUS = 1,
    E_NCAPS_SERIAL = 2,
} OBJECT_NET_CAPS;

OBJECT_RUN_FLAGS

enum OBJECT_RUN_FLAGS

Enumerator
E_OF_NONE	No run flag
E_OF_DEBUG	Enable debug call, per frame
E_OF_INFO	Enable info print during boot
E_OF_LOOP	Enable loop invocation on the main loop
E_OF_DISABLED	Disable component entirely
E_OF_SETUP	Enable setup invocation during boot
E_OF_MAIN	reserved
E_OF_BRIDGE	Component registers methods on the Bridge

Definition at line 4 of file enums.h.

{
    E_OF_NONE = 0,     
    E_OF_DEBUG = 1,    
    E_OF_INFO = 2,     
    E_OF_LOOP = 3,     
    E_OF_DISABLED = 4, 
    E_OF_SETUP = 5,    
    E_OF_MAIN = 6,     
    E_OF_BRIDGE = 7    
} OBJECT_RUN_FLAGS;