Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fcoury/node-anne-pro
Bluetooth communication library for the Anne Pro keyboard
https://github.com/fcoury/node-anne-pro
annepro bluetooth keyboard
Last synced: about 1 month ago
JSON representation
Bluetooth communication library for the Anne Pro keyboard
- Host: GitHub
- URL: https://github.com/fcoury/node-anne-pro
- Owner: fcoury
- License: mit
- Created: 2018-01-14T00:57:04.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-01-14T16:45:54.000Z (almost 7 years ago)
- Last Synced: 2024-07-31T19:01:43.911Z (5 months ago)
- Topics: annepro, bluetooth, keyboard
- Language: JavaScript
- Homepage:
- Size: 14.6 KB
- Stars: 28
- Watchers: 7
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node-anne-pro
[](https://badge.fury.io/js/anne-pro)
> Node.js 8 library for interacting with the Anne Pro keyboard
**IMPORTANT**: only works in macOS currently
Current Features:
- set lighting mode
- set lighting mode speed and brightness
- set layout
Roadmap:
- [ ] Macros
## Install
```bash
npm install anne-pro
```
Or if you want to use the command line utility:
```bash
npm install -g anne-pro
```
## Usage
### As a Command Line application
```text
$ anne
Usage: [options] [command]
Options:
-h, --help output usage information
Commands:
lighting|l [options] sets the keyboard lighting effect
layout|lt sets the keyboard layout
$ anne lighting rai
Lighting effect Rainbow set
$ anne layout arr
Layout WindowsArrows set
```
### As a Library
```javascript
const AnneProKeyboard = require('anne-pro');
new AnneProKeyboard().connect().then(kb => {
console.log('setting Rainbow effect');
kb.setLightingMode(AnneProKeyboard.LightingModes.Rainbow);
process.exit(0);
}).catch(error => {
console.log(error.toString());
process.exit(1);
});
```
## Credits
This library relies on a modified version of [Sandeep Mistry](https://github.com/sandeepmistry)'s [node-core-bluetooth](https://github.com/sandeepmistry/node-core-bluetooth) library that can be found [here](https://github.com/fcoury/node-core-bluetooth).
The code is written based on the Swift code written by [Michiel Visser](https://github.com/msvisser) for the [AnnePro-mac](https://github.com/msvisser/AnnePro-mac) app, which is awesome!
## License
[MIT](http://vjpr.mit-license.org)