> For the complete documentation index, see [llms.txt](https://monitoring.toolkit.citiobs.eu/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://monitoring.toolkit.citiobs.eu/sensing-devices/how-to-setup-the-smart-citizen-kit-for-air-quality-monitoring.md). # How to setup a Smart Citizen Kit for air quality monitoring? This guide will help COs assemble Smart Citizen Kits, register them, and deploy them to start collecting data. The Smart Citizen Kit (SCK) is an open source environmental monitoring device, customizable and modular for multiple use cases. {% hint style="info" %} The devices provided as part of CitiObs are Smart Citizen Kits (or SCK). These devices are *open source, customizable* environmental monitoring devices, and they are developed from Barcelona. If you are interested, you can order them from [LabMaker](https://www.labmaker.org/products/smart-citizen-kit) or [SeeedStudio](https://www.seeedstudio.com/Smart-Citizen2-3-p-6327.html). Contact us at for more information on custom developments. {% endhint %} Depending on what type of device you have (we also call them *kits)*, you will need to start at a different step: * If you have a DIY[^1] kit, you will need to follow the [device assembly section](#device-assembly) and then move on to the [device registration section](#device-registration). * For cases that requested pre-assembled kits, you can skip ahead to the [device registration section](#device-registration). {% hint style="warning" %} **Important note!** **Mobile kits and kits with more complex metrics (CO2 or NO2) are not available as DIY due to their complexity** and the need for more elaborate testing before shipment. These devices will been shipped pre-assembled regardless of the overall requested preference for the Alliance Case. {% endhint %} ## Device assembly DIY kits will need to be assembled before deployment. All the components needed are shipped along with the sensors, including 3D printed enclosure components, screws, etc. {% hint style="info" %} However, simple tools like screw drivers **are not included** and will need to be acquired separately to complete the building process. The exception to this are the HEX keys which are less common. 1-2 of each is provided per DIY Alliance Case. {% endhint %} ### Components {% hint style="warning" %} For DIY kits, there is a small code printed on the box (a four-digit code with a mix of letters and numbers - see component photos below). You will need this code to identify your device while registering it. **It is important not to mix up the numbers,** so keep all the components from one box together and keep track of which device corresponds to which device number.\ \ We suggest you transfer the sticker from the box to the bottom of the PM sensor (see picture below) if there is not already a sticker with the same number. This way, you always have clear which device is which, and this placement gives easy access to check the code when the sensors are deployed. \

{% endhint %} #### Indoor Devices For **indoor DIY kits**, you will need the following components: * 1 x ["multipurpose" cover](#user-content-fn-2)[^2] (3D printed) * 1 x base (3D printed) * 1 x Smart Citizen Starter Pack box: * Smart Citizen Kit 2.3 with PM sensor * SD card and reader * 2Ah Battery * USB charger and cable * 1 x plastic bag with the following components: * 2 x latches * 1 x clip for PM and electronics board * 6 x M3x30mm INOX screws * 2x M3x10mm screws

Contents inside of Smart Citizen Kit Starter Pack

**Outdoor Devices** For **outdoor DIY kits**, you will need the following components: * 1 x [outdoor cover](#user-content-fn-3)[^3] (3D printed) :warning: * 1 x base (3D printed) * 1 x Smart Citizen Starter Pack box: * Smart Citizen Kit 2.3 with PM sensor * SD card and reader * 2Ah Battery * USB charger and cable * 1 x plastic bag with the following components: * 2 x latches * 1 x clip for PM and electronics board * 6 x M3x30mm INOX screws * 2 x M3x10mm screws * 2 x nylon spacers * 1 x aluminum umbrella * 1 x power supply with cables with cover * 1 x plastic bag with the following components: * 4 x M3x15mm screws * 1 x M4x10mm screw * 1 x M4x25mm screw * 4 x M3x15mm screws * [Filtering foam](#user-content-fn-4)[^4] (large sheet of thin black foam, roughly A4 size)

Outdoor DIY components (umbrella screws)

**Tools (included)** * 1 x 2.5 HEX key * 1 x 3 HEX key (for outdoor umbrella only) **Tools (not included, but needed)** * 1 x Phillips screw driver ### Assembly Steps #### 1. Assemble the enclosure Insert the 6 x M3x30mm INOX screws as indicated in the photographs below. {% hint style="info" %} It is easiest to start with the screws on the individual sides of the enclosure, and then to close the box with the hinges in order to align more precisely the two sides. {% endhint %} {% hint style="danger" %} Do not screw the components too tightly, they just need to be screwed into place so that the head of the screw is touching the 3D printed component. {% endhint %}

#### 2. Assemble the device * Insert the micro SD card into the slot

* Separate the two boards, insert the nylon spacers, then reconnect the boards assuring that the pins are correctly aligned. (***See video below.***) * Insert the PCB boards into the 3D printed clip. There is a small groove where the board sits, slide the board all the way in and then snap the two other corners into place. (***See video below.***)

{% embed url="" fullWidth="false" %} * Insert the PM sensor into it's slot in the clip, and push it snugly into place

* Connect the PM cable from the PCB board to the PM sensor feeding it through the holders on the back of the clip to keep it flat. * The cable orientation does not matter, both ends are the same.

* Insert the components into the base of the enclosure, ensuring that it is fully pushed into the enclosure.

* Tuck the battery into place behind the PCB board, using the PM cable to keep it in place.

* Use the 2x M3x10mm and the 2.5 HEX key to screws to screw the clip and components into place

#### 3. Assemble the umbrella (for outdoor devices only) * Using the 2.5 HEX key, install the 4 x M3x15mm screws into the four holes on the underside of the umbrella.

{% hint style="danger" %} These screws should only be screwed in far enough that the screws touch the material below, they do not need to be tightened further, doing so can damage the umbrella. {% endhint %} * Align the enclosure as indicated in the left image below. Using the M4x10mm screw and the 3 HEX key connect the power supply box to the umbrella (bottom left hole, as indicated in the right image), then secure the enclosure using the M4x25mm screw (top left hole) with the 3 HEX key. This should lock the device in place. Check that the device does not move and that you can see the screw pushing the top of the device down securely.

* Using the 4 x M3x15mm screws and a Phillips screw driver, attach the power supply cover.

* Feed the USB cable through the enclosure box and plug it into the device.

* Connect the battery and plug in the device into a wall outlet.

{% hint style="warning" %} Due to the power needs of the SCK2.3 (and SCK2.2), the SCK always needs a battery connected. {% endhint %} * Cut and insert filtering foam to protect the sensors from water and dust buildup (this foam was included with other materials as a large sheet, roughly A4). {% hint style="danger" %} Note, this is the foam we are talking about...

{% endhint %}

## Device registration Once the device is assembled, you can proceed to register your device in the online platform. CitiObs devices are registered through the [Smart Citizen Platform](https://smartcitizen.me/kits). There are two steps to this: 1. [Create an account in the platform, and register all your devices on it](#onboarding-your-device) 2. Share the account name with Smart Citizen Team () to enable *research* options 3. [Enable data forwarding to CitiObs tools](#enable-data-forwarding-to-citiobs-tools) ### Onboarding your device The *onboarding* app will guide you through the process of the setup using simple language and a friendly graphic language. {% hint style="danger" %} **To read before you proceed** The Smart Citizen platform requires a free account to register a device or, in other words, each device requires an owner. We recommend using **one account per case in CitiObs**, and to register all the devices in a certain case on the same account. {% endhint %} Visit the *onboarding* app at [start.smartcitizen.me](https://start.smartcitizen.me/). Before you start make sure you have: * A computer to visit the onboarding app * A smartphone (or tablet, or another computer) to connect to the kit and configure it The app will guide you through the steps. Let us know if there is any issue. ### Enable data forwarding to CitiObs Platform The easiest way to enable forwarding is to visit your device on [the website](#user-content-fn-5)[^5] and click on the `EDIT button` on the bottom part of the graphs. ![Edit Smart Citizen Kit](/files/Nhaoz1Xt5gZ7KeRmS05P) Then, scroll down to the forwarding section and enable the checkbox. Make sure all the other settings are shown as in the image below, and to hit **update** when you are done!

In addition, please add the `CitiObs` `tag` on your device: ![Add device tags](/files/zlZUUOsafeb89wz5X9A4) {% hint style="warning" %} If you do not see this, please contact us at {% endhint %} {% hint style="success" %} Once you are done, make sure you hit **Update**! {% endhint %} ### Enable notifications The easiest way to enable forwarding is to visit your device on [the website](#user-content-fn-5)[^5] and click on the`EDIT button` on the bottom part of the graphs. ![Edit Smart Citizen Kit](/files/Nhaoz1Xt5gZ7KeRmS05P) Then, scroll down to the notifications section and enable both. This will trigger an email in case the device stops publishing. This step is crucial to ensure that, in the event of sensor malfunction, we can avoid data loss. There are no additional notifications on that email. ![Enable notifications](/files/dzQP4tz5hh7Bbl3nlgpX) {% hint style="success" %} Once you are done, make sure you hit **Update**! {% endhint %} ### Create an *experiment* *An experiment is a way to group devices and share data with others through the Smart Citizen Platform. You can create an experiment by visiting your user profile:*

Fill out the relevant information such as `name`, `description`, `start and end dates` and add the devices on the `KITS` section. You can search there for your COs devices and create a collection of devices which is very handy to share later on. {% hint style="info" %} You can look at an example experiment at:

{% endhint %} ### Advanced devices Advanced devices (such as NO2 devices), requires handling of calibration data. For this reason, it's necessary to store the physical ID (`Station ID` or `Hardware ID`) of the unit alongside to the virtual device in the Smart Citizen Platform. The hardware ID should normally be in a sticker to the enclosure both inside and outside and looks like this: ![Hardware IDs](https://hackmd.io/_uploads/B1bz-KbUA.jpg) **Station ID** * This number is important to relate to the actual calibration values of the sensors, stored in the data repository. In order to postprocess the data and calculate pollutants, make sure that the `Station ID` is safely stored in the platform's device {% hint style="danger" %} This hardware ID is not the same as the `device ID`. The `device ID` is the number you have after the smartcitizen.me/kits/ url where you see the data of your device. The `Station ID` is the one in the sticker. The `Station ID` is not meant to change, while the `device ID` can change as you can register your kit many times! {% endhint %} * The easiest way to enable forwarding is to visit your device on [the website](#user-content-fn-5)[^5] and click on the`EDIT button` on the bottom part of the graphs. ![Edit Smart Citizen Kit](/files/Nhaoz1Xt5gZ7KeRmS05P) * Then, in the `hardware URL` field, introduce the number in the sticker (it should be something like `SCAS2200XX`) ![Postprocessing hardware URL](/files/rYobfhostAfB58gkIOcD) * Once this process is done, you should be able to check that the postprocessing is safely stored in the Platform by visiting the following link (Make sure your`` is correct): `https://api.smartcitizen.me/v0/devices//` {% hint style="success" %} After this, we will take care of processing the data in a periodic way. {% endhint %} ## Device Deployment ### Indoor devices There are **only** two possibilities for the device to be placed indoors: laterally or vertically. {% hint style="info" %} The device **should never be placed horizontally** (wide side flat on a surface). This placement would cover completely the sensor inlets, or leave them exposed to dust accumulation. Likewise, the sensors, do not work properly on this configuration. {% endhint %} ![Lateral placement of devices](https://hackmd.io/_uploads/rysUp_ZIC.png) ![Vertical placement of devices (note the PM sensor position)](https://hackmd.io/_uploads/HJjwa_WIA.png) ### Outdoor devices The outdoor devices are deployed as below: ![Outdoor device installation reference](https://docs.smartcitizen.me/assets/images/station-small-front.jpg) Some basic deployment tips: * Try to keep the device continuously powered if it is installed in a fixed location. * Avoid using the device in places with high humidity or large amounts of dust; otherwise, clean/check the device periodically to prevent potential issues. * Avoid covering the sensors, especially the PM sensor. * Deploy the device facing downwards if outdoors, so that dust doesn't accumulate on the sensors. * Avoid direct airflow towards the sensors; if exposed under flow conditions, keep the flow parallel to the sensor surfaces. * Avoid exhaust from air conditioning units, kitchens, etc. * Protect the sensors from moisture using filtering foam, nail polish, or both to cover the sensor pads (see [here](https://docs.smartcitizen.me/_FAQ/#are-the-electronics-waterproof)). ## Additional information The [Smart Citizen Documentation](https://docs.smartcitizen.me) provides all information related to the hardware, the data and what can be done with it. Some quick links: {% hint style="info" %} 🚀 **Installation**: [start.smartcitizen.me](https://start.smartcitizen.me/) 🌍 **Platform**: [smartcitizen.me/kits](https://smartcitizen.me/kits) :book: **Docs**: [docs.smartcitizen.me](https://docs.smartcitizen.me/) 📟 **Hardware documentation**: [features](https://docs.smartcitizen.me/hardware/kit/features/) 💻 **API**: [api.smartcitizen.me](https://api.smartcitizen.me/) :chart: **Data tools**: [data tools](https://docs.smartcitizen.me/data/data-tools/) 💬 **Discuss**: [forum.smartcitizen.me](https://forum.smartcitizen.me/) ❓ **Support**: ✨ **Something big?**: 🚨 **Platform status**: [status.smartcitizen.me](https://status.smartcitizen.me/) ☔ **Download Enclosures**: [enclosures.smartcitizen.me](https://enclosures.smartcitizen.me/) {% endhint %} ### Battery Information All devices comes with USB cable and an adapter with an additional 2000mAh LiPo battery. The SCK has a micro USB port and can be charged like any smartphone or tablet using a dedicated adapter or a computer USB port. {% hint style="info" %} Battery characteristics can be found in the following [link](https://docs.smartcitizen.me/_FAQ/#what-batteries-are-shipped-with-the-kits) :warning: **Remember** - due to the power needs of the SCK2.3 (and SCK2.2), the battery always needs a battery connected. {% endhint %} ### Data logging **Wi-Fi Mode (online)** This is the standard mode and requires a Wi-Fi connection. In this way, the device will publish data every minute (time resolution can be configured) on the smartcitizen.me platform. If a micro SD card is inserted, the data will be stored in duplicate as a backup. {% hint style="info" %} The kit supports Wi-Fi WEP, WPA/WPA2 and open networks, those the standard Wi-Fi networks found in domestic and small businesses environments. However, it does not support WPA/WPA2 Enterprise networks such as EDUROAM or networks with captive portals such as those found in Airports and Hotels. {% endhint %} ### **SD Mode (offline)** If we do not have an internet connection, we can use the SD mode. In this case, the device will record the data on the micro SD card. Later we can read the card using a card reader. The recorded data can be visually explored in a spreadsheet but also published on the platform utilising the [UPLOAD CSV](https://docs.smartcitizen.me/guides/getting-started/uploading-sd-card-data/) option. ### **Limitations** {% hint style="danger" %} While on SD-card mode, the device needs constant power (either USB or battery). {% endhint %} * The Kit location needs to be set during the installation process, and it can be updated at any time using the `EDIT` option on the platform if you made a mistake. However, the Kit does not record its location automatically neither we can't have multiple locations for the same Kit in the platform. * **Unstable Wi-Fi environments need careful consideration**. Check these guidelines for support: [^1]: do-it-yourself (or in other words, not assembled) [^2]: NOTE: This cover is different from the outdoor one below. It has some slots for passing zip ties and a small indentation for hanging the kit on a wall with a screw. [^3]: NOTE: This cover is different from the indoor one above. It has two support holes for screws and two notches for the lower screws of the umbrella. [^4]: This is **not** the foam that comes inside of each individual Smart Citizen Kit box. [^5]: [https://smartcitizen.me/kits/DEVICE-ID](https://smartcitizen.me/kits/%3CDEVICE-ID%3E) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://monitoring.toolkit.citiobs.eu/sensing-devices/how-to-setup-the-smart-citizen-kit-for-air-quality-monitoring.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.