PIKA HMP 2.8 Getting Started Guide

Transcription

1 PIKA HMP 2.8 Getting Started Guide Copyright (c) All rights reserved.

2

3 PIKA HMP 2.8 Getting Started Guide Table of Contents 1 Copyright Information 1 2 Contacting PIKA Technologies 2 3 Introduction How to Use the Documentation PDF Documentation HTML Documentation Related Documents Installation Checklist 8 4 Software Installation Windows Linux Open Source Drivers Installation Instructions 12 Console Installation 13 GUI Installation 14 5 Licensing Registration Key Generation Activation Key Generation No Web Access Activation Key Generation Activation Key Generation With Web Access 27 Single Activate Key Generation 27 Multiple Activation Key Generation Installing Activation Keys 32 iii

4 PIKA HMP 2.8 Getting Started Guide 5.4 Multi-system Activation 34 6 Hardware Installation Installing the Board Connecting Digital Line Cables Connecting Analog Trunk/Phone Cables 37 7 Board Testing Testing Digital Gateway Boards Testing PIKA Analog Trunk FXO PCIe Boards Testing PIKA Analog Station FXS PCIe Boards Testing Media Processing Showing Version Information 44 8 Software Removal Windows Linux 47 Index a iv

5 1 PIKA HMP 2.8 Getting Started Guide 1 Copyright Information 1 COPYRIGHTS Copyright 2010 PIKA Technologies Inc. TRADEMARKS PIKA is a registered trademark of PIKA Technologies Inc. All other trademarks, product names and company names and/or logos cited herein, if any, are the property of their respective holders. DISCLAIMER This document is provided to you for informational purposes only and is believed to be accurate as of the date of its publication, and is subject to change without notice. PIKA Technologies Inc. assumes no responsibility for any errors or omissions in this document and shall have no obligation to you as a result of having made this document available to you or based upon the information it contains. 1

6 PIKA HMP 2.8 Getting Started Guide 2 2 Contacting PIKA Technologies Customer Care 2 For support issues, phone or our Customer Care department at the following: Tel: FAX: [email protected] International Headquarters PIKA Technologies Inc. 535 Legget Drive, Suite 400 Ottawa, Ontario, Canada K2K 3B8 Tel: FAX: [email protected] Internet Visit our website at for the latest news, product announcements, downloads, online community, documentation updates, and contact information. 2

7 3 PIKA HMP 2.8 Getting Started Guide 3 Introduction Thank you for choosing PIKA Technologies! The HMP technology incorporates a powerful VoIP interface that allows applications to make and answer SIP/RTP calls, as well as play and record messages. Applications include tone and DTMF detection/generation, low-latency switching, and conference summing. Analog and Digital boards provide T1/E1 and PSTN network connectivity. 3 The PIKA AllOnHost (AoH) SDK is made up of the following components: Application Program Interface - The AoH API provides the communication mechanism between the user application and the AoH API implementation layer. The AoH API is implemented as a set of C function interfaces linked in when the user application is built. API Implementation Layer - The AoH API implementation layer converts the user application requests, expressed through API functions, into commands for AoH drivers. This layer also translates the significant events reported by the drivers into the format defined by the AoH API and passes them to the user applications. The SIP and ISDN signaling stacks are also implemented in this layer. The AoH API and the API Implementation Layer make up the library linked with the user application. Drivers - AoH incorporates two types of drivers: device drivers to interface with hardware devices, and a virtual driver to perform time-critical voice processing functions. The drivers are installed on the target platform and start whenever the platform starts. Network Interface Devices - AoH interacts with the IP, analog and TDM networks through network interface devices. AoH supports three types: PIKA Digital T1/E1 boards that interface with digital TDM networks, PIKA Analog Station/FXS and Trunk/FXO boards that interface with analog telephone networks, and standard NICs available on PCs for communication with the IP networks. If connectivity to TDM or analog networks is not required, the PIKA boards are not required. Note: the AoH API can only support one user application on each deployment platform. All voice processing functions are performed on the host platform. DSP hardware is not required to perform these functions. 3

8 PIKA HMP 2.8 Getting Started Guide 3.1 How to Use the Documentation Purpose This guide provides a step-by-step procedure for installing and configuring both hardware and software for the PIKA AllOnHost (AoH) SDK and drivers. The following sections provide important points to remember and an installation checklist to ensure each step is followed correctly. License Agreement 3 The PIKA MonteCarlo Software License Agreement constitutes a legal agreement ("License Agreement") between you and PIKA Technologies Inc. ("PIKA") and covers software, media, and accompanying on-line or printed documentation distributed by PIKA. The full version of the agreement appears as you install the software. Approvals Information It is important to note that only PIKA boards are approved for use in a specific country, not the host system. Some countries require additional approvals compliance for the PIKA board application software and host system hardware. For more information, refer to the hardware manual for the PIKA boards used. Potential Hazards Electro-Static Discharge Hazard PIKA cards can be damaged by static electricity (also known as electro-static discharge or ESD). Throughout this guide, warning symbols are displayed for steps that require ESD protection. Please use an anti-static wrist strap (not included) to reduce exposure to ESD. Computer Damage Hazard The computer should always be switched off when inserting any type of board into the system or connecting an external power supply to a board installed in the computer. If the computer is not switched off, other components in the system could be damaged. 3.1 How to Use the Documentation This guide is distributed in two forms, as a PDF document and a set of HTML files. Both forms of the guide provide extensive methods to navigate through the information contained in this and other AoH SDK documentation. The installer (Windows only) places the documents in the following directory structure: 4

9 3.1 How to Use the Documentation PIKA HMP 2.8 Getting Started Guide HTML Documentation This structure is required to allow this document to link successfully to other AoH SDK documents. The most up-to-date documentation is available on the If the documentation is downloaded from the web, the above structure must be maintained for the inter-document links to work properly. PDF documents should be downloaded into the same directory PDF Documentation The guide is displayed by Adobe Reader. All the Adobe Reader features are available. In addition, the guide contains internal and external links. The internal links change the location within this guide. Internal links are identified by the page number. External links change the displayed document to a different PIKA AoH document. External links are displayed as green text. Some diagrams in the guide contain links to related topics. Links in the diagrams are identified by underlined text. The cursor also changes from an open hand to a pointing hand. For example, in the following diagram,,,, and are links. is not a link. Tips To display the original document and the externally linked document simultaneously, right click on the link and select the Open Link in New Window command. 5

10 HTML Documentation PIKA HMP 2.8 Getting Started Guide 3.1 How to Use the Documentation HTML Documentation The HTML documentation has been tested using the following browsers: Internet Explorer 7.0 Firefox 2.0 Firefox Safari and Opera may have issues with displaying the "Contents" frame. Clicking the "Contents" link in the header may cause the "Contents" frame to appear. The guide appears in your default browser. Two frames are displayed. The frame on the left is used for navigation and displays either the index or the table of contents. The frame on the right displays the guide contents. The links ( ) at the top of both frames allow the contents of the navigation window to be changed between the index and the table of contents. The link displays the document welcome screen in the right window. The information in the right window is divided up into sections. Except for the top section, sections can be collapsed and expanded using the and buttons to the left of the section name. 6

11 3.1 How to Use the Documentation PIKA HMP 2.8 Getting Started Guide HTML Documentation Code examples have a button,, above and to the right of the example code. Click on the Copy Code button to copy the text from the code example into the copy buffer. This allows you to easily make a copy of the sample code for pasting into an editor. The buttons in the top right corner ( ) and bottom of the right screen allow you to page through the guide. The button displays the previous page of the guide. The button displays the next page of the guide. The button displays the information of the section in the table of contents immediately above the current section. A series of links at the bottom of the right frame maps the current page location in the table of contents hierarchy. It is labeled guide.. Click on any of the displayed links to display that page of the 3 A button ( ) in the bottom left corner of the right frame provides a convenient method of sending feedback on this guide to PIKA's Technical Documentation department. Click this button to open an message with the address, subject, guide name and section title already entered. Links placed throughout this documentation change the guide page being displayed in the right frame. Links in the text of the page are underlined and colored blue. For example:. Some diagrams in the documentation contain links to related topics. Links in the diagrams are identified by underlined text. For example, in the following diagram,,,, and are links. is not a link. The page displayed by clicking on a link may be a page from this guide or an associated guide, such as the PIKA AllOnHost API Reference guide. Displaying a page from another guide does not change the navigation information in the left panel. To display the navigation information for the new guide, click on the button at the top of the right panel. 7

