docs/modbus_read_bits.md

   1 # modbus_read_bits
   2
   3 ## Name
   4
   5 modbus_read_bits - read many bits
   6
   7 ## Synopsis
   8
   9 ```c
  10 int modbus_read_bits(modbus_t *ctx, int addr, int nb, uint8_t *dest);
  11 ```
  12
  13 ## Description
  14
  15 The *modbus_read_bits()* function shall read the status of the `nb` bits (coils)
  16 to the address `addr` of the remote device. The result of reading is stored in
  17 `dest` array as unsigned bytes (8 bits) set to `TRUE` or `FALSE`.
  18
  19 You must take care to allocate enough memory to store the results in `dest`
  20 (at least `nb * sizeof(uint8_t)`).
  21
  22 The function uses the Modbus function code 0x01 (read coil status).
  23
  24 ## Return value
  25
  26 The function shall return the number of read bits if successful. Otherwise it
  27 shall return -1 and set errno.
  28
  29 ## Errors
  30
  31 - *EMBMDATA*, too many bits requested
  32
  33 ## See also
  34
  35 - [modbus_write_bit](modbus_write_bit.md)
  36 - [modbus_write_bits](modbus_write_bits.md)