tencentyun · tonychanchen · Jun 7, 2021 · Jun 16, 2021 · Jun 28, 2021 · Jun 29, 2021
diff --git a/.github/files/explorer/device_info.json.asc b/.github/files/explorer/device_info.json.asc
@@ -0,0 +1,13 @@
+-----BEGIN PGP MESSAGE-----
+
+jA0EBwMCQEdzKXolxHrr0sDDAS/p+lpyNU18OpGIntyFt6WTktOe7QBFOCa2zzKJ
+0PLJKVs6IK+AqSsWU/ASJhWf7x1MCLywgnXt3Kmo2iZQlP0HFqHD5CZ/AW83DNVU
+rFVuoUPot6YYmlMqbLsZp8NVGxZ+Zev5wp7GiadYFmPQsVR/IoLdUikUOoUpWeyI
+4aVRk6vgsMZzotAYI6DcdCxEOQdUS7vO5B8ZfEx7ehzWf+giR4PGlH+aQJevaT7X
+qHovtcNOK5XPf8hk+QafOYkCDdJP5QaHdfxrDwn7TJHUiLiUvciIYSLOeM16+psP
+XevcTYOhMCy44eLMGejFbT3YPqcEK7j+522x9mpPhDlXtA9FLnLYufv5hUNRQ85Q
+6sMfGgKSd+AoY6Qbfkk2OhM/wqjM7bpr9wGwzurpxvdYXFZ1kBi78zC/T/HqyOQf
+R3LGhW1DijI7Ufo22/+uioaM66S6JVyfBMxVH8n774js2fzh43xOJw1rdgoITSEw
+FOW2a7N/O5ZbxLnTctH1K34NA3cr
+=rSwV
+-----END PGP MESSAGE-----
diff --git a/.github/files/hub/device_info.json.asc b/.github/files/hub/device_info.json.asc
@@ -0,0 +1,13 @@
+-----BEGIN PGP MESSAGE-----
+
+jA0EBwMCDiAOe23XImfr0sC4AWnWsJkzpMVE7w0aZqHyjIa3pEXxWBJlZcxbSHGr
+MyjGqM1sYP4MBQ2aMY9jO2xgsbQbAKDONyhkfdhjw72M7Z5QIiPADwfW+MnTJ96P
+Pw8k0riMYjM1sAWM0odPB6Pn7/F0wAW93020+rTNfiqHewlZ2aPxBBMTS1y9uejE
+eJ/WgZr+QQm2ZJJOGNi/ncEM4qNwSgnduDCuZn3v8kCSXIoVXZuJ6Xp9kH/9Sl2/
+nAz6pKm/YY59yoQrcmxiBCc+44pTG3VfgIs6OAs0t8oZRiwLQNyB3aoAg8kIDJXK
+O1pbroSXq7cdC7YvAhHgTu0lfrv1Kkbwc8rn+VLsB4wgAQH32v2uBJniluUiCf7G
+KtoNFmjR0HeAbOpyKMM7Z4MbDQPbxaQ3YsZCYwwwnMwBeDoG3ScuNV7lD+mYL4xP
+dVaCtjzbnsHgjaqDnmgwfgimAIDbwONa40ZS1YppSvd6+ENRLDu3b+mWqutPE4I+
+jQlLu4BDMnTZeA==
+=skJN
+-----END PGP MESSAGE-----
diff --git a/.github/scripts/send_result_to_wecom.sh b/.github/scripts/send_result_to_wecom.sh
@@ -0,0 +1,23 @@
+#!/bin/sh
+
+color=""
+if [ $2 == "success" ]
+then
+   echo "success"
+   color="info"
+else
+   echo "fail"
+   color="warning"
+fi
+
+curl "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=$IOT_WECOM_CID_ROBOT_KEY" \
+   -H 'Content-Type: application/json' \
+   -d '
+   {
+      "msgtype": "markdown",
+      "markdown": {
+           "content": "**repo: \"'"$1"'\"**\n
+           >result:<font color=\"'"$color"'\">\"'"$2"'\"</font>\n
+           >[action](https://github.com/tencentyun/iot-device-python/actions)"\n
+      }
+   }'
diff --git a/.github/workflows/pypi_publish.yml b/.github/workflows/pypi_publish.yml
@@ -7,33 +7,43 @@ on:
       - '**.md'
       - 'LICENSE'
 
+env:
+  IOT_WECOM_CID_ROBOT_KEY: ${{ secrets.IOT_WECOM_CID_ROBOT_KEY }}
+
 jobs:
 
   build:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v4
     - name: Set up Python 3.x
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v5
       with:
-        python-version: 3.7
+        python-version: '3.13'
 
     - name: Install dependencies
       run: |
+        pip install setuptools wheel twine
         python setup.py check
         python -m pip install --upgrade pip
-        pip install setuptools wheel twine
 
     - name: Unittest TestCase
+      env:
+        PROVISIONING_PASSWORD: ${{ secrets.GPG_DECRYPT_PASSPHRASE }}
       run: |
         python -m venv test_env
         source test_env/bin/activate
+        pip install setuptools
         python setup.py install
         pip install -r requirements.txt
-        python sample/test.py
+        gpg --quiet -d --passphrase "$PROVISIONING_PASSWORD" --batch .github/files/explorer/device_info.json.asc > explorer/sample/device_info.json
+        gpg --quiet -d --passphrase "$PROVISIONING_PASSWORD" --batch .github/files/hub/device_info.json.asc > hub/sample/device_info.json
+        python explorer/sample/test.py
+        python hub/sample/test.py
 
     - name: Publish to Test PyPI
+      if: startsWith(github.event.ref, 'refs/heads')
       env:
         TWINE_USERNAME: __token__
         TWINE_PASSWORD: ${{ secrets.IOT_TEST_PYPI_UPLOAD_TOKEN }}
@@ -47,8 +57,20 @@ jobs:
         TWINE_USERNAME: __token__
         TWINE_PASSWORD: ${{ secrets.IOT_PYPI_UPLOAD_TOKEN }}
       run: |
+        VERSION=$(git describe --tags `git rev-list --tags --max-count=1`)
+        echo $VERSION
         rm -rf dist/
         sed -i "s#resp = urllib.request.*#resp = urllib.request.urlopen(f\'https://pypi.org/pypi/{name}/json\')#g" setup.py
-
+        sed -i "s#version=.*#version=\"$VERSION\",#g" setup.py
         python setup.py sdist bdist_wheel
         twine upload dist/*
+    - name: Report success result to wecom
+      if: ${{ success() }}
+      run: |
+        echo success!!!
+        bash .github/scripts/send_result_to_wecom.sh ${{ github.event.repository.name }} success
+    - name: Report fail result to wecom
+      if: ${{ failure() }}
+      run: |
+        echo fail!!!
+        bash .github/scripts/send_result_to_wecom.sh ${{ github.event.repository.name }} fail
diff --git a/.gitignore b/.gitignore
@@ -5,5 +5,6 @@ dist/
 test_env/
 samples/
 build.sh
-TIoTExploreSDK.egg-info/
-*.pyc
+*.egg-info/
+*.pyc
+logs/log
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+简体中文 | [English](./README_EN-US.md)
+
 # 产品介绍
 
 本仓库中包含两个产品：腾讯云物联网通信（IoT Hub） 和 腾讯云物联网开发平台（IoT Explorer） ，本仓库提供 Python 接入方式 。

diff --git a/README_EN-US.md b/README_EN-US.md
@@ -0,0 +1,27 @@
+[简体中文](https://github.com/tencentyun/iot-device-python) | English   
+
+# Product Overview
+
+This repository contains two products: IoT Hub and IoT Explorer. It provides the Python connection method.
+
+## IoT Hub SDK for Python
+
+Tencent Cloud Internet of Things Hub (IoT Hub) aims to provide a secure, stable, and efficient connection platform that helps developers quickly achieve stable, high-concurrency, and omnidirectional data communications among devices, user applications, and cloud services at low costs. It can implement cross-device interaction, device data reporting, and configuration distribution. Further, by opening up the linkage between device data and Tencent Cloud services based on the rule engine, it allows for the storage, real-time computation, and smart processing and analysis of massive amounts of data with speed and ease. For more information, please see [IoT Hub](https://cloud.tencent.com/document/product/634).
+
+This repository provides the IoT Hub device SDK. You can securely connect Python-enabled devices to IoT Hub by integrating the SDK into them.
+
+* [IoT Hub device SDK for Python](hub/)
+
+
+## IoT Explorer SDK for Python
+
+Tencent Cloud Internet of Things Explorer (IoT Explorer) provides device manufacturers, solution providers, and application developers in various industries with one-stop device automation services. It offers the capabilities to connect and manage high numbers of devices and develop mini programs and is interconnected with the basic products and AI capabilities of Tencent Cloud, which helps improve the device automation efficiency in traditional industries, reduce the development and OPS costs, and empower the business growth. For more information, please see [IoT Explorer](https://cloud.tencent.com/document/product/1081).
+
+This repository provides the IoT Explorer device SDK. You can securely connect Python-enabled devices to IoT Explorer by connecting their drivers or integrating the SDK into them.
+
+* [IoT Explorer device SDK for Python](explorer/)
+
+
+## Domain names involved in SDKs
+
+For the domain names involved in the corresponding SDKs of the two products, please see [Domain Names Involved in Device SDKs](https://github.com/tencentyun/iot-device-java/wiki/Device-SDK涉及的域名).
diff --git a/explorer/README.md b/explorer/README.md
@@ -1,9 +1,12 @@
+简体中文 | [English](doc/en)   
+
 * [腾讯云物联网开发平台设备端 IoT Explorer Python-SDK](#腾讯云物联网开发平台设备端-IoT-Explorer-Python-SDK)
   * [前提条件](#前提条件)
   * [工程配置](#工程配置)
   * [下载IoT Explorer Python-SDK Demo示例代码](#下载IoT-Explorer-Python-SDK-Demo示例代码)
   * [功能文档](#功能文档)
   * [SDK API 说明](#SDK-API-说明)
+  * [常见问题](#常见问题)
 
 # 腾讯云物联网开发平台设备端 IoT Explorer Python-SDK
 欢迎使用腾讯云物联网开发平台设备端 IoT Explorer Python-SDK 。
@@ -33,3 +36,4 @@ SDK支持pip安装，以及本地源码安装，详细接入步骤请参考 [SDK
 * [事件上报以及多事件上报](doc/事件上报以及多事件上报.md)
 * [检查固件更新](doc/检查固件更新.md)
 * [网关使用示例](doc/网关使用示例.md)
+* [常见问题](doc/常见问题.md)
diff --git a/explorer/doc/SDK接入说明.md b/explorer/doc/SDK接入说明.md
@@ -7,7 +7,7 @@
 -  Install from pip
 
     ```
-	pip install TIoTExploreSDK
+	pip install tencent-iot-device
 	```
 
 

diff --git a/explorer/doc/SDK接口说明.md b/explorer/doc/SDK接口说明.md
@@ -0,0 +1,83 @@
+* [API接口说明](#API接口说明)
+  * [MQTT接口](#MQTT接口)
+  * [网关接口](#网关接口)
+  * [数据模板接口](#设备影子接口)
+  * [动态注册接口](#动态注册接口)
+  * [OTA接口](#OTA接口)
+  * [LOG接口](#LOG接口)
+
+# API接口说明
+## MQTT接口
+
+| 接口名称 | 接口描述 |
+| :-: | :-: |
+| connect | MQTT连接 |
+| disconnect | 断开MQTT连接 |
+| subscribe | MQTT订阅 |
+| unsubscribe | MQTT取消订阅 |
+| publish | MQTT发布消息 |
+| registerMqttCallback | 注册MQTT回调函数 |
+| registerUserCallback | 注册用户回调函数 |
+| isMqttConnected | MQTT是否正常连接 |
+| getConnectState | 获取MQTT连接状态 |
+| setReconnectInterval | 设置MQTT重连尝试间隔 |
+| setMessageTimout | 设置消息发送超时时间 |
+| setKeepaliveInterval | 设置MQTT保活间隔 |
+
+## 网关接口
+| 接口名称 | 接口描述 |
+| :-: | :-: |
+| gatewayInit | 网关初始化 |
+| isSubdevStatusOnline | 判断子设备是否在线 |
+| updateSubdevStatus | 更新子设备在线状态 |
+| gatewaySubdevGetConfigList | 获取配置文件中子设备列表 |
+| gatewaySubdevOnline | 代理子设备上线 |
+| gatewaySubdevOffline | 代理子设备下线 |
+| gatewaySubdevBind | 绑定子设备 |
+| gatewaySubdevUnbind | 解绑子设备 |
+| gatewaySubdevSubscribe | 子设备订阅 |
+
+## 数据模板接口
+| 接口名称 | 接口描述 |
+| :-: | :-: |
+| templateInit | 数据模板初始化 |
+| getEventsList | 获取设备event列表 |
+| getActionList | 获取设备action列表 |
+| getPropertyList | 获取设备property列表 |
+| templateSetup | 解析数据模板 |
+| templateEventPost | events上报 |
+| templateJsonConstructReportArray | 构建上报的json结构 |
+| templateReportSysInfo | 设备信息上报 |
+| templateControlReply | 控制消息应答 |
+| templateActionReply | action消息应答 |
+| templateGetStatus | 获取设备最新状态 |
+| templateReport | 设备属性上报 |
+| clearControl | 清除控制 |
+| templateDeinit | 数据模板销毁 |
+
+## 动态注册接口
+| 接口名称 | 接口描述 |
+| :-: | :-: |
+| dynregDevice | 获取设备动态注册的信息 |
+
+## OTA接口
+| 接口名称 | 接口描述 |
+| :-: | :-: |
+| otaInit | OTA初始化 |
+| otaIsFetching | 判断是否正在下载 |
+| otaIsFetchFinished | 判断是否下载完成 |
+| otaReportUpgradeSuccess | 上报升级成功消息 |
+| otaReportUpgradeFail | 上报升级失败消息 |
+| otaIoctlNumber | 获取下载固件大小等int类型信息 |
+| otaIoctlString | 获取下载固件md5等string类型信息 |
+| otaResetMd5 | 重置md5信息 |
+| otaMd5Update | 更新md5信息 |
+| httpInit | 初始化http |
+| otaReportVersion | 上报当前固件版本信息 |
+| otaDownloadStart | 开始固件下载 |
+| otaFetchYield | 读取固件 |
+
+## LOG接口
+| 接口名称 | 接口描述 |
+| :-: | :-: |
+| logInit | 日志初始化 |
diff --git a/explorer/doc/en/PRELIM__SDK接入说明_EN-US.md b/explorer/doc/en/PRELIM__SDK接入说明_EN-US.md
@@ -0,0 +1,28 @@
+ * [How to Import](#How-to-Import)
+
+## How to Import
+
+**How to import**
+
+-  Install from pip
+
+    ```
+	pip install tencent-iot-device
+	```
+
+
+-  Build from source
+
+	```
+	git clone https://github.com/tencentyun/iot-device-python.git
+	cd iot-device-python
+	python setup.py install
+	```
+
+
+**SDK for Python source code**
+
+- If you want to develop a project through code integration, you can download the SDK for Python source code from [Github](../).
+- If you want to develop a project by importing the source code, you can refer to [Latest release](https://github.com/tencentyun/iot-device-python/releases) for the specific version number.
+
+
diff --git a/explorer/doc/en/PRELIM__SDK接口说明_EN-US.md b/explorer/doc/en/PRELIM__SDK接口说明_EN-US.md
@@ -0,0 +1,83 @@
+* [API Description](#API-Description)
+  * [MQTT APIs](#MQTT-APIs)
+  * [Gateway APIs](#Gateway-APIs)
+  * [Data template APIs](#Data-template-APIs)
+  * [Dynamic registration APIs](#Dynamic-registration-APIs)
+  * [OTA APIs](#OTA-APIs)
+  * [Log APIs](#Log-APIs)
+
+# API Description
+## MQTT APIs
+
+| API | Description |
+| :-: | :-: |
+| connect | Establishes MQTT connection |
+| disconnect | Closes MQTT connection |
+| subscribe | Subscribes to MQTT |
+| unsubscribe | Unsubscribes from MQTT |
+| publish | Publishes message over MQTT |
+| registerMqttCallback | Registers MQTT callback function |
+| registerUserCallback | Registers user callback function |
+| isMqttConnected | Checks whether MQTT is normally connected |
+| getConnectState | Gets MQTT connection status |
+| setReconnectInterval | Sets MQTT reconnection attempt interval |
+| setMessageTimout | Sets message sending timeout period |
+| setKeepaliveInterval | Sets MQTT keepalive interval |
+
+## Gateway APIs
+| API | Description |
+| :-: | :-: |
+| gatewayInit | Initializes gateway |
+| isSubdevStatusOnline | Determines whether subdevice is online |
+| updateSubdevStatus | Updates subdevice's online status |
+| gatewaySubdevGetConfigList | Gets subdevice list from configuration file |
+| gatewaySubdevOnline | Proxies subdevice connection |
+| gatewaySubdevOffline | Proxies subdevice disconnection |
+| gatewaySubdevBind | Binds subdevice |
+| gatewaySubdevUnbind | Unbinds subdevice |
+| gatewaySubdevSubscribe | Proxies subdevice subscription |
+
+## Data template APIs
+| API | Description |
+| :-: | :-: |
+| templateInit | Initializes data template |
+| getEventsList | Gets device event list |
+| getActionList | Gets device action list |
+| getPropertyList | Gets device attribute list |
+| templateSetup | Parses data template |
+| templateEventPost | Reports event |
+| templateJsonConstructReportArray | Constructs JSON structure for reporting |
+| templateReportSysInfo | Reports device information |
+| templateControlReply | Replies to control message |
+| templateActionReply | Replies to action message |
+| templateGetStatus | Gets latest device status |
+| templateReport | Reports device attribute |
+| clearControl | Clears control |
+| templateDeinit | Terminates data template |
+
+## Dynamic registration APIs
+| API | Description |
+| :-: | :-: |
+| dynregDevice | Gets the dynamic registration information of device |
+
+## OTA APIs
+| API | Description |
+| :-: | :-: |
+| otaInit | Initializes OTA |
+| otaIsFetching | Determines whether the download is in progress |
+| otaIsFetchFinished | Determines whether the download is completed |
+| otaReportUpgradeSuccess | Reports update success message |
+| otaReportUpgradeFail | Reports update failure message |
+| otaIoctlNumber | Gets the information of the downloaded firmware in `int` type, such as the size |
+| otaIoctlString | Gets the information of the downloaded firmware in `String` type, such as MD5 |
+| otaResetMd5 | Resets MD5 information |
+| otaMd5Update | Updates MD5 information |
+| httpInit | Initializes HTTP |
+| otaReportVersion | Reports the information of current firmware version |
+| otaDownloadStart | Starts firmware download |
+| otaFetchYield | Reads firmware |
+
+## Log APIs
+| API | Description |
+| :-: | :-: |
+| logInit | Initializes log |
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,7 +7,7 @@ @@
     -  Install from pip
         ```
-    	pip install TIoTExploreSDK
+    	pip install tencent-iot-device
     	```
@@ Expand Down @@