amx-setup

0.0.5 • Public • Published

amx-setup

A simple command line tool and Node.js module to setup AMX Netlinx touch panels and processors.

A connection is made to the device over telnet and commands are sent to configure the device.

Installation

$ npm install amx-setup

Features

  • Set network configuration
  • Set device number
  • Set master connection (for touch panels)
  • Reboots the device after update

Example Usage CLI

connect to a device and change it's ip address

$ amx-setup --host 192.168.1.10 --ip 10.10.201.20

Example Usage Node.js

connect to a device and change it's ip address

const setupAMX = require('amx-setup')
 
const device = new setupAMX({
    host: '192.168.1.20',
    ip: '10.10.201.20'
})
 
device.connectAMX()

Defaults

{
  host: '',
  name: '',
  type: 's',
  ip: '',
  sub: '',
  gate: '',
  username: 'administrator',
  password: 'password',
  device: '',
  pin: '1988',
  master: '',
  mode: 'u',
  system: '0',
  masterPass: '',
  masterUser: '',
  masterPort: ''
}

CLI API Reference

arguements available with CLI usage:

--host

The device to connect to

--ip

IP address to set

--name

new host name for the device

--type

's' for static or 'd' for dhcp

--sub

subnet mask

--gate

gateway

--username

telent username

--password

telent password

--device

device ID for touch panels

--pin

pin password for touch panels

--master

master connection ip address for touch panels

--mode

master connection mode. 'u' for url

--system

system number for master connection from touch panel

--masterPass

password for master from touch panel

--masterUser

username for master from touch panel

--masterPort

port to connect to from touch panel to master

Known Issues

  • After updating a touch panel the connection can timeout due to it automatically rebooting on network configuration change.

ToDo

  • Add support for more AMX devices
  • Filter console logs to be readable

Devices Tested

Currently only NX processors and G4 touch panels have been tested so there might be a difference with other touch panels or older processors.

Package Sidebar

Install

npm i amx-setup

Weekly Downloads

1

Version

0.0.5

License

ISC

Last publish

Collaborators

  • ashleymarkfletcher