Skip to content

Latest commit

 

History

History
27 lines (20 loc) · 2.27 KB

README.md

File metadata and controls

27 lines (20 loc) · 2.27 KB
Raw

og3 library

The og3 library is designed to help write applications for ESP microprocessors using the Arduino environment. It was written especially to support MQTT applications and interface with Home Assistant. This library is designed to be used with the Platformio development environment.

Note that this code is a work in progress and should be considered alpha or beta quality. It is suitable for DIY projects at this point. The APIs of this code are still slowly evolving over time.

  • Modules and the ModuleSystem. This system helps to break an application into a set of reusable modules which can work together.
  • Tasks. This is a utility for running scheduled tasks.
  • Logging. This is a very simple text-logging system for monitoring and debugging.
  • Variables. A Variable is a named container for a value, used with web forms, MQTT, and flash storage.
  • Application framework. An App is a package of modules, a system for running scheduled jobs, logging, and other utilities to help writing a firmware application.

Example programs:

  • Blink is a simple application with a module that can blink an LED on and off.
  • Wifi-app is like Blink, but adds a configurable Wifi connection and flash storage.
  • Web-app adds to Wifi-app a web interface for configuring the Wifi options.
  • HA-app is a simple application using MQTT, for talking to Home Assistant. It builds on Web-app.

Projects which use og3

  • Plant133 is a device that can monitor and water up to 4 plants at a time.
  • Dough133 is a temperature-controlled container for proofing and fermenting soughdough.
  • Garage133 is a DIY device for garage door automation.
  • Room133 is a device for room monitoring, for use with Home Assistant
    • Boiler is software for the Room133 board, which monitors the water level of a boiler.

chl33