File: modbus_read_input_bits.md

package info (click to toggle)
libmodbus 3.1.11-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,112 kB
  • sloc: ansic: 5,495; javascript: 137; makefile: 90; sh: 26
file content (35 lines) | stat: -rw-r--r-- 884 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# modbus_read_input_bits

## Name

modbus_read_input_bits - read many input bits

## Synopsis

```c
int modbus_read_input_bits(modbus_t *ctx, int addr, int nb, uint8_t *dest);
```

## Description

The *modbus_read_input_bits()* function shall read the content of the `nb` input
bits to the address `addr` of the remote device. The result of reading is stored
in `dest` array as unsigned bytes (8 bits) set to `TRUE` or `FALSE`.

You must take care to allocate enough memory to store the results in `dest`
(at least `nb * sizeof(uint8_t)`).

The function uses the Modbus function code 0x02 (read input status).

## Return value

The function shall return the number of read input status if
successful. Otherwise it shall return -1 and set errno.

## Errors

- *EMBMDATA*, too many discrete inputs requested

## See also

- [modbus_read_input_registers](modbus_read_input_registers.md)