ioPAC RTU Controllers
C/C++ Sample Code Programming Guide
Modules | Functions
RELAY

Modules

 RELAY_MODE
 

Functions

MODULE_RW_ERR_CODE MX_RTU_Module_Relay_Value_Get (UINT8 slot, UINT32 *value)
 
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_Mode_Get (UINT8 slot, UINT8 start, UINT8 count, UINT8 *buf)
 
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_SigW_L_Get (UINT8 slot, UINT8 start, UINT8 count, UINT32 *buf)
 
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_SigW_H_Get (UINT8 slot, UINT8 start, UINT8 count, UINT32 *buf)
 
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_PWM_Start_Get (UINT8 slot, UINT32 *start)
 
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_PWM_Count_Get (UINT8 slot, UINT8 start, UINT8 count, UINT32 *buf)
 
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_PWM_Config_Get (UINT8 slot, UINT8 start, UINT8 count, float *frequency, float *dutyCycle)
 
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_Total_Count_Get (UINT8 slot, UINT8 start, UINT8 count, UINT32 *buf)
 
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_Current_Count_Get (UINT8 slot, UINT8 start, UINT8 count, UINT32 *buf)
 
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_Value_Set (UINT8 slot, UINT32 value)
 
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_Mode_Set (UINT8 slot, UINT8 start, UINT8 count, UINT8 *buf)
 
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_SigW_L_Set (UINT8 slot, UINT8 start, UINT8 count, UINT32 *buf)
 
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_SigW_H_Set (UINT8 slot, UINT8 start, UINT8 count, UINT32 *buf)
 
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_PWM_Start_Set (UINT8 slot, UINT32 start)
 
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_PWM_Stop_Set (UINT8 slot, UINT32 stop)
 
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_PWM_Count_Set (UINT8 slot, UINT8 start, UINT8 count, UINT32 *buf)
 
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_PWM_Config_Set (UINT8 slot, UINT8 start, UINT8 count, float *frequency, float *dutyCycle)
 
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_Current_Count_Set (UINT8 slot, UINT8 start, UINT8 count, UINT32 *buf)
 

Detailed Description

Sample Code:
relay.c

Function Documentation

