├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── lib └── readme.txt ├── platformio.ini └── src ├── main.cpp ├── resin.cpp └── resin.h /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled Object files 2 | *.slo 3 | *.lo 4 | *.o 5 | *.obj 6 | 7 | # Precompiled Headers 8 | *.gch 9 | *.pch 10 | 11 | # Compiled Dynamic libraries 12 | *.so 13 | *.dylib 14 | *.dll 15 | 16 | # Fortran module files 17 | *.mod 18 | *.smod 19 | 20 | # Compiled Static libraries 21 | *.lai 22 | *.la 23 | *.a 24 | *.lib 25 | 26 | # Executables 27 | *.exe 28 | *.out 29 | *.app 30 | 31 | # Platform.io 32 | .pioenvs/ 33 | .piolibdeps/ 34 | .python-version 35 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # esp8266 base image, repo here: https://github.com/resin-io-library/dependent-base-images/tree/master/esp8266 2 | # See more about resin base images here: http://docs.resin.io/runtime/resin-base-images/ 3 | FROM resin/esp8266 AS buildstep 4 | 5 | # Set the working directory 6 | WORKDIR /usr/src/app 7 | 8 | # Set the board 9 | ENV BOARD esp32dev 10 | 11 | # Get the staging version 12 | RUN platformio platform install \ 13 | https://github.com/platformio/platform-espressif32.git#feature/stage 14 | 15 | # Copy config files to the working directory 16 | COPY platformio.ini ./ 17 | 18 | # Copy source files to the working directory 19 | COPY src/ ./src 20 | 21 | # Copy library files to the working directory 22 | COPY lib/ ./lib 23 | 24 | # Compile the firmware 25 | RUN platformio run --environment $BOARD && \ 26 | mv .pioenvs/$BOARD/firmware.bin /assets/ 27 | 28 | # Start with a minimal runtime container 29 | FROM alpine 30 | 31 | # Copy the compiled firmware into the empty runtime container 32 | COPY --from=buildstep /assets/ /assets/ 33 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ESP32 2 | edge-node-manager compatible firmware for the ESP32 3 | 4 | ### Getting started 5 | - Ensure you have [PlatformIO Core](http://docs.platformio.org/en/latest/installation.html) installed on your local machine 6 | - Sign up on [resin.io](https://dashboard.resin.io/signup) 7 | - Work through the [getting started guide](https://docs.resin.io/raspberrypi3/nodejs/getting-started/) 8 | - Create a dependent application called `esp32` 9 | - Set these variables in the `Fleet Configuration` dependent application side tab 10 | - `RESIN_SUPERVISOR_DELTA=1` 11 | - `RESIN_HOST_TYPE=esp32` 12 | - Clone this repository to your local workspace 13 | - Add the dependent application `resin remote` to your local workspace 14 | - Retrieve the dependent application ID from the Resin dashboard, for example: If your dependent application URL is 15 | `https://dashboard.staging.io/apps/13829/devices` the ID is `13829` 16 | - Change [line 4](https://github.com/resin-io-projects/esp32/blob/master/src/main.cpp#L4) in `src/main.cpp` `String applicationUUID = "1234567890";` to point to your dependent application ID e.g. `String applicationUUID = "13829";` 17 | - Connect the ESP32 to your computer using a USB cable 18 | - Run `platformio run --environment esp32dev --target upload` to compile the initial firmware and flash the ESP32 (replace `esp32dev` with a different board ID from the link below if you are not using the `esp32dev`) 19 | - Push code to resin as normal :) 20 | 21 | ### Note 22 | You will need to ensure your gateway device has a spare WiFi interface 23 | 24 | ### Supported ESP32 boards 25 | The supported boards can be found on the [platform.io](http://docs.platformio.org/en/latest/platforms/espressif32.html#over-the-air-ota-update) website, if you are not using the `esp32dev` you will need to change [line 9](https://github.com/resin-io-projects/esp32/blob/master/Dockerfile#L9) in the `Dockerfile` to the ID of the board you are using 26 | -------------------------------------------------------------------------------- /lib/readme.txt: -------------------------------------------------------------------------------- 1 | 2 | This directory is intended for the project specific (private) libraries. 3 | PlatformIO will compile them to static libraries and link to executable file. 4 | 5 | The source code of each library should be placed in separate directory, like 6 | "lib/private_lib/[here are source files]". 7 | 8 | For example, see how can be organized `Foo` and `Bar` libraries: 9 | 10 | |--lib 11 | | |--Bar 12 | | | |--docs 13 | | | |--examples 14 | | | |--src 15 | | | |- Bar.c 16 | | | |- Bar.h 17 | | |--Foo 18 | | | |- Foo.c 19 | | | |- Foo.h 20 | | |- readme.txt --> THIS FILE 21 | |- platformio.ini 22 | |--src 23 | |- main.c 24 | 25 | Then in `src/main.c` you should use: 26 | 27 | #include 28 | #include 29 | 30 | // rest H/C/CPP code 31 | 32 | PlatformIO will find your libraries automatically, configure preprocessor's 33 | include paths and build them. 34 | 35 | More information about PlatformIO Library Dependency Finder 36 | - http://docs.platformio.org/page/librarymanager/ldf.html 37 | -------------------------------------------------------------------------------- /platformio.ini: -------------------------------------------------------------------------------- 1 | ; PlatformIO Project Configuration File 2 | ; 3 | ; Build options: build flags, source filter 4 | ; Upload options: custom upload port, speed and extra flags 5 | ; Library options: dependencies, extra library storages 6 | ; Advanced options: extra scripting 7 | ; 8 | ; Please visit documentation for the other options and examples 9 | ; http://docs.platformio.org/page/projectconf.html 10 | 11 | [env:featheresp32] 12 | platform = espressif32_stage 13 | board = featheresp32 14 | framework = arduino 15 | 16 | [env:node32s] 17 | platform = espressif32_stage 18 | board = node32s 19 | framework = arduino 20 | 21 | [env:espea32] 22 | platform = espressif32_stage 23 | board = espea32 24 | framework = arduino 25 | 26 | [env:firebeetle32] 27 | platform = espressif32_stage 28 | board = firebeetle32 29 | framework = arduino 30 | 31 | [env:esp32doit-devkit-v1] 32 | platform = espressif32_stage 33 | board = esp32doit-devkit-v1 34 | framework = arduino 35 | 36 | [env:esp32vn-iot-uno] 37 | platform = espressif32_stage 38 | board = esp32vn-iot-uno 39 | framework = arduino 40 | 41 | [env:esp320] 42 | platform = espressif32_stage 43 | board = esp320 44 | framework = arduino 45 | 46 | [env:esp32dev] 47 | platform = espressif32_stage_stage 48 | board = esp32dev 49 | framework = arduino 50 | 51 | [env:hornbill32dev] 52 | platform = espressif32_stage 53 | board = hornbill32dev 54 | framework = arduino 55 | 56 | [env:hornbill32minima] 57 | platform = espressif32_stage 58 | board = hornbill32minima 59 | framework = arduino 60 | 61 | [env:intorobot] 62 | platform = espressif32_stage 63 | board = intorobot 64 | framework = arduino 65 | 66 | [env:nano32] 67 | platform = espressif32_stage 68 | board = nano32 69 | framework = arduino 70 | 71 | [env:nodemcu-32s] 72 | platform = espressif32_stage 73 | board = nodemcu-32s 74 | framework = arduino 75 | 76 | [env:quantum] 77 | platform = espressif32_stage 78 | board = quantum 79 | framework = arduino 80 | 81 | [env:onehorse32dev] 82 | platform = espressif32_stage 83 | board = onehorse32dev 84 | framework = arduino 85 | 86 | [env:esp32thing] 87 | platform = espressif32_stage 88 | board = esp32thing 89 | framework = arduino 90 | 91 | [env:lolin32] 92 | platform = espressif32_stage 93 | board = lolin32 94 | framework = arduino 95 | 96 | [env:widora-air] 97 | platform = espressif32_stage 98 | board = widora-air 99 | framework = arduino 100 | -------------------------------------------------------------------------------- /src/main.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | Resin resin; 4 | String applicationUUID = "1234567890"; 5 | String ssid = "resin-hotspot"; 6 | String password = "resin-hotspot"; 7 | 8 | void setup(void) { 9 | resin.Setup(applicationUUID, ssid, password); 10 | } 11 | 12 | void loop(void) { 13 | resin.Loop(); 14 | delay(1000); 15 | } 16 | -------------------------------------------------------------------------------- /src/resin.cpp: -------------------------------------------------------------------------------- 1 | #include "resin.h" 2 | 3 | Resin::Resin(){} 4 | Resin::~Resin(){} 5 | 6 | void Resin::Setup(String applicationUUID, String ssid, String password, bool led) { 7 | _applicationUUID = applicationUUID; 8 | _ssid = ssid; 9 | _password = password; 10 | _led = led; 11 | 12 | if (_led) { 13 | pinMode(LED_BUILTIN, OUTPUT); 14 | digitalWrite(LED_BUILTIN, HIGH); 15 | } 16 | 17 | WiFi.setAutoConnect(true); 18 | WiFi.setAutoReconnect(true); 19 | WiFi.begin(_ssid.c_str(), _password.c_str()); 20 | while (WiFi.status() != WL_CONNECTED) { 21 | delay(100); 22 | } 23 | 24 | _httpServer = WiFiServer(80); 25 | _httpServer.begin(); 26 | 27 | ArduinoOTA.begin(); 28 | } 29 | 30 | void Resin::Loop() { 31 | Serve(); 32 | 33 | ArduinoOTA.handle(); 34 | 35 | if (_led) { 36 | if (WiFi.isConnected()) { 37 | digitalWrite(LED_BUILTIN, LOW); 38 | } else { 39 | digitalWrite(LED_BUILTIN, HIGH); 40 | } 41 | } 42 | } 43 | 44 | void Resin::Serve() { 45 | WiFiClient client = _httpServer.available(); 46 | if (!client) { 47 | return; 48 | } 49 | 50 | while(client.connected() && !client.available()){ 51 | delay(1); 52 | } 53 | 54 | String req = client.readStringUntil('\r'); 55 | int addr_start = req.indexOf(' '); 56 | int addr_end = req.indexOf(' ', addr_start + 1); 57 | if (addr_start == -1 || addr_end == -1) { 58 | return; 59 | } 60 | 61 | req = req.substring(addr_start + 1, addr_end); 62 | client.flush(); 63 | 64 | if (req == "/id") { 65 | client.print(_applicationUUID.c_str()); 66 | } 67 | } 68 | -------------------------------------------------------------------------------- /src/resin.h: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include 6 | 7 | #ifndef Resin_H 8 | #define Resin_H 9 | 10 | #define LED_BUILTIN 13 11 | 12 | class Resin { 13 | public: 14 | Resin(); 15 | ~Resin(); 16 | 17 | void Setup(String applicationUUID, String ssid, String password, bool led=true); 18 | void Loop(); 19 | 20 | private: 21 | void Serve(); 22 | 23 | WiFiServer _httpServer; 24 | 25 | String _applicationUUID; 26 | String _ssid; 27 | String _password; 28 | bool _led; 29 | }; 30 | 31 | #endif 32 | --------------------------------------------------------------------------------