modbus_rtu_get_rts.txt 832 B

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. modbus_rtu_get_rts(3)
  2. =====================
  3. NAME
  4. ----
  5. modbus_rtu_get_rts - get the current RTS mode in RTU
  6. SYNOPSIS
  7. --------
  8. *int modbus_rtu_get_rts(modbus_t *'ctx');*
  9. DESCRIPTION
  10. -----------
  11. The *modbus_rtu_get_rts()* function shall get the current Request To Send mode
  12. of the libmodbus context _ctx_. The possible returned values are:
  13. * MODBUS_RTU_RTS_NONE
  14. * MODBUS_RTU_RTS_UP
  15. * MODBUS_RTU_RTS_DOWN
  16. This function can only be used with a context using a RTU backend.
  17. RETURN VALUE
  18. ------------
  19. The function shall return the current RTS mode if successful. Otherwise it shall
  20. return -1 and set errno.
  21. ERRORS
  22. ------
  23. *EINVAL*::
  24. The libmodbus backend is not RTU.
  25. SEE ALSO
  26. --------
  27. linkmb:modbus_rtu_set_rts[3]
  28. AUTHORS
  29. -------
  30. The libmodbus documentation was written by Stéphane Raimbault
  31. <stephane.raimbault@gmail.com>