12 PIKA HMP 2.8 Getting Started Guide 3.3 Installation Checklist Tips In some browsers, when the guide is launched, the navigation frame may not appear or the scroll bar in the right window may not be displayed. This is caused by browser pop-up blocking. Disable pop-up blocking when using this guide. 3.2 Related Documents Please refer to the following documents for further information on the hardware and software components of the PIKA AllOnHost SDK. 3 Software PIKA AoH Release Notes PIKA AoH API Reference PIKA AoH Programmer s Guide Hardware PIKA Hardware Manual T1/E1 PCI Board PIKA Hardware Manual T1/E1 PCIe Board PIKA Hardware Manual Analog Trunk/FXO Board PIKA Hardware Manual Analog Station/FXS Board 3.3 Installation Checklist The following checklist is provided to ensure all steps are followed when first installing any hardware and software. Check off each step as it is performed. For more detailed installation instructions, please refer to the chapter listing in the table of contents. Verify list of items required for installation PIKA Software CD or AoH SDK download PIKA board(s) Anti-static wrist strap (not included) Screwdriver (not included) Remove any older versions of the PIKA AoH SDK and driver software Install PIKA AoH SDK and driver software 8

13 3.3 Installation Checklist PIKA HMP 2.8 Getting Started Guide Turn off the PC Attach an anti-static wrist strap and properly ground it Open the computer case Locate an existing empty slot and insert the PIKA board(s) Use the screwdriver and a screw to secure the PIKA board(s) in the slot Replace the computer case Connect the digital and or analog lines Turn on the PC Test the board using AoH Test 3 9

14 PIKA HMP 2.8 Getting Started Guide 4.1 Windows 4 Software Installation The following topics demonstrate how to install the PIKA AoH SDK and drivers on Windows and Linux systems. Installation instructions are listed for users who have the PIKA AoH SDK CD and users who have downloaded the SDK from the PIKA SDK Download web page. Please check the PIKA website for information about downloading the latest release. Note: End users of third-party application software should follow the installation instructions included with their provided software package. Software developers wishing to include the AoH driver and other setup components in their applications, please refer to Distributing Applications in the PIKA AoH Programmer's Guide. 4.1 Windows 4 1. Login using an administrator account. Uninstall any previously installed versions of the PIKA AoH SDK. Refer to Software Removal (pg. 46) for instructions on uninstalling the software. 2. Obtain a copy of the AoH setup file. There are two methods for obtaining the software: from the PIKA Software CD or as a download from our website. PIKA Software CD Insert the PIKA Software CD into the CD ROM drive. The CD Browser should start automatically and provide a method to launch the AoH SDK setup. If the CD Browser doesn't automatically start, open Windows Explorer and select the CD ROM drive. PIKA Website Download the AoH setup file from the website. Save the file in a convenient location on the hard drive. 3. Install the software: click on the setup file on the CD or on the hard drive. The setup program starts and brings up the installation window. 4. Click the Next button. Read the end user license agreement before continuing to the next step. 5. Click the Yes button to accept the terms of the License Agreement. To change the destination directory, click the Folder Browse button and locate the desired directory. 6. Click the Next button. 7. Click the Next button. The setup program begins copying files to the hard drive. To stop the file copy process, click the Cancel button. 8. When the file copy process is complete, the Setup Complete dialog box appears. To view the readme file, ensure the View Readme File check box is selected. 9. Click the Finish button to complete the setup. A prompt to reboot the computer appears. 10

15 4.2 Linux PIKA HMP 2.8 Getting Started Guide Open Source Drivers Note: The computer must be rebooted to finish installing the drivers. 4.2 Linux The following topics describe information about: Linux Open Source Drivers (pg. 11) Linux Installation Instructions (pg. 12) Open Source Drivers The board drivers included in the PIKA AoH SDK package are open source. The installation directory (typically /usr/share/pika/aoh) includes the 'redist' subdirectory which contains the driver source code as well as relinkable libraries and applications. The drivers are built during the installation process. If any of the following requirements are not met, the installer will exit and display a message indicating the problem. Kernel source for the currently running kernel If the kernel source is not installed, install the source for the kernel that is currently running. If the kernel source is installed but cannot be located by the installer, create a symbolic link called /usr/src/linux which points to the directory where the kernel source is located. 4 Note: If the kernel on the system is upgraded, the drivers must be rebuilt. From the 'redist' subdirectory in the installation directory, run 'make install'. A multi-processor (SMP) 2.6 kernel. UNI kernels are not supported. Note that uni-processor systems can use an SMP kernel. An x86 32-bit system architecture SELinux must be set to "disabled" This setting can be changed in /etc/selinux/config. Boardless systems As part of the driver installation, the pikahsp executable script is installed to /etc/init.d/pikahsp. This script starts a service to restart the HSP device driver in boardless systems. This service must be included in the list of services to start when the system boots. If your Linux distribution does not support chkconfig, update-rc.d or rc-update, use the appropriate system command to add this service to the list of services to start at boot time. Troubleshooting: The installer directs the output from building the drivers to the file /tmp/pika_post_install_log.txt and 11

16 Installation Instructions PIKA HMP 2.8 Getting Started Guide 4.2 Linux /tmp/pika_post_install_errors.txt. If there are any errors during the driver installation, the installer will indicate that there is an error and advise you to check the log files. Once the error is corrected, the drivers must be recompiled. From the 'redist' subdirectory in the installation directory, run 'make install' Installation Instructions 1. Login using the root account. Uninstall any previously installed versions of the PIKA AoH SDK. Refer to Software Removal (pg. 46) for instructions on uninstalling the software. 2. Obtain a copy of the AoH setup file. There are two methods for obtaining the software: from the PIKA Software CD or as a download from our website. PIKA Software CD Insert the PIKA Software CD into the CD ROM drive. If the cdrom drive is not mounted, open a console window and type the command listed in bold. [root@localhost root]# mount /mnt/cdrom 4 PIKA Website Download the AoH setup file from the website. Save the file in a convenient location. Based on the Linux distribution in use, select the appropriate version of the installer. Red Hat Enterprise 4/CentOS4: pikaaoh rh4linux-installer. Any other Linux distribution (including newer versions of Red Hat Enterprise/CentOS): pikaaoh linux-installer. 1. Open a console window and change to the directory that contains the setup file by typing one of the following commands. The following command assumes the CDROM has already been mounted. [root@localhost linux]# cd /mnt/cdrom/setup The following command assumes the setup file has been downloaded and saved in the home directory of the root user account. [root@localhost root]# cd /root 2. Install the software by typing the command listed in bold below. If the setup file cannot be executed, use the chmod command to add execute permissions to the file. Red Hat Enterprise 4/CentOS 4: [root@localhost linux]#./pikaaoh rh4linux-installer All other Linux distributions: [root@localhost linux]#./pikaaoh linux-installer 12

17 4.2 Linux PIKA HMP 2.8 Getting Started Guide Installation Instructions Console Installation When the installation procedure requires a yes or no answer to a prompt, the valid responses are provided in square brackets (for example: [y/n]). The default response, if present, is shown as a capital letter in the prompt (for example: a prompt of [Y/n] indicates that yes is the default response). To install the AoH SDK using the console: 1. The License Agreement appears when the installation of AoH starts. Press the space bar to read the License Agreement one page at a time Welcome to the PIKA HMP Low Level SDK Setup Wizard Please read the following License Agreement. You must accept the terms of this agreement before continuing with the installation. PIKA Software License Agreement (Revised January 20, 2009) 4 IMPORTANT - READ CAREFULLY This PIKA Software License Agreement constitutes a legal agreement ("License Agreement") between you and PIKA Technologies Inc. and its wholly owned subsidiary, PIKA Technologies Europe BV. ("PIKA") for the Software Products identified below. This License Agreement covers the following software, media, and accompanying on-line or printed documentation ("Documentation") distributed by PIKA: Press [Enter] to continue :... Do you accept this license? [y/n]: 2. Enter Y to accept the license agreement; entering N terminates the installation procedure. The installation process prompts you for the location to install AoH. The default directory is: /usr/share/pika/aoh Please specify the directory where PIKA AllOnHost SDK will be installed. Installation Directory [/usr/share/pika/aoh]: 3. Press Enter to accept the default directory, or specify a different directory and press Enter. 13

