Project

General

Profile

Users Guide » History » Version 71

Hammel, 07 Apr 2025 21:35

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 69 Hammel
| *Monitor* | The Nest-like control hub based on a Raspberry Pi 3 and the official 7" touchscreen display |
22 12 Hammel
| *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 70 Hammel
| *Controllers* | Network enabled control of Monitor managed devices and PiBox Systems such as PiStore and PiSentry |
25 12 Hammel
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 65 Hammel
The _*Ironman*_ Monitor runs on a Raspberry Pi 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 71 Hammel
%{background:yellow;letter-spacing:0.25em}The mechanical switch will be removed with upcoming versions of the sensors app and imrest server that run on the Ironman monitor.%
45
46 3 Hammel
h3. Installation Prerequisites
47 1 Hammel
48 66 Hammel
* A "Raspberry Pi 3":https://rpilocator.com/?country=US&cat=PI3
49 11 Hammel
* The official "Raspberry Pi 7inch touchscreen display":https://www.sparkfun.com/products/13733
50 66 Hammel
* The Pi 3 requires a "5V / 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.
51
* 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.
52 1 Hammel
* The Pi 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.
53 71 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 are discussed in later sections.  A Fritzing Diagram (attachment:IronmanMonitorSwitch.fzz) is available for this hardware component.
54 30 Hammel
!>{width:300px}IronmanMonitorSwitchBreadboard.png(Ironman Monitor Switch)!
55 1 Hammel
<pre>
56 16 Hammel
                      ___
57
   Config/Pair Mode  |---|  Normal Mode
58
                   --------- 
59
                  |         |
60
                   --------- 
61
connector pins -->  |  |  |  
62
                    |  |   ------ Not connected
63
                    |  |
64
                    |  ----330 Ohm R-----
65
                    |  |                |
66
                    |  |  +-----LED------
67
                    |  |  |
68
          RPi pin   7  9  13     
69
         RPi GPIO   4  G  27
70 6 Hammel
</pre>
71 5 Hammel
72 27 Hammel
* You will need to have sudo access for your Linux user id.
73 1 Hammel
74
h3. Generating the SD Card for the Pi
75
76 71 Hammel
* Clone and build PiBox Development System
77
** git clone https://gitlab.com/pibox/pibox.git
78
** cd pibox
79
** _make pkg_
80
** The build artifacts will be in the "../pkg" directory
81
** export STAGING="$(pwd)/../bld/buildroot-<date>/output/staging"
82
** export XID="$(pwd)/../bld/crosstool-ng-1.25.0.bld/install
83
* Clone the metabuild repository and build the Ironman package set.
84
** git clone https://gitlab.com/pibox/metabuild.git
85
** cd metabuild
86
** _./build.sh -m ironman_
87
*** You need to set STAGING and XID variables before running this command
88
** The packages will be in ../pkg.
89 1 Hammel
* In a terminal window run: _dmesg -w_
90
* 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.
91 18 Hammel
* Kill the _dmesg -w_ command with Ctrl-C.
92 1 Hammel
93 71 Hammel
To install the PiBox Development System on the SD card.
94 1 Hammel
* Format the SD card
95 71 Hammel
** cd <pibox clone dir>/../pkg
96
** _./mksd.sh -d <device name>_
97 1 Hammel
** where <device name> is the name you noted from the output of _dmesg -w_.
98
* Mount the boot partition from the sd card: 
99
** _sudo mkdir -p /mnt/boot_
100
** _sudo mount <device name>1 /mnt/boot_
101 4 Hammel
** where <device name> is the name you noted from the output of _dmesg -w_.
102 18 Hammel
* Install the Development Platform to the SD card
103 71 Hammel
** _./mkinstall.sh -b /mnt/boot -d <device name>2 -o_ 
104 4 Hammel
** where <device name> is the name you noted from the output of _dmesg -w_.
105 1 Hammel
106 71 Hammel
%{background:yellow}You will need sudo access to run mksd and mkinstall.%
107 18 Hammel
108 71 Hammel
To install the Ironman package to the SD card.
109
* Mount the data partition from the sd card: 
110
** _sudo mkdir -p /mnt/data_
111
** _sudo mount <device name>1 /mnt/data_
112
* Copy the _*Ironman*_ packages to the SD card
113
** cd <metaboot clone dir>/../pkg
114
** _sudo cp *.opk /mnt/data/opkg/incoming_
115
** _sudo touch /mnt/data/opkg/incoming/.install_
116
117 4 Hammel
Make sure all writes to the SD card have completed
118 3 Hammel
* _sync;sync;sync_
119
120 4 Hammel
Unmount the SD card partitions
121
* _sudo umount /mnt/boot_
122 71 Hammel
* _sudo umount /mnt/data_
123 4 Hammel
124 71 Hammel
Remove the SD card from the host system and insert it into the Raspberry Pi 3.
125 1 Hammel
126
h3. First time boot
127 26 Hammel
128 22 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.
129
130
Once the display shows two xterm windows it is ready to complete installation.  Type the following command to install the _*Ironman*_ package collection.
131
132
  opkg install *.opk
