PS VTP Commands

Access Commands

V – Validate Pin

This command is used to supply a PIN to unlock the paging station in the case where PIN access has been configured by use of a PIN Group in the Vocia software.   The paging station will validate the supplied PIN then unlock the station if the PIN is OK.

If the PIN is valid and the station has been unlocked the response will be:

<?xml version="1.0"?><Status Command= “V”> <State>AUTH_SUCCESS</State></Status>

If the PIN is not valid, the paging station will be locked and the response will be:

<?xml version="1.0"?><Status Command= “V”> <State>AUTH_FAIL</State></Status>

L – Lock Paging Station

The “L” command can be used by the third party application to lock the paging station after it has been unlocked using the “V” command.

When the paging station is configured for serial control, the paging station default time out lock feature is disabled. If a timeout lock is required this would need to be provided by a third party control system.

The Lock Command is disabled if there is active paging occurring on the paging station. Therefore a paging station will not lock while the PTT button is enabled. Also If serial PTT is enabled and the PTT has been enabled (with a 'T Y' command). A 'T N' command should be used immediately before a Lock command.

The response will be:

<?xml version="1.0"?><Status Command= “L”> <State>state string</State></Status>

• Where state string will be one of:

• STATE_OK – if the paging station was successfully locked.

• STATE_FAULT – if the paging station could not be locked due to an error.

Query configuration command (Q)

The “Q” command can be used to query aspects of the paging station’s configuration.  Commands are provided to display a list of available Page Codes, details of a particular Page Code’s configuration, and a list of available Local World zones.  In addition the query command can be used to request the current paging station status.

The “Q” command can be executed whether or not the paging station is PIN locked.

In the case of EWS emergency paging stations the list of Page Codes will include only emergency Page Codes (those that page to Emergency Zones).

Q E - Query Emergency Paging Priority Threshold

The response will be:

<?xml version="1.0"?>

<Query Command=”E”>

<EmergencyPagingPriorityThreshold>Priority</EmergencyPagingPriorityThreshold>

</Query>

Where

• Priority is between 5 and 252

Q T Z z – Query Page Inhibit priority threshold

The response will be:

<?xml version="1.0"?>

<Query Command=”Q T Z”>

<Zone>z</Zone>

<PageInhibitPriorityThreshold>Priority</PageInhibitPriorityThreshold>

</Query>

Q L-  Query List of assigned Page Codes Command

The response will be:

<?xml version="1.0"?>

<Query Command= “L”><State>STATE_OK</State><Pagecodes count=”Number of codes”>

<Pagecode id=”Pagecode”>Pagecode label</Pagecode>

<Pagecode id=”Pagecode”>Pagecode label</Pagecode>

...

<Pagecode id=”Pagecode”>Pagecode label</Pagecode>

</Pagecodes></Query>

In this example, four Page Codes are been returned following a Q L Command.

Q P - Return the configuration of a specified Page Code.

The response will be:

<?xml version="1.0"?>

<Query Command= “P”><State>State string</State><PageCodeDetail id=”Pagecode”>

<Preamble>Preamble</Preamble>

<Priority>priority</Priority>

<PageCodeType>Type</PageCodeType>

<PageCodeLabel>label</PageCodeLabel>

<AutoRepeat enabled=Repeatstate>

<Count>

<Min>1</Min>

<Default>1</Default>

<Max>9999</Max>

</Count>

<Interval>

<Min>0</Min>

<Default>0</Default>

<Max>43200</Max>

</Interval>

</AutoRepeat>

<Zones count=”Number of zones”>

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

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

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

</Zones></PageCodeDetail></Query>

Where:

"State string" will be one of:

• STATE_OK – if the command completed successfully.

• STATE_FAULT – if an error occurred.

"Pagecode" is a decimal number between 1 and 999

"Preamble" will be

1. • Y preamble will be used.

   • N preamble will not be used.

"Type" can be one of the following:

• PAGE_TYPE_LIVE – audio from the paging microphone will go live to the destination zones.

• PAGE_TYPE_DELAYED – audio from the paging microphone will be stored before a delayed release.

• PAGE_TYPE_PLAYBACK – initiate a pre-recorded announcement.

"RepeatState" can be

• true

• false

If the "RepeatState" is 'true' then the <Count> and <Interval> values will show the Page Code auto repeat configured values.

