Cisco IPICS Server Administration Guide - Release 4.0 - Managing Radios and Radio Descriptors [Cisco IP Interoperability and Collaboration System]

Table Of Contents

Managing Radios and Radio Descriptors

Managing Radios

Tone Control Radio Overview

Serial Control Radio Overview

Understanding How Buttons Display on the IDC

Radio Frequency Channels

Configuring Channel Selectors and Control Sequences

Channel Selector Configuration

Tone Sequence Configuration (Tone Control Radios)

Caveats for Configuring Default Tone Sequences (Tone Control Radios)

Understanding the Radios Window

Adding a Radio

Viewing and Editing Radio Details

Associating a Users to a Radio From the Radios Window

Enabling or Disabling a Radio

Deleting a Radio

Accessing and Using the Serial Radio Control Interface

Managing Radio Descriptors

Radio Descriptors

Radio Descriptor Format

Tone Descriptors

Serial Descriptors

Step 1: Create the Header

Step 2: Create the Body

Caveats for IDC Operation

Understanding the Descriptors Window

Adding Descriptors

Updating Radio and Tone Descriptors

Deleting Radio and Tone Descriptors

Managing Radios and Radio Descriptors

The Cisco IPICS administrator is responsible for configuring the radios and radio descriptors that are used with Cisco IPICS. This chapter provides detailed information about managing these items. In includes these topics:

•"Managing Radios" section

•"Managing Radio Descriptors" section

Managing Radios

Cisco IPICS provides support for tone-controlled radios by enabling the definition of radio channels in the Cisco IPICS server configuration. The IDC sends RFC 2198 and RFC 2833 packets to control tone sequences on a per-channel basis. Cisco IPICS supports up to 50 configured channels, with up to 36 channels active at any one time.

At the LMR gateway, these packets get converted into audible tones via the configured ear and mouth (E&M) interface to the physical radio to provide tone control for radios.

Cisco IPICS also provides support for serial-controlled radios through an integrated radio control service that translates control commands from Cisco IPICS to proprietary serial protocols. Cisco IPICS access serial controlled radios via asynchronous serial ports on the LMR gateway.

Using radio control to manage radios involves the following general steps:

1. Configure hardware as described in Solution Reference Network Design (SRND) (latest version).

2. Create a location that the radio uses for multicast. (See the "Managing Locations" section on page 2-41.)

3. Create and provision a radio descriptor. (See the "Adding Descriptors" section.)

4. Add the radio and assign the desired descriptor to it. (See the "Adding a Radio" section.)

This section contains the following radio management topics:

•Tone Control Radio Overview

•Serial Control Radio Overview

•Understanding How Buttons Display on the IDC

•Radio Frequency Channels

•Configuring Channel Selectors and Control Sequences

•Understanding the Radios Window

•Adding a Radio

•Viewing and Editing Radio Details

•Associating a Users to a Radio From the Radios Window

•Enabling or Disabling a Radio

•Deleting a Radio

•Accessing and Using the Serial Radio Control Interface

You perform the radio management tasks in the Configuration > Radios window in the Administration Console. For more information about these windows, including how to access them, see the "Understanding the Radios Window" section.

Tone Control Radio Overview

Each radio channel that you configure in the Cisco IPICS Administration Console represents a physical radio that you can configure with one or more tone sequences. Tone sequences control various tones and functionality. Each tone sequence includes the frequency or frequencies, volume (power), duration, and other parameters that are necessary to generate a specific tone and invoke a specific action.

Tone control, also referred to as Tone Remote Control (TRC), refers to the use of inband tone sequences to control a radio that is connected to an LMR gateway (typically a base station). In Cisco IPICS, you can use tone control to modify or tune to a different radio frequency (RF) channel, change the transmit power level, enable or disable radio built-in encryption, and control other operations. TRC uses well-defined audio sounds (also referred to as tones) to change the behavior of a device. A tone-keyed radio system requires that a specific tone be present on the incoming analog (e-lead) port. If this tone is not present, the radio does not transmit audio.

The Radio Details page shows available controls and channels. The IDC generates the necessary radio control tone sequences when users press the associated button. For more information about channel selectors, see the "Configuring Channel Selectors and Control Sequences" section.

Note•For information about various Requests for Comment (RFCs), access the RFC repository that is maintained by the Internet Engineering Task Force (IETF).

•For more detailed information about how to use the tone-controlled radio functionality on the IDC, see IPICS Dispatch Console User Guide for release 4.0.

Channel selector buttons, signals, and commands are defined in descriptor files. The following list describes these descriptor files:

•Radio Descriptor Files—Channel selector buttons that provide the functionality for specific radio types are defined in the radio descriptor files. The radio descriptor file defines the tones or events that must be sent to the radio to enable or disable specific capabilities. For more information, see the "Radio Descriptors" section.

•Tone Descriptor Files—Contain signals and commands. You can associate signals, that are defined in a tone descriptor file, to channels. Commands in a tone descriptor can be referenced by any radio descriptor file. See the "Tone Descriptors" section for more information.

Serial Control Radio Overview

Serial controlled radios can be configured to have channel selectors and control functions. Channel selectors represent controls that allow an IDC or Administration Console user to select a radio channel or talkgroup and to set up a private or group call. Control functions are controls that allow an IDC or Administration Console user to invoke functions or modes of operation.

For serial control, Cisco IPICS defines generic control commands that are configured in a radio descriptor. A radio control service that is integrated with Cisco IPICS translates these commands to proprietary commands.

The Serial Radio Control Interface (SRCI) and the IDC provide access to the channel selectors and control functions that are defined in the radio descriptor, if a radio is in a location other than the location that you logged in to. The SRCI and IDC also provide feedback from the controlled radio when a channel selector is changed or a control function is invoked. For radios that support these features, the SRCI and IDC provide the talker ID for incoming calls and emergency detection.

Understanding How Buttons Display on the IDC

When you use tone control, the buttons that display on the IDC get populated from information that the IDC receives from the Cisco IPICS server. The Cisco IPICS server performs a one-to-one mapping of the available IDC buttons and sends it to the IDC.

For more detailed information about the IDC, see Cisco IPICS Dispatch Console User Guide for release 4.0.

Radio Frequency Channels

In Cisco IPICS, a channel can refer to the RF channel (the frequency) to which the radio is tuned and on which content is streaming. Be aware of the following RF caveats when you use the IDC:

•A radio frequency does not define a channel and the audio content may differ depending on the location of the frequency. For example, a channel that is tuned to one frequency in one location may receive different content from the same type of radio that is tuned to the same radio frequency in another location.

•A channel may appear on more than one frequency, so the same content may be audible on several different frequencies.

•Any radio frequency in a specific location may carry several different content streams simultaneously.

You can associate radios and IDC users to enable user access to specified radios. You also can specify channel selector and control permissions to users by choosing the level of permission that pertains to each individual channel selector or radio control button. These permissions determine which channel selector buttons and radio controls the users can access. For example, if you do not configure any channel selector buttons for a user, the user can listen to the channel but cannot change the channels or control the radio.

Examples of radio control functions include MON (monitor), POW (power level) and Enc (encryption).

See the "Configuring Channel Selectors and Control Sequences" section for more information about channel selectors and tone control sequences for radios.

Configuring Channel Selectors and Control Sequences

This section describes how to configure channel selectors and tone control sequences.It includes the following topics:

•Channel Selector Configuration

•Tone Sequence Configuration (Tone Control Radios)

•Caveats for Configuring Default Tone Sequences (Tone Control Radios)

Channel Selector Configuration

You select channel descriptors and controls that are available to radio users in the Configuration > Descriptors window. When you configure or update descriptors and controls, the IDC of the any user who is associated to a radio gets updated.

Note When you configure channel selectors, consider the different actions that users may want to perform on the channel and which commands need to be sent to the radio when those actions are performed.

The channel selector attributes include the following elements:

•Label—This field specifies the name of the radio channel selector, as defined in the radio descriptor file. See the "Managing Radio Descriptors" section for more information about descriptors.

Note When you configure channel selector attributes, be aware that mixing left-to-right (LTR) and right-to-left (RTL) character sets for different languages may cause undesirable behaviors in the server or IDC.

