Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
375 lines (366 loc) · 14.9 KB
/
Copy pathmkdocs.yml
File metadata and controls
375 lines (366 loc) · 14.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
site_name: Smart Citizen Docs
site_description: Smart Citizen Documentation
site_author: Fab Lab Barcelona
site_url: https://docs.smartcitizen.me/
repo_name: smartcitizen-docs
repo_url: https://github.com/fablabbcn/smartcitizen-docs
nav:
- Main:
- Welcome!: index.md
- Hardware:
- hardware/index.md
- Smart Citizen Kit:
- hardware/kit/index.md
- Features: hardware/kit/features.md
- Technical Specs: hardware/kit/specs.md
- Smart Citizen Stations:
- hardware/stations/index.md
- Air:
- hardware/stations/air/index.md
- SCK + T / RH: hardware/stations/air/sck-temp.md
- SCK + CO2: hardware/stations/air/sck-co2.md
- SCK + 1x CHEM: hardware/stations/air/sck-1xchem.md
- SCK + 2x CHEM: hardware/stations/air/sck-2xchem.md
- SCK + CO2 + HCHO: hardware/stations/air/sck-co2-hcho.md
- SCK + CO2 + 2x CHEM: hardware/stations/air/sck-co2-2xchem.md
- Water:
- hardware/stations/water/index.md
- One-Sensor Station: hardware/stations/water/sck-water-single.md
- Multi-Sensor Station: hardware/stations/water/sck-water-multi.md
- Firmware:
- hardware/firmware/index.md
# - Features: hardware/firmware/features.md
- Boards:
- hardware/boards/index.md
- Data Board: hardware/boards/data-board.md
- Urban Board: hardware/boards/urban-board.md
- Analog Sensor Board: hardware/boards/analog-sensor-board.md
- Discontinued:
- Gases Pro Board: hardware/boards/gases-pro-board.md
- PM Board: hardware/boards/pm-board.md
- Add-ons:
- hardware/addons/index.md
- GPS: hardware/addons/gps.md
- Power Supply: hardware/addons/power-supply.md
- Solar Panel: hardware/addons/solar-panel.md
- OLED Screen: hardware/addons/oled-screen.md
- Atlas EZO Drivers: hardware/addons/atlas-drivers.md
- Data:
- data/index.md
- Data Platform: data/data-platform.md
- Data Tools: data/data-tools.md
- SD-card Storage: data/sd-card.md
- Experiments: data/experiments.md
- FAQ: _FAQ.md
- Troubleshooting: troubleshooting.md
- Knowledge:
- knowledge/index.md
- Calibration: knowledge/calibration.md
- Air:
- Introduction: knowledge/air/index.md
- Particulate Matter:
- knowledge/air/pm/index.md
- Plantower PMS5003: knowledge/air/pm/Plantower_PMS5003.md
- Sensirion SPS30: knowledge/air/pm/Sensirion_SPS30.md
- Sensirion SEN5X: knowledge/air/pm/Sensirion_SEN5X.md
- Chemical composition:
- knowledge/air/chemical/index.md
- Alphasense PID: knowledge/air/chemical/Alphasense_PID.md
- Figaro TGS260X: knowledge/air/chemical/Figaro_TGS260X.md
- Sensirion SFA30: knowledge/air/chemical/Sensirion_SFA30.md
- Alphasense Electrochemical: knowledge/air/chemical/Alphasense_Electrochemical.md
- SGX Mics: knowledge/air/chemical/SGX_MICS.md
- AMS CCS811: knowledge/air/chemical/AMS_CCS811.md
- Bosch BME680: knowledge/air/chemical/Bosch_BME680.md
# - Sciosense ENS160: hardware/air/Sciosense_ENS160.md
# - Sensirion SPG4X: hardware/air/Sensirion_SPG4X.md
- CO2:
- knowledge/air/co2/index.md
- Sensirion SCD30: knowledge/air/co2/Sensirion_SCD30.md
- Sensirion SCD4X: knowledge/air/co2/Sensirion_SCD4X.md
- Noise:
- knowledge/air/noise/index.md
- TDK ICS43432: knowledge/air/noise/TDK_ICS43432.md
- Temperature:
- knowledge/air/temperature_rel_humidity/index.md
- Sensirion SHT3X: knowledge/air/temperature_rel_humidity/Sensirion_SHT3X.md
- Sensirion SHT3X Weatherproof: knowledge/air/temperature_rel_humidity/Sensirion_SHT3X-weatherproof.md
- Dallas DS18B20: knowledge/air/temperature_rel_humidity/DS18B20.md
- Light:
- knowledge/air/light/index.md
- Rohm BH1730FVC: knowledge/air/light/Rohm_BH1730FVC.md
- AMS AS7331: knowledge/air/light/AMS_AS7331.md
- AMS AS7341: knowledge/air/light/AMS_AS7341.md
- Pressure:
- knowledge/air/pressure/index.md
- NXP MPL3115A2: knowledge/air/pressure/NXP_MPL3115A2.md
- ST LPS33K: knowledge/air/pressure/ST_LPS33K.md
- Soil and Water:
- knowledge/soil-water/index.md
- pH:
- knowledge/soil-water/pH/index.md
- Atlas pH: knowledge/soil-water/pH/Atlas_pH.md
- Dissolved Oxygen:
- knowledge/soil-water/DO/index.md
- Atlas Dissolved Oxygen: knowledge/soil-water/DO/Atlas_DO.md
- Conductivity:
- knowledge/soil-water/EC/index.md
- Atlas Conductivity: knowledge/soil-water/EC/Atlas_EC.md
- Temperature:
- knowledge/soil-water/temperature/index.md
- Atlas Temperature: knowledge/soil-water/temperature/Atlas_Temperature.md
- ORP:
- knowledge/soil-water/ORP/index.md
- Atlas ORP: knowledge/soil-water/ORP/Atlas_ORP.md
- Soil Moisture:
- knowledge/soil-water/moisture/index.md
- Tensiometer: knowledge/soil-water/moisture/Tensiometer.md
- Chirp Soil Moisture: knowledge/soil-water/moisture/Chirp_Soil_Moisture.md
- Other:
- knowledge/other/index.md
- Electric Current/Voltage:
- knowledge/other/index.md
- Seeed Grove ADC (voltage): knowledge/other/Seeed_Grove_ADC.md
- TI ADS1X15 (voltage): knowledge/other/TI_ADS1X15.md
- TI INA219 (current): knowledge/other/TI_INA219.md
- Guides:
- Introduction: guides/index.md
- Getting Started:
- Assembling the kit: guides/getting-started/kit-assembly.md
- Onboarding your kit: guides/getting-started/onboarding-your-kit.md
- Updating the Wi-Fi: guides/getting-started/updating-wifi-credentials.md
- Updating the SCK token: guides/getting-started/updating-kit-token.md
- Downloading platform data: guides/getting-started/downloading-data.md
- Uploading SD-card data: guides/getting-started/uploading-sd-card-data.md
- Using the Shell: guides/getting-started/using-the-shell.md
- Third party sensors: guides/getting-started/third-party-sensors.md
# - External Sensors: guides/getting-started/External Sensors.md
# - Dealing with sensitive sensor readings: guides/getting-started/Dealing with sensitive sensor readings.md
- Firmware Operations:
- Getting firmware information: guides/firmware/getting-firmware-information.md
- Upgrading the firmware: guides/firmware/upgrading-the-firmware.md
- Enabling additional features: guides/firmware/enabling-additional-features.md
- Editing the firmware: guides/firmware/edit-the-firmware.md
- Debugging the firmware: guides/firmware/debug-the-firmware.md
- Recovering the bootloader: guides/firmware/recovering-the-bootloader.md
# - Calibrating Sensors:
# - Air sensors: guides/calibration/Air sensors.md
# - Water: guides/calibration/Water sensors.md
# - Soil: guides/calibration/Soil moisture sensors.md
# - Air:
# - CO2: guides/calibration/Sensirion SCD30.md
- Working with Data:
- Handling calibration data: guides/data/handling-calibration-data.md
- Sending data to a different platform: guides/data/sending-data-to-other-platforms.md
- Data processing: guides/data/custom-data-processing.md
- Creating data interfaces: guides/data/creating-interfaces.md
- Live demos: guides/data/live-demos.md
- Visual programming: guides/data/visual-programming.md
- Creative coding: guides/data/creative-coding.md
- Python, R and jupyter: guides/data/advanced-data-tools.md
- Debugging:
- Debugging your kit: guides/getting-started/debugging-your-kit.md
- Troubleshooting SD-card Mode: guides/getting-started/troubleshooting-sd-card.md
# - Model your sensor data: guides/data/Creating Models for Sensors Calibration.md
# - Analyse your data in batch: guides/Analyse your data in batch.md
# - Organising and sharing your data: guides/data/Organise your data.md
# - Deploying Devices:
# - Smart Citizen Kit: guides/deployments/Deploying SCK.md
# - iSCAPE Station V1: guides/deployments/Deploying iSCAPE Station V1.md
# - iSCAPE Station V2: guides/deployments/Deploying iSCAPE Station V2.md
# - Smart Citizen Air Station: guides/deployments/Deploying Air Station.md
# - Smart Citizen Water Station: guides/deployments/Deploying Water Station.md
# - Smart Citizen Connectivity Units: guides/deployments/Installing Connectivity Units.md
# - Smart Citizen Power Supply: guides/deployments/Using the power supply.md
# - Solar Panel: guides/deployments/Installing solar panel.md
# - Mobile sensors (GPS): guides/deployments/Mobile sensors.md
# - Replacements:
# - Replacing PM Sensors: guides/replacements/Replacing PM Sensors.md
# - Making Enclosures:
# - Making your own enclosures: guides/enclosures/Making your own enclosures.md
# - Assembling Smart Citizen Stations: guides/enclosures/Assembling Smart Citizen Stations.md
- Legacy Hardware:
- Smart Citizen 1.1:
- Main: hardware/legacy/index.md
- Hardware: hardware/legacy/Hardware.md
- Command Line: hardware/legacy/Command Line.md
- FAQ: hardware/legacy/Faq.md
- Troubleshooting: hardware/legacy/Troubleshooting.md
- Smart Citizen 2.0: hardware/legacy/sck.md
- Resources:
- Introduction: resources/index.md
- Toolkits:
- resources/toolkits/index.md
- Citizen Sensing Toolkit: resources/toolkits/Citizen Sensing Toolkit.md
# - Doit! Toolkit: resources/toolkits/Doit.md
# - Citizen-led Action Toolkit: resources/toolkits/Citizen-led Action Toolkit.md
- Webinars: resources/webinars.md
- Education: resources/education.md
- Research: resources/research.md
- Notes: resources/notes.md
# - Aulamar (ES):
# - Índice: resources/education/AulaMar/index.md
# - Notas generales: resources/education/AulaMar/General.md
# - Instrucciones: resources/education/AulaMar/Instrucciones.md
# - Guías por métrica:
# - pH: resources/education/AulaMar/pH.md
# - Oxígeno disuelto: resources/education/AulaMar/OD.md
# - Conductividad: resources/education/AulaMar/EC.md
# - Temperatura: resources/education/AulaMar/T.md
- About:
- about/index.md
- Funding: about/funding.md
- Friends: about/friends.md
- Open Source: about/open-source.md
theme:
language: 'en'
name: 'material'
features:
- instant
- navigation.indexes
- navigation.instant
- navigation.path
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- content.tooltips
- content.action.edit
- content.action.view
- toc.follow
- navigation.footer
custom_dir: 'custom_theme'
palette:
# Palette toggle for light mode
- scheme: default
primary: black
accent: amber
logo: 'assets/images/logo.svg'
favicon: 'assets/images/favicon.ico'
icon:
repo: fontawesome/brands/git-alt
annotation: material/star-four-points-circle
extra:
social:
# - icon: fontawesome/brands/twitter
# link: 'https://twitter.com/smartcitizenkit'
- icon: fontawesome/brands/instagram
link: 'https://www.instagram.com/smartcitizenkit/'
- icon: fontawesome/brands/github
link: 'https://www.github.com/fablabbcn/smartcitizen-kit-2x'
footer_logo: '/assets/images/eu-flag.png'
license:
name: 'GNU Free Documentation License'
link: 'https://www.gnu.org/licenses/fdl-1.3.html'
fullscreen_button: false
urls:
buy:
name: seeedstudio.com
link: https://www.seeedstudio.com/Smart-Citizen2-3-p-6327.html
installation:
name: start.smartcitizen.me
link: https://start.smartcitizen.me/
main:
name: smartcitizen.me
link: https://smartcitizen.me/
platform:
name: smartcitizen.me/kits
link: https://smartcitizen.me/kits
api:
name: api.smartcitizen.me
link: https://api.smartcitizen.me
ghapi:
name: fablabbcn/smartcitizen-api
link: https://github.com/fablabbcn/smartcitizen-api
developer:
name: developer.smartcitizen.me
link: https://developer.smartcitizen.me
forum:
name: forum.smartcitizen.me
link: https://forum.smartcitizen.me
support:
name: support@smartcitizen.me
link: mailto:support@smartcitizen.me
info:
name: info@smartcitizen.me
link: mailto:info@smartcitizen.me
status:
name: status.smartcitizen.me
link: https://status.smartcitizen.me
firmware:
name: fablabbcn/smartcitizen-kit-2x
link: https://github.com/fablabbcn/smartcitizen-kit-2x
ghfablab:
name: github.com/fablabbcn/
link: https://github.com/search?q=org%3Afablabbcn+smartcitizen&type=repositories
ghhardware:
name: fablabbcn/smartcitizen-kit-2x/hardware
link: https://github.com/fablabbcn/smartcitizen-kit-2x/tree/master/hardware
enclosures:
name: enclosures.smartcitizen.me
link: https://enclosures.smartcitizen.me
fablabbcn:
name: Fab Lab Barcelona
link: https://fablabbcn.org
iaac:
name: Institute For Advanced Architecture Of Catalonia
link: https://iaac.net
# alternate:
# - name: English
# link: /
# lang: en
# - name: Español
# link: /es/
# lang: es
hooks:
- hooks/markdown_export.py
plugins:
- macros
- search
- open-in-new-tab
- tags
# - redirects:
# redirect_maps:
# 'Resources/Tutorials/Configure Orange Data Analysis.md': 'Guides/data/Configure Orange Data Analysis.md'
# 'Resources/Tutorials/Orange Data Widgets.md': 'Guides/data/Orange Data Widgets.md'
# 'Resources/Tutorials/Simple Orange Workflow.md': 'Guides/data/Simple Orange Workflow.md'
# 'Resources/Tutorials/Orange and geolocated data.md': 'Guides/data/Orange and geolocated data.md'
markdown_extensions:
- attr_list
- md_in_html
- admonition
- codehilite
- footnotes
- toc:
permalink: true
toc_depth: 3
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- pymdownx.tabbed:
alternate_style: true
extra_css:
- assets/stylesheets/extra.css
extra_javascript:
- 'assets/javascripts/mathjax.js'
- 'https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js'
- 'https://buttons.github.io/buttons.js'
- 'assets/javascripts/extra.js'