Add SECURITY.md (closes #613)
[libmodbus.git] / doc / modbus_get_float.txt
blob023c0bb502456b828a685070057d9661e5980e38
1 modbus_get_float(3)
2 ===================
5 NAME
6 ----
7 modbus_get_float - get a float value from 2 registers
10 SYNOPSIS
11 --------
12 *float modbus_get_float(const uint16_t *'src');*
14 Warning, this function is *deprecated* since libmodbus v3.2.0 and has been
15 replaced by *modbus_get_float_dcba()*.
17 DESCRIPTION
18 -----------
19 The *modbus_get_float()* function shall get a float from 4 bytes in Modbus
20 format (DCBA byte order). The _src_ array must be a pointer on two 16 bits
21 values, for example, if the first word is set to 0x4465 and the second to
22 0x229a, the float value will be 916.540649.
25 RETURN VALUE
26 ------------
27 The function shall return a float.
30 SEE ALSO
31 --------
32 linkmb:modbus_set_float[3]
33 linkmb:modbus_set_float_dcba[3]
34 linkmb:modbus_get_float_dcba[3]
36 AUTHORS
37 -------
38 The libmodbus documentation was written by Stéphane Raimbault
39 <stephane.raimbault@gmail.com>