Data Acquisition Framework
API for Tags Programming
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Modules
Typedefs | Functions
Modbus object

Typedefs

typedef struct mxmodbus_ mxmodbus
 mxmodbus instance
 

Functions

mxmodbusmxmodbus_new ()
 Create mxmodbus. More...
 
void mxmodbus_delete (mxmodbus *self)
 Delete mxmodbus instance. More...
 
int mxmodbus_read (mxmodbus *self, const char *equipment_name, const char *tag_name, int timeout_ms, value_t *value, value_type_t *value_type)
 Read Modbus tag. More...
 
int mxmodbus_write (mxmodbus *self, const char *equipment_name, const char *tag_name, int timeout_ms, value_t value, value_type_t value_type)
 Write Modbus tag. More...
 

Detailed Description

Function Documentation

void mxmodbus_delete ( mxmodbus self)

Delete mxmodbus instance.

See also
mxmodbus_new()
Parameters
[in]selfInstance to be deleted
mxmodbus* mxmodbus_new ( )

Create mxmodbus.

Returns
Return mxmodbus instance.
Return NULL on failure.
See also
mxmodbus_delete()
int mxmodbus_read ( mxmodbus self,
const char *  equipment_name,
const char *  tag_name,
int  timeout_ms,
value_t value,
value_type_t value_type 
)

Read Modbus tag.

See also
mxmodbus_write()
Parameters
[in]selfmodbus instance
[in]equipment_nameEquipment Name
[in]tag_nameTag Name
[in]timeout_msread timeout in millisecond
[out]valueTag Value
[out]value_typeTag Value's Type
int mxmodbus_write ( mxmodbus self,
const char *  equipment_name,
const char *  tag_name,
int  timeout_ms,
value_t  value,
value_type_t  value_type 
)

Write Modbus tag.

See also
mxmodbus_read()
Parameters
[in]selfModbus instance
[in]equipment_nameEquipment name
[in]tag_nameTag name
[in]timeout_msWrite timeout in milliseconds
[in]valueTag value
[in]value_typeTag value type