Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/Nekmo/amazon-dash

Hack your Amazon Dash to run what you want.
https://github.com/Nekmo/amazon-dash

amazon amazon-dash amazon-dash-button button dash home-assistant home-automation ifttt iot openhab python

Last synced: 2 months ago
JSON representation

Hack your Amazon Dash to run what you want.

Lists

README 

        



.. image:: https://raw.githubusercontent.com/Nekmo/amazon-dash/master/amazon-dash.png

    :width: 100%



|



.. image:: https://raw.githubusercontent.com/Nekmo/amazon-dash/pip-rating-badge/pip-rating-badge.svg

  :target: https://github.com/Nekmo/amazon-dash/actions/workflows/pip-rating.yml

  :alt: pip-rating badge



.. image:: https://img.shields.io/github/actions/workflow/status/Nekmo/amazon-dash/test.yml?style=flat-square&maxAge=2592000&branch=develop

  :target: https://github.com/Nekmo/amazon-dash/actions?query=workflow%3ATests

  :alt: Latest Tests CI build status



.. image:: https://img.shields.io/pypi/v/amazon-dash.svg?style=flat-square

  :target: https://pypi.org/project/amazon-dash/

  :alt: Latest PyPI version



.. image:: https://img.shields.io/pypi/pyversions/amazon-dash.svg?style=flat-square

  :target: https://pypi.org/project/amazon-dash/

  :alt: Python versions



.. image:: https://img.shields.io/codeclimate/maintainability/Nekmo/amazon-dash.svg?style=flat-square

  :target: https://codeclimate.com/github/Nekmo/amazon-dash

  :alt: Code Climate



.. image:: https://img.shields.io/codecov/c/github/Nekmo/amazon-dash/master.svg?style=flat-square

  :target: https://codecov.io/github/Nekmo/amazon-dash

  :alt: Test coverage



.. image:: https://img.shields.io/github/stars/Nekmo/amazon-dash?style=flat-square

     :target: https://github.com/Nekmo/amazon-dash

     :alt: Github stars



**DEVELOPMENT BRANCH**: The current branch is a development version. Go to the stable release by clicking

on `the master branch `_.



Amazon-dash is still alive

##########################

Amazon has abandoned the Amazon-dash buttons, but

`this project wants to keep them alive `_. However, we are looking

for alternatives. If you have suggestions you are welcome to open an incident. All suggestions are welcome.

You can open an issue with your suggestions.



Python Amazon Dash

##################

Hack your Amazon Dash to run what you want. Without welders. For the entire family.



This program written in Python runs in daemon mode waiting for someone in the same

network to press a configured Amazon Dash button. It is not necessary to know

programming to use this program. Amazon-Dash executes **commands by command line,

calls a url and more**. This program works well on a **Raspberry PI** or on computers

with few resources.



1. **Install** Amazon Dash:



.. code:: console



    $ sudo pip3 install amazon-dash  # and after:

    $ sudo python3 -m amazon_dash.install



Also available on `AUR `_ and

`FreeNAS `_. You can also use ``pip2`` and

``python2`` if your system only has Python2, but Python 3 is the recommended version. See other installation

methods `in the documentation `_.



**Note:** It may also be necessary to install ``tcpdump`` on your system (in Debian ``apt install tcpdump``).



2. **Hack and configure Wi-Fi**:



You must hack your button with the `hack-device command `_

if you have never used it. Then you must `configure the Wifi connection

`_. You can skip this step if you have

already configured the Wi-Fi connection to the router.



3. **Avoid a connection to Amazon servers**



Since 2020 your buttons can be bricked in an update from Amazon servers. To continue using your buttons you must

configure your router to block Internet connections from the buttons. More info in

`the Amazon-dash documentation `_.



4. Use *discovery mode* **to know the mac of your Dash** (Run the program, and then press any button). You can

skip this step if you already know the mac address:



.. code-block:: console



    $ sudo amazon-dash discovery



5. Edit **config file** (``/etc/amazon-dash.yml``):



