Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
temp documentation
added docs for
- temperatureAvailable()
- readTemperataure()
  • Loading branch information
karlsoderby committed Jun 2, 2022
commit eb5ed3ba0cc10bac58bfbcff773ea70c7f8ca362
66 changes: 65 additions & 1 deletion docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -337,4 +337,68 @@ Serial.println("X\tY\tZ");
* [readGyroscope()](#readgyroscope)
* [accelerationAvailable()](#accelerationavailable)
* [gyroscopeAvailable()](#gyroscopeavailable)
* [accelerationSampleRate()](#accelerationsamplerate)
* [accelerationSampleRate()](#accelerationsamplerate)

### `readTemperature()`

Reads the temperature from the sensor (Celsius).

#### Syntax

```
IMU.readTemperature()
```

#### Parameters

None.

#### Returns

The temperature in Celsius.

#### Example

```
if (IMU.temperatureAvailable())
{
int temperature_deg = 0;
IMU.readTemperature(temperature_deg);

Serial.print("LSM6DSOX Temperature = ");
Serial.print(temperature_deg);
Serial.println(" °C");
}
```

### `temperatureAvailable()`

Checks if temperature data is available.

#### Syntax

```
IMU.temperatureAvailable()
```

#### Parameters

None.

#### Returns

1 on success, 0 on failure.

#### Example

```
if (IMU.temperatureAvailable())
{
int temperature_deg = 0;
IMU.readTemperature(temperature_deg);

Serial.print("LSM6DSOX Temperature = ");
Serial.print(temperature_deg);
Serial.println(" °C");
}
```