cncjs-pendant-gpio

Configurable gpio pendant for cncjs

• Installation
• Usage
• Configuration

Installation

npm install -g cncjs-pendant-gpio

Usage

cncjs-pendant-gpio [PORT]

PORT - port of your controller. If not specified then pendant connect to first opened port. For more information please read this

Configuration

cncjs-pendant-gpio loads json configuration from ~/cncjs-pendant-gpio

• debounceTimeout
• port
• pin
• action

Example

{
  "pins": [{
    "type": "button", 
    "gpio": 4, 
    "edge": "rising", 
    "actions": [{
      "type": "log", 
      "message": "STOP"
    },{
      "type": "gcode",
      "gcode": "!"
    }]
  },{
    "type": "button",
    "gpio": 3,
    "edge": "rising",
    "actions": [{
      "type": "gcode",
      "gcode": "$H"
    }]
  }],
  "debounceTimeout": 20
}

debounceTimeout

Default is 20 ms

port

If not specified then pendant tracks ports and connect to first opened (you probably already did it in cncjs app). If you have only one controller connected it's probably enough for you. In case of multiple controllers you can use this field to select port witch should be used. You can also specify that in command.

pin

Every pin is described as an object. Field type defines type of pin.

Available types

button

|field|description|default value|required| |---|---|---|---| |type|should be "button"|"button"|true| |gpio|gpio pin number| |true| |edge|"rising", "falling", "both"| |true| |actions|array of actions| |true|

action

Every action is described as an object. Field type defines type of action.

Available types

log

Log message to standard output

|field|description|default value|required| |---|---|---|---| |type|should be "log"|"log"|true| |message|whatever you want to see in logs| |true|

gcode

Send gcode to controller

|field|description|default value|required| |---|---|---|---| |type|should be "gcode"|"gcode"|true| |gcode|gcode command| |true|