Skip to content

Commit 9db00b9

Browse files
committed
updated readme
1 parent 77a71e2 commit 9db00b9

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

README.md

+22-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,31 @@
1-
# Somfy Remote Lib
1+
# Somfy Remote Lib [![Test](https://github.com/Legion2/Somfy_Remote_Lib/workflows/Test/badge.svg)](https://github.com/Legion2/Somfy_Remote_Lib/actions?query=event%3Apush+workflow%3Atest)
2+
23
Based on [Somfy Remote](https://github.com/Nickduino/Somfy_Remote) by Nickduino.
34

4-
An Arduino Library able to emulate a Somfy remote control on Arduino, ESP8266 and ESP32 devices.
5+
This project is an Arduino Library able to emulate a Somfy remote control on Arduino, ESP8266 and ESP32 devices.
6+
It provides out of the box support for multiple remotes and different storage solutions for the rolling codes.
7+
Because it is a Arduino Library it can easily included in existing projects or used standalone using one of its [included example sketches](examples/).
58

69
If you want to learn more about the Somfy RTS protocol, check out [Pushtack](https://pushstack.wordpress.com/somfy-rts-protocol/).
710

8-
## Requirements
11+
## Getting Started
12+
13+
This library was tested with ESP32 and the CC1101 transceiver module.
14+
It should also work on any Arduino and ESP8266 Board with any *433.42 Mhz* RF transmitter.
15+
I have not the time and resources to test them all, so please let me know (open an Issue) when you have any problem or have tested other hardware with this library.
16+
17+
### Hardware Requirements
918

1019
For this library to work you need an *433.42 Mhz* RF transmitter.
1120
The regular 433.92 MHz RF transmitter do not work, so watch out when buying a transmitter that you get a *433.42 Mhz* RF transmitter.
1221
An example for such an compatible transmitter is the CC1101 module, see the [CC1101](examples/CC1101/CC1101.ino) example.
22+
23+
### Installation
24+
25+
This library can be install using the Library-Manager.
26+
Open the Library-Manager in Arduino IDE via Tools->Manage Libraries...
27+
Search for "Somfy_Remote_Lib" and install the Somfy Remote Lib library.
28+
29+
### Usage
30+
31+
See the [SomfyRemote example](examples/SomfyRemote/SomfyRemote.ino).

0 commit comments

Comments
 (0)