•Enabled—If checked, this box indicates whether a PTT channel is allowed to associate to this channel. That is, this channel selector displays in the drop-down list for the radio connection for the channel.

•Associated Channel—This field displays the name of the currently associated channel and its short name (a condensed name of the channel).

Tone Sequence Configuration (Tone Control Radios)

The tone control sequences, which are defined in a radio descriptor file, contain information about how to tune the radio to another channel within that radio. See the "Managing Radio Descriptors" section for more information.

You can also configure default tone sequences. However, be aware of the caveats that the "Caveats for Configuring Default Tone Sequences (Tone Control Radios)" section describes before you configure these sequences.

The control attributes for tone sequences include the following elements:

•Label—This field indicates the name of the tone sequence, as defined in the tone descriptor file. These sequences may include names such as Monitor On/Off or Hi/Medium/Low Power and are used to identify a tone sequence.

•Enabled—If checked, this check box indicates that this control can be made available to the IDC.

•Description—This field indicates a description of the tone control sequence. A tone control can be either a stateful or momentary operation.

If a control is stateful, the IDC displays the button.

For example, Encryption is a stateful operation and the IDC monitors its setting. Another example is a Transmit Power setting that can be toggled between High, Medium, and Low.

A momentary control is one in which the functional state is not monitored or remembered. Most signals are momentary, meaning that they are sent without being monitored by the system.

Note Because of the limitations of tone-controlled radios, you may be able to toggle a feature on, but you may not have any way to know when the feature has been toggled back. For example, even though you can enable monitor mode, this mode can be turned off for a variety of reasons, including pressing the PTT button or changing the radio channel.

For more information about tone and radio descriptors, see the "Tone Descriptors" section and the "Understanding the Descriptors Window" section.

Caveats for Configuring Default Tone Sequences (Tone Control Radios)

Cisco IPICS allows you to configure a default tone sequence that transmits on the last used channel whenever the currently-tuned channel is unknown.

Note Be aware that the channel on which the tone sequence transmits is determined by the capabilities of the specific radio equipment systems that are being used and you should configure the channel based on that information.

You can configure the following options for a default channel:

•Associate to no tones

•A tone sequence that instructs that the radio transmits on a default channel, such as F1

•A tone sequence that instructs that the radio transmits on the currently-tuned channel, if that capability is available

Note When some users do not have access to channel selectors and cannot select a channel on which to transmit, the IDC does not know which channel the radio has been tuned to. Therefore, the IDC does not provide the user with a visual indicator and does not allow the user to transmit under those conditions. The channel that gets used depends on the configuration and on the radio capabilities as described earlier in this chapter.

Be aware that when you configure a default tone sequence, it may transmit over an unintended channel under the following conditions:

•If you configure the system so that a default tone sequence transmits on the currently-tuned channel, Cisco IPICS uses the last used channel to transmit if the transmission occurs before a specific channel has been selected.

•If an IDC user pushes a PTT button to talk, the tone control sequence may transmit over that specific channel, even if it was not the intended channel to use for transmission.

•If an IDC user begins to transmit while another user attempts to change channels in the same radio, transmission may occur in the channel that was selected by the second user. Or, the channel may not actually be changed but the tone control sequence sent by the attempted channel change may transmit over an unintended frequency.

Note The behavior of the IDC depends on the capabilities of the radio system that is being used.

Understanding the Radios Window

The Configuration > Radios window, in the Administration Console, lists information about each of the radios that you have added in Cisco IPICS.

Table 9-1 describes the items in the Radios window.

Table 9-1 Items in the Radios Window

Item

Description

Reference

Table Columns

Name

Indicates the names of radios that are configured in Cisco IPICS.

See the "Adding a Radio" section and the "Viewing and Editing Radio Details" section.

Radio Type

Indicates the name of the radio descriptor that is associated with the radio. The radio descriptor describes the radio type and associated channel selectors and control functions.

Control Type

Indicates whether the radio is tone controlled or serial controlled.

Pooled

(Serial controlled radios only)

Indicates whether the radio is enabled as a pooled resource and whether it is currently allocated. Pooled radios cannot be controlled manually. They are automatically allocated and configured by Cisco IPICS on demand when a channel is activated via a VTG or a user on an IDC.

The value does not apply if the radio is tone controlled.

See the "Adding a Radio" section and the "Viewing and Editing Radio Details" section.

Status

Indicates whether the radio is enabled or disabled. Disabled radios cannot be controlled and are not available on the pool.

Control Status

(Serial controlled radios only)

Indicates the control status of the radio. The value does not apply if the radio is tone controlled.

Reserved By

(Serial controlled radios only)

Indicates whether a radio that is not a pooled resource is reserved by a user or VTG.

The value does not apply if the radio is tone controlled or if the radio is a pooled resource.

VTG

Indicates whether the radio can be assigned to a VTG.

User

Indicates whether the radio can be assigned to a user.

Buttons

Add

Click this button to configure new radios.

See the "Adding a Radio" section.

Delete

Click this button to delete radios from Cisco IPICS.

See the "Deleting a Radio" section.

Associations

Click this button to associate radios to users.

See the "Associating a Users to a Radio From the Radios Window" section.

Radio Control

(Non-pooled serial controlled radios only)

Opens a browser-based control user interface. This button is active only if you check the check box for a single non-pooled serial controlled radio. It is dimmed if the radio is tone controlled or pooled, or if multiple check boxes are checked.

See the "Accessing and Using the Serial Radio Control Interface" section.

Display Controls

Rows per page drop-down list

Specifies the number of rows of radios that are included in a radios list page.

See the "Navigating Item Lists" section on page 1-19.

Page field

Displays radios on a specific page.

|< (First page) button

Displays the first page of the radio list.

< (Previous page) button

Displays the previous page of the radio list.

> (Next page) button

Displays the next page of the radio list.

>| (Last page) button

Displays the last page of the radio list.

Adding a Radio

When you add a radio it becomes available for use by Cisco IPICS.

Before you add a radio, make sure that you configure locations, as described in the "Managing Locations" section on page 2-41.

To add a new radio, perform the following procedure:

Procedure

Step 1 From the Cisco IPICS Administration Console, navigate to the Configuration > Radios window.

Step 2 In the Radios window, click Add and designate the type of radio that you want to add by choosing one of these options from the drop-down list that displays:

•Add Tone Controlled Radio

•Add Serial Controlled Radio

The General tab for a new radio displays. Table 9-2 describes the fields in this tab.

Table 9-2 General Tab Fields in Radios Window

Field

Description for Tone Controlled Radio

Description for Serial Controlled Radio

General Information Area

Name

Enter the name of the radio.

Enter the name of the radio.

Radio Type

Choose the type of radio from the drop-down list.

The choices that display for radio type are based on the radio types that are in the radio descriptor files. For more information about radio descriptor files, see the "Managing Radio Descriptors" section.

Description

Enter a description of the radio.

Pooled Resource

—

Check this check box to designate that the radio is a pooled resource. Pooled radios are not controlled manually. They are automatically allocated and configured by Cisco IPICS on demand when a channel is activated via a VTG or a user on an IDC.

Content Source Information Area

Location

Choose a location for the radio from the drop-down list.

Location is used to determine how the IDC client can reach the radio (via multicast or unicast).

Note IDC users must log in from the same location as the radio to access it. Cisco IPICS supports remote log in only if the Cisco IPICS server is configured with an RMS in the same location as the radio.

See the "Managing Locations" section on page 2-41for information about configuring locations.

Multicast Address

This field specifies the multicast address that is used to transmit audio and tones.

Enter the multicast address that is defined in the dial peer configuration of the LMR gateway.

Multicast Port

This field specifies the multicast port for the radio.

Enter the port number that is defined in the dial peer configuration of the LMR gateway.

Codec

Enter the codec that is defined in the dial peer configuration of the LMR gateway.

Enter the codec that is defined in the dial peer configuration of the LMR gateway.

Secure Radio

Choose Yes or No from the drop-down list.

Note This field defines the security label of the radio only, and not the security of the individual channels that can be carried over the radio.

Voice Delay (msec)

(Tone control only)

