Skip to content

Commit

Permalink
Image updates for boards pages
Browse files Browse the repository at this point in the history
  • Loading branch information
peters-rebecca committed Jan 28, 2025
1 parent 931d6b3 commit 1d19918
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 32 deletions.
17 changes: 14 additions & 3 deletions docs/hardware/boards/data-board.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,14 @@

The Data Board is a data-logger at the core of the sensors architecture supporting the Smart Citizen Kit and the Smart Citizen Station. This module is powered by an ARM M0+ 32-bits 48Mhz **SAMD21** running the [Smart Citizen Firmware](/Components/Firmware), combining the low power consumption of the ARM M0 family with the power of a 32-bits processor with 32KB of RAM and 256KB of FLASH memory. This solution offers enough program storage and memory space to support multiple auxiliary sensors. This chip is used by the Arduino Zero and MKR boards, therefore benefiting from the open community built around these boards in particular and the Arduino project in general.

<img src="https://live.staticflickr.com/65535/47950912298_2b132245cb_h.jpg" walt="SCK 2.1 Data Board">
=== "SCK2.3"
<img style="max-height: 325px; width: 100%; object-fit: cover;" src="https://live.staticflickr.com/65535/54281911435_c1ae473a74_o.jpg" alt="SCK2.3 Data Board"/>
=== "SCK2.2"
<img style="max-height: 325px; width: 100%; object-fit: cover;" src="https://live.staticflickr.com/65535/54281911450_2edda8b7ed_o.jpg" alt="SCK2.2 Data Board"/>
=== "SCK2.1"
<img style="max-height: 325px; width: 100%; object-fit: cover;" src="https://live.staticflickr.com/65535/54281911410_5f944402a3_o.jpg" alt="SCK2.1 Data Board"/>

<a class="github-button" data-size="large" href="https://github.com/fablabbcn/smartcitizen-kit-21" aria-label="Check the source code">Check the source code</a>
<a class="github-button" data-size="large" href="{{ config.extra.urls.ghhardware.link }}" aria-label="Check the design files">Check the design files</a>

The Data Board also includes a Wi-Fi module, a micro SD card slot, an internal Flash and a battery management solution. In addition, it includes 4MB of extra Flash Memory for offline data storage, in case of network brownouts. The Wi-Fi Module is the well-known [Espressif ESP8266](https://www.espressif.com/en/products/hardware/esp8266ex/overview) IEEE 802.11 b/g/n Wi-Fi with 4MB Internal Flash for web content storage:

Expand All @@ -22,7 +27,12 @@ The controller allows the batteries to be easily charged using the boards micro

## Firmware

The Smart Citizen Kit firmware is comprised of two parts: 1) the primary processing tasks are done by the SAMD21 microcontroller firmware; 2) the tasks related to network communication are run through the ESP8266. The SAMD21 is built on top of the Arduino Zero with a custom variant for the Data Board main MCU. The ESP8266 is also built using the Arduino ESP Core. Both firmwares are built and managed with Platform IO, an open-source IDE for embedded development. Platform IO features built-in dependency management and allows you to compile and upload both processors with a single command. Using the SWD ARM connector you can change the MCU bootloader and debug the firmware using Open Source tools.
The Smart Citizen Kit firmware is comprised of two parts:

1. the primary processing tasks are done by the SAMD21 microcontroller firmware;
2. the tasks related to network communication are run through the ESP8266.

The SAMD21 is built on top of the Arduino Zero with a custom variant for the Data Board main MCU. The ESP8266 is also built using the Arduino ESP Core. Both firmwares are built and managed with Platform IO, an open-source IDE for embedded development. Platform IO features built-in dependency management and allows you to compile and upload both processors with a single command. Using the SWD ARM connector you can change the MCU bootloader and debug the firmware using Open Source tools.

!!! info

Expand Down Expand Up @@ -78,5 +88,6 @@ You can find all the design files for the different versions of the Urban Boards

!!!info "Previous versions"
Previous versions of the SCK, are in their respective repositories:

- Smart Citizen Kit 2.0: https://github.com/fablabbcn/smartcitizen-kit-20
- Smart Citizen Kit 1.5: https://github.com/fablabbcn/smartcitizen-kit-15
8 changes: 4 additions & 4 deletions docs/hardware/boards/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@

The core of the system is the [Data Board](/hardware/boards/data-board), a data logger with Wi-Fi connectivity, a micro SD-card, micro USB and battery connectors. Different components can be connected to the board: customized sensor boards, or a wide range of digital and analog sensors. The idea is to make it very easy to get started, no matter if you want to collect air quality or noise data, working on educational settings, or on more _advanced_ scientific research. The type of sensors that we normally work with can take [air](/knowledge/air), [water](/knowledge/water) or [soil](/knowledge/soil) measurements.

<img src="https://live.staticflickr.com/65535/47950912298_3bc1587732_k.jpg" alt="SCK 2.1 Data Board"/>
<img style="max-height: 350px; width: 100%; object-fit: cover;" src="https://live.staticflickr.com/65535/54281911435_c1ae473a74_o.jpg" alt="SCK 2.3 Data Board"/>

The [Data Board](/hardware/boards/data-board) is always used with other components, depending on what you want to measure. Below, we list the most common use cases. Any configuration can send the data to a dedicated [Smart Citizen platform](/data/data-platform/), which can then be visualised through a web interface.
The [Data Board](/hardware/boards/data-board) is always used with other components, depending on what you want to measure. Below, we list the most common use cases. Any configuration can send the data to a dedicated [Smart Citizen platform](/data/data-platform/), which can then be visualised through a web interface.

## Sensor Boards

