Metadata-Version: 2.1
Name: hasspad
Version: 0.1.1
Summary: 
Home-page: https://github.com/kvchen/hasspad/
License: MIT
Keywords: Home Assistant,keybow
Author: Kevin Chen
Author-email: keffcat@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: PyYAML (>=5.4.1,<6.0.0)
Requires-Dist: RPi.GPIO (>=0.7.0,<0.8.0)
Requires-Dist: click (>=7.1.2,<8.0.0)
Requires-Dist: keybow (>=0.0.3,<0.0.4)
Requires-Dist: pydantic (>=1.7.3,<2.0.0)
Requires-Dist: rich (>=9.8.2,<10.0.0)
Requires-Dist: spidev (>=3.5,<4.0)
Requires-Dist: websockets (>=8.1,<9.0)
Project-URL: Repository, https://github.com/kvchen/hasspad/
Description-Content-Type: text/markdown

# hasspad

A macropad interface for Home Assistant using the Pimoroni Keybow

## Installation

First, provision the device. Flash `raspios` and ensure `ssh` and WiFi access are enabled.
This can be done by writing a blank `ssh` file and a `wpa_supplicant.conf` file to the BOOT mount.

Once you are able to login to the device, perform some basic setup to set the hostname and enable SPI:

```
sudo raspi-config nonint do_hostname hasspad
sudo raspi-config nonint do_spi 1
sudo reboot
```

Install `docker` and `docker-compose`:

```
curl -sSL https://get.docker.com | sh
sudo usermod -aG docker pi

sudo apt-get install -y libffi-dev libssl-dev python3 python3-pip
sudo pip3 install docker-compose
```

The last thing you need to do is ensure environment variables are set that are used to authenticate with Home Assistant.
You can also pass these in as flags or modify `docker-compose.yml`:

```
export HASSPAD_URI="ws://homeassistant.local:8123/api/websocket"
export HASSPAD_ACCESS_TOKEN="abcd"
```

Finally, just run `docker-compose up`.