This field specifies a value, in milliseconds, that is set on the LMR gateway that you must replicate on the server for radio instances that are associated to the router.

The value of this parameter on the router determines how long the LMR gateway delays the audio before sending it to the radio. The delay is necessary to ensure that tones do not overlap with audio when the static tone configuration is used in the dial peers.

Note Make sure that the value that you enter for this parameter is the same that is configured on the LMR gateway. This field must map to the value that is entered in the timing delay-voice tdm CLI command. see Solution Reference Network Design (SRND) (latest version) for more information.

—

Hangover Time (msec)

(Tone control only)

This field specifies a value, in milliseconds, that is set on the LMR gateway that you must replicate on the server for radio instances that are associated to the router.

The value of this parameter on the router determines how long the LMR gateway keeps the radio keyed after the last audio packet is received on a talk spurt. This setting is used to protect the system against packet loss and to accommodate for the configured delay time.

Hangover time is usually larger than the delay time to ensure that all the buffered audio is played before unkeying the radio.

Note Make sure that the value that you enter for this parameter is the same that is configured on the LMR gateway. See Solution Reference Network Design (SRND) (latest version) for more information.

Valid values: 0 through 10000

—

Ops Views Area

Ops Views— Display only

Indicates that the radio is associated to the System ops view.

For general information about ops views, see Chapter 7, "Configuring and Managing Cisco IPICS Operational Views."

Restrictions Area

Allow association to users

Check this check box if you want the radio to be available for association with on ore more users.

Allow use in VTGs

Check this check box if you want the radio to be available for use in one or more VTGs.

If you do not check this check box, the radio can be used only as a channel media connection.

Check this check box if you want the radio to be available for use in one or more VTGs.

If you do not check this check box, the radio can be used only to place private calls to another serial radio.

Control Information Area

Radio Control Service

—

Value is local-rcs.

Connection Information Area

IP Address

—

Enter the IP address of the LMR gateway to which the radio connects.

Port

—

Enter the port number of the auxiliary or asynchronous line of the LMR gateway to which the radio is physically connected. Determine this port number by adding 4,000 to the line number to which the radio is serially connected.

To find the line number, use the show line command on the LMR gateway.

User Name

—

Optional. Enter the user name of the LMR gateway.

Password

—

Optional. Enter the password of the LMR gateway.

Step 3 Click Save.

If you do not want to add the radio, click Cancel.

Note If you are adding a serial radio and the IP address/port provided in the radio connection section is unreachable, the radio could take as long as 30 seconds to save. This applies only to serial radios.

Step 4 To configure channel selectors for this radio, take these actions:

a. Click the Selectors tab.

b. In the Channel Selectors pane, check the check boxes next to the channel selectors that you want to enable.

If you want to check all check boxes at once, check the Enabled check box.

Note Channel selectors and radio controls are defined in the radio type descriptors.

c. In the Channel Selectors pane, choose a priority for each channel selector from the Priority drop-down lists.

Cisco IPICS uses this information to select a pooled radio when a channel selector for multiple pooled radios that belong to the same radio descriptor is used.

Priority levels are 1 (highest priority) through 5 (lowest priority). The default value is 3.

d. Click Save.

If you do not want to save these configurations, click Cancel.

Step 5 To configure Control Functions for this radio, take these action:

a. Click the Controls tab.

b. In the Controls pane, check the check boxes next to the controls that you want to enable.

If you want to check all check boxes at once, check the Enabled check box.

Note Radio controls are defined in the radio type descriptors.

c. Click Save.

If you do not want to save these configurations, click Cancel.

For detailed information about tone control sequences, see the "Configuring Channel Selectors and Control Sequences" section.

Step 6 To disable or enable the radio, click the Disable or Enable button.

If the radio is enabled, the Disable button displays. If the radio is disabled, the Enable button displays. For more information about enabling or disabling radios, see the "Enabling or Disabling a Radio" section.

Note If a pooled radio is allocated to a channel, the name of the channel and a link to the channel display for Pooled Usage in the General area. You cannot disable a pooled radio that is allocated to a channel until it is released by all IDC users and VTGs that activated the channel that uses the pooled radio. You also can force a radio to be deallocated by clicking the Deallocate button in the radio details page.

Step 7 To configure the IDC details for this radio, take these actions:

a. Click the IDC tab.

The IDC tab for the selected channel displays. This window contains IDC information for this radio. Table 9-3 describes the fields in the IDC tab.

Table 9-3 IDC Tab Fields in Radios Window

Field

Description

IDC Tab

RX Mute During PTT

This attribute specifies the transmission settings for all radios or only one radio. It controls the audio for the active radios while you are transmitting.

The following values affect how the mute functionality is configured on the IDC:

•None—When PTT is engaged, the radio is muted

•All—When PTT is engaged, RX (receive transmission) is muted on all channels

•Radio—When radio is engaged, RX is muted for this radio only

Note When you initially assign a radio to the IDC, the RX mute settings that you have configured apply. The IDC user can modify this setting. However, if you change the setting after the radio has been assigned to the user, the changes do not become effective.

Allow Latch

When set to true (attribute check box is checked) on a radio or VTG, the user can use latch (lock in radios) on any radio that you specify.

Caution Use the latch functionality with caution. Be aware that when you latch the PTT button, this action blocks transmissions from half-duplex radios when these devices are attached to the channel or VTG via an LMR gateway.

By default, this attribute is set to false (attribute check box is unchecked).

Listen Only

When set to true (attribute check box is checked), the user can hear but cannot talk, on the radio.

Radio Color

Color tag that you can choose from a drop-down list.

With this setting, you can uniquely identify specific radios by using predefined colors for the background text that appears on the radio. You configure the color by choosing from the options in the drop-down list.

Note If you do not want the radio to be tagged with a color, you can choose Not colored from the drop-down list.

Region

Choose an IDC region from the drop-down list. When configured, the regions appear as tabs in the IDC display for IDC users who are associated with this radio.

To create IDC regions, see the "Adding IDC Regions" section on page 2-137.

b. Click Save.

If you do not want to save these configurations, click Cancel.

To associate users to a radio, see the "Associating a Users to a Radio From the Radios Window" section.

Viewing and Editing Radio Details

You can view and edit information for any radio. Information that you can modify for a radio includes changing the name of a radio, enabling or disabling the channel selectors and tone control sequences, enabling or disabling the radio, and associating the radio to users.

To view or edit radio details, perform the following procedure:

Procedure

Step 1 From the Administration Console, navigate to the Configuration > Radios window.

Step 2 In the Name column, click the link for the radio for which you want to view or change information.

The General tab for the selected radio displays.

Step 3 Take any of the following actions:

•To view or edit general information, update information in the General tab, then click Save.

For descriptions of the fields in the General tab, see Table 9-2.

•To view or edit IDC information, update information in the IDC tab, then click Save.

For descriptions of the fields in the IDC tab, see Table 9-3.

•To enable or disable channel selectors for the radio, check or uncheck the check boxes next to the channel selectors that you want to modify in the Selectors tab, then click Save.

•To enable or disable tone control sequences for the radio, check or uncheck the check boxes next to the tone control sequences that you want to modify in the Controls tab, then click Save.

Note•If you are saving a serial radio and the IP address/port provided in the radio connection section is unreachable, the radio could take as much as 30 seconds to save.

•If radio descriptor files are renamed, deleted, or corrupted, an error message displays in the Radio Management window. This message includes the affected radio descriptor files and a recommendation about how to proceed.

Step 4 To view or edit the IDC attributes for the radio, make the desired changes in the IDC tab, then click Save.

For descriptions of the fields in the IDC tab, see Table 9-3.

Step 5 To view or edit radio associations, see the "Associating a Users to a Radio From the Radios Window" section.

Associating a Users to a Radio From the Radios Window

You can associate specific users to a radio in the Radios window. When you do so, the radios that you choose become available on an IDC.

When you associate a user with a radio, the user has the permission to change to any enabled channel on that radio. However, you can restrict the channels to which the user can tune by setting radio permissions for that user.

Because the radio permissions are separate from channel permissions, a user could have permission to tune a channel on a radio but not have access to the association Cisco IPICS channel.

Note You can perform this procedure only if users have already been added in Cisco IPICS.

