EM500-CO₂ – Configurable Properties

You can update a device's settings by modifying the configurable properties of its TSL model via API. This topic provides the configurable parameters for EM500-CO2 TSL model, their descriptions, and how to use them.

Usage

  1. Have an overview of the configurable properties and their default values of EM500-CO2 .
  2. Copy the example code and remove the comments and parameters that do not require modification.
  3. Edit the desired properties according to the detailed properties description .
    Note: Make sure that the edited example code complies with the JSON format requirements.
  4. Use the edited example code as the body parameters of Update Device Properties Incrementally.

Configurable Properties

The following code represents all configurable properties in the EM500-CO2 TSL model, along with their default values.

Note:
  • Click a property to view its detailed description and valid values.
  • Configure the example code as needed, then use it as the body parameters of Update Device Properties Incrementally to save time and effort.
{
    "version": "v1.0",
    "type": "TSL",
    "properties": {
        "reporting_interval": 600, // Reporting Interval Type: int Unit: s
        "time_zone": "0", // Time Zone Type: enum
        "reset_collection": { // Reset Collection Settings Type: struct
            "count": 2, // Reset Collection Count Type: int
            "period": 5 // Reset Collection Period Type: int Unit: s
        },
        "co2_abc_calibration_setting": { // CO₂ ABC Calibration Settings Type: struct
            "enable": false, // CO₂ ABC Calibration Enable Type: bool
            "period": 168, // CO₂ ABC Calibration Period Type: int Unit: h
            "value": 400 // CO₂ ABC Target Calibration Value Type: int
        },
        "altitude_calibration": { // Altitude Calibration Settings Type: struct
            "enable": false, // Altitude Calibration Enable Type: bool
            "value": 0 // Altitude Type: int Unit: m
        },
        "sensor_enable_temp": { // Sensor Enable Type: struct
            "enable": true // Temperature Enable Type: bool
        },
        "sensor_enable_humi": { // Sensor Enable Type: struct
            "enable": true // Humidity Enable Type: bool
        },
        "sensor_enable_co2": { // Sensor Enable Type: struct
            "enable": true // CO₂ Type: bool
        },
        "sensor_enable_atmospheric": { // Sensor Enable Type: struct
            "enable": true // Barometric Pressure Type: bool
        },
        "collecting_interval": 60, // Collecting Interval Type: int Unit: s
        "threshold_parameter_co2_concentration": { // CO₂ Concentration Threshold Alarm Type: struct
            "enable": false, // CO₂ Concentration Threshold Alarm Type: bool
            "threshold_condition": "0", // Threshold Condition Type: enum
            "threshold_min": 401, // Value A Type: int Unit: ppm
            "threshold_max": 401 // Value B Type: int Unit: ppm
        },
        "threshold_parameter_temperature": { // Temperature Threshold Alarm Type: struct
            "enable": false, // Temperature Threshold Alarm Type: bool
            "threshold_condition": "0", // Threshold Condition Type: enum
            "threshold_min": 0, // Value A Type: float Unit: ℃
            "threshold_max": 0 // Value B Type: float Unit: ℃
        },
        "mutation_parameter_temperature": { // Temperature Mutation Alarm Type: struct
            "enable": false, // Temperature Mutation Alarm Type: bool
            "threshold_max": 0.1 // Temperature change greater than Type: float Unit: ℃
        },
        "alarm_count": 3, // Alarm Reporting Times Type: int
        "alarm_disable": false, // Alarm Dismiss Report Type: bool
        "temperature_calibration_parameter": { // Temperature Type: struct
            "enable": false, // Calibration Enable Type: bool
            "value": 0 // Calibration Value Type: float Unit: ℃
        },
        "co2_calibration_parameter": { // CO₂ Concentration Type: struct
            "enable": false, // Calibration Enable Type: bool
            "value": 0 // Calibration Value Type: int Unit: ppm
        },
        "barometric_calibration_parameter": { // Barometric Pressure Type: struct
            "enable": false, // Calibration Enable Type: bool
            "value": 0 // Calibration Value Type: float Unit: hPa
        },
        "humility_calibration_parameter": { // Humidity Type: struct
            "enable": false, // Calibration Enable Type: bool
            "value": 0 // Calibration Value Type: float Unit: %
        },
        "data_storage_enable": false, // Data Storage Enable Type: bool
        "retransmission_enable": false, // Data Retransmission Enable Type: bool
        "retransmission_interval": { // Retransmission Interval Settings Type: struct
            "interval": 600 // Retransmission Interval Type: int Unit: s
        },
        "retrival_interval": { // Retrival Interval Settings Type: struct
            "interval": 60 // Retrival Interval Type: int Unit: s
        }
    }
}

Description

The following table provides the description and valid values for the configurable properties of EM500-CO2.

Parameter Type Description
reporting_interval Integer

Specify the interval for data reporting (Unit: Second).

  • Default value: 600
  • Valid value: 60 - 64800
time_zone Enum

Specify the time zone for this device.

  • Default value: 0 (UTC / Western European Time)
  • Valid value: Refer to time_zone Value for valid values and description.
reset_collection Struct

Sensor re-collection settings.

count Integer

Specify the maximum number of re-collections after sensor data collection error.

  • Default value: 2
  • Valid value: 1 - 1000
period Integer

Specify the interval of re-collections after sensor data collection error ( Unit : Second).

  • Default value: 5
  • Valid value: 1 - 65535
co2_abc_calibration_setting Struct

CO₂ Auto Background Calibration Settings.

enable Boolean

Decide whether to enable CO₂ Auto Background Calibration.

Valid value:
  • false: disable (Default value).
  • true: enable.
period Integer

Specify the calibration period ( Unit : hour).

  • Default value: 168
  • Valid value: 1 - 65534
value Integer

Specify the target calibration value ( Unit : ppm).

  • Default value: 400
  • Valid value: 1 - 65534
altitude_calibration Struct

CO₂ Barometric Pressure (Altitude) Calibration Settings

enable Boolean

Decide whether to enable Barometric Pressure (Altitude) Calibration.

Valid value:
  • false: disable (Default value).
  • true: enable.
value Integer

Specify the altitude value to calculate the pressure ( Unit : m).

  • Default value: 0
  • Valid value: 0 - 5000
sensor_enable_temp Struct

Temperature sensor collection settings.

enable Boolean

Decide to whether collect and report temperature values.

Valid value:
  • false: disable.
  • true: enable (Default value).
sensor_enable_humi Struct

Humidity sensor collection settings.

enable Boolean

Decide to whether collect and report humidity values.

Valid value:
  • false: disable.
  • true: enable (Default value).
sensor_enable_co2 Struct

CO₂ sensor collection settings.

enable Boolean

Decide to whether collect and report CO₂ values.

Valid value:
  • false: disable.
  • true: enable (Default value).
sensor_enable_atmospheric Struct

Barometric Pressure sensor collection settings.

enable Boolean

Decide to whether collect and report Barometric Pressure values.

Valid value:
  • false: disable.
  • true: enable (Default value).
collecting_interval Integer

Specify the interval for collecting data (Unit: second).

  • Default value: 60
  • Valid value: 60 - 64800
threshold_parameter_co2_concentration Struct

CO₂ Concentration Threshold Alarm settings.

enable Boolean

Decide whether to enable CO₂ Concentration Threshold Alarm.

Valid value:
  • false: disable (Default value).
  • true: enable.
threshold_condition Enum

Specify the conditions for triggering the CO₂ alarm.

Valid value:
  • 0: Do NOT send CO₂ alarm (Default value).
  • 1: The detected CO₂ < Minimum threshold.
  • 2: The detected CO₂ > Maximum threshold.
  • 3: Minimum threshold < The detected CO₂ < Maximum threshold.
  • 4: The detected CO₂ < Minimum threshold or the detected CO₂ > Maximum threshold.
threshold_min Integer

