From 692f6b76f7675f40a5d86a1d9e019175544decf0 Mon Sep 17 00:00:00 2001 From: Stéphane Raimbault Date: Wed, 1 May 2013 23:58:51 +0200 Subject: [PATCH] Rename modbus_set_float_swapped to modbus_set_float_dcba --- doc/Makefile.am | 4 ++-- doc/libmodbus.txt | 4 ++-- doc/modbus_get_float.txt | 4 ++-- doc/modbus_get_float_dcba.txt | 38 ++++++++++++++++++++++++++++++++++++++ doc/modbus_get_float_swapped.txt | 38 -------------------------------------- doc/modbus_set_float.txt | 4 ++-- doc/modbus_set_float_dcba.txt | 37 +++++++++++++++++++++++++++++++++++++ doc/modbus_set_float_swapped.txt | 37 ------------------------------------- src/modbus-data.c | 8 ++++---- src/modbus.h | 4 ++-- tests/unit-test-client.c | 14 +++++++------- tests/unit-test.h.in | 2 +- 12 files changed, 97 insertions(+), 97 deletions(-) create mode 100644 doc/modbus_get_float_dcba.txt delete mode 100644 doc/modbus_get_float_swapped.txt create mode 100644 doc/modbus_set_float_dcba.txt delete mode 100644 doc/modbus_set_float_swapped.txt diff --git a/doc/Makefile.am b/doc/Makefile.am index 632b5cb..ac015e7 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -9,7 +9,7 @@ MAN3 = \ modbus_get_byte_from_bits.3 \ modbus_get_byte_timeout.3 \ modbus_get_float.3 \ - modbus_get_float_swapped.3 \ + modbus_get_float_dcba.3 \ modbus_get_header_length.3 \ modbus_get_response_timeout.3 \ modbus_get_socket.3 \ @@ -40,7 +40,7 @@ MAN3 = \ modbus_set_debug.3 \ modbus_set_error_recovery.3 \ modbus_set_float.3 \ - modbus_set_float_swapped.3 \ + modbus_set_float_dcba.3 \ modbus_set_response_timeout.3 \ modbus_set_slave.3 \ modbus_set_socket.3 \ diff --git a/doc/libmodbus.txt b/doc/libmodbus.txt index 4bb65c5..aa1ba51 100644 --- a/doc/libmodbus.txt +++ b/doc/libmodbus.txt @@ -152,8 +152,8 @@ Handling of bits and bytes:: Set or get float numbers:: linkmb:modbus_get_float[3] linkmb:modbus_set_float[3] - linkmb:modbus_get_float_swapped[3] - linkmb:modbus_set_float_swapped[3] + linkmb:modbus_get_float_dcba[3] + linkmb:modbus_set_float_dcba[3] Connection diff --git a/doc/modbus_get_float.txt b/doc/modbus_get_float.txt index 3e0bb99..ec7d9dc 100644 --- a/doc/modbus_get_float.txt +++ b/doc/modbus_get_float.txt @@ -28,8 +28,8 @@ The _modbus_get_float()_ function shall return a float. SEE ALSO -------- linkmb:modbus_set_float[3] -linkmb:modbus_set_float_swapped[3] -linkmb:modbus_get_float_swapped[3] +linkmb:modbus_set_float_dcba[3] +linkmb:modbus_get_float_dcba[3] AUTHORS ------- diff --git a/doc/modbus_get_float_dcba.txt b/doc/modbus_get_float_dcba.txt new file mode 100644 index 0000000..ff79ed8 --- /dev/null +++ b/doc/modbus_get_float_dcba.txt @@ -0,0 +1,38 @@ +modbus_get_float_dcba(3) +======================== + + +NAME +---- +modbus_get_float_dcba - get a float value from 2 registers in DCBA byte order + + +SYNOPSIS +-------- +*float modbus_get_float_dcba(const uint16_t *'src');* + + +DESCRIPTION +----------- +The _modbus_get_float_dcba()_ function shall get a float from 4 bytes in +inversed Modbus format (DCBA order). The 'src' array must be pointer on two 16 +bits values, for example, if the first word is set to 0x9a22 and the second to +0x6544, the float value read will be 916.540649. + + +RETURN VALUE +------------ +The _modbus_get_float_dcba()_ function shall return a float. + + +SEE ALSO +-------- +linkmb:modbus_set_float_dcba[3] +linkmb:modbus_set_float[3] +linkmb:modbus_get_float[3] + + +AUTHORS +------- +The libmodbus documentation was written by Stéphane Raimbault + diff --git a/doc/modbus_get_float_swapped.txt b/doc/modbus_get_float_swapped.txt deleted file mode 100644 index b794091..0000000 --- a/doc/modbus_get_float_swapped.txt +++ /dev/null @@ -1,38 +0,0 @@ -modbus_get_float_swapped(3) -=========================== - - -NAME ----- -modbus_get_float_swapped - get a float value from 2 byte swapped registers - - -SYNOPSIS --------- -*float modbus_get_float_swapped(const uint16_t *'src');* - - -DESCRIPTION ------------ -The _modbus_get_float_swapped()_ function shall get a float from 4 bytes in -swapped Modbus format (DCBA order). The 'src' array must be pointer on two 16 -bits values, for example, if the first word is set to 0x9a22 and the second to -0x6544, the float value read will be 916.540649. - - -RETURN VALUE ------------- -The _modbus_get_float_swapped()_ function shall return a float. - - -SEE ALSO --------- -linkmb:modbus_set_float_swapped[3] -linkmb:modbus_set_float[3] -linkmb:modbus_get_float[3] - - -AUTHORS -------- -The libmodbus documentation was written by Stéphane Raimbault - diff --git a/doc/modbus_set_float.txt b/doc/modbus_set_float.txt index c9bcfa3..339cb95 100644 --- a/doc/modbus_set_float.txt +++ b/doc/modbus_set_float.txt @@ -27,8 +27,8 @@ The is no return values. SEE ALSO -------- linkmb:modbus_set_float[3] -linkmb:modbus_set_float_swapped[3] -linkmb:modbus_get_float_swapped[3] +linkmb:modbus_set_float_dcba[3] +linkmb:modbus_get_float_dcba[3] AUTHORS ------- diff --git a/doc/modbus_set_float_dcba.txt b/doc/modbus_set_float_dcba.txt new file mode 100644 index 0000000..c12664a --- /dev/null +++ b/doc/modbus_set_float_dcba.txt @@ -0,0 +1,37 @@ +modbus_set_float_dcba(3) +======================== + + +NAME +---- +modbus_set_float_dcba - set a float value in 2 registers using DCBA byte order + + +SYNOPSIS +-------- +*void modbus_set_float_dcba(float 'f', uint16_t *'dest');* + + +DESCRIPTION +----------- +The _modbus_set_float_dcba()_ function shall set a float to 4 bytes in inversed +Modbus format (DCBA order). The 'dest' array must be pointer on two 16 bits +values to be able to store the full result of the conversion. + + +RETURN VALUE +------------ +The is no return values. + + +SEE ALSO +-------- +linkmb:modbus_get_float_dcba[3] +linkmb:modbus_set_float[3] +linkmb:modbus_get_float[3] + + +AUTHORS +------- +The libmodbus documentation was written by Stéphane Raimbault + diff --git a/doc/modbus_set_float_swapped.txt b/doc/modbus_set_float_swapped.txt deleted file mode 100644 index a616c50..0000000 --- a/doc/modbus_set_float_swapped.txt +++ /dev/null @@ -1,37 +0,0 @@ -modbus_set_float_swapped(3) -=========================== - - -NAME ----- -modbus_set_float_swapped - set a float value in 2 registers using a byte order swapped integer - - -SYNOPSIS --------- -*void modbus_set_float_swapped(float 'f', uint16_t *'dest');* - - -DESCRIPTION ------------ -The _modbus_set_float_swapped()_ function shall set a float to 4 bytes in -swapped Modbus format (DCBA order). The 'dest' array must be pointer on two 16 -bits values to be able to store the full result of the conversion. - - -RETURN VALUE ------------- -The is no return values. - - -SEE ALSO --------- -linkmb:modbus_get_float_swapped[3] -linkmb:modbus_set_float[3] -linkmb:modbus_get_float[3] - - -AUTHORS -------- -The libmodbus documentation was written by Stéphane Raimbault - diff --git a/src/modbus-data.c b/src/modbus-data.c index 089702d..134d134 100644 --- a/src/modbus-data.c +++ b/src/modbus-data.c @@ -88,8 +88,8 @@ float modbus_get_float(const uint16_t *src) return f; } -/* Get a float from 4 bytes in swapped Modbus format (DCBA) */ -float modbus_get_float_swapped(const uint16_t *src) +/* Get a float from 4 bytes in inversed Modbus format (DCBA) */ +float modbus_get_float_dcba(const uint16_t *src) { float f; uint32_t i; @@ -110,8 +110,8 @@ void modbus_set_float(float f, uint16_t *dest) dest[1] = (uint16_t)(i >> 16); } -/* Set a float to 4 bytes in swapped Modbus format (DCBA) */ -void modbus_set_float_swapped(float f, uint16_t *dest) +/* Set a float to 4 bytes in inversed Modbus format (DCBA) */ +void modbus_set_float_dcba(float f, uint16_t *dest) { uint32_t i; diff --git a/src/modbus.h b/src/modbus.h index 82f5a22..ced3583 100644 --- a/src/modbus.h +++ b/src/modbus.h @@ -226,9 +226,9 @@ EXPORT void modbus_set_bits_from_bytes(uint8_t *dest, int index, unsigned int nb const uint8_t *tab_byte); EXPORT uint8_t modbus_get_byte_from_bits(const uint8_t *src, int index, unsigned int nb_bits); EXPORT float modbus_get_float(const uint16_t *src); -EXPORT float modbus_get_float_swapped(const uint16_t *src); +EXPORT float modbus_get_float_dcba(const uint16_t *src); EXPORT void modbus_set_float(float f, uint16_t *dest); -EXPORT void modbus_set_float_swapped(float f, uint16_t *dest); +EXPORT void modbus_set_float_dcba(float f, uint16_t *dest); #include "modbus-tcp.h" #include "modbus-rtu.h" diff --git a/tests/unit-test-client.c b/tests/unit-test-client.c index 1d693d4..da84d20 100644 --- a/tests/unit-test-client.c +++ b/tests/unit-test-client.c @@ -342,20 +342,20 @@ int main(int argc, char *argv[]) goto close; } - printf("3/4 Set float swapped: "); - modbus_set_float_swapped(UT_REAL, tab_rp_registers); - if (tab_rp_registers[1] == (UT_IREAL_SWAPPED >> 16) && - tab_rp_registers[0] == (UT_IREAL_SWAPPED & 0xFFFF)) { + printf("3/4 Set float in DBCA order: "); + modbus_set_float_dcba(UT_REAL, tab_rp_registers); + if (tab_rp_registers[1] == (UT_IREAL_DCBA >> 16) && + tab_rp_registers[0] == (UT_IREAL_DCBA & 0xFFFF)) { printf("OK\n"); } else { ireal = (uint32_t) tab_rp_registers[0] & 0xFFFF; ireal |= (uint32_t) tab_rp_registers[1] << 16; - printf("FAILED (%x != %x)\n", ireal, UT_IREAL_SWAPPED); + printf("FAILED (%x != %x)\n", ireal, UT_IREAL_DCBA); goto close; } - printf("4/4 Get float swapped: "); - real = modbus_get_float_swapped(tab_rp_registers); + printf("4/4 Get float in DCBA order: "); + real = modbus_get_float_dcba(tab_rp_registers); if (real == UT_REAL) { printf("OK\n"); } else { diff --git a/tests/unit-test.h.in b/tests/unit-test.h.in index ba12b90..0c15bfd 100644 --- a/tests/unit-test.h.in +++ b/tests/unit-test.h.in @@ -63,6 +63,6 @@ const uint16_t UT_INPUT_REGISTERS_TAB[] = { 0x000A }; const float UT_REAL = 916.540649; const uint32_t UT_IREAL = 0x4465229a; -const uint32_t UT_IREAL_SWAPPED = 0x9a226544; +const uint32_t UT_IREAL_DCBA = 0x9a226544; #endif /* _UNIT_TEST_H_ */ -- libgit2 0.21.4