doc/modbus_get_byte_from_bits.txt

   1 modbus_get_byte_from_bits(3)
   2 ============================
   3
   4 NAME
   5 ----
   6 modbus_get_byte_from_bits - get the value from many bits
   7
   8
   9 SYNOPSIS
  10 --------
  11 *uint8_t modbus_get_byte_from_bits(const uint8_t *'src', int 'index', unsigned int 'nb_bits');*
  12
  13
  14 DESCRIPTION
  15 -----------
  16 The *modbus_get_byte_from_bits()* function shall extract a value from many
  17 bits. All _nb_bits_ bits from _src_ at position _index_ will be read as a
  18 single value. To obtain a full byte, set nb_bits to 8.
  19
  20
  21 RETURN VALUE
  22 ------------
  23 The function shall return a byte containing the bits read.
  24
  25
  26 SEE ALSO
  27 --------
  28 linkmb:modbus_set_bits_from_byte[3]
  29 linkmb:modbus_set_bits_from_bytes[3]
  30
  31
  32 AUTHORS
  33 -------
  34 The libmodbus documentation was written by Stéphane Raimbault
  35 <stephane.raimbault@gmail.com>