Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 1.41 KB

README.md

File metadata and controls

47 lines (29 loc) · 1.41 KB

uServer

Template for rapid IoT development on ESP32. Build webpages fast and exchange data quickly!

Features

See Features for full list of features and examples.

Hardware Required

  • This project is only tested on an ESP32 (China)

Software Required

Installation

See Quickstart to quickly get up and running.

REST API

uServer creates an API endpoint for I/O, variables, MQTT, and will be able to read/write configurations files for persistent storage. See API for examples. Endpoints:

  • /io - Read input statuses or change output states
  • /variables - Change a user variable
  • /mqtt - Connect, publish, and subscribe
  • /files - List files in a directory
  • /file - Read contents of .json configuration file
  • /cloud - Read from cloud API's!

FastAPI Testing

Repo contains a Docker image with a test API endpoint for you on port 8000:

docker-compose up -d --build

To-do List