.. code-block:: yaml



    # amazon-dash.yml

    # ---------------

    settings:

      delay: 10

    devices:

      0C:47:C9:98:4A:12: # Command example

        name: Hero

        user: nekmo

        cmd: spotify

      AC:63:BE:75:1B:6F: # SSH example

        name: Tassimo

        cmd: door --open

        ssh: 192.168.1.23:2222

      AC:63:BE:67:B2:F1: # Url Webhook example

        name: Kit Kat

        url: 'http://domain.com/path/to/webhook'

        method: post

        content-type: json

        body: '{"mac": "AC:63:BE:67:B2:F1", "action": "toggleLight"}'

        confirmation: send-tg

      40:B4:CD:67:A2:E1: # Home Assistant example

        name: Fairy

        homeassistant: hassio.local

        event: toggle_kitchen_light

      18:74:2E:87:01:F2: # OpenHAB example

        name: Doritos

        openhab: 192.168.1.140

        item: open_door

        state: "ON"

        confirmation: send-pb

      44:65:0D:75:A7:B2: # IFTTT example

        name: Pompadour

        ifttt: cdxxx-_gEJ3wdU04yyyzzz

        event: pompadour_button

        data: {"value1": "Pompadour button"}

    confirmations:

      send-tg:

        service: telegram

        token: '402642618:QwGDgiKE3LqdkNAtBkq0UEeBoDdpZYw8b4h'

        to: 24291592

        is_default: false

      send-pb:

        service: pushbullet

        token: 'o.BbbPYjJizbPr2gSWgXGmqNTt6T9Rew51'

        is_default: false



**UPGRADE** from `previous versions `_



The following execution methods are supported with your Amazon Dash button with this program:



================================  ================================  ================================

.. image:: https://goo.gl/VqgMZJ  .. image:: https://goo.gl/a6TS7X  .. image:: https://goo.gl/zrjisq

`System command`_                 `Call url`_                       `Homeassistant`_

.. image:: https://goo.gl/Cq4bYC  .. image:: https://goo.gl/L7ng8k

`OpenHAB`_                        `IFTTT`_

================================  ================================  ================================



Amazon-dash also allows you to **send a confirmation** after pressing a button. You will also receive a message in

case of failure. **Telegram** and **Pushbullet** are supported.



For more information see

`the documentation of the configuration file `_.



6. Run the **daemon**:



If you use a **Systemd** system *(Debian 8+, Fedora 15+, Ubuntu 15.04+, Arch Linux 2012+, OpenSUSE 12.1+, and more)*

execute:



.. code-block:: console



    $ sudo systemctl start amazon-dash



To run Amazon-dash at **startup**:



.. code-block:: console



    $ sudo systemctl enable amazon-dash



To run Amazon-dash manually look at `the documentation `_.



Docker

======

Using Amazon Dash within docker is easy! First, pull the Docker image:



.. code-block:: console



    $ docker pull nekmo/amazon-dash:latest



Then, create a container and run Amazon Dash itself:



.. code-block:: console



    $ docker run -it --network=host \

                 -v :/config/amazon-dash.yml \

                 nekmo/amazon-dash:latest \

                 amazon-dash run --ignore-perms --root-allowed \

                                 --config /config/amazon-dash.yml



Join the community

==================

Do you need ideas on how to use Amazon Dash? See what the community does with this project. Some examples:



* `The Simpsons Random Episode `_

* `Shopping list in Google Keep `_

* `Play a audio `_



See all the examples `in the community`_.



.. _System command: http://docs.nekmo.org/amazon-dash/config_file.html#execute-cmd

.. _Call url: http://docs.nekmo.org/amazon-dash/config_file.html#call-url

.. _Homeassistant: http://docs.nekmo.org/amazon-dash/config_file.html#homeassistant-event

.. _OpenHAB: http://docs.nekmo.org/amazon-dash/config_file.html#openhab-event

.. _IFTTT: http://docs.nekmo.org/amazon-dash/config_file.html#ifttt-event

.. _in the community: http://docs.nekmo.org/amazon-dash/community.html