You can also associate a user with a radio in the Users window. For information, see the "Associating Radios with a User" section on page 3-33.

To associate a user with a radio, perform the following procedure:

Procedure

Step 1 From the Administration Console, navigate to the Configuration > Radios window.

Step 2 Take either of these actions to display the Associations window for the radio with which you want to associate users:

•Click the link for the radio in the Name column; then, click the Associations button, which appears at the bottom of each tab.

•Check the check box to the left of the name of the radio; then, click the Associations button at the bottom of the Radios window.

Note The Associations button appears dimmed if you do not check a radio or if you check more than one radio.

The Users tab displays for the radio. This tab displays a list of the users that are associated with the radio and the status of each user.

Step 3 To add a user to be associated with the radio, click Add.

The Search Users window displays. This window allows you to search for users to associate to the radio by choosing criteria that is based on the following filters:

•User Name field—Specifies the user name of a user

•First Name field—Specifies the first name of a user

•Last Name field—Specifies the last name of a user

•Location drop-down list—Choose from a list of locations

See the "Managing Locations" section on page 2-41 for detailed information about how to configure locations.

•Role drop-down list—Choose from a list of Cisco IPICS roles

•Ops View drop-down list—Choose from a list of ops views

Step 4 To search for a user, enter your search criteria; then, click Go. To clear your criteria, click Clear Filter.

Note To display all the users in Cisco IPICS, click the Go button without entering any search criteria.

The results of your search criteria display in a list.

Step 5 To choose a user to associate to the radio, check the check box to the left of the user name and click OK.

The user that you choose displays in the user list in the Users tab.

Note You can add multiple users simultaneously by clicking the check boxes next to each user and clicking OK.

Step 6 To view or edit radio permissions for a user, select the user by checking the check box next to the user name and choose one of the following options from the Radio Permissions drop-down list:

•Channel Selector Permissions—When you choose this option, a separate window displays for channel selector permissions. In this window, you can configure specific channels that the user can communicate on.

•Control Function Permissions—When you choose this option, a separate window displays for radio control function permissions. In this window, you can configure specific radio controls that the user can access to control the radio.

Note The Radio Permissions drop-down list appears dimmed if you do not have any users checked or if you have more than one user checked.

Step 7 To select the radio permissions on this radio for the user, take any of the following actions in the applicable radio permissions window:

•To move a channel selector or control function from one list to the other, click the item to highlight it; then, click > or <. Or, double-click the item.

•To move several channel selectors or control functions from one list to the other at one time, Shift-click or Ctrl-click to select the items, then, click > or <.

•To move all channel selectors/control functions from one list to the other at one time, click >> or <<.

Step 8 Click Save.

Note If you are saving a serial radio and the IP address/port provided in the radio connection section is unreachable, then the radio could take as much as 30 seconds to save.

Step 9 To remove a user from the association to the radio, check the check box to the left of the user name; then, click the Delete button.

You can remove multiple users from the association at the same time by checking the check boxes that display by the user names of the users that you want to remove and clicking Delete.

Enabling or Disabling a Radio

You can enable or disable a radio in Cisco IPICS. If the radio is disabled, you can can still modify the multicast address, location, LLGT, and all of the other attributes of the radio. However, if the radio is enabled, you cannot modify these attributes.

If the radio is part of an active VTG and you disable the radio, it disconnects from the VTG.

Note After you define a radio, the radio type cannot be changed even if you disable the radio. If you want to change the radio type after you define the radio, you must delete the radio and create a new radio instance. If you only want to modify the types of tones on a radio type, you can upload a new descriptor file for the same radio type and the changes get applied to that radio instance. For more information about descriptors, see the "Managing Radio Descriptors" section.

To enable or disable a radio, perform the following procedure:

Procedure

Step 1 From the Administration Console, navigate to the Configuration > Radios window.

Step 2 Under the Name column, click the link of the radio that you want to enable or disable.

The General tab displays for the radio.

Step 3 To enable or disable the radio, click the Enable/Disable button at the bottom of the window.

Note If the radio is currently enabled, only the Disable button displays. If the radio is currently disabled, only the Enable button displays.

If you do not want to enable or disable the radio, click Cancel.

Deleting a Radio

If a radio is no longer needed, you can delete it from Cisco IPICS. You can delete a single radio or you can delete several radios at one time.

Before you delete a radio, you must remove any associated media connections in all of the channels for that radio.

Note You cannot delete a pooled radio that is allocated to a channel. Before deleting the radio, deactivate the VTG that caused the channel activation or have all users that activated the channel deactivate it. You can also can force a radio to be deallocated by clicking the Deallocate button in the radio details page. After the radio is forcibly deallocated, you can delete it.

To delete a radio, perform the following procedure:

Procedure

Step 1 From the Administration Console, navigate to the Configuration > Radios window.

Step 2 Check the check box next to each radio that you want to delete.

Step 3 Click Delete.

A dialog box prompts you to confirm the deletion.

Step 4 To confirm the deletion, click OK.

If you do not want to delete the radio, click Cancel.

Accessing and Using the Serial Radio Control Interface

After you configure a serial controlled radio, you can access and use the SRCI from an IDC, as described in IPICS Dispatch Console User Guide for release 4.0, or from the Cisco IPICS Administration Console.

To access the SRCI from the Administration Console, perform any of the following actions:

•Navigate to the Configuration > Radios window, click the link for the desired radio in the Name column, then click Controls, which displays at the bottom of each tab.

•Navigate to the Configuration > Radios window, check the check box next to the radio for which you want to access the SRCI, then click Radio Control.

•Navigate to the VTG Management > Virtual Talk Groups window, and click a VTG name. In the Participants tab, double-click a radio in the Participants or Resources box.

•If the radio is associated with a user, navigate to User Management > Users, choose a user, click Associations, choose the Radio tab, choose the desired radio, then click Radio Control.

The SRCI displays in its own page and is organized as follows:

Radio Information

The top area of the SRCI provides the following information and functions:

•Name of the radio, as configured in the Name field in the General tab for the radio.

•Type of the radio, as defined in the radio descriptor.

•Connection status of the radio, which can be any of the following:

–CONNECTED_ONLINE—Radio is ready for control.

–CONNECTED_OFFLINE—Radio connection to the LMR gateway is active, but Cisco IPICS cannot communicate with the radio. This situation can occur if the radio is turned off or is not connected to the correct asynchronous line on the correct LMR gateway, or if the connected radio is of the wrong type.

–AUTHENTICATION_FAILURE—The login credentials provided in the radio details are not correct and IPICS cannot connect to the specified port on the LMR Gateway.

–SOCKET_FAILURE—Cisco IPICS cannot connect to the LMR gateway IP address and port that are as configured in the General tab for the radio. This situation can occur if the IP address or port number are incorrect, the LMR gateway is turned off, the LMR gateway is disconnected from the network or in an unreachable network, or the LMR gateway is in use and needs to be cleared.

–DISCONNECTED—Cisco IPICS has not initialized the connection or is in the process of re-initializing the connection because of a SOCKET_FAILURE or AUTHENTICATION_FAILURE situation.

–RADIO CONTROL SERVICE UNAVAILABLE: The Cisco IPICS Radio Control Service is down and needs to be restarted.

•Reserve/Release toggle button—The Reserve button allows you to indicate to other users that you would like to use this radio. When you click this button, your Cisco IPICS user name and full name appear in the Reserved By field and the date and time that you clicked it appear in the Reserved On field. In addition, the name of the button changes to Release. In this case, other SRCI and IDC users see the Release button and they see your information in the Reserved By and Reserved On fields.

This function is provided as a courtesy only and does not block any user from controlling the radio. Any SRCI or IDC user can click the Release button, which clears the Reserved By and Reserved On information and changes the button name to Reserve.

If the radio is in an active VTG, Cisco IPICS disables the Reserve/Release button. In addition, the VTG name and the date and time that this radio was added to the VTG appear in the Reserved by field, with the date and time this radio was added to the active VTG. (Any user can control a radio that is reserved by a VTG.)

Radio Display and Controls

The second-from-the-top area of the SRCI provides the following information:

