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/api.md
+9-7
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@
11
11
|`class`[`ModulinoKnob`](#modulinoknob)| Handles the functionality of Modulino Knob, interfacing with the rotary knob position. |
12
12
|`class`[`ModulinoMovement`](#modulinomovement)| Handles the functionality of Modulino Movement,interfacing with the IMU sensor to get acceleration readings. |
13
13
|`class`[`ModulinoThermo`](#modulinothermo)| Handles the functionality of Modulino Thermo, managing temperature sensors to provide real-time temperature and humidity readings. |
14
-
|`class`[`ModulinoPressure`](#modulinopressure)| Handles the functionality of Modulino Pressure, interfacing with pressure sensors to get atmospheric pressure. |
14
+
|`class`[`ModulinoDistance`](#modulinodistance)| Handles the functionality of Modulino Distance, enabling distance measurement using ToF (Time-of-Flight) sensors for precise range detection. |
15
15
16
16
### ModulinoClass
17
17
@@ -132,17 +132,19 @@ Represents a Modulino Thermo module.
132
132
133
133
---
134
134
135
-
### ModulinoPressure
135
+
### ModulinoDistance
136
136
137
-
Represents a Modulino Pressure module.
137
+
Represents a Modulino Distance module.
138
138
139
139
#### Methods
140
140
141
-
-**`float getPressure()`**
142
-
Returns the pressure reading.
141
+
-**`available()`**
142
+
Checks if new distance data is available from the sensor. If data is ready, it reads the data and updates the distance value.
143
+
`true` if distance data is available, `false` if distance data is not available.
143
144
144
-
-**`float getTemperature()`**
145
-
Returns the temperature reading.
145
+
-**`float get()`**
146
+
Returns the distance measured by the sensor in millimeters.
147
+
The measured distance in millimeters if available, `NAN` if the distance reading is invalid.
0 commit comments