IoT Platform:TSL model FAQ

Symptoms

When you import a TSL model for a product in the IoT Platform console, one of two verification failures may occur in the Import TSL Model dialog box: an immediate error message, The file content is not in a valid JSON format, or a verification exception with a Download and View link for retrieving detailed error information.

Solutions

The following solutions correspond to the two types of verification failures:

• Check the TSL model file, fix any JSON formatting errors, and then re-upload the file.

• Click Download and View to obtain the errors.txt file. Use the file to identify and resolve the problem.

  For more information about the errors.txt file, see the following example.

  Sample TSL model file:

  {
      "schema":"https://iotx-tsl.oss-ap-southeast-1.aliyuncs.com/schema.json",
      "profile":{
          "productKey":"a1Jk***"
      },
      "services":[],
      "properties": 1,
      "events": [],
      "functionBlockId": "modulemtest",
      "functionBlockName": "Custom Module 1"
  }

  Downloaded errors.txt file:

  [
    {
      "path": [
        "properties"
      ],
      "property": "instance.properties",
      "message": "is not of a type(s) array",
      "schema": {
        "type": "array",
        "items": {
          "$ref": "#/definitions/propertyDefinition"
        }
      },
      "instance": 1,
      "name": "type",
      "argument": [
        "array"
      ],
      "stack": "instance.properties is not of a type(s) array"
    },
    {
      "path": [
        "functionBlockId"
      ],
      "property": "instance.functionBlockId",
      "message": "does not match pattern \"^[_a-zA-Z0-9]{1,30}$\"",
      "schema": {
        "type": "string",
        "pattern": "^[_a-zA-Z0-9]{1,30}$"
      },
      "instance": "module-test",
      "name": "pattern",
      "argument": "^[_a-zA-Z0-9]{1,30}$",
      "stack": "instance.functionBlockId does not match pattern \"^[_a-zA-Z0-9]{1,30}$\""
    }
  ]

  Parameter	Description
  path	The path to the element that caused the verification error. In this example, two errors are found: // The properties parameter is incorrectly configured. It is not an array. "path": [ "properties" ] // The value of functionBlockId contains a hyphen, which is invalid. "path": [ "functionBlockId" ]
  property	The specific object under the path that violates the rule. For example, the property for "path": ["functionBlockId" ] is instance.functionBlockId.
  message	The specific error message. For example, for "path": ["functionBlockId" ], the error message for the property is does not match pattern \"^[_a-zA-Z0-9]{1,30}$\".
  schema	The name and content of the verification rule. For example, for "path": ["functionBlockId" ], the rules are type and pattern. For more information about rule definitions, see JSON Schema.
  instance	The specific object being verified. For example, for "path": ["functionBlockId" ], the content of "functionBlockId": "module-test" in the TSL model file is verified.
  name	The name of the rule that failed the verification. For example, for "path": ["functionBlockId" ], the object module-test does not comply with the pattern rule.
  argument	The definition of the rule that was violated. For example, for "path": ["functionBlockId" ], the unmet pattern rule is defined as ^[_a-zA-Z0-9]{1,30}$.
  stack	A complete error message that combines the property and message fields.

For more information, see jsonschema documentation.

Functional differences

After property data, historical data, or batch property data is reported to IoT Platform, the platform generates historical data records based on the timestamps.

Differences in communication topics and data formats

The topic and data format differ for each method. For more information, see Device reports properties, Report historical TSL model data, and Device reports properties in batches.

Example

This example uses a device that reports temperature data.

• Property reporting:

  1. The device reports snapshot data with timestamps sequentially from left to right, as shown in the following table.

     13:00	14:00	15:00	15:10
     60	70	80	90

  2. Then, the device reports another snapshot value of 100. The data is updated differently based on whether a timestamp is included:

     • Without a timestamp: The time defaults to the current time (for example, 15:30). In this case, the snapshot value displayed in the IoT Platform console is 100 at 15:30, and the latest entry in the historical data list is also 100 at 15:30.

     • With a timestamp: If the timestamp is 15:00, the data for 15:00 is updated to 100. The snapshot value displayed in the IoT Platform console becomes 100 at 15:00, but the latest entry in the historical data list remains 90 at 15:10.

• Historical data reporting:

  1. The device reports the following historical data at the same time.

     13:00	14:00	15:00	15:10
     60	70	80	90

  2. Then, the device reports the following historical data at the same time.

     13:10	14:10
     100	200

     In this case, the snapshot value displayed in the IoT Platform console is either 100 at 13:10 or 200 at 14:10, depending on which value was last written to the database. The latest entry in the historical data list remains 90 at 15:10.