doc/modbus_read_input_registers.txt

   1 modbus_read_input_registers(3)
   2 ==============================
   3
   4
   5 NAME
   6 ----
   7 modbus_read_input_registers - read many input registers
   8
   9
  10 SYNOPSIS
  11 --------
  12 *int modbus_read_input_registers(modbus_t *'ctx', int 'addr', int 'nb', uint16_t *'dest');*
  13
  14
  15 DESCRIPTION
  16 -----------
  17 The *modbus_read_input_registers()* function shall read the content of the _nb_
  18 input registers to address _addr_ of the remote device. The result of the
  19 reading is stored in _dest_ array as word values (16 bits).
  20
  21 You must take care to allocate enough memory to store the results in _dest_ (at
  22 least _nb_ * sizeof(uint16_t)).
  23
  24 The function uses the Modbus function code 0x04 (read input registers). The
  25 holding registers and input registers have different historical meaning, but
  26 nowadays it's more common to use holding registers only.
  27
  28
  29 RETURN VALUE
  30 ------------
  31 The function shall return the number of read input registers if
  32 successful. Otherwise it shall return -1 and set errno.
  33
  34
  35 ERRORS
  36 ------
  37 *EMBMDATA*::
  38 Too many bits requested
  39
  40
  41 SEE ALSO
  42 --------
  43 linkmb:modbus_read_input_bits[3]
  44 linkmb:modbus_write_register[3]
  45 linkmb:modbus_write_registers[3]
  46
  47
  48 AUTHORS
  49 -------
  50 The libmodbus documentation was written by Stéphane Raimbault
  51 <stephane.raimbault@gmail.com>