IoT Platform:Remote configuration

Features

The remote configuration feature of IoT Platform allows you to:

• Enable or disable remote configuration for a product.

• Edit configuration files and manage their versions online.

• Push configuration files from IoT Platform to update device configurations in a batch.

• Allow devices to proactively request configuration updates.

Use cases

Remote configuration can be used in the following two scenarios:

• From the IoT Platform console, you can push configuration information to devices in a batch. After a device receives the information, it updates its local configuration file.

• A device proactively requests a new configuration file from IoT Platform to perform an update.

The following sections describe the procedures for these use cases.

Use case 1: IoT Platform pushes configurations

In the IoT Platform console, you can push a configuration file to all devices of a product in a batch.

1. Connect the device to IoT Platform.

   For more information about the device development process and code samples, see the Link SDK documentation.

   Important

   When you develop the device, you must configure the device to subscribe to the topic for pushing configuration information: /sys/${productKey}/${deviceName}/thing/config/push.

2. In the IoT Platform console, edit the configuration file.

   1. Log on to the IoT Platform console.

   2. On the Overview page, click All environment. On the All environment tab, find the instance that you want to manage and click the instance ID or instance name.

   3. In the left-side navigation pane, choose Maintenance > Remote Configuration.

   4. Select a product, turn on the remote configuration switch, and click Edit.

   5. In the editor under Configuration Template, write or paste the configuration information in JSON format.

      Note

      A product configuration template applies to all devices under that product. You cannot push a configuration file to a single device from the IoT Platform console.

   6. After you edit the configuration information, click Save, and then click Confirm.

      After saving, you can manually push the configuration information to all devices under the product in a batch, or devices can proactively request this configuration.

3. Click Batch Update, and then click Confirm Update.

   After you confirm, IoT Platform pushes the configuration file to all devices under the product in a batch.

   If IoT Platform detects that the operation is performed in an untrusted environment after you click Batch Update, it initiates an SMS verification. IoT Platform sends the configuration file to the devices only after you complete the verification.

   Important

   • After a successful push, you cannot push a new configuration file to the same product within one hour.

   • You can push the same configuration file to a product only once from IoT Platform.

   • To stop batch updates for device configurations, turn off the remote configuration switch for the product. After you turn off remote configuration, IoT Platform stops all update pushes and denies proactive update requests from devices.

4. The device receives the configuration file download URL from IoT Platform and updates its configuration.

   Note

   The download URL for the configuration file is valid for 30 minutes. The device must download the file within this period.

5. (Optional) View and manage configuration file versions.

   The remote configuration feature saves the last five modification records by default. If you successfully edit and submit a new configuration file, the previous version appears in the version history list below.

   You can view the update time and content of each version for traceability. Click View for a specific version to see its configuration content in a dialog box. In the dialog box, you can click Restore to This Version to load its content into the editor. You can then modify the content and perform a batch update.

Use case 2: Device requests configurations

The following flowchart shows how a device proactively queries and updates its configuration information.

1. Connect the device to IoT Platform.

   For more information about the device development process and code samples, see the Link SDK documentation.

   Note

   When you develop the device, you must configure it to subscribe to the topic that IoT Platform uses to respond to configuration information requests from the device: /sys/${productKey}/${deviceName}/thing/config/get_reply.

2. In the IoT Platform console, enable remote configuration and edit the configuration information. For more information, see Step 2 in Use case 1.

3. The device calls the linkkit_invoke_cota_get_config interface to trigger a remote configuration request.

4. The device sends a request to the /sys/${productKey}/${deviceName}/thing/config/get topic to query the latest configuration information.

5. After receiving the request, IoT Platform returns the latest configuration information to the topic: /sys/${productKey}/${deviceName}/thing/config/get_reply.

6. The device uses the provided URL to download the configuration file.

   For example, C SDK v3.x provides the cota_callback callback function to download the configuration file and complete the update.

   Note

   The download URL for the configuration file is valid for 30 minutes. The device must download the file within this period.