├── .gitignore ├── .gitmodules ├── LICENSE ├── Makefile ├── README.md ├── doc └── img │ └── preview.jpg └── main ├── app_main.c ├── component.mk └── include ├── config.h ├── debug.h └── onenet.h /.gitignore: -------------------------------------------------------------------------------- 1 | build 2 | *.si4project 3 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "components/espmqtt"] 2 | path = components/espmqtt 3 | url = https://github.com/tidyjiang8/espmqtt.git 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # 2 | # This is a project Makefile. It is assumed the directory this Makefile resides in is a 3 | # project subdirectory. 4 | # 5 | VERBOSE = 1 6 | PROJECT_NAME := esp32-onenet 7 | include $(IDF_PATH)/make/project.mk 8 | 9 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # esp32-onenet 2 | ESP32 通过 MQTT 连接到中国移动物联网云平台 OneNET 3 | 4 | 应用展示 - [https://open.iot.10086.cn/appview/p/1c77653399eb0cdde908b7e1faf1c1aa](https://open.iot.10086.cn/appview/p/1c77653399eb0cdde908b7e1faf1c1aa) 5 | 6 | ![](doc/img/preview.jpg) 7 | 8 | ## 子模块 9 | 10 | [ESP32 MQTT 组件库](https://github.com/tidyjiang8/espmqtt) 11 | 12 | ## 功能列表 13 | 14 | - [x] 连接鉴权 15 | - [x] 心跳包 16 | - [x] 数据上报(QoS0, QoS1, QoS2) 17 | - [x] 创建 Topic 18 | - [x] 订阅/取消订阅 19 | - [ ] 平台命令处理(QoS0) 20 | - [ ] 离线 Topic 21 | - [ ] 数据点订阅 22 | - [ ] 动态接入设备 23 | - [ ] 批量接入设备 24 | 25 | ## 快速体验 26 | 27 | 如果你已对oneNET有一定的了解,且能够使用 ESP-IDF 编译 hello-world,则可以按照下面的步骤快速体验。 28 | 29 | - 登录oneNET,依次创建产品,添加设备,设置鉴权信息。记录下产品ID、设备ID和鉴权信息。 30 | - 创建一个数据流,并记录下该数据流的名称。 31 | - 修改本仓库源代码目录下的`config.h`文件,主要包括: 32 | - `WIFI_SSID` - esp32需要连接到的AP的ssid。 33 | - `WIFI_PASS` - esp32需要连接到的AP的密码。 34 | - `ONENET_DEVICE_ID` - 云平台所创建设备的设备ID。 35 | - `ONENET_PROJECT_ID` - 云平台所创建的产品的产品ID。 36 | - `ONENET_AUTH_INFO` - 自己设置的鉴权信息。 37 | - `ONENET_DATA_STREAM` - 自己所创建的数据流的名称。 38 | - 编译工程: 39 | - 指定 ESP-IDF 所在路径:`export IDF_PATH=/你的/ESP/IDF/所在的/路径`。 40 | - 编译&烧写:`make & make flash` 41 | 42 | -------------------------------------------------------------------------------- /doc/img/preview.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/chunhuajiang/esp32-onenet/869769a97347395fc4463a8ef452747506fbaf32/doc/img/preview.jpg -------------------------------------------------------------------------------- /main/app_main.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | 6 | #include "soc/rtc_cntl_reg.h" 7 | 8 | #include "esp_wifi.h" 9 | #include "esp_system.h" 10 | #include "nvs_flash.h" 11 | #include "esp_event_loop.h" 12 | 13 | 14 | #include "freertos/FreeRTOS.h" 15 | #include "freertos/task.h" 16 | #include "freertos/semphr.h" 17 | #include "freertos/queue.h" 18 | 19 | #include "lwip/sockets.h" 20 | #include "lwip/dns.h" 21 | #include "lwip/netdb.h" 22 | 23 | #include "config.h" 24 | #include "debug.h" 25 | 26 | #include "mqtt.h" 27 | #include "os.h" 28 | #include "onenet.h" 29 | 30 | static bool onenet_initialised = false; 31 | static TaskHandle_t xOneNetTask = NULL; 32 | 33 | void onenet_task(void *param) 34 | { 35 | mqtt_client* client = (mqtt_client *)param; 36 | uint32_t val; 37 | 38 | while(1) { 39 | /** 40 | * Replace this *val* with real captured value by your sensor, 41 | * Here, we just use a rand number which ranges form 15 to 35. 42 | */ 43 | val = os_random() % 20 + 15; 44 | 45 | char buf[128]; 46 | memset(buf, 0, sizeof(buf)); 47 | sprintf(&buf[3], "{\"%s\":%d}", ONENET_DATA_STREAM, val); 48 | uint16_t len = strlen(&buf[3]); 49 | buf[0] = data_type_simple_json_without_time; 50 | buf[1] = len >> 8; 51 | buf[2] = len & 0xFF; 52 | mqtt_publish(client, "$dp", buf, len + 3, 0, 0); 53 | 54 | for (int i = 0 ; i < len + 3; i ++){ 55 | printf("0x%02x ", buf[i]); 56 | } 57 | printf(", len:%d\n", len+3); 58 | 59 | vTaskDelay((unsigned long long)ONENET_PUB_INTERVAL* 1000 / portTICK_RATE_MS); 60 | } 61 | } 62 | 63 | 64 | void onenet_start(mqtt_client *client) 65 | { 66 | if(!onenet_initialised) { 67 | xTaskCreate(&onenet_task, "onenet_task", 2048, client, CONFIG_MQTT_PRIORITY + 1, &xOneNetTask); 68 | onenet_initialised = true; 69 | } 70 | } 71 | 72 | void onenet_stop(mqtt_client *client) 73 | { 74 | if(onenet_initialised) { 75 | if(xOneNetTask) { 76 | vTaskDelete(xOneNetTask); 77 | } 78 | onenet_initialised = false; 79 | } 80 | } 81 | 82 | void connected_cb(void *self, void *params) 83 | { 84 | mqtt_client *client = (mqtt_client *)self; 85 | //mqtt_subscribe(client, "/test", 0); 86 | //mqtt_publish(client, "/test", "howdy!", 6, 0, 0); 87 | onenet_start(client); 88 | } 89 | void disconnected_cb(void *self, void *params) 90 | { 91 | mqtt_client *client = (mqtt_client *)self; 92 | onenet_stop(client); 93 | } 94 | void reconnect_cb(void *self, void *params) 95 | { 96 | mqtt_client *client = (mqtt_client *)self; 97 | onenet_start(client); 98 | } 99 | void subscribe_cb(void *self, void *params) 100 | { 101 | INFO("[APP] Subscribe ok, test publish msg\n"); 102 | mqtt_client *client = (mqtt_client *)self; 103 | //mqtt_publish(client, "/test", "abcde", 5, 0, 0); 104 | } 105 | 106 | void publish_cb(void *self, void *params) 107 | { 108 | 109 | } 110 | void data_cb(void *self, void *params) 111 | { 112 | (void)self; 113 | mqtt_event_data_t *event_data = (mqtt_event_data_t *)params; 114 | 115 | if (event_data->data_offset == 0) { 116 | 117 | char *topic = malloc(event_data->topic_length + 1); 118 | memcpy(topic, event_data->topic, event_data->topic_length); 119 | topic[event_data->topic_length] = 0; 120 | INFO("[APP] Publish topic: %s\n", topic); 121 | free(topic); 122 | } 123 | 124 | // char *data = malloc(event_data->data_length + 1); 125 | // memcpy(data, event_data->data, event_data->data_length); 126 | // data[event_data->data_length] = 0; 127 | INFO("[APP] Publish data[%d/%d bytes]\n", 128 | event_data->data_length + event_data->data_offset, 129 | event_data->data_total_length); 130 | // data); 131 | 132 | // free(data); 133 | 134 | } 135 | 136 | mqtt_settings settings = { 137 | .host = ONENET_HOST, 138 | .port = ONENET_PORT, 139 | .client_id = ONENET_DEVICE_ID, 140 | .username = ONENET_PROJECT_ID, 141 | .password = ONENET_AUTH_INFO, 142 | .clean_session = 0, 143 | .keepalive = 120, 144 | .lwt_topic = "/lwt", 145 | .lwt_msg = "offline", 146 | .lwt_qos = 0, 147 | .lwt_retain = 0, 148 | .connected_cb = connected_cb, 149 | .disconnected_cb = disconnected_cb, 150 | .reconnect_cb = reconnect_cb, 151 | .subscribe_cb = subscribe_cb, 152 | .publish_cb = publish_cb, 153 | .data_cb = data_cb 154 | }; 155 | 156 | static esp_err_t wifi_event_handler(void *ctx, system_event_t *event) 157 | { 158 | 159 | switch(event->event_id) { 160 | case SYSTEM_EVENT_STA_START: 161 | ESP_ERROR_CHECK(esp_wifi_connect()); 162 | break; 163 | 164 | case SYSTEM_EVENT_STA_GOT_IP: 165 | 166 | mqtt_start(&settings); 167 | // Notice that, all callback will called in mqtt_task 168 | // All function publish, subscribe 169 | break; 170 | case SYSTEM_EVENT_STA_DISCONNECTED: 171 | /* This is a workaround as ESP32 WiFi libs don't currently 172 | auto-reassociate. */ 173 | 174 | mqtt_stop(); 175 | ESP_ERROR_CHECK(esp_wifi_connect()); 176 | break; 177 | default: 178 | break; 179 | } 180 | return ESP_OK; 181 | 182 | 183 | } 184 | 185 | void wifi_conn_init(void) 186 | { 187 | INFO("[APP] Start, connect to Wifi network: %s ..\n", WIFI_SSID); 188 | 189 | tcpip_adapter_init(); 190 | 191 | ESP_ERROR_CHECK( esp_event_loop_init(wifi_event_handler, NULL) ); 192 | 193 | wifi_init_config_t icfg = WIFI_INIT_CONFIG_DEFAULT(); 194 | ESP_ERROR_CHECK( esp_wifi_init(&icfg) ); 195 | ESP_ERROR_CHECK( esp_wifi_set_storage(WIFI_STORAGE_RAM) ); 196 | 197 | wifi_config_t wifi_config = { 198 | .sta = { 199 | .ssid = WIFI_SSID, 200 | .password = WIFI_PASS 201 | }, 202 | }; 203 | 204 | ESP_ERROR_CHECK( esp_wifi_set_mode(WIFI_MODE_STA)); 205 | ESP_ERROR_CHECK( esp_wifi_set_config(WIFI_IF_STA, &wifi_config)); 206 | ESP_ERROR_CHECK( esp_wifi_start()); 207 | } 208 | 209 | void app_main() 210 | { 211 | INFO("[APP] Startup..\n"); 212 | INFO("[APP] Free memory: %d bytes\n", esp_get_free_heap_size()); 213 | INFO("[APP] Build time: %s\n", BUID_TIME); 214 | 215 | #ifdef CPU_FREQ_160MHZ 216 | INFO("[APP] Setup CPU run as 160MHz\n"); 217 | SET_PERI_REG_BITS(RTC_CLK_CONF, RTC_CNTL_SOC_CLK_SEL, 0x1, RTC_CNTL_SOC_CLK_SEL_S); 218 | WRITE_PERI_REG(CPU_PER_CONF_REG, 0x01); 219 | INFO("[APP] Setup CPU run as 160MHz - Done\n"); 220 | #endif 221 | 222 | nvs_flash_init(); 223 | wifi_conn_init(); 224 | } 225 | -------------------------------------------------------------------------------- /main/component.mk: -------------------------------------------------------------------------------- 1 | # 2 | # Main Makefile. This is basically the same as a component makefile. 3 | # 4 | # This Makefile should, at the very least, just include $(SDK_PATH)/make/component.mk. By default, 5 | # this will take the sources in the src/ directory, compile them and link them into 6 | # lib(subdirectory_name).a in the build directory. This behaviour is entirely configurable, 7 | # please read the SDK documents if you need to do this. 8 | # 9 | THISDIR:=$(dir $(abspath $(lastword $(MAKEFILE_LIST)))) 10 | DATETIME := $(shell date "+%Y-%b-%d_%H:%M:%S_%Z") 11 | 12 | COMPONENT_ADD_INCLUDEDIRS := include 13 | CFLAGS += -DBUID_TIME=\"$(DATETIME)\" -Wno-error=format= 14 | 15 | ifneq ("$(wildcard $(THISDIR)/include/user_config.local.h)","") 16 | CFLAGS += -DLOCAL_CONFIG_AVAILABLE 17 | endif 18 | -------------------------------------------------------------------------------- /main/include/config.h: -------------------------------------------------------------------------------- 1 | #ifndef __ONENET_CONFIG_H__ 2 | #define __ONENET_CONFIG_H__ 3 | 4 | //#define CPU_FREQ_160MHZ 5 | 6 | /* Here needs to be changed according to your envirnoment. */ 7 | #define WIFI_SSID "ABC" 8 | #define WIFI_PASS "ABC8881033" 9 | 10 | #define ONENET_HOST "183.230.40.39" 11 | #define ONENET_PORT (6002) 12 | 13 | /* Here needs to be changed accoding to your oneONET configure. */ 14 | #define ONENET_DEVICE_ID "5619109" // mqtt client id 15 | #define ONENET_PROJECT_ID "85574" // mqtt username 16 | #define ONENET_AUTH_INFO "hellok64f" // mqtt password 17 | 18 | /* Here needs to be changed accoding to your oneONET configure. */ 19 | #define ONENET_DATA_STREAM "temperature" 20 | 21 | #define ONENET_PUB_INTERVAL (60) // unit: s 22 | 23 | #endif 24 | 25 | -------------------------------------------------------------------------------- /main/include/debug.h: -------------------------------------------------------------------------------- 1 | #ifndef _DEBUG_H_ 2 | #define _DEBUG_H_ 3 | #include 4 | #define INFO(...) printf(__VA_ARGS__) 5 | #endif 6 | -------------------------------------------------------------------------------- /main/include/onenet.h: -------------------------------------------------------------------------------- 1 | #ifndef __ONENET_H__ 2 | #define __ONENET_H__ 3 | 4 | /* Supported format when publish data point to oneNET */ 5 | enum mqtt_save_data_type { 6 | data_type_full_json = 0x01, 7 | data_type_bin = 0x02, 8 | data_type_simple_json_without_time = 0x03, 9 | data_type_simple_json_with_time = 0x04, 10 | data_type_string = 0x05, 11 | data_type_string_with_time = 0x06, 12 | data_type_float = 0x07 13 | }; 14 | 15 | 16 | #endif /* __ONENET_H__ */ 17 | --------------------------------------------------------------------------------