doc/modbus_read_bits.txt

   1 modbus_read_bits(3)
   2 ===================
   3
   4
   5 NAME
   6 ----
   7 modbus_read_bits - read many bits
   8
   9
  10 SYNOPSIS
  11 --------
  12 *int modbus_read_bits(modbus_t *'ctx', int 'addr', int 'nb', uint8_t *'dest');*
  13
  14
  15 DESCRIPTION
  16 -----------
  17 The *modbus_read_bits()* function shall read the status of the _nb_ bits (coils)
  18 to the address _addr_ of the remote device. The result of reading is stored in
  19 _dest_ array as unsigned bytes (8 bits) set to `TRUE` or `FALSE`.
  20
  21 You must take care to allocate enough memory to store the results in _dest_
  22 (at least _nb_ * sizeof(uint8_t)).
  23
  24 The function uses the Modbus function code 0x01 (read coil status).
  25
  26
  27 RETURN VALUE
  28 ------------
  29 The function shall return the number of read bits if successful. Otherwise it
  30 shall return -1 and set errno.
  31
  32
  33 ERRORS
  34 ------
  35 *EMBMDATA*::
  36 Too many bits requested
  37
  38
  39 SEE ALSO
  40 --------
  41 linkmb:modbus_write_bit[3]
  42 linkmb:modbus_write_bits[3]
  43
  44
  45 AUTHORS
  46 -------
  47 The libmodbus documentation was written by Stéphane Raimbault
  48 <stephane.raimbault@gmail.com>