smart-panel.rst

Smart Panel Blueprint

Contents

• Overview
• Bill of materials
  • IoT controller (Avenger96)
    • Equipment
    • Cables and connectors
  • IoT devices (Nitrogens)
    • Equipment
    • Cables and connectors
• Assembly
  • IoT controller
  • IoT devices
• Get sources
• Prepare IoT devices (Nitrogen/Zephyr flavour)
  • Build
  • Flash
• Prepare IoT controller (Avenger96/Linux flavour)
  • Build
  • Flash
  • Add Bluetooth firmware
• Home Assistant
  • Set up
  • Customizing the Dashboard
  • Set up automations
• Verify operations

Overview

The Smart Panel Blueprint provides support for building a PoC for a home automation system with components showing the capabilities of the build infrastructure in leveraging different kernels for building an end to end solution.

The setup is composed of an Avenger96 board acting as a gateway and running HomeAssistant. The gateway also provides UI as a browser connected to the localhost HomeAssistant server. The gateway is connected over Bluetooth to two Nitrogen boards exposing sensors and/or actuator (e.g. controlled light source).

Bill of materials

IoT controller (Avenger96)

Equipment

• 1x 96Boards Avenger96
• 1x Power supply 12 V minimum 2 A,
• 1x microSD card at least 8 GB,
• 1x HDMI touch screen,

Cables and connectors

• 1x HDMI-HDMI.
• 1x microUSB-USB type A cable.
• 1x Ethernet cable.

IoT devices (Nitrogens)

Equipment

• 2x 96Boards Nitrogen,
• 2x Grove Mezzanine board,
• 1x Grove LED module,
• 1x Grove DHT11 temperature and humidity sensor,
• 1x Grove AK9753 human presence sensor,
• 1x Grove LCD RGB Backlight screen,

Cables and connectors

• 4x Grove connector cables,
• 2x microUSB cable.

Assembly

IoT controller

1. Connect the screen's display output with the board using HDMI cable.

2. Connect the screen's touch controller with the board using USB cable.

3. The board to a network with DHCP server configured using the Ethernet cable.

4. Do not insert the microSD card into the board's slot. It will be needed for flashing.

5. Connect power supply to the power jack.

   

IoT devices

1. Connect Grove Mezzanine boards to both Nitrogen boards. One of them will act as a light switching device, the other as sensors device.
2. Assemble the light switching device:
   • Connect Grove LED module to GPIO IJ port on the Mezzanine board.
3. Assemble the sensors device:
   • Connect Grove DHT11 module to GPIO GH port on the Mezzanine board,
   • Connect Grove AK9753 module to GPIO KL port on the Mezzanine board,
   • Connect Grove LCD module to I2C0 port on the Mezzanine board,
4. Connect Nitrogens to your computer with microUSB cables.

Get sources

1. Get |main_project_name| sources as described in the :ref:`documentation <AllScenariOSQuickBuild>`.

2. If you already have sources cloned, update them to the most recent revision

   $ repo sync -d

Prepare IoT devices (Nitrogen/Zephyr flavour)

Build

1. Create build directory

   $ TEMPLATECONF=../oniro/flavours/zephyr . ./oe-core/oe-init-build-env build-oniro-zephyr-96b-nitrogen

2. Edit conf/local.conf, and uncomment the following line:

   #MACHINE ?= "96b-nitrogen"

3. Build zephyr-blueprint-smarthome-sensors image using bitbake, with the following override:

   $ DISTRO=allscenarios-zephyr-blueprint-dashboard bitbake zephyr-blueprint-smarthome-sensors

   Note

   • The build will configure the MAC address with sane defaults. If you want a custom MAC address, you can prepend to the command above the following:

     BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE SMART_HOME_SENSORS_MAC" SMART_HOME_SENSORS_MAC="<custom_mac_address>"

   • The MAC address can have any value provided it starts with C0 and is unique in your environment.

4. Make sure you have at least 3 GB of free space on the partition where the build directory is located.