18 Installation Instructions PIKA HMP 2.8 Getting Started Guide 4.2 Linux A prompt appears asking if you want to continue Setup is now ready to begin installing PIKA AoH SDK on your computer. Do you want to continue? [Y/n]: 4. Enter Y to continue the installation; entering N abandons the installation without changing anything on the platform. The installation copies the files from the installation package to the installation directory. Progress of the installation is shown by # characters appearing under a 0% to 100% scale. Before completing the installation, post-install steps are executed. Press Enter to complete the installation Please wait while Setup installs PIKA AllOnHost SDK on your computer. Installing 0% 50% 100% ########################################Info: 4 Please press enter to finalize the installation. Note that this may take several minutes. Press [Enter] to continue : When the installation is complete, you are asked if you wish to read the Readme file Setup has finished installing PIKA AllOnHost SDK on your computer. View Readme file? [Y/n]: 5. Select Y or press Enter to display the Readme file; entering N skips the Readme file. 6. If the distribution supports the RPM package format, enter "rpm -q pikaaoh" to verify the installation. $ rpm -q pikaaoh pikaaoh Note: For distributions that support RPM package format, the setup registers with the RPM database for file auditing purposes only. Full RPM install and uninstall functionality is not supported. To uninstall the software, please refer to Software Removal (pg. 47) GUI Installation At any point in the installation process, you can click on the Cancel button to abandon the installation process. 14

19 4.2 Linux PIKA HMP 2.8 Getting Started Guide Installation Instructions 1. Click on the setup file. The Welcome dialog appears. 2. Click Next or Forward to continue. The License Agreement dialog appears. 3. Read the license and select the Yes button to accept the agreement. Click Next or Forward to continue. The Installation Directory dialog appears. 4. Select an installation directory or accept the default. Click Next or Forward to continue. The Ready To Install dialog appears. 5. Click Next or Forward to install the software. The Install Progress dialog appears. 6. To cancel installation, click the Cancel button. Otherwise, wait for the installation to continue. The Info dialog to finalize the installation appears. 7. Click OK to continue. The Setup Complete dialog appears. 8. To view the readme file, select the View Readme File check box. Click Finish to complete the setup and display the readme file. 4 15

20 PIKA HMP 2.8 Getting Started Guide 5 5 Licensing In AoH, user applications require a license for each active media stream. The licenses are divided into the following categories: License Type Previously Named in Release 2.1 Description Usage Supported Features FAX N/A (New) Specifies the number of simultaneous channels allowed to run FAX on a single system. A license is seized on the fly when fax is started (i.e. when PKH_FAX_Send() or PKH_FAX_Receive() is called). PIKA provides four free FAX licenses if there is a PIKA board installed in the system. V.34 FAX N/A (New in 2.6.0) Specifies the number of simultaneous channels of V.34 allowed to run FAX on a single system. A license is seized on the fly when fax is started (i.e. when PKH_FAX_Send() or PKH_FAX_Receive() is called). 5 G.729 G.729 Specifies the number of simultaneous channels running G.729 enabled on a single system. A license is seized on the fly when RTP is started and configured to use G.729 (i.e. when PKH_RTP_StartTx() or PKH_RTP_StartRx() are called). When both Rx and Tx are started on the same channel, the first function acquires the license and shares it with the other one. Switching, conferencing, play, record, DTMF detection, tone detection, energy detection, speech detection, tone generation, echo cancellation, GFSK, and MFR2. VOIP VOIP Specifies the number of RTP channels that can be created on a single system. A license is allocated when an RTP resource is created (i.e. when PKH_RTP_Create() is called). A VoIP license gets shared between the input and output media stream, so only one license is required for a full-duplex channel. Switching, conferencing, play, record, DTMF detection, tone detection, energy detection, speech detection, tone generation, echo cancellation, GFSK, and MFR2. 16

21 5 PIKA HMP 2.8 Getting Started Guide T1/E1 (M) TDM Specifies the number of digital T1/E1 channels that can be enabled on single system. The M means full media processing is enabled. A license is allocated when a B-Channel or analog channel gets created (i.e. when PKH_SPAN_SeizeChannel is called). A T1/E1 (M) license gets shared between the input and output media stream, so only one license is required for a full-duplex channel. Switching, conferencing, play, record, DTMF detection, tone detection, energy detection, speech detection, tone generation, echo cancellation, GFSK, and MFR2. T1/E1 N/A (New) This provides licensing for a limited subset of media processing functions. Specifies the number of digital T1/E1 channels that can be enabled on a single system for use with the Asterisk channel driver. Only media streaming functions required for Asterisk are enabled. A license is allocated when a B-Channel or analog channel gets created (i.e. when PKH_SPAN_SeizeChannel is called). A T1/E1 license gets shared between the input and output media stream, so only one license is required for a full-duplex channel. Switching, play, record, DTMF detection, echo cancellation, MFR2, and the use of timers. TRUNK (M) ANALOG Specifies the number of analog trunk channels that can be enabled on a single system. The M means full media processing is enabled. A license is allocated when an analog trunk channel gets created (i.e. when PKH_TRUNK_Seize() is called). A Trunk (M) license gets shared between the input and output media stream, so only one license is required for a full-duplex channel. Switching, conferencing, play, record, DTMF detection, tone detection, energy detection, speech detection, tone generation, echo cancellation, GFSK, and MFR2. 5 TRUNK N/A (New) This provides licensing for a limited subset of media processing functions. Specifies the number of analog trunk channels that can be enabled on a single system for use with the Asterisk channel driver. Only media streaming functions required for Asterisk are enabled. A license is allocated when an analog trunk channel gets created (i.e. when PKH_TRUNK_Seize() is called). A Trunk license gets shared between the input and output media stream, so only one license is required for a full-duplex channel. Switching, play, record, DTMF detection, echo cancellation, MFR2, and the use of timers. 17

22 PIKA HMP 2.8 Getting Started Guide 5 STATION (M) N/A (New) Specifies the number of analog station channels that can be enabled on a single system. The M means full media processing is enabled. A license is allocated when an analog phone channel gets created (i.e. when PKH_PHONE_Seize() is called). A Station (M) license gets shared between the input and output media stream, so only one license is required for a full-duplex channel. Switching, conferencing, play, record, DTMF detection, tone detection, energy detection, speech detection, tone generation, echo cancellation, GFSK, and MFR2. STATION N/A (New) Specifies the number of analog station channels that can be enabled on a single system for use with the Asterisk channel driver. Only media streaming functions required for Asterisk are enabled. A license is allocated when an analog phone channel gets created (i.e. when PKH_PHONE_Seize() is called). A Station license gets shared between the input and output media stream, so only one license is required for a full-duplex channel. Switching, play, record, DTMF detection, echo cancellation, MFR2, and the use of timers. 5 TRIAL Trial Enabled unlimited use of all licensed features for the specified number of days from the time of activation. Switching, conferencing, play, record, DTMF detection, tone detection, energy detection, speech detection, tone generation, echo cancellation, GFSK, and MFR2. Note: All active channels MUST be licensed. There is a dependency between G.729 licenses and VOIP licenses. By default, a VOIP license includes the use of a G.711 codec. The use of the G.729 codec is licensed separately, but requires a corresponding VOIP license for use. For example, purchasing ten G.729 licenses but no VOIP licenses, does not permit VoIP calls, regardless of which codec type is used. There is a dependency between Fax and V.34 Fax licenses. Regular Fax licenses do not include the use of V.34 modem types. The use of the V.34 Fax modem type is licensed separately, but requires a corresponding Fax license for use. For example, purchasing ten V.34 Fax licenses but no Fax licences, does not permit Fax processing, regardless of the modem type used. NOTE: If the application requests a V.34 Fax license and none is available, a lower Fax modem speed will be attempted if there are regular Fax licenses available. A registration key controls a pool of licenses for a specific feature. When initially purchased, a registration key controls an original quantity of licenses. As licenses are activated out of the pool, the number of licenses available from the registration key decreases by 18

