File: modbus_get_byte_from_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 (26 lines) | stat: -rw-r--r-- 642 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
# modbus_get_byte_from_bits

## Name

modbus_get_byte_from_bits - get the value from many bits

## Synopsis

```c
uint8_t modbus_get_byte_from_bits(const uint8_t *src, int index, unsigned int nb_bits);
```

## Description

The *modbus_get_byte_from_bits()* function shall extract a value from many
bits. All `nb_bits` bits from `src` at position `index` will be read as a
single value. To obtain a full byte, set `nb_bits` to 8.

## Return value

The function shall return a byte containing the bits read.

## See also

- [modbus_set_bits_from_byte](modbus_set_bits_from_byte.md)
- [modbus_set_bits_from_bytes](modbus_set_bits_from_bytes.md)