Matter Linux Air Quality Example

An example showing the use of Matter on the Linux. The document will describe how to build and run Matter Linux Air Quality Example on Raspberry Pi. This doc is tested on Ubuntu for Raspberry Pi Server 20.04 LTS (aarch64) and Ubuntu for Raspberry Pi Desktop 20.10 (aarch64)

To cross-compile this example on x64 host and run on NXP i.MX 8M Mini EVK, see the associated README document for details.

• Matter Linux Air Quality Example
  • Building
  • Commandline arguments
  • Running the Complete Example on Raspberry Pi 4
  • Trigger event using air-quality-sensor-app event named pipe
    • Trigger air quality change event
    • Trigger Temperature change event
    • Trigger Humidity change event
    • Trigger concentration change event

Building

• Install tool chain

    $ sudo apt-get install git gcc g++ python pkg-config libssl-dev libdbus-1-dev libglib2.0-dev ninja-build python3-venv python3-dev unzip
  

• Build the example application:

    $ cd ~/connectedhomeip/examples/air-quality-sensor-app/linux
    $ git submodule update --init
    $ source third_party/connectedhomeip/scripts/activate.sh
    $ gn gen out/debug
    $ ninja -C out/debug
  

• To delete generated executable, libraries and object files use:

    $ cd ~/connectedhomeip/examples/air-quality-sensor-app/linux
    $ rm -rf out/
  

• Build the example with pigweed RPC

    $ cd ~/connectedhomeip/examples/air-quality-sensor-app/linux
    $ git submodule update --init
    $ source third_party/connectedhomeip/scripts/activate.sh
    $ gn gen out/debug --args='import("//with_pw_rpc.gni")'
    $ ninja -C out/debug
  

Commandline arguments

• --wifi

  Enables WiFi management feature. Required for WiFi commissioning.

• --thread

  Enables Thread management feature, requires ot-br-posix dbus daemon running. Required for Thread commissioning.

• --ble-controller <selector>

  Use the specific Bluetooth controller for BLE advertisement and connections. For details on controller selection refer to Linux BLE Settings.

Running the Complete Example on Raspberry Pi 4

gn gen out/debug
ninja -C out/debug

• Prerequisites

  1. A Raspberry Pi 4 board
  2. A USB Bluetooth Dongle, Ubuntu desktop will send Bluetooth advertisement, which will block Matter from connecting via BLE. On Ubuntu server, you need to install pi-bluetooth via APT.
  3. Ubuntu 20.04 or newer image for ARM64 platform.

• Building

  Follow Building section of this document.

• Running

  • [Optional] Plug USB Bluetooth dongle

    • Plug USB Bluetooth dongle and find its bluetooth controller selector as described in Linux BLE Settings.

  • Run Linux Air Quality Example App

      $ cd ~/connectedhomeip/examples/air-quality-sensor-app/linux
      $ sudo out/debug/chip-air-quality-sensor-app --ble-controller [bluetooth controller number]
      # In this example, the device we want to use is hci1
      $ sudo out/debug/chip-air-quality-sensor-app --ble-controller 1
    

  • Test the device using ChipDeviceController on your laptop / workstation etc.

Trigger event using air-quality-sensor-app event named pipe

You can send a command to air-quality-sensor-app to trigger specific event by adding the --app-pipe argument with the named pipe path value <file_path>

Example to enable named pipes

sudo out/debug/chip-air-quality-sensor-app --app-pipe /tmp/air_quality_named_pipe

Trigger air quality change event

Generate event AirQuality, to change the air quality value.

$ echo '{"Name":"AirQuality","NewValue":3}' > /tmp/air_quality_named_pipe

Trigger Temperature change event

Generate event TemperatureMeasurement, to change the temperate value.

$ echo '{"Name":"TemperatureMeasurement","NewValue":1800}' > /tmp/air_quality_named_pipe

Trigger Humidity change event

Generate event RelativeHumidityMeasurement, to change the relative humidity value (6000 for 60,0 %).

$ echo '{"Name":"RelativeHumidityMeasurement","NewValue":6000}' > /tmp/air_quality_named_pipe

Trigger concentration change event

Concentration change events can be trigger on the concentration measurement clusters.

Generate event CarbonDioxideConcentrationMeasurement, to change the CO2 value.

$ echo '{"Name":"CarbonDioxideConcentrationMeasurement","NewValue":400}' > /tmp/air_quality_named_pipe

Generate event CarbonMonoxideConcentrationMeasurement, to change the CO value.

$ echo '{"Name":"CarbonMonoxideConcentrationMeasurement","NewValue":1}' > /tmp/air_quality_named_pipe

Generate event NitrogenDioxideConcentrationMeasurement, to change the NO₂ value.

$ echo '{"Name":"NitrogenDioxideConcentrationMeasurement","NewValue":1}' > /tmp/air_quality_named_pipe

Generate event Pm1ConcentrationMeasurement, to change the PM1 value.

echo '{"Name":"Pm1ConcentrationMeasurement","NewValue":1}' > /tmp/air_quality_named_pipe

Generate event Pm25ConcentrationMeasurement, to change the PM2.5 value.

echo '{"Name":"Pm25ConcentrationMeasurement","NewValue":2.5}' > /tmp/air_quality_named_pipe

Generate event Pm10ConcentrationMeasurement, to change the PM10 value.

echo '{"Name":"Pm10ConcentrationMeasurement","NewValue":10}' > /tmp/air_quality_named_pipe

Generate event TotalVolatileOrganicCompoundsConcentrationMeasurement, to change the TVOC value.

$ echo '{"Name":"TotalVolatileOrganicCompoundsConcentrationMeasurement","NewValue":100}' > /tmp/air_quality_named_pipe