Skip to content

Commit 2285377

Browse files
authored
README: Provide per sensor descriptions of the examples
* Add section to describe sensor by example * Link example directories * Add SFA30, SVM40, SGP4x and SHTs * Update README.md * SFA -> SFA30 for consistency reasons * improve descriptions
1 parent e1ebc9e commit 2285377

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,59 @@ All samples in this directory share the same format; as such, you can follow the
2121
1. Save your project under a meaningful name
2222
1. Compile and flash the sketch
2323
1. Open the "Serial Monitor" from the "Tools" menu in the Arduino IDE to display the output data read from the sensor
24+
25+
# Examples by sensor
26+
27+
## SCD4x
28+
29+
|Name|Protocol|Description|
30+
|----|--------|-----------|
31+
|[SCD4x_I2C_minimal_example](/SCD4x_I2C_minimal_example)|I2C|Minimal example to get started|
32+
|[SCD4x_I2C_FRC_Forced_Recalibration_Example](SCD4x_I2C_FRC_Forced_Recalibration_Example)|I2C|Show forced recalibration|
33+
34+
## SEN44
35+
|Name|Protocol|Description|
36+
|----|--------|-----------|
37+
|[SEN44_I2C_minimal_example](/SEN44_I2C_minimal_example)|I2C|Basic example for I2C|
38+
|[SEN44_I2C_change_T_offset_example](/SEN44_I2C_change_T_offset_example)|I2C|Change T offset over I2C|
39+
|[SEN44_I2C_change_VOC_parameters_example](/SEN44_I2C_change_VOC_parameters_example)|I2C|Change VOC parameters over I2C|
40+
|[SEN44_SCD40_I2C_example](/SEN44_SCD40_I2C_example)|I2C|Example using SEN44 with SCD4x|
41+
|[SEN44_UART_minimal_example](/SEN44_UART_minimal_example)|UART|Basic example for UART (Serial) interface|
42+
43+
## SFA30
44+
|Name|Protocol|Description|
45+
|----|--------|-----------|
46+
|[SFA30_I2C_minimal_example](/SFA30_I2C_minimal_example)|I2C|Minimal example to get started|
47+
48+
49+
## SGP40
50+
|Name|Protocol|Description|
51+
|----|--------|-----------|
52+
|[SGP40_SHTC3_I2C_voc_algo_minimal_example](/SGP40_SHTC3_I2C_voc_algo_minimal_example)|I2C|Minimal example to use SGP40 with VOC Index algorithm|
53+
54+
## SHT3x
55+
|Name|Protocol|Description|
56+
|----|--------|-----------|
57+
|[SHT3x_I2C_minimal_example](/SHT3x_I2C_minimal_example)|I2C|Minimal example to get started|
58+
59+
## SHT4x
60+
|Name|Protocol|Description|
61+
|----|--------|-----------|
62+
|[SHT4x_I2C_minimal_example](/SHT4x_I2C_minimal_example)|I2C|Minimal example to get started|
63+
64+
## SHTC3
65+
|Name|Protocol|Description|
66+
|----|--------|-----------|
67+
|[SHTC3_I2C_minimal_example](/SHTC3_I2C_minimal_example)|I2C|Minimal example to get started|
68+
69+
70+
## SVM40
71+
|Name|Protocol|Description|
72+
|----|--------|-----------|
73+
|[SVM40_I2C_minimal_example](/SVM40_I2C_minimal_example)|I2C|Minimal example to get started|
74+
|[SVM40_I2C_change_T_offset_example](/SVM40_I2C_change_T_offset_example)|I2C|Change T offset|
75+
|[SVM40_I2C_change_VOC_parameters_example](/SVM40_I2C_change_VOC_parameters_example)|I2C|Change VOC index algorithm parameters|
76+
77+
78+
79+

0 commit comments

Comments
 (0)