Skip to content

Latest commit

 

History

History
105 lines (77 loc) · 3.44 KB

index.rst

File metadata and controls

105 lines (77 loc) · 3.44 KB

LwESP |version| documentation

Welcome to the documentation for version |version|.

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.

.. rst-class:: center

.. rst-class:: index_links

        :ref:`download_library` :ref:`getting_started` `Open Github <https://github.com/MaJerle/lwesp>`_ `Donate <https://paypal.me/tilz0R>`_

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

.. literalinclude:: ../LICENSE

Table of contents

.. toctree::
    :maxdepth: 2
    :caption: Contents

    self
    get-started/index
    user-manual/index
    api-reference/index
    examples/index
    firmware-update/index
    changelog/index
    authors/index


.. toctree::
    :maxdepth: 2
    :caption: Other projects
    :hidden:

    LwBTN - Button manager <https://github.com/MaJerle/lwbtn>
    LwDTC - DateTimeCron <https://github.com/MaJerle/lwdtc>
    LwESP - ESP-AT library <https://github.com/MaJerle/lwesp>
    LwEVT - Event manager <https://github.com/MaJerle/lwevt>
    LwGPS - GPS NMEA parser <https://github.com/MaJerle/lwgps>
    LwCELL - Cellular modem host AT library <https://github.com/MaJerle/lwcell>
    LwJSON - JSON parser <https://github.com/MaJerle/lwjson>
    LwMEM - Memory manager <https://github.com/MaJerle/lwmem>
    LwOW - OneWire with UART <https://github.com/MaJerle/lwow>
    LwPKT - Packet protocol <https://github.com/MaJerle/lwpkt>
    LwPRINTF - Printf <https://github.com/MaJerle/lwprintf>
    LwRB - Ring buffer <https://github.com/MaJerle/lwrb>
    LwSHELL - Shell <https://github.com/MaJerle/lwshell>
    LwUTIL - Utility functions <https://github.com/MaJerle/lwutil>
    LwWDG - RTOS task watchdog <https://github.com/MaJerle/lwwdg>