modbus_get_byte_from_bits.txt 794 B

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