Merge branch 'svm4x_2.0.3_20231114_0935' into 'master'

Update SVM4x driver from SVM4X model version 2.0.3

See merge request Sensirion/Python/python-uart-svm4x!4

Author: LeonieFierz

CHANGELOG.rst

@@ -3,7 +3,12 @@ CHANGELOG
 
 unreleased
 ::::::::::
-- Update driver to the latest sensor model
+
+2.0.3
+:::::
+
+- class Svm41Device was renamed to Svm4xDevice
+- get_product_type has no longer a parameter as_int, was replaced with separate function get_product_type_as_int
 
 0.1.0
 :::::

README.md

@@ -13,6 +13,7 @@ The SVM4x evaluation kit covers evaluation of the SGP40 and SGP41 sensors.
 
 
 
+
 ## Connect the sensor
 
 You can connect your sensor over the provided USB cable.  

docs/execute-measurements.rst

@@ -1,7 +1,7 @@
 Execute measurements
 ====================
 
-The following steps shows how to use this driver to execute a simple measurement on a Windows system.
+The following steps show how to use this driver to execute a simple measurement on a Windows system.
 
 1. Install the SVM4X sensor driver and all required packages as described in :ref:`Installation`.
 2. Connect the SVM4X sensor to your system with the serial USB cable.

examples/algorithm_tuning_example_uart_svm4x.py

@@ -5,9 +5,9 @@
 #
 #     THIS FILE IS AUTOMATICALLY GENERATED!
 #
-# Generator:     sensirion-driver-generator 0.32.0
+# Generator:     sensirion-driver-generator 0.33.0
 # Product:       svm4x
-# Model-Version: 2.0.0
+# Model-Version: 2.0.3
 #
 
 import time
@@ -48,7 +48,7 @@
     sensor.set_voc_tuning_parameters(100, 12, 12, 180, 50, 230)
     sensor.set_nox_tuning_parameters(1, 12, 12, 720, 50, 230)
     sensor.start_measurement()
