فهرست منبع

add readme.md

mrh 10 ماه پیش
والد
کامیت
6bbcc1b6be
1فایلهای تغییر یافته به همراه24 افزوده شده و 12 حذف شده
  1. 24 12
      readme.md

+ 24 - 12
readme.md

@@ -8,10 +8,10 @@
 ESP8266 相关代码,主要用于设备的核心逻辑和通信功能。
 
 - **esp_http.py**: 提供 HTTP 请求功能,包括 GET、POST 等方法。
-- **esp_mqtt.py**: 实现 MQTT 协议,支持与 OneNet 平台的数据交互。
-- **main.py**: 设备的核心逻辑,定义了 `Device` 类。
-- **mywifi.py**: 管理 Wi-Fi 连接,提供 `MyWifi` 类。
-- **test.py**: 包含测试类 `Client` 和 `Test`。
+- **esp_mqtt.py**: 实现 MQTT 协议,支持与 OneNet 平台的数据交互,包括数据上传、消息订阅和命令响应
+- **main.py**: 设备的核心逻辑,定义了 `Device` 类,可能用于管理设备的整体运行
+- **mywifi.py**: 管理 Wi-Fi 连接,提供 `MyWifi` 类,支持自动连接和状态检查
+- **test.py**: 包含测试类 `Client` 和 `Test`,用于验证 MQTT 功能
 - **demo/**: 示例代码,展示文件系统操作和 MQTT 使用。
 
 ### python38/
@@ -19,30 +19,42 @@ Python3.8 相关代码,主要用于与 OneNet 平台的交互和开发板通
 
 - **communicate.py**: 提供 MQTT 连接和消息处理功能。
 - **connect.py**: 包含核心秘钥计算算法和 MQTT 功能。
-- **mqtt_onenet.py**: 实现与 OneNet 平台的交互。
+- **mqtt_onenet.py**: 实现与 OneNet 平台的交互,支持数据上传和命令响应
 - **mylib.py**: 工具函数库,如生成 Token 和格式化数据。
-- **OneNet_API.py**: 提供调用 OneNet API 的功能。
-- **pyboard.py**: 与开发板通信,支持文件系统操作和命令执行。
-- **test.py**: 包含测试类 `Test`。
+- **OneNet_API.py**: 提供调用 OneNet API 的功能,支持设备注册、信息查询和命令发送
+- **pyboard.py**: 与开发板通信,支持文件系统操作(如列出文件、读取文件、写入文件)和命令执行。
+- **test.py**: 包含测试类 `Test`,用于验证数据上传功能
 
 ### umqtt/
 MicroPython 的 MQTT 库,提供轻量级的 MQTT 客户端实现。
 
 - **simple.py**: 实现 MQTT 协议的基本功能,包括连接、发布、订阅等。
 
+## 功能说明
+
+### MQTT 通信
+- **数据上传**:通过 `esp_mqtt.py` 和 `mqtt_onenet.py`,设备定期向 OneNet 平台上传传感器数据(如温度、湿度)和系统信息(如电量、GPS 坐标)。
+- **命令响应**:设备订阅 OneNet 平台的命令主题,接收并响应远程控制指令。例如,可以通过平台发送命令来控制设备行为。
+
+### 应用场景
+- **环境监测**:通过上传传感器数据,可用于监测温度、湿度等环境参数。
+- **远程控制**:通过接收平台命令,可实现对设备的远程控制。
+- **物联网基础框架**:项目提供了物联网设备开发的基础功能,可扩展到智能家居、工业监控等场景。
+
 ## 使用说明
 
 1. **ESP8266**:
    - 使用 `mywifi.py` 配置 Wi-Fi 连接。
    - 使用 `esp_http.py` 或 `esp_mqtt.py` 实现与服务器的通信。
-   - 核心逻辑在 `main.py` 中实现。
+   - 核心逻辑在 `main.py` 中实现,可能包括设备初始化、任务调度等功能。
+   - 示例代码在 `demo/` 目录下,展示了如何使用文件系统和 MQTT。
 
 2. **Python3.8**:
-   - 使用 `OneNet_API.py` 调用 OneNet 平台的 API。
-   - 使用 `pyboard.py` 与开发板进行通信。
+   - 使用 `OneNet_API.py` 调用 OneNet 平台的 API,支持设备管理和数据交互
+   - 使用 `pyboard.py` 与开发板进行通信,支持文件系统操作和命令执行
 
 3. **umqtt**:
-   - 使用 `simple.py` 实现 MQTT 客户端功能。
+   - 使用 `simple.py` 实现 MQTT 客户端功能,适用于资源受限的设备
 
 ## 测试