diff --git a/doc/Makefile.am b/doc/Makefile.am index 3e06aba..61ab5d5 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -43,6 +43,9 @@ TXT3 = \ modbus_set_debug.txt \ modbus_set_error_recovery.txt \ modbus_set_float.txt \ + modbus_set_float_abcd.txt \ + modbus_set_float_badc.txt \ + modbus_set_float_cdab.txt \ modbus_set_float_dcba.txt \ modbus_set_response_timeout.txt \ modbus_set_slave.txt \ diff --git a/doc/modbus_get_float_abcd.txt b/doc/modbus_get_float_abcd.txt index b715a9c..6a491b2 100644 --- a/doc/modbus_get_float_abcd.txt +++ b/doc/modbus_get_float_abcd.txt @@ -28,9 +28,9 @@ The function shall return a float. SEE ALSO -------- linkmb:modbus_set_float_abcd[3] -linkmb:modbus_get_float_dcba[3] linkmb:modbus_get_float_badc[3] linkmb:modbus_get_float_cdab[3] +linkmb:modbus_get_float_dcba[3] AUTHORS diff --git a/doc/modbus_get_float_badc.txt b/doc/modbus_get_float_badc.txt index 525f945..317770d 100644 --- a/doc/modbus_get_float_badc.txt +++ b/doc/modbus_get_float_badc.txt @@ -14,7 +14,6 @@ SYNOPSIS DESCRIPTION ----------- - The *modbus_get_float_badc()* function shall get a float from 4 bytes with swapped bytes (BADC instead of ABCD). The _src_ array must be a pointer on two 16 bits values, for example, if the first word is set to 0x2000 and the second @@ -30,8 +29,8 @@ SEE ALSO -------- linkmb:modbus_set_float_badc[3] linkmb:modbus_get_float_abcd[3] -linkmb:modbus_get_float_dcba[3] linkmb:modbus_get_float_cdab[3] +linkmb:modbus_get_float_dcba[3] AUTHORS diff --git a/doc/modbus_get_float_cdab.txt b/doc/modbus_get_float_cdab.txt index dc57183..82261b7 100644 --- a/doc/modbus_get_float_cdab.txt +++ b/doc/modbus_get_float_cdab.txt @@ -29,8 +29,8 @@ SEE ALSO -------- linkmb:modbus_set_float_cdab[3] linkmb:modbus_get_float_abcd[3] -linkmb:modbus_get_float_dcba[3] linkmb:modbus_get_float_badc[3] +linkmb:modbus_get_float_dcba[3] AUTHORS diff --git a/doc/modbus_set_float_abcd.txt b/doc/modbus_set_float_abcd.txt new file mode 100644 index 0000000..386cbef --- /dev/null +++ b/doc/modbus_set_float_abcd.txt @@ -0,0 +1,38 @@ +modbus_set_float_abcd(3) +======================== + + +NAME +---- +modbus_set_float_abcd - set a float value in 2 registers using ABCD byte order + + +SYNOPSIS +-------- +*void modbus_set_float_abcd(float 'f', uint16_t *'dest');* + + +DESCRIPTION +----------- +The *modbus_set_float_abcd()* function shall set a float to 4 bytes in usual +Modbus format. The _dest_ array must be pointer on two 16 bits values to be able +to store the full result of the conversion. + + +RETURN VALUE +------------ +There is no return values. + + +SEE ALSO +-------- +linkmb:modbus_get_float_abcd[3] +linkmb:modbus_set_float_badc[3] +linkmb:modbus_set_float_cdab[3] +linkmb:modbus_set_float_dcba[3] + + +AUTHORS +------- +The libmodbus documentation was written by Stéphane Raimbault + diff --git a/doc/modbus_set_float_badc.txt b/doc/modbus_set_float_badc.txt new file mode 100644 index 0000000..8df8ca9 --- /dev/null +++ b/doc/modbus_set_float_badc.txt @@ -0,0 +1,38 @@ +modbus_set_float_badc(3) +======================== + + +NAME +---- +modbus_set_float_badc - set a float value in 2 registers using BADC byte order + + +SYNOPSIS +-------- +*void modbus_set_float_badc(float 'f', uint16_t *'dest');* + + +DESCRIPTION +----------- +The *modbus_set_float_badc()* function shall set a float to 4 bytes in swapped +bytes Modbus format (BADC insted of ABCD). The _dest_ array must be pointer on +two 16 bits values to be able to store the full result of the conversion. + + +RETURN VALUE +------------ +There is no return values. + + +SEE ALSO +-------- +linkmb:modbus_get_float_badc[3] +linkmb:modbus_set_float_abcd[3] +linkmb:modbus_set_float_cdab[3] +linkmb:modbus_set_float_dcba[3] + + +AUTHORS +------- +The libmodbus documentation was written by Stéphane Raimbault + diff --git a/doc/modbus_set_float_cdab.txt b/doc/modbus_set_float_cdab.txt new file mode 100644 index 0000000..3a03725 --- /dev/null +++ b/doc/modbus_set_float_cdab.txt @@ -0,0 +1,39 @@ +modbus_set_float_cdab(3) +======================== + + +NAME +---- +modbus_set_float_cdab - set a float value in 2 registers using CDAB byte order + + +SYNOPSIS +-------- +*void modbus_set_float_cdab(float 'f', uint16_t *'dest');* + + +DESCRIPTION +----------- +The *modbus_set_float_cdab()* function shall set a float to 4 bytes in swapped +words Modbus format (CDAB order instead of ABCD). The _dest_ array must be +pointer on two 16 bits values to be able to store the full result of the +conversion. + + +RETURN VALUE +------------ +There is no return values. + + +SEE ALSO +-------- +linkmb:modbus_get_float_cdab[3] +linkmb:modbus_set_float_abcd[3] +linkmb:modbus_set_float_badc[3] +linkmb:modbus_set_float_dcba[3] + + +AUTHORS +------- +The libmodbus documentation was written by Stéphane Raimbault +