•The type of call that is active on the controlled radio, followed by the channel selector name, the private call alias/ID, or the group call name. Call types are indicated as follows:

–[Channel/TG]—Conventional channel and trunked talkgroup operation

–[Private Call]—Unit to unit calls (iDEN and Sprint Nextel only)

–[Group Call]—Dynamic group operation (iDEN and Sprint Nextel only)

•A green icon that appears when there is inbound voice traffic on the channel.

•When there is inbound voice to the radio and the radio detects the talker ID, this ID displays below the channel selector for the duration of the inbound voice.

•Configured control functions. Each function appears as a button, and the current state of each function displays above the corresponding button.

Channel Selectors

The third-from-the-top area of the SRCI includes channel selectors. Each configured channel selector displays as a button. Depending on the radio control configuration, a user may be able to press a channel selector button to change the channel/talkgroup on the radio or place a private or group call.

IPICS Connect

Applies to Nextel radios only.

The bottom area of the SRCI allows you to make private calls, group calls, and call alerts (pages). This area applies to Nextel radios only.

Making private and group calls from the channel selector area is a one touch operation. From the IPICS Connect box, you can make ad-hoc private and group calls, including combining users from different predefined groups. You can also send a call alert (page) to a predefined participant or ad-hoc participant.

The names that display in the Select From Groups/Users list come from channel selectors for private and group calls that are defined in the serial radio descriptor, and from Cisco IPICS users that are associated with a Nextel radio.

To make a private call, follow these steps:

Step 1 Take either of these actions:

•Enter a direct connect number to call in the Direct Connector Number field and then click << to move the number to the Participants list. The number must be in a Nextel-supported format.

•Click a name of a user to call in the Groups/Users list and then click << to move the name to the Participants list.

Step 2 Click Call to initiate the private call to the selected number or user.

To make a group call, follow these steps:

Step 1 Enter a group name (from 1 to 20 characters) in the Group/User Alias field.

Step 2 Take either or both of these actions:

•Enter a direct connect number in the Direct Connector Number field and then click << to move the number to the Participants list.

•Click a name in the Groups/Users list and then click << to move the item to the Participants list.

Repeat this step as needed to specify up to 20 items in the Participants list.

Step 3 Click Call to initiate the group call.

To send a call alert, also known as a page, follow these steps:

Step 1 Take either of these actions:

•Enter a direct connect number to page in the Direct Connector Number field and then click << to move the number to the Participants list.

•Click a name of the user to page in the Groups/Users list and then click << to move the name to the Participants list.

Step 2 Click Alert to initiate the alert to the selected direct connect number or user.

You can send a call alert only to one participant at a time.

Managing Radio Descriptors

This section describes radio and tone descriptor management tasks and includes the following topics:

•Radio Descriptors

•Tone Descriptors

•Caveats for IDC Operation

•Understanding the Descriptors Window

•Adding Descriptors

•Updating Radio and Tone Descriptors

•Deleting Radio and Tone Descriptors

Radio Descriptors

Radio descriptors define the controls that a particular type of tone control or serial control radio supports.

Note A radio type may refer to a specific make and model of radio or special tone-controlled hardware, such as a CPI box, which interprets the inband tones and causes the configuration of an attached radio to be changed.

Radio descriptors are .xml files that contain commands that are used to control functions on a radio. These files contain the following elements:

•Channel selectors—Used to change the frequency on a radio

•Control functions—Stateful controls, such as power settings and encryption on/off, and simple (momentary) controls, such as monitor and scan

Note When choosing a descriptor type in the Administration Console, be aware that a Tone Radio descriptor type refers to a radio descriptor file and a Tones descriptor type refers to a tone descriptor file. See the "Adding Descriptors" section and "Updating Radio and Tone Descriptors" section for more information.

For each radio capability, the radio descriptor defines the tones (events) that need to be sent to the radio to enable or disable that capability.

Note For tone control channel selectors and control functions (both stateful and simple), Cisco IPICS supports only RFC 2833 tones. See the "Caveats for IDC Operation" section for more information.

The tone control sequences that define the control functions can be included directly in the radio descriptor, or can be referenced by name in a tone descriptor file. For more information about tone descriptors, see the "Tone Descriptors" section.

The Cisco IPICS server provides an example radio descriptor file; however, you may need to modify this example and/or create additional radio descriptors that properly model your specific radio hardware. The example file is in the list of descriptors.

If you must modify or create radio descriptors, see the documentation that came with your radio, or other device that is being controlled, for the specific tone sequences that it supports.

Caution Because improperly constructing an .xml file, removing a radio descriptor file, or removing elements from a radio descriptor file may have unpredictable results, Cisco recommends that you only modify the radio descriptor file when absolutely necessary.

For more information about adding or modifying descriptor files, see the "Managing Radio Descriptors" section. To see examples of valid and invalid descriptor file .xml entries, see the "Examples of descriptor .xml files" section.

See the "Radio Descriptor Format" section for an example of the format of a radio descriptor.

Radio Descriptor Format

The following example shows the format of a radio descriptor .xml file:

Radio Descriptor File Format
<?xml version="1.0" encoding="UTF-8"?>
<ipics:RadioTypeDescriptor... name="CPITestBox"> 
where:

name= represents the name of the radio type that displays in the UI; this name should be unique.
	<Commands>... </Commands>
Commands define "macro-like" tone/event sequences that can be used elsewhere within the radio descriptor.
	<ChannelSelectors>... </ChannelSelectors>
Channel selectors define the available tone sequences needed to use each channel on the radio.
	<ControlFunctions>... </ControlFunctions>
Control functions define the available stateful control sequences and the tones that need to be sent to enable each stateful state.

Examples of descriptor .xml files

The following example shows valid radio signaling .xml entries. Even though this example shows more than six consecutive RFC 2833 tone sequences, it is still valid because the tones are separated by a pause entry of at least 1 ms (frequency = 0 tone).
<Signal shortName="TV" longName="Start TV" description="Start the 
Television">
    <Action type="pressed">
        <Command>
            <Rfc2833Tone db="0" duration="40" frequency="100" /> 
            <Rfc2833Tone db="0" duration="40" frequency="200" /> 
. 
. 
.
duration="40" frequency="600" /> 
            <Rfc2833Tone db="0" duration="1" frequency="0" /> 
            <Rfc2833Tone db="0" duration="40" frequency="700" /> 
            <Rfc2833Tone db="0" duration="40" frequency="800" /> 
        </Command>
    </Action>
</Signal>
The remaining examples involve invalid entries.

The following example shows more than six RFC 2833 tone entries as part of a radio signaling tone sequence and does not include any pause entries.
<Signal shortName="TV" longName="Start TV" description="Start the 
Television">
    <Action type="pressed">
        <Command>
            <Rfc2833Tone db="0" duration="40" frequency="100" /> 
            <Rfc2833Tone db="0" duration="40" frequency="200" /> 
            <Rfc2833Tone db="0" duration="40" frequency="300" /> 
            <Rfc2833Tone db="0" duration="40" frequency="400" /> 
            <Rfc2833Tone db="0" duration="40" frequency="500" /> 
            <Rfc2833Tone db="0" duration="40" frequency="600" /> 
            <Rfc2833Tone db="0" duration="40" frequency="700" /> 
        </Command>
    </Action>
</Signal>
The following example shows DTMF events as part of a radio control tone sequence.
<ChannelSelector label="F2">
    <Action type="tune">
        <CommandRef href="hlgt" /> 
        <Command>
            <Rfc2833Tone db="-10" duration="40" frequency="1850" /> 
            <Rfc2833Event db="-30" duration="200" event="5" />
        </Command>
    </Action>
    <Action type="begintransmit">
        <CommandRef href="hlgt" /> 
        <Command>
           <Rfc2833Tone db="-10" duration="40" frequency="1850" /> 
           <Rfc2833Event db="-30" duration="200" event="5" />
        </Command>
        <CommandRef href="llgt" /> 
    </Action>
</ChannelSelector>
The following example shows more than six consecutive RFC 2833 radio control tone sequences.
<State shortName="On">
    <Action type="pressed">
        <Command>
            <Rfc2833Tone db="-10" duration="200" frequency="1105" />
