您可以使用HTTP API参考来开发将执行配置请求的设备固件。
如前所述，设备可以在注册过程中请求服务器生成凭据或提供其自己的凭据。请参阅以下每个选项的请求/响应和代码示例：


由ThingsBoard服务器生成的凭证
设备提供
访问令牌
参数 示例值 描述
设备名称 设备名称 ThingsBoard中的设备名称。
ProvisionDeviceKey PUT_PROVISION_KEY_HERE 供应设备密钥，您应该从已配置的设备配置文件中获取它。
ProvisionDeviceSecret PUT_PROVISION_SECRET_HERE 设置设备密码，您应该从已配置的设备配置文件中获取它。

请求数据示例：

  1. {
  2.   "deviceName": "DEVICE_NAME",
  3.   "provisionDeviceKey": "PUT_PROVISION_KEY_HERE",
  4.   "provisionDeviceSecret": "PUT_PROVISION_SECRET_HERE"
  5. }

响应示例：

  1. {
  2.   "status":"SUCCESS",
  3.   "credentialsType":"ACCESS_TOKEN",
  4.   "credentialsValue":"sLzc0gDAZPkGMzFVTyUY"
  5. }

样例脚本

脚本源代码如下。您可以将其复制粘贴到文件中，例如：

  1. device-provision-example.py

现在，您应该运行脚本并按照其中的步骤进行操作。
您可以使用python 3启动脚本：

  1. python3 device-provision-example.py

脚本源代码：

  3. from requests import post
  4. from json import dumps
  7. def collect_required_data():
  8.     config = {}
  9.     print("\n\n", "="*80, sep="")
  10.     print(" "*10, "\033[1m\033[94mThingsBoard device provisioning without authorization example script. HTTP API\033[0m", sep="")
  11.     print("="*80, "\n\n", sep="")
  12.     host = input("Please write your ThingsBoard \033[93mhost\033[0m or leave it blank to use default (https://thingsboard.cloud): ")
  13.     config["host"] = host if host else "https://thingsboard.cloud"
  14.     port = input("Please write your ThingsBoard \033[93mHTTP port\033[0m or leave it blank to use default (80): ")
  15.     config["port"] = int(port) if port else 80
  16.     config["provision_device_key"] = input("Please write \033[93mprovision device key\033[0m: ")
  17.     config["provision_device_secret"] = input("Please write \033[93mprovision device secret\033[0m: ")
  18.     device_name = input("Please write \033[93mdevice name\033[0m or leave it blank to generate: ")
  19.     if device_name:
  20.         config["device_name"] = device_name
  21.     print("\n", "="*80, "\n", sep="")
  22.     return config
  25. # Example for message to ThingsBoard
  26. to_publish = {
  27.   "stringKey": "value1",
  28.   "booleanKey": True,
  29.   "doubleKey": 42.0,
  30.   "longKey": 73,
  31.   "jsonKey": {
  32.     "someNumber": 42,
  33.     "someArray": [1, 2, 3],
  34.     "someNestedObject": {"key": "value"}
  35.   }
  36. }
  38. if __name__ == '__main__':
  40.     config = collect_required_data()
  42.     THINGSBOARD_HOST = config["host"]  # ThingsBoard instance host
  43.     THINGSBOARD_PORT = config["port"]  # ThingsBoard instance MQTT port
  45.     PROVISION_REQUEST = {"provisionDeviceKey": config["provision_device_key"],  # Provision device key, replace this value with your value from device profile.
  46.                          "provisionDeviceSecret": config["provision_device_secret"],  # Provision device secret, replace this value with your value from device profile.
  47.                          }
  48.     if config.get("device_name") is not None:
  49.         PROVISION_REQUEST["deviceName"] = config["device_name"]
  50.     response = post("%s:%i/api/v1/provision" % (THINGSBOARD_HOST, THINGSBOARD_PORT), json=PROVISION_REQUEST)
  51.     decoded_response = response.json()
  52.     print("Received response: ")
  53.     print(decoded_response)
  54.     received_token = decoded_response.get("credentialsValue")
  55.     if received_token is not None:
  56.         response = post('%s:%i/api/v1/%s/telemetry' % (THINGSBOARD_HOST, THINGSBOARD_PORT, received_token,), dumps(to_publish))
  57.         print("[THINGSBOARD CLIENT] Response code from Thingsboard.")
  58.         print(response.status_code)
  59.     else:
  60.         print("Failed to get access token from response.")
  61.         print(decoded_response.get("errorMsg"))
