@capgo/capacitor-barometer

Read air pressure from the device barometer on iOS and Android, as the latest sample or as a live stream of updates. Weather, outdoor and fitness apps get real sensor data with a few lines of code.

🤖 Building with an AI coding agent? Install Capgo skills so Claude Code, Codex, Cursor, Copilot, or Gemini CLI know how to install and use @capgo/capacitor-barometer in your Capacitor app: npx skills add Cap-go/capgo-skills. Then ask your agent: "Add @capgo/capacitor-barometer to my Capacitor app and wire it up." Agent setup guides · Hosted MCP

Key features

• Pressure readings: getMeasurement() returns the latest air pressure sample in hectopascals (hPa) with a timestamp. Start updates first, since it returns 0 until the first sensor event.
• Live updates: startMeasurementUpdates() streams readings to the measurement listener until you call stopMeasurementUpdates().
• Relative altitude on iOS: each reading includes the altitude change since updates started (Android reports 0).
• Availability check: isAvailable() tells you whether the device has a barometer before you show pressure UI.
• Permission status: checkPermissions() and requestPermissions() report access, using Core Motion authorization on iOS 17 and later.
• Platforms: iOS and Android. iOS uses Core Motion CMAltimeter, Android uses Sensor.TYPE_PRESSURE. On web, isAvailable() returns false.

Documentation

The most complete doc is available here: https://capgo.app/docs/plugins/barometer/

Compatibility

Note: The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

Install

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

Then use the following prompt:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-barometer` plugin in my project.

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

npm install @capgo/capacitor-barometer
npx cap sync

API

• getMeasurement()
• isAvailable()
• startMeasurementUpdates()
• stopMeasurementUpdates()
• checkPermissions()
• requestPermissions()
• addListener('measurement', ...)
• removeAllListeners()
• getPluginVersion()
• Interfaces
• Type Aliases

Capacitor plugin contract for working with the device barometer sensor.

getMeasurement()

getMeasurement() => Promise<GetMeasurementResult>

Get the most recent barometer reading captured by the native layer.

Returns: Promise<Measurement>

Since: 1.0.0

isAvailable()

isAvailable() => Promise<IsAvailableResult>

Check if the current device includes a barometer sensor.

Returns: Promise<IsAvailableResult>

Since: 1.0.0

startMeasurementUpdates()

startMeasurementUpdates() => Promise<void>

Begin streaming barometer updates to the JavaScript layer.

Call {@link addListener} with the measurement event to receive the updates.

Since: 1.0.0

stopMeasurementUpdates()

stopMeasurementUpdates() => Promise<void>

Stop the continuous updates started via {@link startMeasurementUpdates}.

Since: 1.0.0

checkPermissions()

checkPermissions() => Promise<PermissionStatus>

Return the current permission state for accessing barometer data.

Returns: Promise<PermissionStatus>

Since: 1.0.0

requestPermissions()

requestPermissions() => Promise<PermissionStatus>

Request permission to access barometer data if required by the platform.

Returns: Promise<PermissionStatus>

Since: 1.0.0

addListener('measurement', ...)

addListener(eventName: 'measurement', listenerFunc: (event: MeasurementEvent) => void) => Promise<PluginListenerHandle>

Listen for pressure updates.

Returns: Promise<PluginListenerHandle>

Since: 1.0.0

removeAllListeners()

removeAllListeners() => Promise<void>

Remove all registered listeners for this plugin.

Since: 1.0.0

getPluginVersion()

getPluginVersion() => Promise<{ version: string; }>

Get the native Capacitor plugin version.

Returns: Promise<{ version: string; }>

Since: 1.0.0

Interfaces

Measurement

Air pressure and relative altitude values sampled from the device barometer.

IsAvailableResult

Result returned by {@link CapacitorBarometerPlugin.isAvailable}.

PermissionStatus

Permission information returned by {@link CapacitorBarometerPlugin.checkPermissions} and {@link CapacitorBarometerPlugin.requestPermissions}.

PluginListenerHandle

Type Aliases

GetMeasurementResult

Alias for the most recent pressure sample.

Measurement

BarometerPermissionState

Permission state union including limited for platforms that can throttle sensor access.

PermissionState | 'limited'

PermissionState

'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'

MeasurementEvent

Event payload emitted when {@link CapacitorBarometerPlugin.startMeasurementUpdates} is active.

Measurement

Credit

This plugin was inspired from: https://github.com/kesha-antonov/react-native-background-downloader