Merge branch 'LKD-458-fix-embedded-data-ready-interface' into 'master'

Rename getDataReadyStatus() to getDataReadyFlag()

See merge request MSO-SW/drivers/embedded/embedded-i2c-scd4x!15

Author: Rol-la

scd4x_i2c.c

@@ -290,10 +290,11 @@ int16_t scd4x_start_low_power_periodic_measurement() {
     return sensirion_i2c_write_data(SCD4X_I2C_ADDRESS, &buffer[0], offset);
 }
 
-int16_t scd4x_get_data_ready_status(uint16_t* data_ready) {
+int16_t scd4x_get_data_ready_flag(bool* data_ready_flag) {
     int16_t error;
     uint8_t buffer[3];
     uint16_t offset = 0;
+    uint16_t local_data_ready = 0;
     offset = sensirion_i2c_add_command_to_buffer(&buffer[0], offset, 0xE4B8);
 
     error = sensirion_i2c_write_data(SCD4X_I2C_ADDRESS, &buffer[0], offset);
@@ -307,7 +308,8 @@ int16_t scd4x_get_data_ready_status(uint16_t* data_ready) {
     if (error) {
         return error;
     }
-    *data_ready = sensirion_common_bytes_to_uint16_t(&buffer[0]);
+    local_data_ready = sensirion_common_bytes_to_uint16_t(&buffer[0]);
+    *data_ready_flag = (local_data_ready & 0x07FF) != 0;
     return NO_ERROR;
 }
 

scd4x_i2c.h

@@ -59,7 +59,7 @@ int16_t scd4x_start_periodic_measurement(void);
  * scd4x_read_measurement_ticks() - read sensor output. The measurement data can
  * only be read out once per signal update interval as the buffer is emptied
  * upon read-out. If no data is available in the buffer, the sensor returns a
- * NACK. To avoid a NACK response the get_data_ready_status can be issued to
+ * NACK. To avoid a NACK response the get_data_ready_flag can be issued to
  * check data status. The I2C master can abort the read transfer with a NACK
  * followed by a STOP condition after any data byte if the user is not
  * interested in subsequent data.
@@ -258,14 +258,14 @@ int16_t scd4x_set_automatic_self_calibration(uint16_t asc_enabled);
 int16_t scd4x_start_low_power_periodic_measurement(void);
 
 /**
- * scd4x_get_data_ready_status() - Check whether new measurement data is
+ * scd4x_get_data_ready_flag() - Check whether new measurement data is
  * available for read-out.
  *
- * @param data_ready If last 11 bits are 0 data not ready, else data ready
+ * @param data_ready_flag True if data available, otherwise false.
  *
  * @return 0 on success, an error code otherwise
  */
-int16_t scd4x_get_data_ready_status(uint16_t* data_ready);
+int16_t scd4x_get_data_ready_flag(bool* data_ready_flag);
 
 /**
  * scd4x_persist_settings() - Configuration settings such as the temperature

scd4x_i2c_example_usage.c

@@ -72,7 +72,16 @@ int main(void) {
 
     for (;;) {
         // Read Measurement
-        sensirion_i2c_hal_sleep_usec(5000000);
+        sensirion_i2c_hal_sleep_usec(100000);
+        bool data_ready_flag = false;
+        error = scd4x_get_data_ready_flag(&data_ready_flag);
+        if (error) {
+            printf("Error executing scd4x_get_data_ready_flag(): %i\n", error);
+            continue;
+        }
+        if (!data_ready_flag) {
+            continue;
+        }
 
         uint16_t co2;
         int32_t temperature;

tests/scd4x_i2c_test.cpp

@@ -200,11 +200,11 @@ TEST (SCD4X_Tests, SCD4X_Test_start_low_power_periodic_measurement) {
     CHECK_EQUAL_ZERO_TEXT(error, "scd4x_stop_periodic_measurement");
 }
 
-TEST (SCD4X_Tests, SCD4X_Test_get_data_ready_status) {
+TEST (SCD4X_Tests, SCD4X_Test_get_data_ready_flag) {
     int16_t error;
-    uint16_t data_ready;
-    error = scd4x_get_data_ready_status(&data_ready);
-    CHECK_EQUAL_ZERO_TEXT(error, "scd4x_get_data_ready_status");
+    bool data_ready;
+    error = scd4x_get_data_ready_flag(&data_ready);
+    CHECK_EQUAL_ZERO_TEXT(error, "scd4x_get_data_ready_flag");
     printf("data_ready: %i\n", data_ready);
 }