docs/modbus_write_bits.md

   1 # modbus_write_bits
   2
   3 ## Name
   4
   5 modbus_write_bits - write many bits
   6
   7 ## Synopsis
   8
   9 ```c
  10 int modbus_write_bits(modbus_t *ctx, int addr, int nb, const uint8_t *src);
  11 ```
  12
  13 ## Description
  14
  15 The *modbus_write_bits()* function shall write the status of the `nb` bits
  16 (coils) from `src` at the address `addr` of the remote device. The
  17 `src` array must contains bytes set to `TRUE` or `FALSE`.
  18
  19 The function uses the Modbus function code 0x0F (force multiple coils).
  20
  21 ## Return value
  22
  23 The function shall return the number of written bits if successful. Otherwise it
  24 shall return -1 and set errno.
  25
  26 ## Errors
  27
  28 - *EMBMDATA*, writing too many bits.
  29
  30 ## See also
  31
  32 - [modbus_read_bits](modbus_read_bits.md)
  33 - [modbus_write_bit](modbus_write_bit.md)