Merge pull request #1 from Sensirion/scd4x_2.0_20250129_1204

LeonieFierz · web-flow · commit 96b9bba99f1a · 2025-01-30T16:21:49.000+01:00
Generate SCD4x driver from SCD4x model version 2.0
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -8,9 +8,5 @@ on:
       - main
 
 jobs:
-  dg-metadata-validation:
-    if: github.event_name == 'push' && github.ref != 'refs/head/main'
-    uses: sensirion/.github/.github/workflows/driver.generated.metadata_check.yml@main
-
   test:
     uses: sensirion/.github/.github/workflows/driver.python.test.yml@main
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,13 +10,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - All commands according to data sheet
-## [0.1.0] - 2021-2-1
 
-### Added
+### Deprecated
+
+- Deprecated the previous Python SCD4x driver repository https://github.com/Sensirion/python-i2c-scd
 
-- Initial version
-- Check latest 0.x.x version for changelog prior to version 1.0.0
 
 [Unreleased]: https://github.com/Sensirion/python-i2c-scd4x/compare/1.0.0...HEAD
-[1.0.0]: https://github.com/Sensirion/python-i2c-scd4x/compare/0.1.0...1.0.0
-[0.1.0]: https://github.com/Sensirion/python-i2c-scd4x/releases/tag/0.1.0
+[1.0.0]: https://github.com/Sensirion/python-i2c-scd4x/releases/tag/1.0.0
diff --git a/examples/example_scd41_single_shot_linux_scd4x.py b/examples/example_scd41_single_shot_linux_scd4x.py
@@ -7,7 +7,7 @@
 #
 # Generator:     sensirion-driver-generator 1.1.2
 # Product:       scd4x
-# Model-Version: 1.0
+# Model-Version: 2.0
 #
 
 import argparse
diff --git a/examples/example_scd41_single_shot_sensorbridge_scd4x.py b/examples/example_scd41_single_shot_sensorbridge_scd4x.py
@@ -7,7 +7,7 @@
 #
 # Generator:     sensirion-driver-generator 1.1.2
 # Product:       scd4x
-# Model-Version: 1.0
+# Model-Version: 2.0
 #
 
 import argparse
diff --git a/examples/example_usage_linux_scd4x.py b/examples/example_usage_linux_scd4x.py
@@ -7,7 +7,7 @@
 #
 # Generator:     sensirion-driver-generator 1.1.2
 # Product:       scd4x
-# Model-Version: 1.0
+# Model-Version: 2.0
 #
 
 import argparse
diff --git a/examples/example_usage_sensorbridge_scd4x.py b/examples/example_usage_sensorbridge_scd4x.py
@@ -7,7 +7,7 @@
 #
 # Generator:     sensirion-driver-generator 1.1.2
 # Product:       scd4x
-# Model-Version: 1.0
+# Model-Version: 2.0
 #
 
 import argparse
diff --git a/metadata.yml b/metadata.yml
@@ -1,7 +1,7 @@
 # driver generation metadata
 generator_version: 1.1.2
-model_version: '1.0'
+model_version: '2.0'
 dg_status: released
 is_manually_modified: false
 first_generated: '2025-01-29 11:48'
-last_generated: '2025-01-29 11:48'
+last_generated: '2025-01-29 12:04'
diff --git a/sensirion_i2c_scd4x/commands.py b/sensirion_i2c_scd4x/commands.py
@@ -7,7 +7,7 @@
 #
 # Generator:     sensirion-driver-generator 1.1.2
 # Product:       scd4x
-# Model-Version: 1.0
+# Model-Version: 2.0
 #
 """
 The transfer classes specify the data that is transferred between host and sensor. The generated transfer classes
@@ -320,7 +320,7 @@ def pack(self):
         return self.tx_data.pack([])
 
     tx = TxData(CMD_ID, '>H', device_busy_delay=0.001, slave_address=None, ignore_ack=False)
-    rx = RxData('>3H')
+    rx = RxData('>3H', convert_to_int=True)
 
 
 class PerformSelfTest(Transfer):
diff --git a/sensirion_i2c_scd4x/device.py b/sensirion_i2c_scd4x/device.py
@@ -7,7 +7,7 @@
 #
 # Generator:     sensirion-driver-generator 1.1.2
 # Product:       scd4x
-# Model-Version: 1.0
+# Model-Version: 2.0
 #
 """
 The class Scd4xDeviceBase implements the low level interface of the sensor.