23 5 PIKA HMP 2.8 Getting Started Guide the number of licenses activated. An activation key controls a number of licenses for a specific feature on a specific platform. It is generated by combining the registration key for that feature, a unique system identifier for the platform and the quantity of licenses. Since the system identifier is unique to each platform, licenses generated for one platform can not be used on any other platform. Note: The system identifier is tied to a NIC on the platform. If the NIC is removed, the user application is no longer able to acquire licenses and will not function properly. There are separate license registration keys and license activation keys for each feature. When licenses are unavailable at run-time, an AoH function that uses a media stream requiring a license returns a PKH_ERROR_LICENSE_VIOLATION status. Refer to Application License Management in the PIKA AllOnHost Programmer's Guide for more information. The generation and activation of AoH licenses requires three steps: 1. The developer orders a pool of licenses from PIKA Technologies for the features used by the application. 2. When the developer is ready to deploy the application at a customer site, the appropriate number of licenses for each feature are activated for the deployment platform from the pool of licenses controlled by the registration key(s). The number of activated licenses and a platform identifier are encoded into an activation key. 3. The activation keys are transferred to the deployment platform. At runtime, the activation keys are read by the License Manager Module linked into the user application. Steps 2 and 3 can be combined if the deployment platform has internet access. 5 The following diagram shows the process followed to generate activation codes. Each step is described in further detail in the following topics. 19

24 PIKA HMP 2.8 Getting Started Guide 5 PIKA Technologies provides the License Manager utility in the PKH_BASE_DIR/bin (Windows) or /usr/bin (Linux) directory to enable users to easily activate licenses. This utility calculates a unique system identifier for each platform, based in part on the MAC address of the NIC on the platform. The License Manager sends the unique system identifier, the registration key for a feature, and the quantity of the licenses to activate for the feature, via the internet, to a PIKA server. The PIKA server generates the activation key and sends it back to the License Manager utility. 5 Launching the License Manager Windows From the start menu: 1. Click on Start 2. Click on All Programs 3. Click on PIKA AllOnHost SDK Click on License Manager From the icon: 1. Open the C:\Program Files\PIKA\AoH\bin folder. 2. Double click on the License Manager icon. Linux 20

25 5 PIKA HMP 2.8 Getting Started Guide Enter the following command from any directory: 1. pikalm Note: The Windows License Manager launch instructions assume the default installation directory is used. Tips The License Manager generates a log file in the PKH_BASE_DIR/bin/pikalm-tmp (Windows) or /usr/bin/pikalm-tmp (Linux) directory. This log file may be required by PIKA Customer Support to resolve License Manager problems. The NICs installed on a platform can be displayed using the License Manager utility. 1. Launch the License Manager. 2. Select option [2] : Show network interface cards. The License Manager displays the network interfaces. The following is an example of the output: > Your input: 2 Interface [1] IP Address: { } MAC Address: {00-0C-6E-91-F0-E6} Description: {3Com Gigabit LOM (3C940) - Packet Scheduler Miniport} Interface [2] IP Address: { } MAC Address: {00-08-C7-8A-6C-61} Description: {Compaq NC3121 Fast Ethernet NIC - Packet Scheduler Minip} On a system with multiple NICs, the first time in a session the License Manager is instructed to generate a license, the License Manager prompts you to select the NIC to be used. The following is an example of the NIC selection prompt: Please choose one of the following: or [q]=quit, [m]=main menu [1] : Show activated licenses [2] : Show network interface cards [3] : Show license server connection status [4] : Single registration key activation [5] : Multiple registration key activation - (file-based) 5 > Your input: 4 Interface [1] IP Address: { } MAC Address: {00-0C-6E-91-F0-E6} Description: {3Com Gigabit LOM (3C940) - Packet Scheduler Miniport} Interface [2] IP Address: { } MAC Address: {00-08-C7-8A-6C-61} Description: {Compaq NC3121 Fast Ethernet NIC - Packet Scheduler Minip} Please choose an interface. Range [1-2]. > Your input: 2 21

26 PIKA HMP 2.8 Getting Started Guide 5.1 Registration Key Generation Please choose one of the following: or [q]=quit, [m]=main menu [1] : Automatic activation - (requires internet access) [2] : Manual activation > Your input: 5.1 Registration Key Generation This topic describes the information provided by PIKA Technologies when pools of licenses are purchased. PIKA's customer receives a registration key that controls the generation of licenses. 5 When PIKA Technologies receives a purchase order for feature registration keys, PIKA Technologies generates a 39-character registration key for each feature. The registration keys are ed to an address associated with the registration key. A file, licensekeys.txt, containing the registration key information is attached to the . The following shows an example of the information contained in a registration key This confirms delivery of registration keys for order #xxxx. Time of key generation: Oct , 9:52 am. The following are your new registration keys: ################################################################### [AAAA-AAAA-AAAA-AAAA-AAAA-AAAA-AAAA-AAAA] (250 channels of G.729) [BBBB-BBBB-BBBB-BBBB-BBBB-BBBB-BBBB-BBBB] (500 channels of VoIP) [CCCC-CCCC-CCCC-CCCC-CCCC-CCCC-CCCC-CCCC] (600 channels of T1/E1) [DDDD-DDDD-DDDD-DDDD-DDDD-DDDD-DDDD-DDDD] (450 channels of Trunk) ################################################################### Note: Please refer to PikaLM utility's reference manual to activate and install the above registration key(s). The following is an example of the corresponding licensekeys.txt file sent with the 22

27 5.2 Activation Key Generation PIKA HMP 2.8 Getting Started Guide # Registration keys generated on Oct , 9:52 am. [AAAA-AAAA-AAAA-AAAA-AAAA-AAAA-AAAA-AAAA] # 250 channels of G.729 [BBBB-BBBB-BBBB-BBBB-BBBB-BBBB-BBBB-BBBB] # 500 channels of VoIP [CCCC-CCCC-CCCC-CCCC-CCCC-CCCC-CCCC-CCCC] # 600 channels of T1/E1 [DDDD-DDDD-DDDD-DDDD-DDDD-DDDD-DDDD-DDDD] # 450 channels of Trunk Where: xxxx is your customer number AAAA represent characters in the G.729 registration key BBBB represent characters in the VoIP registration key CCCC represent characters in the E1/T1 registration key DDDD represent characters in the trunk registration key The registration keys are required to generate activation keys. 5.2 Activation Key Generation This topic describes the methods available to generate the activation keys required for the deployment platform. 5 The generation of 59-character activation keys requires three pieces of information: a registration key for the feature. the system identifier for the deployment platform. If the activation key is being generated from a deployment platform connected to the internet, the system identifier is calculated and sent to the Activation Key Generator by the License Manager utility without user intervention. the quantity of licenses to activate from the pool controlled by the registration key. The method used to generate an activation key for a deployment platform depends on whether the deployment platform is connected to the internet and the number of activation keys being generated. When the deployment platform has internet access, run the License Manager utility on the deployment platform to generate and install the activation keys. If the deployment platform 23

28 No Web Access Activation Key Generation PIKA HMP 2.8 Getting Started Guide 5.2 Activation Key Generation does not have internet access use the PIKA Technologies license activation web site to create the activation key. The License Manager utility is run on the deployment platform to generate the unique system required by the web page. The activation key is then transferred to the deployment platform manually No Web Access Activation Key Generation When the deployment platform does not have internet access, the activation keys must be generated on a platform that does have internet access and transferred manually to the deployment platform. To generate an activation key using the PIKA Technologies license key activation web site, you first need to determine the System Identifier for the target platform. To determine the system identifier on a platform: 1. Launch the License Manager utility. 2. Select option [4] : Single registration key activation from the main menu. 3. Select option [2] : Manual activation from the displayed menu. 4. Enter a registration key at the prompt Please enter a registration key. 5. Enter a quantity at the prompt Please enter a quantity. [all]=remaining. The system identifier is displayed in square brackets after SystemId: 5 The following is an example of determining the host identifier for a deployment platform. User input is shown in bold. Please choose one of the following: or [q]=quit, [m]=main menu [1] : Show activated licenses [2] : Show network interface cards [3] : Show license server connection status [4] : Single registration key activation [5] : Multiple registration key activation - (file-based) > Your input: 4 Please choose one of the following: or [q]=quit, [m]=main menu [1] : Automatic activation - (requires internet access) [2] : Manual activation > Your input: 2 Please enter a registration key. 24