.
.
.
		<Rfc2833Tone db="-10" duration="200" frequency="1605" /> 
            <Rfc2833Tone db="-10" duration="200" frequency="1705" />            
        </Command>
    </Action>
</State>
Tone Descriptors

A tone descriptor file is an .xml file that defines commands and over-the-air signals that can be associated to one or more Cisco IPICS channels. Commands can be referenced by any radio descriptor and signals can be associated to any channel.

A tone sequence is a list of tones and events that are used to either control a radio or to signal a channel. For more information about tone sequences, see the "Configuring Channel Selectors and Control Sequences" section.

Most tone control radios support a standard set of tone sequences. Some sequences are used to change the RF channel, while other sequences are used to enable the scan functionality on a radio. There are many more tone sequences that are used for tone signaling.

For tone sequences, Cisco IPICS supports both RFC 2833 tone and RFC 2833 event (DTMF) commands. For more information, see the "Caveats for IDC Operation" section.

For some examples of valid and invalid descriptor file entries, see the "Examples of descriptor .xml files" section.

Unlike momentary controls, signals do not cause the radio to change configuration; rather, signals are treated like voice and are transmitted over the currently-tuned radio channel frequency.

Each tone in a sequence is specified by the frequency (from 0 to 3999 Hz), a decibel (db) level (0 to -63), and a duration in milliseconds. This sequence of tones can be used by different radios. For tone signaling purposes, each telephony event in a sequence is specified by the event type (from 0 to 255), a db level (0 to -63), and a duration in milliseconds.

Note Any RFC 2833 tone or event has a maximum duration of eight seconds. See the "Caveats for IDC Operation" section for more information.

The Cisco IPICS server provides signaling sequences in an example tone descriptor file called ExampleToneSet.xml; however, you may need to modify this example file or create additional tone descriptors that properly model your specific radio hardware. To add or update descriptors, see the "Managing Radio Descriptors" section.

Note•If you must modify or create tone descriptors, see the documentation that you received with your radio or other device that you need to control for the specific signaling sequences that it supports.

•When choosing a descriptor type in the Administration Console, be aware that a Tone Radio descriptor type refers to a radio descriptor file and a Tones descriptor type refers to a tone descriptor file. See the "Adding Descriptors" section and "Updating Radio and Tone Descriptors" section for more information.

Caution Improperly constructing an .xml file, removing a tone descriptor file, or removing elements from a tone descriptor file that is referenced by a radio descriptor file may have unpredictable results. Cisco recommends that you only modify the tone descriptor file when absolutely necessary.

For information about the descriptor management functions in the Descriptors window, see the "Understanding the Descriptors Window" section.

Serial Descriptors

The following sections describe the general steps for creating a serial descriptor for serial radio control:

•Step 1: Create the Header

•Step 2: Create the Body

Step 1: Create the Header

A radio descriptor begins with the element <SerialRadioTypeDescriptor>. This element includes the following attributes:

•name—Contains 1 through 64 characters and specifies the name of the radio descriptor.

•controlType—Always set to SERIAL.

•controlModule—Specifies the type of radio that is controlled. Use "Nextel" for iDEN radios in a Sprint Nextel or private iDEN network. Use "EFJohnson" for EF Johnson model 5300 mobile radios.

The following is an example of a serial descriptor header:
<ipics:SerialRadioTypeDescriptor xmlns:ipics= 
       "urn:com.cisco.ipics.RadioDescriptor"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xsi:schemaLocation="urn:com.cisco.ipics.RadioDescriptor 
../../SerialRadioTypeDescriptor.xsd "
               name="Nextel"
               controlType="SERIAL"
               controlModule="Nextel">
Step 2: Create the Body

The body of the radio descriptor has two main sections, <ChannelSelectors> and <ControlFunctions>, each of which define buttons that the SRCI renders.

Channel Selectors

<ChannelSelector> elements are controls that set up the radio for a specific mode of communication. The controls include selecting a channel/talkgroup on the radio or placing a private or dynamic group all.

Each <ChannelSelector> has a required "label" attribute that is 1 through 12 characters in length and that defines the name of a button that the SRCI renders.

The <Action> element within each <ChannelSelector> includes the "type" attribute. This attribute must be set to "tune" and indicates that this control is communications related.

The <Action> element includes the <Command> element. This attribute specifies the tuning action and can be either <Channel> or <GroupCall>.

Selecting a Channel or Talkgroup

For channel or talkgroup controls, the element within <Command> must be <Channel>. The <Channel> element must include these attributes:

•zone—Must be set to a valid zone in the radio that represents this channel selector.

•channel—Must be set to a valid channel in the radio that represents this channel selector.

iDEN radios do not have the concept of zones and channels. For these radios, always set the zone attribute 1. The channel attribute represents the talkgroup ID and can range from 1 to 200.

The following example shows the use of the <ChannelSelector> element:
<ChannelSelector label="CHAN 5">
          <Action type="tune">
                    <Command>
                              <Channel zone="1" channel="5" />
                    </Command>
          </Action>
</ChannelSelector>
Setting up a Private Call

This feature applies only to iDEN radios.

To define a channel selector that can set up a private call, the <Command> element must contain a child element called <GroupCall>. The <GroupCall> element includes the "name" attribute, which defines the name of the button that represents this private call. The "name" attribute can contain 1 through 12 characters.

The <GroupCall> element contains the ID of the remote radio that will participate in this call. The radio is represented by the <Call> element and contains an attribute called "number."

The following example represents an iDEN private call with the direct connect number of the participant in the <Call> element:
<ChannelSelector label="W Plinge">
          <Action type="tune">
                    <Command>
                              <GroupCall groupName="W Plinge">
                                        <Call number="123*45678*9" />
                              </GroupCall>
                    </Command>
          /Action>
</ChannelSelector>
Setting up a Group Call

This feature applies only to iDEN radios that are in iDEN networks that are capable of dynamic group calls.

To define a channel selector that can set up a group call, the <Command> element contains one or more child elements called <GroupCall>. Each <GroupCall> element includes the "name" attribute, which defines the name of the button that represents this private call. The "name" attribute can contain 1 through 12 characters.

The following example represents an iDEN group call with the direct connect numbers of the participants in <Call> elements:
<ChannelSelector label="My Team">
          <Action type="tune">
                    <Command>
                              <GroupCall groupName="My Team">
                                        <Call number="123*45678*9" />
                                        <Call number="123*45678*10" />
                                        <Call number="123*45678*11" />
                                        <Call number="123*45678*12" />
                              </GroupCall>
                    </Command>
          </Action>
</ChannelSelector>
Control Functions

Control functions define buttons on the SRCI that can control certain functions of the control radio. Control functions do not exist in iDEN radios. These control functions are listed as <Simple> elements, with the following attributes:

"shortName" is an attribute of a control function. It is 1 through 12 characters in length and defines the name of the control as rendered on the SRCI.

"description" is an attribute of a control function. It describes the nature of the control function.

Each <Simple> element contains an <Action> element, which defines the control functions with the "type" attribute. An <Action> element is always set to a value of "pressed" and contains a <Command> element, which determines the specific command for the control function.

Cisco IPICS provides the following control functions:

•Monitor—When representing a control function to enable or disable monitor mode in the controlled radio, use the following xml within <ControlFunctions>:
<Stateful shortName="MON" longName="Monitor" description="Set 
Monitor Mode" presentation="multiple">
                     <State shortName="ON" longName="ON" 
description="Monitor mode is on" user_selectable="true">
                           <Action type="pressed">
                                   <Command>
                                         <SetMonitorMode 
value="ON" />
                                  </Command>
                           </Action>
                     </State>
                     <State shortName="OFF" longName="OFF" 
description="Monitor mode is off" user_selectable="true">
                           <Action type="pressed">
                                  <Command>
                                         <SetMonitorMode 
value="OFF" />
                                  </Command>
                           </Action>
                     </State>
                     <State shortName="UNKWN" longName="UNKNOWN" 
description="Monitor mode is in an unknown state" 
user_selectable="false">
                           <Action type="pressed">
                                  <Command>
                                         <SetMonitorMode 
value="UNKNOWN" />
                                  </Command>
                           </Action>
                     </State>
                     <State shortName="UNSPRT" 