The most popular one of these boards are the [Urban Boards](/hardware/boards/urban-board/). These boards offer a selection of low-cost sensors in a board ready to measure the urban environment: temperature, humidity, noise, light, and PM2.5, among others. Together with the [Data Board](/hardware/boards/data-board), and a PM sensor, they create the [Smart Citizen Kit](/hardware/kit/).

<img src="https://live.staticflickr.com/65535/53968621878_f3e3878856_k.jpg" alt="Urban-Board-composite"/>
<img style="max-height: 370px; width: 80%; object-fit: cover;" src="https://live.staticflickr.com/65535/54281726349_e3353f828b_o.jpg" alt="SCK2.3 Urban Board"/>

## Interface Boards

These boards are used to interface with sensors that the _data board_ can't interface with directly:

* [Analog Sensors Board](/hardware/boards/analog-sensor-board/): An auxiliary board using two high-resolution Analog to Digital Converters (ADCs) capable of reading 8 analog channels at 16 bit resolution. It is used in the [Smart Citizen Stations](/hardware/stations/) for the interfacing with sensors such as [electrochemical cells](/knwoledge/sensors/air/chemical/Alphasense_Electrochemical/) or [PIDs](/knwoledge/sensors/air/chemical/Alphasense_PID/).

<img src="https://live.staticflickr.com/65535/53968621883_5c4f1ab625_k.jpg" width="2048" height="1364" alt="Analog-Sensor-Board-front-b"/>
<img style="max-height: 350px; width: 100%; object-fit: cover;" src="https://live.staticflickr.com/65535/53968621883_5c4f1ab625_k.jpg" alt="Analog-Sensor-Board-front-b"/>

* The [PM Sensors Board](/hardware/boards/pm-board/): An auxiliary board capable of driving two [PMS5003 Particulate Matter sensors](/hardware/sensors/air/OPCs/) as well as other auxiliary sensors required for specific deployments. It is generally used in the big [Smart Citizen Stations](/hardware/stations/).

Expand Down
24 changes: 10 additions & 14 deletions docs/hardware/boards/urban-board.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ interface: None

# Urban Board

## Description

The Urban Board is a solution that contains a selection of low-cost sensors for environmental monitoring. The actual [measurements](#measurements) it takes depend on the version, but overall, it is capable of measurements such as:

- Temperature and Relative Humidity
Expand All @@ -21,21 +19,18 @@ The Urban Board is a solution that contains a selection of low-cost sensors for

The Urban Board has undergone several modifications throughout its development, and its current version is the **V2.3**. Below you can see all versions:

<!-- === "SCK 2.0"
![TODO](SCK20) -->
=== "SCK 2.3"
<img src="https://live.staticflickr.com/65535/54163699376_1cd43f2fe7_k.jpg" alt="SCK2.3 Urban Board"/>
=== "SCK 2.2"
<img src="https://live.staticflickr.com/65535/53967486162_a874c1baf3_k.jpg" alt="SCK2.2 Urban Board"/>
=== "SCK 2.1"
<img src="https://live.staticflickr.com/65535/47950912253_1404d418dd_k.jpg" alt="SCK2.1 Urban Board"/>

=== "SCK2.3"
<img style="max-height: 450px; width: 100%; object-fit: cover;" src="https://live.staticflickr.com/65535/54281726349_e3353f828b_o.jpg" alt="SCK2.3 Urban Board"/>
=== "SCK2.2"
<img style="max-height: 450px; width: 100%; object-fit: cover;" src="https://live.staticflickr.com/65535/54281726359_471ec852eb_o.jpg" alt="SCK2.2 Urban Board"/>
=== "SCK2.1"
<img style="max-height: 450px; width: 100%; object-fit: cover;" src="https://live.staticflickr.com/65535/54281911420_32e26bdd40_o.jpg" alt="SCK2.1 Urban Board"/>

<a class="github-button" data-size="large" href="https://github.com/fablabbcn/smartcitizen-kit-2x" aria-label="Check the source code">Check the source code</a>
<a class="github-button" data-size="large" href="{{ config.extra.urls.ghhardware.link }}" aria-label="Check the design files">Check the design files</a>

## Assembly

The Urban Board connect to the [Data Board](/hardware/boards/data-board/) connector named `Sensor Board`:
The Urban Board connects to the [Data Board](/hardware/boards/data-board/) with the connector labeled `Sensor Board`:

![](/assets/images/sck-connection.png)

Expand Down Expand Up @@ -87,9 +82,10 @@ The Urban Board connect to the [Data Board](/hardware/boards/data-board/) connec

## Design files

You can find all the design files for the different versions of the Urban Boards in the [hardware repository]({{ extra.urls.ghhardware.link }}).
You can find all the design files for the different versions of the Urban Board in the [hardware repository]({{ extra.urls.ghhardware.link }}).

!!!info "Previous versions"
Previous versions of the SCK, are in their respective repositories:

- Smart Citizen Kit 2.0: https://github.com/fablabbcn/smartcitizen-kit-20
- Smart Citizen Kit 1.5: https://github.com/fablabbcn/smartcitizen-kit-15
11 changes: 0 additions & 11 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,3 @@ hide:
---

{{ insert_custom_cards(custom_cards = ['smart_citizen_kit.html', 'smart_citizen_stations.html', 'data.html', 'guides.html', 'knowledge.html', 'about.html'], wide_columns = True) }}

<!--
## Open Source
**We're against black boxes!**
The entire project is released under open source licenses:
* Hardware components: [CERN Open Hardware License v1.2](https://www.ohwr.org/licenses/cern-ohl/license_versions/v1.2)
* Core firmware and data tools: [GNU GPL v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html)
* Software platform: [GNU AGLP v3.0](https://www.gnu.org/licenses/agpl-3.0.en.html) -->

0 comments on commit 1d19918

Please sign in to comment.