Detalhes do pacote

@xkeys-lib/core

SuperFlyTV5kMIT3.3.0

NPM package to interact with the X-keys panels

xkeys, x-keys, hid, usb

readme (leia-me)

X-keys - Core

This package contains the platform-agnostic parts of the X-keys library.

You should not be importing this package directly, instead you'll want to use one of the wrapper libraries to provide the appropriate HID bindings for your target platform, see https://github.com/SuperFlyTV/xkeys

changelog (log de mudanças)

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

3.3.0 (2024-12-09)

Features

3.2.0 (2024-08-26)

Bug Fixes

  • add 'disconnect' event for the webHID device (44179d3)

Features

  • Add XkeysWatcher to WebHID version, rework XkeysWatcher to share code between node & webHID versions (34bbd3c)

3.1.2 (2024-08-12)

Bug Fixes

  • event listeners in node-hid-wapper to follow style in web-hid-wrapper. (ee1d6c6)

3.1.1 (2024-03-04)

Bug Fixes

  • clarify which github page. (07d7b4f)

3.1.0 (2024-01-11)

Bug Fixes

  • remove hack (possible HID.HID that exposed a devicePath) (fca382d)
  • remove support for HID.HID and HID.Async devices in setupXKeysPanel. (1bc87ba)
  • support providing HID.HIDAsync into setupXkeysPanel() (190d4a1)
  • typo (095c064)

Features

  • expose Xkeys.filterDevice() static method, used to filter for compatible X-keys devices when manually handling HID devices (ab542a8)
  • use async node-hid (429c5ea)

3.0.1 (2023-11-02)

Bug Fixes

  • filter for correct usage/usagePage when finding xkeys devices (8b9fdd1)
  • filter for correct usage/usagePage when finding xkeys devices (68f3e86)

3.0.0 (2023-05-03)

Bug Fixes

Features

  • BREAKING CHANGE: Dropped support for EOL versions of Node.js (<14).
  • Add support for the RailDriver.
  • Add support for panels with multiple background-light banks (added an argument for bankIndex to .setBacklight() & .setAllBacklights())
  • Add support for a few upcoming X-keys panels, including features like trackball, rotary

2.4.0 (2022-10-26)

Bug Fixes

Features

  • replace usb-detection with usb (d6349ef)

2.3.4 (2022-06-06)

Bug Fixes

  • ignore engines for node10 in ci (8c88b43)
  • pre-commit hook (887fbb2)
  • Watcher: async handling of adding/removing devices (61f0b28)

2.3.2 (2021-12-12)

Bug Fixes

  • add XKeys.writeData() method, used for testing and development (fba879c)

2.3.0 (2021-11-28)

2.3.4 (2022-06-06)

Bug Fixes

  • ignore engines for node10 in ci (8c88b43)
  • pre-commit hook (887fbb2)
  • Watcher: async handling of adding/removing devices (61f0b28)

2.3.2 (2021-12-12)

Bug Fixes

  • add XKeys.writeData() method, used for testing and development (fba879c)

2.3.0 (2021-11-28)

Features

  • add usePolling option to the XKeysWatcher to fall back to polling, since "usb-detection" might not work on all OS:es (ab31223)

2.2.1 (2021-09-22)

Note: Version bump only for package xkeys-monorepo

2.2.0 (2021-09-08)

Note: Version bump only for package xkeys-monorepo

2.2.0-alpha.1 (2021-09-06)

Bug Fixes

2.2.0-alpha.0 (2021-09-06)

Features

  • add feature: "Automatic UnitId mode" (f7c3a86)
  • add XKeys.uniqueId property, to be used with automaticUnitIdMode (a2e6d7a)

2.1.1 (2021-05-24)

Note: Version bump only for package xkeys-monorepo

2.1.1-alpha.1 (2021-05-23)

Bug Fixes

  • hack to fix issue in Electron (501f06d)
  • make XKeysWatcher.stop() close all the devices it has called setupXkeysPanel() for. (f69b599)

2.1.1-alpha.0 (2021-05-23)

Bug Fixes

  • remove listeners on watcher.stop() (c8d36a3)

2.1.0 (2021-05-15)

Note: Version bump only for package xkeys-monorepo

2.1.0-alpha.1 (2021-05-10)

Note: Version bump only for package xkeys-monorepo

2.1.0-alpha.0 (2021-05-10)

Bug Fixes

  • publication-script for the node-record-test executable (wip) (e4a8071)
  • refactor repo into lerna mono-repo (d5bffc1)

Features

  • add package with web-HID support (1f27199)

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

2.0.0 (2021-04-16)

Features

  • emit precalculated deltaZ for joystick (2dad07b)
  • Refactor & improve (0ce375e)

Bug Fixes

  • bug for joystick deltaZ (41cd561)
  • compare new values with old, not the other way around (71e1801)
  • joystick bug (84d2150)
  • the emitted timestamp is undefined for some products (a45ee1f)
  • use type imports (373e6b4)
  • use XKeys.listAllConnectedPanels to DRY it up (d49827d)

1.1.1 (2021-01-15)

Bug Fixes

  • remove spammy console.log [release] (e3a0feb)

1.1.0 (2021-01-06)

1.1.0-0 (2021-01-06)

  • Add support for XKE-124 T-bar (PR)

1.0.0 (2020-10-27)

Bug Fixes

  • add (guessed) banks for XK16, XK8 & XK4 (a47834b)
  • add best-guesses for banks property, for untested products (8ecffec)
  • setBacklightIntensity improvements (thanks to @jonwyett) (a75d330)
  • typings fixes (a8a7193)
  • updated node-hid dependencies (0ec22e1)
  • upgrade dependencies (98bb387)
  • use device.interface instead of device.usage (2883c46)