fcoury / node-anne-pro

Bluetooth communication library for the Anne Pro keyboard

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

node-anne-pro

npm version

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

npm install anne-pro

Or if you want to use the command line utility:

npm install -g anne-pro

Usage

As a Command Line application


$ anne
  Usage:  [options] [command]

  Options:
    -h, --help  output usage information

  Commands:
    lighting|l [options] <mode>  sets the keyboard lighting effect
    layout|lt <name>             sets the keyboard layout

$ anne lighting rai
Lighting effect Rainbow set

$ anne layout arr
Layout WindowsArrows set

As a Library

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's node-core-bluetooth library that can be found here.

The code is written based on the Swift code written by Michiel Visser for the AnnePro-mac app, which is awesome!

License

MIT

About

Bluetooth communication library for the Anne Pro keyboard

License:MIT License


Languages

Language:JavaScript 100.0%