longName="UNSUPPORTED" description="Monitor mode is not supported" 
user_selectable="false">
                           <Action type="pressed">
                                  <Command>
                                         <SetMonitorMode 
value="UNSUPPORTED" />
                                  </Command>
                           </Action>
                     </State>
              </Stateful>
•Secure Transmit Mode—When representing a control function to toggle between secure and clear transmit modes in the controlled radio, use the following xml within <ControlFunctions>:
<Stateful shortName="SEC" longName="Secure Tx Mode" 
description="Select Between Secure and Clear Transmit Modes" 
presentation="multiple">
                     <State shortName="SEC" longName="SECURE" 
description="Secure transmit mode is set to SECURE" 
user_selectable="true">
                           <Action type="pressed">
                                  <Command>
                                         <SetSecureTxMode 
value="SECURE" />
                                  </Command>
                           </Action>
                     </State>
                     <State shortName="CLR" longName="CLEAR" 
description="Secure transmit mode is set to CLEAR" 
user_selectable="true">
                           <Action type="pressed">
                                  <Command>
                                         <SetSecureTxMode 
value="CLEAR" />
                                  </Command>
                           </Action>
                     </State>
                     <State shortName="KEYFL" longName="KEYFAIL" 
description="Keyfail. Key required for encryption is not present" 
user_selectable="false">
                           <Action type="pressed">
                                  <Command>
                                         <SetSecureTxMode 
value="KEYFAIL" />
                                  </Command>
                           </Action>
                     </State>
                     <State shortName="NOENC" 
longName="NO_ENCRYPT" description="No encryption module present" 
user_selectable="false">
                           <Action type="pressed">
                                  <Command>
                                         <SetSecureTxMode 
value="NO_ENCRYPT" />
                                  </Command>
                           </Action>
                     </State>
                     <State shortName="MSMTCH" longName="MISMATCH" 
description="Mismatch between user selected secure transmit mode 
and actual fixed/strapped tx mode" user_selectable="false">
                           <Action type="pressed">
                                  <Command>
                                         <SetSecureTxMode 
value="MISMATCH" />
                                  </Command>
                           </Action>
                     </State>
                     <State shortName="UNKWN" longName="UNKNOWN" 
description="Secure/Clear Transmit mode is in an unknown state" 
user_selectable="false">
                           <Action type="pressed">
                                  <Command>
                                         <SetSecureTxMode 
value="UNKNOWN" />
                                  </Command>
                           </Action>
                     </State>
                     <State shortName="UNSPRT" 
longName="UNSUPPORTED" description="Encryption is not supported" 
user_selectable="false">
                           <Action type="pressed">
                                  <Command>
                                         <SetSecureTxMode 
value="UNSUPPORTED" />
                                  </Command>
                           </Action>
                     </State>
              </Stateful>
•Repeater/Talkaround—When representing a control function to toggle between repeater and talkaround modes in the controlled radio, use the following xml within <ControlFunctions>:
<Stateful shortName="RTA" longName="Repeater/Talkaround" 
description="Select Between Repeater and Talkaround Transmit 
Modes" presentation="multiple">
                     <State shortName="RPTR" longName="REPEATER" 
description="Transmit mode is set to REPEATER" 
user_selectable="true">
                           <Action type="pressed">
                                  <Command>
                                         <SetRepeaterTaMode 
value="REPEATER" />
                                  </Command>
                           </Action>
                     </State>
                     <State shortName="TA" longName="TALKAROUND" 
description="Transmit mode is set to TALKAROUND" 
user_selectable="true">
                           <Action type="pressed">
                                  <Command>
                                         <SetRepeaterTaMode 
value="TALKAROUND" />
                                  </Command>
                           </Action>
                     </State>
                     <State shortName="UNKWN" longName="UNKNOWN" 
description="Repeater/Talkaround mode is in an unknown state" 
user_selectable="false">
                           <Action type="pressed">
                                  <Command>
                                         <SetRepeaterTaMode 
value="UNKNOWN" />
                                  </Command>
                           </Action>
                     </State>
                     <State shortName="UNSPRT" 
longName="UNSUPPORTED" description="Repeater/TA mode selection is 
not supported" user_selectable="false">
                           <Action type="pressed">
                                  <Command>
                                         <SetRepeaterTaMode 
value="UNSUPPORTED" />
                                  </Command>
                           </Action>
                     </State>
              </Stateful>
•Transmit Power—When representing a control function to toggle transmit power in the controlled radio, use the following xml within <ControlFunctions>:
<Stateful shortName="PWR" longName="Transmit Power Mode" 
description="Change the transmit power level" 
presentation="multiple">
                     <State shortName="HIGH" longName="HIGH" 
description="Transmit power mode is set to HIGH" 
user_selectable="true">
                           <Action type="pressed">
                                  <Command>
                                         <SetTxPowerMode 
value="HIGH" />
                                  </Command>
                           </Action>
                     </State>
                     <State shortName="LOW" longName="LOW" 
description="Transmit power mode is set to LOW" 
user_selectable="true">
                           <Action type="pressed">
                                  <Command>
                                         <SetTxPowerMode 
value="LOW" />
                                  </Command>
                           </Action>
                     </State>
                     <State shortName="UNKWN" longName="UNKNOWN" 
description="Transmit power mode is in an unknown state" 
user_selectable="false">
                           <Action type="pressed">
                                  <Command>
                                         <SetTxPowerMode 
value="UNKNOWN" />
                                  </Command>
                           </Action>
                     </State>
                     <State shortName="UNSPRT" 
longName="UNSUPPORTED" description="Transmit power mode selection 
is not supported" user_selectable="false">
                           <Action type="pressed">
                                  <Command>
                                         <SetTxPowerMode 
value="UNSUPPORTED" />
                                  </Command>
                            </Action>
                     </State>
              </Stateful>
•Scan—When representing a control function to toggle scan mode in the controlled radio, use the following xml within <ControlFunctions>:
<Stateful shortName="SCN" longName="Scan" description="Set Scan 
Mode" presentation="multiple">
                     <State shortName="ON" longName="ON" 
description="Scan is on" user_selectable="true">
                           <Action type="pressed">
                                  <Command>
                                         <SetScanMode value="ON" 
/>
                                  </Command>
                           </Action>
                     </State>
                     <State shortName="OFF" longName="OFF" 
description="Scan is off" user_selectable="true">
                           <Action type="pressed">
                                  <Command>
                                         <SetScanMode value="OFF" 
/>
                                  </Command>
                           </Action>
                     </State>
                     <State shortName="UNKWN" longName="UNKNOWN" 
description="Scan is in an unknown state" user_selectable="false">
                           <Action type="pressed">
                                  <Command>
                                         <SetScanMode 
value="UNKNOWN" />
                                  </Command>
                           </Action>
                     </State>
                     <State shortName="UNSPRT" 
longName="UNSUPPORTED" description="Scan is not supported" 
user_selectable="false">
                           <Action type="pressed">
                                  <Command>
                                         <SetScanMode 
value="UNSUPPORTED" />
                                  </Command>
                           </Action>
                     </State>
              </Stateful>
•Emergency Mode—When representing a control function to toggle emergency mode in the controlled radio, use the following xml within <ControlFunctions>:
<Stateful shortName="EMG" longName="Emergency" 
description="Enable/Disable Emergency Mode" 
presentation="multiple">
                     <State shortName="ON" longName="ON" 
description="Emergency mode is on" user_selectable="true">
                           <Action type="pressed">
                                  <Command>
                                         <SetEmergencyMode 
value="ON" />
                                  </Command>
                           </Action>
                     </State>
                     <State shortName="OFF" longName="OFF" 
description="Emergency mode is off" user_selectable="true">
                           <Action type="pressed">
                                  <Command>
                                         <SetEmergencyMode 
value="OFF" />
                                  </Command>
                           </Action>
                     </State>
                     <State shortName="UNKWN" longName="UNKNOWN" 
description="Emergency mode is in an unknown state" 
user_selectable="false">
                           <Action type="pressed">
                                  <Command>
                                         <SetEmergencyMode 
value="UNKNOWN" />
                                  </Command>
                           </Action>
                     </State>
                     <State shortName="UNSPRT" 
