Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
oscgonfer committed Apr 19, 2024
1 parent ea757f0 commit 2184b09
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,26 @@
# Smart Citizen Kit 2.1
# Smart Citizen Kit 2.X

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)]()
[![DOI](https://zenodo.org/badge/109865611.svg)](https://zenodo.org/badge/latestdoi/109865611)
![](https://live.staticflickr.com/65535/47950912168_fcf8fa398c_h.jpg)

[Click here for version 2.0](https://github.com/fablabbcn/smartcitizen-kit-20)
Welcome to the Smart Citizen Kit main repository. Here you will find the hardware design files and the firmware for the SCK 2.1 and SCK 2.2 versions. [Click here for version 2.0](https://github.com/fablabbcn/smartcitizen-kit-20)

![](https://live.staticflickr.com/65535/47950912168_fcf8fa398c_h.jpg)

## Documentation

* If you want to read more about the Smartcitizen Kit or its sensors please check our [documentation](http://docs.smartcitizen.me/)
* If you just want to **upgrade** your Smartcitizen kit **firmware** please refer to the [Updating the Smartcitizen Kit Firmware](http://docs.smartcitizen.me/Guides/firmware/Update%20the%20firmware/) guide.
* If you want to change something and build the firmware, use the [Building and flashing the Smartcitizen Kit firmware](http://docs.smartcitizen.me/Guides/firmware/Edit%20the%20Firmware/) guide.
* If you want to read more about the Smart Citizen Kit or its sensors please check our [documentation](http://docs.smartcitizen.me/)
* If you just want to **upgrade** your Smart Citizen kit **firmware** please refer to the [Upgrading the Smart Citizen Kit Firmware](http://docs.smartcitizen.me/Guides/firmware/Update%20the%20firmware/) guide.
* If you want to change something and build the firmware, use the [Building and flashing the Smart Citizen Kit firmware](http://docs.smartcitizen.me/Guides/firmware/Edit%20the%20Firmware/) guide.
* The SCK provides a comprehensive command shell over USB to manage all the kits functionalities for advanced users: [Using the Smartcitizen Kit shell](http://docs.smartcitizen.me/Guides/getting%20started/Using%20the%20Shell/) guide.
* A compilation of Smartcitizen hardware work in a single **open publication:** [_Hardware X: Special Issue on Open-Hardware for Environmental Sensing and Instruments_](https://doi.org/10.1016/j.ohx.2019.e00070)
* A compilation of Smartcitizen hardware work in a single **open publication:** [_Hardware X: Special Issue on Open-Hardware for Environmental Sensing and Instruments_](https://doi.org/10.1016/j.ohx.2019.e00070).
* You can also follow the [forum](https://forum.smartcitizen.me/) and [twitter](https://twitter.com/SmartCitizenKit) for updates.

## Development

In this repository you can find:

* The Smartcitizen Kit 2.1 hardware [design files](./hardware).
* The Smart Citizen Kit hardware [design files](./hardware).
* The [bootloader](bootloader) and [main firmware](./sam) (C++) for the SAMD21 microcontroller.
* The [main firmware](./esp) for the ESP8266 microcontroller.
* A [mobile web UI](./mock-api) for setting up the kit.
Expand All @@ -31,6 +33,7 @@ In this repository you can find:
* Kit Enclosures [github.com/fablabbcn/smartcitizen-enclosures](https://github.com/fablabbcn/smartcitizen-enclosures)
* Useful software resources for communities [github.com/fablabbcn/smartcitizen-toolkit](https://github.com/fablabbcn/smartcitizen-toolkit)
* Advanced data analysis tools [github.com/fablabbcn/smartcitizen-data](https://github.com/fablabbcn/smartcitizen-data)
* Python API connector [github.com/fablabbcn/smartcitizen-data](https://github.com/fablabbcn/smartcitizen-connector)
* Analog Sensor Board [github.com/fablabbcn/smartcitizen-analog-sensor-board](https://github.com/fablabbcn/smartcitizen-analog-sensor-board)
* PM Board [github.com/fablabbcn/smartcitizen-kit-pm-board](https://github.com/fablabbcn/smartcitizen-kit-pm-board)

Expand Down

0 comments on commit 2184b09

Please sign in to comment.