npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@yelo/hid-scanner

v0.2.1

Published

Node.js Library for HID Code Scanner

Downloads

4

Readme

HID Scanner

:flashlight: Node.js Library for HID Code Scanner

Installation

# install as a cli
npm i @yelo/hid-scanner --build-from-source --driver=libusb -g
# or install as a dependency
npm i @yelo/hid-scanner --build-from-source --driver=libusb --save

Usage

CLI Usage

Basic

  1. Execute:

    hid-scanner
  2. Scan QRCode with your scanner!

List devices

hid-scanner --devices

Use another hid device (with other product name)

hid-scanner <product-name>

e.g.:

hid-scanner "MY SUPERB HID PRODUCT"

More information

hid-scanner --help

Library Usage

const { Scanner } = require('@yelo/hid-scanner')
const scanner = new Scanner('SM-2D PRODUCT HID KBW')
/**
 * or:
 *    const scanner = new Scanner(Scanner.devices()[0])
 */

let string = ''
scanner.on('key', (event) => {
  const { name, char } = event
  if (!char) {
    console.log(`Press: ${name}`)
    return
  }
  if (char === '\n') {
    console.info(`Input: ${string}`)
    string = ''
    return
  }
  string += char
})

Key Event Struct

  • name, the key name
  • char, the character to be typed in
  • raw, the raw HID Usage ID (HEX)

Development

Local installation for Linux

  1. libsub is required

    sudo apt install libusb-1.0-0 libusb-1.0-0-dev

    see https://github.com/node-hid/node-hid/#compiling-from-source

  2. Build from source

    npm install --build-from-source --driver=libusb
  3. Link to global

    npm link

Testing

npm test

Generate HEX fixture for testing

./test/helpers/generate-hex.js <product-name>

e.g.:

./test/helpers/generate-hex.js > ./test/fixtures/0.hex.txt

Keymap

The keymap file is automatically generated with: https://source.android.com/devices/input/keyboard-devices.html#hid-keyboard-and-keypad-page-0x07

Generate keymap

npm run generate-keymap

or see all commands by executing:

./scripts/keymap-generator.js --help

References

  • https://gist.github.com/MightyPork/6da26e382a7ad91b5496ee55fdc73db2
  • https://source.android.com/devices/input/keyboard-devices.html
  • https://github.com/node-hid/node-hid/issues/228
  • https://www.usb.org/document-library/hid-usage-tables-112

License

MIT © yelo, 2019 - present