Project

General

Profile

Users Guide » History » Version 6

Hammel, 19 Sep 2019 15:49

1 1 Hammel
h1. Users Guide
2
3 2 Hammel
{{>toc}}
4
5 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
6
onto an SD card.
7 1 Hammel
8 3 Hammel
h2. The Ironman Monitor
9
10
The Ironman Monitor runs on a Raspberry Pi 2 or 3 and provides a central hub for management of home automation devices.
11
12
h3. Installation Prerequisites
13
14 4 Hammel
* The Pi 2/3 requires a 5V / 2A power supply.  For best results, use a power supply rated to at least 5.25V to avoid under voltage conditions.
15 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.
16 5 Hammel
* A switch should be connected to the Pi GPIOs to allow for pairing the Monitor with IoT Sensors and Jarvis.  The ASCII diagram below describes the setup. The LED is lit in normal mode and off in Pair Mode until something tries to pair with the Pi.
17
18
<pre>
19
                    ___
20
           Normal  |---|  Pair Mode
21
                 --------- 
22
                |         |
23
                 --------- 
24
        pins -->  |  |  |  
25
26
       RPi GPIO   4  G  27
27 6 Hammel
        RPi pin   7  9  13     
28
                     |  |
29
                     |  +---LED---+
30
                     |            |
31
                     +---330 R----+
32 5 Hammel
</pre>
33
34
* You will need to have sudo access for your Linux user id.
35 6 Hammel
36 3 Hammel
37 1 Hammel
h3. Generating the SD Card for the Pi
38 3 Hammel
39 1 Hammel
* Download the RPi 2 Development Platform 
40 4 Hammel
** _wget <url>_
41
** Unpack the archive to a directory called *image*.
42 1 Hammel
* Download the Ironman Package Collection
43 4 Hammel
** _wget <url>_
44
** Unpack the archive to a directory called *package*.
45 3 Hammel
46 4 Hammel
In a terminal window run: _dmesg -w_
47 1 Hammel
Insert the microSD card and look for the device name for the newly added card.  It should be something like /dev/sdb or /dev/sde.
48 4 Hammel
Kill the _dmesg -w_ command with Ctrl-C.
49 3 Hammel
50 4 Hammel
From the *image* directory
51 1 Hammel
* Format the SD card
52 4 Hammel
** _sudo ./mksd.sh -d <device name>_
53 3 Hammel
** where <device name> is the name you noted from the output of dmesg -w.
54 1 Hammel
* Mount the boot partition from the sd card: 
55 4 Hammel
** _sudo mkdir -p /mnt/boot_
56
** _sudo mount <device name>1 /mnt/boot_
57 1 Hammel
** where <device name> is the name you noted from the output of dmesg -w.
58 4 Hammel
* Install the Development Platform to the SD card
59
** _sudo ./mkinstall.sh -b /mnt/boot -d <device name>2_ 
60 3 Hammel
** where <device name> is the name you noted from the output of dmesg -w.
61
62 4 Hammel
From the *package* directory
63 3 Hammel
* Mount the root partition from the sd card: 
64 4 Hammel
** _sudo mkdir -p /mnt/root_
65
** _sudo mount <device name>1 /mnt/root_
66 3 Hammel
* Copy the Ironman Package Collection files to /root of the root partition on the SD card
67 4 Hammel
** _sudo cp *.opk /mnt/root/root_
68 3 Hammel
69
Make sure all writes to the SD card have completed
70 4 Hammel
* _sync;sync;sync_
71 3 Hammel
72
Unmount the SD card partitions
73 4 Hammel
* _sudo umount /mnt/boot_
74
* _sudo umount /mnt/root_
75 3 Hammel
76 4 Hammel
Remove the SD card from the host system and insert it into the Raspberry Pi 2.
77 1 Hammel
78
h3. First time boot
79
80
h3. Network configuration
81
82
h3. Pairing with IoT Sensors
83
84
h3. Pairing with Jarvis
85
86
h2. IoT Sensor
87
88
h3. Sensor Types
89
90
h4. Light Switch
91
92
h3. Flashing the firmware
93
94
h3. Power On
95
96
h3. Pairing with a Monitor
97
98
h2. Jarvis
99
100
h3. Prerequisites
101
102
h3. Pairing with a Monitor
103
104
h3. Supported Commands