You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/readme.md
+37-38Lines changed: 37 additions & 38 deletions
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,16 @@
1
1
# **Sensor Kit Reference**
2
2
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)
4
8
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)
6
10
7
-
## Classes
8
-
### SensorKit
11
+
## Using the SensorKit Class
9
12
10
-
#### Constructor of the object
13
+
###Declaration
11
14
12
15
```cpp
13
16
#include"Arduino_SensorKit.h"
@@ -18,7 +21,7 @@ The library it's a wrapper of some libraries to use with the [Arduino Sensor Kit
18
21
voidloop(){}
19
22
```
20
23
21
-
####Initialization
24
+
### Initialization
22
25
23
26
Using the function `begin()` at the beginning of the `setup()`
24
27
@@ -34,12 +37,10 @@ Using the function `begin()` at the beginning of the `setup()`
34
37
void loop(){}
35
38
```
36
39
37
-
### Oled
40
+
## Using the Grove - OLED Display 0.96 inch
38
41
39
-
Using U8G2 library
40
-
https://github.com/olikraus/u8g2
41
42
42
-
#### Init the driver
43
+
### Initialising the driver
43
44
44
45
Init and returns true if success, already done in the `SensorKit`'s object `begin()`
45
46
@@ -50,7 +51,8 @@ if(!Oled.begin()){
50
51
}
51
52
Serial.println("Ok");
52
53
```
53
-
#### "hello world" screen
54
+
### Printing "hello world"
55
+
54
56
```cpp
55
57
#include"Arduino_SensorKit.h"
56
58
@@ -70,20 +72,18 @@ void loop() {
70
72
}
71
73
```
72
74
73
-
#### Print values
74
-
Syntax:
75
+
###Printing values
76
+
75
77
```cpp
76
78
Oled.print(value);
77
79
```
78
-
### Accelerometer
79
-
80
-
Using LIS3DHTR library, this library renames their functions.
81
-
github.com/Seeed-Studio/Seeed_Arduino_LIS3DHTR
82
80
81
+
## Using the Grove - 3-Axis Digital Accelerometer (±1.5g)
83
82
84
-
#### Init the sensor
83
+
###Initialising the sensor
85
84
86
85
Init and returns true if success, already done in the `SensorKit`'s object `begin()`
0 commit comments