An open API service indexing awesome lists of open source software.

https://github.com/endbug/dynamr

Wrapper for the DynamR controller API
https://github.com/endbug/dynamr

Last synced: 3 months ago
JSON representation

Wrapper for the DynamR controller API

Awesome Lists containing this project

README

          

# @endbug/dynamr

_Wrapper for the DynamR controller API_

This package is meant as a wrapper for the [DynamR](https://www.dynamr.com/) controller API, used in indoor skydiving.
More details about its usage can be found on the official website ([dynamr.com](https://www.dynamr.com/)) and in the manuals:

- [User guide](https://docs.google.com/document/d/11zYqI7WV49YWBew6dyXWNPCuNHHK3IRhykTtMVSmvfQ)
- [DynamR API Documentation](https://docs.google.com/document/d/15Ez0mxv8RAcY6AhZKYmGrU6iiezubTqgft2GZndNrao)

## Usage

```ts
import DynamR from '@endbug/dynamr';

const dynamr = new DynamR({
protocol: 'http',
hostname: '123.123.123.123',
port: '1234',
});

dynamr.getPresets().then(console.log);
```

## Methods:

- `getPresets`
- `getLightStatus`
- `setLightPreset`
- `setLightColor`
- `beginSession`
- `exitSession`
- `endSession`
- `getSessionStatus`
- `reloadSpeedRound`
- `bustEnter`
- `bustLeave`
- `stopSpeedRound`
- `setODE`
- `setETH0`

Please see the TS and JSDoc annotations for more info.