MODULE_RW_ERR_CODE MX_RTU_Module_Relay_Value_Get ( UINT8  slot,
UINT32 value 
)
Parameters
[in]slotslot 0: Built-in IO Ports, slot 1 ~ 12: Expansion IO Ports.
[out]valueA bitwise value to indicate all channels' values. The bit 0 represents channel 0's value and so on.
Returns
MODULE_RW_ERR_CODE
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_Mode_Get ( UINT8  slot,
UINT8  start,
UINT8  count,
UINT8 buf 
)
Parameters
[in]slotslot 0: Built-in IO Ports, slot 1 ~ 12: Expansion IO Ports.
[in]startThe first channel to get.
[in]countThe number of channels to get.
[out]bufThe RELAY modes for the corresponding channels.
Returns
MODULE_RW_ERR_CODE
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_SigW_L_Get ( UINT8  slot,
UINT8  start,
UINT8  count,
UINT32 buf 
)
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_SigW_H_Get ( UINT8  slot,
UINT8  start,
UINT8  count,
UINT32 buf 
)
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_PWM_Start_Get ( UINT8  slot,
UINT32 start 
)
Parameters
[in]slotslot 0: Built-in IO Ports, slot 1 ~ 12: Expansion IO Ports.
[out]startA bitwise value to indicate all channels PWMs' status. The bit 0's value represents channel 0's PWM is started or not and so on (0: stop, 1: start).
Returns
MODULE_RW_ERR_CODE
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_PWM_Count_Get ( UINT8  slot,
UINT8  start,
UINT8  count,
UINT32 buf 
)
Parameters
[in]slotslot 0: Built-in IO Ports, slot 1 ~ 12: Expansion IO Ports.
[in]startThe first channel to get.
[in]countThe number of channels to get.
[out]bufThe numbers of PWM count for the corresponding channels.
Returns
MODULE_RW_ERR_CODE
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_PWM_Config_Get ( UINT8  slot,
UINT8  start,
UINT8  count,
float *  frequency,
float *  dutyCycle 
)
Parameters
[in]slotslot 0: Built-in IO Ports, slot 1 ~ 12: Expansion IO Ports.
[in]startThe first channel to get.
[in]countThe number of channels to get.
[out]frequencyThe RELAY PWM frequency (Hz) for the corresponding channels. Range = 0.01Hz ~ MAX supported freqency.
[out]dutyCycleThe RELAY PWM ON duty cycle (%) for the corresponding channels. Range = 0.1% ~ 99.9%.
Returns
MODULE_RW_ERR_CODE
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_Total_Count_Get ( UINT8  slot,
UINT8  start,
UINT8  count,
UINT32 buf 
)
Parameters
[in]slotslot 0: Built-in IO Ports, slot 1 ~ 12: Expansion IO Ports.
[in]startThe first channel to get.
[in]countThe number of channels to get.
[out]bufThe numbers of relay total count for the corresponding channels.
Returns
MODULE_RW_ERR_CODE
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_Current_Count_Get ( UINT8  slot,
UINT8  start,
UINT8  count,
UINT32 buf 
)
Parameters
[in]slotslot 0: Built-in IO Ports, slot 1 ~ 12: Expansion IO Ports.
[in]startThe first channel to get.
[in]countThe number of channels to get.
[out]bufThe numbers of relay current count for the corresponding channels.
Returns
MODULE_RW_ERR_CODE
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_Value_Set ( UINT8  slot,
UINT32  value 
)
Parameters
[in]slotslot 0: Built-in IO Ports, slot 1 ~ 12: Expansion IO Ports.
[in]valueA bitwise value to indicate all channels' values. The bit 0 represents channel 0's value and so on.
Returns
MODULE_RW_ERR_CODE
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_Mode_Set ( UINT8  slot,
UINT8  start,
UINT8  count,
UINT8 buf 
)
Parameters
[in]slotslot 0: Built-in IO Ports, slot 1 ~ 12: Expansion IO Ports.
[in]startThe first channel to set.
[in]countThe number of channels to set.
[in]bufThe RELAY modes for the corresponding channels.
Returns
MODULE_RW_ERR_CODE
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_SigW_L_Set ( UINT8  slot,
UINT8  start,
UINT8  count,
UINT32 buf 
)
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_SigW_H_Set ( UINT8  slot,
UINT8  start,
UINT8  count,
UINT32 buf 
)
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_PWM_Start_Set ( UINT8  slot,
UINT32  start 
)
Parameters
[in]slotslot 0: Built-in IO Ports, slot 1 ~ 12: Expansion IO Ports.
[in]startA bitwise value to indicate all channels PWMs' status. The bit 0's value represents channel 0's PWM will start or not and so on (0: stop, 1: start).
Returns
MODULE_RW_ERR_CODE
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_PWM_Stop_Set ( UINT8  slot,
UINT32  stop 
)
Parameters
[in]slotslot 0: Built-in IO Ports, slot 1 ~ 12: Expansion IO Ports.
[in]stopA bitwise value to indicate all channels PWMs' status. The bit 0's value represents channel 0's PWM will stop or not and so on (0: ignore, 1: stop).
Returns
MODULE_RW_ERR_CODE
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_PWM_Count_Set ( UINT8  slot,
UINT8  start,
UINT8  count,
UINT32 buf 
)
Parameters
[in]slotslot 0: Built-in IO Ports, slot 1 ~ 12: Expansion IO Ports.
[in]startThe first channel to set.
[in]countThe number of channels to set.
[in]bufThe numbers of PWM count for the corresponding channels.
Returns
MODULE_RW_ERR_CODE
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_PWM_Config_Set ( UINT8  slot,
UINT8  start,
UINT8  count,
float *  frequency,
float *  dutyCycle 
)
Parameters
[in]slotslot 0: Built-in IO Ports, slot 1 ~ 12: Expansion IO Ports.
[in]startThe first channel to get.
[in]countThe number of channels to get.
[in]frequencyThe RELAY PWM frequency (Hz) for the corresponding channels. Range = 0.01Hz ~ MAX supported freqency.
[in]dutyCycleThe RELAY PWM ON duty cycle (%) for the corresponding channels. Range = 0.1% ~ 99.9%.
Returns
MODULE_RW_ERR_CODE
MODULE_RW_ERR_CODE MX_RTU_Module_Relay_Current_Count_Set ( UINT8  slot,
UINT8  start,
UINT8  count,
UINT32 buf 
)
Parameters
[in]slotslot 0: Built-in IO Ports, slot 1 ~ 12: Expansion IO Ports.
[in]startThe first channel to get.
[in]countThe number of channels to get.
[in]bufThe numbers of relay current count for the corresponding channels.
Returns
MODULE_RW_ERR_CODE