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

cncjs-pendant-streamdeck

v0.9.0

Published

A cncjs pendant for the Elgato Stream Deck

Downloads

7

Readme

cncjs-pendant-streamdeck

A ridiculously configurable mobile web and Elgato Stream Deck pendant for CNCjs + Grbl

Sponsor

Web view with a 3 x 5 grid layout of buttons for jogging cnc

Stream Deck device with buttons with buttons for CNC

The web version acts as a prototype for the Stream Deck, and powerful and useful pendant as a side effect.

All configuration takes place in config.json. An example, mostly matching my own interface, is included to get started.

You can use your own images, or those included with the pendant, courtesy czottmann's system-uicons and fluent system icons and a handful from Font Awesome.

Features

  • Works with or without a Stream Deck, either as CLI process or web pendant
  • Linux-friendly, does not use default Stream Deck software
  • Unlimited pages
  • Arbitrary grid dimensions for web version
  • Excessively customizable
  • Execute one or more actions on press, release, and/or button hold
  • Support up to 6 axes
  • Multi axis smooth jogging
  • Templated text for
  • Lots of included icons, or add your own
  • Display and animate gcode
  • Run macros
  • Run cncjs custom commands (ex: to restart the system or update packages)
  • Manage alarms, hold, and pause events (like macro-triggered tool changes)
  • Custom configuration is well documented
  • Configuration validator

Compatibility

This has been tested with Grbl 1.1h, CNCjs 1.9.26 and Node 14.20.0+

Documentation

Full documentation can be found at https://billiam.github.io/cncjs-pendant-streamdeck

Installation

Web

  1. Download the latest release and extract it, to ex: /home/my-name/cncjs-pendant-streamdeck
  2. Rename config.example.json to config.json
  3. Update the config.json file with your connection information in the cncjs section.
  4. Edit your ~/.cncrc file, adding a mount point for this pendant
    "mountPoints": [
      {
        "route": "grid",
        "target": "/home/pi/cncjs-pendant-streamdeck"
      }
    ]
  5. Restart CNCjs

Streamdeck

Follow Web steps above to generate create a configuration directory, config.json file, and button images. You can skip the cncrc step if you do not need the web interface.

Linux

Instructions borrowed from https://github.com/julusian/node-elgato-stream-deck

On linux, the udev subsystem blocks access to the StreamDeck without some special configuration. Save the following to /etc/udev/rules.d/50-elgato.rules and reload the rules with sudo udevadm control --reload-rules

SUBSYSTEM=="input", GROUP="input", MODE="0666"
SUBSYSTEM=="usb", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="0060", MODE:="666", GROUP="plugdev"
SUBSYSTEM=="usb", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="0063", MODE:="666", GROUP="plugdev"
SUBSYSTEM=="usb", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="006c", MODE:="666", GROUP="plugdev"
SUBSYSTEM=="usb", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="006d", MODE:="666", GROUP="plugdev"
SUBSYSTEM=="usb", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="0080", MODE:="666", GROUP="plugdev"
SUBSYSTEM=="usb", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="0086", MODE:="666", GROUP="plugdev"
KERNEL=="hidraw*", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="0060", MODE:="666", GROUP="plugdev"
KERNEL=="hidraw*", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="0063", MODE:="666", GROUP="plugdev"
KERNEL=="hidraw*", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="006c", MODE:="666", GROUP="plugdev"
KERNEL=="hidraw*", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="006d", MODE:="666", GROUP="plugdev"
KERNEL=="hidraw*", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="0080", MODE:="666", GROUP="plugdev"
KERNEL=="hidraw*", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="0086", MODE:="666", GROUP="plugdev"

Unplug, and replug the device after reloading rules if necessary.

Install Stream Deck and canvas dependencies:

apt-get install libusb-1.0-0-dev libudev-dev libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev

Install optional node dependencies:

npm install -g canvas @julusian/jpeg-turbo

Install the application:

npm install -g cncjs-pendant-streamdeck

Run the pendant

cncjs-pendant-streamdeck --directory /home/my-name/cncjs-pendant-streamdeck

To-do

  • Config builder

Licenses and credits

Several icon sets have been added for convenience