Q S - Return the current operating state of the paging station.

The response will be:

<?xml version="1.0"?><Query Command= “S”><State>State string</State>

<PagingStationState>State</PagingStationState></Query>

"State" will be one of the following:

• PXY_DEST_IDLE – The paging station is currently idle and the current destination is also idle.

• PXY_DEST_BUSY – The paging station is currently idle and the current destination is busy at a priority less than the current pagecode.

• PXY_DEST_DELAY – The paging station is currently idle and the current destination is busy at a priority greater than or equal to the current pagecode.

• PXY_NOT_AVAIL – The paging station is not available for use (most likely because it has no configuration).

• PXY_PLEASE_WAIT – The station is waiting for the audio path to be established and the preamble to finish.

• PXY_REQUEST_FAILED – The last recorded announcement request failed.

• PXY_PLEASE_TALK_NOW – The station is paging and is transmitting microphone audio to the destination zones.

• PXY_REQUEST_QUEUED – The recorded announcement request has been accepted and queued for playback.

• PXY_CANCEL_REQUEST – A delayed page has been recorded.  The operator now has an opportunity to cancel it.

• PXY_PAGE_WILL_END – The current page is about to time out.

• PXY_SECURITY – The paging station has been locked for security reasons.  A PIN is required to unlock it.

• PXY_NO_DEST – The station currently has no current valid destination.

• PXY_REQUEST_TIMEOUT – The current page has now timed out and has been terminated.

• PXY_NO_DEST_REQUESTED – The page failed because there were no destination devices to receive the page.

State string will be one of:

• STATE_OK – if the command completed successfully.

• STATE_FAULT – if an error occurred.

Q Z - Return a list of all the available zones in the world.

The response will be:

<?xml version="1.0"?><Query Command= “Z”><State>State string</State><Zones count=”Number of zones”><Zone  id=”Id”>”Zone name string”</Zone><Zone  id=”Id”>”Zone name string”</Zone>...<Zone  id=”Id”>”Zone name string”</Zone><Zone  id=”Id”>”Zone name string”</Zone></Zones></Query>

Where State string will be one of:

• STATE_OK – if the command completed successfully.

• STATE_FAULT – if an error occurred.

Note: The zone “Id” corresponds directly with the Zone numbers configured in the Vocia Configuration.

In the case of EWS emergency paging stations the list of zones will include only emergency zones.

Pagecode Command (P)

The P command allows the third party application to select a Page Code from one of those in the list of configured codes (see Q L command).  This Page Code will then be used for subsequent pages until another Page Code is selected or modified.  The page code defines the type of page, its priority, the destination zones,  whether or not a preamble will be played prior to the announcement and the default number of repeats and repeat time. The Page Code repeat parameters will always be available via VTP - these can be customized and defined separately using the R N, R I and R T commands. See the Auto_Repeat_options section for more details

The response will be:

<?xml version="1.0"?><Status Command= “P”> <State>State string</State></Status>

State string will be one of:

• STATE_OK – if the command completed successfully.

• STATE_FAULT – if an error occurred or the requested Page Code does not exist.

• AUTH_FAIL – if the paging station was PIN locked.

Examples of Page Codes with Custom Repeat settings

PageCode Command with Auto Repeat User adjustable repetition count and Interval defined

Zone Commands (Z)

Use the “Z” command to specify a set of custom destination paging zones for subsequent Live or Pre-recorded pages.  This will override the current destination zone selection.

Z Z zones -Specify destination zones using a space delimited list of zone numbers.

The response will be:

<?xml version="1.0"?><ZonesStatus Command= “Z”><State>State string</State></ZonesStatus>

State string will be one of:

• STATE_OK – if the command completed successfully.

• STATE_FAULT – if an error occurred.

• AUTH_FAIL – if the paging station was PIN locked.

Sets zone allocation for zones 1,2,4 & 55.

Z A - Request that all available zones be used as a destination for the next page.

Note that for EWS emergency paging stations this command will select only emergency paging zones.

The response will be:

<?xml version="1.0"?><ZonesStatus Command= “A”><State>State string</State></ZonesStatus>

State string will be one of:

• STATE_OK – if the command completed successfully.

• STATE_FAULT – if an error occurred.

