Use new modbus_mapping_new_start_address in unit tests
[libmodbus.git] / doc / modbus_write_bits.txt
blob7f1af848848bf98292ecd4e64ed9603110f26808
1 modbus_write_bits(3)
2 ====================
5 NAME
6 ----
7 modbus_write_bits - write many bits
10 SYNOPSIS
11 --------
12 *int modbus_write_bits(modbus_t *'ctx', int 'addr', int 'nb', const uint8_t *'src');*
15 DESCRIPTION
16 -----------
17 The *modbus_write_bits()* function shall write the status of the _nb_ bits
18 (coils) from _src_ at the address _addr_ of the remote device. The
19 _src_ array must contains bytes set to `TRUE` or `FALSE`.
21 The function uses the Modbus function code 0x0F (force multiple coils).
24 RETURN VALUE
25 ------------
26 The function shall return the number of written bits if successful. Otherwise it
27 shall return -1 and set errno.
30 ERRORS
31 ------
32 *EMBMDATA*::
33 Writing too many bits
36 SEE ALSO
37 --------
38 linkmb:modbus_read_bits[3]
39 linkmb:modbus_write_bit[3]
42 AUTHORS
43 -------
44 The libmodbus documentation was written by Stéphane Raimbault
45 <stephane.raimbault@gmail.com>