diff --git a/sensirion_i2c_scd4x/result_types.py b/sensirion_i2c_scd4x/result_types.py
@@ -7,7 +7,7 @@
 #
 # Generator:     sensirion-driver-generator 1.1.2
 # Product:       scd4x
-# Model-Version: 1.0
+# Model-Version: 2.0
 #
 """
 The signal classes specify transformations of the raw sensor signals into a meaningful units.
diff --git a/tests/test_scd4x.py b/tests/test_scd4x.py
@@ -7,10 +7,12 @@
 #
 # Generator:     sensirion-driver-generator 1.1.2
 # Product:       scd4x
-# Model-Version: 1.0
+# Model-Version: 2.0
 #
 
 import pytest
+import time
+from sensirion_i2c_driver.errors import I2cNackError
 from sensirion_i2c_scd4x.device import Scd4xDevice
 
 
@@ -147,26 +149,26 @@ def test_measure_and_read_single_shot1(sensor):
 
 def test_measure_single_shot_rht_only1(sensor):
     sensor.measure_single_shot_rht_only()
-
-
-def test_measure_single_shot1(sensor):
-    sensor.measure_single_shot()
+    (a_co2_concentration, a_temperature, a_relative_humidity
+     ) = sensor.read_measurement()
+    print(f"a_co2_concentration: {a_co2_concentration}; "
+          f"a_temperature: {a_temperature}; "
+          f"a_relative_humidity: {a_relative_humidity}; "
+          )
 
 
 def test_start_periodic_measurement1(sensor):
     sensor.start_periodic_measurement()
+    while not sensor.get_data_ready_status():
+        # wait until data is ready to be read out
+        time.sleep(1)
     (a_co2_concentration, a_temperature, a_relative_humidity
      ) = sensor.read_measurement()
     print(f"a_co2_concentration: {a_co2_concentration}; "
           f"a_temperature: {a_temperature}; "
           f"a_relative_humidity: {a_relative_humidity}; "
           )
-    (co2_concentration, temperature, relative_humidity
-     ) = sensor.read_measurement_raw()
-    print(f"co2_concentration: {co2_concentration}; "
-          f"temperature: {temperature}; "
-          f"relative_humidity: {relative_humidity}; "
-          )
+    # read_measurement_raw is implicitly tested with read_measurement
     sensor.set_ambient_pressure(101300)
     a_ambient_pressure = sensor.get_ambient_pressure()
     print(f"a_ambient_pressure: {a_ambient_pressure}; "
@@ -186,18 +188,16 @@ def test_start_periodic_measurement1(sensor):
 
 def test_start_low_power_periodic_measurement1(sensor):
     sensor.start_low_power_periodic_measurement()
+    while not sensor.get_data_ready_status():
+        # wait until data is ready to be read out
+        time.sleep(1)
     (a_co2_concentration, a_temperature, a_relative_humidity
      ) = sensor.read_measurement()
     print(f"a_co2_concentration: {a_co2_concentration}; "
           f"a_temperature: {a_temperature}; "
           f"a_relative_humidity: {a_relative_humidity}; "
           )
-    (co2_concentration, temperature, relative_humidity
-     ) = sensor.read_measurement_raw()
-    print(f"co2_concentration: {co2_concentration}; "
-          f"temperature: {temperature}; "
-          f"relative_humidity: {relative_humidity}; "
-          )
+    # read_measurement_raw is implicitly tested with read_measurement
     sensor.set_ambient_pressure(101300)
     a_ambient_pressure = sensor.get_ambient_pressure()
     print(f"a_ambient_pressure: {a_ambient_pressure}; "
@@ -214,3 +214,23 @@ def test_start_low_power_periodic_measurement1(sensor):
           )
     sensor.stop_periodic_measurement()
 
+
+@pytest.mark.needs_hardware
+def test_sleep_mode(sensor):
+    """
+    Test power down and wake up commands
+    """
+    sensor.power_down()
+    try:
+        sensor.get_data_ready_status()
+    except I2cNackError:
+        assert True
+    else:
+        assert False, "SCD4x should respond with NACK when in sleep mode"
+    sensor.wake_up()
+    try:
+        sensor.get_data_ready_status()
+    except I2cNackError:
+        assert False, "SCD4x should respond after wake up"
+    else:
+        assert True

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`#`
`8`	`8`	`# Generator: sensirion-driver-generator 1.1.2`
`9`	`9`	`# Product: scd4x`
`10`		`-# Model-Version: 1.0`
	`10`	`+# Model-Version: 2.0`
`11`	`11`	`#`
`12`	`12`
`13`	`13`	`import argparse`