• AUTH_FAIL – if the paging station was PIN locked.

Set Page Options command (C)

The C command is used to "lock in " the zones specified in a previous Z Z or Z A command, as well as specify the priority of the page, whether or not it will use a preamble, and whether it is a live, infinite or delayed page. The Page Code repeat parameters will always be available via - these can be customized and defined separately using  the R N, R I commands. See the Audio_Repeat_options section for more details. The priority parameter will only accept a priority in the appropriate paging priority range for the paging station (ie. in the regular paging priority range for the DS-4, DS-10, WS-4 and WS-10 and in the emergency paging priority range for the EWS-4 and EWS-10). The 'C' command will respond with a STATE_FAULT type response if the priority is outside the appropriate paging priority range for the paging station. The 'C' command replaces the deprecated 'S' command (pre 1.6) and deprecated 'O' command (pre 1.8).

• preamble (pre) is Y if a preamble is required and N otherwise.

• priority (pri) is required to be a number within the page priority threshold (regular paging range and emergency paging range depending on device role).

• type (type) is L for a finite length live page (as specified in the Universe Max Live Page Length setting), I for infinite live page or D for a delayed page.

The response will be:

<?xml version="1.0"?><Status Command= “O”><State>State string</State></Status>

State string will be one of:

• STATE_OK – if the command completed successfully.

• STATE_FAULT – if an error occurred.

• AUTH_FAIL – if the paging station was PIN locked.

Examples of Page Codes with Custom Repeat settings

Set Page Options Command with Auto Repeat User adjustable repetition count and Interval defined.

Auto Repeat options (R)

Auto repeat options are configurable via PS-VTP per paging station and operate regardless of the selected Page Code pre-configured auto-repeat parameters. Repeat parameters must be defined via VTP to suit the required operation. Consideration should be given to track the current active repeat mode of the paging station.

R C - used to cancel a repeating Page.

Cancels any active repeating pages.

R N - specify the number of times a particular announcement will be repeated

Quantity can be specified between 1 and 9999.

The ability to specify the number of repeats via VTP will never be inhibited. The number of repeats will default to zero, so no repetition of announcements will occur. If a  repeat count has been defined on an earlier VTP command this will persist for all subsequent pages and page codes. Set the repeat count back to zero ( R N 0 ) if repetition is no longer required.

R I -  used to request infinite playback of announcements.  

Active Infinite page announcements can only be stopped using the 'R C' command.

The ability to specify infinite playback via VTP will never be inhibited. The infinite playback setting will persist for all subsequent pages and page codes.  After being enabled the R I command can be disabled with the R N command.

R T - specify the time interval in seconds between repetitions for subsequent announcements

The time will be specified in seconds and must be less than or equal to 43200 (12 hours).

The ability to specify the repeat interval via VTP will never be inhibited. The repeat interval will default to zero seconds. If the repeat interval has been defined on an earlier VTP command this will persist for all subsequent pages and page codes. Set the repeat interval back to zero ( R T 0 ) if repetition is no longer required.

Examples of Page Codes with Custom Repeat settings

PageCode Command with Auto Repeat User adjustable repetition count and Interval defined

Push to Talk command (T)

The T command is used to “press” or “depress” the push-to-talk button.

T state

Where state is Y to depress the push-to-talk, or N to release it or A to release and depress.  If the Push-To-Talk has been enabled with a T Y, it can be reset with a T N before sending any new Paging  commands. T A allows the push-to-talk button to be re-depressed without having to release it first.

The response will be:

<?xml version="1.0"?><Status Command= “T”><State>State string</State></Status>

State string will be one of:

• STATE_OK – if the command completed successfully.

• STATE_FAULT – if an error occurred.

• AUTH_FAIL – if the paging station was PIN locked.

Delayed Page Send/Cancel command (D)

The “D” command is used to send or cancel a delayed page.

D action

Where action is S to send the delayed page, or C to cancel the delayed page.

The response will be:

<?xml version="1.0"?><DelayedPageStatus Command= “S”><State>State string</State></DelayedPageStatus>

State string will be one of:

• STATE_OK – if the command completed successfully.

• STATE_FAULT – if an error occurred.

• AUTH_FAIL – if the paging station was PIN locked.

Set Page Options command (S)

Set Page Options command (O)