Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Legion2 committed Nov 28, 2020
1 parent 77a71e2 commit 9db00b9
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,31 @@
# Somfy Remote Lib
# 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)

Based on [Somfy Remote](https://github.com/Nickduino/Somfy_Remote) by Nickduino.

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

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

## Requirements
## Getting Started

This library was tested with ESP32 and the CC1101 transceiver module.
It should also work on any Arduino and ESP8266 Board with any *433.42 Mhz* RF transmitter.
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.

### Hardware Requirements

For this library to work you need an *433.42 Mhz* RF transmitter.
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.
An example for such an compatible transmitter is the CC1101 module, see the [CC1101](examples/CC1101/CC1101.ino) example.

### Installation

This library can be install using the Library-Manager.
Open the Library-Manager in Arduino IDE via Tools->Manage Libraries...
Search for "Somfy_Remote_Lib" and install the Somfy Remote Lib library.

### Usage

See the [SomfyRemote example](examples/SomfyRemote/SomfyRemote.ino).

0 comments on commit 9db00b9

Please sign in to comment.