29 5.2 Activation Key Generation PIKA HMP 2.8 Getting Started Guide No Web Access Activation Key Generation > Your input: AAAA-AAAA-AAAA-AAAA-AAAA-AAAA-AAAA-AAAA Please enter a quantity. [all]=remaining. > Your input: 5 Manual activation: Please connect to using a web browser on a computer with an internet access and fill in the required information using the following: Registration Key: [AAAA-AAAA-AAAA-AAAA-AAAA-AAAA-AAAA-AAAA] Quantity: [5] SystemId: [ ] An activation key will be generated for your registration key. The activation key is needed to continue. Please enter an activation key. 6. Access the PIKA Technologies license key activation web site The following page appears Enter: the registration key for the feature you want to activate. the number of licenses to activate. The default is all remaining licenses. The number entered must be equal to or less than the number of licenses still available in the pool of licenses controlled by the registration key. Entering blank or the string all activates all the remaining licenses associated with the registration key. the deployment platform system ID. Do not check the Check if MAC address format box. The following diagram shows the web page with the information filled in. 25

30 No Web Access Activation Key Generation PIKA HMP 2.8 Getting Started Guide 5.2 Activation Key Generation 8. Click on the Activate License button. The following information is displayed: registration key original and remaining quantities and license types for the feature controlled by the registration key number of licenses associated with the activation key system identifier activation key PIKA License Activation - Results The following confirmation has been sent to [email protected] Confirmation of activation: Oct , 3:40 pm. Registration key: [AAAA-AAAA-AAAA-AAAA-AAAA-AAAA-AAAA-AAAA] Original quantity: 1250 channels of G.729 Remaining quantity: 1243 Activated quantity during this session: 5 (activated for System ID = C7-8A-6C-61) Activation code is: [YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY] The same information is mailed to the owner of the registration key along with a file called licensekeys.txt which contains the activation key. 5 The following is an example of the received by the owner of the registration key. Confirmation of activation: Oct , 3:40 pm. Registration key: [AAAA-AAAA-AAAA-AAAA-AAAA-AAAA-AAAA-AAAA] Original quantity: 1250 channels of G.729 Remaining quantity: 1243 Activated quantity during this session: 5 (activated for System ID = C7-8A-6C-61) Activation code is: [YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY] The following is an example of the contents of the licensekeys.txt file sent with the . # Activation code generated on Oct , 3:40 pm. [YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY] #<5> channels of G.729; for ID: < > 9. The activation key must be manually transferred to the deployment platform and placed in the license.keys file in the 26

31 5.2 Activation Key Generation PIKA HMP 2.8 Getting Started Guide Activation Key Generation With Web Access PKH_BASE_DIR/conf directory in Windows or the /etc/pika directory in Linux Activation Key Generation With Web Access When the deployment platform has Internet access, activation key generation is much simpler as the License Manager utility automatically determines the system identifier and installs the activation key in the proper file and directory, adding the new activation keys to any existing activation keys on the platform. There are two methods that can be used: Single activation key generation (pg. 27) - to generate the activation keys one at a time Multiple activation key generation (pg. 29) - to generate multiple activation keys for a specific platform Single Activate Key Generation Perform the following steps to generate a single activation key: 1. Launch the License Manager utility. 2. Select option [4] : Single registration key activation from the main menu. 3. Select option [1] : Automatic activation - (requires internet access). 4. Enter a registration key at the prompt Please enter a registration key Enter a quantity at the prompt Please enter a quantity. [all]=remaining. Note: the default value is all remaining licenses available for the specified registration code. The License Manager utility responds with the string *** Done! *** and writes the activation key into the license.keys file in the PKH_BASE_DIR/conf directory (Windows) or the /etc/pika directory (Linux) on the deployment platform. The following is an example of generating a single activation key on a deployment platform. User input is shown in bold. Please choose one of the following: or [q]=quit, [m]=main menu [1] : Show activated licenses [2] : Show network interface cards [3] : Show license server connection status [4] : Single registration key activation [5] : Multiple registration key activation - (file-based) > Your input: 4 Please choose one of the following: or [q]=quit, [m]=main menu 27

32 Activation Key Generation With Web Access PIKA HMP 2.8 Getting Started Guide 5.2 Activation Key Generation [1] : Automatic activation - (requires internet access) [2] : Manual activation > Your input: 1 Please enter a registration key. > Your input: XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX Please enter a quantity. [all]=remaining. > Your input: 13 *** Done! *** Please enter a registration key. > Your input: An containing the registration key, original and remaining quantities and type of licenses for the feature controlled by the registration key, the number of licenses associated with the activation key, the system identifier, and the activation code is mailed to the owner of the registration key. A file called licensekeys.txt which contains the activation key is included in the . The following is an example of the received by the owner of the registration key. Confirmation of activation: Oct , 10:09 am. 5 Registration key: [XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX] Original quantity: 123 channels of analog Remaining quantity: 100 Activated quantity during this session: 13 (activated for System ID = C7-8A-6C-61) Activation code is: [YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY] The following is an example of the contents of the licensekeys.txt file sent with the . # Activation code generated on Oct , 10:09 am. [YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY] #<13> channels of analog; for ID: < > 6. Enter: another registration key to continue the generation of activation keys for this platform. m to return to the main menu. 28

33 5.2 Activation Key Generation PIKA HMP 2.8 Getting Started Guide Activation Key Generation With Web Access q to exit the License Manager Multiple Activation Key Generation The generation of activation keys for multiple features on a deployment platform takes three steps: entering the quantity of licenses required for each feature. generating the activation keys. installing the activation keys. The generation of activation keys for multiple features, requires licensekeys.txt file provided in the containing the registration keys to be in the PKH_BASE_DIR/bin (Windows) or /usr/bin (Linux) directory. The directory PKH_BASE_DIR/bin/pikalm-tmp is used to store temporary files used in the generation of activation keys for multiple features. To generate activation keys for multiple features: 1. Launch the License Manager utility. 2. Select option [5] : Multiple registration key activation - (file-based). 3. Select option [1] : Enter resource quantity. 4. Enter quantities for each of the features for which activation keys are to be generated. Entering s or zero means no activation key is generated for that specified feature. When quantities have been entered for all available features, the License Manager displays Selected quantities are ready for activation. and returns to the main menu. 5. Select option [5] : Multiple registration key activation - (file-based). 6. Select option [2] : Activate resources - (requires internet access). 5 The License Manager displays Activation in progress Complete! and returns to the main menu. An for each feature activated containing the registration key, original and remaining quantities and type of licenses for the feature controlled by the registration key, the number of licenses associated with the activation key, the system identifier, and the activation code is mailed to the owner of the registration key along. A file called licensekeys.txt which contains the activation key is included in each Select option [5] : Multiple registration key activation - (file-based). 8. Select option [3] : Install activation keys. The License Manager displays Installation in progress Complete!, returns to the main menu and copies the activation keys into the license.keys file in the PKH_BASE_DIR/conf directory (Windows) or the /etc/pika directory (Linux). The following is an example of generating activation keys for multiple features on a deployment platform. User input is shown in bold. Welcome to pikalm activation utility. 29

34 Activation Key Generation With Web Access PIKA HMP 2.8 Getting Started Guide 5.2 Activation Key Generation Attempting to connect to license server (Connected) Please choose one of the following: or [q]=quit, [m]=main menu [1] : Show activated licenses [2] : Show network interface cards [3] : Show license server connection status [4] : Single registration key activation [5] : Multiple registration key activation - (file-based) > Your input: 5 Please choose one of the following: or [q]=quit, [m]=main menu [1] : Enter resource quantity [2] : Activate resources - (requires internet access) [3] : Install activation keys > Your input: 1 Please choose the desired quantities for the following resources Resource [G.729] Original quantity [1250] Please enter a quantity. [all]=remaining, [s]=skip. 5 > Your input: Resource [VOIP] Original quantity [2123] Please enter a quantity. [all]=remaining, [s]=skip. > Your input: Resource [TDM] Original quantity [6000] Please enter a quantity. [all]=remaining, [s]=skip. > Your input: Resource [ANALOG] Original quantity [123] Please enter a quantity. [all]=remaining, [s]=skip. > Your input: 10 Selected quantities are ready for activation. Please choose one of the following: or [q]=quit, [m]=main menu 30

