Set up a development or production environment of the Dwyl smart home system.
This document is a work in progress, please file an issue for any problems you find setting up the development environment
This is a getting started guide for the Dwyl smart home system. It contains everything you need to set up your own system; either for development or production.
It contains no infomation on any of the protocols used or how the system works, this can be found here: TODO: Design documentation
It is a complex system with lots of moving parts, and unfortunately setting it up requires some time and configuration. We've tried to make this as simple as possible, with only two repositories needed to make a working system. You also need to make sure you have compatible hardware, found in the "prerequisites" section.
You should be able to go through this guide with no previous knowledge of Iot, Elixir, or Nerves. However, we do recommened you go though our Learn Nerves tutorial first so you know why things are happening and have Nerves setup on your computer. Some knowledge of wiring up GPIO headers on a Raspberry Pi would also go a long way.
Although we have no "hard" requirements on the specifics - (it should work on any Nerves compatible hardware) - this is the hardware the systems been designed for and will work best on.
| Hardware | Notes |
|---|---|
| Raspberry Pi 3+ / Zero | Or anything better with WiFi support |
| PN532 Development board | Find on with UART support |
| Necessary Connectors | You'll need at least 4 female-female wires 1 |
| Hub Server | Anything that can run a server, another Raspberry Pi, or I used my laptop for development. |
1 : You can also use a breadboard with normal F-to-M jumper wires
You'll need Elixir and Nerves setup on your computer. If you don't have this, please follow the first part of our Learn Nerves tutorial.
You'll also need postgres running where your hosting the hub server.
API Development software. Our hub currently does not have a GUI, only a REST API. I recommend using Insomnia Core as there's a workspace already setup in the Hub repo.
You'll also need a Dwyl API key, follow the instructions here: https://github.com/dwyl/auth_plug#2-get-your-auth_api_key-
-
Clone the necessary repositories:
git clone https://github.com/dwyl/smart-home-auth-server git clone https://github.com/dwyl/smart-home-firmware -
If you haven't yet, set your DWYL_API_KEY/AUTH_API_KEY
export AUTH_API_KEY=<Your Key> -
Wire up the Raspberry Pi to the PN532 board over Universal Asynchronous Receiver/Transmitter (UART) protocol
| Pi | PN532 |
|---|---|
| 5v | 5v |
| Ground | Ground |
| TXD (GPIO 14) | RX |
| RXD (GPIO 15) | TX |
Use the linked GPIO diagram to work out which pins which. Your development board should have pins labelled.
Then link the door strike relay up to to the Raspberry Pi by connecting GPIO Pin 4 to IN1.
You may also need to connect power to your Door servo. This can be done through the same 5v header
as the PN532 development board is using.
Change directory into the hub server folder:
cd smart-home-auth-server/
and then setup and run the server
mix setup
mix phx.server
This should be all you have to do.
This is a pain, we need to fix this
Visit https://localhost:4000/api/v0/users in your browser. This should trigger an Authentication flow and redirect you to the Dwyl auth site. Log in and wait for you to be redirected back.
Look in the URL, you should see a long string of letters after ?jwt=.
Copy this.
Open Insomnia, go to Get User on the sidebar.
- Click Auth dropdown
- Bearer Token
- Paste the token you copied into
token - Press send, this should apply a global auth cookie
This should only have to be done once.
Navigate to the firmware repository, e.g.
cd ../smart-home-firmware
Change the :smart_home_firmware, :hub config value in both
config/config.exs and config/target.exs to the IP and port of
the hub server you setup in the previous steps.
On macOS, you can option-click your network connection to get your IP, and the port will default to 4000 on Phoenix.
config :smart_home_firmware,
hub: "192.168.0.14:4000"We need to install dependencies to install and run Scenic on our host, see Learn Scenic. On macOS we can just run:
brew install glfw3 glew pkg-config
to install all required dependencies.
Then create a firmware with your WiFi credentials and burn it to an SD card. If your not using WiFi, skip these environment vars, it will still connect over Ethernet automatically:
NERVES_NETWORK_SSID=<Wifi Name> NERVES_NETWORK_PSK=<Wifi pass> mix firmware.burn
You could also save these to a .env file to avoid writing out every time -
I just keep mine in terminal history with fish.
Insert the SD card into the Pi and boot it up.
After around a minute, if everything works, you should see a message similar to
[info] lock-8650 has come online
appear in your hub servers logs. This means everything is configured correctly, and the locks can correctly connect to the hub server.