# @oarc/gpp-access

> Utilities around the Open AR Cloud GeoPoseProtocol

Latest version **0.2.1** (published 2025-04-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install @oarc/gpp-access
pnpm add @oarc/gpp-access
yarn add @oarc/gpp-access
bun add @oarc/gpp-access
```

## Health

**Score 40/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2025-04-12 |
| First published | 2021-09-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 281.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Michael Vogt and Gabor Soros |
| Maintainers | janerivi, soeroesg |
| Keywords | camera, localization, relocalisation, geopose, arcloud, spatial, capture, oarc |

## Links

- npm: https://www.npmjs.com/package/@oarc/gpp-access
- Repository: https://github.com/OpenArCloud/gpp-access
- Homepage: https://github.com/OpenArCloud/gpp-access#readme
- Issues: https://github.com/OpenArCloud/gpp-access/issues
- npm.io page: https://npm.io/package/@oarc/gpp-access

## Dependencies (2)

- [zod](https://npm.io/package/zod.md) ^3.22.4
- [deepmerge](https://npm.io/package/deepmerge.md) ^4.2.2

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.2.1 (latest) — 2025-04-12
- 0.2.0 — 2024-08-22
- 0.1.1 — 2024-01-17
- 0.1.0 — 2024-01-15
- 0.0.9 — 2022-10-06
- 0.0.8 — 2022-10-06
- 0.0.7 — 2022-10-06
- 0.0.6 — 2022-05-16
- 0.0.5 — 2022-05-16
- 0.0.3 — 2022-05-14
- 0.0.2 — 2021-09-30
- 0.0.1 — 2021-09-30

## README

Simple client library for the Open AR Cloud GeoPoseProtocol for visual positioning.

### New with version 0.2.0:
- BREAKING: upgrade to GeoPoseProtocol v2

### New with version 0.1.0:
- conversion from JavaScript to TypeScript

### New with version 0.0.3:
- update to new GeoPose format

### Simple usage
```
    import { sendRequest, validateRequest, GeoPoseRequest, type GeoposeResponseType } from '@oarc/gpp-access';
    import { ImageOrientation, IMAGEFORMAT, CameraParam, CAMERAMODEL } from '@oarc/gpp-access';

    /*
    // Input
    image: string, // base64 encoded JPG image
    width: number,
    height: number,
    cameraIntrinsics: { fx: number; fy: number; cx: number; cy: number; }
    */

    let cameraParams = new CameraParam();
    cameraParams.model = CAMERAMODEL.PINHOLE;
    cameraParams.modelParams = [cameraIntrinsics.fx, cameraIntrinsics.fx, cameraIntrinsics.cx, cameraIntrinsics.cy];

    const geoPoseRequest = new GeoPoseRequest(uuidv4())
        .addCameraData(IMAGEFORMAT.JPG, [width, height], image.split(',')[1], 0, new ImageOrientation(false, 0), cameraParams)
        .addLocationData(latAngle, lonAngle, 0, 0, 0, 0, 0)

    sendRequest(`${serviceUrl}`, JSON.stringify(geoPoseRequest))
        .then(data => {
            // handle GeoPoseResponse
        })
```

### More information about the GeoPoseProtocol can be found here:
[https://github.com/OpenArCloud/oscp-geopose-protocol](https://github.com/OpenArCloud/oscp-geopose-protocol)

---
_Source: https://npm.io/package/@oarc/gpp-access · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._