LSI-16 VTP Commands

Login Commands

The U, P and A commands will be the only commands available until the remote LSI-16 VTP user has been authorized.

U – Username

The U command will be used to supply a Username in order to gain access to the LSI-16 TCP/IP interface. This command must be executed prior to sending the P command. The U, P and A commands will be only ones available until the remote LSI VTP user has been authorized.

If connecting Via RS-232 no authentication is required

P – Password

The P command will be used to supply a password in order to gain access to the LSI-16 RS-232 or TCP/IP interface. This command must be executed prior to sending the A command. The U, P and A commands will be only ones available until the remote LSI VTP user has been authorized.

If connecting Via RS-232 no authentication is required

A – Authorization

The A command will be used to authorize a LSI-16 VTP User with the LSI-16 and gain access to the protected VTP control via the LSI-16 VTP interface.  It is necessary to first send a Username and password using the U and P commands respectively.   The U, P and A commands will be only ones available until the remote LSI-16 VTP user has been authorized. Responses will be of the form specified in XML Responses.

If connecting Via RS-232 no authentication is required

Handshake Commands (H)

H – Handshake

The H command is used by the LSI-16 to ascertain the integrity of a RS-232 or TCP/IP connection.  A token is passed between the LSI-16 VTP user and the LSI-16.  This token is an unsigned integer that the LSI-16 compares with a stored copy of the last token transmitted.  If these match then the connection will be reported as good.  If a matching token is not received by the LSI-16 within 15 seconds of the last good token received the connection will be declared bad and a path fault generated.  A valid handshake command should be sent to the LSI-16 every five seconds.

For TCP and RS-232 Connections the remote LSI-16 VTP user will be required to supply a connection ID.  For TCP connections this is a numerical value (1-4) and should correspond with one of the four enabled monitored TCP Connections configured in the LSI-16 General Settings tab.  For RS-232 connections this is always the number 0. Using RS-232 requires the use of the H handshake command.

If handshake communications are lost, a Path Fault will be indicated on the front panel of the LSI-16, and the LSI-16 Alarms and Log tab will show a bad transmission path alarm.  If connected via TCP/IP an LSI-16 TCP/IP transmission path will indicate as BAD.  If connected via RS-232 a LSI-16 RS-232 transmission path will indicate as BAD.

• The TCP connectionid is a numerical value of 1 to 4.

• The RS-232 connectionid is always a value of 0.

• The Token will always start at 0 (zero).

• The LSI-16 responds with the next token to be used for the next handshake. This needs to be sent as the new token.

Input Command (I)

I - Input State

The I command will be used by the LSI-16 VTP User to set the state of a virtual input.  Virtual inputs behave much like the inputs of an IM-16.   They can be configured in the Vocia GUI in the LSI-16 Virtual Inputs tab to perform one of the following functions:

• Disabled

• Alarm

• Fault

• Reset

• Reset All

• Silence All

Fault inputs are level sensitive.  If the input is ON then the fault is active.  If the input is OFF the fault is inactive.  All other virtual input types are positive edge triggered – they will enable on a low to high transition.  So a command to set the input to ON will enable the associated function (the zone virtual input will go active), whereas a command to turn the input OFF will be ignored.

To enable Virtual Input 1 the command will be:  I 1 1

To disable Virtual Input 1 the command will be: I 1 0

The Virtual Input Channel Number is the channel number as listed in the Vocia GUI under LSI-16 properties/ Virtual Inputs.

State sets the specified input ON (state = 1) or OFF (state = 0).   The response will be:

<?xml version="1.0"?><Status Command= “I”> <State> STATE_OK</State></Status>

Group Input Command (G)

G - Group Input State

The G command can be used to set the state of multiple virtual inputs at once (maximum 50 inputs per 'G' command). Virtual inputs behave much like the inputs of an IM-16. They can be configured in the Vocia GUI in the LSI-16 Virtual Inputs tab to perform one of the following functions:

• Disabled

