Skip to content

Commit

Permalink
Minor docs fix, bump version
Browse files Browse the repository at this point in the history
Signed-off-by: Fabiano Riccardi <[email protected]>
  • Loading branch information
Fabiano Riccardi committed Dec 19, 2018
1 parent b97cc61 commit 707d0b8
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion examples/5_8_lights_effects/effect.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ void doRangeLimit(void){
*/
void doNearValues(void){
const float period = 4;
static int briLevels1[]={70,70};
static int briLevels1[]={73,70};
static int briLevels2[]={71,71};
static int briLevels3[]={72,73};
static uint8_t brightnessStep=0;
Expand Down
8 changes: 4 additions & 4 deletions library.properties
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name=Dimmable Light for ESP8266
version=1.0.0
name=Dimmable Light for ESP8266/ESP32
version=1.1.0
author=Fabiano Riccardi
maintainer=Fabiano Riccardi <[email protected]>
sentence=This library allows you to command electrical appliances through dimmer (also known as thyristor)
paragraph=The code about thyristor is reusable, 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
category=Device Control
url=
architectures=esp8266
architectures=esp8266,esp32
6 changes: 3 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Dimmable Light for ESP8266
A simple library to manage up to 8 thyristors (also knows as dimmer) on ESP8266 in Arduino environment.
# Dimmable Light for ESP8266/ESP32
A simple library to manage up to 8 thyristors (also knows as dimmer) on ESP8266/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 need only Arduino IDE and ESP8266 Board Package. If you want to compile the 5th example, you also need [ArduinoSerialCommand](https://github.com/kroimon/Arduino-SerialCommand) library.
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
The main APIs are accessible through DimmableLight class. First, you must instantiate one or more DimmableLight, specifying the corresponding pin. Second, you must set Zero Cross pin, calling the static method *setSyncPin(..)*. Finally you must call static method *begin()*: this activated interrupt on Zero Cross pin, hence activating thryristor whenever required. To set the delivered power level, call method *setBrightness(..)*: it accepts value from 0 to 255, fitting into 8 bit.
Expand Down

0 comments on commit 707d0b8

Please sign in to comment.