OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
environmental.buffered_barometric_source.BufferedBarometricSource Class Reference

Store the latest pushed sample for use by BarometricController. More...

Inheritance diagram for environmental.buffered_barometric_source.BufferedBarometricSource:
environmental.barometric_source_if.BarometricSourceIf

Public Member Functions

bool is_connected (self)
 Return whether the sensor is connected and ready.
 
None connect (self)
 Connect to the barometric source.
 
None disconnect (self)
 Disconnect from the barometric source.
 
BarometricSample read_barometric (self)
 Read pressure and optional temperature.
 
- Public Member Functions inherited from environmental.barometric_source_if.BarometricSourceIf
BarometricSample read_environment (self)
 Compatibility alias for the original generic source API.
 

Detailed Description

Store the latest pushed sample for use by BarometricController.

Member Function Documentation

◆ is_connected()

bool environmental.buffered_barometric_source.BufferedBarometricSource.is_connected (   self)

Return whether the sensor is connected and ready.

Return values
TrueThe sensor is connected and ready.
FalseThe sensor is disconnected or unavailable.

Reimplemented from environmental.barometric_source_if.BarometricSourceIf.

◆ read_barometric()

BarometricSample environmental.buffered_barometric_source.BufferedBarometricSource.read_barometric (   self)

Read pressure and optional temperature.

Returns
Normalized barometric sample in SI units. temperature_c is None for pressure-only sources such as many phone barometers.

Reimplemented from environmental.barometric_source_if.BarometricSourceIf.


The documentation for this class was generated from the following file: