docs/modbus_rtu_get_rts_delay.md

   1 # modbus_rtu_get_rts_delay
   2
   3 ## Name
   4
   5 modbus_rtu_get_rts_delay - get the current RTS delay in RTU
   6
   7 ## Synopsis
   8
   9 ```c
  10 int modbus_rtu_get_rts_delay(modbus_t *ctx);
  11 ```
  12
  13 ## Description
  14
  15 The `modbus_rtu_get_rts_delay()` function shall get the current Request To Send
  16 delay period of the libmodbus context 'ctx'.
  17
  18 This function can only be used with a context using a RTU backend.
  19
  20 ## Return value
  21
  22 The function shall return the current RTS delay in microseconds if successful.
  23 Otherwise it shall return -1 and set errno to one of the values defined below.
  24
  25 ## Errors
  26
  27 - *EINVAL*, the libmodbus backend is not RTU.
  28
  29 ## See also
  30
  31 - [modbus_rtu_set_rts_delay](modbus_rtu_set_rts_delay.md)