• Alarm

• Fault

• Reset

• Reset All

• Silence All

Fault inputs are level sensitive. If the input is ON then the fault is active.  If the input is OFF the fault is inactive.  All other virtual input types are positive edge triggered – they will enable on a low to high transition. So a command to set the input to ON will enable the associated function (the Zone virtual input will go active), whereas a command to turn the input OFF will be ignored.

To enable Virtual Inputs 20 through 30, the command will be:  G 20-30 1

To disable Virtual Inputs 5 to 10, command will be: G 5-10 0

Note that the delimiter character ("-") is always required to seperate a range of indexes.

The Virtual Input Channel Number is the channel number as listed in the Vocia GUI under LSI-16 properties/ Virtual Inputs.

State sets the specified input ON (state = 1) or OFF (state = 0).   The response will be:

<?xml version="1.0"?><Status Command= “G”> <State> STATE_OK</State></Status>

Reset System Fault (R S)

R S - Reset System Fault command

The R S command will allow the System Fault alarm to be reset if the LSI-16(e) has been configured to support remote resetting of system fault via VTP.

In a Master-Slave Emergency system, if this command is issued to the Master LSI-16(e) and the “Reset on Master Triggers Reset on All Slaves” option is enabled then all Slave LSI-16(e)’s will also have their System Fault reset.

The F S command can be used to obtain the current fault status from the LSI-16(e).

Emergency Zone Status Commands (Z)

Z – Zone status command

The Z Z command will be used to obtain the current status of a particular emergency zone. The Q Z Command can be used to get a listing of current configured Emergency Zones.

The status of a zone can be Inactive, Muted, or Announcing.  If the zone is in the Announcing state, the response will contain the name of the announcement currently playing in that zone.

The Zone Id will be the emergency zone id number assigned in the Vocia configuration. One Emergency Zone can be specified at a time.

• The ZoneState tag will return the default state of the zone as defined by the LSI-16.  This state does not incorporate emergency paging in any form. It will report as Inactive, Muted, Announcing

• • Inactive : Normal mode paging, background music and emergency pages will be heard in the zone.

  • Muted : All normal mode paging, background music and emergency recorded announcements are muted. Only emergency pages will be allowed.

  • Announcing: The emergency zone will continually play an emergency announcement in a looping fashion. All normal mode paging, background music will be muted. Emergency pages take priority.

The ZoneAvailable tag indicates if there are available operational output channels for the Emergency Zone. Supported Output devices include the VA-8600, VA-2060, VA-4030 and VO-4e.

 Will be either

• Yes - At least one output channel with the specified Emergency Zone is available.

• No - There are no operational emergency output channels available.

The <ZoneMessage> tag is only present if the zone state is Announcing.

Z A- Specify Zone status of all emergency zones

The Z A command will be used to obtain the current status of a all emergency zones in a World. The status of a zone can be Inactive, Muted, or Announcing.  If the zone is in the Announcing state, the response will contain the name of the announcement currently playing in that zone.

The Zone Id will be the emergency zone id number assigned in the Vocia configuration.

• The ZoneState tag will return the default state of the zone as defined by the LSI-16.  This state does not incorporate emergency paging in any form. It will report as Inactive, Muted, Announcing

• • Inactive : Normal mode paging, background music and emergency pages will be heard in the zone.

  • Muted : All normal mode paging, background music and emergency recorded announcements are muted. Only emergency pages will be allowed.

  • Announcing: The emergency zone will continually play an emergency announcement in a looping fashion. All normal mode paging, background music will be muted. Emergency pages take priority.

The ZoneAvailable tag indicates if there are available operational output channels for the Emergency Zone. Supported Output devices include the VA-8600, VA-2060, VA-4030 and VO-4e.

 Will be either

• Yes - At least one output channel with the specified Emergency Zone is available.

• No - There are no operational emergency output channels available.

The <ZoneMessage> tag is only present if the zone state is Announcing.

Query configuration command (Q)

The Q command is used to query aspects of the LSI-16’s configuration.  Commands are provided to display a list of all emergency mode devices and a list of all emergency zones.

Q D Return a list of all the emergency devices in the world.

The response will be:

<?xml version="1.0"?><Query Command= “D”><State> STATE_OK</State>

<Devices count=”Number of devices”>

<Device type="Type" id=”Id”>”TypeString”:”Id”</Device>

<Device type="Type" id=”Id”>” TypeString”:”Id”</Device>

...

<Device type="Type" id=”Id”>” TypeString”:”Id”</Device>

<Device type="Type" id=”Id”>” TypeString”:”Id”</Device>

</Devices></Query>

"Type" and "Typstring" Values

Valid "Type" and "TypeString" are as follows:

Q I – Query the type of Virtual Input.

InputID is a numerical value of the Virtual Input. This can be obtained using the ‘Q L’ Command. A response with the details of a specific virtual input configuration will be provided. The response format will depend on how the virtual Input is configured.

Possible Virtual Input Configurations with XML Responses

Virtual Input configured as a Fault Input:

The response will be:

<?xml version="1.0"?> <Query Command= “I”><State> STATE_OK</State>

< VirtualInputDetail id=”Input Id”><Name>”Input name string”</ Name >

<Description>”Input description string”</ Description>

<Function>”Fault”</Function>

<FaultType>”Input Fault Type”</ FaultType >

</VirtualInputDetail ></Query>

The input fault type can be one of the following:

1. • PSU

   • Ethernet

   • Protection

   • Transmission Path

Virtual Input configured as a Alarm Input:

The response will be:

<?xml version="1.0"?><Query Command= “I”><State> STATE_OK</State>

< VirtualInputDetail id=”Input Id”><Name>”Input name string”</ Name >

<Description>”Input description string”</ Description>

<Function>”Alarm”</Function> <Zone id=”Id”>”Zone name string”</Zone>

<ZoneMessage>”Zone message string”</ ZoneMessage >

</VirtualInputDetail ></Query>

The zone message string will be the Virtual Input label as configured in the Vocia software or:

1. • Mute - indicating that this input will mute the associated zone.

   • Unknown  - indicating a configuration parsing error.

Virtual Input configured as a Zone Reset Input:

The response will be:

<?xml version="1.0"?><Query Command= “I”><State> STATE_OK</State>

< VirtualInputDetail id=”Input Id”><Name>”Input name string”</ Name >

<Description>”Input description string”</ Description>

<Function>”Reset”</Function>

<Zone id=”Id”>”Zone name string”</Zone>

</VirtualInputDetail ></Query>

Virtual Input configured as an All Zone Silence Input:

The response will be:

<?xml version="1.0"?> <Query Command= “I”><State> STATE_OK</State>

< VirtualInputDetail id=”Input Id”><Name>”Input name string”</ Name >

<Description>”Input description string”</ Description>

<Function>”All silence”</Function>

</VirtualInputDetail ></Query>

Virtual Input configured as a All Zone Reset Input:

The response will be:

<?xml version="1.0"?><Query Command= “I”><State> STATE_OK</State>

< VirtualInputDetail id=”Input Id”><Name>”Input name string”</ Name >

<Description>”Input description string”</ Description>

<Function>”All reset”</Function>

</VirtualInputDetail ></Query>

LSI-16 Virtual Inputs configured as follows

Q L - Return a list of all the virtual inputs configured for this LSI-16.

The response will be:

<?xml version="1.0"?>

<Query Command= “L”><State> STATE_OK</State>

<VirtualInputs count=”Number of inputs”>

<VirtualInput id=”Id”>”Input name string”</VirtualInput>

<VirtualInput id=”Id”>”Input name string”</VirtualInput>

...

<VirtualInput id=”Id”>”Input name string”</VirtualInput>

</ VirtualInputs></Query>

The input “Id” is a 1 based input number.

Q Z Return a list of all the emergency zones in the World.

