Users Guide » History » Revision 56
Revision 55 (Hammel, 29 Sep 2019 17:47) → Revision 56/67 (Hammel, 01 Oct 2019 20:18)
h1. Ironman Users Guide
table{border-collapse;width:100%}.
|={font-size:140%;margin-bottom:15px;background-color:#fdd}. This document is under development and is likely not accurate at this time. |
{{>toc}}
In this document the term _host system_ refers to a Linux desktop or laptop that will be used to download and install software onto an SD card.
h2. Overview
_*Ironman*_ is a home automation project based on the PiBox build system. It supports a Nest-like monitor for controlling Arduino based sensors, cameras and remote voice control.
table{align=center}.
|!{width:640px}http://redmine.graphics-muse.org/attachments/download/114!|
|={font-size:120%;margin-bottom:15px;background-color:#dff}. *Design Intent of the Ironman Project* |
|=. Mark I release is in progress. Mark II and Mark III are future development plans. |
_*Ironman*_ consists of the following components.
| *Monitor* | The Nest-like control hub based on a Raspberry Pi 2/3 and the official 7" touchscreen display |
| *Sensors* | Arduino based devices, such as door alarms and cameras, running code based on a sensor and camera templates for pairing and secure communication with the Monitor |
| *Jarvis* | A Java application that supports voice control of Monitor managed devices |
| *Controllers* | Network enabled control of Monitor managed devices |
h3. Security
_*Ironman*_ supports AES encrypted communication with IoT sensors and Jarvis interfaces.
h3. What it is
_*Ironman*_ is a do-it-yourself system, where you buy the parts and assemble them as described, modifying the provided code to suit your needs and handling flashing and maintenence. _*Ironman*_ is designed to allow you to build your own home automation system where you specify the devices you want to control and how you want to control them.
h3. What it is not
_*Ironman*_ is not a product. It is not intended for anyone other than Makers (aka DIY'ers) who like to tinker and see not just how to assemble things but why they actually work.
While the Users Guide is intended to bring up a currently working version of _*Ironman*_ with limited sensor and camera support, if you aren't prepared to deal with writing code or flashing devices and dealing with electrical circuits then _*Ironman*_ is not for you.
h2. The Ironman Monitor
The _*Ironman*_ Monitor runs on a Raspberry Pi 2 or 3 and provides a central hub for management of home automation devices. It uses a 7" touch screen display and a mechanical switch to manage pairing with IoT devices and Jarvis interfaces.
h3. Installation Prerequisites
* A "Raspberry Pi 2 or 3":https://www.adafruit.com/product/3055
* The official "Raspberry Pi 7inch touchscreen display":https://www.sparkfun.com/products/13733
* The Pi 2/3 requires a "V / 2A power supply":https://www.adafruit.com/product/1994. For best results, use a power supply rated to at least 5.25V to avoid under voltage conditions. For ease of use the power supply cable should include an "on/off switch":https://www.adafruit.com/product/2379.
* A keyboard is required for initial installation. A "wireless keyboard":https://www.adafruit.com/product/922 should work as will a wired keyboard. The keyboard will not be needed for normal operation but can be helpful in debugging.
* The Pi 2/3 requires a microSD card that is at least 4GB. A mechanism for using the SD card on your host system is needed, such as an SD card USB adapter or an SD port on your laptop.
* A mechanical switch, such as a "SPDT":https://www.electronicshub.org/switches/#Single_Pole_Double_Throw_Switch_SPDT, should be connected to the Pi GPIOs to allow for pairing the Monitor with IoT Sensors and Jarvis interfaces. The ASCII diagram below describes the setup. The LED is off in normal mode, lit in Config Mode, and off in Pair Mode until something tries to pair with the Pi which then turns on the LED for 3 seconds. Config and Pair mode operations ared discussed in later sections. A Fritzing Diagram (attachment:IronmanMonitorSwitch.fzz) is available for this hardware component.
!>{width:300px}IronmanMonitorSwitchBreadboard.png(Ironman Monitor Switch)!
<pre>
___
Config/Pair Mode |---| Normal Mode
---------
| |
---------
connector pins --> | | |
| | ------ Not connected
| |
| ----330 Ohm R-----
| | |
| | +-----LED------
| | |
RPi pin 7 9 13
RPi GPIO 4 G 27
</pre>
* You will need to have sudo access for your Linux user id.
h3. Generating the SD Card for the Pi
* Download the RPi 2 Development Platform
** _wget <url>_
** Unpack the archive to a directory called *image*.
* Download the _*Ironman*_ Package Collection
** _wget <url>_
** Unpack the archive to a directory called *package*.
* In a terminal window run: _dmesg -w_
* Insert the microSD card and note the device name displayed for the newly added card as displayed in the _dmesg -w_ terminal window. It should be something like /dev/sdb or /dev/sde.
* Kill the _dmesg -w_ command with Ctrl-C.
From the *image* directory
* Format the SD card
** _sudo ./mksd.sh -d <device name>_
** where <device name> is the name you noted from the output of _dmesg -w_.
* Mount the boot partition from the sd card:
** _sudo mkdir -p /mnt/boot_
** _sudo mount <device name>1 /mnt/boot_
** where <device name> is the name you noted from the output of _dmesg -w_.
* Install the Development Platform to the SD card
** _sudo ./mkinstall.sh -b /mnt/boot -d <device name>2_
** where <device name> is the name you noted from the output of _dmesg -w_.
From the *package* directory
* Mount the root partition from the sd card:
** _sudo mkdir -p /mnt/root_
** _sudo mount <device name>1 /mnt/root_
* Copy the _*Ironman*_ Package Collection files to /root of the root partition on the SD card
** _sudo cp *.opk /mnt/root/root_
Make sure all writes to the SD card have completed
* _sync;sync;sync_
Unmount the SD card partitions
* _sudo umount /mnt/boot_
* _sudo umount /mnt/root_
Remove the SD card from the host system and insert it into the Raspberry Pi 2.
h3. First time boot
Power on the Monitor and wait for it to complete installation. During this time the display may be upside down. Once initial installation is complete the display will be right side up.
Once the display shows two xterm windows it is ready to complete installation. Type the following command to install the _*Ironman*_ package collection.
opkg install *.opk
Wait for this command to complete, then reboot the system either by power it off and back on or by typing the command
reboot
The Monitor is now fully installed and ready for use. At this point the keyboard can be removed though you may want to leave it connected for debugging purposes.
h3. First time configuration
!>{width:300px}ironman-config-ui.png(Ironman Config UI)!
Turn the power off and set the Mode switch to Config/Pair, then power the Monitor back on. The LED should light indicating the Monitor is ready to be configured.
Use a smartphone or laptop with wifi to connect to the "ironman" SSID. The default password is _ironman1_. Then use a browser to connect to the Ironman web UI at
http://192.168.36.1:1337
The display should be as shown in the adjacent photo. There are two network domains to configure, as described in the following table.
|_. Domain |_. Description |
| Internet Connection | This is how the Monitor will connect to your home network. |
| Sensors Network | This is how the Monitor will communicate with your IoT devices. |
After both networks are configured, power off the Monitor and set the Mode switch to Normal, then power the Monitor on. The Monitor is now ready to use with IoT sensors, Jarvis and controllers.
h3. Network configuration
The Monitor's hardware supports WiFi B/G/N networks. However, in order to use the Monitor as both a WiFi client on the local
network and as an Access Point for IoT devices, only G networks are supported by the Ironman software.
h4. Internet Connection
The Internet Connection domain configures the Monitor to connect to your local network.
|_. Field |_. Description |
|Location |Unique name for this monitor, such as Bedroom or Office. This name is used to identify monitors by name via commands from Jarvis or other remote controllers|
|SSID |Network name configured on your router for your local WiFi network. |
|Security | Type of security used on your router. Only WPA2 Personal and WPA2 Enterprise are currently supported. |
|Password | Your router's password, specifically for the SSID entered previously. |
The *Show Password* button will display the password typed in the Password field. By default this button is not enabled, causing the Password field to be hidden using asterisks for each character.
h4. Sensor Network
The Sensor Network domain is used to configure the Monitor's private network used with IoT devices. Data on this network is not routed to the Internet Connection and data from the Internet Connection domain are not routed to the Sensor Network.
|_. Field |_. Description |
|SSID |Network name for this private WiFi network. This name will be hidden on Wifi scans.|
|Channel | Channel to use. Select a channel that has low use in your neighborhood. Only a subset of channels on G networks are available. This will be addressed in future releases. |
|Password | Password IoT devices should use to gain access to the specified SSID. |
|Static IP | An IP address to give the Monitor as it acts as an Access Point. This should be a Class C subnet for the network, which limits the number of IoT devices that can be managed by a single Monitor to 254. |
The *Show Password* button will display the password typed in the Password field. By default this button is not enabled, causing the Password field to be hidden using asterisks for each character.
h2. IoT Sensor
h3. Sensor Types
There is currently only one sensor type: imlightsw (light switch).
The sensor template GIT repository, which is the imlightsw repo, is intended to be used to design additional sensor types, such as door and window alarms, window shade controllers, environment sensors and so forth.
h4. Light Switch
!>{width:300px}imlightsw.png(Ironman Light Switch)!
This prototype light switch (attachment:imlightsw-with-relay-2.fzz) uses a relay to power an LED on and off. The breadboard power supply can be replaced with an "HLK-PM01":http://www.hlktech.net/product_detail.php?ProId=54 and an "LM3671 5V to 3.3v buck converter":https://www.adafruit.com/product/2745 to power the board from mains (110v).
The FTDI connection is used to connect and "FTDI Basic board":https://www.sparkfun.com/products/9873 so that a the output from the ESP-01 can be viewed in a terminal program.
The ESP-01 has a Blue LED that is used to provide visual information using blink patterns.
h5. Config Button
This button has multiple uses, depending on where it is used.
_AP Config Mode_
AP Config Mode means the device is running as an WiFi Access Point, allowing you to connect to it via a web browser to configure the device for use on a Monitor's Sensor network.
* AP Config mode is disabled by default, that is, when the Config Button is in the off position.
* If Config Button is ON at boot, imlightsw enters AP config mode. In this mode the LED will blink twice and then stop. Once the device is connected to a Monitor's Sensor network it will blink 4 times.
* After configuration is complete, button must be set OFF and device power cycled.
_Pair Mode_
Pair Mode is used to pair the imlightsw device with an Ironman Monitor. Pairing involves the exchange of secret keys that will be used to encrypt messages between the Monitor and the imlightsw device.
* The Config Button is OFF at boot.
* Later the Config Button is turned on and imlightsw enters PAIR mode. In this mode the blue LED stays on.
* After the device has paired with a Monitor the blue LED blinks.
* The Config Button must be turned off for normal operation.
h5. Blue LED Blink Patterns
A _blink_ implies the LED turns on and then off.
|_. LED State |_. Blink Speed |_. Blink Count |_. Device Mode |
|Blink | 1/sec | 2 | Entered AP Config Mode |
|Blink | 1/sec | 4 | Device is connected to monitor |
|Blink | 1/.125 sec | 5 | Device failed to connect to monitor |
|Solid On | N/A | N/A | Entered Pair Mode |
|Blink | 2/.150 sec then 1/.200 sec | continuous | Waiting to Pair with Monitor|
|Blink | 1/.100 sec | 3 | Not currently paired with Monitor|
h5. Reset Button
The Reset Button is used to return the imlightsw to it's initial state, prior to configuration and pairing. If the device is reset it will need to be configured to use the network again as well as paired with an Ironman Monitor before it can be managed.
* The Reset Button is ON at boot.
* The device removes all configuration from itself.
* The Reset Button must be turned off, then the device can be rebooted and reconfigured.
table{border-collapse;width:100%}.
|={font-size:120%;margin-bottom:15px;background-color:#fdd}. The Reset Button is not connected in code currently due to the limit on GPIO pins in the ESP-01. To fully reset the ESP-01 you must compile the code with RESET=1, flash and run the code, then recompile with RESET=0 (or not specified on the command line) and flash again. |
h3. Setting up to use the code
h4. Prerequisites
* ESP-01 connected to your serial port using an FTDI board
** Try the one from "SparkFun":https://www.sparkfun.com/products/9873
* You have proper power to the ESP-01
** You need 3.3V for the ESP-01.
** You need 5V for the power relay.
** Try this board from "Amazon":https://smile.amazon.com/gp/product/B010UJFVTU/ref=oh_aui_detailpage_o03_s00?ie=UTF8&psc=1. It can supply both 3.3V and 5V power on a half size breadboard like this one from "Adafruit":https://www.adafruit.com/product/64
* Other parts you might want
** ESP-01 "breadboard adapter":https://www.addicore.com/ProductDetails.asp?ProductCode=AD-BB-ADTR
** "Logic Level Converter":https://www.sparkfun.com/products/12009
** "5V 1-Channel Relay":https://www.ebay.com/itm/5V-10A-one-1-Channel-Relay-Module-With-optocoupler-For-PIC-AVR-DSP-ARM-Arduino/310636242802?ssPageName=STRK%3AMEBIDX%3AIT&_trksid=p2057872.m2749.l2649 board
h4. Arduino Setup
This build doesn't use the Arduino UI. It makes use of GNU Make to build the code without the UI. However, it still requires components provided via the Arduino UI distribution, along with extra libraries.
* Make a directory to hold required repository clones - call it _repos_.
* Change to _repos_
* Clone the esp8266/Arduino repository
** git clone https://github.com/esp8266/Arduino.git
** cd Arduino
** git checkout tags/2.1.0
** cd ..
* Clone the makeEspArduino repo
** git clone https://github.com/plerup/makeEspArduino.git
** cd makeEspArduino
** If ESP_ROOT points to a symlink but doesn't use a trailing slash: _git checkout d13cf13602f2acc9be3baa3315911a4c037dc62d_
** Otherwise: _git checkout tags/4.13.0_
** cd ..
* Install libraries
** cd Arduino/libraries
** clone extra libraries (see Required Libraries below)
* If your USB/FTDI connector shows up as something other than /dev/USBFTDI then set SERIALDEV
** export SERIALDEV=/dev/_your device_
* aJson has a [bug with flush()](https://github.com/interactive-matter/aJson/issues/89) that prevents compilation. Apply the patch found in the lightsw repository's patch directory.
|_. Required Arduino libraries |_. URL |
|AES| https://github.com/spaniakos/AES/|
|Timer| https://github.com/JChristensen/Timer.git|
|WiFiManager| https://github.com/tzapu/WiFiManager.git
tag: 0.12
commit: 04d47882a7d662b46bb1b1dbecfe786e5bc9efa4 |
|aJson| https://github.com/interactive-matter/aJson.git
Requires patch in patch/ directory. |
|aREST| https://github.com/marcoschwartz/aREST.git|
|arduino-base64| https://github.com/adamvr/arduino-base64
Requires patch in patch/ directory. |
Notes on libraries
* cd esp8266/libraries, then clone the extra libraries there
* AES library: Remove the examples or the build will probably fail.
h4. The imlightsw Code
The code is required to do flash updates to the ESP-01. Before starting, be sure to install "cdtools":https://gitlab.com/cdtools/cdtools.
* Clone the software: _git clone https://gitlab.com/xarduino/lightsw.git_
* Copy _lightsw/docs/arduino.sh_ to your cdtools directory (_~/bin/env_) and edit as appropriate.
** Be sure to set ESPTOP as described in arduino.sh.
* Setup your environment for the build:
** _. cdtools_
** _ard lightsw_
** _cd?_ (to see what you can do with cdtools in this repository)
* Change to this repos directory: _cdx_
h3. Flashing the firmware
!>{width:300px}imlightsw-flasher.png(Ironman Light Switch Flasher)!
This prototype light switch flasher (attachment:imlightsw-flasher.fzz) is used to program the ESP-01. A separate flasher circuit like this is required due to the limited number of GPIO pins on the ESP-01.
The "FTDI Basic board":https://www.sparkfun.com/products/9873 is required to connect the ESP-01 to a computer over a USB port. On Linux, the port will show up as /dev/ttyUSB0 or similar.
The code must be built before it can be flashed to the ESP-01.
* _make_ table{border-collapse;width:100%}.
** Binary is in ../bld/*.bin
* _make RESET=1_
** This causes stored data in the ESP-01 to be erased on power up. |={font-size:120%;margin-bottom:15px;background-color:#fdd}. After that, you need to reflash without this flag.
* _make SERIAL=1_
** This causes the code to use the TX line TBD - instructions for serial output for debugging purposes. If this is not set then the blue LED is used instead and there is not serial console output.
Finally, to flash the updated image to the ESP-01 use the _upload_ target.
* _make upload_
** _upload_ target is in makeEspArduino.mk, not in local Makefile.
flashing |
h3. Power On
An IoT sensors must be configured to operate on the same network as the Monitor's Sensor Network. Once this has been done the IoT sensor and the Monitor can be paired. An IoT device can only be paired with a single Monitor.
h4. Configuring an IoT Device Network
* Set the Mode button to Config.
* Power on the IoT device.
* TBD
h3. Pairing with a Monitor
* With the Monitor running, set the Monitor Mode switch to Pair.
* Power on the IoT Sensor and wait for it to pair with the Monitor. When it's done, the LED will light for 3 seconds.
* Disable the Mode switch on the Monitor.
table{border-collapse;width:100%}.
|={font-size:140%;margin-bottom:15px;background-color:#fdd}. *WARNING!* |
|={font-size:120%;margin-bottom:15px;background-color:#fdd}. Leaving the Mode switch turned to Pair will allow random devices to attempt to pair with the Monitor. This is a security risk. The Mode switch should only be set to Pair long enough to pair with an IoT device. |
h2. Jarvis
h3. Prerequisites
h3. Pairing with a Monitor
* With the Monitor running, set the Monitor Mode switch to Pair.
* TBD
h3. Supported Commands
h2. Addendums
h3. Ironman Packages
|_. Package |_. Repository |_.Contents |_. Description |
|imcore |monitor | |Package that updates a PiBox Development Platform for use with Ironman. Includes network configuration updates and other config files. |
|imwww |www | |Contains two web servers |
| ||imwww |Provides network configuration interface for Monitor |
| ||imrest |Provides IoT/Jarvis REST API. Updates /etc/ironman directories with registrations.|
|imgpio |gpio | |Command line tool for querying GPIO pins using syfs interface. |
|launcher |launcher | |Ironman specific launcher that adds clock interface to front panel. |
|pisensor |pisensor | |Provides UI for managing sensors. Uses inotify to watch for changes to /etc/ironman/iot directory. |
|picam |picam | |Generic console camera interface (same as PiBox media systems) |
|Misc |appmgr, piboxd, omxplayer, pmsui, psplash, mjpg-streamer| |Same packages as in PiBox media system, unmodified|
h3. Source Code Repositories
* PiBox
** "Development Platform":https://gitlab.com/pibox/pibox
** "appmgr":https://gitlab.com/pibox/appmgr
** "mjpg-streamer":https://gitlab.com/pibox/mjpg-streamer
** "omxplayer":https://gitlab.com/pibox/omxplayer
** "piboxd":https://gitlab.com/pibox/piboxd
** "picam":https://gitlab.com/pibox/picam
** "pmsui":https://gitlab.com/pibox/pmsui
** "psplash":https://gitlab.com/pibox/psplash
* Ironman
** "gpio":https://gitlab.com/xironman/gpio
** "launcher":https://gitlab.com/xironman/launcher
** "monitor":https://gitlab.com/xironman/monitor
** "pisensor":https://gitlab.com/xironman/sensors
** "www":https://gitlab.com/xironman/www
** "meta build":https://gitlab.com/xironman/meta
* Arduino
** "Sensor Template (imlightsw)":https://gitlab.com/xarduino/lightsw
h3. Fritzing Models
* ESP-01 Flasher: attachment:imlightsw-flasher.fzz
* Light Switch: attachment:imlightsw-with-relay-2.fzz
** "ESP8266":https://github.com/ydonnelly/ESP8266_fritzing
** "Keyes_SRly":https://github.com/rwaldron/fritzing-components
** "Breadboard Power Supply":https://github.com/AchimPieters/Fritzing-Custom-Parts/blob/master/YwRobot%20Breadboard%20Power%20Supply.fzpz
** "Hilink HLK-PM01":http://forum.fritzing.org/t/hlk-pm01-ac-dc-220v-to-5v/381
* Monitor Switch: attachment:IronmanMonitorSwitch.fzz
h3. Networking Internals
<pre>
wlan0
* This interface is used for configuration of the Monitor.
* Configured on the 192.168.36.0 subnet.
** See /etc/network/dhcpd.conf.aponly
uap0
* This interface is used as an access point for IoT devices.
* Configured on the 192.168.3.0 subnet.
** See /etc/network/dhcpd.conf.uap and dhcpd.conf.uap.tmpl
** The template is used to change the base subnet through the web interface.
** The SSID is _ironman_.
</pre>
h3. Pair Button Usage
<pre>
Pair/Config button is GPIO 4 (RPi pin 7)
Pair/Config LED is GPIO 7 (RPi pin 13)
LED should only be lit on boot if button is enabled (in Config mode).
In this case, we're in Config Mode to configure the networks.
The web server (imwww) is on SSID _ironman_ at 192.168.36.1:1337.
LED is off on boot if button is disabled (in Pair Mode).
If in Pair Mode
Start hostapd for aponly
Start dhcpd for aponly on wlan0
Start imrest web service on port 8165 for IoT devices and Jarvis interfaces.
If in Config Mode
Start wpa_supplicant on wlan0
Create uap0 device as virtual device on wlan0
Start dhcpd on uap0
Start hostapd on uap0
Start imwww for network configuration of the Monitor.
</pre>
h3. Monitor IoT Directories
<pre>
/etc/ironman/iot Registration directory for IoT devices
/etc/ironman/jarvis Registration directgory for Jarvis interfaces
</pre>
h2. Privileged Apps
Some applications must be privileged in order to perform their functions, such as the camera. The terminal application is not privileged by default. It can be made privileged with the following steps.
# Power down the Monitor.
# Remove the SD card and mount it into your laptop or desktop computer.
# Edit this file on the SD card: /etc/appmgr.priv
# Add this line: /usr/bin/xterm
# Save the file and unmount the SD card.
# Remove the SD card from the laptop or desktop.
# Replace the SD card in the Monitor.
# Power up the Monitor.
The terminal application will now have privileged access on the monitor.
h2. File Attachments