An open API service indexing awesome lists of open source software.

https://github.com/zheng-bote/esp32_libs

(Arduino) libraries for ESP32 Microcontroller
https://github.com/zheng-bote/esp32_libs

arduino cpp11 esp32 libraries

Last synced: about 2 months ago
JSON representation

(Arduino) libraries for ESP32 Microcontroller

Awesome Lists containing this project

README

          





ESP32 libraries


(Arduino) libraries for ESP32




Explore the docs »




Report Bug
·
Request Feature


Table of Contents



  1. About The Project



  2. Getting Started


  3. Usage

  4. Roadmap

  5. Contributing

  6. License

  7. Contact

  8. Acknowledgments

## About The Project
### ESP32 libraries
(Arduino) libraries for ESP32 wihich maybe are usefull
* WiFi
* WiFi http client
* MQTT client (publish/subscribe)
* ESP32 system calls (eg. ESP32 deep sleep with intervall, get MAC address, ...)
* Lora
* SIM800 (eg. send/receive SMS)
* ...

## Getting Started

install the Arduino IDE or use the web online version

**Note that master is generally a work in progress, and you probably want to use a tagged release version.**

### Prerequisites

* PC or Laptop with Windows, MacOS or Linux *_^
* ESP32 connected
* install the Arduino IDE
`https://www.arduino.cc/en/software`
* or use Arduino IDE online
`https://create.arduino.cc/editor`
* some libraries needs additional Arduino libraries (e.g. PubSubClient. See header comments)

(back to top)

### Installation

1. Clone the repo

**Note that master is generally a work in progress, and you probably want to use a tagged release version.**
```sh
git clone https://github.com/Zheng-Bote/ESP32_libs.git
```
2. copy the libs manually to /usr/local/include/ESP32/
(CMake / Makefile coming soon...)
```sh
sudo mkdir -d /usr/local/include/ESP32 && cp ./* /usr/local/include/ESP32/.
```
3. add required lib to your project
`#include "ESP32/the_lib.h"`

4. load firmware on ESP32

(back to top)

### Usage

see Wiki for details of the libraries

(back to top)

## Roadmap

- [x] list all libs with short description (see Wiki)
- [x] optimize header files with docu (mostly done, except older libs)
- [x] optimize mem usage (stack/heap)
- [ ] create CMake/Makefile for installation/updates
- [ ] ???

Maybe a Kanban board will be established (soon)

(back to top)

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

(back to top)

## License

Distributed under the MIT License. See `LICENSE.txt` for more information.

(back to top)

## Contact

ZHENG Robert Zhèng Bó Tè 郑 伯特

Project Link: [https://github.com/Zheng-Bote/ESP32_libs](https://github.com/Zheng-Bote/ESP32_libs)

(back to top)