LwESP latest-develop documentation

Welcome to the documentation for version latest-develop.

LwESP is generic, platform independent, ESP-AT parser library to communicate with ESP8266 or ESP32 WiFi-based microcontrollers from Espressif systems using official AT Commands set running on ESP device. Its objective is to run on master system, while Espressif device runs official AT commands firmware developed and maintained by Espressif systems.

_images/logo.svg

Download library Getting started Open Github Donate

Features

  • Supports latest ESP32, ESP32-C2, ESP32-C3, ESP32-C6 & ESP8266 AT software from Espressif system

  • Platform independent and easy to port, written in C99

    • Library is developed under Win32 platform

    • Provided examples for ARM Cortex-M or Win32 platforms

  • Allows different configurations to optimize user requirements

  • Optimized for systems with operating systems (or RTOS)

    • Currently only OS mode is supported

    • 2 different threads to process user inputs and received data

      • Producer thread to collect user commands from application threads and to start command execution

      • Process thread to process received data from ESP device

  • Allows sequential API for connections in client and server mode

  • Includes several applications built on top of library

    • HTTP server with dynamic files (file system) support

    • MQTT client for MQTT connection

    • MQTT client Cayenne API for Cayenne MQTT server

  • Embeds other AT features, such as WPS

  • User friendly MIT license

Requirements

  • C compiler

  • ESP8266 or ESP32 device with running AT-Commands firmware

Contribute

Fresh contributions are always welcome. Simple instructions to proceed:

  1. Fork Github repository

  2. Respect C style & coding rules used by the library

  3. Create a pull request to develop branch with new features or bug fixes

Alternatively you may:

  1. Report a bug

  2. Ask for a feature request

License

MIT License

Copyright (c) 2024 Tilen MAJERLE

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.