Skip to content

Latest commit

 

History

History
80 lines (58 loc) · 2.96 KB

README.md

File metadata and controls

80 lines (58 loc) · 2.96 KB
Raw

DREAM

logo

CircleCI GitHub GitHub repo size

DREAM (Dynamic Real-time Embedded Arduino Modules) is a collection of useful modules for ESP8266/ESP32 projects on the Arduino Framework.

Installation

For PlatformIO:

Just add following line to platformio.ini file of your project:

lib_deps = 
	https://github.com/DreamerDeLy/dream.git

Also you can select specific version, using tag:

lib_deps = 
	https://github.com/DreamerDeLy/dream.git#v0.9.0

For ArduinoIDE:

  1. Download source code as zip (green button "Code" > Download ZIP) or go to the Releases tab on this page and download one of the versions.
  2. Open the Arduino IDE and click to the "Sketch" menu and then Include Library > Add ZIP library.
  3. Select downloaded ZIP file.

Modules

  • Containers
    • Value - Container for any single value that stores the data type, units of measurement, the sensor from which the data was obtained, and a name.
    • Data - Container for a set of Value objects, which has tools for their search and processing, as well as the function of averaging data in an array of Data objects.
    • Units Convert - Tool for converting values from one units to other.
  • Debug
    • CLI - Library for the developer's CLI, into which any command can be integrated.
    • Serial Logging - Macro-based logging library.
  • NET
  • Realtime
    • Simple Timer - Simple software timer.
    • Simple Stopwatch - A simple object for measuring the elapsed time between the execution of some functions.

Build & testing

This project created with PlatformIO.

Use this commands to build examples:

pio ci --board=esp32dev examples/CLI/ --lib src/
pio ci --board=esp32dev examples/SerialLogging/ --lib src/
pio ci --board=esp32dev examples/UnitsConversion/ --lib src/
pio ci --board=esp32dev examples/Values/ --lib src/
pio ci --board=esp32dev examples/Timer_Basic/ --lib src/
pio ci --board=esp32dev examples/Timer_Callbacks/ --lib src/
pio ci --board=esp32dev examples/HTTPRequest/ --lib src/
pio ci --board=esp32dev examples/HTTPResponse/ --lib src/

Use this command to run tests (you have to have connected ESP32 to your computer):

pio test

License

Copyright © 2019-2023 Dmytro Obukhov (DeLy Dreamer)

License: https://www.gnu.org/licenses/gpl-3.0.html