Project

General

Profile

Users Guide » History » Version 27

Hammel, 20 Sep 2019 21:03

1 10 Hammel
h1. Ironman Users Guide
2 1 Hammel
3 7 Hammel
table{border-collapse;width:100%}.
4 8 Hammel
|={font-size:140%;margin-bottom:15px;background-color:#fdd}. This document is under development and is likely not accurate at this time. |
5 7 Hammel
6 2 Hammel
{{>toc}}
7
8 3 Hammel
In this document the term _host system_ refers to a Linux desktop or laptop that will be used to download and install software
9
onto an SD card.
10 1 Hammel
11 10 Hammel
h2. Overview
12
13 17 Hammel
_*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.
14 1 Hammel
15
|!http://redmine.graphics-muse.org/attachments/download/114!|
16
|={font-size:120%;margin-bottom:15px;background-color:#dff}. *Design Intent of the Ironman Project* |
17
|=. Mark I release is in progress.  Mark II and Mark III are future development plans.|
18
19 17 Hammel
_*Ironman*_ consists of the following components.
20 12 Hammel
21
| *Monitor* | The Nest-like control hub based on a Raspberry Pi 2/3 and the official 7" touchscreen display |
22
| *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 |
23
| *Jarvis*  | A Java application that supports voice control of Monitor managed devices |
24
| *Controllers* | Network enabled control of Monitor managed devices |
25
26 1 Hammel
h3. Security
27
28 17 Hammel
_*Ironman*_ supports AES encrypted communication with IoT sensors and Jarvis interfaces.
29 12 Hammel
30
h3. What it is
31
32 17 Hammel
_*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.  
33 12 Hammel
34
h3. What it is not
35
36 17 Hammel
_*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.
37 12 Hammel
38 17 Hammel
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.
39 10 Hammel
40 1 Hammel
h2. The Ironman Monitor
41 3 Hammel
42 17 Hammel
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.
43 3 Hammel
44
h3. Installation Prerequisites
45 1 Hammel
46 11 Hammel
* A "Raspberry Pi 2 or 3":https://www.adafruit.com/product/3055
47
* The official "Raspberry Pi 7inch touchscreen display":https://www.sparkfun.com/products/13733
48
* 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.
49 27 Hammel
* 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.
50 3 Hammel
* 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.
51 16 Hammel
* 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.
52 5 Hammel
53 1 Hammel
<pre>
54 16 Hammel
                      ___
55
   Config/Pair Mode  |---|  Normal Mode
56
                   --------- 
57
                  |         |
58
                   --------- 
59
connector pins -->  |  |  |  
60
                    |  |   ------ Not connected
61
                    |  |
62
                    |  ----330 Ohm R-----
63
                    |  |                |
64
                    |  |  +-----LED------
65
                    |  |  |
66
          RPi pin   7  9  13     
67
         RPi GPIO   4  G  27
68 6 Hammel
</pre>
69 5 Hammel
70
* You will need to have sudo access for your Linux user id.
71 27 Hammel
72 16 Hammel
73 1 Hammel
h3. Generating the SD Card for the Pi
74 3 Hammel
75 1 Hammel
* Download the RPi 2 Development Platform 
76 4 Hammel
** _wget <url>_
77
** Unpack the archive to a directory called *image*.
78 17 Hammel
* Download the _*Ironman*_ Package Collection
79 4 Hammel
** _wget <url>_
80 1 Hammel
** Unpack the archive to a directory called *package*.
81 18 Hammel
* In a terminal window run: _dmesg -w_
82
* 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.
83
* Kill the _dmesg -w_ command with Ctrl-C.
84 4 Hammel
85
From the *image* directory
86 1 Hammel
* Format the SD card
87
** _sudo ./mksd.sh -d <device name>_
88 18 Hammel
** where <device name> is the name you noted from the output of _dmesg -w_.
89 3 Hammel
* Mount the boot partition from the sd card: 
90 4 Hammel
** _sudo mkdir -p /mnt/boot_
91
** _sudo mount <device name>1 /mnt/boot_
92 18 Hammel
** where <device name> is the name you noted from the output of _dmesg -w_.
93 4 Hammel
* Install the Development Platform to the SD card
94
** _sudo ./mkinstall.sh -b /mnt/boot -d <device name>2_ 
95 18 Hammel
** where <device name> is the name you noted from the output of _dmesg -w_.
96 3 Hammel
97 4 Hammel
From the *package* directory
98 3 Hammel
* Mount the root partition from the sd card: 
99 4 Hammel
** _sudo mkdir -p /mnt/root_
100
** _sudo mount <device name>1 /mnt/root_
101 17 Hammel
* Copy the _*Ironman*_ Package Collection files to /root of the root partition on the SD card
102 4 Hammel
** _sudo cp *.opk /mnt/root/root_
103 3 Hammel
104
Make sure all writes to the SD card have completed
105 4 Hammel
* _sync;sync;sync_
106 3 Hammel
107
Unmount the SD card partitions
108 4 Hammel
* _sudo umount /mnt/boot_
109
* _sudo umount /mnt/root_
110 3 Hammel
111 4 Hammel
Remove the SD card from the host system and insert it into the Raspberry Pi 2.
112 1 Hammel
113
h3. First time boot
114
115 26 Hammel
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.
116 22 Hammel
117
Once the display shows two xterm windows it is ready to complete installation.  Type the following command to install the _*Ironman*_ package collection.
118
119
  opkg install *.opk
120
121
Wait for this command to complete, then reboot the system either by power it off and back on or by typing the command 
122
123
  reboot
124
125
The Monitor is now fully installed and ready for use.
126
127
h3. First time configuration
128
129 24 Hammel
!>{width:300px}Ironman-PHP-Config-UI-480w.png(Ironman Config UI)!
130
131 22 Hammel
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.
132
133
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 
134
135
  http://192.168.36.1:1337
136
137 25 Hammel
The display should be as shown in the adjacent photo.  There are two network domains to configure, as described in the following table.
138
139
|_. Domain |_. Description |
140
| Internet Connection | This is how the Monitor will connect to your home network. |
141
| Sensors Network | This is how the Monitor will communicate with your IoT devices. |
142 22 Hammel
143 1 Hammel
h3. Network configuration
144
145 9 Hammel
wlan0
146
147
* This interface is used for configuration of the Monitor.
148
* Configured on the 192.168.36.0 subnet.
149
** See /etc/network/dhcpd.conf.aponly
150
151
uap0
152
153
* This interface is used as an access point for IoT devices.
154
* Configured on the 192.168.3.0 subnet.
155
** See /etc/network/dhcpd.conf.uap and dhcpd.conf.uap.tmpl
156
** The template is used to change the base subnet through the web interface.
157
** The SSID is _ironman_.
158
159
<pre>
160
Pair/Config button is GPIO 4 (RPi pin 7)
161
Pair/Config LED is GPIO 7 (RPi pin 13)
162
	LED should only be lit on boot if button is enabled (in Config mode).
163
		In this case, we're in Config Mode to configure the networks.
164 17 Hammel
		The web server (imwww) is on SSID _ironman_ at 192.168.36.1:1337.
165 9 Hammel
	LED is off on boot if button is disabled (in Pair Mode).
166
	If in Pair Mode
167
		Start hostapd for aponly
168
		Start dhcpd for aponly on wlan0
169
		Start imrest web service on port 8165 for IoT devices and Jarvis interfaces.
170
	If in Config Mode
171
		Start wpa_supplicant on wlan0
172
		Create uap0 device as virtual device on wlan0
173
		Start dhcpd on uap0
174
		Start hostapd on uap0
175
		Start imwww for network configuration of the Monitor.
176
177
/etc/ironman/iot		Registration directory for IoT devices
178
/etc/ironman/jarvis		Registration directgory for Jarvis interfaces
179 14 Hammel
180
Apps
181
imcore					Package that updates a PiBox Development Platform for use with Ironman.
182
						Includes network configuration updates and other config files.
183
imwww					Contains two web servers
184
	imwww				Provides network configuration interface for Monitor
185
	imrest				Provides IoT/Jarvis REST API.  Updates /etc/ironman directories with registrations.
186
imgpio					Command line tool for querying GPIO pins using syfs interface.
187
launcher				Ironman specific launcher that adds clock interface to front panel.
188
pisensors				Provides UI for managing sensors.
189
						Uses inotify to watch for changes to /etc/ironman/iot directory.
190
picam   				Generic console camera interface (same as PiBox media systems)
191
appmgr, piboxd, omxplayer, pmsui, psplash, mjpg-streamer
192
						Same packages as in PiBox, unmodified
193 9 Hammel
</pre>
194
195 1 Hammel
h3. Pairing with IoT Sensors
196
197
h3. Pairing with Jarvis
198
199
h2. IoT Sensor
200
201
h3. Sensor Types
202
203
h4. Light Switch
204
205
h3. Flashing the firmware
206
207
h3. Power On
208
209
h3. Pairing with a Monitor
210
211
h2. Jarvis
212
213
h3. Prerequisites
214
215
h3. Pairing with a Monitor
216
217
h3. Supported Commands
218 15 Hammel
219
h2. Addendums
220
221
h3. Source Code Repositories
222
223
* PiBox
224
** Development Platform
225
** appmgr
226
** mjpg-streamer
227
** omxplayer
228
** piboxd
229
** picam
230
** pmsui
231
** psplash
232
* Ironman
233
** launcher
234
** monitor
235
** pisensor
236
** www
237
* Arduino
238
** Sensor Template (imlightsw)
239
240
h3. Fritzing Models
241
242
* ESP-01 Flasher
243
* Light Switch
244
** Keyes_SRly
245
** Hilink
246
* Monitor Switch