Users Guide¶

This document is under development and is likely not accurate at this time.

• Table of contents
• Users Guide
  • The Ironman Monitor
    • Installation Prerequisites
    • Generating the SD Card for the Pi
    • First time boot
    • Network configuration
    • Pairing with IoT Sensors
    • Pairing with Jarvis
  • IoT Sensor
    • Sensor Types
      • Light Switch
    • Flashing the firmware
    • Power On
    • Pairing with a Monitor
  • Jarvis
    • Prerequisites
    • Pairing with a Monitor
    • Supported Commands

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.

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.

Installation Prerequisites¶

• 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.
• 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 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.

                    ___
           Normal  |---|  Pair Mode
                 --------- 
                |         |
                 --------- 
        pins -->  |  |  |  

       RPi GPIO   4  G  27
        RPi pin   7  9  13     
                     |  |
                     |  +---LED---+
                     |            |
                     +---330 R----+

• You will need to have sudo access for your Linux user id.

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 look for the device name for the newly added card. 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.

First time boot¶

Network configuration¶

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.

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.

/etc/ironman/iot        Registration directory for IoT devices
/etc/ironman/jarvis        Registration directgory for Jarvis interfaces

Pairing with IoT Sensors¶

Pairing with Jarvis¶

IoT Sensor¶

Sensor Types¶

Light Switch¶

Flashing the firmware¶

Power On¶

Pairing with a Monitor¶

Jarvis¶

Prerequisites¶

Pairing with a Monitor¶

Supported Commands¶