PebbleOS v4.47.0-512-g5285d4236
Loading...
Searching...
No Matches
Pressure sensor

Barometric pressure sensor class. More...

Modules

 BMP390
 Bosch BMP380/BMP390 Pressure sensor driver (compatible bosch,bmp380).
 

Data Structures

struct  pbl_pressure_ops
 Pressure sensor driver operations, called with the device lock held. More...
 
struct  pbl_pressure_state
 Pressure sensor runtime state. More...
 
struct  pbl_pressure
 Pressure sensor. More...
 

Macros

#define PBL_PRESSURE_STATE_DEFINE(sym)
 Define the class state of a pressure sensor.
 
#define PBL_PRESSURE_INIT(sym, _name, _parent, _ops)
 Initialize a struct pbl_pressure.
 

Functions

int pbl_pressure_read (const struct pbl_pressure *pressure, uint32_t *pa)
 Measure the pressure.
 

Variables

const struct pbl_pressure *const PRESSURE
 The board's barometric pressure sensor.
 

Detailed Description

Barometric pressure sensor class.

A pressure sensor is a struct pbl_pressure device. Each read runs one conversion; the sensor sleeps in between. Every call into the driver runs with the device lock held, a recursive mutex.

uint32_t pa;
if (pbl_pressure_read(PRESSURE, &pa) == 0) {
// pa is in pascals
}
const struct pbl_pressure *const PRESSURE
The board's barometric pressure sensor.
int pbl_pressure_read(const struct pbl_pressure *pressure, uint32_t *pa)
Measure the pressure.

Data Structure Documentation

◆ pbl_pressure_state

struct pbl_pressure_state

Pressure sensor runtime state.

Data Fields
struct pbl_mutex lock Device lock.

◆ pbl_pressure

struct pbl_pressure

Pressure sensor.

Data Fields
struct pbl_device dev Device.
const struct pbl_pressure_ops * ops Driver operations.
struct pbl_pressure_state * state Runtime state.

Macro Definition Documentation

◆ PBL_PRESSURE_INIT

#define PBL_PRESSURE_INIT (   sym,
  _name,
  _parent,
  _ops 
)
Value:
{ \
.dev = PBL_DEVICE_INIT_CLASS(sym, _name, pbl_pressure_dev_init, _parent, &pbl_pressure_class), \
.ops = (_ops), \
.state = &sym##_pressure_state, \
}
#define PBL_DEVICE_INIT_CLASS(sym, _name, _init, _parent, _cls)
Initializer for the struct pbl_device of device instance sym, in class _cls.
Definition device.h:153

Initialize a struct pbl_pressure.

Parameters
symSymbol of the instance, as passed to PBL_PRESSURE_STATE_DEFINE().
_nameDevice name.
_parentParent device.
_opsDriver operations.

◆ PBL_PRESSURE_STATE_DEFINE

#define PBL_PRESSURE_STATE_DEFINE (   sym)
Value:
static struct pbl_pressure_state sym##_pressure_state = {.lock = PBL_MUTEX_INITIALIZER}
#define PBL_DEVICE_STATE_DEFINE(sym)
Define the runtime state of device instance sym.
Definition device.h:132
struct pbl_mutex lock
Device lock.
Definition pressure.h:42
Pressure sensor runtime state.
Definition pressure.h:40
#define PBL_MUTEX_INITIALIZER
Static initializer for an unlocked mutex.
Definition mutex.h:50

Define the class state of a pressure sensor.

Parameters
symSymbol of the instance.

Function Documentation

◆ pbl_pressure_read()

int pbl_pressure_read ( const struct pbl_pressure *  pressure,
uint32_t *  pa 
)

Measure the pressure.

Runs one conversion, which takes tens of milliseconds and sleeps the caller.

Parameters
pressurePressure sensor.
[out]paPressure in pascals.
Returns
0, -ENODEV if the sensor is not ready, -ETIMEDOUT if the conversion timed out, or a negative errno.

Variable Documentation

◆ PRESSURE

const struct pbl_pressure* const PRESSURE
extern

The board's barometric pressure sensor.