35 5.2 Activation Key Generation PIKA HMP 2.8 Getting Started Guide Activation Key Generation With Web Access [1] : Show activated licenses [2] : Show network interface cards [3] : Show license server connection status [4] : Single registration key activation [5] : Multiple registration key activation - (file-based) > Your input: 5 Please choose one of the following: or [q]=quit, [m]=main menu [1] : Enter resource quantity [2] : Activate resources - (requires internet access) [3] : Install activation keys > Your input: 2 Activation in progress Complete! Please choose one of the following: or [q]=quit, [m]=main menu [1] : Show activated licenses [2] : Show network interface cards [3] : Show license server connection status [4] : Single registration key activation [5] : Multiple registration key activation - (file-based) > Your input: 5 5 Please choose one of the following: or [q]=quit, [m]=main menu [1] : Enter resource quantity [2] : Activate resources - (requires internet access) [3] : Install activation keys > Your input: 3 Installation in progress Complete! Please choose one of the following: or [q]=quit, [m]=main menu [1] : Show activated licenses [2] : Show network interface cards [3] : Show license server connection status [4] : Single registration key activation [5] : Multiple registration key activation - (file-based) > Your input: 31

36 PIKA HMP 2.8 Getting Started Guide 5.3 Installing Activation Keys The following is an example of one of the s received by the owner of the registration key. Confirmation of activation: Oct , 10:59 am. Registration key: [XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX] Original quantity: 2123 channels of VoIP Remaining quantity: 2107 Activated quantity during this session: 16 (activated for System ID = C7-8A-6C-61) Activation code is: [YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY] The following is an example of the contents of the licensekeys.txt file sent with the . # Activation code generated on Oct , 10:59 am. [YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY-YYYY] #<16> channels of VoIP; for ID: < > 5.3 Installing Activation Keys 5 Once the activation key is generated, it must be inserted into the license.keys file in the PKH_BASE_DIR\conf directory (Windows) or the /etc/pika directory (Linux) of the deployment platform. When the activation key is generated on the deployment platform by the License Manager utility while the deployment platform is connected to the internet, the activation keys are automatically inserted into the license.keys file. When the deployment platform is not connected to the internet, the activation keys must be manually inserted into the license key file using a text editor. 32

37 5.3 Installing Activation Keys PIKA HMP 2.8 Getting Started Guide Activation keys are 59-character strings made up of capital letters and dashes - and have the form XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX. They must be enclosed in square brackets []. Only one activation key is allowed per line. All other characters on the line are ignored. To determine the quantity of licenses for each feature available on a platform: 1. Launch the License Manager utility Select option [1] : Show activated licenses. The License Manager displays the quantity of licenses for each feature available on the platform. The following is an example of the output of this option. Please choose one of the following: or [q]=quit, [m]=main menu [1] : Show activated licenses [2] : Show network interface cards [3] : Show license server connection status [4] : Single registration key activation [5] : Multiple registration key activation - (file-based) > Your input: 1 [ 1000 ] - G.729 [ 1000 ] - VOIP [ 500 ] - T1/E1 (M) [ 500 ] - TRUNK (M) [ 1500 ] - FAX [ 500 ] - STATION (M) 33

38 PIKA HMP 2.8 Getting Started Guide 5.4 Multi-system Activation Tips The License Manager only reads the license.key file when it starts up or when it inserts an activation key. When you manually update the license.keys file, the License Manager must be stopped and restarted to provide accurate information. 5.4 Multi-system Activation To activate multiple registration keys on a system without Internet access: 1. Ensure you have a valid licensekeys.txt file that contains your registration keys. 2. Place licensekeys.txt and the PikaLM utility on a portable media storage (such as a floppy disk or USB media disk). 3. Run the License Manager utility on the deployment platform and choose option Enter a quantity for each of the resources found in the licensekeys.txt file. 5. Enter the desired quantity, all to select the remaining quantity of a resource, or s or 0 to skip a resource. 6. Move the portable media storage to a computer with Internet access. 7. Run the License Manager utility. 8. Choose option 5-2 to activate the selected resources Once activation is completed, move the portable media storage back to the deployment platform. 10. Choose option 5-3 to install the activation keys. When installing licenses on multiple systems without Internet access: 1. Move the portable media storage to each deployment platform and run the License Manager utility choosing option Take the portable media storage to a computer with Internet access and run the License Manager utility choosing option 5-2 to activate all selected resource quantities for all of the deployment platforms. 3. Take the portable media storage back to each deployment platform and run option 5-3 to install the activated keys on each system. 34

39 6.1 Installing the Board PIKA HMP 2.8 Getting Started Guide 6 Hardware Installation The following topics describe how to install PIKA hardware in a computer system, including physically inserting boards in a system and connecting cables. Warning! PIKA boards and other PC hardware can be damaged by electro-static discharge (ESD). Please use an anti-static wrist strap to ground yourself properly before handling or installing any PIKA boards. Required Tools & Components Tools Screwdriver (for PC case) Anti-static wrist strap Components Network cables with RJ-45 connectors (optional) Network cables with RJ-21 connector (optional) 6.1 Installing the Board To install the PIKA Digital T1/E1 PCI, PIKA Digital T1/E1 PCIe, PIKA Analog Trunk FXO PCIe 16L, or PIKA Analog Station FXS PCIe board in a PC: 1. Ensure the PIKA AoH SDK and drivers have been previously installed on the PC. This reduces the number of times needed to reboot the PC. Refer to Software Installation (pg. 10) for details. Note: PIKA boards are not Plug and Play. Software drivers must be installed for the operating system to properly detect the board and for applications to be able to use the board Connect the ESD wrist strap. 3. Shut off the PC and disconnect the power cord. 4. Remove the cover from the PC. 5. Remove the backplate from an empty PCI/PCIe slot (keep the screw for later). 6. If installing a PIKA Digital T1/E1 PCIe board and digital logging is to be enabled on spans associated with the board, ensure the appropriate jumpers have been removed. See the figure in the PIKA Digital T1/E1 PCIe Board hardware overview in the PIKA AoH Programmer's Guide for the jumper locations. 7. If installing a PIKA Analog Station FXS with an expansion module, first install the expansion module on the board. Refer to Module Installation in the PIKA Analog FXS Expansion Module Hardware Guide for instructions. 35

40 PIKA HMP 2.8 Getting Started Guide 6.2 Connecting Digital Line Cables 8. Firmly press the card into the empty slot. The card should fit easily do not force it into the slot. 9. Use the screw removed from the backplate to anchor the board to the PC chassis. 10. Repeat steps 5 through 7 to install any additional boards. 11. Replace the cover on the PC. 12. Reconnect the power cord and switch on the PC. 13. The hardware installation process is almost complete. Proceed to Connecting Digital Line Cables (pg. 36) and/or Connecting Analog Trunk/Phone Cables (pg. 37) to connect the board(s) to digital phone equipment. Note: Proper system cooling, which varies based on system design, is required to maintain an acceptable operating temperature. A general rule of thumb is that boards should not feel uncomfortably warm to the touch. 6.2 Connecting Digital Line Cables Each PIKA Digital T1/E1 PCI and PIKA Digital T1/E1 PCIe board has four T1/E1 digital line interface jacks. The following diagram shows the T1/E1 digital line interface jacks on a board. 6 The digital line interface cables are terminated with an industry-standard RJ-48C connector. Each connector provides access to a single T1/E1 digital line interface. The following diagram shows the pinouts of the RJ-48C digital line interface jack. 36

41 6.3 Connecting Analog Trunk/Phone Cables PIKA HMP 2.8 Getting Started Guide 6.3 Connecting Analog Trunk/Phone Cables The PIKA Analog Trunk FXO PCIe board provides connectivity to each of the analog trunk interfaces through a single 50-pin RJ-21 Telco connector (also known as an Amphenol or Centronics connector) on the back of the board. This connector is capable of connecting up to 24 analog trunks to the board. Currently only the first 16 loop start line interfaces are functional. The PIKA Analog Station FXS PCIe board provides connectivity to each of the station interfaces through a single 50-pin RJ-21 Telco connector (also known as an Amphenol or Centronics connector) on the back of the board. This connector is capable of connecting up to 20 station interfaces. Without an expansion module, only the first 12 phone interfaces are functional. If an expansion module is used, an addition 8 phone interfaces (20 total) are functional. The following diagram shows the 50-pin female RJ-21 connector on the back of the board. 6 To connect the board to station lines (PIKA Analog Trunk FXO PCIe board) or phones (PIKA Analog Station FXS PCIe board), a 50-wire cable with appropriate connectors must be used. There are two main types of cables: unterminated and with a breakout box. Unterminated Cables The following table lists the pinouts of the RJ-21 connector. This table is only required if connections are being made using a cable with a male RJ-21 connector on one end and unterminated wires on the other end (such as for use with a punch-down block). 37

42 PIKA HMP 2.8 Getting Started Guide 6.3 Connecting Analog Trunk/Phone Cables 6 Pin # Signal Name Wire Colors (solid/stripe) Pin # Signal Name Wire Colors (solid/stripe) Associated Line Interface 16L Associated Line Interface 12P 1 TIP 0 white / blue 26 RING 0 blue / white Loop Start Trunk 0 Station 0 2 TIP 1 white / orange 27 RING 1 orange / white Loop Start Trunk 1 Station 1 3 TIP 2 white / green 28 RING 2 green / white Loop Start Trunk 2 Station 2 4 TIP 3 white / brown 29 RING 3 brown / white Loop Start Trunk 3 Station 3 5 TIP 4 white / gray 30 RING 4 gray / white Loop Start Trunk 4 Station 4 6 TIP 5 red / blue 31 RING 5 blue / red Loop Start Trunk 5 Station 5 7 TIP 6 red/ orange 32 RING 6 orange / red Loop Start Trunk 6 Station 6 8 TIP 7 red / green 33 RING 7 green / red Loop Start Trunk 7 Station 7 9 TIP 8 red / brown 34 RING 8 brown / red Loop Start Trunk 8 Station 8 10 TIP 9 red / gray 35 RING 9 gray / red Loop Start Trunk 9 Station 9 11 TIP 10 black / blue 36 RING 10 blue / black Loop Start Trunk 0 Station TIP 11 black / orange 37 RING 11 orange / black Loop Start Trunk 11 Station TIP 12 black / green 38 RING 12 green / black Loop Start Trunk 12 Expansion 14 TIP 13 black / brown 39 RING 13 brown / black Loop Start Trunk 13 Expansion 15 TIP 14 black / gray 40 RING 14 gray / black Loop Start Trunk 14 Expansion 16 TIP 15 yellow / blue 41 RING 15 blue / yellow Loop Start Trunk 15 Expansion 17 TIP 16 yellow / orange 42 RING 16 orange / yellow Loop Start Trunk 16 (expansion) 18 TIP 17 yellow / green 43 RING 17 green / yellow Loop Start Trunk 17 (expansion) 19 TIP 18 yellow / brown 44 RING 18 brown / yellow Loop Start Trunk 18 (expansion) 20 TIP 19 yellow / gray 45 RING 19 gray / yellow Loop Start Trunk 19 (expansion) 21 TIP 20 violet / blue 46 RING 20 blue / violet Loop Start Trunk 20 (expansion) 22 TIP 21 violet / orange 47 RING 21 orange / violet Loop Start Trunk 21 (expansion) 23 TIP 22 violet / green 48 RING 22 green / violet Loop Start Trunk 22 (expansion) 24 TIP 23 violet / brown 49 RING 23 brown / violet Loop Start Trunk 23 (expansion) Expansion Expansion Expansion Expansion Unused Unused Unused Unused 38

43 6.3 Connecting Analog Trunk/Phone Cables PIKA HMP 2.8 Getting Started Guide 25 S-GND violet / gray 50 S-BAT gray / violet Note: white/blue means the cable is solid white with a blue stripe. blue/white means the cable is solid blue with a white stripe. LS means loop start line. Cables With a Breakout Box The following diagram shows how to connect a cable with a male RJ-21 connector on one end and a 12-jack breakout box on the other end. The following table lists the pinouts and wire color on each jack of the breakout box. Breakout Box Port Line Number Jack Pin Phone Line Color Code Associated Line Interface Associated Line Interface 24L (12P) 24L (16L) 1 1 2, 3 Green, Red LS0 Station 0 2 1, 4 Yellow, Black LS1 Station , 3 Green, Red LS2 Station , 4 2, 3 Yellow, Black Green, Red LS3 LS4 Station 3 Station , 4 Yellow, Black LS5 Station , 3 Green, Red LS6 Station 6 8 1, 4 Yellow, Black LS7 Station , 3 Green, Red LS8 Station , 4 Yellow, Black LS9 Station , 3 Green, Red LS10 Station , 4 Yellow, Black LS11 Station , 3 Green, Red LS12 Expansion 14 1, 4 Yellow, Black LS13 Expansion 39

44 PIKA HMP 2.8 Getting Started Guide 6.3 Connecting Analog Trunk/Phone Cables , 3 1, 4 Green, Red Yellow, Black LS14 LS15 Expansion Expansion , 3 1, 4 Green, Red Yellow, Black LS16 (Exp) LS17 (Exp) Expansion Expansion , 3 1, 4 Green, Red Yellow, Black LS18 (Exp) LS19 (Exp) Expansion Expansion , 3 1, 4 Green, Red Yellow, Black LS20 (Exp) LS21 (Exp) Unused Unused , 3 1, 4 Green, Red Yellow, Black LS22 (Exp) LS23 (Exp) Unused Unused Note: LS means loop start line. 6 40

45 7 PIKA HMP 2.8 Getting Started Guide 7 Board Testing Once the boards have been properly installed in the system and properly configured by PIKA Setup, a basic test should be performed on the boards using AoH Test. Starting AoH Test Windows 2K/2K3/XP: Select the AoH Test icon in the PIKA AoH Program group. Linux: Open a console window and type the following command. The application can be found in the system path and is launched from the /usr/bin folder. [root@localhost root]#./aohtest The program displays a banner showing the copyright notice and compile date. AoH Help To obtain a detailed listing of all available commands in AoH Test, enter the help command. To obtain a detailed listing of a specific group of commands in AoH Test, enter the help <section name> command. Listing Installed Boards To list the boards installed on the platform, enter the following commands: > system 0 open > system 0 get boards These commands list the board ID, type (Digital Gateway PCI, Digital Gateway PCIe, Analog Gateway PCIe 16L, and Analog Gateway PCIe 12P), FPGA version, and serial number. The board ID is used for subsequent AoH Test board commands. The following output shows an example of the system get boards command. 7 SYSTEM 0: Board listing <4 boards> BOARD 0, Analog Gateway PCIe 12P [FPGA-2032] [PIK ] BOARD 1, Analog Gateway PCIe 16L [FPGA-2032] [PIK ] BOARD 2, PrimeNet Gateway PCIe [FPGA-1011] [PIK ] BOARD 3, PrimeNet Gateway PCI [FPGA-002f] [PIK ] 41

46 PIKA HMP 2.8 Getting Started Guide 7.2 Testing PIKA Analog Trunk FXO PCIe Exiting AoH To exit AoH Test, enter the exit command. 7.1 Testing Digital Gateway Boards To ensure the PIKA AoH SDK interface is communicating with a PIKA Digital T1/E1 PCI or PIKA Digital T1/E1 PCIe board, enter the following AoH Test commands to open and start the spans on the board: board 0 open span 0-3 open span 0-3 start Note: The board number for the Digital Gateway PCI or PCIe on your platform may be different from the one shown in the example. For each span, AoH Test should indicate there are no T1 or E1 cables attached to the board by generating a Red Alarm. SPAN 0: received PKH_EVENT_SPAN_ALARM_T1_RED <p0=0x1, p1=0x0, p2=0x0> SPAN 1: received PKH_EVENT_SPAN_ALARM_T1_RED <p0=0x1, p1=0x0, p2=0x0> SPAN 2: received PKH_EVENT_SPAN_ALARM_T1_RED <p0=0x1, p1=0x0, p2=0x0> SPAN 3: received PKH_EVENT_SPAN_ALARM_T1_RED <p0=0x1, p1=0x0, p2=0x0> 7.2 Testing PIKA Analog Trunk FXO PCIe Boards To ensure the PIKA AoH SDK interface is communicating with a PIKA Analog Trunk FXO PCIe board, enter the following AoH Test commands to open and start the trunks on the board: board 2 open trunk 0-15 open trunk 0-15 start trunk 0-15 get info Note: The board number for the PIKA Analog Trunk FXO PCIe board on your platform may be different from the one shown in the example. AoH Test should return the line voltage and current information for each trunk. The following example indicates no trunks have been connected to the interfaces: the current for each trunk is zero and the voltage for each trunk is lass than 2 volts. 7 TRUNK 0: 1V 0mA TRUNK 1: 1V 0mA TRUNK 2: 1V 0mA TRUNK 3: 1V 0mA TRUNK 4: 1V 0mA TRUNK 5: 1V 0mA TRUNK 6: 1V 0mA TRUNK 7: 1V 0mA TRUNK 8: 1V 0mA TRUNK 9: 1V 0mA TRUNK 10: 0V 0mA TRUNK 11: 1V 0mA TRUNK 12: 1V 0mA TRUNK 13: 1V 0mA 42

47 7.4 Testing Media Processing PIKA HMP 2.8 Getting Started Guide TRUNK 14: 1V TRUNK 15: 1V 0mA 0mA 7.3 Testing PIKA Analog Station FXS PCIe Boards To ensure the PIKA AoH SDK interface is communicating with a PIKA Analog Station FXS PCIe board, enter the following AoH Test commands to open and start the phones on the board: board 3 open phone 0-11 open phone 0-11 start phone 0-11 get info Note: The board number for the PIKA Analog Station FXS PCIe board on your platform may be different from the one shown in the example. AoH Test should return the line voltage and current information for each phone. The following example indicates no phones have been connected to the interfaces: the current for each phone is zero (or less than zero) and the voltage for each phone is 48 V or 46.5 V. PHONE 0: 48.00V -0.00mA PHONE 1: 48.00V -0.00mA PHONE 2: 48.00V -1.25mA PHONE 3: 48.00V -0.00mA PHONE 4: 48.00V -1.25mA PHONE 5: 48.00V -0.00mA PHONE 6: 48.00V -0.00mA PHONE 7: 48.00V -0.00mA PHONE 8: 46.50V -0.00mA PHONE 9: 48.00V -0.00mA PHONE 10: 48.00V -0.00mA PHONE 11: 48.00V -0.00mA 7.4 Testing Media Processing To perform a basic test on the virtual board driver. 1. Enter the following commands: virtual 0 create record 0 start A virtual stream, which is useful for conferencing, is created and starts recording audio. Because there is no input into the stream, the recording is blank. It does, however, show the virtual board driver is functioning properly Enter the following command to stop the test: record 0 stop The following example shows the output of the test. 43

48 PIKA HMP 2.8 Getting Started Guide 7.5 Showing Version Information RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> >record 0 stop RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_DATA_READY <p0=0x800, p1=0x0, p2=0x0> RECORD 0: received PKH_EVENT_RECORD_IDLE <p0=0x0, p1=0x0, p2=0x0> 7.5 Showing Version Information To display the PIKA AoH SDK, OS, and driver version information, enter the following commands: system 0 open system 0 get info The following example shows a sample of the output, where x is the build number. 7 SYSTEM 0: Info dump SDK version = x OS version = Windows <Service Pack 2> pikahsp driver version = x pikagpw driver version = x pikaagw driver version = x system 0 open system 0 get boards board 0 open board 0 get info 44

49 7.5 Showing Version Information PIKA HMP 2.8 Getting Started Guide The following example shows information about the analog board: SYSTEM 0: Board listing (1 board) BOARD 0, Analog Gateway PCIe 12P [FPGA-1017] [PIK ] BOARD 0: Bus.Slot = 4.0 Interrupt Level = 17 Serial number = PIK Card id = 0x Real card id = 0x Product revision = 0x Product number = [PIK ] Driver Version = FPGA Version = 2032 Spans = 0 Span Mask = 0x0000 Trunks = 0 Trunk Mask = 0x0000 Phones = 20 Phone Mask = 0xfffff 7 45

50 PIKA HMP 2.8 Getting Started Guide 8.1 Windows 8 Software Removal The following topics demonstrate how to remove the PIKA AoH SDK and drivers from: Windows systems (pg. 46) Linux systems (pg. 47) 8.1 Windows Note: Uinstalling the PIKA AoH SDK deletes everything in the installation directory, including configuration files and licenses. Please back up anything important before uninstalling. 1. Login using an administrator account. 2. Start the Uninstall program. There are two methods for launching the uninstall program: the UnInstall icon in the AoH program group or Add-Remove Programs in the Windows Control Panel. Uninstall ICON Select the UnInstall icon in the PIKA AoH Program group. The Confirm Uninstall dialog box appears. Add-Remove Programs Open the Control Panel. Double-click the Add/Remove Programs icon. The Add-Remove Programs dialog appears. Scroll through the list of available applications and highlight PIKA AoH. Click the Add/Remove button. The Confirm Uninstall dialog box appears. 3. To remove the PIKA AoH SDK from the computer, click the Yes button. The Confirm Remove All Files dialog appears. Uninstall prompts to delete all files in the PIKA installation directory. 8 WARNING! This includes license files that cannot be recreated. Note: If existing licenses, log files, or custom protocol files are to be preserved, they must be backed up before continuing. 4. Click the Yes button to delete all remaining files in the PIKA folder. Click No to cancel deleting the files. The UnInstall Progress dialog appears and the uninstall process begins. When Uninstall is complete, the Uninstallation complete dialog appears. 5. Click OK to finish. 46

51 8.2 Linux PIKA HMP 2.8 Getting Started Guide A dialog appears prompting to reboot. 6. Click Yes to reboot the computer. 8.2 Linux Note: Uinstalling the PIKA AoH SDK deletes everything in the installation directory, including configuration files and licenses. If existing licenses, log files, or custom protocol files are to be preserved, they must be backed up before continuing. WARNING! Although the setup software registers with the RPM package manager, the software cannot be properly uninstalled using RPM. Console Removal 1. Login using the root account. 2. Uninstall the software by typing the following command. This step may take a few moments to complete. [root@localhost root]# /usr/share/pika/aoh/uninstall The uninstall confirms removal of the software. 3. Type y to continue. [root@localhost root]# /usr/share/pika/aoh/uninstall Do you want to uninstall PIKA AoH SDK and all of its modules? [Y/n] : y The uninstall confirms removal of any remaining files, such as logs, configuration files, and license files, from the system. WARNING! This includes license files that cannot be recreated Uninstall Status When uninstalling, some files, such as license and log files, normally remain on the system. Do you want to remove these remaining files? WARNING - Activated licenses that are deleted cannot be reused without contacting PIKA Customer Care. Delete license files ONLY if they are no longer needed. [y/n]: 4. Type n to leave remaining files. Type y to delete all files associated with AoH. When the uninstall is complete, a message appears. Uninstalling PIKA AoH SDK 0% 50% 100% ######################################### 8 Info: Uninstallation completed 47

52 PIKA HMP 2.8 Getting Started Guide 8.2 Linux Press [Enter] to continue : 5. Press Enter to finish. GUI Removal 1. Login using the root account. 2. Uninstall the software by clicking on the uninstall binary in the installation directory (default is /usr/share/pika/aoh). This step may take a few moments to complete. The uninstall confirms removal of the software. 3. Click Yes to continue. The uninstall confirms removal of any remaining files, such as logs, configuration files, and license files, from the system. WARNING! This includes license files that cannot be recreated. 4. Click No to leave remaining files. Click Yes to delete all files associated with AoH. When the uninstall is complete, a message appears. 5. Click OK to finish. 8 48

53 9 PIKA HMP 2.8 Getting Started Guide Index A Activation Key Generation 23 Activation Key Generation With Web Access 27 B Board Testing 41 C Connecting Analog Trunk/Phone Cables 37 Connecting Digital Line Cables 36 Console Installation 13 Contacting PIKA Technologies 2 Copyright Information 1 G GUI Installation 14 H Hardware Installation 35 How to Use the Documentation 4 HTML Documentation 6 I Installation Checklist 8 Installation Instructions 12 Installing Activation Keys 32 Installing the Board 35 Introduction 3 L M Multiple Activation Key Generation 29 Multi-system Activation 34 N No Web Access Activation Key Generation 24 O Open Source Drivers 11 P PDF Documentation 5 R Registration Key Generation 22 Related Documents 8 S Showing Version Information 44 Single Activate Key Generation 27 Software Installation 10 Software Removal 46 T Testing Digital Gateway Boards 42 Testing Media Processing 43 Testing PIKA Analog Station FXS PCIe Boards 43 Testing PIKA Analog Trunk FXO PCIe Boards 42 W Windows 10, 46 Licensing 16 Linux 11, 47 a