Telnet

The device offers two telnet interfaces that can be used interactively or for automation purposes, be it with scripts or programs. One interface uses TCP/IP and is listening on port 23 (enabled by default), the other can be switched on optionally and uses a serial line.

Most features can be configured through the telnet interface, and you can activate status feedback to monitor the device.

The TCP/IP version of the telnet daemon has a soft limit of three (3) simultaneous sessions. If you need more simultaneous connections, please contact us.

Contents

• Connecting to telnet
• Using telnet manually
• Creating scripts
• Command Reference
• Status Reference

Connecting to telnet

You need a telnet client to connect to the telnet TCP/IP service. On OS X and Linux, all you need is to open a terminal and connect to the service:

If you want to use the serial version of the telnet daemon, make sure it is started (Configuration->Device->Plugins->Telnet (serial connection)). Make sure the input and output of the serial interface you want to use is connected to the controller (Routing->Serial Matrix) and the bitrates are identical on the controller and interface. The serial variant of the telnet daemon will follow any of the bitrates you configure, just make sure you set them correctly.

Using telnet manually

You can get a list of the possible commands at any time by typing 'help':

Detailed help

To get more details about the parameters and its values, enter the command without parameters:

Feedback

All commands are parsed and sent to the central control daemon to process it. If you need feedback about the parsing of the command, use feeback on. If you want to be informed about the actual changes in the configuration, use config on.

Note: If a command does not change the configuration, you will get no config feedback. Also you will receive configuration feedback if the configuration is changed somewhere else, e.g. in the GUI.

A similar feature switches on status feedback, status on.

To get the full current configuration or status, send config get or status get.

Using telnet with scripts

Since all you send to the telnet service is ASCII commands, you can easily type them in a text file in advance and then send the whole file to the telnet service. This way you can easily automate things.

In this example we create a script that unlocks all channels, create a 1024 channel 1:1 matrix and set the clock source to word clock input. Since there is no command to unlock all channels, we create 1024 unlock commands in the terminal:

The resulting file can now be sent to the device:

Command reference

AUDIOXP

The AUDIOXP command is used to set or delete single connections in either the on- or offline matrix.

Example

AUDIODI

The AUDIODI command disconnects a source channel from all of its destinations at once.

Example

In this example the channels 4, 6, 8 and 9 are connected to input channel 2.

AUDIOSI

The AUDIOSI command lists the destination channels a source channel is connected to.

Example

In this example input channel 1 is connected to destination channels 1, 9 and 17. Input channel 2 is not connected.

AUDIOSO

The AUDIOSI command lists the source channel for a given destination channel.

Example

In this example output channel 1 is connected to input channel 1. Output channel 2 is not connected.

BAUD

The BAUD command sets the line speed of a serial port.

Example

BULK BEGIN

Normally, commands are executed as soon as they are received. The internal processing might lead to audible delays if you have a large number of commands.

To avoid that, you can group commands by switching on bulk transaction mode. All commands after sending the BULK BEGIN command are buffered until a BULK END is sent, then the commands are executed simultaneously.

BULK END

Every BULK BEGIN has to be closed with a BULK ENDm otherwise command execution hangs until a timeout is reached. You can end bulk transaction mode either by sending a BULK END or by terminating the telnet connection.

COMMIT

COMMIT copies the current offline matrix into the online matrix.

CONFIG

The CONFIG command toggles configuration feedback for the telnet connection it is issued in.

COPY

COPY copies the current online matrix into the offline matrix.

ENABLE_MASTER_CLOCK

ENABLE_MASTER_CLOCK enables or disables the master clock. If enabled, all clock references are set to the master clock reference.

Example

ENABLE_MASTER_MUL

ENABLE_MASTER_MUL enabled or disables the master clock multiplier. If enabled, the master clock multiplier is used for all clock references.

Example

FAN

FAN configures the fan's PWM control.

Example

FOLLOW_PORT

FOLLOW_PORT configures the 'follow clock domain' feature.

Example

GAIN

GAIN sets the channel output gain.

Example

GPO

GPO turns a GPO switch on or off.

Example

HELP

HELP shows a command list. Type a command without parameters to see its usage.

Example

IDENTIFY

IDENTIFY blinks the status and power supply LEDs in front of the device.

LOCK

LOCK locks an audio connection in the online matrix. A locked crosspoint cannot be modified. Use UNLOCK to unlock it again.

Example

MASTER_CLOCK

MASTER_CLOCK configures the master clock source. Use ENABLE_MASTER_CLOCK to enable/disable the usage of the master clock feature.

Example

MASTER_MUL

MASTER_MUL configures the master clock multiplier. Use ENABLE_MASTER_MUL to turn this feature on/off.

Example

MIDIXP

MIDIXP controls the crosspoints in the MIDI matrix.

Example

OFF

Deletes a range of crosspoints.

Example

POLY_SOURCE

Configures the word clock reference for a MADI port or the word clock output. The settings made here are only active if master clock is disabled.

Example

PORTGAIN

PORTGAIN sets the gain for an output port. Port and channel gains are additive.

Example

PORTGAIN_MODE

