Peter M. Groen / libmodbus

Commit 4a303e94c780268d300a7e7483fd626f1b8f13df

Authored by Stéphane Raimbault
1 parent 1e62dd09

Add missing documentation of modbus_set_float functions

Inline Side-by-side
Showing 7 changed files with 121 additions and 4 deletions
doc/Makefile.am
  View file @4a303e9
... ... @@ -43,6 +43,9 @@ TXT3 = \
43 43 modbus_set_debug.txt \
44 44 modbus_set_error_recovery.txt \
45 45 modbus_set_float.txt \
  46 + modbus_set_float_abcd.txt \
  47 + modbus_set_float_badc.txt \
  48 + modbus_set_float_cdab.txt \
46 49 modbus_set_float_dcba.txt \
47 50 modbus_set_response_timeout.txt \
48 51 modbus_set_slave.txt \
... ...
doc/modbus_get_float_abcd.txt
  View file @4a303e9
... ... @@ -28,9 +28,9 @@ The function shall return a float.
28 28 SEE ALSO
29 29 --------
30 30 linkmb:modbus_set_float_abcd[3]
31   -linkmb:modbus_get_float_dcba[3]
32 31 linkmb:modbus_get_float_badc[3]
33 32 linkmb:modbus_get_float_cdab[3]
  33 +linkmb:modbus_get_float_dcba[3]
34 34  
35 35  
36 36 AUTHORS
... ...
doc/modbus_get_float_badc.txt
  View file @4a303e9
... ... @@ -14,7 +14,6 @@ SYNOPSIS
14 14  
15 15 DESCRIPTION
16 16 -----------
17   -
18 17 The *modbus_get_float_badc()* function shall get a float from 4 bytes with
19 18 swapped bytes (BADC instead of ABCD). The _src_ array must be a pointer on two
20 19 16 bits values, for example, if the first word is set to 0x2000 and the second
... ... @@ -30,8 +29,8 @@ SEE ALSO
30 29 --------
31 30 linkmb:modbus_set_float_badc[3]
32 31 linkmb:modbus_get_float_abcd[3]
33   -linkmb:modbus_get_float_dcba[3]
34 32 linkmb:modbus_get_float_cdab[3]
  33 +linkmb:modbus_get_float_dcba[3]
35 34  
36 35  
37 36 AUTHORS
... ...
doc/modbus_get_float_cdab.txt
  View file @4a303e9
... ... @@ -29,8 +29,8 @@ SEE ALSO
29 29 --------
30 30 linkmb:modbus_set_float_cdab[3]
31 31 linkmb:modbus_get_float_abcd[3]
32   -linkmb:modbus_get_float_dcba[3]
33 32 linkmb:modbus_get_float_badc[3]
  33 +linkmb:modbus_get_float_dcba[3]
34 34  
35 35  
36 36 AUTHORS
... ...
doc/modbus_set_float_abcd.txt 0 → 100644
  View file @4a303e9
  1 +modbus_set_float_abcd(3)
  2 +========================
  3 +
  4 +
  5 +NAME
  6 +----
  7 +modbus_set_float_abcd - set a float value in 2 registers using ABCD byte order
  8 +
  9 +
  10 +SYNOPSIS
  11 +--------
  12 +*void modbus_set_float_abcd(float 'f', uint16_t *'dest');*
  13 +
  14 +
  15 +DESCRIPTION
  16 +-----------
  17 +The *modbus_set_float_abcd()* function shall set a float to 4 bytes in usual
  18 +Modbus format. The _dest_ array must be pointer on two 16 bits values to be able
  19 +to store the full result of the conversion.
  20 +
  21 +
  22 +RETURN VALUE
  23 +------------
  24 +There is no return values.
  25 +
  26 +
  27 +SEE ALSO
  28 +--------
  29 +linkmb:modbus_get_float_abcd[3]
  30 +linkmb:modbus_set_float_badc[3]
  31 +linkmb:modbus_set_float_cdab[3]
  32 +linkmb:modbus_set_float_dcba[3]
  33 +
  34 +
  35 +AUTHORS
  36 +-------
  37 +The libmodbus documentation was written by Stéphane Raimbault
  38 +<stephane.raimbault@gmail.com>
... ...
doc/modbus_set_float_badc.txt 0 → 100644
  View file @4a303e9
  1 +modbus_set_float_badc(3)
  2 +========================
  3 +
  4 +
  5 +NAME
  6 +----
  7 +modbus_set_float_badc - set a float value in 2 registers using BADC byte order
  8 +
  9 +
  10 +SYNOPSIS
  11 +--------
  12 +*void modbus_set_float_badc(float 'f', uint16_t *'dest');*
  13 +
  14 +
  15 +DESCRIPTION
  16 +-----------
  17 +The *modbus_set_float_badc()* function shall set a float to 4 bytes in swapped
  18 +bytes Modbus format (BADC insted of ABCD). The _dest_ array must be pointer on
  19 +two 16 bits values to be able to store the full result of the conversion.
  20 +
  21 +
  22 +RETURN VALUE
  23 +------------
  24 +There is no return values.
  25 +
  26 +
  27 +SEE ALSO
  28 +--------
  29 +linkmb:modbus_get_float_badc[3]
  30 +linkmb:modbus_set_float_abcd[3]
  31 +linkmb:modbus_set_float_cdab[3]
  32 +linkmb:modbus_set_float_dcba[3]
  33 +
  34 +
  35 +AUTHORS
  36 +-------
  37 +The libmodbus documentation was written by Stéphane Raimbault
  38 +<stephane.raimbault@gmail.com>
... ...
doc/modbus_set_float_cdab.txt 0 → 100644
  View file @4a303e9
  1 +modbus_set_float_cdab(3)
  2 +========================
  3 +
  4 +
  5 +NAME
  6 +----
  7 +modbus_set_float_cdab - set a float value in 2 registers using CDAB byte order
  8 +
  9 +
  10 +SYNOPSIS
  11 +--------
  12 +*void modbus_set_float_cdab(float 'f', uint16_t *'dest');*
  13 +
  14 +
  15 +DESCRIPTION
  16 +-----------
  17 +The *modbus_set_float_cdab()* function shall set a float to 4 bytes in swapped
  18 +words Modbus format (CDAB order instead of ABCD). The _dest_ array must be
  19 +pointer on two 16 bits values to be able to store the full result of the
  20 +conversion.
  21 +
  22 +
  23 +RETURN VALUE
  24 +------------
  25 +There is no return values.
  26 +
  27 +
  28 +SEE ALSO
  29 +--------
  30 +linkmb:modbus_get_float_cdab[3]
  31 +linkmb:modbus_set_float_abcd[3]
  32 +linkmb:modbus_set_float_badc[3]
  33 +linkmb:modbus_set_float_dcba[3]
  34 +
  35 +
  36 +AUTHORS
  37 +-------
  38 +The libmodbus documentation was written by Stéphane Raimbault
  39 +<stephane.raimbault@gmail.com>
... ...