Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TobiasRoeddiger authored Sep 29, 2023
1 parent b212239 commit 7aa57d7
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
# 🦻 OpenEarable Dashboard
This repository offers comprehensive web interface for controlling and monitoring OpenEarable. The dashboard offers acces to different sensors, audio controls, button and the RGB LED of OpenEarable. In addition, it shows real-time graphs of accelerometer, gyroscope, magnetomer, pressure sensor, and temperature sensor data. Users can use the dashboard to label incoming data and download the labeled data as csv file ([edge-ml.org](https://edge-ml.org) compatible format).

This repository also includes the OpenEarable JavaScript library in the assets folder `assets/js/OpenEarable.js`.
This repository also includes the [OpenEarable.js](https://github.com/OpenEarable/dashboard#openearablejs-library) JavaScript library in the assets folder `assets/js/OpenEarable.js`.

## Usage

## OpenEarable.js library
## OpenEarable.js Library
OpenEarable.js is a JavaScript library that provides a seamless interface to connect, manage, and interact with OpenEarable. The library abstracts the complexities of BLE communication, making it easy to fetch device details, manage sensors, LED, and audio, and subscribe to device state changes.

### Installation
To use OpenEarable.js simply integrate the library found under `assets/js/OpenEarable.js` into your project as follows.
```html
<script src="./OpenEarable.js"></script>
```

## License
Distributed under the MIT License. See LICENSE for more information.
Expand Down

0 comments on commit 7aa57d7

Please sign in to comment.