@logitech-mx-creative-console/webhid
Version:
An npm module for interfacing with the Logitech MX Creative Console in the browser
97 lines (67 loc) • 4.31 kB
Markdown
[](https://codecov.io/gh/Julusian/node-logitech-mx-creative-console)
[](https://npm.im/@logitech-mx-creative-console/webhid)
[](https://npm.im/@logitech-mx-creative-console/webhid)
[@logitech-mx-creative-console/webhid](https://www.npmjs.com/org/logitech-mx-creative-console) is a library for interfacing with the various models of the [Logitech MX Creative Console](https://www.logitech.com/en-gb/products/keyboards/mx-creative-console.html).
This library has nothing to do with the official software produced by Logi. There is nothing here to install and run. This is a library to help developers make alternatives to that software
`$ npm install --save @logitech-mx-creative-console/webhid`
On linux, the udev subsystem blocks access to the device without some special configuration.
Copy the [rules file](./udev/50-logi-mx-creative-console-user.rules) into `/etc/udev/rules.d/` and reload the rules with `sudo udevadm control --reload-rules`
Unplug and replug the device and it should be usable
- Only works with Chromium v89+ based browsers
- The original model of the 15key is not supported on linux
- When having a hid device open, you will still be subject to background tab throttling which affects the draw rate
The root methods exposed by the library are as follows. For more information it is recommended to rely on the typescript typings for hints or to browse through the source to see what methods are available
```typescript
/**
* Request the user to select some MXConsoles to open
* @param userOptions Options to customise the device behvaiour
*/
export async function requestMXCreateConsoleDevices(options?: OpenMXConsoleOptions): Promise<MXCreativeConsoleWeb[]>
/**
* Reopen previously selected MXConsoles.
* The browser remembers what the user previously allowed your site to access, and this will open those without the request dialog
* @param options Options to customise the device behvaiour
*/
export async function reopenMXCreativeConsoleDevices(options?: OpenMXConsoleOptions): Promise<MXCreativeConsoleWeb[]>
/**
* Open a MXConsole from a manually selected HIDDevice handle
* @param browserDevice The unopened browser HIDDevice
* @param userOptions Options to customise the device behvaiour
*/
export async function openDevice(
browserDevice: HIDDevice,
userOptions?: OpenMXConsoleOptions,
): Promise<MXCreativeConsoleWeb>
```
The MXCreativeConsole type can be found [here](/packages/core/src/models/types.ts#L15)
## Example
```typescript
import { requestMXCreateConsoleDevices } from '@logitech-mx-creative-console/webhid'
// Prompts the user to select a device to use
const myDevices = await requestMXCreateConsoleDevices()
myDevices[0].on('down', (keyIndex) => {
console.log('key %d down', keyIndex)
})
myDevices[0].on('up', (keyIndex) => {
console.log('key %d up', keyIndex)
})
// Fired whenever an error is detected by the hid device.
// Always add a listener for this event! If you don't, errors will be silently dropped.
myDevices[0].on('error', (error) => {
console.error(error)
})
// Fill the first button form the left in the first row with a solid red color. This is asynchronous.
await myDevices[0].fillKeyColor(4, 255, 0, 0)
console.log('Successfully wrote a red square to key 4.')
```
Some the [demo site](https://julusian.github.io/node-logitech-mx-creative-console/) for some more complete examples and its corresponding [source](/packages/webhid-demo).
The logitech-mx-creative-console team enthusiastically welcomes contributions and project participation! There's a bunch of things you can do if you want to contribute! Please don't hesitate to jump in if you'd like to, or even ask us questions if something isn't clear.
Please refer to the [Changelog](CHANGELOG.md) for project history details, too.