Explicitly handle NAN values

extras/test/CMakeLists.txt

@@ -66,6 +66,8 @@ set(TEST_SRCS
   src/test_addPropertyReal.cpp
   src/test_callback.cpp
   src/test_CloudColor.cpp
+  src/test_CloudFloat.cpp
+  src/test_CloudWrapperFloat.cpp
   src/test_CloudLocation.cpp
   src/test_CloudSchedule.cpp
   src/test_decode.cpp

extras/test/src/test_CloudFloat.cpp

@@ -0,0 +1,112 @@
+/*
+   Copyright (c) 2019 Arduino.  All rights reserved.
+*/
+
+/**************************************************************************************
+   INCLUDE
+ **************************************************************************************/
+
+#include <catch2/catch_test_macros.hpp>
+
+#include <CBORDecoder.h>
+
+#include <property/types/CloudFloat.h>
+
+/**************************************************************************************
+  TEST CODE
+ **************************************************************************************/
+
+SCENARIO("Arduino Cloud Properties ", "[ArduinoCloudThing::CloudFloat]")
+{
+  WHEN("NAN value from cloud is received")
+  {
+    PropertyContainer property_container;
+    CloudFloat prop = 2.0f;
+    prop.writeOnDemand();
+    addPropertyToContainer(property_container, prop, "test", Permission::ReadWrite);
+
+    /* [{0: "test", 2: NaN}] = 81A200647465737402F97E00 */
+    uint8_t const payload[] = { 0x81, 0xA2, 0x00, 0x64, 0x74, 0x65, 0x73, 0x74, 0x02, 0xF9, 0x7E, 0x00 };
+    int const payload_length = sizeof(payload) / sizeof(uint8_t);
+    CBORDecoder::decode(property_container, payload, payload_length);
+
+    REQUIRE(prop.isDifferentFromCloud() == true);
+  }
+
+  WHEN("Local value is NAN")
+  {
+    PropertyContainer property_container;
+    CloudFloat prop = NAN;
+    prop.writeOnDemand();
+    addPropertyToContainer(property_container, prop, "test", Permission::ReadWrite);
+
+    /* [{0: "test", 2: 1.5}] = 81A200647465737402F93E00 */
+    uint8_t const payload[] = { 0x81, 0xA2, 0x00, 0x64, 0x74, 0x65, 0x73, 0x74, 0x02, 0xF9, 0x3E, 0x00 };
+    int const payload_length = sizeof(payload) / sizeof(uint8_t);
+    CBORDecoder::decode(property_container, payload, payload_length);
+
+    REQUIRE(prop.isDifferentFromCloud() == true);
+  }
+
+  WHEN("both, the local and the cloud values are NaN")
+  {
+    PropertyContainer property_container;
+    CloudFloat prop = NAN;
+    prop.writeOnDemand();
+    addPropertyToContainer(property_container, prop, "test", Permission::ReadWrite);
+
+    /* [{0: "test", 2: NaN}] = 81A200647465737402F97E00 */
+    uint8_t const payload[] = { 0x81, 0xA2, 0x00, 0x64, 0x74, 0x65, 0x73, 0x74, 0x02, 0xF9, 0x7E, 0x00 };
+    int const payload_length = sizeof(payload) / sizeof(uint8_t);
+    CBORDecoder::decode(property_container, payload, payload_length);
+
+    REQUIRE(prop.isDifferentFromCloud() == false);
+  }
+
+  WHEN("the local and cloud values are the same")
+  {
+    PropertyContainer property_container;
+    CloudFloat prop = 1.5;
+    prop.writeOnDemand();
+    addPropertyToContainer(property_container, prop, "test", Permission::ReadWrite);
+
+    /* [{0: "test", 2: 1.5}] = 81A200647465737402F93E00 */
+    uint8_t const payload[] = { 0x81, 0xA2, 0x00, 0x64, 0x74, 0x65, 0x73, 0x74, 0x02, 0xF9, 0x3E, 0x00 };
+    int const payload_length = sizeof(payload) / sizeof(uint8_t);
+    CBORDecoder::decode(property_container, payload, payload_length);
+
+    REQUIRE(prop.isDifferentFromCloud() == false);
+  }
+
+  WHEN("the local and the cloud values differ")
+  {
+    PropertyContainer property_container;
+    CloudFloat prop = 1.0f;
+    prop.writeOnDemand();
+    addPropertyToContainer(property_container, prop, "test", Permission::ReadWrite);
+
+    /* [{0: "test", 2: 1.5}] = 81A200647465737402F97E00 */
+    uint8_t const payload[] = { 0x81, 0xA2, 0x00, 0x64, 0x74, 0x65, 0x73, 0x74, 0x02, 0xF9, 0x7E, 0x00 };
+    int const payload_length = sizeof(payload) / sizeof(uint8_t);
+    CBORDecoder::decode(property_container, payload, payload_length);
+
+    REQUIRE(prop.isDifferentFromCloud() == true);
+  }
+
+  WHEN("the local value differs by 0.25 from the cloud value")
+  {
+    PropertyContainer property_container;
+    CloudFloat prop = 1.0f;
+    prop.writeOnDemand();
+    addPropertyToContainer(property_container, prop, "test", Permission::ReadWrite);
+
+    /* [{0: "test", 2: 1.5}] = 81A200647465737402F97E00 */
+    uint8_t const payload[] = { 0x81, 0xA2, 0x00, 0x64, 0x74, 0x65, 0x73, 0x74, 0x02, 0xF9, 0x7E, 0x00 };
+    int const payload_length = sizeof(payload) / sizeof(uint8_t);
+    CBORDecoder::decode(property_container, payload, payload_length);
+    prop.publishOnChange(0.25f, 0); // 0.25 min delta
+
+    REQUIRE(prop.isDifferentFromCloud() == true);
+  }
+
+}

extras/test/src/test_CloudWrapperFloat.cpp

@@ -0,0 +1,118 @@
+/*
+   Copyright (c) 2019 Arduino.  All rights reserved.
+*/
+
+/**************************************************************************************
+   INCLUDE
+ **************************************************************************************/
+
+#include <catch2/catch_test_macros.hpp>
+
+#include <CBORDecoder.h>
+
+#include <property/types/CloudWrapperFloat.h>
+
+/**************************************************************************************
+  TEST CODE
+ **************************************************************************************/
+
+SCENARIO("Arduino Cloud Properties ", "[ArduinoCloudThing::CloudWrapperFloat]")
+{
+  WHEN("NAN value from cloud is received")
+  {
+    PropertyContainer property_container;
+    float value = 2.0f;
+    CloudWrapperFloat prop(value);
+    prop.writeOnDemand();
+    addPropertyToContainer(property_container, prop, "test", Permission::ReadWrite);
+
+    /* [{0: "test", 2: NaN}] = 81A200647465737402F97E00 */
+    uint8_t const payload[] = { 0x81, 0xA2, 0x00, 0x64, 0x74, 0x65, 0x73, 0x74, 0x02, 0xF9, 0x7E, 0x00 };
+    int const payload_length = sizeof(payload) / sizeof(uint8_t);
+    CBORDecoder::decode(property_container, payload, payload_length);
+
+    REQUIRE(prop.isDifferentFromCloud() == true);
+  }
+
+  WHEN("Local value is NAN")
+  {
+    PropertyContainer property_container;
+    float value = NAN;
+    CloudWrapperFloat prop(value);
+    prop.writeOnDemand();
+    addPropertyToContainer(property_container, prop, "test", Permission::ReadWrite);
+
+    /* [{0: "test", 2: 1.5}] = 81A200647465737402F93E00 */
+    uint8_t const payload[] = { 0x81, 0xA2, 0x00, 0x64, 0x74, 0x65, 0x73, 0x74, 0x02, 0xF9, 0x3E, 0x00 };
+    int const payload_length = sizeof(payload) / sizeof(uint8_t);
+    CBORDecoder::decode(property_container, payload, payload_length);
+
+    REQUIRE(prop.isDifferentFromCloud() == true);
+  }
+
+  WHEN("both, the local and the cloud values are NaN")
+  {
+    PropertyContainer property_container;
+    float value = NAN;
+    CloudWrapperFloat prop(value);
+    prop.writeOnDemand();
+    addPropertyToContainer(property_container, prop, "test", Permission::ReadWrite);
+
+    /* [{0: "test", 2: NaN}] = 81A200647465737402F97E00 */
+    uint8_t const payload[] = { 0x81, 0xA2, 0x00, 0x64, 0x74, 0x65, 0x73, 0x74, 0x02, 0xF9, 0x7E, 0x00 };
+    int const payload_length = sizeof(payload) / sizeof(uint8_t);
+    CBORDecoder::decode(property_container, payload, payload_length);
+
+    REQUIRE(prop.isDifferentFromCloud() == false);
+  }
+
+  WHEN("the local and cloud values are the same")
+  {
+    PropertyContainer property_container;
+    float value = 1.5f;
+    CloudWrapperFloat prop(value);
+    prop.writeOnDemand();
+    addPropertyToContainer(property_container, prop, "test", Permission::ReadWrite);
+
+    /* [{0: "test", 2: 1.5}] = 81A200647465737402F93E00 */
+    uint8_t const payload[] = { 0x81, 0xA2, 0x00, 0x64, 0x74, 0x65, 0x73, 0x74, 0x02, 0xF9, 0x3E, 0x00 };
+    int const payload_length = sizeof(payload) / sizeof(uint8_t);
+    CBORDecoder::decode(property_container, payload, payload_length);
+
+    REQUIRE(prop.isDifferentFromCloud() == false);
+  }
+
+  WHEN("the local and the cloud values differ")
+  {
+    PropertyContainer property_container;
+    float value = 1.0f;
+    CloudWrapperFloat prop(value);
+    prop.writeOnDemand();
+    addPropertyToContainer(property_container, prop, "test", Permission::ReadWrite);
+
+    /* [{0: "test", 2: 1.5}] = 81A200647465737402F97E00 */
+    uint8_t const payload[] = { 0x81, 0xA2, 0x00, 0x64, 0x74, 0x65, 0x73, 0x74, 0x02, 0xF9, 0x7E, 0x00 };
+    int const payload_length = sizeof(payload) / sizeof(uint8_t);
+    CBORDecoder::decode(property_container, payload, payload_length);
+
+    REQUIRE(prop.isDifferentFromCloud() == true);
+  }
+
+  WHEN("the local value differs by 0.25 from the cloud value")
+  {
+    PropertyContainer property_container;
+    float value = 1.0f;
+    CloudWrapperFloat prop(value);
+    prop.writeOnDemand();
+    addPropertyToContainer(property_container, prop, "test", Permission::ReadWrite);
+
+    /* [{0: "test", 2: 1.5}] = 81A200647465737402F97E00 */
+    uint8_t const payload[] = { 0x81, 0xA2, 0x00, 0x64, 0x74, 0x65, 0x73, 0x74, 0x02, 0xF9, 0x7E, 0x00 };
+    int const payload_length = sizeof(payload) / sizeof(uint8_t);
+    CBORDecoder::decode(property_container, payload, payload_length);
+    prop.publishOnChange(0.25f, 0); // 0.25 min delta
+
+    REQUIRE(prop.isDifferentFromCloud() == true);
+  }
+
+}

src/property/math_utils.h

@@ -0,0 +1,29 @@
+/*
+  This file is part of the ArduinoIoTCloud library.
+
+  Copyright (c) 2024 Arduino SA
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+*/
+#pragma once
+#include <math.h>
+
+namespace arduino { namespace math {
+
+    template<typename T>
+    inline bool ieee754_different(const T a, const T b, const T delta = 0.0) {
+        /* The following comparison is introduced to take into account the very peculiar
+         * way of handling NaN values by the standard IEEE754.
+         * We consider two floating point number different if their binary representation is different.
+         * or if those two IEEE754 values are numbers or zero(which is handled on its own) exceed
+         * a certain threshold
+         */
+        return memcmp((uint8_t*)&a, (uint8_t*)&b, sizeof(b)) != 0 && (
+            (std::fpclassify(a) != FP_NORMAL && std::fpclassify(a) != FP_ZERO) ||
+            (std::fpclassify(b) != FP_NORMAL && std::fpclassify(b) != FP_ZERO) ||
+            fabs(a - b) >= delta
+        );
+    }
+}}

src/property/types/CloudFloat.h

@@ -19,6 +19,7 @@
 #define CLOUDFLOAT_H_
 
 #include <math.h>
+#include "../math_utils.h"
 
 /******************************************************************************
    INCLUDE
@@ -46,7 +47,7 @@ class CloudFloat : public Property {
       return _value;
     }
     virtual bool isDifferentFromCloud() {
-      return _value != _cloud_value && (abs(_value - _cloud_value) >= Property::_min_delta_property);
+      return arduino::math::ieee754_different(_value, _cloud_value, Property::_min_delta_property);
     }
     virtual void fromCloudToLocal() {
       _value = _cloud_value;

src/property/types/CloudWrapperFloat.h

@@ -19,6 +19,7 @@
 #define CLOUDWRAPPERFLOAT_H_
 
 #include <math.h>
+#include "../math_utils.h"
 
 /******************************************************************************
    INCLUDE
@@ -39,7 +40,7 @@ class CloudWrapperFloat : public CloudWrapperBase {
   public:
     CloudWrapperFloat(float& v) : _primitive_value(v), _cloud_value(v), _local_value(v) {}
     virtual bool isDifferentFromCloud() {
-      return _primitive_value != _cloud_value && (abs(_primitive_value - _cloud_value) >= Property::_min_delta_property);
+      return arduino::math::ieee754_different(_primitive_value, _cloud_value, Property::_min_delta_property);
     }
     virtual void fromCloudToLocal() {
       _primitive_value = _cloud_value;