视频讲解： https://www.bilibili.com/video/BV1GK4y1X7Kc/

thingsboard自动创建设备

工作流程汇总如图

image.png
设备向”thingboard”发送设备配置请求。请求中包含密钥和机密（预配置设备秘钥名，预配置设备秘钥），请求可选择包括设备生成的设备名称和凭据。如果缺少这些凭据，服务器将生成设备要使用的访问令牌。
拨备请求示例：

  1. {
  2.   "deviceName": "DEVICE_NAME",
  3.   "provisionDeviceKey": "预配置设备秘钥名",
  4.   "provisionDeviceSecret": "预配置设备秘钥"
  5. }

thingsboard使用设备提供响应（响应）验证请求和回复。成功的响应包含设备 ID、凭据类型和token。如果验证不成功，响应将仅包含状态。

  1. {
  2.   "provisionDeviceStatus":"SUCCESS",  
  3.   "credentialsType":"ACCESS_TOKEN",
  4.   "accessToken":"sLzc0gDAZPkGMzFVTyUY"
  5. }
  6. {
  7.   "credentialsValue":"xvbxcyccSBq9MODwUIOe",
  8.  "credentialsType":"ACCESS_TOKEN",
  9.  "status":"SUCCESS"
  10. }

在请求验证期间，平台将首先检查所提供的DeviceKey和Device秘钥，以找到相应的设备配置文件。找到配置文件后，平台将使用配置的备用策略来验证设备名称。

  • 允许创建新设备- 检查同名设备尚未在 ThingsBoard 中注册。当您在制造过程中不知道唯一设备名称列表（MAC 地址等）时，此策略是有用的，但设备本身可以访问固件中的此信息。它更容易实施，但它不如第二个策略安全。

拨备完成后，ThingsBoard 将更新设备的备件国家服务器属性，并将它设置为拨备值。

设备配置文件配置

您应该配置设备配置文件，以启用配置功能、收集配置设备密钥和提供设备机密。

  • 您可以创建新设备配置文件或打开现有设备配置文件。要创建新的，您应该打开设备配置文件页面，然后单击表头中的”+”图标。
  • 输入新设备配置文件的名称，然后单击”添加设备配置文件”向导的第 4 步。我们将在本示例中使用名称”设备配置测试”。但是，通常这应该是您的设备型号或类似设备。
  • 选择其中一个配给策略，复制拨备密钥和秘密，最后单击”添加”。

image.png