133
134
Wait for this command to complete, then reboot the system either by power it off and back on or by typing the command 
135
136
  reboot
137 44 Hammel
138 22 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.
139
140
h3. First time configuration
141 33 Hammel
142 24 Hammel
!>{width:300px}ironman-config-ui.png(Ironman Config UI)!
143 22 Hammel
144
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.
145
146
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 
147
148
  http://192.168.36.1:1337
149 25 Hammel
150
The display should be as shown in the adjacent photo.  There are two network domains to configure, as described in the following table.
151
152
|_. Domain |_. Description |
153
| Internet Connection | This is how the Monitor will connect to your home network. |
154 22 Hammel
| Sensors Network | This is how the Monitor will communicate with your IoT devices. |
155 36 Hammel
156
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.
157 1 Hammel
158
h3. Network configuration
159 34 Hammel
160
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
161
network and as an Access Point for IoT devices, only G networks are supported by the Ironman software.
162
163
h4. Internet Connection
164
165
The Internet Connection domain configures the Monitor to connect to your local network.  
166
167
|_. Field |_. Description |
168
|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|
169
|SSID |Network name configured on your router for your local WiFi network. |
170
|Security | Type of security used on your router. Only WPA2 Personal and WPA2 Enterprise are currently supported. |
171
|Password | Your router's password, specifically for the SSID entered previously. |
172
173
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.
174
175
h4. Sensor Network
176
177
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.
178
179
|_. Field |_. Description |
180
|SSID |Network name for this private WiFi network. This name will be hidden on Wifi scans.|
181
|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. |
182
|Password | Password IoT devices should use to gain access to the specified SSID. |
183
|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. |
184
185
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.
186 38 Hammel
187 1 Hammel
h2. IoT Sensor
188 38 Hammel
189
h3. Sensor Types
190 68 Hammel
191 38 Hammel
There is currently only one sensor type:  pwrctrl (power control for outlets).  
192 68 Hammel
193 38 Hammel
The sensor template GIT repository, which is the imlightsw (historical name) 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.
194
195 47 Hammel
h4. Light Switch
196 38 Hammel
!>{width:300px}imlightsw.png(Ironman Light Switch)!
197 50 Hammel
198 38 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).
199 1 Hammel
200 51 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.
201
202
The ESP-01 has a Blue LED that is used to provide visual information using blink patterns.
203
204
h5. Config Button
205
206
This button has multiple uses, depending on where it is used.  
207
208
_AP Config Mode_
209 55 Hammel
210 51 Hammel
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.
211
212 68 Hammel
* AP Config mode is disabled by default, that is, when the Config Button is in the off position.
213 51 Hammel
* If Config Button is ON at boot, pwrctrl 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.
214
* After configuration is complete, button must be set OFF and device power cycled.
215
216
_Pair Mode_
217 68 Hammel
218 51 Hammel
Pair Mode is used to pair the pwrctrl device with an Ironman Monitor.  Pairing involves the exchange of secret keys that will be used to encrypt messages between the Monitor and the pwrctrl device.
219
220 68 Hammel
* The Config Button is OFF at boot.
221 1 Hammel
* Later the Config Button is turned on and pwrctrl enters PAIR mode.  In this mode the blue LED stays on.
222 51 Hammel
* After the device has paired with a Monitor the blue LED blinks.
223 55 Hammel
* The Config Button must be turned off for normal operation.
224 51 Hammel
225
226
h5. Blue LED Blink Patterns
227
228
A _blink_ implies the LED turns on and then off.
229
230
|_. LED State |_. Blink Speed |_. Blink Count |_. Device Mode |
231
|Blink        | 1/sec       | 2             | Entered AP Config Mode |
232
|Blink        | 1/sec       | 4             | Device is connected to monitor |
233
|Blink        | 1/.125 sec  | 5             | Device failed to connect to monitor |
234
|Solid On     | N/A         | N/A           | Entered Pair Mode |
235
|Blink        | 2/.150 sec then 1/.200 sec | continuous             | Waiting to Pair with Monitor|
236
|Blink        | 1/.100 sec  | 3             | Not currently paired with Monitor|
237
238
h5. Reset Button
239 68 Hammel
240 51 Hammel
The Reset Button is used to return the pwrctrl 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.
241
242
* The Reset Button is ON at boot.
243
* The device removes all configuration from itself.
244
* The Reset Button must be turned off, then the device can be rebooted and reconfigured.
245
246
table{border-collapse;width:100%}.
247 49 Hammel
|={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. |
248 56 Hammel
249
h3. Setting up to use the code
250
251
h4. Prerequisites
252
253
* ESP-01 connected to your serial port using an FTDI board
254
** Try the one from "SparkFun":https://www.sparkfun.com/products/9873
255
* You have proper power to the ESP-01
256
** You need 3.3V for the ESP-01.
257
** You need 5V for the power relay.
258
** 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
259
* Other parts you might want
260
** ESP-01 "breadboard adapter":https://www.addicore.com/ProductDetails.asp?ProductCode=AD-BB-ADTR
261
** "Logic Level Converter":https://www.sparkfun.com/products/12009
262
** "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
263
264
h4. Arduino Setup
265
266
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.
267
268
* Make a directory to hold required repository clones - call it _repos_.
269
* Change to _repos_
270
* Clone the esp8266/Arduino repository
271
** git clone https://github.com/esp8266/Arduino.git
272
** cd Arduino
273
** git checkout tags/2.1.0
274
** cd ..
275
* Clone the makeEspArduino repo
276
** git clone https://github.com/plerup/makeEspArduino.git
277
** cd makeEspArduino
278
** If ESP_ROOT points to a symlink but doesn't use a trailing slash: _git checkout d13cf13602f2acc9be3baa3315911a4c037dc62d_
279
** Otherwise: _git checkout tags/4.13.0_
280
** cd ..
281
* Install libraries
282
** cd Arduino/libraries
283
** clone extra libraries (see Required Libraries below)
284
* If your USB/FTDI connector shows up as something other than /dev/USBFTDI then set SERIALDEV
285
** export SERIALDEV=/dev/_your device_
286
* 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.
287
288
|_. Required Arduino libraries |_. URL |
289
|AES|            https://github.com/spaniakos/AES/|
290
|Timer|          https://github.com/JChristensen/Timer.git|
291
|WiFiManager|    https://github.com/tzapu/WiFiManager.git
292
                 tag: 0.12
293
                 commit: 04d47882a7d662b46bb1b1dbecfe786e5bc9efa4 |
294
|aJson|          https://github.com/interactive-matter/aJson.git
295
                 Requires patch in patch/ directory. |
296
|aREST|          https://github.com/marcoschwartz/aREST.git|
297
|arduino-base64| https://github.com/adamvr/arduino-base64
298
                 Requires patch in patch/ directory. |
299
300
Notes on libraries
301
* cd esp8266/libraries, then clone the extra libraries there
302
* AES library:  Remove the examples or the build will probably fail.
303 68 Hammel
304 56 Hammel
h4. The pwrctrl Code
305
306
The code is required to do flash updates to the ESP-01.  Before starting, be sure to install "cdtools":https://gitlab.com/cdtools/cdtools.
307
308
* Clone the software: _git clone https://gitlab.com/xarduino/lightsw.git_
309
* Copy _lightsw/docs/arduino.sh_ to your cdtools directory (_~/bin/env_) and edit as appropriate.
310
** Be sure to set ESPTOP as described in arduino.sh.
311
* Setup your environment for the build:
312
**  _. cdtools_
313
**  _ard lightsw_
314
**  _cd?_ (to see what you can do with cdtools in this repository)
315
* Change to this repos directory: _cdx_
316 38 Hammel
317 52 Hammel
h3. Flashing the firmware
318 38 Hammel
!>{width:300px}imlightsw-flasher.png(Ironman Light Switch Flasher)!
319 53 Hammel
320
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.
321 1 Hammel
322
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.  
323 56 Hammel
324
The code must be built before it can be flashed to the ESP-01.
325
326
* _make_
327
** Binary is in ../bld/*.bin
328
* _make RESET=1_
329
** This causes stored data in the ESP-01 to be erased on power up.  After that, you need to reflash without this flag.
330
* _make SERIAL=1_
331
** This causes the code to use the TX line 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.
332
333
Finally, to flash the updated image to the ESP-01 use the _upload_ target.
334
335
* _make upload_
336
** _upload_ target is in makeEspArduino.mk, not in local Makefile.
337
338 58 Hammel
339 1 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.
340 58 Hammel
341 61 Hammel
h3. Connect Serial Terminal to IoT Device
342
343 1 Hammel
!>{width:300px}minicom.png(Sample minicom session)!
344 58 Hammel
345 1 Hammel
It helps, at this stage of development, to see what the ESP-01 thinks is happening while configuring it.  This can be done by connecting the FTDI Basic connector to a USB connector on a laptop.
346 58 Hammel
347
* Connect the FTDI Basic to a USB port on the laptop.
348
* Check the laptop for a port such as /dev/ttyUSB0 (this may be different on different Linux distributions).
349
* Use _minicom_ or a similar serial communication program and connect it to /dev/ttyUSB0
350
** Baud: 115200
351
** No parity
352
** 1 stop bit
353
** Terminal type should be set to ANSI (you might get garbage characters otherwise)
354
355
You can now watch the progress of the ESP-01 as it processes hardware and software changes in the following sections.
356
357 1 Hammel
h3. Configuring an IoT Device to the Sensor Network
358 62 Hammel
359
!>{width:300px}iotwebui.png(IoT Device Configuration)!
360 57 Hammel
361
The IoT device has it's own WiFi Access Point at 192.168.4.1 with no password.  This is used to configure the device to connect to the Monitor's Sensor Network.
362 1 Hammel
363
* Set the Mode button to Config. 
364 57 Hammel
* Power on the IoT device.
365
* Connect a laptop or smartphone to the _imiot_ SSID.  An IP will be assigned automatically to the laptop or smartphone.
366
* If connecting to the _imiot_ SSID does not automatically open a browser page to the IoT device's WiFi configuration page, then manually open a browser to http://192.168.4.1.
367
368
The configuration page looks like the image to the right.  This page has multiple options.  Only the first is needed to configure to the Sensor Network.
369
370
* Click on ...tbd...
371
* A scan of local WiFi access points will be shown.
372
* Choose the SSID configured for the Monitor's Sensor Network.
373
* Type in the password configured for the Monitor's Sensor Network.
374
* Click on ...tbd...
375
376
At this point the device will attempt to connect to the Monitor and retrieve an IP address.  Wait about 1 minute for this to complete.
377
378
* Turn the IoT device off.
379
* Turn the Mode button to Normal.
380
* Power on the IoT device.
381
382 1 Hammel
The device is now ready for pairing with the Monitor.
383 38 Hammel
384 14 Hammel
h3. Pairing with a Monitor
385 63 Hammel
386
!>{width:300px}iotpair.png(IoT device pairing in Minicom session)!
387 38 Hammel
388 59 Hammel
* With the Monitor running, set the Monitor Mode switch to Pair.
389
* Power on the IoT device.
390
* Turn the Mode button on the IoT device to Config.
391
* Wait for it to pair with the Monitor.  When pairing is completed the Monitor's Mode Button LED will flash for 1 second and the Blue LED on the IoT sensor will light for 3 seconds.
392
** The Monitor's Sensor app will show a new device that can now be managed from the Monitor.
393
* Turn the Mode switch to Normal on the Monitor.
394
* Turn the Iot device off.
395
* Turn the Mode button on the IoT device to Normal.
396
* Power on the Iot Device.
397
398 14 Hammel
The Iot device can now be managed by the Monitor's Sensor App.
399 9 Hammel
400
table{border-collapse;width:100%}.
401 1 Hammel
|={font-size:140%;margin-bottom:15px;background-color:#fdd}. *WARNING!* |
402
|={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. |
403
404
h2. Jarvis
405
406
h3. Prerequisites
407
408 38 Hammel
h3. Pairing with a Monitor
409
410
* With the Monitor running, set the Monitor Mode switch to Pair.
411 1 Hammel
* TBD
412
413
h3. Supported Commands
414 35 Hammel
415
h2. Addendums
416 40 Hammel
417 35 Hammel
h3. Ironman Packages
418 40 Hammel
419
|_. Package |_. Repository |_.Contents |_. Description |
420
|imcore |monitor | |Package that updates a PiBox Development Platform for use with Ironman.  Includes network configuration updates and other config files. |
421
|imwww |www | |Contains two web servers |
422
| ||imwww |Provides network configuration interface for Monitor |
423
| ||imrest |Provides IoT/Jarvis REST API.  Updates /etc/ironman directories with registrations.|
424
|imgpio |gpio | |Command line tool for querying GPIO pins using syfs interface. |
425
|launcher |launcher | |Ironman specific launcher that adds clock interface to front panel. |
426
|pisensor |pisensor | |Provides UI for managing sensors.  Uses inotify to watch for changes to /etc/ironman/iot directory. |
427
|picam |picam | |Generic console camera interface (same as PiBox media systems) |
428 1 Hammel
|Misc |appmgr, piboxd, omxplayer, pmsui, psplash, mjpg-streamer| |Same packages as in PiBox media system, unmodified|
429
430
h3. Source Code Repositories
431
432 39 Hammel
* PiBox
433
** "Development Platform":https://gitlab.com/pibox/pibox
434
** "appmgr":https://gitlab.com/pibox/appmgr
435
** "mjpg-streamer":https://gitlab.com/pibox/mjpg-streamer
436
** "omxplayer":https://gitlab.com/pibox/omxplayer
437
** "piboxd":https://gitlab.com/pibox/piboxd
438
** "picam":https://gitlab.com/pibox/picam
439
** "pmsui":https://gitlab.com/pibox/pmsui
440 1 Hammel
** "psplash":https://gitlab.com/pibox/psplash
441 39 Hammel
* Ironman
442
** "gpio":https://gitlab.com/xironman/gpio
443
** "launcher":https://gitlab.com/xironman/launcher
444
** "monitor":https://gitlab.com/xironman/monitor
445
** "pisensor":https://gitlab.com/xironman/sensors
446
** "www":https://gitlab.com/xironman/www
447 1 Hammel
** "meta build":https://gitlab.com/xironman/meta
448 39 Hammel
* Arduino
449
** "Sensor Template (imlightsw)":https://gitlab.com/xarduino/lightsw
450 1 Hammel
451
h3. Fritzing Models
452 54 Hammel
453
* ESP-01 Flasher: attachment:imlightsw-flasher.fzz
454
* Light Switch: attachment:imlightsw-with-relay-2.fzz
455
** "ESP8266":https://github.com/ydonnelly/ESP8266_fritzing
456
** "Keyes_SRly":https://github.com/rwaldron/fritzing-components
457
** "Breadboard Power Supply":https://github.com/AchimPieters/Fritzing-Custom-Parts/blob/master/YwRobot%20Breadboard%20Power%20Supply.fzpz
458 35 Hammel
** "Hilink HLK-PM01":http://forum.fritzing.org/t/hlk-pm01-ac-dc-220v-to-5v/381
459 54 Hammel
* Monitor Switch: attachment:IronmanMonitorSwitch.fzz
460 35 Hammel
461
462
h3. Networking Internals
463
464
<pre>
465
wlan0
466
467
* This interface is used for configuration of the Monitor.
468
* Configured on the 192.168.36.0 subnet.
469
** See /etc/network/dhcpd.conf.aponly
470
471
uap0
472
473
* This interface is used as an access point for IoT devices.
474
* Configured on the 192.168.3.0 subnet.
475
** See /etc/network/dhcpd.conf.uap and dhcpd.conf.uap.tmpl
476
** The template is used to change the base subnet through the web interface.
477
** The SSID is _ironman_.
478
</pre>
479
480
h3. Pair Button Usage
481
482
<pre>
483
Pair/Config button is GPIO 4 (RPi pin 7)
484
Pair/Config LED is GPIO 7 (RPi pin 13)
485
	LED should only be lit on boot if button is enabled (in Config mode).
486
		In this case, we're in Config Mode to configure the networks.
487
		The web server (imwww) is on SSID _ironman_ at 192.168.36.1:1337.
488
	LED is off on boot if button is disabled (in Pair Mode).
489
	If in Pair Mode
490
		Start hostapd for aponly
491
		Start dhcpd for aponly on wlan0
492
		Start imrest web service on port 8165 for IoT devices and Jarvis interfaces.
493
	If in Config Mode
494
		Start wpa_supplicant on wlan0
495
		Create uap0 device as virtual device on wlan0
496
		Start dhcpd on uap0
497
		Start hostapd on uap0
498
		Start imwww for network configuration of the Monitor.
499
</pre>
500
501
h3. Monitor IoT Directories
502
503
<pre>
504 1 Hammel
/etc/ironman/iot		Registration directory for IoT devices
505
/etc/ironman/jarvis		Registration directgory for Jarvis interfaces
506 41 Hammel
</pre>
507 45 Hammel
508
h2. Privileged Apps
509
510
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.
511
512
# Power down the Monitor.
513
# Remove the SD card and mount it into your laptop or desktop computer.
514
# Edit this file on the SD card:  /etc/appmgr.priv
515
# Add this line:  /usr/bin/xterm
516
# Save the file and unmount the SD card.
517
# Remove the SD card from the laptop or desktop.
518
# Replace the SD card in the Monitor.
519
# Power up the Monitor.
520
521
The terminal application will now have privileged access on the monitor.
522 41 Hammel
523 1 Hammel
h2. File Attachments