5. Build zephyr-blueprint-smarthome-switch image using bitbake, with the following override:

   • SMART_HOME_SWITCH_MAC set to MAC address of the IoT device. It must be different than the MAC address used in the previous step.

     $ DISTRO=allscenarios-zephyr-blueprint-dashboard bitbake zephyr-blueprint-smarthome-switch

     Note

     • The build will configure the MAC address with sane defaults. If you want a custom MAC address, you can prepend to the command above the following:

       BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE SMART_HOME_SWITCH_MAC" SMART_HOME_SWITCH_MAC="<custom_mac_address>"

     • The MAC address can have any value provided it starts with C0 and is unique in your environment.

Flash

1. Connect 96Boards Nitrogen boards to your computer.

2. Assuming both boards are connected simultaneously, retrieve their IDs

   $ pyocd list
     #   Probe              Unique ID
   ---------------------------------------------------
     0   Arch BLE [nrf51]   9009022103BB2A02FE6545F3
     1   Arch BLE [nrf51]   9009022103BB3A2DFE6555DC

   If you do not have PyOCD in your system, follow the guide in the PyOCD section of the :ref:`Nitrogen documentation <SupportedBoardNitrogenPyOCD>`.

3. Flash the first board with zephyr-blueprint-smarthome-sensors image. Use the same command you used for build, with the following changes:

   • add -c flash_usb suffix,

   • remove the MAC address override (it is only effective at build time),

   • add board ID override in the form of: BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE PYOCD_FLASH_IDS" PYOCD_FLASH_IDS="<id>"

     $ BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE PYOCD_FLASH_IDS" \
             PYOCD_FLASH_IDS="9009022103BB2A02FE6545F3" bitbake zephyr-blueprint-smarthome-sensors -c flash_usb

4. Flash the other board with zephyr-blueprint-smarthome-switch image

   $ BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE PYOCD_FLASH_IDS" \
             PYOCD_FLASH_IDS="9009022103BB3A2DFE6555DC" bitbake zephyr-blueprint-smarthome-switch -c flash_usb

Prepare IoT controller (Avenger96/Linux flavour)

Build

1. Create build directory

   $ TEMPLATECONF=../oniro/flavours/linux . ./oe-core/oe-init-build-env build-oniro-linux-stm32mp1-av96

2. Edit conf/local.conf, and uncomment the following line:

   #MACHINE ?= "stm32mp1-av96"

3. Make sure you have at least 25 GB of free space on the partition where the build directory is located.

4. Build blueprint-dashboard-gateway-image image using bitbake, with the following overrides:

   • DISTRO set to allscenarios-linux-blueprint-dashboard -- this distribution configuration enhances the regular distribution with dependencies necessary for this demonstration scenario,

   • SMART_HOME_SENSORS_MAC and SMART_HOME_SWITCH_MAC set to MAC addresses of IoT devices, as set in the previous section.

     $ DISTRO=allscenarios-linux-blueprint-dashboard \
         BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE SMART_HOME_SENSORS_MAC SMART_HOME_SWITCH_MAC" \
         SMART_HOME_SENSORS_MAC="C0:BA:DD:06:F0:0D" \
         SMART_HOME_SWITCH_MAC="C0:BA:DD:06:F0:0E" \
         bitbake blueprint-dashboard-gateway-image

Flash

1. Build artifacts are located in ./tmp/deploy/images/stm32mp1-av96/ relative to the build directory. Flashing script is located in ./scripts/create_sdcard_from_flashlayout.sh relative to the build artifacts directory. FSD card flash layout used to convert build artifacts to the image is located in flashlayout_<image name>/extensible/FlashLayout_sdcard_stm32mp157a-av96-extensible.tsv relative to the build artifacts directory.

2. Go to the build artifacts directory and convert flash layout into a build image

   $ cd tmp/deploy/images/stm32mp1-av96
   
   $ ./scripts/create_sdcard_from_flashlayout.sh \
       flashlayout_blueprint-dashboard-gateway-image/extensible/FlashLayout_sdcard_stm32mp157a-av96-extensible.tsv

