From fb32c0c44d05c600c5539c5a8e6163bad505aaf9 Mon Sep 17 00:00:00 2001 From: Fabiano Riccardi Date: Fri, 21 Dec 2018 09:25:02 +0100 Subject: [PATCH] Minor fix to be compliant with Arduino library specifications Signed-off-by: Fabiano Riccardi --- library.properties | 4 ++-- readme.md | 7 +++++-- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/library.properties b/library.properties index 3b06db1..1571de6 100644 --- a/library.properties +++ b/library.properties @@ -1,9 +1,9 @@ -name=Dimmable Light for ESP8266/ESP32 +name=Dimmable Light for ESP version=1.1.0 author=Fabiano Riccardi maintainer=Fabiano Riccardi sentence=This library allows you to command electrical appliances through dimmer (also known as thyristor) -paragraph=The code about thyristor is heavily reusable for other AC loads, although this library is designed to support the traditional incandescence light bulbs, this code is easy reusable to command other appliances like electrical heaters +paragraph=The code about thyristor is heavily reusable for other AC loads, although this library is designed to support the traditional incandescence light bulbs, this code is easy reusable to command other appliances like electrical heaters. Actually it works only for ESP32 and ESP8266. category=Device Control url= architectures=esp8266,esp32 diff --git a/readme.md b/readme.md index 81f5064..7f095d6 100644 --- a/readme.md +++ b/readme.md @@ -1,10 +1,13 @@ -# Dimmable Light for ESP8266/ESP32 -A simple library to manage up to 8 thyristors (also knows as dimmer) on ESP8266/ESP32 in Arduino environment. +# Dimmable Light for ESP +A simple library to manage up to 8 thyristors (also knows as dimmer) on ESP8266 and ESP32 in Arduino environment. ## Motivations This library was born from the curiosity to learn how hardware timer works on esp8266 (precision and flexibility) and to control the old fashioned incandescence lights. I can confirm the timer is pretty poor if compared with other SoC, and a single timer (there is also Timer 0, but it is mandatory for WiFi operations) is not enough for some applications (i.e. play a tone with buzzer and simultaneously control dimmers). ## Installation +You can install Dimmable Light for ESP through Arduino Library Manager or cloning this repository. + +### Requirements You need only Arduino IDE and ESP8266 and/or ESP32 Board Package. If you want to compile the 5th example, you also need [ArduinoSerialCommand](https://github.com/kroimon/Arduino-SerialCommand) library. ## Usage