doc/modbus_set_slave.txt

   1 modbus_set_slave(3)
   2 ===================
   3
   4
   5 NAME
   6 ----
   7 modbus_set_slave - set slave number in the context
   8
   9
  10 SYNOPSIS
  11 --------
  12 *int modbus_set_slave(modbus_t *'ctx', int 'slave');*
  13
  14
  15 DESCRIPTION
  16 -----------
  17 The *modbus_set_slave()* function shall set the slave number in the libmodbus
  18 context.
  19
  20 The behavior depends of network and the role of the device:
  21
  22 *RTU*::
  23 Define the slave ID of the remote device to talk in master mode or set the
  24 internal slave ID in slave mode. According to the protocol, a Modbus device must
  25 only accept message holing its slave number or the special broadcast number.
  26
  27 *TCP*::
  28 The slave number is only required in TCP if the message must reach a device
  29 on a serial network. The special value `MODBUS_TCP_SLAVE` (0xFF) can be used in TCP mode to restore
  30 the default value.
  31
  32 The broadcast address is `MODBUS_BROADCAST_ADDRESS`. This special value must be
  33 use when you want all Modbus devices of the network receive the request.
  34
  35
  36 RETURN VALUE
  37 ------------
  38 The function shall return 0 if successful. Otherwise it shall return -1 and set
  39 errno to one of the values defined below.
  40
  41
  42 ERRORS
  43 ------
  44 *EINVAL*::
  45 The slave number is invalid.
  46
  47
  48 AUTHORS
  49 -------
  50 The libmodbus documentation was written by Stéphane Raimbault
  51 <stephane.raimbault@gmail.com>