This topic describes the steps for building an integrated AN application that uses the Aztek AV5 protocol stack library and the NMS V5 library.
Before integrating the various parts of the AN system, create a mapping between the V5.2 protocol structures and the data types defined by the layers of the AV5 protocol stack and by the NMS V5 library. The following table shows mappings for data structures that are common for different functions within the AV5 and NMS V5 libraries:
|
V5.2 protocol data |
NMS V5 data types |
Aztek AV5 data types |
|
Interface ID |
NMS_V5_INTERFACE_ID_T |
V5_INTERFACE_ID_T |
|
E1 link ID |
N/A |
V5_LE_LINK_ID_T |
|
E1 location |
NMS_V5_E1_LOCATION_T E1 trunk location on the CG board. |
V5_E1_T (AV5 local ID) |
|
Communication path (C-path) for Control, Link Control, PSTN, BCC, and Protection protocols |
N/A |
V5_C_PATH_T |
|
Communication channel (C-channel) to carry a group of one or more C-paths |
N/A |
V5_LOGICAL_C_CHANNEL_T |
|
Number of logical C-channels |
num_channels function parameter when provisioning a variant. |
V5_PROVISION_DATA_T (numLogCchan parameter) |
|
Protection group number |
N/A |
V5_PROTECTION_GRP_NUM_T |
|
Protection group standby channels |
N/A |
V5_PROTECT_STNDBY_T |
|
|
NMS_V5_CHANNEL_LOCATION_T HDLC channel location with respect to the hardware. |
V5_PHYSICAL_C_CHANNEL_T for each standby |
|
Provisioned variant |
Capable of provisioning and destroying a standby variant. |
V5_VARIANT_ID_T |
|
PSTN or ISDN port on AN side |
N/A |
V5_AN_PORT_T |
|
BCC protocol: Bearer-channel timeslot on E1 |
NMS_V5_E1_LOCATION_T and hardware-mapped logical timeslot number. |
V5_E1_T and V5_TIME_SLOT_T |
|
C-channels send/receive data |
NMS_V5_CHANNEL_LOCATION_T HDLC channel location with respect to the hardware. |
V5_E1_T and V5_C_CHANNEL_T |
|
BCC protocol: Bearer-channel port location on AN side |
Hardware-mapped logical timeslot number on an E1 trunk on an CG board. |
V5_AN_PORT_T |
To configure the NMS V5 library software to work with CG boards, applications must define a pair of data types to reference common location information for boards, trunks, and HDLC channels.
The NMS_V5_INTERFACE_ID_T data type specifies the ID associated with a particular lower level interface.
The NMS_V5_E1_LOCATION_T data type provides information about the specific location of E1 links. Applications use the following structure to specify the location of particular E1 trunks on a CG board:
struct {
DWORD boardNb;
DWORD trunkNb;
} CG;
where the data type specifies the following information:
|
Parameters |
Description |
|
boardNb |
Logical board number of the board where the E1 link resides. |
|
trunkNb |
Logical trunk number associated with the E1 link. |
The NMS_V5_CHANNEL_LOCATION_T data type provides information about the specific locations of HDLC channels. Applications use the following structure to specify the location of particular HDLC channels on a CG board:
struct {
DWORD boardNb;
DWORD trunkNb;
DWORD timeslotNb;
} CG;
where the data type specifies the following information:
|
Parameters |
Description |
|
boardNb |
Logical board number of the associated board. |
|
trunkNb |
Logical trunk number on which the HDLC channel is located. |
|
timeslotNb |
Physical timeslot number to associate with the HDLC channel. Specify timeslots 15, 16, and 31 as needed in accordance with the V5 protocol. |
You can use Aztek AV5 library and NMS V5 library software to develop applications on the AN side of the V5.2 protocol. However, before you can run the application, connect the AN side of the system to the local exchange (LE) end of the V5.2 protocol through an E1 cable. After you connect the E1 cable to the CG board, boot the CG board, and start the LE side of the system. Follow these steps to verify that the E1 links are synchronized:
|
Step |
Action |
|
1 |
Set up appropriate CT bus clocking for the system. In a single board system with E1 network connectivity, configure the board clocks to slave to a network interface. In a typical multiple-board system, configure one board to derive its clocking from the network and act as the clock master for the other boards on the system. Configure the remaining boards to slave to the CT bus clock for inter-board synchronization. Refer to the NMS OAM System User's Manual or the appropriate board installation manual for more information about setting up CT bus clocking. |
|
2 |
Boot the board and observe the trunk LEDs on the board's front panel. The LEDs remain briefly in an alarm condition after the board is booted, until frame synchronization is acquired. When the trunks leave the alarm state and are synchronized, the green LED remains lit for each trunk. |
|
3 |
Run the trunkmon utility with the -b (board number) argument to monitor alarms and gather performance statistics for the E1 trunks. When all trunks are synchronized, trunkmon displays the alarm status for the board as NONE. |
|
4 |
If the trunks connected to the external E1 link stay in an alarm state, connect a cross-over cable between any two trunks of the CG board. If the LEDs show that the trunks are in frame synchronization, this indicates that there is a problem with the E1 link rather than the board. |
For more information about CG board LEDs, the trunkmon utility, and using cross-over cables with CG boards, refer to the CG board documentation.
Use the nmsv5tool and aimv5 programs to test the integration.
To use the nmsv5tool demonstration program:
|
Step |
Action |
|
1 |
Compile the program as an executable from the DLCP software source code. |
|
2 |
Start nmsv5tool. |
|
3 |
Start the aimv5 utility (the AIM V5 task must be running). |
|
4 |
Enter commands as needed from the nmsv5tool or aimv5 command line. |
For more information about using nmsv5tool, refer to Using the demonstration programs.
To use the aimv5 utility:
|
Step |
Action |
|
1 |
Compile the program as an executable from the source code provided with the AV5 software. |
|
2 |
Initialize the AV5 software (by running nmsv5tool) and make sure that the AV5 library AIM task is listening on the appropriate socket for the AIM messages. |
|
3 |
Start aimv5 by entering the following at the command line: aimv5 <hostname> where hostname is the name of the machine running the AN application. The aimv5 program reports when the connection is established and displays a menu of available commands. |
|
4 |
Enter commands as needed. |
For more information about using aimv5, refer to the Aztek documentation.
After you start the nmsv5tool and aimv5 programs, you can enter commands at the command line of either utility to perform operations on V5.2 interfaces. These programs allow you to perform a variety of tasks, such as executing API functions, toggling task tracing, verifying the integration status, and displaying status information.
After completing the basic tasks to integrate and verify the AV5 and NMS V5 libraries, you can build an enhanced application by modifying the nmsv5tool source code to provide additional functionality or by creating a new application using functions from the NMS V5 library.
You can use the NMS Switching service to connect ports associated with a V5.2 interface to specific CT bus timeslots. Depending on the AN system requirements, you can also use other NMS software and hardware to provide access to PSTN or IP networks, or to provide digital loop carrier (DLC), hybrid fiber coax (HFC), or wireless local loop (WLL) support.
For more information about the association between Aztek AV5 library functions and NMS V5 library functions when performing typical tasks, refer to Developing AN applications.