longName="UNSUPPORTED" description="Emergency mode is not 
supported" user_selectable="false">
                           <Action type="pressed">
                                  <Command>
                                         <SetEmergencyMode 
value="UNSUPPORTED" />
                                  </Command>
                           </Action>
                     </State>
              </Stateful>
Caveats for IDC Operation

For Serial Control the CTRL button opens a browser-based UI to control radios.

If you are using a tone controlled radio, be aware of the following IDC operation caveats when configuring tone sequences in radio and tone descriptor files:

•For tone control sequences (channel selectors and radio control functions), Cisco IPICS supports only RFC 2833 tones (DTMF entries are not supported).

•You cannot enter more than six consecutive RFC 2833 tones in a tone control sequence.

The following example shows the format of an RFC 2833 tone:
<Rfc2833Tone db="0" duration="40" frequency="100" /> 
A tone sequence is a sequence of tones, as shown in the following 
example:
<Rfc2833Tone db="0" duration="40" frequency="100" /> 
<Rfc2833Tone db="0" duration="40" frequency="200" /> 
<Rfc2833Tone db="0" duration="40" frequency="300" /> 
<Rfc2833Tone db="0" duration="40" frequency="400" /> 
<Rfc2833Tone db="0" duration="40" frequency="500" /> 
<Rfc2833Tone db="0" duration="40" frequency="600" /> 
Note The tone sequence in the previous example does not display more than six consecutive RFC 2833 tones ("100" through "600").

•For tone signaling, Cisco IPICS supports both RFC 2833 tone and RFC 2833 event (DTMF) commands.

You can enter more than six consecutive RFC 2833 tones only if the sixth tone event is separated by a pause entry (such as one ms) or a DTMF digit entry (such as digit one for 200 ms).

Note When you enter DTMF digits, be sure to configure a delay between the digits so that DTMF gets detected, as required by the local specifications. U.S. specifications require a delay of 40 ms.

There is no limit to the number of DTMF entries that are allowed in a signaling tone sequence.

Note You can define a pause by a tone with a frequency of zero, as in the following example:

<Rfc2833Tone db="0" frequency="0" duration="40" />

where:

db="0" frequency="0" represents the pause entry.

•Because tone sequences, whether in signaling or control sequences, are grouped into RFC 2198 packets, a maximum duration gets imposed for some of the tones. For example, if `n' is the total number of tones in the tone sequence, where max(n) = 6, the maximum duration for the first (n-1) tones cannot be more than two seconds.

•The maximum duration for any RFC 2833 tone or event is 8 seconds.

•Because preamble tones that are longer than one second compromise the beginning of talk spurts, there is a maximum possible voice delay of one second.

For some examples of valid and invalid descriptor file entries, see the "Examples of descriptor .xml files" section.

Understanding the Descriptors Window

The Descriptors window lists information about each of the radio and tone and serial descriptor files that you have added in Cisco IPICS.

This window also enables you to perform several radio and tone descriptor management functions. To display the Descriptors window, navigate to Configuration > Descriptors in the Administration Console.

Table 9-4 describes the items in the Descriptors window.

Table 9-4 Fields in the Descriptors Window

Field

Description

Reference

Name field

This field indicates the name of the radio type that Cisco IPICS supports.

See the "Radio Descriptors" section, the "Tone Descriptors" section, and the "Adding Descriptors" section.

File Name field

This field indicates the name of the radio/tone descriptor .xml file.

Type field

This field indicates the type of descriptor.

Note When choosing a descriptor type in the Administration Console, be aware that a Tone Radio descriptor type refers to a radio descriptor file and a Tones descriptor type refers to a tone descriptor file.

File Size (KB) field

This field indicates the size of the descriptor file.

Last Update field

This field indicates the date and time of the last modified descriptor file.

Add button

Click this button to add new descriptor files.

See the "Adding Descriptors" section.

Update button

Click this button to update existing descriptor files.

See the "Updating Radio and Tone Descriptors" section.

Delete button

Click this button to delete descriptor files from Cisco IPICS.

See the "Deleting Radio and Tone Descriptors" section.

Display Controls

Rows per page drop-down list

Specifies the number of rows of descriptors that are included in a descriptors list page.

See the "Navigating Item Lists" section on page 1-19.

Page field

Displays descriptors on a specific page.

|< (First page) button

Displays the first page of the descriptors list.

< (Previous page) button

Displays the previous page of the descriptors list.

> (Next page) button

Displays the next page of the descriptors list.

>| (Last page) button

Displays the last page of the descriptors list.

Adding Descriptors

You can add descriptors to Cisco IPICS in the Configuration > Descriptors window in the Administration Console.

For detailed information about descriptors, see the "Radio Descriptors" section and "Tone Descriptors" section.

For examples of valid and invalid descriptor file .xml entries, see the "Examples of descriptor .xml files" section.

Note When choosing a descriptor type in the Administration Console, be aware that a Tone Radio descriptor type refers to a radio descriptor file and a Tones descriptor type refers to a tone descriptor file.

To add a new descriptor file, perform the following procedure:

Procedure

Step 1 From the Cisco IPICS Administration Console, navigate to the Configuration > Descriptors window.

Step 2 In the Descriptors window, click Add.

The New Descriptor window displays.

Step 3 From the Descriptor Type drop-down list, choose one of the following options:

•Tone Radio—Choose this option to add a descriptor file for a tone control radio.

•Serial Radio—Choose this option to add a descriptor file for a serial control radio.

•Tones—Choose this option to add a tone descriptor file.

Step 4 To locate the descriptor file that you want to add, click Browse.

Step 5 In the Choose File window, navigate to the location of the descriptor file that you want to add and highlight the file.

Step 6 Click Open.

The File to Upload field gets populated with the descriptor file that you selected.

Step 7 Click Save.

If you do not want to add the descriptor, click Cancel.

Note If you need to modify an existing descriptor file, follow the steps in the "Updating Radio and Tone Descriptors" section.

Updating Radio and Tone Descriptors

You can update an existing descriptor file in Cisco IPICS in the Descriptors window.

Note When choosing a descriptor type in the Administration Console, be aware that a Tone Radio descriptor type refers to a radio descriptor file and a Tones descriptor type refers to a tone descriptor file.

When you update a radio descriptor to add new channel selectors or control functions, all of the radio instances that are currently using this descriptor get updated accordingly. If there are any IDC users using these radio instances, their IDC clients get updated also.

If you update a tone descriptor, the system checks the newly uploaded file for missing commands that may be in use by the radio descriptor file.

Note If you upload a new file that is missing a command, which is in use by the radio descriptor, the system does not allow the update.

For more detailed information about radio and tone descriptors, see the "Radio Descriptors" section and the "Tone Descriptors" section.

To update radio and tone descriptors, perform the following procedure:

Procedure

Step 1 From the Cisco IPICS Administration Console, navigate to the Configuration > Descriptors window.

Step 2 Click the radio button next to the descriptor that you want to update.

Step 3 Click Update.

Step 4 Click the Browse button, that is next to the File to Upload field.

Step 5 In the Choose File window, navigate to the location of the descriptor file that you want to use to update and highlight the file.

Step 6 Click Open.

The File to Upload field gets populated with the descriptor file that you selected.

Step 7 Click Save.

If you do not want to update the descriptor, click Cancel.

Note If there are multiple radio descriptor files for the same type of radio, the Cisco IPICS server uses the latest uploaded file. This feature allows you to update the radio descriptor file for a given radio type by uploading a new descriptor file.

Deleting Radio and Tone Descriptors

You can delete radio and tone descriptor files from Cisco IPICS.

You cannot delete radio descriptor files that are being used by radios.

For more detailed information about radio and tone descriptors, see the "Radio Descriptors" section and the "Tone Descriptors" section.

To delete a radio, perform the following procedure:

Procedure

Step 1 From the Administration Console, navigate to the Configuration > Radios window.

Step 2 Check the check box next to each radio that you want to delete.

Step 3 Click Delete.

A dialog box prompts you to confirm the deletion.

Step 4 To confirm the deletion, click OK.

If you do not want to delete the radio(s), click Cancel.