Cisco IPICS PMC Command Line Interface, Release 2.0(1)
Command Line Interface Commands

Table Of Contents

Command Line Interface Commands

Activate Command

IsActivate Command

IsEnabled Command

IsLatch Command

IsTxMuted Command

Play Command


Command Line Interface Commands


This chapter describes each of the supported PMC CLI commands in detail.


NoteBe aware that Cisco IPICS supports only the CLI commands that are described in this Cisco IPICS PMC Command Line Interface, Release 2.0(1) documentation.

Make sure that you do not use the CLI commands that were previously documented in the Cisco IPICS Command Line Interface, Release 1.0(1) documentation, as they are no longer supported for use with Cisco IPICS.


For each command, this chapter provides all or some of the following information about the supported CLI commands, as appropriate:

Description—Explains the functionality of the command.

Syntax—Shows how to issue the CLI command and describes the meaning of arguments and options as they relate to the specific CLI command.

Return codes—Describes the meaning of return codes that the CLI command generates.

Examples—Provides examples of how to use the specific CLI commands.

Related commands—Lists and cross-references related PMC CLI commands.

Table 2-1 lists the supported PMC CLI commands. It also provides a brief description of each command and a reference to the following sections that describe the individual CLI command in more detail:

Activate Command

IsActivate Command

IsEnabled Command

IsLatch Command

IsTxMuted Command

Play Command


Note Cisco IPICS supports only the CLI commands that are listed above.



Tip PMC CLI commands are not case sensitive. For example, entering PMC.EXE -Activate, PMC.exe -ACTIVATE, or pmc.exe -activate executes the same command.


Table 2-1 Cisco IPICS CLI Command Summary 

Command
Description
Reference

PMC.EXE -Activate [-line #]

Toggles the Activate/Deactivate button on the specified PTT channel

Activate Command

PMC.EXE -IsActivate [-line #]

Returns a code that designates whether the specified PTT channel is active

IsActivate Command

PMC.EXE -IsEnabled [-line #]

Returns a code that designates whether the specified PTT channel is enabled

IsEnabled Command

PMC.EXE -IsLatch [-line #]

Determines whether the PMC PTT button for the specified PTT channel is latched

IsLatch Command

PMC.EXE -IsTxMuted [-line #]

Returns a code that designates whether the specified PTT is muted by Cisco IPICS.

IsTxMuted Command

PMC.EXE -Play file [-line #]

Outputs a wave audio file to the specified PTT channel

Play Command


Activate Command

The Activate command toggles the Activate/Deactivate button on the specified PTT channel.

If the Activate/Deactivate button is already activated, issuing this command deactivates it.

If the Activate/Deactivate button is not activated, issuing this command activates it.

There are no return codes for this command.

Syntax

This command uses the following syntax:

PMC.EXE -Activate [-line #]

The -line # option, where # is a number from 1 through 18, specifies the PTT channel to which this command applies. If you omit this option, the command applies to channel 1.

Example

Table 2-2 shows examples of the Activate command.

Table 2-2 Examples of Activate Command Usage 

Command
Result

PMC.EXE -Activate

This command activates channel 1 if it is not activated.

This command deactivates channel 1 if it is activated.

PMC.EXE -Activate -line 1

This command activates channel 1 if it is not activated.

This command deactivates channel 1 if it is activated.

PMC.EXE -Activate -line 6

This command activates channel 6 if it is not activated.

This command deactivates channel 6 if it is activated.


Related Command

IsActivate Command—This command returns a code that designates whether the selected channel is activated.

IsActivate Command

The IsActivate command returns a code that designates whether the selected channel is activated.

Syntax

This command uses the following syntax:

PMC.EXE -IsActivate [-line #]

The -line # option, where # is a number from 1 through 18, specifies the PTT channel to which this command applies. If you omit this option, the command applies to channel 1.

Return Codes

Table 2-3 shows the return codes for the IsActivate command.

Table 2-3 Return Codes for the IsActivate Command 

Return Code
Meaning

0

This return code indicates that the specified channel is not activated.

1

This return code indicates that the specified channel is activated.


Related Command

Activate Command—This command toggles the Activate/Deactivate button on the specified PTT channel.

IsEnabled Command

The IsEnabled command returns a code that designates whether the selected channel is enabled in Cisco IPICS.

Syntax

This command uses the following syntax:

PMC.EXE -IsEnabled [-line #]

The -line # option, where # is a number from 1 through 18, specifies the PTT channel to which this command applies. If you omit this option, the command applies to channel 1.

Return Codes

Table 2-4 shows the return codes for the IsEnabled command.

Table 2-4 Return Codes for the IsEnabled Command 

Return Code
Meaning

0

This return code indicates that the specified channel is not enabled.

1

This return code indicates that the specified channel is enabled.


IsLatch Command

The IsLatch command determines whether the PMC PTT button for the specified channel is latched. The return code indicates the state of the PTT button.

Syntax

This command uses the following syntax:

PMC.EXE -IsLatch [-line #]

The -line # option, where # is a number from 1 through 18, specifies the PTT channel to which this command applies. If you omit this option, the command applies to channel 1.

Return Codes

Table 2-5 shows the return codes for the IsLatch command.

Table 2-5 Return Codes for the IsLatch Command 

Return Code
Meaning

0

This return code indicates that the PTT button is not latched.

1

This return code indicates that the PTT button is latched.


IsTxMuted Command

The IsTxMuted command returns a code that designates whether the selected channel is muted. (PMC users cannot transmit on channels that are muted.)

Syntax

This command uses the following syntax:

PMC.EXE -IsTxMuted [-line #]

The -line # option, where # is a number from 1 through 18, specifies the PTT channel to which this command applies. If you omit this option, the command applies to channel 1.

Return Codes

Table 2-6 shows the return codes for the IsTxMuted command.

Table 2-6 Return Codes for the IsTxMuted Command 

Return Code
Meaning

0

This return code indicates that the specified channel is not muted.

1

This return code indicates that the specified channel is muted.


Play Command

The Play command outputs a wave audio file to the specified PTT channel.

Specifically, this command latches the PMC PTT button, plays the designated wave file, and then unlatches the PTT button.

There are no return codes for this command.

Syntax

This command uses the following syntax:

PMC.EXE -Play file [-line #]

The file argument is the path and file name of the wave file that you want to play.

The -line # option, where # is a number from 1 through 18, specifies the PTT channel line to which this command applies. If you omit this option, the command applies to channel 1.

Example

Table 2-7 shows examples of the Play command.

Table 2-7 Examples of Play Command Usage 

Command
Result

PMC.EXE -Play c:\sounds\tone.wav

This command plays the tone.wav file in the c:\sounds folder to PTT channel 1.

PMC.EXE -Play c:\sounds\tone.wav -line 3

This command plays the tone.wav file in the c:\sounds folder to PTT channel 3.


For more information about the PMC, refer to the Cisco IPICS PMC Installation and User Guide at the following URL:

http://www.cisco.com/univercd/cc/td/doc/product/cis/c_ipics/index.htm