Skip to content

Latest commit

 

History

History
217 lines (151 loc) · 11.1 KB

README.md

File metadata and controls

217 lines (151 loc) · 11.1 KB
Raw

Air Quality Demo

Summary

This is a demo project showing the integration of Sensirion's environmental sensors with Cypress WICED SDK devices, using http://thingsboard.io as an online dashboard. Sensors used are the SHTC1 temperature humidity sensor and SGP30 air quality sensor as well as the SPS30 particulate matter sensor.

The demo is prepared to work on any WICED SDK device, requiring only adjustments to the inital configuration.

This tutorial assumes that the user is familiar with Cypress' WICED Studio, and Thingsboard. For questions on how to use these tools, please check their respective documentation.

The drivers for this demo are implemented using Sensirion's standard embedded drivers:

The WICED port is based on the wiced-ess implementation:

Dashboard preview

Table of contents

This documentation is separate into the following chapters:

  1. Hardware setup
  2. Software downloads
  3. Dashboard setup
  4. Device setup
  5. Configuring for a particular WICED platform

Hardware setup

Components

The hardware setup consists of the following components:

  • Hardware platform (reference design / development kit) supported by Cypress WICED SDK
  • Sensirion Environmental Sensor Shield (ESS) featuring the SHTC1 and SGP30 sensors
  • Sensirion SPS30 particulate matter sensor

The ESS requires a hardware platform which has Arduino-compatible expansion headers. Subsequenty, we will assume that the platform chosen has such expansion headers.

Note: Of course, the software will also work for other sensor boards featuring the SHTC1 and SGP30 sensor components, as long as they are correctly wired.

Interface cable for the SPS30

The interface of the SPS30 is described in its datasheet (chapter "Hardware Interface Specifications"). The connector is a ZHR-5 from JST Sales America Inc. The pin out is defined as follows when using the sensor in I2C mode:

Pin Function
1 VDD
2 SDA
3 SCL
4 SEL (GND for I2C)
5 GND

To make the cable, it's easier to buy pre-crimped cables.

In addition, to connect to the reference design, you can use any jumper cables you have available. Choose either a male of female connector based on your reference design. To connect to the ESS, female connectors are required. If you don't have cables available, the following is an example of cables that would work:

Finally, to assemble the cable, procede as follows:

  • Connect the five pre-crimped wires to the connector; ensure the cables are properly aligned
  • Connect Wire 4 SEL and 5 GND together

It is recommended to have at least 20cm or 8" of cable, which will allow for enough freedom to move the SPS30 around, so make sure you cut the jumper wires accordingly.

Note: It is also possible to use 2" pre-crimped wires, with longer jumper wires.

Wire 4 and 5 connected

  • Cut off a short piece of the jumper wires with the connector you need, strip a few mm of the other end of the cable
  • solder the jumper wires to the pre-crimped wires wires; for Wire 4 and 5, connect only one connector

jumper wires soldered together

  • Use heat shrink wrap and a heat gun to protect the solder joints

The pictures in this documention use a red jumper wire for VCC, green for SDA, yellow for SCL, and black for GND. You can choose any colors you like, of course. The resulting cable should look like this:

SPS30 cable

Connecting the SPS30 to the ESS board

The ESS has a connector on the back with power supply lines (VCC, GND) as well as I2C lines (SCL, SDA). This allows to connect another sensor easily. In this case however, the SPS30 requires an exact 5V supply voltage (+/-10%), which the VCC pin on the back won't deliver. So in order to supply this, you can connect the VCC pin of the SPS30 cable to any available 5V pin on your hardware platform.

Alternatively, you can solder a jumper wire to the 5V pin of your ESS board, and use super glue to fix it to the back of the ESS board. This allows to keep the connectings hidden and the setup neat:

Front:

Front view

Back:

Back view

Software downloads

Please download a current release ZIP file from https://github.com/winkj/aqdemo/releases. It will be use in subsequent sections

Dashboard setup

This demo is using http://thingsboard.io for visualization. To setup this demo, follow the following steps:

Setup device

  1. first create an account on their demo server https://demo.thingsboard.io/login
  2. Go to the Devices tab
  3. create a new device; you can choose any name, but we're going to use WICED_INPUT in this documentation; make sure you replace any occurances of this with the device name you chose

Device setup

Import Dashboard

  1. Go to the Dashboards tab
  2. import the dashboard from the downloaded ZIP, located in dashboard/air_quality_demo.json by pressing the red "+" button (bottom right), then the red "up arrow" button

Device setup

