https://github.com/garrettmflynn/blueberry

A Blueberry Driver for the Data Capture and Streams API
https://github.com/garrettmflynn/blueberry

Last synced: about 1 month ago
JSON representation

A Blueberry Driver for the Data Capture and Streams API

• Host: GitHub
• URL: https://github.com/garrettmflynn/blueberry
• Owner: garrettmflynn
• License: agpl-3.0
• Created: 2022-05-11T21:08:41.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-05-11T21:49:30.000Z (over 2 years ago)
• Last Synced: 2024-11-17T01:18:18.652Z (about 2 months ago)
• Language: JavaScript
• Size: 19.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## blueberry

 A Blueberry Driver for the Data Capture and Streams API

 > **Note:** src/blueberry.js has a fully-functioning driver that we are progressively converting into a DataStreams-native format

## Getting Started 

After you've installed Node and NPM, install all the project dependencies: 

```bash

npm install

```

Now modify the `src` files to interface with your specific hardware.

### Run

The following command will create a `dist` folder with your driver files **and serve the included `index.html` file to http://localhost:1234**.

```bash

npm start

```

This links the latest version of the Data Capture and Streams API to ensure compatibility.

### Publish

If your device is working properly, the following command will publish it to NPM.

```bash

npm publish --access public

```

## Use

In order to use your device in other projects, you'll have to link it using one of the following options:

#### Browser

```javascript

```

#### Module

```javascript

import device from `https://cdn.jsdelivr.net/npm/@brainsatplay/blueberry`

```

Have fun with your data!

## Known Issues

1. This repository only grabs short wave data available on both v2020 and v2021 Blueberry devices.