DONOFF – WiFi enabled light dimmer

[ 17,005 views ]

Part-1 – Introduction

Years ago I started building RF devices to measure temperatures and switching lights on or off. I even wrote a small book (in Dutch) about my findings and experiments. But I always wanted to overcome the main disadvantage of RF devices: no feedback about the status of the lights. I thought that could be done better and with the introduction of the small ESP8266 WiFi enabled processors it could! But SONOFF beat me with there WiFi enabled switches. One great disadvantage of the SONOFF devices is the poor software. To make the switches usable you have to upload third party (mainly Open-Source) firmware and install a Home-Automation solution to control the switches. Another disadvantage of the SONOFF switches is .. well they are switches (Switch On Off). So there is room for improvement!

Albeit: I introduce to you: DONOFF (Dimmer On Off)!

Een nederlandse versie van deze post kunt u hier vinden.

Project goals

The goals of this project is to make an ecosystem that is self sustained. So: you don’t need a Home-Automation system to control the DONOFF devices! Also, there is no substitute for a physical switch (ask your spouse)! You can attach an external toggle– or push-switch to the DONOFF hardware with which you can either switch the light On or Off (toggle-switch) or, with a push-switch, you can switch the light On or Off and dim-up and dim-down by long-pressing the (push) switch.
Every DONOFF has a web-server on board that you can use directly from any (Javascript enabled) browser. Accessing the web-server on a browser gives you the control page for this device:


I will, in four parts, explain how you can build and use this DONOFF ecosystem.

  • Part 1 – Introduction (this part)
  • Part 2 – The Electronics
  • Part 3 – The Firmware
  • Part 4 – Building a DONOFF device

Every DONOFF installation has one DONOFF designated as a Master whilst all the others are designated as Slaves. From the Master’s webpage all the other (Slave) devices can be controlled.
Slave’s automatically register to the Master with their IP-address and Device Name. If you power-up a new DONOFF device it will automatically be added to the Master’s page. If you unplug a DONOFF device it will (after a while) disappear from the Master’s page.

Switches are always shown below the dimmers (yes, you can upgrade a SONOFF switch to this ecosystem but for obvious reasons it will not have the dimmer functionality).
The controls have the following function:


Every DONOFF device has a unique hostname (i.g. “floorlamp”) and an indication of which lamp it controls (i.g. the “Floor Lamp”). With the slider you can control the brightness of the lamp. Clicking on the Toggle-Switch-icon will turn the device “On” or “Off”, which does not affect the slider controlled brightness of the lamp. The lightbulb-icon shows whether the lamp is “On” or “Off”. Every DONOFF device has a settings page to control the various attributes of the device. Clicking on the “Settings-icon” brings you to this page.


The attributes have the following meaning:

this DeviceHere you can give this Device a hostname. The IP-address is assigned by the DHCP server in your network and can (will) change every time you reconnect the DONOFF device (but this will not affect the installation as the new IP-address will automatically be updated)
Device RoleThis can either be “Master” or “Slave”. Be aware: there can only be one (1) Master in your installation!
MasterIf this Device is a Slave, than you must enter the Master credentials. Every Master has the hostname “DONOFF” that can not be changed. But do enter the Master’s IP-address!
Device TypeThis can either be “Dimmer” or “Switch”. A Switch can only be “On” or “Off” (obviously)
BuiltIn Led pinThis is the GPIO pin at which a Built In Led is connected (GPIO1 for an ESP-01, GPIO16 for a NodeMCU, GPIO13 for a SONOFF basic etc.)
External SwitchThis is the GPIO pin at which an external switch is attached. On the DONOFF board with the ESP-01 this is GPIO2
You have to indicate the type of external switch. Either “Toggle” or “Push”. A Push switch gives, besides the On/Off functionality also the ability to dim-up or dim-down the light
PWM outOn the DONOFF board with the ESP-01 this is GPIO3. On the SONOFF basic this is GPIO12 (for a switch type there is no PWM but only HIGH [1] or LOW [0])
PWM frequencyWell, the PWM frequency in Hz. A value between 200 and 900.
Min PercentThis is the lowest value (in percent) at which the Led lamp still glows
Max PercentThis is the maximum percentage you will control using the slider or push-switch. Normally this will be 100(%)
default Light StateThe value used by a Toggle-switch if the light is switched On
device LabelThe name of the light as shown on the web-page of this Slave or on the DONOFF Master’s web-page
This entry was posted in Arduino, DONOFF, ESP8266, Hardware, SONOFF, WiFi and tagged , , , , , , , , , . Bookmark the permalink.

