Documents
Resources
Learning Center
Upload
Plans & pricing Sign in
Sign Out
Your Federal Quarterly Tax Payments are due April 15th Get Help Now >>

WARP Enterprise GSM

VIEWS: 5 PAGES: 28

									                                        PIKA TECHNOLGIES INC.




         WARP Enterprise GSM
                                 BETA 1 User Guide
                                               Shawn Karow
                                                1/22/2010




This document describes the 1st BETA release of WARP Enterprise with GSM. It includes notes on
installing software the software and using it. Limitations and issues with this release are also described.
Contents
Introduction .................................................................................................................................................. 4
Release Notes ............................................................................................................................................... 5
   Supported Features .................................................................................................................................. 5
   Features Not Supported............................................................................................................................ 5
   Known issues............................................................................................................................................. 6
Installing Software ........................................................................................................................................ 7
Installing GSM Module.................................................................................................................................. 9
Using FreePBX with GSM ............................................................................................................................ 13
   Logging In to FreePBX ............................................................................................................................. 13
   Adding A GSM Trunk ............................................................................................................................... 15
   Adding a GSM DID ................................................................................................................................... 18
   Using Asterisk CLI with GSM ................................................................................................................... 19
   Additional FreePBX Resources ................................................................................................................ 20
GSM Configuration Files.............................................................................................................................. 21
   gsm.conf .................................................................................................................................................. 21
   gsm_additional.conf ............................................................................................................................... 22
GSM CLI Commands .................................................................................................................................... 24
   Channel commands................................................................................................................................. 24
       gsm init port <port> ............................................................................................................................ 24
       gsm shutdown port <port> ................................................................................................................. 24
       gsm restart port <port> ...................................................................................................................... 24
       gsm show status.................................................................................................................................. 24
   SMS Related Commands ......................................................................................................................... 25
       gsm send sms <port> <number> "<smstext>" .................................................................................... 25
       gsm show sms <port> ......................................................................................................................... 25
       gsm fetch sms <port> .......................................................................................................................... 25
   Configuration Commands ....................................................................................................................... 25
       gsm show config values ...................................................................................................................... 25
       gsm show config descriptions ............................................................................................................. 25
       gsm show config description <item> .................................................................................................. 25
   Operator Related Commands ................................................................................................................. 25
       gsm show operators............................................................................................................................ 25
       gsm set op <port> <operator> ............................................................................................................ 25
   Debugging Commands ............................................................................................................................ 26
       gsm set debug <level>......................................................................................................................... 26
       gsm debug info.................................................................................................................................... 26
       gsm show version................................................................................................................................ 26
Compiling from Source ............................................................................................................................... 27
   PADS Source ............................................................................................................................................ 27
   FreePBX Source ....................................................................................................................................... 27
Contacting PIKA Technologies .................................................................................................................... 28
Introduction
This document describes the January 2010 Beta release of GSM code for the PIKA WARP appliance. It
includes details on support of the GSM module in WARP Enterprise.
Release Notes
These release notes apply to the January 2010 BETA release of PADS and WARP Enterprise with GSM
support.

Supported Features
      2 radios per module, using the two main external SIM cards (extra SIM per radio not supported in
       this release)

      2 modules per WARP

       GSM module can be combined with any other exp. module. i.e. FXO, FXS, BRI

       Incoming / Outgoing voice calls

       SMS send

       Incoming caller ID

      Asterisk support only – no PIKA API support

       FreePBX support

           o   Display “CLI command get info” information (see CLI command section below)

           o    PIN number configuration

           o    Preferred operator

           o    SMSC number. Example: +15141234567

       Full text based Asterisk Dialplan supported

