Skip to content

Commit

Permalink
Improved README.md, added wiring diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
N-Storm committed Apr 12, 2024
1 parent 6becc85 commit c36063a
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
# DigiLivolo

Firmware (for Digispark Arduino compatible module) & software to control Livolo RF 433 Mhz light switches.
Firmware for Digispark Arduino compatible module (any probably other AVR parts capable runninng V-USB)
to control Livolo RF 433 Mhz light switches via USB.

Once flashed, this firmware turns DigiSpark module into USB HID device. Which should have drivers
shipped with most modern OSes. I.e. no driver will be required.

Device accepts commands from USB Host with Livolo Remote ID & keycode and sends it on radio with
some kind of 433 MHz dumb OOK/ASK transmitter, like cheap SYN115 modules.

## Description

Expand Down Expand Up @@ -31,6 +38,8 @@ Upload firmware to your Digispark module. Connect DATA pin of 433 Mhz transmitte
were used & confirmed to work by me) to P5 of Digispark module (this pin can be changed in main sketch code).
Also connect VCC & GND of the module.

![f](https://raw.githubusercontent.com/N-Storm/DigiLivolo/main/wiring.jpg)

Once plugged to USB, the device should be recognized as USB HID device, not requiring any driver as every
modern OS have this standard USB class driver built-in.

Expand All @@ -50,6 +59,8 @@ This should send Livolo command as remote ID 0x214d (77,33) and key ID 0x10 (16)

## Building

### With PlatformIO

```console
git checkout --recurse-submodules https://github.com/N-Storm/digiLivolo/
cd digiLivolo/firmware
Expand All @@ -58,10 +69,21 @@ pio run

Or open VSCode workspace after checkout, providing you have VSCode with PlatformIO plugin installed.

### With Arduino IDE

Install [DigistumpArduino](https://github.com/ArminJo/DigistumpArduino) core.

Create new directory `DigiLivolo`, copy `firmware/src/DigiLivolo.cpp` as `DigiLivolo.ino` there.

Copy `DLUSB` and `Livolo` libraries from `firmware/lib` to your Arduino libraries directory.

Open `DigiLivolo.ino` with Arduino IDE, set board to DigiSpark and compile.

## Software used

* [PlatformIO](https://platformio.org/)
* [DigistumpArduino](https://github.com/ArminJo/DigistumpArduino)
* [V-USB](https://www.obdev.at/products/vusb/index.html)
* [Livolo Arduino library](https://forum.arduino.cc/t/control-livolo-switches-livolo-switch-library/149850)
* [hidapi](https://github.com/libusb/hidapi)
* [hidapitester](https://github.com/todbot/hidapitester)
Binary file added wiring.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c36063a

Please sign in to comment.