capacitor-barometer

Capacitor-Barometer is a native plugin for Capacitor that provides access to barometric pressure sensor data on supported devices. Easily integrate real-time atmospheric pressure readings into your cross-platform mobile apps for weather tracking, altitude estimation, or scientific applications.

Install

``bash
npm install capacitor-barometer
npx cap sync
`

API

* isAvailable()
* start()
* stop()
* getPressure()
* echo(...)
* addListener('onPressureChange', ...)
* removeAllListeners()
* Interfaces

$3

`typescript
isAvailable() => Promise<{ available: boolean; }>
`

Checks if the barometer sensor is available on the device.

Returns: Promise<{ available: boolean; }>

--------------------

$3

`typescript
start() => Promise
`

Starts listening for barometer updates.
This will also trigger the 'onPressureChange' event.

--------------------

$3

`typescript
stop() => Promise
`

Stops listening for barometer updates.

--------------------

$3

`typescript
getPressure() => Promise<{ pressure: number; }>
`

Gets the last known pressure reading.
Ensure 'start()' has been called and data is available.

Returns: Promise<{ pressure: number; }>

--------------------

$3

`typescript
echo(options: { value: string; }) => Promise<{ value: string; }>
`

An echo method for testing.

| Param | Type |
| ------------- | ------------------------------- |
| options | { value: string; } |

Returns: Promise<{ value: string; }>

--------------------

$3

`typescript
addListener(eventName: 'onPressureChange', listenerFunc: (data: { pressure: number; }) => void) => Promise & PluginListenerHandle
`

Called when pressure data changes.

| Param | Type | Description |
| ------------------ | ----------------------------------------------------- | ------------------------------------------ |
| eventName | 'onPressureChange' | The name of the event ('onPressureChange') |
| listenerFunc | (data: { pressure: number; }) => void | The callback function to be executed. |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

--------------------

$3

`typescript
removeAllListeners() => Promise
`

Removes all listeners for this plugin.

--------------------

$3


#### PluginListenerHandle

| Prop | Type |
| ------------ | ----------------------------------------- |
| remove` | () => Promise<void> |