README.md
author Luke Hoersten <luke@hoersten.org>
Thu, 01 Mar 2018 17:52:55 -0600
changeset 20 49b20c7a10e8
parent 2 3ab597628612
child 24 bba43c5fbf59
permissions -rw-r--r--
Updated README.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
30d8bcb1ebb4 Initial public commit.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     1
# Raspberry Pi Homekit Door Accessory
30d8bcb1ebb4 Initial public commit.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     2
2
3ab597628612 Updated Readme.
Luke Hoersten <luke@hoersten.org>
parents: 0
diff changeset
     3
Using
3ab597628612 Updated Readme.
Luke Hoersten <luke@hoersten.org>
parents: 0
diff changeset
     4
a
3ab597628612 Updated Readme.
Luke Hoersten <luke@hoersten.org>
parents: 0
diff changeset
     5
[Raspberry Pi Zero W](https://www.raspberrypi.org/products/raspberry-pi-zero-w/) and
3ab597628612 Updated Readme.
Luke Hoersten <luke@hoersten.org>
parents: 0
diff changeset
     6
[Pimoroni Automation pHAT](https://shop.pimoroni.com/products/automation-phat),
3ab597628612 Updated Readme.
Luke Hoersten <luke@hoersten.org>
parents: 0
diff changeset
     7
make a simple circuit-based door lock and door bell intercom into a
20
49b20c7a10e8 Updated README.
Luke Hoersten <luke@hoersten.org>
parents: 2
diff changeset
     8
Siri-controlled HomeKit smart accessory. Siri integration is provided
2
3ab597628612 Updated Readme.
Luke Hoersten <luke@hoersten.org>
parents: 0
diff changeset
     9
by [HAP-NodeJS](https://github.com/KhaosT/HAP-NodeJS).
3ab597628612 Updated Readme.
Luke Hoersten <luke@hoersten.org>
parents: 0
diff changeset
    10
3ab597628612 Updated Readme.
Luke Hoersten <luke@hoersten.org>
parents: 0
diff changeset
    11
## Installation
3ab597628612 Updated Readme.
Luke Hoersten <luke@hoersten.org>
parents: 0
diff changeset
    12
20
49b20c7a10e8 Updated README.
Luke Hoersten <luke@hoersten.org>
parents: 2
diff changeset
    13
Installation is rather involved and handled by
2
3ab597628612 Updated Readme.
Luke Hoersten <luke@hoersten.org>
parents: 0
diff changeset
    14
an [Ansible](https://ansible.com/) playbook.
3ab597628612 Updated Readme.
Luke Hoersten <luke@hoersten.org>
parents: 0
diff changeset
    15
0
30d8bcb1ebb4 Initial public commit.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    16
## Ansible Inventory
30d8bcb1ebb4 Initial public commit.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    17
30d8bcb1ebb4 Initial public commit.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    18
`inventory/host_vars/raspberrypi.local.yaml`
30d8bcb1ebb4 Initial public commit.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    19
30d8bcb1ebb4 Initial public commit.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    20
    github_user: "<github user>"
30d8bcb1ebb4 Initial public commit.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    21
    wpa_networks:
30d8bcb1ebb4 Initial public commit.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    22
      - ssid: "<your ssid>"
30d8bcb1ebb4 Initial public commit.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    23
        psk: "<your wifi password>"
2
3ab597628612 Updated Readme.
Luke Hoersten <luke@hoersten.org>
parents: 0
diff changeset
    24
3ab597628612 Updated Readme.
Luke Hoersten <luke@hoersten.org>
parents: 0
diff changeset
    25
## Run Ansible
3ab597628612 Updated Readme.
Luke Hoersten <luke@hoersten.org>
parents: 0
diff changeset
    26
3ab597628612 Updated Readme.
Luke Hoersten <luke@hoersten.org>
parents: 0
diff changeset
    27
`ansible-playbook hap.yaml`