forked from esphome/esphome-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Cookbook Guide for Brilliant / Mirabella Genio Smart Plugs (esphome#195)
* Cookbook Guide for Brilliant / Mirabella Genio Smart Plugs * Fix documentation error * Fix linting errors * Simplified configuration and remove invalid component
- Loading branch information
1 parent
1a92227
commit 40ff3ee
Showing
5 changed files
with
241 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,240 @@ | ||
Brilliant / Mirabella Genio Smart Plugs | ||
======================================= | ||
|
||
Brilliant / Mirabella Genio Smart Plugs are a tuya based smart plugs sold by Bunnings and Kmart respectively in Australia. | ||
|
||
.. figure:: images/brilliant-mirabella-genio-smart-plugs.jpg | ||
:align: center | ||
:width: 50.0% | ||
|
||
Originally intended to be used with their companion apps once flashed using `tuya-convert <https://github.com/ct-Open-Source/tuya-convert>`__ ESPHome generated | ||
firmware can be uploaded allowing you to control the smart plugs via Home Assistant. | ||
|
||
1. Create the ESPHome Firmware | ||
------------------------------ | ||
|
||
#. Refer to either :doc:`/guides/getting_started_command_line` or :doc:`/guides/getting_started_hassio` before moving onto the next step. | ||
#. Select a plug configuration below based on the plug/s you have and copy all of the text in the code block and paste into your | ||
``name_of_esphome_configuration.yaml`` file. | ||
#. Compile the firmware, again depending on your chosen setup refer to the guides in the first point. | ||
|
||
2. Flashing | ||
----------- | ||
|
||
2.1 Prerequisites | ||
***************** | ||
|
||
#. Before you begin you'll need one of the following linux machines running the latest copy of `Raspbian Stretch Lite | ||
<https://www.raspberrypi.org/downloads/raspbian/>`__ | ||
|
||
a. Raspberry Pi 2B/B+ with `USB WiFi Dongle <https://www.raspberrypi.org/products/raspberry-pi-usb-wifi-dongle/>`__. | ||
b. Raspberry Pi 3B/B+. | ||
|
||
.. note:: | ||
|
||
As per the `tuya-convert documentation <https://github.com/ct-Open-Source/tuya-convert/blob/master/README.md#requirements>`__: | ||
|
||
Any Linux with a Wifi adapter which can act as an Access Point should also work. Please note that we have tested the Raspberry Pi with clean installations | ||
only. If you use your Raspberry Pi for anything else, we recommend using another SD card with a clean installation. | ||
|
||
#. A microSD card (minimum 2GB, 8GB+ recommended). | ||
#. Any WiFi device which can connect to the SSID generated by the Raspberry Pi and eventually the flashed tuya device. **This cannot be an iOS / Apple device. | ||
Android devices will work.** | ||
|
||
2.2 Installing the OS | ||
********************* | ||
|
||
#. It's recommended to read the documentation provided by the Raspberry Pi Foundation on the best way to flash the OS to the microSD card depending on your | ||
platform - `Installing operating system images <https://www.raspberrypi.org/documentation/installation/installing-images/>`__. | ||
#. After you've flashed the microSD card browse to the "boot" partition and add a blank file called "ssh" **(without any extension)** which will enable the | ||
SSH server upon first boot, extended information on this step can be found `here | ||
<https://www.raspberrypi.org/documentation/remote-access/ssh/README.md#3-enable-ssh-on-a-headless-raspberry-pi-add-file-to-sd-card-on-another-machine>`__. | ||
#. Plug the microSD card into the Raspberry Pi, connect network cable and power, the Raspberry Pi will start to boot. | ||
|
||
2.3 Connecting to the Pi via SSH | ||
******************************** | ||
|
||
#. Download and install `Putty <https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html>`__. | ||
#. Open Putty. | ||
#. Enter the IP of Raspberry Pi in the box that says "Host Name", leaving the port set to 22 (default for SSH). A list of recommended ways can be found `here | ||
<https://www.raspberrypi.org/documentation/remote-access/ip-address.md>`__, but the easiest is to download and use `Fing <https://www.fing.com/>`__ | ||
(`Android <https://play.google.com/store/apps/details?id=com.overlook.android.fing&hl=en_GB>`__ / `iOS | ||
<https://itunes.apple.com/us/app/fing-network-scanner/id430921107?mt=8>`__). | ||
#. In the "Saved Sessions" input box, name the Raspberry Pi connection and then press "Save". | ||
#. Select your new saved session from the list. | ||
#. Press "Open". | ||
|
||
2.4 Configuring the Pi | ||
********************** | ||
|
||
#. In the putty window login with the **pi** as the user and **raspberry** for the password. | ||
#. Type ``sudo apt-get update && sudo apt-get dist-upgrade -y`` and wait for the upgrades to install. | ||
#. Type ``sudo apt-get install git`` and wait for it to install. | ||
|
||
2.5 Setup and Install tuya-convert | ||
********************************** | ||
|
||
#. In the putty window type ``git clone https://github.com/ct-Open-Source/tuya-convert`` press enter and wait while the repository is cloned. | ||
#. Type ``cd tuya-convert`` and press enter. | ||
#. Type ``./install_prereq.sh`` press enter and wait as the script gathers all the required components needed to function. | ||
|
||
2.6 Upload ESPHome Firmware using SFTP | ||
************************************** | ||
|
||
#. Download `FileZilla <https://filezilla-project.org/download.php?type=client>`__ or `WinSCP <https://winscp.net/eng/index.php>`__ or use your preferred FTP | ||
client. | ||
#. Depending on the program you need to connect to the Pi using the IP address as the hostname and the username and password the same as you used to connect | ||
via SSH and ensure your connection type is set to **SFTP** | ||
#. Browse to ``/root/tuya-convert/files``. | ||
#. Upload your compiled ``firmware.bin`` file to this directory. For command line based installs you can access the file under | ||
``<CONFIG_DIR>/<NODE_NAME>/.pioenvs/<NODE_NAME>/firmware.bin`` alternatively Hass.io users can download the file directly from the web ui. | ||
|
||
2.7 Use tuya-convert to install ESPHome Firmware | ||
************************************************ | ||
|
||
#. Type ``./start_flash.sh`` | ||
#. Type ``yes`` to accept the warning. | ||
#. Connect your alternative WiFi device (non iOS / Apple based) to the ``vtrust-flash`` SSID using ``flashmeifyoucan`` as the password. This is the network | ||
being broadcast by the Pi from the tuya flash script. | ||
#. If you haven't already connect your smart plug and turn it on. It should automatically enter pairing mode, if it doesn't follow the instructions below: | ||
|
||
* Brilliant `(PDF Manual) <https://www.brilliantsmart.com.au/wp-content/uploads/2019/02/03.-How-to-setup-the-Smart-plug.pdf>`__ | ||
|
||
* To connect the Smart WiFi Plug to your WiFi press and hold the manual control button for about 5 seconds until you hear a click. Let go of the button | ||
as soon as you hear the **click**. Then press button once again to activate blinking. **The red indicator light should now blink rapidly (2 times per | ||
second)**. | ||
|
||
* Mirabella `(PDF Manual) <https://img1.wsimg.com/blobby/go/67cdd3b9-3600-4104-b097-603c05201237/downloads/1cq5h6nt7_336441.pdf>`__ | ||
|
||
* To do this, ensure your plug is on (the indicator light should be blue), hold the power button down for 5 seconds until you hear a click, let go of the | ||
power button and then press the button once to activate. | ||
|
||
#. Press enter on your putty window to start the flash process and wait. If the connection is successful you should see a large amount of scrolling text, this | ||
is the script backing up the factory shipped firmware. | ||
#. Once the process is complete you can type ``curl http://10.42.42.42/flashURL?url=http://10.42.42.1/files/firmware.bin`` | ||
#. The plug will restart and if everything is working correctly after a few seconds you should be able to press the button triggering the relay and turning the | ||
blue led on. | ||
|
||
3. Smart Plug Configurations | ||
---------------------------- | ||
|
||
Thanks to the existing work by `@ideasman69 <https://github.com/ct-Open-Source/tuya-convert/issues/66>`__ and | ||
`afalzon <https://github.com/arendst/Sonoff-Tasmota/wiki/Mirabella-Genio-Smart-Plug>`__ | ||
which these adaptions created by `@cryptelli <https://community.home-assistant.io/u/cryptelli>`__ are based on. | ||
|
||
|
||
3.1 Brilliant Smart Plug | ||
************************ | ||
|
||
.. code-block:: yaml | ||
esphome: | ||
name: brilliant_smart_plug | ||
platform: ESP8266 | ||
board: esp01_1m | ||
wifi: | ||
ssid: 'WIFI' | ||
password: 'WIFIPASS' | ||
logger: | ||
api: | ||
ota: | ||
binary_sensor: | ||
- platform: gpio | ||
pin: | ||
number: 14 | ||
mode: INPUT_PULLUP | ||
inverted: true | ||
name: "Power Button" | ||
on_press: | ||
- switch.toggle: relay | ||
- platform: status | ||
name: "Status" | ||
switch: | ||
- platform: gpio | ||
id: red_led | ||
pin: | ||
number: GPIO12 | ||
inverted: true | ||
- platform: gpio | ||
name: "Brilliant Smart Plug" | ||
pin: GPIO5 | ||
id: relay | ||
# Turn off red LED to show blue when turned on | ||
on_turn_on: | ||
- switch.turn_off: red_led | ||
# Turns on the red LED once the plug is turned off. Stock plug doesn't do this, to restore normal behavior remove the on_turn_on and on_turn_off | ||
# blocks. | ||
on_turn_off: | ||
- switch.turn_on: red_led | ||
3.2 Mirabella Genio Wi-Fi 1 USB Adaptor | ||
*************************************** | ||
|
||
.. code-block:: yaml | ||
esphome: | ||
name: mirabella_genio_smart_plug | ||
platform: ESP8266 | ||
board: esp01_1m | ||
wifi: | ||
ssid: 'WIFI' | ||
password: 'WIFIPASS' | ||
logger: | ||
api: | ||
ota: | ||
binary_sensor: | ||
- platform: gpio | ||
pin: | ||
number: GPIO13 | ||
mode: INPUT_PULLUP | ||
inverted: true | ||
name: "Power Button" | ||
on_press: | ||
- switch.toggle: relay | ||
- platform: status | ||
name: Status | ||
switch: | ||
- platform: gpio | ||
name: "Mirabella Genio Smart Plug" | ||
pin: GPIO12 | ||
id: relay | ||
4. Adding to Home Assistant | ||
--------------------------- | ||
|
||
You can now add your smart plug to home assistant via the configurations page, look for 'ESPHome' under the Integrations option and click 'Configure'. | ||
|
||
.. figure:: images/brilliant-mirabella-genio-smart-plugs-homeassistant.jpg | ||
:align: center | ||
:width: 50.0% | ||
|
||
See Also | ||
-------- | ||
|
||
- :doc:`/components/switch/index` | ||
- :doc:`/components/binary_sensor/index` | ||
- :doc:`/components/light/index` | ||
- :doc:`/components/light/monochromatic` | ||
- :doc:`/components/output/index` | ||
- :doc:`/components/output/esp8266_pwm` | ||
- :doc:`/guides/automations` | ||
- :ghedit:`Edit` | ||
|
||
.. disqus:: |
Binary file added
BIN
+7.8 KB
cookbook/images/brilliant-mirabella-genio-smart-plugs-homeassistant.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters