Project

General

Profile

Users Guide » History » Version 54

Hammel, 29 Sep 2019 17:29

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 34 Hammel
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.
9 1 Hammel
10 10 Hammel
h2. Overview
11
12 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.
13 1 Hammel
14 43 Hammel
table{align=center}.
15 42 Hammel
|!{width:640px}http://redmine.graphics-muse.org/attachments/download/114!|
16 1 Hammel
|={font-size:120%;margin-bottom:15px;background-color:#dff}. *Design Intent of the Ironman Project* |
17 43 Hammel
|=. Mark I release is in progress.  Mark II and Mark III are future development plans. |
18 1 Hammel
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 32 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.  A Fritzing Diagram (attachment:IronmanMonitorSwitch.fzz) is available for this hardware component.
52 30 Hammel
!>{width:300px}IronmanMonitorSwitchBreadboard.png(Ironman Monitor Switch)!
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 27 Hammel
* You will need to have sudo access for your Linux user id.
71 16 Hammel
72 1 Hammel
h3. Generating the SD Card for the Pi
73 3 Hammel
74 1 Hammel
* Download the RPi 2 Development Platform 
75 4 Hammel
** _wget <url>_
76
** Unpack the archive to a directory called *image*.
77 17 Hammel
* Download the _*Ironman*_ Package Collection
78 4 Hammel
** _wget <url>_
79 1 Hammel
** Unpack the archive to a directory called *package*.
80 18 Hammel
* In a terminal window run: _dmesg -w_
81
* 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.
82
* Kill the _dmesg -w_ command with Ctrl-C.
83 4 Hammel
84
From the *image* directory
85 1 Hammel
* Format the SD card
86
** _sudo ./mksd.sh -d <device name>_
87 18 Hammel
** where <device name> is the name you noted from the output of _dmesg -w_.
88 3 Hammel
* Mount the boot partition from the sd card: 
89 4 Hammel
** _sudo mkdir -p /mnt/boot_
90
** _sudo mount <device name>1 /mnt/boot_
91 18 Hammel
** where <device name> is the name you noted from the output of _dmesg -w_.
92 4 Hammel
* Install the Development Platform to the SD card
93
** _sudo ./mkinstall.sh -b /mnt/boot -d <device name>2_ 
94 18 Hammel
** where <device name> is the name you noted from the output of _dmesg -w_.
95 3 Hammel
96 4 Hammel
From the *package* directory
97 3 Hammel
* Mount the root partition from the sd card: 
98 4 Hammel
** _sudo mkdir -p /mnt/root_
99
** _sudo mount <device name>1 /mnt/root_
100 17 Hammel
* Copy the _*Ironman*_ Package Collection files to /root of the root partition on the SD card
101 4 Hammel
** _sudo cp *.opk /mnt/root/root_
102 3 Hammel
103
Make sure all writes to the SD card have completed
104 4 Hammel
* _sync;sync;sync_
105 3 Hammel
106
Unmount the SD card partitions
107 4 Hammel
* _sudo umount /mnt/boot_
108
* _sudo umount /mnt/root_
109 3 Hammel
110 4 Hammel
Remove the SD card from the host system and insert it into the Raspberry Pi 2.
111 1 Hammel
112
h3. First time boot
113
114 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.
115 22 Hammel
116
Once the display shows two xterm windows it is ready to complete installation.  Type the following command to install the _*Ironman*_ package collection.
117
118
  opkg install *.opk
119
120
Wait for this command to complete, then reboot the system either by power it off and back on or by typing the command 
121
122
  reboot
123
124 44 Hammel
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.
125 22 Hammel
126
h3. First time configuration
127
128 33 Hammel
!>{width:300px}ironman-config-ui.png(Ironman Config UI)!
129 24 Hammel
130 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.
131
132
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 
133
134
  http://192.168.36.1:1337
135
136 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.
137
138
|_. Domain |_. Description |
139
| Internet Connection | This is how the Monitor will connect to your home network. |
140
| Sensors Network | This is how the Monitor will communicate with your IoT devices. |
141 22 Hammel
142 36 Hammel
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.
143
144 1 Hammel
h3. Network configuration
145
146 34 Hammel
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
147
network and as an Access Point for IoT devices, only G networks are supported by the Ironman software.
148
149
h4. Internet Connection
150
151
The Internet Connection domain configures the Monitor to connect to your local network.  
152
153
|_. Field |_. Description |
154
|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|
155
|SSID |Network name configured on your router for your local WiFi network. |
156
|Security | Type of security used on your router. Only WPA2 Personal and WPA2 Enterprise are currently supported. |
157
|Password | Your router's password, specifically for the SSID entered previously. |
158
159
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.
160
161
h4. Sensor Network
162
163
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.
164
165
|_. Field |_. Description |
166
|SSID |Network name for this private WiFi network. This name will be hidden on Wifi scans.|
167
|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. |
168
|Password | Password IoT devices should use to gain access to the specified SSID. |
169
|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. |
170
171
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.
172
173 38 Hammel
h2. IoT Sensor
174 1 Hammel
175 38 Hammel
h3. Sensor Types
176
177
There is currently only one sensor type:  imlightsw (light switch).  
178
179 46 Hammel
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.
180 38 Hammel
181
h4. Light Switch
182 47 Hammel
!>{width:300px}imlightsw.png(Ironman Light Switch)!
183 38 Hammel
184 50 Hammel
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).
185 38 Hammel
186 1 Hammel
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.
187 51 Hammel
188
The ESP-01 has a Blue LED that is used to provide visual information using blink patterns.
189
190
h5. Config Button
191
192
This button has multiple uses, depending on where it is used.  
193
194
_AP Config Mode_
195
196
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 the local network.
197
198
* AP Config mode is disabled by default, that is, when the Config Button is in the off position.
199
* 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 the local network it will blink 4 times.
200
* After configuration is complete, button must be set OFF and device power cycled.
201
202
_Pair Mode_
203
204
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.
205
206
* The Config Button is OFF at boot.
207
* Later the Config Button is turned on and imlightsw enters PAIR mode.  In this mode the blue LED stays on.
208
* After the device has paired with a Monitor the blue LED blinks.
209
* The Config Button must be turned off for normal operation.
210
211
h5. Blue LED Blink Patterns
212
213
A _blink_ implies the LED turns on and then off.
214
215
|_. LED State |_. Blink Speed |_. Blink Count |_. Device Mode |
216
|Blink        | 1/sec       | 2             | Entered AP Config Mode |
217
|Blink        | 1/sec       | 4             | Device is connected to monitor |
218
|Blink        | 1/.125 sec  | 5             | Device failed to connect to monitor |
219
|Solid On     | N/A         | N/A           | Entered Pair Mode |
220
|Blink        | 2/.150 sec then 1/.200 sec | continuous             | Waiting to Pair with Monitor|
221
|Blink        | 1/.100 sec  | 3             | Not currently paired with Monitor|
222
223
h5. Reset Button
224
225
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.
226
227
* The Reset Button is ON at boot.
228
* The device removes all configuration from itself.
229
* The Reset Button must be turned off, then the device can be rebooted and reconfigured.
230
231
table{border-collapse;width:100%}.
232
|={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. |
233 49 Hammel
234 38 Hammel
h3. Flashing the firmware
235 52 Hammel
!>{width:300px}imlightsw-flasher.png(Ironman Light Switch Flasher)!
236 38 Hammel
237 52 Hammel
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.
238 38 Hammel
239 53 Hammel
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.  
240
241
table{border-collapse;width:100%}.
242
|={font-size:120%;margin-bottom:15px;background-color:#fdd}.  TBD - instructions for flashing |
243
244 38 Hammel
h3. Power On
245
246 37 Hammel
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.
247 14 Hammel
248
h4. Configuring an IoT Device Network
249
250
* Set the Mode button to Config. 
251 1 Hammel
* Power on the IoT device.
252
* TBD
253
254 38 Hammel
h3. Pairing with a Monitor
255 14 Hammel
256 38 Hammel
* With the Monitor running, set the Monitor Mode switch to Pair.
257 14 Hammel
* 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.  
258
* Disable the Mode switch on the Monitor.
259
260 9 Hammel
table{border-collapse;width:100%}.
261
|={font-size:140%;margin-bottom:15px;background-color:#fdd}. *WARNING!* |
262 1 Hammel
|={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. |
263
264
h2. Jarvis
265
266
h3. Prerequisites
267
268
h3. Pairing with a Monitor
269 38 Hammel
270
* With the Monitor running, set the Monitor Mode switch to Pair.
271
* TBD
272 1 Hammel
273
h3. Supported Commands
274
275 35 Hammel
h2. Addendums
276
277 40 Hammel
h3. Ironman Packages
278 35 Hammel
279 40 Hammel
|_. Package |_. Repository |_.Contents |_. Description |
280
|imcore |monitor | |Package that updates a PiBox Development Platform for use with Ironman.  Includes network configuration updates and other config files. |
281
|imwww |www | |Contains two web servers |
282
| ||imwww |Provides network configuration interface for Monitor |
283
| ||imrest |Provides IoT/Jarvis REST API.  Updates /etc/ironman directories with registrations.|
284
|imgpio |gpio | |Command line tool for querying GPIO pins using syfs interface. |
285
|launcher |launcher | |Ironman specific launcher that adds clock interface to front panel. |
286
|pisensor |pisensor | |Provides UI for managing sensors.  Uses inotify to watch for changes to /etc/ironman/iot directory. |
287
|picam |picam | |Generic console camera interface (same as PiBox media systems) |
288
|Misc |appmgr, piboxd, omxplayer, pmsui, psplash, mjpg-streamer| |Same packages as in PiBox media system, unmodified|
289 1 Hammel
290
h3. Source Code Repositories
291
292
* PiBox
293 39 Hammel
** "Development Platform":https://gitlab.com/pibox/pibox
294
** "appmgr":https://gitlab.com/pibox/appmgr
295
** "mjpg-streamer":https://gitlab.com/pibox/mjpg-streamer
296
** "omxplayer":https://gitlab.com/pibox/omxplayer
297
** "piboxd":https://gitlab.com/pibox/piboxd
298
** "picam":https://gitlab.com/pibox/picam
299
** "pmsui":https://gitlab.com/pibox/pmsui
300
** "psplash":https://gitlab.com/pibox/psplash
301 1 Hammel
* Ironman
302 39 Hammel
** "gpio":https://gitlab.com/xironman/gpio
303
** "launcher":https://gitlab.com/xironman/launcher
304
** "monitor":https://gitlab.com/xironman/monitor
305
** "pisensor":https://gitlab.com/xironman/sensors
306
** "www":https://gitlab.com/xironman/www
307
** "meta build":https://gitlab.com/xironman/meta
308 1 Hammel
* Arduino
309 39 Hammel
** "Sensor Template (imlightsw)":https://gitlab.com/xarduino/lightsw
310
311 1 Hammel
h3. Fritzing Models
312
313 54 Hammel
* ESP-01 Flasher: attachment:imlightsw-flasher.fzz
314
* Light Switch: attachment:imlightsw-with-relay-2.fzz
315
** "ESP8266":https://github.com/ydonnelly/ESP8266_fritzing
316
** "Keyes_SRly":https://github.com/rwaldron/fritzing-components
317
** "Breadboard Power Supply":https://github.com/AchimPieters/Fritzing-Custom-Parts/blob/master/YwRobot%20Breadboard%20Power%20Supply.fzpz
318
** "Hilink HLK-PM01":http://forum.fritzing.org/t/hlk-pm01-ac-dc-220v-to-5v/381
319 35 Hammel
* Monitor Switch: attachment:IronmanMonitorSwitch.fzz
320 54 Hammel
321 35 Hammel
322
h3. Networking Internals
323
324
<pre>
325
wlan0
326
327
* This interface is used for configuration of the Monitor.
328
* Configured on the 192.168.36.0 subnet.
329
** See /etc/network/dhcpd.conf.aponly
330
331
uap0
332
333
* This interface is used as an access point for IoT devices.
334
* Configured on the 192.168.3.0 subnet.
335
** See /etc/network/dhcpd.conf.uap and dhcpd.conf.uap.tmpl
336
** The template is used to change the base subnet through the web interface.
337
** The SSID is _ironman_.
338
</pre>
339
340
h3. Pair Button Usage
341
342
<pre>
343
Pair/Config button is GPIO 4 (RPi pin 7)
344
Pair/Config LED is GPIO 7 (RPi pin 13)
345
	LED should only be lit on boot if button is enabled (in Config mode).
346
		In this case, we're in Config Mode to configure the networks.
347
		The web server (imwww) is on SSID _ironman_ at 192.168.36.1:1337.
348
	LED is off on boot if button is disabled (in Pair Mode).
349
	If in Pair Mode
350
		Start hostapd for aponly
351
		Start dhcpd for aponly on wlan0
352
		Start imrest web service on port 8165 for IoT devices and Jarvis interfaces.
353
	If in Config Mode
354
		Start wpa_supplicant on wlan0
355
		Create uap0 device as virtual device on wlan0
356
		Start dhcpd on uap0
357
		Start hostapd on uap0
358
		Start imwww for network configuration of the Monitor.
359
</pre>
360
361
h3. Monitor IoT Directories
362
363
<pre>
364
/etc/ironman/iot		Registration directory for IoT devices
365 1 Hammel
/etc/ironman/jarvis		Registration directgory for Jarvis interfaces
366
</pre>
367 41 Hammel
368 45 Hammel
h2. Privileged Apps
369
370
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.
371
372
# Power down the Monitor.
373
# Remove the SD card and mount it into your laptop or desktop computer.
374
# Edit this file on the SD card:  /etc/appmgr.priv
375
# Add this line:  /usr/bin/xterm
376
# Save the file and unmount the SD card.
377
# Remove the SD card from the laptop or desktop.
378
# Replace the SD card in the Monitor.
379
# Power up the Monitor.
380
381
The terminal application will now have privileged access on the monitor.
382
383 41 Hammel
h2. File Attachments