Skip to content

Latest commit

 

History

History
215 lines (161 loc) · 9.1 KB

README.md

File metadata and controls

215 lines (161 loc) · 9.1 KB
Raw

Dasshio - Amazon Dash Buttons Hass.io add-on

Hass.io add-on to use Amazon Dash Buttons in Home Assistant.

Description: How dasshio works

This is a python script used to scan Wifi devices connected to your network (using ARP and UDP). If a device matches any MAC address of the options, it will perform a HTTP POST request to the Home Assistant API.

Usage

The purpose of Dasshio is to "integrate" Amazon's Dash buttons in Home Assistant in an easy way with Hass.io.

See RESTful API Post Services documentation to see what you can do.

Examples:

  • Set a Dash Button to toggle room_light light:
    • domain: light
    • service: toggle
    • service_data: {\"entity_id\": \"light.room_light\"}
  • Set a Dash Button to activate a welcome_home script:
    • domain: script
    • service: turn_on
    • service_data: {\"entity_id\": \"script.welcome_home\"}

Have a look at Service calls to know what services you can use and what you can do with them.

How to install this Hass.io add-on

To install this add-on, please, follow Home Assistant documentation on how to Install Third-party Add-ons

How to connect your Dash button to your Wifi

Amazon has annouced that Dash Buttons will be no longer supported after 2019. In some countries, the configuration of the buttons has been disabled from Amazon's app.

However, there is an alternative method to connect the divice to your wifi network.

  1. Set the button into configuration mode by pressing the button for 6 seconds.
  2. Connect your laptop to the Wifi SSID that the button generates called Amazon Configure me.
  3. Open your favourite browser and navigate to the following URL http://192.168.0.1 here you will see a table with the MAC of your device. Copy the MAC address in order to indetify your device in the Dasshio configuration later.
  4. Navigate to the following URL: http://192.168.0.1/?amzn_ssid=<SSID>&amzn_pw=<PASSWORD> where <SSID> is the name of your Wifi network and <PASSWORD> is the password.
  5. Once you navigate to that URL, the button's Amazon Configure me Wifi will disappear and if <SSID> and <PASSWORD> were right, the button will connect to the Wifi network once you press the button.

Options example: domain, service, service_data

Here it is an example of a Dash Gillette button used to toggle a light and a Dash Bounty to call a script. Note you can add as many buttons as you like inside the "buttons" array.

  • name: name of your device
  • address: MAC of your device
  • domain: Home Assistant domain (light, switch, script, automation...). Check Home Assistant RESTful API.
  • service: Home Assistant service.
  • service_data: Home Assistant service data to call the service (Optional).

/data/options.json

{
  "timeout": 20,
  "buttons": [
  {
    "name": "Gillette",
    "address": "AC:63:BE:77:C4:0D",
    "domain": "light",
    "service": "toggle",
    "service_data": "{\"entity_id\": \"light.room_light\"}"
  },
  {
    "name": "Bounty",
    "address": "AC:63:BE:77:C4:0C",
    "domain": "script",
    "service": "turn_on",
    "service_data": "{\"entity_id\": \"script.welcome_home\"}"
  }]
}

Note: Dasshio uses http://hassio/homeassistant/api/services/{domain}/{service} as the base url to route requests over the Hassio local network between the containers. This is the prefered method as it means the requests don't have to leave the machine Hassio is running on (See Hass.io Addon Communication).

WARNING: As headers and body sections have to be strings, it is necessary to use backslashes ( \ ) before double quotes ( " ) to escape them. Like this: \"

Options: url, body, headers

Another possibility would be to use Dasshio to perform a HTTP Post request to an URL outside Home Assistant. To do so you can use the configuration below.

  • name: name of your device
  • address: MAC of your device
  • url: Url to perform the HTPP Post request (http or https). Check Home Assistant RESTful API.
  • headers: HTTP Post headers (Useful for Home Assistant API password -see example-).
  • body: HTTP Post Body (Normally the entity_id in Home Assistant)

/data/options.json

{
  "timeout": 20,
  "buttons": [
  {
    "name": "Gillette",
    "address": "AC:63:BE:77:C4:0D",
    "url": "http://httpbin.org/post",
    "headers": "{}",
    "body": "{\"payload\": \"This is an HTTP Post request!\"}"
  },
  {
    "name": "Bounty",
    "address": "AC:63:BE:77:C4:0C",
    "url": "http://hassio/homeassistant/api/services/script/welcome_home",
    "headers": "{}",
    "body": "{}"
  }]
}

Note: As described above, you can still use http://hassio/homeassistant/api to route requests over the Hassio local network and perform API calls to Home Assistant. You can see Hass.io Addon Communication for more information. For those running Hass.io in Docker you must add the docker internal IP address to HTTP trusted_networks in the configuration.yaml file.

# Example configuration.yaml entry
http:
    trusted_networks:
    - 127.0.0.1
    - 192.168.0.0/24
    - 172.17.0.0/16 # Example Docker bridge - change to your relevent ip subnet range.
    - 172.30.32.0/23 # Example Docker hassio - change to your relevent ip subnet range.

Options: timeout

By default Dasshio waits 10 seconds after a button press before resuming, this is to avoid detecting duplicate button presses. This option allows you to change this delay, if you want more responsive buttons then decrease this value and increase it if you experience duplicate presses.

Options: request_timeout_secs

In case you suffer some latency in the HTTP requests, you can increase the request_timeout_secs (default to 2 seconds).

How to find the MAC address of your Dash

At the moment, the best way to do this is to hold down the button for 6 seconds, disconnect from the current Wifi and connect to the Amazon ConfigureMe SSID. If prompted, "stay connected" and open web page 192.168.0.1. You will see your button’s ‘about’ page with the MAC and the additional information.

Alternatively, you can access your Wifi Router and check the MAC addresses in the history of connected devices. Then, copy and paste the MAC in a service like MA:CV:en:do:rs to find the Vendor of that device. The Amazon Dash button vendor should be: Amazon Technologies Inc.

Manual installation (not as an addon)

Requirements: To have installed Home Assistant following this guide: https://www.home-assistant.io/docs/installation/virtualenv/

  1. Create the folder /srv/homeassistant/dasshio to store the files:

    /srv/homeassistant/dasshiodasshio.py
/srv/homeassistant/dasshiodata/config.json
/srv/homeassistant/dasshiodata/options.json

  2. In options.json define the url, headers, body and domain of your Home Assistant integration:

    {
  "server": "http://localhost:8123",
  "timeout": 30,
  "buttons": [
  {
    "name": "Duracell",
    "address": "xx:xx:xx:xx:xx:xx",
    "url": "http://localhost:8123/api/services/switch/toggle",
    "headers": "{\"x-ha-access\": \"ha_password\"}",
    "body": "{\"entity_id\":\"switch.socket_power\"}",
    "domain": "switch"
  }]
}

  3. To run dasshio as a service, create the file: /lib/systemd/system/dasshio.service

    [Unit]
Description=dasshio - Amazon Dash Buttons
After=network.target,home-assistant\@homeassistant.service
StartLimitIntervalSec=0
[Service]
Type=simple
Restart=always
RestartSec=1
User=root
ExecStart=/srv/homeassistant/bin/python3 /srv/homeassistant/dasshio/dasshio.py

[Install]
WantedBy=multi-user.target

  4. Manually start/stop the service:

    sudo systemctl start dasshio
sudo systemctl status dasshio
sudo systemctl stop dasshio

  5. Automatically start the service on boot

    sudo systemctl enable dasshio

Credit

Sources & Inspiration: