NMS GR303 and V5 Library Developer's Reference Manual
P/N 9000-62083-11
Version
Version
Table of Contents
1 Digital to Loop Carrier Protocols
- 1.1 Digital Loop Carrier Protocol Support
- 1.1.1 Overview of DLCP
- 1.1.2 Platform Support for DLCP: Components
- 1.2 Access303 and Exchange303 GR-303 Support
- 1.3 Access AV5 V5.2 Protocol Support
- 1.4 Developing IDT, RDT, and AN Applications
- 1.4.1 Building Access303, Exchange303, or AV5 Libraries
- 1.4.2 Using the AIM Utilities
- 1.4.3 Using nms303tool and nmsv5tool
- 1.5 Frequently Used Acronyms
2 Platform Support for DLCP Environment
- 2.1 NMS Hardware and Software
- 2.1.1 CG Hardware
- 2.2 Natural Access Software
- 2.2.1 Natural Access Development Environment
- 2.2.2 NMS OAM
- NMS OAM Configuration Files
- 2.2.3 Runtime Software
- 2.2.4 Trunk Control Programs
- 2.2.5 Platform Support for DLCP System Overview
- 2.3 Aztek Protocol Stacks
- 2.3.1 Access303 and Exchange303 Protocol Software
- 2.3.2 AV5 Protocol Software
3 Configuring the System
- 3.1 Configuring and Verifying the CG System
- 3.1.1 Customizing the OAM Configuration Files
- 3.1.2 Modifying Sample System Configuration Files
- 3.1.3 Modifying Sample CG Board Keywords Files
- 3.1.4 Configuring T1 or E1 Line Interfaces
- 3.1.5 CG Board HDLC Instances
- 3.1.6 Sample HDLC Configurations
- GR-303 (T1) Configuration
- V5.2 (E1) Configuration
4 Integrating the System
- 4.1 Integrating Platform Support for DLCP with Aztek Protocol Stacks
- 4.2 Integrating NMS GR303 and Aztek Protocol Software
- 4.2.1 Specifying T1 Link and HDLC Channel Locations
- 4.2.2 Verifying T1 Connections
- 4.2.3 Using nms303tool
- 4.2.4 Using the aim303 Utility
- 4.2.5 Testing the Integration
- 4.2.6 Building a Complete GR-303 Application
- 4.3 Integrating NMS V5 and Aztek AV5
- 4.3.1 Specifying E1 Link and HDLC Channel Locations
- 4.3.2 Verifying E1 Connections
- 4.3.3 Using nmsv5tool
- 4.3.4 Using the aimv5 Utility
- 4.3.5 Testing the Integration
- 4.3.6 Building a Complete AN Application
5 NMS GR303 Programming Model
- 5.1 Developing GR-303 Applications
- 5.2 NMS GR303 Library Overview
- 5.3 Using the NMS GR303 Library
- 5.3.1 Initializing the NMS GR303 Library
- 5.3.2 Provisioning an NMS GR303 Interface
- 5.3.3 Starting and Monitoring an NMS GR303 Interface
- 5.3.4 Modifying an NMS GR303 Interface
- 5.3.5 Reprovisioning an NMS GR303 Interface
- 5.3.6 Sending and Receiving HDLC Channel Data
- 5.3.7 Retrieving Channel and Link Status Information
- 5.3.8 Stopping an NMS GR303 Interface
- 5.3.9 Destroying an NMS GR303 Interface
- 5.3.10 Exiting the NMS GR303 Library
- 5.3.11 NMS GR303 Library State Diagram
- 5.4 Access303, Exchange303, and NMS GR303 Functions
- 5.4.1 Initializing an Interface
- 5.4.2 Stopping and Restarting Without Reprovisioning
- 5.4.3 Stopping, Reprovisioning, and Starting
- 5.4.4 Modifying Standby Locations
6 NMS V5 Programming Model
- 6.1 Developing AN Applications
- 6.2 NMS V5 Library Overview
- 6.3 Using the NMS V5 Library
- 6.3.1 Initializing the NMS V5 Library
- 6.3.2 Provisioning an Interface
- 6.3.3 Starting an NMS V5 Interface
- 6.3.4 Adding and Deleting E1 Links with NMS V5 Library Functions
- 6.3.5 Provisioning, Switching to, and Destroying a Standby Variant
- 6.3.6 Sending and Receiving HDLC Channel Data
- 6.3.7 Monitoring E1 Link Status Information
- 6.3.8 Controlling SA7 Bit Values on E1 Links
- 6.3.9 Retrieving HDLC Channel and E1 Link Status Information
- 6.3.10 Reprovisioning an Existing Interface
- 6.3.11 Stopping an Interface
- 6.3.12 Destroying an Interface
- 6.3.13 Exiting the NMS V5 Library
- 6.3.14 NMS V5 Library State Diagram
- 6.4 Aztek AV5 and NMS V5 Library Functions
- 6.4.1 Initializing an Interface
- 6.4.2 Stopping and Restarting Without Reprovisioning
- 6.4.3 Stopping, Reprovisioning, and Starting
- 6.4.4 Checking Link IDs
- 6.4.5 Access Network Initiated Switchover to a Variant
- 6.4.6 Local Exchange Initiated Switchover to a Variant
7 Function Summary
- 7.1 Introduction
- 7.2 NMS GR303 Library Function Summary
- 7.2.1 Initializing and Exiting the NMS GR303 Library
- 7.2.2 Creating, Modifying, and Destroying Interfaces
- 7.2.3 Controlling Interfaces
- 7.2.4 Retrieving and Resetting DS1 Link and Channel Information
- 7.3 NMS V5 Library Function Summary
- 7.3.1 Initializing and Exiting the NMS V5 Library
- 7.3.2 Creating and Destroying Interfaces
- 7.3.3 Controlling Interfaces
- 7.3.4 Retrieving and Resetting E1 Link and Channel Information
8 Function Reference
- 8.1 Using the Function Reference
- NMS_GR303DestroyInterface
- NMS_GR303Exit
- NMS_GR303GetChannelStatistics
- NMS_GR303GetDS1Status
- NMS_GR303Initialize
- NMS_GR303ModifyChannelLocation
- NMS_GR303PhSendData
- NMS_GR303ProvisionInterface
- NMS_GR303ResetChannelStatistics
- NMS_GR303ResetDS1Status
- NMS_GR303SetTrace
- NMS_GR303StartInterface
- NMS_GR303StopInterface
- NMS_V5AddE1
- NMS_V5DeleteE1
- NMS_V5DestroyInterface
- NMS_V5DestroyStandByVariant
- NMS_V5Exit
- NMS_V5GetChannelStatistics
- NMS_V5GetE1Status
- NMS_V5Initialize
- NMS_V5PhSendData
- NMS_V5ProvisionInterface
- NMS_V5ProvisionStandByVariant
- NMS_V5ResetChannelStatistics
- NMS_V5ResetE1Status
- NMS_V5SendSA7Bit
- NMS_V5SetTrace
- NMS_V5StartInterface
- NMS_V5StopInterface
- NMS_V5SwitchOverVariantData
9 Demonstration Programs
- 9.1 Using the Demonstration Programs
- 9.1.1 nms303tool and nmsv5tool
- 9.1.2 Building Program Executables
- Example 1: Building nms303tool as a Standalone Program
- Example 2: Building nmsv5tool as an Integrated Program
- 9.1.3 Running nms303tool in Standalone Mode
- Example: nms303tool in Standalone Mode
- 9.1.4 Running nms303tool in Integrated Mode
- Example: nms303tool in Integrated Mode
- 9.1.5 Running nmsv5tool in Standalone mode
- Example: nmsv5tool in Standalone Mode
- 9.1.6 Running nmsv5tool in Integrated Mode
- Example: nmsv5tool in Integrated Mode
Appendix A Errors and Events
- Introduction
- NMS GR303 Library Errors
- Alphabetical Error Summary
- Numerical Error Summary
- NMS GR303 Library Channel Callback Events
- Alphabetical Channel Callback Event Summary
- Numerical Channel Callback Event Summary
- NMS V5 Library Errors
- Alphabetical Error Summary
- Numerical Error Summary
- NMS V5 Library Channel Callback Events
- Alphabetical Channel Callback Event Summary
- Numerical Channel Callback Event Summary
Appendix B Data Types
- Introduction
- NMS GR303 Library Structures
- NMS_GR303_BOARD_FAMILY_T
- NMS_GR303_DS1_LOCATION_T
- NMS_GR303_CHANNEL_LOCATION_T
- NMS_GR303_DS1_STATUS_T
- NMS_GR303_CHANNEL_STATISTICS_T
- NMS V5 Library Data Types
- NMS_V5_BOARD_FAMILY_T
- NMS_V5_E1_LOCATION_T
- NMS_V5_CHANNEL_LOCATION_T
- NMS_V5_E1_STATUS_T
- NMS_V5_CHANNEL_STATISTICS_T
Appendix C T1 and E1 Trunk Channels
- Introduction
- Channels and Transmission Rates
- Signaling
- Channel Associated Signaling (CAS)
- Common Channel Signaling (CCS)
- Framing
- T1 Framing
- E1 Framing
- Voice Encoding
- Companding
- AMI, Ones Density, and Zero Code Suppression
Version
Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2001, NMS Communications Corporation. All rights
reserved.