{"id":42102095,"url":"https://github.com/Cap-go/capacitor-accelerometer","last_synced_at":"2026-02-05T13:00:50.359Z","repository":{"id":321004454,"uuid":"1084007040","full_name":"Cap-go/capacitor-accelerometer","owner":"Cap-go","description":"Capacitor plugin to read device accelerometer measurements","archived":false,"fork":false,"pushed_at":"2026-02-04T02:11:01.000Z","size":869,"stargazers_count":3,"open_issues_count":4,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-04T13:54:55.519Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cap-go.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null},"funding":{"github":"Cap-go","patreon":null,"open_collective":"capgo","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2025-10-27T04:49:27.000Z","updated_at":"2026-02-04T02:10:05.000Z","dependencies_parsed_at":"2025-10-27T09:14:09.198Z","dependency_job_id":"b4ccd7a5-0a30-4d5e-9a9f-97f10942bbad","html_url":"https://github.com/Cap-go/capacitor-accelerometer","commit_stats":null,"previous_names":["cap-go/capacitor-accelerometer"],"tags_count":24,"template":false,"template_full_name":null,"purl":"pkg:github/Cap-go/capacitor-accelerometer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-accelerometer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-accelerometer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-accelerometer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-accelerometer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cap-go","download_url":"https://codeload.github.com/Cap-go/capacitor-accelerometer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-accelerometer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29122350,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-05T10:47:47.471Z","status":"ssl_error","status_checked_at":"2026-02-05T10:45:08.119Z","response_time":65,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-26T13:00:21.332Z","updated_at":"2026-02-05T13:00:50.347Z","avatar_url":"https://github.com/Cap-go.png","language":"Swift","readme":"# @capgo/capacitor-accelerometer\n \u003ca href=\"https://capgo.app/\"\u003e\u003cimg src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/\u003e\u003c/a\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ch2\u003e\u003ca href=\"https://capgo.app/?ref=plugin_accelerometer\"\u003e ➡️ Get Instant updates for your App with Capgo\u003c/a\u003e\u003c/h2\u003e\n  \u003ch2\u003e\u003ca href=\"https://capgo.app/consulting/?ref=plugin_accelerometer\"\u003e Missing a feature? We’ll build the plugin for you 💪\u003c/a\u003e\u003c/h2\u003e\n\u003c/div\u003e\n\n\nAccess raw accelerometer measurements across iOS, Android, and the Web.\n\n## Why Capacitor Accelerometer?\n\nThe only **free** and **maintained** Capacitor plugin for accelerometer access. Other plugins are either paid or no longer updated. This plugin provides:\n\n- **Up-to-date implementation** - Uses the latest APIs across all platforms\n- **Consistent JavaScript API** - Same interface as popular paid alternatives\n- **Cross-platform** - Works on iOS, Android, and Web\n- **Permission handling** - Built-in permission management\n- **Real-time streaming** - Listen to continuous accelerometer updates\n\nPerfect for fitness apps, games, gesture detection, and motion-based interfaces.\n\n## Documentation\n\nThe most complete doc is available here: https://capgo.app/docs/plugins/accelerometer/\n\n## Compatibility\n\n| Plugin version | Capacitor compatibility | Maintained |\n| -------------- | ----------------------- | ---------- |\n| v8.\\*.\\*       | v8.\\*.\\*                | ✅          |\n| v7.\\*.\\*       | v7.\\*.\\*                | On demand   |\n| v6.\\*.\\*       | v6.\\*.\\*                | ❌          |\n| v5.\\*.\\*       | v5.\\*.\\*                | ❌          |\n\n\u003e **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.\n\n## Install\n\n```bash\nnpm install @capgo/capacitor-accelerometer\nnpx cap sync\n```\n\n## API\n\n\u003cdocgen-index\u003e\n\n* [`getMeasurement()`](#getmeasurement)\n* [`isAvailable()`](#isavailable)\n* [`startMeasurementUpdates()`](#startmeasurementupdates)\n* [`stopMeasurementUpdates()`](#stopmeasurementupdates)\n* [`checkPermissions()`](#checkpermissions)\n* [`requestPermissions()`](#requestpermissions)\n* [`addListener('measurement', ...)`](#addlistenermeasurement-)\n* [`removeAllListeners()`](#removealllisteners)\n* [`getPluginVersion()`](#getpluginversion)\n* [Interfaces](#interfaces)\n* [Type Aliases](#type-aliases)\n\n\u003c/docgen-index\u003e\n\n\u003cdocgen-api\u003e\n\u003c!--Update the source file JSDoc comments and rerun docgen to update the docs below--\u003e\n\nCapacitor plugin contract for working with the device accelerometer.\n\n### getMeasurement()\n\n```typescript\ngetMeasurement() =\u003e Promise\u003cGetMeasurementResult\u003e\n```\n\nGet the most recent accelerometer sample that was recorded by the native layer.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#measurement\"\u003eMeasurement\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### isAvailable()\n\n```typescript\nisAvailable() =\u003e Promise\u003cIsAvailableResult\u003e\n```\n\nCheck if the current device includes an accelerometer sensor.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#isavailableresult\"\u003eIsAvailableResult\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### startMeasurementUpdates()\n\n```typescript\nstartMeasurementUpdates() =\u003e Promise\u003cvoid\u003e\n```\n\nBegin streaming accelerometer updates to the JavaScript layer.\n\nCall {@link addListener} with the `measurement` event to receive the updates.\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### stopMeasurementUpdates()\n\n```typescript\nstopMeasurementUpdates() =\u003e Promise\u003cvoid\u003e\n```\n\nStop streaming accelerometer updates started via {@link startMeasurementUpdates}.\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### checkPermissions()\n\n```typescript\ncheckPermissions() =\u003e Promise\u003cPermissionStatus\u003e\n```\n\nReturn the current permission state for accessing motion data.\n\nOn platforms without explicit permissions this resolves to `granted`.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#permissionstatus\"\u003ePermissionStatus\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### requestPermissions()\n\n```typescript\nrequestPermissions() =\u003e Promise\u003cPermissionStatus\u003e\n```\n\nRequest permission to access motion data if supported by the platform.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#permissionstatus\"\u003ePermissionStatus\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### addListener('measurement', ...)\n\n```typescript\naddListener(eventName: 'measurement', listenerFunc: (event: MeasurementEvent) =\u003e void) =\u003e Promise\u003cPluginListenerHandle\u003e\n```\n\nListen for measurement updates.\n\n| Param              | Type                                                                    | Description                                |\n| ------------------ | ----------------------------------------------------------------------- | ------------------------------------------ |\n| **`eventName`**    | \u003ccode\u003e'measurement'\u003c/code\u003e                                              | Only the `measurement` event is supported. |\n| **`listenerFunc`** | \u003ccode\u003e(event: \u003ca href=\"#measurement\"\u003eMeasurement\u003c/a\u003e) =\u0026gt; void\u003c/code\u003e | Callback invoked with each measurement.    |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#pluginlistenerhandle\"\u003ePluginListenerHandle\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### removeAllListeners()\n\n```typescript\nremoveAllListeners() =\u003e Promise\u003cvoid\u003e\n```\n\nRemove all listeners that have been registered on the plugin.\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### getPluginVersion()\n\n```typescript\ngetPluginVersion() =\u003e Promise\u003c{ version: string; }\u003e\n```\n\nGet the native Capacitor plugin version.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ version: string; }\u0026gt;\u003c/code\u003e\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### Interfaces\n\n\n#### Measurement\n\nThe x, y and z axis acceleration values reported by the device motion sensors.\n\n| Prop    | Type                | Description                            | Since |\n| ------- | ------------------- | -------------------------------------- | ----- |\n| **`x`** | \u003ccode\u003enumber\u003c/code\u003e | The acceleration on the x-axis in G's. | 1.0.0 |\n| **`y`** | \u003ccode\u003enumber\u003c/code\u003e | The acceleration on the y-axis in G's. | 1.0.0 |\n| **`z`** | \u003ccode\u003enumber\u003c/code\u003e | The acceleration on the z-axis in G's. | 1.0.0 |\n\n\n#### IsAvailableResult\n\nResult returned by {@link CapacitorAccelerometerPlugin.isAvailable}.\n\n| Prop              | Type                 | Description                                                 | Since |\n| ----------------- | -------------------- | ----------------------------------------------------------- | ----- |\n| **`isAvailable`** | \u003ccode\u003eboolean\u003c/code\u003e | Whether an accelerometer sensor is available on the device. | 1.0.0 |\n\n\n#### PermissionStatus\n\nPermission information returned by {@link CapacitorAccelerometerPlugin.checkPermissions}\nand {@link CapacitorAccelerometerPlugin.requestPermissions}.\n\n| Prop                | Type                                                                                  | Description                                                             | Since |\n| ------------------- | ------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----- |\n| **`accelerometer`** | \u003ccode\u003e\u003ca href=\"#accelerometerpermissionstate\"\u003eAccelerometerPermissionState\u003c/a\u003e\u003c/code\u003e | The permission state for accessing motion data on the current platform. | 1.0.0 |\n\n\n#### PluginListenerHandle\n\n| Prop         | Type                                      |\n| ------------ | ----------------------------------------- |\n| **`remove`** | \u003ccode\u003e() =\u0026gt; Promise\u0026lt;void\u0026gt;\u003c/code\u003e |\n\n\n### Type Aliases\n\n\n#### GetMeasurementResult\n\nAlias for the most recent measurement.\n\n\u003ccode\u003e\u003ca href=\"#measurement\"\u003eMeasurement\u003c/a\u003e\u003c/code\u003e\n\n\n#### AccelerometerPermissionState\n\nPermission state union including `limited` for platforms that can throttle motion access.\n\n\u003ccode\u003e\u003ca href=\"#permissionstate\"\u003ePermissionState\u003c/a\u003e | 'limited'\u003c/code\u003e\n\n\n#### PermissionState\n\n\u003ccode\u003e'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'\u003c/code\u003e\n\n\n#### MeasurementEvent\n\nEvent payload emitted when {@link CapacitorAccelerometerPlugin.startMeasurementUpdates}\nis active.\n\n\u003ccode\u003e\u003ca href=\"#measurement\"\u003eMeasurement\u003c/a\u003e\u003c/code\u003e\n\n\u003c/docgen-api\u003e\n\n### Credit\n\nThis plugin was inspired from: https://github.com/kesha-antonov/react-native-background-downloader\n","funding_links":["https://github.com/sponsors/Cap-go","https://opencollective.com/capgo"],"categories":["Capgo Capacitor Plugins","[Capgo plugins](https://capgo.app/)"],"sub_categories":["Device \u0026 Sensors"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCap-go%2Fcapacitor-accelerometer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCap-go%2Fcapacitor-accelerometer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCap-go%2Fcapacitor-accelerometer/lists"}