参数 示例值 描述
设备名称 设备名称 ThingsBoard中的设备名称。
ProvisionDeviceKey PUT_PROVISION_KEY_HERE 供应设备密钥，您应该从已配置的设备配置文件中获取它。
ProvisionDeviceSecret PUT_PROVISION_SECRET_HERE 设置设备密码，您应该从已配置的设备配置文件中获取它。
凭据类型 ACCESS_TOKEN 凭证类型参数。
代币 DEVICE_ACCESS_TOKEN 在ThingsBoard中访问设备的令牌。

请求数据示例：

  1. {
  2.   "deviceName": "DEVICE_NAME",
  3.   "provisionDeviceKey": "PUT_PROVISION_KEY_HERE",
  4.   "provisionDeviceSecret": "PUT_PROVISION_SECRET_HERE",
  5.   "credentialsType": "ACCESS_TOKEN",
  6.   "token": "DEVICE_ACCESS_TOKEN"
  7. }

响应示例：

  1. {
  2.   "credentialsType":"ACCESS_TOKEN",
  3.   "credentialsValue":"DEVICE_ACCESS_TOKEN",
  4.   "status":"SUCCESS"
  5. }

样例脚本

脚本源代码如下。您可以将其复制粘贴到文件中，例如：

  1. device-provision-example.py

现在，您应该运行脚本并按照其中的步骤进行操作。
您可以使用python 3启动脚本：

  1. python3 device-provision-example.py

脚本源代码：

  3. from requests import post
  4. from json import dumps
  7. def collect_required_data():
  8.     config = {}
  9.     print("\n\n", "="*80, sep="")
  10.     print(" "*10, "\033[1m\033[94mThingsBoard device provisioning with access token authorization example script. HTTP API\033[0m", sep="")
  11.     print("="*80, "\n\n", sep="")
  12.     host = input("Please write your ThingsBoard \033[93murl\033[0m or leave it blank to use default (https://thingsboard.cloud): ")
  13.     config["host"] = host if host else "https://thingsboard.cloud"
  14.     port = input("Please write your ThingsBoard \033[93mHTTP port\033[0m or leave it blank to use default (80): ")
  15.     config["port"] = int(port) if port else 80
  16.     config["provision_device_key"] = input("Please write \033[93mprovision device key\033[0m: ")
  17.     config["provision_device_secret"] = input("Please write \033[93mprovision device secret\033[0m: ")
  18.     config["token"] = input("Please write \033[93mdevice access token\033[0m: ")
  19.     device_name = input("Please write \033[93mdevice name\033[0m or leave it blank to generate: ")
  20.     if device_name:
  21.         config["device_name"] = device_name
  22.     print("\n", "="*80, "\n", sep="")
  23.     return config
  26. # Example for message to ThingsBoard
  27. to_publish = {
  28.   "stringKey": "value1",
  29.   "booleanKey": True,
  30.   "doubleKey": 42.0,
  31.   "longKey": 73,
  32.   "jsonKey": {
  33.     "someNumber": 42,
  34.     "someArray": [1, 2, 3],
  35.     "someNestedObject": {"key": "value"}
  36.   }
  37. }
  39. if __name__ == '__main__':
  41.     config = collect_required_data()
  43.     THINGSBOARD_HOST = config["host"]  # ThingsBoard instance host
  44.     THINGSBOARD_PORT = config["port"]  # ThingsBoard instance MQTT port
  46.     PROVISION_REQUEST = {"provisionDeviceKey": config["provision_device_key"],  # Provision device key, replace this value with your value from device profile.
  47.                          "provisionDeviceSecret": config["provision_device_secret"],  # Provision device secret, replace this value with your value from device profile.
  48.                          "credentialsType": "ACCESS_TOKEN",
  49.                          "token": config["token"],
  50.                          }
  51.     if config.get("device_name") is not None:
  52.         PROVISION_REQUEST["deviceName"] = config["device_name"]
  53.     response = post("%s:%i/api/v1/provision" % (THINGSBOARD_HOST, THINGSBOARD_PORT), json=PROVISION_REQUEST)
  54.     decoded_response = response.json()
  55.     print("Received response: ")
  56.     print(decoded_response)
  57.     received_token = decoded_response.get("credentialsValue")
  58.     if received_token is not None:
  59.         response = post('%s:%i/api/v1/%s/telemetry' % (THINGSBOARD_HOST, THINGSBOARD_PORT, received_token,), dumps(to_publish))
  60.         print("[THINGSBOARD CLIENT] Response code from Thingsboard.")
  61.         print(response.status_code)
  62.     else:
  63.         print("Failed to get access token from response.")
  64.         print(decoded_response.get("errorMsg"))