Create data alias for connected device

  1. Open the newly created dashboard (It's going to be called "Air Quality Demo"
  2. Press the edit button (red pen, bottom right)
  3. Select the entity aliases button, and make sure you have an alias named ess-input, Filter Type Single Device, Type Device, Device WICED_INPUT Device alias

Your dashboard is now ready to be used!

Make dashboard public

If you want to share the dashboard with others, make sure both the device and dashboard are public:

  1. Go to the Devices tab
  2. Make the device public by pressing the "share" icon (see screeshot below)
  3. Go back to the Dashboards tab
  4. Make the Dashboard public by pressing the "share" icon, and store the URL you're getting from this dialog

Share icon

Device setup

This demo is supporting Cypress WICED SDK devices.

Step 1: import the files

For the device setup, follow the following steps:

  1. Open WICED-Studio
  2. Go to the wiced directory in your downloaded ZIP file
  3. Select the "sensirion" directory, and press Ctrl-c to copy it
  4. Go to WICED Studio, and open 43xxx_Wi-Fi\libraries\drivers\sensors
  5. Press Ctrl-v
  6. Go back to the downloaded files.
  7. In the wiced directory, select the air_quality_demo folder, and press Ctrl-c to copy it
  8. Go back to WICED-Studio and open 43xxx_Wi-Fi\apps\demo
  9. Press Ctrl-v
  10. Create a new Make target called demo.air_quality_demo-<WICED PLATFORM NAME> download run

For the last step, put in the name of the WICED platform you're using.

Step 2: Adjust the files

  1. go to the air_quality_demo folder, and open air_quality_demo_secrets.h
  2. Change the WiFi information to match your wireless network
  3. Then, go to https://demo.thingsboard.io/devices, click on the device you created before, and select "Copy Access Token"
  4. Paste this value in air_quality_demo_secrets.h for the THINGBOARD_DEVICE_TOKEN #define

Step 3: Test without network

  1. To test without the networking setup, open air_quality_demo.c in your air_quality_demo directory, and comment out the #define ENABLE_DATA_UPLOAD
  2. Double click the make target you created earlier
  3. Open the serial console, and you should see the following output:
tVOC   21 | CO2eq  400 | T   25.83 | RH   33.46
measured values:
	0.55 pm1.0
	0.77 pm2.5
	0.92 pm4.0
	0.96 pm10.0
	3.26 nc0.5
	4.11 nc1.0
	4.32 nc2.5
	4.35 nc4.5
	4.35 nc10.0
	0.74 typical particle size

If you see this output, the setup worked as expected. You can then enable the networking (see next step). Please note that the measured values - the numbers shown above - are a representation of the live environment, so they will most likely be different in your setup.

Step 4: Test with Network upload

  1. To test with the networking enabled, open air_quality_demo.c in your air_quality_demo directory, and remove the comment from #define ENABLE_DATA_UPLOAD
  2. Double click on the make target you created earlier
  3. Check the serial configuration for information about the networking. If there's any errors here, make sure the correct Wi-Fi information is set in air_quality_demo_secrets.h
  4. Then, go to https://demo.thingsboard.io/devices, click on the device you created before, and click the "LATEST TELEMETRY"
  5. You should see a steady stream of data coming in
  6. Go to the dashboards tab, and select your new data.
  7. If everything works as expected, you should see the gauges and charts animated with the most recent data

The resulting dashboard should look like this:

Dashboard preview

Configuring for a particular WICED platform

This demo should be compatible with most WICED hardware platforms, however the code may have to be adjusted to match the hardware configuration.

To do that, open the file air_quality_demo.c, and locate the definition of device_config . This struct is of type ess_device_config_t, which is sensirion_ess library that's included in this demo. More information on that library can be found here.

To adapt your own configuration, add the following code:

const ess_device_config_t device_config = {
    .i2c_port              = WICED_I2C_1,
    .needs_init_workaround = 0,
    .leds_supported        = 0,
    .flags                 = I2C_DEVICE_NO_DMA
};

Simply change the .i2c_port to match the I2C port you are attaching the sensors to (e.g. WICED_I2C_1, WICED_I2C_2, WICED_I2C_3, WICED_I2C_4).

You can find a list of premade configurations for WICED devices in the wiced-ess library, which includes a default configuration called ESS_DEVICE_CONFIG_DEFAULT.

Configuring for Cypress CY8CKIT-062-WIFI-BT

In order to use the Arduino connector of the Cypress CY8CKIT-062-WIFI-BT - compatible with the Environmental Sensor Shield - set .i2c_port to WICED_I2C_4. This will configure the library to use the correct I2C port.