Add SECURITY.md (closes #613)
[libmodbus.git] / doc / modbus_get_float_badc.txt
blob317770d474e8c5e7c1318bfb968bfd09d7706220
1 modbus_get_float_badc(3)
2 ========================
5 NAME
6 ----
7 modbus_get_float_badc - get a float value from 2 registers in BADC byte order
10 SYNOPSIS
11 --------
12 *float modbus_get_float_badc(const uint16_t *'src');*
15 DESCRIPTION
16 -----------
17 The *modbus_get_float_badc()* function shall get a float from 4 bytes with
18 swapped bytes (BADC instead of ABCD). The _src_ array must be a pointer on two
19 16 bits values, for example, if the first word is set to 0x2000 and the second
20 to 0x47F1, the float value will be read as 123456.0.
23 RETURN VALUE
24 ------------
25 The function shall return a float.
28 SEE ALSO
29 --------
30 linkmb:modbus_set_float_badc[3]
31 linkmb:modbus_get_float_abcd[3]
32 linkmb:modbus_get_float_cdab[3]
33 linkmb:modbus_get_float_dcba[3]
36 AUTHORS
37 -------
38 The libmodbus documentation was written by Stéphane Raimbault
39 <stephane.raimbault@gmail.com>