cambridge-sound-qtpro

Node package for communicating with Cambridge Sound Qt series sound masking systems through their telnet-based command line interface.

Tested with QtPro 300 but should work with any Qt series sound masking system that implements the telnet command line interface.

Basic testing has been done but there are likely to be uncaught edge cases. Issues and pull requests are welcome.

Install

npm install cambridge-sound-qtpro

Quick start

const QTPro = require('cambridge-sound-qtpro');

const params = {
    ip: '172.16.10.141', 
    model: 'QT300',
    port: 23, // default
    reconnect: true // default
};

const qtpro = new QTPro(params);

qtpro.on('ready', () => {
    const getSystemArgs = {
        parameter: 'ip_address'
    };
    qtpro.getSystemParam(getSystemArgs, (res) => {
        console.log(`The IP address of this Qt Pro unit is ${res[getSystemArgs.parameter]}`);
    });

    const getZoneArgs = {
        zone: 1, // 0-indexed zone number, so this is asking for Zone 2
        parameter: 'masking_max'
    };
    qtpro.getZoneParam(getZoneArgs, (res) => {
        console.log(`The maximum masking level for Zone 2 of this Qt Pro unit is ${res[getZoneArgs.parameter]}`);
    });

    const setSystemArgs = {
        parameter: 'unit_name',
        value: 'CommLink Integration Corp HQ'
    };
    qtpro.setSystemParam(setSystemArgs, (res) => {
        console.log(`The unit name was ${res ? '' : 'not'} set to ${setSystemArgs.value}`);
    });

    const setZoneArgs = {
        zone: 1,
        parameter: 'masking_min',
        value: 12
    };
    qtpro.setZoneParam(setZoneArgs, (res) => {
        console.log(`The minimum masking level for Zone 2 was ${res ? '' : 'not'} set to ${setZoneArgs.value}`);
    });

    qtpro.getAllSystemParams((res) => {
        console.log(`The system parameters are ${res}`);
    });

    qtpro.getAllZoneParams({zone: 0}, (res) => {
        console.log(`Zone 1 parameters are ${res}`);
    });
});

Classes

QTPro

Typedefs

getOneCallback : function: Callback for requesting one system or zone parameter
getAllCallback : function: Callback for requesting all system or zone parameters
setCallback : function: Callback for setting one system or zone parameter

QTPro

Kind: global class

Emits:
- QTPro#event:ready - When the connection is ready for data to be sent/received
- QTPro#event:disconnected - When the connection is not active
- QTPro#event:connecting - While the connection attempt it being made
- QTPro#event:error - On a connection error
QTPro

new QTPro(params)

Create a QTPro unit.

Param	Type	Default	Description
params	`Object`
params.ip	`string`		The IP address of the unit
params.model	`string`		The model of QTPro connecting to, options are 'QT300' or 'QT600'
[params.port]	`number`	`23`	The port number the unit is listening on
[params.reconnect]	`boolean`	`true`	If the connection should attempt to re-establish after closing

qtPro.connect()

Attempts to connect to the Qt Pro unit. This is run automatically on class instantiation but can be used manually to reconnect if reconnect is set to false in the constructor params