TS60x – 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 TS60x TSL model, their descriptions, and how to use them.
Usage
- Have an overview of the configurable properties and their default values of TS60x .
- Copy the example code and remove the comments and parameters that do not require modification.
- Edit the desired properties according to the detailed
properties description
.
Note: Make sure that the edited example code complies with the JSON format requirements.
- 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 TS60x TSL model, along with their default values.
- 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": { // Reporting Interval Type: struct
"minutes_of_time": 30 // Reporting Interval Type: int
},
"cumulative_times": 8, // Cumulative Numbers Type: int
"collection_interval": { // Collecting Interval Type: struct
"minutes_of_time": 15 // Collecting Interval Type: int Unit: min
},
"alarm_reporting_times": 1, // Alarm Max Count Type: int
"alarm_deactivation_enable": false, // Alarm Threshold Release Type: bool
"temperature_unit": "0", // Temperature Unit Type: enum
"auto_p_enable": true, // AutoP Enable Type: bool
"base_station_position_enable": false, // Base Station Positioning Type: bool
"airplane_mode_time_period_settings": { // Airplane Mode Time Period Type: struct
"enable": false, // Flight Mode Enable Mode Type: bool
"start_timestamp": { // Start Time Type: struct
"year": 0, // Start Year Type: int
"month": 1, // Start Month Type: int
"day": 1, // Start Day Type: int
"hour": 0, // Start Hour Type: int
"minute": 0, // Start Minute Type: int
"second": 0 // Start Second Type: int
},
"end_timestamp": { // End Time Type: struct
"year": 0, // End Year Type: int
"month": 1, // End Month Type: int
"day": 1, // End Day Type: int
"hour": 0, // End Hour Type: int
"minute": 0, // End Minute Type: int
"second": 0 // End Second Type: int
}
},
"time_zone": "0", // Time Zone Type: enum Unit: min
"daylight_saving_time": { // Daylight Saving Time Type: struct
"enable": false, // Daylight Saving Time Type: bool
"daylight_saving_time_offset": 60, // DST Bias Type: int Unit: min
"start_month": "1", // Month Type: enum
"start_week_num": "1", // Number of Week Type: enum
"start_week_day": "7", // Week Type: enum
"start_hour_min": "0", // Time Type: enum Unit: min
"end_month": "1", // Month Type: enum
"end_week_num": "1", // Number of Week Type: enum
"end_week_day": "7", // Week Type: enum
"end_hour_min": "0" // Time Type: enum Unit: min
},
"data_storage_settings": { // Data Storage Settings Type: struct
"enable": true, // Data Storage Enable Type: bool
"retransmission_enable": true // Data Retransmission Enable Type: bool
},
"button_lock": { // Button Lock Type: struct
"enable": true, // Button Lock Enable Type: bool
"power_off_enable": true, // Turn off Type: bool
"collect_report_enable": false // Collect And Report Type: bool
},
"temperature_alarm_settings": { // Temperature Threshold Alarm Config 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: ℃
},
"temperature_mutation_alarm_settings": { // Temperature Shift Threshold Type: struct
"enable": false, // Temperature Shift Threshold Type: bool
"mutation_max": 10 // Temperature change greater than Type: float Unit: ℃
},
"humidity_alarm_settings": { // Humidity Threshold Alarm Type: struct
"enable": false, // Humidity Threshold Alarm Type: bool
"threshold_condition": "0", // Threshold Condition Type: enum
"threshold_min": 0, // Value A Type: float Unit: %RH
"threshold_max": 0 // Value B Type: float Unit: %RH
},
"humidity_mutation_alarm_settings": { // Humidity Mutation Alarm Config Type: struct
"enable": false, // Humidity Shift Threshold Type: bool
"mutation_max": 10 // Humidity change greater than Type: float Unit: %RH
},
"temperature_calibration_settings": { // Temperature Calibration Type: struct
"enable": false, // Calibration Enable Type: bool
"calibration_value": 0 // Calibration Value Type: float Unit: ℃
},
"humidity_calibration_settings": { // Humidity Calibration Type: struct
"enable": false, // Calibration Enable Type: bool
"calibration_value": 0 // Calibration Value Type: float Unit: %RH
},
"light_alarm_settings": { // Light Threshold Alarm Config Type: struct
"enable": false, // Threshold Alarm Config Enable Type: bool
"threshold_max": 10 // Threshold Value Type: int Unit: lux
},
"tilt_alarm_settings": { // Tilt Threshold Alarm Config Type: struct
"enable": false, // Threshold Alarm Config Enable Type: bool
"threshold_max": 20, // Threshold Value Type: int Unit: °
"duration": 10 // Duration Type: int Unit: s
},
"falling_alarm_settings": { // Falling Alarm Config Type: struct
"enable": false // Falling Alarm Enable Type: bool
},
"cellular_settings": { // Cellular Settings Type: struct
"work_mode": "0", // Work Mode Type: enum
"transport_type": "7", // Transport Type Type: enum
"network": { // Network Config Type: struct
"apn": "EPA82WSJRVSYXHRUZLCV95NODKP0PYM", // APN Type: string
"auth_mode": "0", // Authentication Mode Type: enum
"auth_username": "4H5OOB27TYQT4CKPUGRRALVQYRD1WMZV5VI3TBGP30TR91FZ5N074HLWZNA4FVZ", // Username Type: string
"password": "87NY0IUOJEW3A3QHJEUW3G5LR78QKW5T06RUUTOSHXKERB59RB30XOEDBD2QSZP", // Password Type: string
"pin": "PKLO72JW" // PIN Type: string
},
"mqtt_settings": { // MQTT Settings Type: struct
"server_address": "0GUV8HDM68HN93M2SU3P2I8VVE2HD1IQ32CWRZ2LW9SAE0VQTLXTQLK3ATKBEAGU421IHDU6877JHLDXWV8NU4AQBKZYII1IED6ZLS7JQELZ8L1H75JCZA7MVDXZHBD", // Broker Address Type: string
"server_port": 1883, // Port Type: int
"client_id": "[sn]", // Client ID Type: string
"auth_enable": false, // User Credentials Enable Type: bool
"auth_username": "YI08PNIGOOFUNGZ4B1DZ9D0X3L7H4NDLLATTCLFDUCZ72LWLKJPQVUBDAQT50C6G2CKQRF5XNUDQEW6DB4DNW86YZAHYE4Z2I82YIXAKD5PKJ5JUHY0815615JSH0D1", // Username Type: string
"auth_password": "MNF1V97IROGB1ZMOYV5SZN5SPEWZMZ48FSJ7WO1UM9XMTNUEUZW4UB4R6II3EC88X1NG9OEKT4QUDUTXAHTV7S2KHUUJ1QODRU4UD3YHWXYVAGPP78SO8SKAUABP1R0", // Password Type: string
"enable_tls": false, // TLS Enable Type: bool
"enable_ca_certificate": false, // CA File Enable Type: bool
"ca_certificate": "H8UELI1DJR12CUFA63LKTZL6TH3I3MPP69HSZB8V8AD8A8U8D50PVWPHGOYL9IRK6GXTA0Q7AC29RW67ZXZGYGQM5XUP4GH5H2YXCQNX4SGJSGYN2XZMGSF64LG30PW6P02OBBNPIENMOB5CHVPCHJ25A6929441", // CA File Type: string
"enable_client_certificate": false, // Client Certificate Enable Type: bool
"client_certificate": "304Z2MY7QYRH8HO53I6CEQ1KOK5H46EOA0FMH2NIZY66ZAXD8ME8ON7PPSLC4N40P4P8VDQ1SLRNGXJZZBC8SJYBLEL66JE9SYWV59LZAEJI38SPU41FV9OR4F91XX3R08EYV3V98EGJPEF1VH81XUJO906EXL2O", // Client Certificate Type: string
"enable_key_certificate": false, // Client Key Enable Type: bool
"key_certificate": "0BGRVRX260E8IYDZDP6DQV4UWCV3ECTFRF8SGF016GMUGZVH1U030KKU93HM2VCWXOYXVR73G771NTMI1J0QF8G83HRKS55OGS10A1C90RIUOI0FRZWRZFT8V44UU4UKO6EJCK67IVR6H6N221UJ30OR0HF68HKN", // Client Key Type: string
"uplink_topic": "ts/[sn]/uplink", // Uplink Topic Type: string
"uplink_qos": "0", // Uplink QoS Type: enum
"downlink_topic": "ts/[sn]/downlink", // Downlink Topic Type: string
"downlink_qos": "0" // Downlink QoS Type: enum
},
"aws_settings": { // AWS Settings Type: struct
"server_address": "L1J8FYP0V4LTBG2XFPFB7EAD64IVBYXWNB3FTEL35ITP41N8RMIOVKEZK9TI0TQJ9Y1DAKYMIEVOTI9IIHZTM5GN7XQ56ZANZ4C3MA1Q8WVKWQW7OWAEYJ6F2OZ8ITK", // Broker Address Type: string
"ca_certificate": "DJXC2JOK70SZOXEP2Y7ET11SQJ1Z1VXMTT0FAPB29G2KUVXLYQ09TUV1RZFGT3N0TELK894N9WHVFBYT831MDQMWCEFYD5SYCY3753P9W4BNNBP4W74ZPDDQSQNEXS1ZER223IMQ2SOUACJA3QC313J28VRLIYKB", // CA Certificate Type: string
"client_certificate": "FIU4CEZOSUOEU1JDOQW49DXFK6SGFFQGAUZ6EZ9H4UDRGEZ2ZOV83QU3QQEMA0Q32JH0A1ZOOJ4N5X6BN8CLJBHBRD8HQ74BKOQ2A8T1U344H284PITU5RJHG0DZR4LG5XAHBC7ULFQN5HYQQZ299RP25YVG19O9", // Client Certificate Type: string
"key_certificate": "EFOI3WXCJP8WLOPC49S7H2YGYSHKO890PZ6PLA3DX9UFHXG654N8U457HV5PL0SG7A57YF79896HVGJCZMBKU4MMRYW09S5JWQIX8Y1CM5R6S9FC2Q8JMAO5G7QJFQKZUUYPR9DTEXGEK3UCB9QOGFVQMYS66L5C" // Client Key Type: string
},
"tcp_settings": [ // TCP Settings Type: array Length: 1
{
"server_address": "9L6B48OLSZ9AAJHHDKOFLWP19SDVIAZZ2SHACN78NRYUHPWMHWNPZC55WAWL867R1SRGFS1XXLKI3EANODBO63MAA9K1C2VCBKVHWEKJ1UBAC11DK1NUI3CLOA4XUJV", // Server Address Type: string
"server_port": 1000, // Port Type: int
"retry_count": 1, // Retry Times Type: int
"retry_interval": 5 // Retry Interval Type: int
}
],
"udp_settings": [ // UDP Settings Type: array Length: 1
{
"server_address": "YA641DM9CG82DH24THFW2IKDU4NOGQJL9JQHFLF2YSH9UI4JKDE4N4YZJFINBTFSX90GB5WBAW2QHFFSUMA1PY58EH12UDN6FV2Y75M4LQVWELBO38I5U2VSJZMG0YB", // Server Address Type: string
"server_port": 1000 // Port Type: int
}
]
}
}
}
Description
The following table provides the description and valid values for the configurable properties of TS60x.
| Parameter | Type | Description | ||
|---|---|---|---|---|
| reporting_interval | Struct |
The interval for data reporting. |
||
| minutes_of_time | Integer |
Specify the interval for data reporting (Unit: min).
|
||
| cumulative_times | Integer |
Specify the number of cumulative data records.
|
||
| collection_interval | Struct |
The interval for collecting data. |
||
| minutes_of_time | Integer |
Specify the interval for collecting data ( Unit : min).
|
||
| alarm_reporting_times | Integer |
Specify the maximum number of alarm reports.
|
||
| alarm_deactivation_enable | Boolean |
Decide whether to enable alarm dismiss report. Valid value:
|
||
| temperature_unit | Enum |
Specify the temperature unit used by this device. Valid value:
|
||
| auto_p_enable | Boolean |
Decide whether to enable the RPS Pre-configured function. Valid value:
|
||
| base_station_position_enable | Boolean |
Decide whether to enable base station positioning. This only works with TS60x-L0DEU and TS60x-L0DLA. Valid value:
|
||
| airplane_mode_time_period_settings | Struct |
The settings of the flight mode time period. |
||
| enable | Boolean |
Decide whether to enable the flight mode time period. Valid value:
|
||
| start_timestamp | Struct |
The settings of the start time. |
||
| year | Integer |
Specify the start year of the flight mode time period.
|
||
| month | Integer |
Specify the start month of the flight mode time period.
|
||
| day | Integer |
Specify the start day of the flight mode time period.
|
||
| hour | Integer |
Specify the start hour of the flight mode time period.
|
||
| minute | Integer |
Specify the start minute of the flight mode time period.
|
||
| second | Integer |
Specify the start second of the flight mode time period.
|
||
| end_timestamp | Struct |
The settings of the end time. |
||
| year | Integer |
Specify the end year of the flight mode time period.
|
||
| month | Integer |
Specify the end month of the flight mode time period.
|
||
| day | Integer |
Specify the end day of the flight mode time period.
|
||
| hour | Integer |
Specify the end hour of the flight mode time period.
|
||
| minute | Integer |
Specify the end minute of the flight mode time period.
|
||
| second | Integer |
Specify the end second of the flight mode time period.
|
||
| time_zone | Enum |
Specify the time zone for this device.
|
||
| daylight_saving_time | Struct |
The settings of Daylight Saving Time. |
||
| enable | Boolean |
Decide whether to enable Daylight Saving Time. Valid value:
|
||
| daylight_saving_time_offset | Integer |
Specify the bias of Daylight Saving Time (Unit : minute).
|
||
| start_month | Enum |
Specify the start month of Daylight Saving Time. Valid value:
|
||
| start_week_num | Enum |
Specify the start week of Daylight Saving Time. Valid value:
|
||
| start_week_day | Enum |
Specify the start week day of Daylight Saving Time. Valid value:
|
||
| start_hour_min | Enum |
Specify the start time of Daylight Saving Time (Unit : minute). Valid value:
|
||
| end_month | Enum |
Specify the end month of Daylight Saving Time. Valid value:
|
||
| end_week_num | Enum |
Specify the end week of Daylight Saving Time. Valid value:
|
||
| end_week_day | Enum |
Specify the end week day of Daylight Saving Time. Valid value:
|
||
| end_hour_min | Enum |
Specify the end time of Daylight Saving Time (Unit : minute). Valid value:
|
||
| data_storage_settings | Struct |
The settings of data storage. |
||
| enable | Boolean |
Decide whether to allow the device to store data. Valid value:
|
||
| retransmission_enable | Boolean |
Decide whether to enable data retransmission. Valid value:
|
||
| button_lock | Struct |
The settings of the button lock. |
||
| enable | Boolean |
Decide whether to enable the button lock. Valid value:
|
||
| power_off_enable | Boolean |
Decide whether to lock the power off button. Valid value:
|
||
| collect_report_enable | Boolean |
Decide whether to lock the collection and report function. Valid value:
|
||
| temperature_alarm_settings | Struct |
The settings of the temperature threshold alarm. |
||
| enable | Boolean |
Decide whether to enable the temperature threshold alarm. Valid value:
|
||
| threshold_condition | Enum |
Specify the conditions for triggering the temperature alarm. Valid value:
|
||
| threshold_min | Float |
Specify the minimum temperature threshold ( Unit : ℃).
|
||
| threshold_max | Float |
Specify the maximum temperature threshold ( Unit : ℃).
|
||
| temperature_mutation_alarm_settings | Struct |
The settings of the temperature shift alarm. |
||
| enable | Boolean |
Decide whether to enable the temperature shift alarm. Valid value:
|
||
| mutation_max | Float |
Specify the temperature change threshold ( Unit : ℃).
|
||
| humidity_alarm_settings | Struct |
The settings of the humidity threshold alarm. |
||
| enable | Boolean |
Decide whether to enable the humidity threshold alarm. Valid value:
|
||
| threshold_condition | Enum |
Specify the condition for triggering the humidity alarm. Valid value:
|
||
| threshold_min | Float |
Specify the minimum humidity threshold ( Unit : %RH).
|
||
| threshold_max | Float |
Specify the maximum humidity threshold ( Unit : %RH).
|
||
| humidity_mutation_alarm_settings | Struct |
The settings of the humidity mutation alarm. |
||
| enable | Boolean |
Decide whether to enable the humidity shift alarm. Valid value:
|
||
| mutation_max | Float |
Specify the humidity change threshold ( Unit : %RH).
|
||
| temperature_calibration_settings | Struct |
The settings of temperature calibration. |
||
| enable | Boolean |
Decide whether to enable temperature calibration. Valid value:
|
||
| calibration_value | Float |
Specify the calibration value ( Unit : ℃).
|
||
| humidity_calibration_settings | Struct |
The settings of humidity calibration. |
||
| enable | Boolean |
Decide whether to enable humidity calibration. Valid value:
|
||
| calibration_value | Float |
Specify the calibration value ( Unit : %RH).
|
||
| light_alarm_settings | Struct |
The settings of the light threshold alarm. |
||
| enable | Boolean |
Decide whether to enable the threshold alarm. Valid value:
|
||
| threshold_max | Integer |
Specify the light threshold value ( Unit : lux).
|
||
| tilt_alarm_settings | Struct |
The settings of the tilt threshold alarm. |
||
| enable | Boolean |
Decide whether to enable the threshold alarm. Valid value:
|
||
| threshold_max | Integer |
Specify the tilt threshold value ( Unit : °).
|
||
| duration | Integer |
Specify the duration of the tilt condition ( Unit : s).
|
||
| falling_alarm_settings | Struct |
The settings of the drop alarm. |
||
| enable | Boolean |
Decide whether to enable the drop alarm. Valid value:
|
||
| cellular_settings | Struct |
The settings of cellular communication. |
||
| work_mode | Enum |
Specify the work mode of cellular communication. Valid value:
|
||
| transport_type | Enum |
Specify the transport type of cellular communication. Valid value:
|
||
| network | Struct |
The settings of the cellular network. |
||
| apn | String |
Specify the APN (Access Point Name).
|
||
| auth_mode | Enum |
Specify the authentication mode. Valid value:
|
||
| auth_username | String |
Specify the username for cellular network authentication.
|
||
| password | String |
Specify the password for cellular network authentication.
|
||
| pin | String |
Specify the PIN code of the SIM card.
|
||
| mqtt_settings | Struct |
The settings of MQTT. |
||
| server_address | String |
Specify the address of the MQTT broker.
|
||
| server_port | Integer |
Specify the port of the MQTT broker.
|
||
| client_id | String |
Specify the client ID of the MQTT client.
|
||
| auth_enable | Boolean |
Decide whether to enable user credentials for MQTT authentication. Valid value:
|
||
| auth_username | String |
Specify the username for MQTT authentication.
|
||
| auth_password | String |
Specify the password for MQTT authentication.
|
||
| enable_tls | Boolean |
Decide whether to enable TLS. Valid value:
|
||
| enable_ca_certificate | Boolean |
Decide whether to enable the CA certificate. Valid value:
|
||
| ca_certificate | String |
Specify the CA certificate.
|
||
| enable_client_certificate | Boolean |
Decide whether to enable the client certificate. Valid value:
|
||
| client_certificate | String |
Specify the client certificate.
|
||
| enable_key_certificate | Boolean |
Decide whether to enable the client key. Valid value:
|
||
| key_certificate | String |
Specify the client key.
|
||
| uplink_topic | String |
Specify the topic for uplink messages.
|
||
| uplink_qos | Enum |
Specify the QoS level for uplink messages. Valid value:
|
||
| downlink_topic | String |
Specify the topic for downlink messages.
|
||
| downlink_qos | Enum |
Specify the QoS level for downlink messages. Valid value:
|
||
| aws_settings | Struct |
The settings of AWS IoT. |
||
| server_address | String |
Specify the address of the AWS IoT broker.
|
||
| ca_certificate | String |
Specify the CA certificate.
|
||
| client_certificate | String |
Specify the client certificate.
|
||
| key_certificate | String |
Specify the client key.
|
||
| tcp_settings | Array |
The settings of TCP. |
||
| server_address | String |
Specify the address of the TCP server.
|
||
| server_port | Integer |
Specify the port of the TCP server.
|
||
| retry_count | Integer |
Specify the number of retries.
|
||
| retry_interval | Integer |
Specify the interval between retries.
|
||
| udp_settings | Array |
The settings of UDP. |
||
| server_address | String |
Specify the address of the UDP server.
|
||
| server_port | Integer |
Specify the port of the UDP server.
|
||