modbus_get_byte_timeout


 

Function

 

Retrieves the timeout period between bytes in Modbus communication.

 

Format

 

ret = modbus_get_byte_timeout( ctx , to_sec , to_usec )

 

Parameters

 

ctx [ C : modbus_t * ] [ Python : ctypes.POINTER(modbus_t) ]

Specify the pointer to the libmodbus structure.

 

to_sec [ C : uint32_t * ] [ Python : ctypes.POINTER(ctypes.c_uint32) ]

Specify the pointer to store the part of the timeout period that is more than 1 second (in unit of sec).

 

to_usec [ C : uint32_t * ] [ Python : ctypes.POINTER(ctypes.c_uint32) ]

Specify the pointer to store the part of the timeout period that is less than 1 second (in unit of usec).

 

Return values

 

ret [ C : int ] [ Python : ctypes.c_int ]

If the function succeeds, 0 is returned. If the function fails, -1 is returned.

 

Remarks

 

The timeout setting between bytes in the same message in Modbus communication can be retrieved.

 

Example

 

Retrieves the timeout period.

 

C

int ret;

modbus_t *ctx;

uint32_t to_sec;

uint32_t to_usec;

ret = modbus_get_byte_timeout(ctx, &to_sec, &to_usec);

 

Python

ret = ctypes.c_int

ctx = ctypes.POINTER(modbus_t)

uint32_to_sec = ctypes.c_ulong

uint32_to_usec = ctypes.c_ulong

ret = modbus.modbus_get_byte_timeout(ctx, sec, to_usec)