PORTGAIN_MODE modifies the way the portgain is applied to a port's channels.

Example

PORTXP

PORTXP creates 1:1 routings on whole ports with a single command.

PORT_MODE

PORT_MODE sets the number of channels to send on a port.

Note: The 57 channel option is only available on black series M.1k2 with a minimum FPGA firmware version of 3.7.

Example

PORT_FRAME

PORT_FRAME sets the frame format to be used on a port if it set to 2FS (88.1/96kHz).

Example

QUIT

QUIT terminates a telnet session.

REDUNDANCY

REDUNDANCY configures the input port redundancy. If any one of the two input ports loses its signal, the signal of the other port is used.

Example

RS4XX_MODE

RS4XX_MODE configures the protocol to be used with the front 4xx port.

Example

RS485_ECHO

RS485_ECHO enables or disables local echo mode if RS485 is used on the front port.

Example

SERXP

SERXP controls the crosspoints in the serial matrix.

Example

SNAPLOAD

SNAPLOAD loads a system snapshot. All features of the snapshot are restored (crosspoints, port configuration, labels).

Example

SYSTEM_SCRIPT

SYSTEM_SCRIPT runs a system script. The system script has to be defined previously.

Example

IOMASK_SET_XP

Permit or forbid a input channel/output channel pair.

Example

IOMASK_SET_PORT

Permit or forbid a input port/output port pair.

Example

IOMASK_GET

Read out the permission status of a input/output channel pair.

Example

IOMASK_CLEAR

Clear the IO mask, set all input/output combinations to 'permitted'.

STATUS

The STATUS command toggles status feedback for the telnet connection it is issued in.

TERM

TERM enables/disables word clock termination on the word clock and video input.

Example

UNITY

UNITY overwrites a range of the matrix with the unity routing (all inputs are routed 1:1 on the outputs).

Example

UNLOCK

UNLOCK unlocks a previously with LOCK locked audio connection in the online matrix.

Example

VERSION

VERSION prints the current version of the telnet daemon.

Example

WCK_MUL

WCK_MUL configures the FS multiplier to use on a MADI port. Different FS settings are only in effect if MASTER_FS_ENABLE is disabled. The exception is the word clock output #2, which can always have a ratio different from the master FS.

Example

Status Reference

Once activated via STATUS ON, all state changes are transmitted immediately. All status messages with their current values can be requested with STATUS GET. All status messages are ASCII messages and designed to be human readable and parsable with scripts.

All status messages begin with the prefix STATUS:<SPACE>, followed by a key word/key phrase (may contain white space!) and a number of parameters (can be zero) separated by a comma.

BOARD REVISION

Reports the hardware version of the mainboard.

Example

DOPPELGAENGER

Reports the current Doppelgänger slave status.

The status value is one of the following:

Example

FAN

Reports the current fan speed, 0-100%.

Example

FIRMWARE VERSION

Reports the FPGA firmware currently active.

Example

FS USAGE

Reports the file system usage for the system and user data partition as a percentage value.

Example

INPUT PORT FRAME

Reports the MADI frame (48k/96k) present at a MADI port.

Example

INPUT PORT MODE

Reports the channel mode present at a MADI port.

Example

IO BOARD

Reports the I/O board configuration.

The port values indicate the type of media connector on the board:

Example

IO BOARD POWER STATUS

Reports the I/O board 'power good' status.

Example

IO BOARD PRESENT

Reports the I/O board detection in Slot 1/2.

Example

KEY VALID

Reports wether the device license key is valid.

Example

LOCAL CONTROL

Reports wether local control is disabled (e.g. because the device becomes a Doppelgänger slave) or not.

Example

MAINBOARD TEMP

Reports the current mainboard temperature in degrees celsius with 0.1 degree accuracy.

Example

PSU

If the status of a PSU changes, it is reported immediately.

Example

SERIAL NUMBER

The serial number of the device is reported.

Example

SLAVE ADDED

If a slave device attaches itself to this M.1k2, a "Slave added" status message is sent. It contains the IP address of the slave that was attached.

Example

SLAVE REMOVED

If a slave exits normally (resumes normal control mode), a "Slave removed" status message is sent. It contains the IP address of the slave that was removed.

Example

SLAVE

This message is part of the STATUS GET output. It is output once for every slave device that is attached to this M.1k2.

Example

SLAVE VANISHED

If the connection to a slave device breaks or times out, a "Slave vanished" status message is sent. It contains the IP address of the slave device that vanished.

Example

SYNC STATUS

The sync status for all inputs is reported.

The input value is one of the following:

The status value is one of the following:

The duration value is the number of seconds since the last sync status change.

Example

TEMPERATURE CRITICAL

Is sent out if the device temperature reaches the configured critical temperature level or is returning to a non-critical level.

VIDEO MODE

Outputs the detected VIDEO standard (PAL/NTSC) at the video input. Defaults to NTSC, even if no signal is present.

WC FREQUENCY

The frequency of all word clock reference sources is measured constantly. If any clock reference changes its frequency more than 1Hz, the new frequency is reported.

The reference value is one of the following:

Example