Features Not Supported
      LCD display support similar to the other trunk expansion modules. - GA only
      HW variant for 1 or 2 radios using jumper method - GA only

      Multiple SIM per radio, no SIM switching

       PIKA API

       SIM lock

       No data support ( GPRS or 3G )

       Concatenated SMS (CSMS) (http://en.wikipedia.org/wiki/Concatenated_SMS)

       North American approvals
       Call waiting

       Roaming SIMS

      -Support AT command set from Dialplan.

       Query remaining minutes from GUI.

      911 or similar calls.

       As part of our CLI query command, display if active calls were full rate or half rate.

      SIMs are able to store contact information

Known issues
SRK – Update just before release

      7370 - Radio 1 doesn't receive commands anymore
      7361 - chan_gsm CLI commands are inconsistent
      7351 - PADS Asterisk version differs from Freepbx one
      7358 - Messages lost when sending through the same port quickly in a row
      7355 - Second SIM card lost registration
      7354 - PIKA ports and GSM went silent after a while
Installing Software
If you have received your WARP appliance with the WARP Enterprise GSM BETA software installed, you
can skip this section and go to installing your GSM module.

The WARP Enterprise GSM BETA requires updates to the firmware on the appliance. There are also
changes to the way that the NAND is written to on the appliance that mean that this BETA is most safely
written to the appliance using u-boot. This requires the serial cable connection to the WARP and a tftp
server. More details on setting up your tftp server can be found here and on serial access here. If you
are unable to use this method, please contact support@pikatech.com for alternative options.

The steps to install the GSM BETA on you WARP are as follows:

1. Download the software package from here, INSERT BETA IMAGE LINK
2. Extract the software package. Ensure that the following files are in the package:
       a. u-boot-1.3.0-86.wrp CONFIRM NUMBERS
       b. fpga3004.wrp CONFIRM NUMBERS
       c. kernel.wrp
       d. ramdisk.wrp
       e. persistent.wrp
       f. persistent1.wrp
       g. persistent2.wrp
3. Copy the u-boot and fpga file to your WARP currently running the 2.0.X release of software.
4. Set up and connect to WARP using serial access.
5. Log into the command line of the WARP using serial access.
6. Change to directory where you copied u-boot and fpga files and run the following:
       a. #> warploader –p u-boot u-boot.wrp CONFIRM NUMBERS
       b. #> warploader –p fpga fpga.wrp CONFIRM NUMBERS
       c. #> reboot
7. Copy the other 5 files from the software package to your tftp server.
8. After the WARP reboots, you should interrupt the boot process through your serial access. At the
   prompt you need to run the following commands.
       a. setenv serverip xxx.xxx.xxx.xxx Insert IP of your tftp server
       b. setenv ipaddr xxx.xxx.xxx.xxx Insert IP on your network
       c. setenv load_nand_kernel nand read.jffs2 0x02000000 0 0x00200000
       d. saveenv
       e. update kernel kernel.wrp
       f. update ramdisk ramdisk.wrp
       g. update persistent persistent.wrp
       h. update persistent1 persistent1.wrp
       i. update persistent2 persistent2.wrp
       j. setenv serverip deflt (NOTE: do this step if you want to be dhcp again, if you were static
            reset this to your previous value)
       k. setenv ipaddr deflt (NOTE: do this step if you want to be dhcp again, if you were static reset
            this to your previous value)
       l. saveenv
       m. reset
9. Your GSM Beta software is now installed. It will take ~30 minutes to finish the full install. After the
   installation is complete, you can proceed to installing your GSM module.
Installing GSM Module

1. Power off your appliance by removing the power cord.
2. Remove screws from each side of the WARP appliance case near the back. (See arrow on diagram
   below.) Save these screws to put the lid back on later. Lift the lid from the appliance.




3. If there is a piece of plastic blocking the module slot on the back of the appliance, remove it by
   twisting it. Be careful to not put pressure on the top of the hole or you may break the plastic.

4. Remove the screws from the top of the two standoff posts on the baseboard near the back of the
   baseboard where the module will be located. The posts may loosen; ensure you reset them using
   your hand. Use gentle pressure. Save the screws for later to secure your module in place.


5. Take the GSM module and place the end with the red covered connectors through the slot at the
   back of the WARP appliance. You may need to push the module against the back side, where you
   removed the plastic from, of the WARP a little in order for the connector on the module to line up
   with the connector on the baseboard. Be careful where you push on the module so that you do not
   damage any components.
6. Once the connecters line up, push the module down so that the connectors are fully seated
   together. Be careful where you push on the module so that you do not damage any components.




7. Screw the module to the standoff posts on the baseboard through the holes on the module using
   the screws removed in step 3.
8. Repeat steps 2-6 as necessary for any other module (analog FXS, analog FXO, BRI) you wish to put in
   the remaining slot.

9. Place the lid back on the WARP appliance and screw it back into place with the screws from step 1.

10. Remove the red cap from the connector(s) at the back of the GSM module.




11. Screw the antennae connector to the connector on the GSM module. You should ensure that the
    antenna is fully screwed in. The antennae itself should be placed where it will not be obstructed and
    as far away from the WARP as possible. If the warp is installed in a cabinet or rack, ensure you
    mount the antenna outside of the rack.
12. Take the SIM card(s) and place it in the slot at the back of the GSM module that corresponds to
    where you attached your antennae.




Once installation is finished, you can power up your appliance again. Once it is finished booting, you can
begin to configure your WARP GSM trunks using FreePBX as described in next section.
Using FreePBX with GSM

Logging In to FreePBX
To log into the FreePBX GUI, just enter the IP address of the WARP. You can get the IP of your WARP by
lightly pressing the touch sensitive button, shown below (found to the right of the LCD screen), you will
toggle the LCD display between the line status view and the IP address view. Take note of the IP
address, as you will need to enter it into a browser to access configuration information.




After you enter the IP address into your browser, you will be presented with the screen below.
Click on the FreePBX Administration link. You will be presented with a login screen as shown. The default
user is admin and the default password is admin. These can be changed in the GUI later.




After you click OK, you will be logged into the GUI and presented with the main screen as shown. You
can now configure your system.
Adding A GSM Trunk
To add a GSM trunk using FreePBX, first select the Trunks tab on the left of the GUI as shown.




Then from the available trunk types, as shown below, select the GSM trunk option.




The following page will appear. To configure your trunk using the page, you should:
1. Select which GSM channel you want to configure from the drop down box. Each GSM radio/SIM
   card combination in the WARP needs its own configuration in order to be used.
2. In the text box, configure all of the values as appropriate. See here for details on what the values
   mean..
3. Configure other values on the page as needed but they are not required. Note: Inline help is
   available by holding the mouse over the underlined values on the page.
4. Press Submit Button to store your changes.
In order for this trunk to become active, the configuration must be applied. To do this, hit the apply
configuration button at the top of the GUI as shown.




Then when the Apply Configuration Changes box appears, select the Continue and Reload button as
shown to apply your changes.




Your trunk is now ready for use and you can use it in your Dial Plans and FreePBX settings as you would
any other trunk. The trunk settings as applied in this way are written to the
/etc/asterisk/gsm_additional.conf file on the WARP. Please read section on the GSM configuration files
later in this document for more details.
Adding a GSM DID
A DID number can be configured for GSM trunks using the FreePBX GUI. This is useful if you intend to do
call routing based on the GSM trunk that an incoming call arrives on. To add a GSM Channel DID, select
the GSM Channels DID tab on the left hand side of the GUI as shown.




The following page will appear. To add a DID for your GSM trunk, you should already have added a GSM
trunk as previously described above. You should fill in all values shown. In line help is available by
holding the mouse over the underlined values on the page. The channel number should correspond to
the gsm channel you wish to set the DID for. It should be between 1 and 4.
Using Asterisk CLI with GSM
The GSM channel driver has many Asterisk CLI (Command Line Interface) functions available. For a
complete list of these, consult the section on GSM CLI commands later in the document. To gain easy
access to these commands you can use the Asterisk CLI page in FreePBX. To do so, select the Asterisk CLI
tab under Tools on the left hand side of the page as shown.




This will bring up a page as follows.
As an example, you can type help gsm into the box to see what gsm commands are available. Any of
these commands can be run through this page. For further details on the gsm CLI commands, please see
the section on that later in this document.




Additional FreePBX Resources
If you are unfamiliar with the use of FreePBX to configure WARP ENTERPRISE we strongly encourage you
to take advantage of a few short training webinars from PIKA’s technical personnel which can be found
on the PIKA WARP Forum at http://forum.pikawarp.org. These training webinars will introduce you to
the basic concepts necessary to configure the features and functionality of WARP ENTERPRISE using
FreePBX Administration.

       How to update and install FreePBX modules http://pikawarp.org/?p=274
       How to add extensions and trunks http://pikawarp.org/?p=276
       How to add an IVR http://pikawarp.org/?p=344
       How to customize the FreePBX GUI, http://pikawarp.org/?p=269
       Forum on using FreePBX on the PIKA WARP, http://forum.pikawarp.org/forumdisplay.php?f=8


Alternatively, reference material for the FreePBX open source project is available online at

       http://www.freepbx.org/support/documentation
GSM Configuration Files
There are two configuration files for the chan_gsm channel driver in asterisk. They are both found in the
/etc/asterisk folder on the WARP appliance. The files are called gsm.conf and gsm_additional.cong.

gsm.conf
The gsm.conf file contains settings that apply to all GSM channels in the system. The default example of
this file is as shown below.


 [general]

 ;Directory where the sms files are stored.
 smsdir=/var/spool/asterisk/smsin

 ;if you want to periodically check for the homezone
 check_homezone=yes

 ;if you want to skip the '+' prefix, set this to yes
 skip_plus=no

 ;set this to yes to enable debugging via syslog
 syslogdebug=no

 ;set this to yes to enable radio/gsm optimzed dtmf detection mechanism
 relaxdtmf=yes

 ;all port configuration should go to gsm_additional.conf
 ;which has a sample configuration that is commented out

 #include gsm_additional.conf




The last line in the file includes the other file, gsm_additional.conf., see details on it below. The available
parameters in this file and their meanings are as follows. All options here are grouped under
the [general] section.

       smsdir - The smsdir option defines the directory where the sms files are stored. Valid values: any
        directory path that is valid for a linux system.
       check_homezone - The check_homezone option indicates whether the GSM channel driver
        should periodically check homezone (also measuring signal strength). From the command line,
        the command "gsm show status" gives the output that is relevant to this option. Valid values:
        yes no
       skip_plus - The skip_plus option enables/disables skipping the '+' prefix for a number that
        comes with one. Valid values: yes no
       syslogdebug - The syslogdebug option enables debugging via syslog. Valid values: yes no
       relaxdtmf - The relaxdtmf option enables/disables radio/gsm optimized DTMF detection
        mechanism. Valid values: yes no
gsm_additional.conf
This file contains all of the channel specific information for GSM trunks in the system. This is the file
written by the freepbx GUI when GSM trunks are added to the system. A sample of this for a single
trunk, as generated by the freepbx GUI, is as follows.

  ;--------------------------------------------------------------------------------;
  ; Do NOT edit this file as it is auto-generated by FreePBX. All modifications to ;
  ; this file must be done via the web gui. There are alternative files to make    ;
  ; custom modifications, details at: http://freepbx.org/configuration_files       ;
  ;--------------------------------------------------------------------------------;
  ;

  [from-gsm-custom-1]
  sms_pdu_mode=no
  smsc=15142345678
  resetinterval=0
  pin=1234
  initfile=/etc/asterisk/gsm-init-file
  hidecallerid=no
  exten=s
  context=from-gsm
  channel=>1




This file is over written every time configuration is applied in the FreePBX GUI. The available parameters
in this file and their meanings are as follows.

       channel - The channel option defines the channel number(s) the configuration will apply to. If
        there is more than one channel, they are comma separated. Valid values: Comma separated list
        of channel numbers.
       initfile - The initfile option specifies the file that contains the collection of commands used to
        initialize the GSM radio. Valid values: A path to an initialization file with the correct format. If
        this option is left empty, a default initialization sequence will be used.
       context - The context option specifies the context to be used under the dialplan for incoming
        calls. Valid values: A valid context name
       exten - The exten option specifies the extension to be used for incoming calls. Valid values: A
        valid extension
       pin - The pin option specifies the SIM card PIN number for the SIM card(s). Valid values: A
        correct PIN number
       hidecallerid - The hidecallerid option specifies whether the caller ID is to be hidden when
        making outgoing calls. Valid values: yes no
       resetinterval - The resetinterval option defines the number of seconds to elapse after which the
        channel(s) is to be reset (when not in use). Leave as 0 to disable this option. Valid values: 0..N
       smsc - The smsc option specifies the SMS service provider number. Valid values: A Valid SMS
        service provide number.
   sms_pdu_mode - The sms_pdu_mode option specifies whether the SMS should be provided in
    PDU or in cleartext format. Valid values: yes no
GSM CLI Commands
There are many Asterisk CLI commands available for the chan_gsm channel driver. To run any of these
commands, log into the Asterisk CLI or input them as detailed above in the using FreePBX section. The
commands are as follows.

Channel commands
gsm init port <port>
Use this command to initialize a GSM port, where <port> is the port number to be initialized.

gsm shutdown port <port>
Use this command to shut down a GSM port, where <port> is the port number to be initialized.

gsm restart port <port>
This command is used to restart a GSM port, where <port> is the port number to be restarted.

gsm show status
This command is used to list the status of all GSM ports. A sample output from this command would
look like the following:

 Port Status     InUse          Provider         Home Zone          Signal Quality
 1 (0) REGISTERED n            "Rogers Wireless"  y                  -83dbm
 2 (0) REGISTERED n            "Rogers Wireless"  y                 -79dbm




The fields here can be detailed as follows:

       Port column is the index to the GSM port.
       Status should be REGISTERED.
       InUse column indicates if the GSM port is busy.
       Provider gives the name of the provider.
       Home Zone indicates if we're registered to our regular provider.
       Signal Quality indicates how good the signal reception is.

For signal quality, we can translate the measurements as follows:

       not measurable (not measured yet)
       -112 dbm is very low
       -97 dbm is low
       -82 dbm is ok
       -67 dbm is good
       -52 dbm is high
       -51 dbm is very high
SMS Related Commands
gsm send sms <port> <number> "<smstext>"
Use this command to send an SMS message to a given number via a given port, where <port> is the port
number to use, <number> is the recipient and <smstext> is the message to be sent. A sample command
to send SMS on port 1 to number 5556666 would be:

gsm send sms 1 5556666 "Hello, Earthling"

gsm show sms <port>
This command is used to display all stored SMS messages on a given port. A sample output for received
SMS messages is as follows:

 P(1) SMS RECEIVED: Idx(2) Number(+16133011736) Date(09/12/08,15:54:58+00) Text(testing 1,2,3,4)


gsm fetch sms <port>
This command is used to retrieve all stored SMS messages on a given port and store them to disk. All
messages on the given <port> will be stored to disk (under smsdir) and then subsequently erased from
the SIM memory. A sample output for "fetched" SSM messages is as follows:

 Saving SMS in /var/spool/asterisk/smsin/1260307679-254790.sms



Configuration Commands
gsm show config values
This command displays all configuration values.

gsm show config descriptions
This command displays all available configuration items.

gsm show config description <item>
This command displays the description for a specific configuration item. Use the above command see a
list of all available items.

Operator Related Commands
gsm show operators
This command displays a list of all available operators.

gsm set op <port> <operator>
This command sets a port to a specific operator, where <port> is the port number and <operator> is
operator name in numeric format.
Debugging Commands
gsm set debug <level>
This command sets the debug level output to <level>, where <level> is the debugging level, which is 0
for no debug and 1 for debugging.

gsm debug info
This command prints out debugging information.

gsm show version
This command displays the version information for the GSM channel driver.
Compiling from Source

PADS Source
If you do not wish to use the FreePBX based system and want to create your own Asterisk based system,
you can retrieve the source code for PADS with GSM support here,
http://svn.pikatech.com/pads/distro/branches/gsm/ SRK: State revision

Instructions on using PADS to compile and make your own system can be found here.

FreePBX Source
If you wish to compile your own version of the FreePBX based plateform, Enterprise, you can retrieve
the source for it here, http://svn.pikatech.com/pads/addons/branches/gsm-freepbx/

To compile FreePBX code, from the command line of your Linux machine, follow these steps:

[ someone@localhost ~]$ svn export http://svn.pikatech.com/pads/addons/branches/gsm-freepbx/

Now you just need to go into that folder and build it.

[ someone@localhost ~]$ cd gsm-freepbx
[ someone@localhost freepbx-mysql]$ ./build_freepbx.sh

Now go get a coffee or something. With a good internet connection and processor, this will take around
45 minutes or more if you have a slow computer or internet.

When the compilation is finished, you will see a message where the image files to flash to your WARP
are located. Make sure you have proper instructions on flashing before doing this.
Contacting PIKA Technologies

Customer Care
PIKA Technologies provides free technical support to all customers. For support issues,
phone or e-mail
Customer Care at the following:
Tel: +1-613-591-1555
FAX: +1-613-591-9295
Email: support@pikatech.com

International Headquarters
PIKA Technologies Inc.
535 Legget Drive, Suite 400
Ottawa, Ontario, Canada K2K 3B8
Tel: +1-613-591-1555
FAX: +1-613-591-9295
Email: sales@pikatech.com

Internet
Visit our website at www.pikatechnologies.com for the latest news, product
announcements, downloads, documentation updates, and contact information. There are
also blog and forum sites dedicated to the PIKA WARP appliance at http://pikawarp.org and
http://forum.pikawarp.org.

								
To top