Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jessebraham/esp-iot-quickstart
A project template for developing IoT projects using the Espressif Systems ESP32
https://github.com/jessebraham/esp-iot-quickstart
c esp-idf esp32 espressif iot mqtt websocket
Last synced: 27 days ago
JSON representation
A project template for developing IoT projects using the Espressif Systems ESP32
- Host: GitHub
- URL: https://github.com/jessebraham/esp-iot-quickstart
- Owner: jessebraham
- License: mit
- Created: 2019-01-01T22:11:42.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-04-21T00:32:00.000Z (over 5 years ago)
- Last Synced: 2024-04-16T20:24:09.247Z (7 months ago)
- Topics: c, esp-idf, esp32, espressif, iot, mqtt, websocket
- Language: C
- Homepage:
- Size: 21.5 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# esp-iot-quickstart
A project template for developing IoT projects using the [Espressif Systems ESP32](https://www.espressif.com/en/products/hardware/esp32/overview). Contains the boilerplate required to connect to a wireless network and MQTT broker. Intended to serve as a starting point, and to help avoid repeating myself.
# Usage
To develop a project from this template, begin by checking out the repository, making sure to use the `--recursive` flag to ensure we check out the [espressif/esp-mqtt](https://github.com/espressif/esp-mqtt) component as well:
```bash
$ git clone --recursive https://github.com/jessebraham/esp-iot-quickstart.git
$ cd esp-iot-quickstart/
```We can use the `make` command to perform a number of helpful tasks. To configure the wireless network and MQTT broker settings, run `make menuconfig` from the project root. From here you will be greeted with a [curses](https://en.wikipedia.org/wiki/Curses_%28programming_library%29) interface, from which you can select the `esp-iot-quickstart config` item.
Within `main/main.c` lies a function named `mqtt_event_handler`; there are a number of comments within it instructing what to add for your application.
Once you're ready to flash the device, run:
```bash
$ make flash
$ make monitor
```