-    for i in range(50):
+    for i in range(100):
         try:
             time.sleep(1.0)
             (a_humidity, a_temperature, a_voc_index, a_nox_index

examples/example_usage_uart_svm4x.py

@@ -5,9 +5,9 @@
 #
 #     THIS FILE IS AUTOMATICALLY GENERATED!
 #
-# Generator:     sensirion-driver-generator 0.32.0
+# Generator:     sensirion-driver-generator 0.33.0
 # Product:       svm4x
-# Model-Version: 2.0.0
+# Model-Version: 2.0.3
 #
 
 import time
@@ -28,8 +28,28 @@
     serial_number = sensor.get_serial_number()
     print(f"serial_number: {serial_number}; "
           )
+    product_type = sensor.get_product_type()
+    print(f"product_type: {product_type}; "
+          )
+    product_name = sensor.get_product_name()
+    print(f"product_name: {product_name}; "
+          )
+    (firmware_major, firmware_minor, firmware_debug, hardware_major, hardware_minor, protocol_major, protocol_minor
+     ) = sensor.get_version()
+    print(f"firmware_major: {firmware_major}; "
+          f"firmware_minor: {firmware_minor}; "
+          f"firmware_debug: {firmware_debug}; "
+          f"hardware_major: {hardware_major}; "
+          f"hardware_minor: {hardware_minor}; "
+          f"protocol_major: {protocol_major}; "
+          f"protocol_minor: {protocol_minor}; "
+          )
+    t_offset = sensor.get_temperature_offset_for_rht_measurements()
+    print(f"t_offset: {t_offset}; "
+          )
+    sensor.set_temperature_offset_for_rht_measurements(0)
     sensor.start_measurement()
-    for i in range(50):
+    for i in range(100):
         try:
             time.sleep(1.0)
             (a_humidity, a_temperature, a_voc_index, a_nox_index

metadata.yml

@@ -1,7 +1,7 @@
-generator_version: 0.32.0
-model_version: 2.0.0
+generator_version: 0.33.0
+model_version: 2.0.3
 dg_status:
 - released
 is_manually_modified: true
 first_generated: '2022-09-27 17:04'
-last_generated: '2023-10-19 10:12'
+last_generated: '2023-11-14 09:35'

sensirion_uart_svm4x/commands.py

@@ -5,9 +5,9 @@
 #
 #     THIS FILE IS AUTOMATICALLY GENERATED!
 #
-# Generator:     sensirion-driver-generator 0.32.0
+# Generator:     sensirion-driver-generator 0.33.0
 # Product:       svm4x
-# Model-Version: 2.0.0
+# Model-Version: 2.0.3
 #
 """
 The transfer classes specify the data that is transferred between host and sensor. The generated transfer classes
@@ -113,7 +113,10 @@ def pack(self):
 
 
 class ReadMeasuredValuesAsIntegers(Transfer):
-    """Returns the new measurement results as integers."""
+    """
+    Read measurement data as integers.
+    This command is named get_signals in the datasheet.
+    """
 
     CMD_ID = 0x3
 
@@ -125,7 +128,10 @@ def pack(self):
 
 
 class ReadMeasuredRawValues(Transfer):
-    """Returns the measured raw values."""
+    """
+    Read measuremed raw values.
+    This command is named get_signals_raw in the datasheet.
+    """
 
     CMD_ID = 0x3
 
@@ -137,7 +143,10 @@ def pack(self):
 
 
 class GetTemperatureOffsetForRhtMeasurements(Transfer):
-    """Gets the T-Offset for the temperature compensation of the RHT algorithm."""
+    """
+    Gets the T-Offset for the temperature compensation of the RHT algorithm.
+    This command is named get_temperature_offset in the datasheet.
+    """
 
     CMD_ID = 0x60
 
@@ -149,7 +158,10 @@ def pack(self):
 
 
 class GetVocTuningParameters(Transfer):
-    """Gets the currently set parameters for customizing the VOC algorithm."""
+    """
+    Gets the currently set parameters for customizing the VOC algorithm.
+    This command is named get_voc_parameters in the datasheet.
+    """
 
     CMD_ID = 0x60
 
@@ -161,7 +173,10 @@ def pack(self):
 
 
 class GetNoxTuningParameters(Transfer):
-    """Gets the currently set parameters for customizing the NOx algorithm."""
+    """
+    Gets the currently set parameters for customizing the NOx algorithm.
+    This command is named get_nox_parameters in the datasheet.
+    """
 
     CMD_ID = 0x60
 
@@ -173,7 +188,17 @@ def pack(self):
 
 
 class StoreNvData(Transfer):
-    """Stores all algorithm parameters to the non-volatile memory."""
+    """
+    This command stores all parameters previously set with the commands
+    set_temperature_offset_for_rht_measurements, set_voc_tuning_parameters and
+    set_nox_tuning_parameters to the non-volatile
+    memory of SVM4x. These parameters will not be erased
+    during reset and will be used by the corresponding algorithms
+    after start-up. To reset the storage to factory settings the
+    master has to set all parameters to the default values followed
+    by a subsequent call of the store_nv_data command.
+    This command is named store_input_parameters in the datasheet.
+    """
 
     CMD_ID = 0x60
 
@@ -201,6 +226,7 @@ class SetVocTuningParameters(Transfer):
     """
     Sets parameters to customize the VOC algorithm. This command is only available
     in idle mode.
+    This command is named set_voc_parameters in the datasheet.
     """
 
     CMD_ID = 0x60
@@ -226,6 +252,7 @@ class SetNoxTuningParameters(Transfer):
     """
     Sets parameters to customize the NOx algorithm. This command is only available
     in idle mode.
+    This command is named set_nox_parameters in the datasheet.
     """
 
     CMD_ID = 0x60
@@ -263,22 +290,6 @@ def pack(self):
     rx = RxData('>8B')
 
 
-class GetNoxState(Transfer):
-    """
-    Gets the current NOx algorithm state. Retrieved values can be used to set the
-    NOx algorithm state to resume operation after a short interruption, skipping
-    initial learning phase. This command is only available during measurement mode.
-    """
-
-    CMD_ID = 0x61
-
-    def pack(self):
-        return self.tx_data.pack([0x9])
-
-    tx = TxData(CMD_ID, '>BB', device_busy_delay=0.05, slave_address=None, ignore_ack=False)
-    rx = RxData('>8B')
-
-
 class SetVocState(Transfer):
     """
     Set previously retrieved VOC algorithm state to resume operation after a short
@@ -295,37 +306,3 @@ def pack(self):
         return self.tx_data.pack([0x88, self._state])
 
     tx = TxData(CMD_ID, '>BB8B', device_busy_delay=0.05, slave_address=None, ignore_ack=False)
-
-
-class SetNoxState(Transfer):
-    """
-    Set previously retrieved NOx algorithm state to resume operation after a short
-    interruption, skipping initial learning phase. This command is only available in
-    idle mode.
-    """
-
-    CMD_ID = 0x61
-
-    def __init__(self, state):
-        self._state = state
-
-    def pack(self):
-        return self.tx_data.pack([0x89, self._state])
-
-    tx = TxData(CMD_ID, '>BB8B', device_busy_delay=0.05, slave_address=None, ignore_ack=False)
-
-
-class EnterBootloader(Transfer):
-    """
-    Command to enter into the bootloader mode. The device will reboot into
-    bootloader mode and wait until the new Firmware is received (start update
-    command expected). Even after a power reset, the device returns into bootloader
-    mode. The response frame is sent before the reset.
-    """
-
-    CMD_ID = 0xf3
-
-    def pack(self):
-        return self.tx_data.pack([])
-
-    tx = TxData(CMD_ID, '>B')