Specify the minimum threshold for CO₂ alarm ( Unit : ppm).

  • Default value: 401
  • Valid value: 401 - 5000
threshold_max Integer

Specify the maximum threshold for CO₂ alarm ( Unit : ppm).

  • Default value: 401
  • Valid value: 401 - 5000
threshold_parameter_temperature Struct

Temperature alarm settings.

enable Boolean

Decide whether to enable Temperature Threshold Alarm.

Valid value:
  • false: disable (Default value).
  • true: enable.
threshold_condition Enum

Specify the conditions for triggering the temperature alarm.

Valid value:
  • 0: Do NOT send temperature alarm (Default value).
  • 1: The detected temperature < Minimum threshold.
  • 2: The detected temperature > Maximum threshold.
  • 3: Minimum threshold < The detected temperature < Maximum threshold.
  • 4: The detected temperature < Minimum threshold or the detected temperature > Maximum threshold.
threshold_min Float

Specify the minimum threshold for temperature alarm (Unit: °C).

  • Default value: 0
  • Valid value: -40 - 70
threshold_max Float

Specify the maximum threshold for temperature alarm (Unit: °C).

  • Default value: 0
  • Valid value: -40 - 70
mutation_parameter_temperature Struct

Temperature Change Alarm settings.

enable Boolean

Decide whether to enable temperature change alarm.

Valid value:
  • false: disable (Default value).
  • true: Enable.
threshold_max Float

Specify the change value for temperature alarm (Unit: °C).

  • Default value: 0.1
  • Valid value: 0.1 - 100
alarm_count Integer

Specify the number of alarms.

  • Default value: 3
  • Valid value: 1 - 1000
alarm_disable Boolean

Decide whether to enable alarm dismiss report.

Valid value:
  • false: disable (Default value).
  • true: enable.
temperature_calibration_parameter Struct

Temperature calibration settings.

enable Boolean

Decide whether to enable temperature calibration.

Valid value:
  • false: disable (Default value).
  • true: enable.
value Float

Specify the calibration value (Unit: °C).

  • Default value: 0
  • Valid value: -100 - 100
    Note: This value supports setting one decimal place.
co2_calibration_parameter Struct

CO₂ numerical calibration settings.

enable Boolean

Decide whether to enable CO₂ numerical calibration.

Valid value:
  • false: disable (Default value).
  • true: enable.
value Integer

Specify the calibration value ( Unit : ppm).

  • Default value: 0
  • Valid value: -5000 - 5000
barometric_calibration_parameter Struct

Barometric Pressure calibration settings.

enable Boolean

Decide whether to enable Barometric Pressure numerical calibration.

Valid value:
  • false: disable (Default value).
  • true: enable.
value Float

Specify the calibration value ( Unit : hPa).

  • Default value: 0
  • Valid value: -1000 - 1000
humility_calibration_parameter Struct

Humidity calibration settings.

enable Boolean

Decide whether to enable humidity calibration.

Valid value:
  • false: disable (Default value).
  • true: enable.
value Float

Specify the calibration value ( Unit : %).

  • Default value: 0
  • Valid value: -100 - 100
data_storage_enable Boolean

Decide whether to allow the device to store data.

Valid value:
  • false: disable (Default value).
  • true: enable.
retransmission_enable Boolean
Decide whether to enable data retransmission, which allows the device to log time point of network disconnection periodically resend the accumulated data during the disconnection period upon reconnection.
Note: This setting ONLY takes effect when data_storage_enable is set to true.
Valid value:
  • false: disable (Default value).
  • true: enable.
retransmission_interval Struct
Note: This setting ONLY takes effect when retransmission_enable is set to true.
The interval for data retransmission.
interval Integer
Specify the interval for data retransmission (Unit: Second).
  • Default value: 600
  • Valid value: 30 - 1200
retrival_interval Struct

The time interval for data retrieval.

interval Integer
Specify the time interval for data retrieval (Unit: Second).
  • Default value: 60
  • Valid value: 30 - 1200