Skip to content

Commit 5ba7944

Browse files
authored
Update readme.md
Updated the definition of the library and added Sections
1 parent 2f5e0f7 commit 5ba7944

File tree

1 file changed

+37
-38
lines changed

1 file changed

+37
-38
lines changed

docs/readme.md

Lines changed: 37 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
# **Sensor Kit Reference**
22

3-
This is a basic documentation about the library for the *SensorKit* .
3+
This documentation contains information about the classes and the usage of **Arduino_SensorKit** library which is primarily used in the [Arduino Sensor Kit](https://sensorkit.arduino.cc/). This library is a wrapper for other libraries such as
4+
* [u8g2 Library for monochrome displayes](https://github.com/olikraus/u8g2)
5+
* [Seeed_Arduino_LIS3DHTR for the 3 Axis Accelerometer](github.com/Seeed-Studio/Seeed_Arduino_LIS3DHTR)
6+
* [Grove_BMP280 Library for the Barometer](https://github.com/Seeed-Studio/Grove_BMP280)
7+
* [DHT-sensor-library for the Temperature and Humidity Sensor](https://github.com/adafruit/DHT-sensor-library)
48

5-
The library it's a wrapper of some libraries to use with the [Arduino Sensor Kit](), it can be downloaded from the Arduino IDE’s library manager or by going to the [github repository](https://github.com/arduino-libraries/Arduino_SensorKit)
9+
The Arduino_SensorKit Library can be downloaded from the Arduino IDE’s library manager or from the [github repository](https://github.com/arduino-libraries/Arduino_SensorKit)
610

7-
## Classes
8-
### SensorKit
11+
## Using the SensorKit Class
912

10-
#### Constructor of the object
13+
### Declaration
1114

1215
```cpp
1316
#include "Arduino_SensorKit.h"
@@ -18,7 +21,7 @@ The library it's a wrapper of some libraries to use with the [Arduino Sensor Kit
1821
void loop(){}
1922
```
2023

21-
#### Initialization
24+
### Initialization
2225

2326
Using the function `begin()` at the beginning of the `setup()`
2427

@@ -34,12 +37,10 @@ Using the function `begin()` at the beginning of the `setup()`
3437
void loop(){}
3538
```
3639
37-
### Oled
40+
## Using the Grove - OLED Display 0.96 inch
3841
39-
Using U8G2 library
40-
https://github.com/olikraus/u8g2
4142
42-
#### Init the driver
43+
### Initialising the driver
4344
4445
Init and returns true if success, already done in the `SensorKit`'s object `begin()`
4546
@@ -50,7 +51,8 @@ if(!Oled.begin()){
5051
}
5152
Serial.println("Ok");
5253
```
53-
#### "hello world" screen
54+
### Printing "hello world"
55+
5456
```cpp
5557
#include "Arduino_SensorKit.h"
5658

@@ -70,20 +72,18 @@ void loop() {
7072
}
7173
```
7274

73-
#### Print values
74-
Syntax:
75+
### Printing values
76+
7577
```cpp
7678
Oled.print(value);
7779
```
78-
### Accelerometer
79-
80-
Using LIS3DHTR library, this library renames their functions.
81-
github.com/Seeed-Studio/Seeed_Arduino_LIS3DHTR
8280

81+
## Using the Grove - 3-Axis Digital Accelerometer (±1.5g)
8382

84-
#### Init the sensor
83+
### Initialising the sensor
8584

8685
Init and returns true if success, already done in the `SensorKit`'s object `begin()`
86+
8787
```cpp
8888
if (!Accelerometer.begin()){
8989
Serial.println("Error"); // Accelerometer didnt initialized
@@ -92,7 +92,7 @@ Init and returns true if success, already done in the `SensorKit`'s object `begi
9292
Serial.println("Init complete");
9393
```
9494
95-
#### Read Acceleration X
95+
### Reading the Acceleration X
9696
9797
```cpp
9898
#include "Arduino_SensorKit.h"
@@ -112,7 +112,8 @@ Init and returns true if success, already done in the `SensorKit`'s object `begi
112112
}
113113
```
114114

115-
#### Read values
115+
### Reading the coordinate values
116+
116117
```cpp
117118
#include "Arduino_SensorKit.h"
118119
SensorKit kit;
@@ -135,7 +136,7 @@ Init and returns true if success, already done in the `SensorKit`'s object `begi
135136
}
136137
```
137138
138-
#### Check if the sensor has reads available
139+
### Check if the sensor has reads available
139140
140141
Return if the sensor its good to give the data
141142
@@ -158,11 +159,9 @@ Return if the sensor its good to give the data
158159
}
159160
```
160161
161-
### Pressure
162-
Using BMP280 library
163-
https://github.com/Seeed-Studio/Grove_BMP280
162+
## Using the Grove Barometer Sensor (BMP280)
164163

165-
#### Init the sensor
164+
### Initialising the sensor
166165
Init and returns true if success, already done in the `SensorKit`'s object `begin()`
167166
```cpp
168167
if (!Pressure.begin()){
@@ -172,10 +171,8 @@ Init and returns true if success, already done in the `SensorKit`'s object `begi
172171
Serial.println("Init complete");
173172
```
174173
175-
#### Get values
176-
The Pressure sensor can get temperature, pressure and altitude
174+
### Reading the Temperature values
177175
178-
##### Temperature
179176
```cpp
180177
#include "Arduino_SensorKit.h"
181178
SensorKit kit;
@@ -194,7 +191,8 @@ The Pressure sensor can get temperature, pressure and altitude
194191
}
195192
```
196193

197-
##### Pressure
194+
### Reading the Pressure values
195+
198196
```cpp
199197
#include "Arduino_SensorKit.h"
200198
SensorKit kit;
@@ -213,7 +211,7 @@ The Pressure sensor can get temperature, pressure and altitude
213211
}
214212
```
215213
216-
##### Altitude
214+
### Reading the Altitude values
217215
```cpp
218216
#include "Arduino_SensorKit.h"
219217
SensorKit kit;
@@ -232,18 +230,17 @@ The Pressure sensor can get temperature, pressure and altitude
232230
}
233231
```
234232
235-
### Environment
236-
Using DHT library
237-
https://github.com/adafruit/DHT-sensor-library
233+
## Using the Grove - Temperature & Humidity Sensor (DHT11)
234+
235+
DHT sensor can read Temperature and Humidity.
238236

239-
DHT sensor can read Temperature and Humidity
240-
#### DHTPIN
237+
### DHTPIN
241238
By default, once you include the library it has been set to digital pin `3`, it can be changed by adding
242239
```cpp
243240
#define DHTPIN yourPin
244241
```
245242
246-
#### Init the sensor
243+
### Initialising the sensor
247244
```cpp
248245
if (!Environment.begin()){
249246
Serial.println("Error"); // Accelerometer didnt initialized
@@ -252,7 +249,8 @@ By default, once you include the library it has been set to digital pin `3`, it
252249
Serial.println("Init complete");
253250
```
254251

255-
#### Temperature
252+
### Reading the Temperature values
253+
256254
```cpp
257255
#include "Arduino_SensorKit.h"
258256
SensorKit kit;
@@ -272,7 +270,8 @@ By default, once you include the library it has been set to digital pin `3`, it
272270
}
273271
```
274272
275-
#### Humidity
273+
### Reading the Humidity values
274+
276275
```cpp
277276
#include "Arduino_SensorKit.h"
278277
SensorKit kit;

0 commit comments

Comments
 (0)