3. Lots of text will appear, but the most important part are the two commands

   WARNING: before to use the command dd, please umount all the partitions
           associated to SDCARD.
       sudo umount `lsblk --list | grep <sd card name> | grep part | gawk '{ print $7 }' | tr '\n' ' '`
   
   To put this raw image on sdcard
       sudo dd if=<image>.raw of=<sd card node> bs=8M conv=fdatasync status=progress

4. Put a microSD card in your card reader. Copy the commands above and paste them into your terminal. Do not remove the microSD card from the reader just yet.

Add Bluetooth firmware

Due to licensing details, |main_project_name| cannot provide the firmware file for the on-board Bluetooth controller. However, user may download and install it manually.

1. Download the Bluetooth firmware file from GitHub.

2. Create directory lib/firmware/brcm on the rootfs partition of the microSD card and copy the downloaded file into that directory. Assuming your card's mount point is /mnt/rootfs, you may use the example commands to accomplish that:

   $ sudo mkdir /mnt/rootfs/lib/firmware/brcm
   $ sudo cp ~/Downloads/BCM4345C0.hcd /mnt/rootfs/lib/firmware/brcm
   $ sudo chmod 755 /mnt/rootfs/lib/firmware/brcm

3. Unmount all microSD card partitions, remove them from the reader and put it in Avenger96 card slot. Power up the board.

Home Assistant

Set up

1. Put ths SD card into Avenger96 and press power on button.

2. On start up, Avenger96 will try to contact a DHCP server. Be sure to have one in your network, where you can see the IP address assigned to the board. Alternatively, you can use UART-USB adapter, log in to the system and set IP address manually.

3. Using a web browser, go to the IP address of Avenger96, port 8123. E.g. if you find out the Avenger's IP address is 192.0.2.137 , go to http://192.0.2.137:8123.

4. Create a user account and click your way through the basic settings.

5. You should find yourself in Home Assistant dashboard. Three circular icons on top show temperature, humidity and human presence.

   

Customizing the Dashboard

1. Click three vertical dots in the top-right corner of the dashboard and select Configure UI.

2. Agree to take control over the UI, remove the default widgets and click the yellow + button in the bottom-right corner of the dashboard.

3. Choose widgets according to your taste. They are already pre-configured, connected to the existing sensors (temperature, humidity, human presence) and light controls.

4. Adjust widgets configuration according to your taste. Most notable possibility is that you can combine multiple entities in one widget, e.g. creating a single widget with all the sensors and a light control switch.

   

Set up automations

Home Assistant can do things for you based on state sensors. This is how Home Assistant can be configured to turn the light on/off based on user presence nearby the human presence sensor. Imagine it is a kitchen light turning on every time it detects you are about to prepare a meal!

1. Go to Configuration menu using the cog button located on the left-hand sidebar, then to Automations.

2. Click the yellow + button in the bottom-right corner of the screen, then skip the smart automations generator.

3. Name your automation accordingly, e.g. Lights on when somebody in the room.

4. Set the trigger as follows:

   • Trigger type: State,

   • Entity: sensor.all_scenarios_os_smarthome_device_presence,

   • From: False (person not detected).

   • To: True (person detected)/

     

5. Set the action as follows:

   • Action type: Call service,

   • Service: switch.turn_on,

   • Name(s) of entities to turn on: switch.all_scenarios_os_smarthome_device_light.

     

6. Click the yellow save button in the bottom-right corner of the screen.

7. Repeat steps 2-6 for the opposite automation, i.e. turning the light off, when human presence state switches from True to False.

Verify operations

1. Temperature and humidity readings should show temperature and humidity in the room where the Nitrogen with sensors is located. Try to blow hot/cold air on the sensor to see values changing
2. Human presence state should change when you move your hand close to the sensor.
3. The light switch should control the LED.
4. The LED should turn on/off automatically when human presence is detected.
5. The LCD screen should display the current temperature, humidity and the connection state marked with a <B> symbol.