56 Responses to DONOFF – WiFi enabled light dimmer

  1. Rob de Bie says:

    Beste Willem,
    Grandioos, wederom een hele diepe buiging !
    Mooi, zinvol en bruikbaar project.
    Groet,
    Rob

  2. Rob says:

    Hoi Willem,
    na je slimme meter monitor gebouwd te hebben, ga ik dit zeker even volgen.
    Groet, Rob (andere rob dan hierboven!)

    • Hallo Rob,
      Het is zeker een project dat de moeite waard is. Ben nu nog druk in de Research & Development (eerste print-ontwerp heeft een verkeerd formaat Hi-Link 🙁 )
      Verder nog wat punten op I-en zetten. Maar dan krijg je ook wat!

      Ondertussen werkt DONOFF bij mij al vanaf februari 2019 probleemloos met één master, drie DONOFF slaves en een SONOFF switch.

      Je kunt hier een complete kit (zonder project box) kopen.

  3. diy electric bike says:

    Your style is unique in comparison to other folks I have read stuff from.
    Many thanks for posting.
    I will just bookmark this page

  4. K.G. Dik says:

    Willem , ik ben iedere keer weer onder indruk van de mogelijkheden van de huidige electronica, maar dat wist je al!
    Ik ben benieuwd wat je dit jaar allemaal weer fabriekt!
    Kees

  5. Erik Meinders says:

    Willem,

    This is exactly what SONOFF misses; the ability to dimm your lights. Even LED lights, which of course is today’s standard. I can’t wait to see what else you come up with in 2019!?

    Keep up the good work,

    Erik

  6. Roland says:

    Hi Willem,
    I’ve done your smart meter reader project with great pleasure before.
    And now see that you have another nice project; Donoff
    Maybe you have the Donoff pcb for sale separately?
    I will send you my personal data by mail
    Thnx in advance, Roland

    • Willem Aandewiel says:

      Hi Roland,

      Nice you like my projects.
      Send you a PM.

      In the mean time opencircuit.nl is selling DONOFF as a complete kit that you can order here.

  7. Rob says:

    mooi project willem. Nu nog een versie ontwerpen die zoals de zwave en shelly systemen achter een schakelaar in een wcd past.

    • Willem Aandewiel says:

      @Rob,

      I’m not familiar with zwave and shelly but I wonder if they have PWM dimmers that small …. But of course that is the ultimate goal.

  8. Sune Bielefeldt says:

    Dear Willem Aandewiel
    It is a great project you have made here, just what I have missed for a long time.
    I am a great consumer of Sonoff, but have missed this dimmer feature that Donoff offers.

    I want to try to build one or more sets myself.

    Is it possible to buy PCBs from you, or maybe just Gerber files so I can order them myself?

    Best regards from Denmark
    Sune Bielefeldt

  9. Andrew Bennett says:

    Hi Willem, this looks interesting. Could you tell me if you still have PCB’s or files available? Thanks.

  10. Ed says:

    Well done, but just one remark: you also do not “need” a home automation system for the sonoff, can do that with a webserver as well, just as you did with the donoff

  11. Sorin Tudor says:

    Hi Willem,

    Congratulations for this project!
    I would like to reproduce it too, the presentation seems pretty clear to me and I would like to control some LED bulbs …
    My question is the following: what kind of LED bulbs can I use? Dimmable LED bulbs working at 220V AC are OK considering the DC power supply? If not, what kind of bulbs do you recommend?

    Sincerely,
    Sorin from Romania

    • Willem Aandewiel says:

      Sorin,
      Nice you like my project.
      I have tested with Ikea, Philips and a view other brands “dimmable led-bulbs”. Mind you, all ‘mains’ led bulbs work internaly with DC voltage. The Donoff work as well with normal light bulbs.

      You can buy a complete kit here.

      • Sorin Tudor says:

        I’m glad to hear that!
        I hope not to bother with other questions if necessary.
        Thanks for the quick response!

    • Willem Aandewiel says:

      No problem!
      Keep me posted about your findings and progress.

  12. andrew says:

    Hi Willem,
    R1 marked on the board is not on the Bill of Materials. What value is it?

  13. Geert says:

    Hi Willem ,

    Heb je nog een complete set te koop ,
    Hoor graag van je
    Gr Geert

  14. Jorrit says:

    Hoi Willem,

    Is er een mogelijkheid deze dimmer te laten werken met google assistent?
    Met Sonoff kan je deze koppelen dmv de service “Smart We Link”, maar aangezien hier andere firmware op zit, vraag ik me af of hier een oplossing voor is.

    Mvg,
    Jorrit

    • Willem Aandewiel says:

      Hi Jorrit,
      Ik ken Google Assistent niet maar het is vast wel mogelijk om de Assistant de correcte informatie naar de DONOFF te laten sturen om zo lampen te dimmen of uit of aan te zetten.

  15. Roland says:

    I have made an enclosure for DONOFF; https://www.thingiverse.com/thing:3924602

  16. Roland says:

    By the way; the HLK-PM03 still doesn’t fit on PCB V2.1

    • Willem Aandewiel says:

      Strange!
      On my V2.1 PCB they fit both. So, unless the footprint of the HLK-PM03 has changed I would not know why it should not fit ..
      I send you a PM.

      • Roland says:

        Hi Willem, I understand the confusion now, I used the HLK-5M03 (5W) module (according to your BOM list) instead of the HLK-PM03 (3W) module. The dimensions on the PCB correspond to the HLK-PM03.

  17. Chris says:

    Op de een of andere manier krijg ik bij het verifiëren de foutmelding dat WebSocketsServer.h niet aanwezig is. Welke library moet ik downloaden van github om dit te corrigeren?

    • Willem Aandewiel says:

      Hi Chris,

      Je zult echt iets meer informatie moeten geven.
      – Wat heb je gedaan om de code in de Arduino IDE te krijgen?
      – Heb je de documentatie goed gelezen?
      – Welke versie van de DONOFF code probeer je te compileren?
      – Welke libraries heb je geïnstalleerd?
      – Welke versie van de IDE gebruik je?
      – Welke versie van de Arduino/ESP8266 core heb je geïnstalleerd?
      – Kun je een stukje van de compile-output toevoegen (liefst geen plaatjes want die zijn bijna niet te lezen)

      • Chris says:

        Dag Willem,
        Hartelijk dank voor je snelle reactie. Ik ben bang dat ik net door de mand ben gevallen als een absolute beginner…
        Dankzij de instructie is het me gelukt om Arduino IDE te installeren en DONOFF v0.3.6 te downloaden en te openen. Door de links in de code werd precies aangegeven welke library ik nog miste. Dus die heb ik 1 voor 1 toegevoegd. Alleen voor de websocket stond het er niet bij. Door te zoeken op github op WebSocketsServer.h heb ik gevonden dat ik de library van Links2004/arduinoWebSockets moet hebben. Inmiddels heb ik het kunnen compileren. Ik kijk ernaar uit om te gaan solderen 😉
        Heel erg bedankt voor dit mooie laagdrempelige project. Als ik het aan de praat krijg dan gaat er een wereld voor me open!
        Met hartelijke groet,
        Chris

  18. Don Zentmeyer says:

    Are the kits for DONOFF available in the US? Can they be shipped to the US?

    • Willem Aandewiel says:

      Hi Don,

      I don’t know. You better ask opencircuit.nl.
      But mind you, DONOFF is configured for 230v mains.

      • Don Zentmeyer says:

        When I looked at the BOM both of the recommended power modules (IRM-01-3.3 and HLK-PM03) are rated for 110 or 230.
        A little over my head but won’t either convert mains power to 3.3vDC?

    • Willem Aandewiel says:

      Don,

      The power modules are not the problem. It’s the Mosfet Control Circuit that is, with the given dimensions, not suitable for 110volt.

  19. Chris says:

    Dag Willem,

    Het is inmiddels gelukt om te compileren. Ik heb alles van Arduino IDE verwijderd en ben opnieuw begonnen aan de hand van de instructie bij de DSMR-logger (zoals je aangeraden had). Daarna heb ik de DONOFF firmware via een zip gedownload en uitgepakt (de instructie $ git clone https://github.com/mrWheel/DONOFF.git . werkte bij mij niet. Ik deed vast iets verkeerd, maar geen idee wat. ‘git’ is een programma dat niet wordt herkend). Maar via de Arduino IDE kon ik ook de DONOFF.ino starten en daarna dus compileren.

    Bedankt voor de hulp!

    • Willem Aandewiel says:

      Chris,

      Bedankt voor de feedback.

      Git is inderdaad een programma dat je moet installeren (daarover is alles met google te vinden) en waarmee je eenvoudig met github kunt werken.

      Maar het downloaden van het zip file werkt net zo goed.

      Succes verder met DONOFF.

  20. Chris says:

    Goedemorgen Willem,

    Als beginneling ben ik aan het zoeken en kom niet verder. Misschien kan je een hint geven hoe ik het beste verder kan gaan?

    Mijn probleem is als volgt: Ik kan de DONOFF firmware uploaden, maar krijg bij het laden van de icoontjes via ‘ESP8266 Sketch data upload’ de volgende foutmelding (in blauw). Ik gebruik uploader “AVRISP mkll” (zie screenshot).
    Ik ben aan het zoeken maar kom niet verder (ook niet via internet). Wat is de beste stap die ik zou kunnen doen? Moet ik de bibliotheek opnieuw installeren? Of een andere uploader instellen?

    Alvast bedankt voor je hint/hulp,

    Met groet,

    Chris


    ======================================================
    Arduino:1.8.11 (Windows Store 1.8.29.0) (Windows 10), Board:"Generic ESP8266 Module, 80 MHz, Flash, Legacy (new can return nullptr), All SSL ciphers (most compatible), dtr (aka nodemcu), 26 MHz, 40MHz, DOUT (compatible), 1MB (FS:128KB OTA:~438KB), 1, nonos-sdk 2.2.1+113 (191105), v2 Lower Memory, Disabled, None, Only Sketch, 115200"

    [SPIFFS] data : C:\Users\Chris\Documents\Arduino\DONOFF\data
    [SPIFFS] size : 128
    [SPIFFS] page : 256
    [SPIFFS] block : 4096
    /admin.html
    /admin_sm.png
    /index.html
    /lightOff.ico
    /lightOn.ico

    [SPIFFS] upload : C:\Users\Chris\AppData\Local\Temp\arduino_build_193833/DONOFF.spiffs.bin
    [SPIFFS] address : 0xDB000
    [SPIFFS] reset : --before default_reset --after hard_reset
    [SPIFFS] port : COM6
    [SPIFFS] speed : 115200
    [SPIFFS] python : python.exe
    [SPIFFS] uploader : C:\Users\Chris\Documents\ArduinoData\packages\esp8266\hardware\esp8266\2.6.2\tools\upload.py

    usage: esptool [-h] [--chip {auto,esp8266,esp32}] [--port PORT] [--baud BAUD]

    [--before {default_reset,no_reset,no_reset_no_sync}]

    [--after {hard_reset,soft_reset,no_reset}] [--no-stub]

    [--trace] [--override-vddsdio [{1.8V,1.9V,OFF}]]

    {load_ram,dump_mem,read_mem,write_mem,write_flash,run,image_info,make_image,elf2image,read_mac,chip_id,flash_id,read_flash_status,write_flash_status,read_flash,verify_flash,erase_flash,erase_region,version}

    ...

    esptool: error: unrecognized arguments: --end

    SPIFFS Upload failed!

    Dit rapport zou meer informatie bevatten met
    "Uitgebreide uitvoer weergeven tijden compilatie"
    optie aan in Bestand -> Voorkeuren.
    ======================================================

    • Willem Aandewiel says:

      Hi Chris,

      Je gebruikt helemaal geen programmer dus daar hoef je ook niets in te vullen.

      FWIW: bij mij is USBasp geselecteerd (waarschijnlijk omdat ik die het laatst gebruikt hebt bij het programmeren van een ATmeg328).

      Na het flashen van de firmware moet je de hele data-map naar SPIFFS flashen. Dat doe je met het “Sketch Data Upload” tool die je eerst zelf moet installeren (hier kun je lezen hoe dat moet).
      Waarschijnlijk gebruik je een versie van het data upload tool die niet compatible is met je Arduino IDE. Op de website van het tool staan verschillende versies hiervan. Meestal is de nieuwste goed in combinatie met de nieuwste Arduino IDE (ik gebruik 1.8.10).

      Eventueel kun je de maintenance page handmatig starten door in de browser, achter http://IPADDRES/ of http://donoff.local/ “maintenance” te tikken (zonder de quotjes!).

      Via de maintenance page kun je met [choose file] één voor één de bestanden uit de data map uploaden.

      Anders moet je deze hint misschien opvolgen:

      Dit rapport zou meer informatie bevatten met
      “Uitgebreide uitvoer weergeven tijden compilatie”
      optie aan in Bestand -> Voorkeuren.

      Ik heb geen verstand van Windows dus specifieker kan ik je niet helpen..

  21. Chris says:

    Hartelijk dank!
    Ik ga het proberen. Ik heb intussen de data map handmatig overgezet en voor het eerst alles aangesloten. En…. het werkt!
    Ik heb er nu al zoveel lol van 🙂

    • Willem Aandewiel says:

      Dat is mooi om te horen.

      Ik heb er zelf verschillende draaien en ben er ook nog steeds verbaast over hoe goed het werkt!!

  22. RobV says:

    Hi Chris en anderen:

    Ik heb ook mn eerste set gebouwd en hij werkt!
    Maar, de lampen (LED Dimable verschillende soorten) branden allemaal niet stabiel. Ze faden, afhankelijk van de PWM-frequentie, regelmatig aan en (deels) uit. Het lijkt of er een klokpuls net uit de pas loopt met de netfrequentie of zo. Misschien een zero-cross probleempje? Kan iemand mij advies geven?

    Groet, RobV

    • Willem Aandewiel says:

      Hi RobV,

      Heb je verschillende PWM frequenties geprobeerd?

      De meeste LED lampen kun je niet tot “0” dimmen. Je moet de minimale waarde zo kiezen dat er geen fading meer optreedt.

      • RobV says:

        Hallo Willem. Dank voor je snelle reactie. En ja, ik ken het effect van LED-lampen op lage lichtsterkte. Ik heb een ander effect ook bij halve lichtsterkte. Om duidelijk te maken wat ik bedoel, heb ik een filmpje gemaakt maar het lukt me niet om dat hier te posten.

        Groet, RobV

        • @RobV
          .. voor mij ook een raadsel!
          Als je er een “gewone” lamp op aansluit, wat gebeurd er dan?

          Kun je de spanning over D3 en C2 meten? Liefst met een oscilloscoop, maar dan moet je wel een differential probe gebruiken anders kun je je scoop opblazen!!! Ik zou haast denken dat de 15 volt spanning fluctueert. Als de frequentie laag is zou je het met een normale multimeter moeten kunnen volgen. Spanning moet zo tussen de 13v en 15v liggen.

          Kan het zijn dat je onderdelen verkeerd gebruikt heb? Ik denk dan bijvoorbeeld aan R3, R4 en R6

  23. JFJ Frijns says:

    Hoi Willem,

    Bij het compeleren met Arduino IDE krig ik op lijn 879 (httpClient.begin(wifiClient, URL); // Specify request destination) de volgende fout melding;

    C:\Users\jackp\Documents\ArduinoData\packages\esp8266\hardware\esp8266\2.4.2\libraries\ESP8266HTTPClient\src/ESP8266HTTPClient.h:144:10: note:   candidate expects 4 arguments, 2 provided
    C:\Users\jackp\Documents\ArduinoData\packages\esp8266\hardware\esp8266\2.4.2\libraries\ESP8266HTTPClient\src/ESP8266HTTPClient.h:146:10: note: bool HTTPClient::begin(String, uint16_t, String, bool, String)
         bool begin(String host, uint16_t port, String uri, bool https, String httpsFingerprint)  __attribute__ ((deprecated));
              ^
    C:\Users\jackp\Documents\ArduinoData\packages\esp8266\hardware\esp8266\2.4.2\libraries\ESP8266HTTPClient\src/ESP8266HTTPClient.h:146:10: note:   candidate expects 5 arguments, 2 provided
    exit status 1
    no matching function for call to 'HTTPClient::begin(WiFiClient&, String&)'
    

    Ik heb alle libs geinstalleerd (denk ik…) en kom met googelen / dit forum niet verder.

    Waar ik de mist in?

    Merci, jack

    • Willem Aandewiel says:

      Jack,

      Volgens mij heb je álles goed gedaan.
      Ondertussen is de firmware ook getest met de ESP8266 core versie 2.6.x en ik raad je aan om die laatste core versie te installeren en dan kijken hoever je komt.

      Success!

      • Jack says:

        Hoi Willem,

        Success, met 2.6.3 kan ik nu compilen en uploaden.

        Volgende probleem is de data upload, krijg de volgende melding;

        esptool: error: unrecognized arguments: --end
        SPIFFS Upload failed!
        [SPIFFS] data    : C:\Users\jackp\Documents\Arduino\DONOFF\data
        [SPIFFS] size    : 128
        [SPIFFS] page    : 256
        [SPIFFS] block   : 4096
        /admin.html
        /admin_sm.png
        /favicon.ico
        /index.html
        /lightOff.ico
        /lightOn.ico
        [SPIFFS] upload  : C:\Users\jackp\AppData\Local\Temp\arduino_build_953398/DONOFF.spiffs.bin
        [SPIFFS] address  : 0xDB000
        [SPIFFS] reset    : --before no_reset --after soft_reset
        [SPIFFS] port     : COM3
        [SPIFFS] speed    : 115200
        [SPIFFS] python   : python.exe
        [SPIFFS] uploader : C:\Users\jackp\Documents\ArduinoData\packages\esp8266\hardware\esp8266\2.6.3\tools\upload.py
         
        usage: esptool [-h] [--chip {auto,esp8266,esp32}] [--port PORT] [--baud BAUD]
                       [--before {default_reset,no_reset,no_reset_no_sync}]
                       [--after {hard_reset,soft_reset,no_reset}] [--no-stub]
                       [--trace] [--override-vddsdio [{1.8V,1.9V,OFF}]]
                       {load_ram,dump_mem,read_mem,write_mem,write_flash,run,image_info,make_image,elf2image,read_mac,chip_id,flash_id,read_flash_status,write_flash_status,read_flash,verify_flash,erase_flash,erase_region,version}
                       ...
        esptool: error: unrecognized arguments: --end
        SPIFFS Upload failed!
        

        Ik heb Phyton 3.7 en 3.8, esptool versie 1.0.3 en 1.0.4 geprobeerd met hetzelfde resultaat.

        Moet ik iets anders installeren?

        Merci,

        jack

        • Willem Aandewiel says:

          Jack,

          Google is je beste vriend!

          Zoek op “esptool: error: unrecognized arguments: --end“ en je vind tientallen redenen waarom je deze fout krijgt en hoe je hem moet oplossen!

  24. Jeroen says:

    Hoi Willem,

    Hoe zit het in dit schema met de afstraling van radiogolven?

    Ik kan me voorstellen dat een pwm puls op 230 volt storing kan veroorzaken zeker wanneer de draden naar de lamp langer worden.

    Groetjes Jeroen

Leave a Reply

Your email address will not be published. Required fields are marked *


The maximum upload file size: 4 MB.
You can upload: image, other.
Links to YouTube, Facebook, Twitter and other services inserted in the comment text will be automatically embedded.

This site uses Akismet to reduce spam. Learn how your comment data is processed.