image.png

  1. from paho.mqtt.client import Client
  2. from json import dumps, loads
  4. RESULT_CODES = {
  5.     1: "incorrect protocol version",
  6.     2: "invalid client identifier",
  7.     3: "server unavailable",
  8.     4: "bad username or password",
  9.     5: "not authorised",
  10.     }
  14. def collect_required_data():
  15.     config = {}
  16.     print("\n\n", "="*80, sep="")
  17.     print(" "*10, "\033[1m\033[94mThingsBoard device provisioning with basic authorization example script.\033[0m", sep="")
  18.     print("="*80, "\n\n", sep="")
  19.     host = input("Please write your ThingsBoard \033[93mhost\033[0m or leave it blank to use default (thingsboard.cloud): ")
  20.     config["host"] = host if host else "thingsboard.cloud"
  21.     port = input("Please write your ThingsBoard \033[93mport\033[0m or leave it blank to use default (1883): ")
  22.     config["port"] = int(port) if port else 1883
  23.     config["provision_device_key"] = input("Please write \033[93mprovision device key\033[0m: ")
  24.     config["provision_device_secret"] = input("Please write \033[93mprovision device secret\033[0m: ")
  25.     device_name = input("Please write \033[93mdevice name\033[0m or leave it blank to generate: ")
  26.     if device_name:
  27.         config["device_name"] = device_name
  28.     print("\n", "="*80, "\n", sep="")
  29.     return config
  32. class ProvisionClient(Client):
  33.     PROVISION_REQUEST_TOPIC = "/provision/request"
  34.     PROVISION_RESPONSE_TOPIC = "/provision/response"
  36.     def __init__(self, host, port, provision_request):
  37.         super().__init__()
  38.         self._host = host
  39.         self._port = port
  40.         self._username = "provision"
  41.         self.on_connect = self.__on_connect
  42.         self.on_message = self.__on_message
  43.         self.__provision_request = provision_request
  45.     def __on_connect(self, client, userdata, flags, rc):  # Callback for connect
  46.         if rc == 0:
  47.             print("[Provisioning client] Connected to ThingsBoard ")
  48.             client.subscribe(self.PROVISION_RESPONSE_TOPIC)  # Subscribe to provisioning response topic
  49.             provision_request = dumps(self.__provision_request)
  50.             print("[Provisioning client] Sending provisioning request %s" % provision_request)
  51.             client.publish(self.PROVISION_REQUEST_TOPIC, provision_request)  # Publishing provisioning request topic
  52.         else:
  53.             print("[Provisioning client] Cannot connect to ThingsBoard!, result: %s" % RESULT_CODES[rc])
  55.     def __on_message(self, client, userdata, msg):
  56.         decoded_payload = msg.payload.decode("UTF-8")
  57.         print("[Provisioning client] Received data from ThingsBoard: %s" % decoded_payload)
  58.         decoded_message = loads(decoded_payload)
  59.         provision_device_status = decoded_message.get("status")
  60.         if provision_device_status == "SUCCESS":
  61.             self.__save_credentials(decoded_message["credentialsValue"])
  62.         else:
  63.             print("[Provisioning client] Provisioning was unsuccessful with status %s and message: %s" % (provision_device_status, decoded_message["errorMsg"]))
  64.         self.disconnect()
  66.     def provision(self):
  67.         print("[Provisioning client] Connecting to ThingsBoard (provisioning client)")
  68.         self.__clean_credentials()
  69.         self.connect(self._host, self._port, 60)
  70.         self.loop_forever()
  72.     def get_new_client(self):
  73.         client_credentials = self.__get_credentials()
  74.         new_client = None
  75.         if client_credentials:
  76.             new_client = Client()
  77.             new_client.username_pw_set(client_credentials)
  78.             print("[Provisioning client] Read credentials from file.")
  79.         else:
  80.             print("[Provisioning client] Cannot read credentials from file!")
  81.         return new_client
  83.     @staticmethod
  84.     def __get_credentials():
  85.         new_credentials = None
  86.         try:
  87.             with open("credentials", "r") as credentials_file:
  88.                 new_credentials = credentials_file.read()
  89.         except Exception as e:
  90.             print(e)
  91.         return new_credentials
  93.     @staticmethod
  94.     def __save_credentials(credentials):
  95.         with open("credentials", "w") as credentials_file:
  96.             credentials_file.write(credentials)
  98.     @staticmethod
  99.     def __clean_credentials():
  100.         open("credentials", "w").close()
  103. def on_tb_connected(client, userdata, flags, rc):  # Callback for connect with received credentials
  104.     if rc == 0:
  105.         print("[ThingsBoard client] Connected to ThingsBoard with credentials: %s" % client._username.decode())
  106.         data={
  107.             "Hello":"Vincent Iot"
  108.         }
  109.         client.publish('v1/devices/me/telemetry', payload=dumps(data), qos=0)
  110.     else:
  111.         print("[ThingsBoard client] Cannot connect to ThingsBoard!, result: %s" % RESULT_CODES[rc])
  114. if __name__ == '__main__':
  116.     config = collect_required_data()
  118.     THINGSBOARD_HOST = config["host"]  # ThingsBoard instance host
  119.     THINGSBOARD_PORT = config["port"]  # ThingsBoard instance MQTT port
  121.     PROVISION_REQUEST = {"provisionDeviceKey": config["provision_device_key"],  # Provision device key, replace this value with your value from device profile.
  122.                          "provisionDeviceSecret": config["provision_device_secret"],  # Provision device secret, replace this value with your value from device profile.
  123.                          }
  124.     if config.get("device_name") is not None:
  125.         PROVISION_REQUEST["deviceName"] = config["device_name"]
  126.     provision_client = ProvisionClient(THINGSBOARD_HOST, THINGSBOARD_PORT, PROVISION_REQUEST)
  127.     provision_client.provision()  # Request provisioned data
  128.     tb_client = provision_client.get_new_client()  # Getting client with provisioned data
  129.     if tb_client:
  130.         tb_client.on_connect = on_tb_connected  # Setting callback for connect
  131.         tb_client.connect(THINGSBOARD_HOST, THINGSBOARD_PORT, 60)
  132.         tb_client.loop_forever()  # Starting infinity loop
  133.     else:
  134.         print("Client was not created!")

运行结果

  1. ================================================================================
  2.           ThingsBoard device provisioning with basic authorization example script.
  3. ================================================================================
  6. Please write your ThingsBoard host or leave it blank to use default (thingsboard.cloud): www.vincentisme.com
  7. Please write your ThingsBoard port or leave it blank to use default (1883): 1883
  8. Please write provision device key: 2qvxh8igfbqsbf1bzvg1
  9. Please write provision device secret: qvm7qfeiiy0pv0vtbx30
  10. Please write device name or leave it blank to generate: vincentIot
  12. ================================================================================
  14. [Provisioning client] Connecting to ThingsBoard (provisioning client)
  15. [Provisioning client] Connected to ThingsBoard 
  16. [Provisioning client] Sending provisioning request {"provisionDeviceKey": "2qvxh8igfbqsbf1bzvg1", "provisionDeviceSecret": "qvm7qfeiiy0pv0vtbx30", "deviceName": "vincentIot"}
  17. [Provisioning client] Received data from ThingsBoard: {"credentialsValue":"iMc83m7ipXBt3RLsqXti","credentialsType":"ACCESS_TOKEN","status":"SUCCESS"}
  18. [Provisioning client] Read credentials from file.
  19. [ThingsBoard client] Connected to ThingsBoard with credentials: iMc83m7ipXBt3RLsqXti

image.png

image.png