The response will be:

<?xml version="1.0"?><Query Command= “Z”><State> STATE_OK</State>

<Zones count=”Number of zones”>

<Zones  id=”Id”>”Zone name string”</Zone>

<Zones  id=”Id”>”Zone name string”</Zone>

...

<Zones  id=”Id”>”Zone name string”</Zone>

<Zones  id=”Id”>”Zone name string”</Zone>

</Zones></Query>

The zone “Id” is the zone number.

Fault status command (F)

The F command will be used to obtain the current fault status from the LSI-16. Commands are provided to display a summary list of emergency faults, device specific faults all current faults.

F S - Requests the emergency fault summary status from the LSI-16.

F D - Return a fault listing for the specified device.

The F D command will return a fault listing for all Emergency Devices excluding the LSI-16(e)

The nature of the response will depend on the specified device and will include all information provided by the device to the LSI-16.

The response will be:

<?xml version="1.0"?>

<Faults Command= “D”><State> STATE_OK</State>

<DeviceFaults type=" Type" Id= "Id">

<Fault type="System Fault">STATE_FAULT</Fault>

<Fault type="General Fault">STATE_FAULT</Fault>

<Fault type="Protection Fault">STATE_OK</Fault>

<Fault type="System Configuration">STATE_OK</Fault>

<Fault type="Audio Path Fault">STATE_FAULT</Fault>

<Fault type="Device Memory Failure">STATE_OK</Fault>

<Fault type="Device Offline">STATE_OK</Fault>

</DeviceFaults></Faults>

Valid type and id strings are as follows:

F F  - Return a summary of all active faults.

This includes any active emergency faults and a summary of active device faults.  The device fault summary is intended to indicate that there is a fault associated with a particular device without providing any detail.  An “F D” command could then be used to find out which particular fault had been detected.  Only devices that have faults will be listed.

The response will be:

<?xml version="1.0"?>

<Faults Command= “F”><State> STATE_OK</State><EmergencyFaults>

<Fault type="General Fault">STATE_FAULT</Fault>

...

<Fault type="Transmission Path Fault">STATE_FAULT</Fault></EmergencyFaults>

<DeviceFaults type=" Type " Id= Id ><Fault type="Summary">STATE_FAULT</Fault></DeviceFaults>

<DeviceFaults type=" Type " Id= Id ><Fault type="Summary">STATE_FAULT</Fault></DeviceFaults>

...

<DeviceFaults type=" Type " Id= Id ><Fault type="Summary">STATE_FAULT</Fault></DeviceFaults>

</Faults>

Valid type and type strings are as follows:

F A – Fault Acknowledge

This command operates as a virtual 'local Silence'. So performs the same way as physically pressing the 'Local Silence' on a CI-1 front panel.

The response will be:

<?xml version="1.0"?>

<Faults Command=“A”>

<State>STATE_OK</State></Faults>

Emergency Paging Station control via LSI-16(e)

The "@" command is used to relay a specific VTP command to an emergency paging station or LSI-16(e) in the local World, via the LSI-16(e) hosting the current connection.

• Device Type (Dev_Type) is '2' for an EWS-4, '4' for an EWS-10 and '8' for an LSI-16(e).

• Device ID (Dev_ID) is the unique identifier the device has been assigned formatted as a hex number. Valid ID range is 01 - FF.

• Command is a PS VTP string as specified. See the PS VTP Glossary for available commands.

The response will be:

<?xml version="1.0"?>

<VTPRelay Command="@">

<Device type=”2” id=”05”>EWS-4:05</Device>

<State>STATE_OK</State>

<Response>[Response From EWS-4/EWS-10]</Response>

</VTPRelay>

Where [Response From EWS-4/EWS-10] is the PS-VTP response from the remote device.

A <State>STATE_FAULT</State> response will be returned if the device specified is unable to be communicated with.

Note: It is not possible to use the relay command to send a command to another LSI-16(e) that asks it to relay the command to a third device.