Skip to content

Commit

Permalink
Minor fix to be compliant with Arduino library specifications
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 21, 2018
1 parent 707d0b8 commit fb32c0c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
4 changes: 2 additions & 2 deletions library.properties
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>
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
7 changes: 5 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit fb32c0c

Please sign in to comment.