OpenBTS Application Suite Release 4.0 User Manual Revision date: April 15, 2014 Copyright 2011-2014 Range Networks, Inc. This document is distributed and licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License. Contents 1 General Information 7 1.1 Scope and Audience.........................................8 1.2 License and Copyright........................................8 1.3 Disclaimers..............................................8 1.4 Source Code Availability....................................... 10 1.5 Abbreviations............................................ 11 1.6 References.............................................. 12 1.7 Contact Information & Support................................... 13 2 Introduction to OpenBTS Application Suite 14 2.1 Key Programs............................................ 15 2.2 Network Organization........................................ 16 3 Getting to Know Your OpenBTS System 19 3.1 Accessing the System........................................ 19 3.2 Starting and Stopping Applications................................. 20 3.3 OpenBTS Command Line Interface (CLI)............................. 20 3.4 Using the OpenRANUI....................................... 24 3.5 Databases.............................................. 25 3.6 Folder Structure........................................... 25 3.7 Logging............................................... 26 4 OpenBTS Data Tables and Structures 27 4.1 Manipulating OpenBTS Databases................................. 27 4.2 The Configuration Table...................................... 28 2 CONTENTS 3 4.3 TMSI Table............................................. 29 4.4 Transaction Table.......................................... 30 4.5 Channel Table............................................ 30 5 OpenBTS and the Transceiver 32 5.1 Downlink Power and Congestion Management........................... 32 5.2 Uplink Power and Timing Control................................. 34 6 SIPAuthServe, Subscriber Registry and Asterisk 35 6.1 Subscriber Registry......................................... 36 6.2 Provisioning New Subscribers.................................... 38 6.3 Emergency Calls........................................... 43 6.4 Connecting to a VoIP Carrier.................................... 44 6.5 Hybrid GSM/SIP Transactions................................... 45 6.6 Backhaul Capacity Considerations................................. 45 7 SMQueue 50 7.1 Design and Operation of SMQueue................................. 50 7.2 Configuring SMQueue........................................ 51 7.3 Short Code Applications....................................... 51 8 Other GSM Services 53 8.1 Short Message Service Cell Broadcast (SMSCB).......................... 53 8.2 Radio Resource Location Protocol (RRLP)............................. 53 9 General Packet Radio Service (GPRS) 54 9.1 Configuring GPRS in OpenBTS................................... 54 9.2 Configuration of Handsets for OpenBTS GPRS.......................... 57 9.3 Using CLI to Monitor and Control GPRS.............................. 57 10 NodeManager 58 10.1 NodeManager API Interface..................................... 58 10.2 Running NodeManager Queries................................... 60 10.3 Port Utilization........................................... 61 4 CONTENTS 11 PowerScanner 62 Appendices 63 A OpenBTS Implementation of GSM & 3GPP Specifications and IETF Standards 64 A.1 The OpenBTS GSM Air Interface.................................. 64 A.2 Text Messaging (SMS)....................................... 72 A.3 Short Message Service Cell Broadcast (SMSCB).......................... 76 A.4 General Packet Radio Service (GPRS)............................... 77 B Configuration Parameters 85 B.1 OpenBTS Parameters........................................ 85 B.2 Smqueue Parameters........................................ 98 B.3 SIPAuthServe Parameters...................................... 101 C The Command Line Interface (CLI) Reference 102 C.1 \alarms" Command........................................ 103 C.2 \audit" Command......................................... 103 C.3 \calls" Command......................................... 103 C.4 \cellid" Command........................................ 104 C.5 \chans" Command......................................... 104 C.6 \config" Commands........................................ 105 C.7 \devconfig" Command...................................... 106 C.8 \endcall" Command........................................ 106 C.9 \freqcorr" Command....................................... 107 C.10 \gprs" Command.......................................... 107 C.11 \handover" Command....................................... 108 C.12 \help" Command.......................................... 108 C.13 \load" Command.......................................... 108 C.14 \memstat" Command........................................ 109 C.15 \neighbors" Command...................................... 109 C.16 \noise" Command......................................... 109 C.17 \notices" Command........................................ 109 CONTENTS 5 C.18 \page" Command.......................................... 109 C.19 \power" Command......................................... 110 C.20 \rawconfig" Command...................................... 110 C.21 \regperiod" Command...................................... 111 C.22 \rmconfig" Command....................................... 111 C.23 \rxgain" Command........................................ 111 C.24 \sendsimple" and \sendsms" Commands............................ 112 C.25 \sgsn" Command.......................................... 112 C.26 \shutdown" Command....................................... 112 C.27 \stats" Command......................................... 113 C.28 \sysinfo" Command........................................ 113 C.29 \tmsis" Command......................................... 113 C.30 \trans" Command......................................... 114 C.31 \trxfactory" Command...................................... 114 C.32 \txatten" Command........................................ 114 C.33 \unconfig" Command....................................... 115 C.34 \uptime" Command........................................ 115 C.35 \version" Command........................................ 115 C.36 Executing OS shell commands from the CLI............................ 115 D Logging in OpenBTS 116 E Multi-BTS Networks 118 E.1 How Mobility Works......................................... 118 E.2 Example of Mobility Configuration, Simple Case.......................... 120 E.3 Example of Mobility Configuration, More Advanced Case..................... 122 E.4 Handover............................................... 123 E.5 Remote Logging........................................... 126 F Test Procedures 130 F.1 Test SIM Procedures........................................ 130 F.2 Testing with Open Registration................................... 132 6 CONTENTS G FOSS Licenses 134 G.1 Creative Commons License..................................... 134 G.2 GNU General Public License, v.1.................................. 139 G.3 GNU General Public License, v.2.................................. 144 G.4 GNU General Public License, v.3.................................. 152 G.5 GNU Lesser General Public License, v.2.1............................. 166 G.6 GNU Lesser General Public License, v.3.............................. 176 G.7 BSD Licenses............................................ 178 Chapter 1 General Information 1.1 Scope and Audience.....................................8 1.2 License and Copyright....................................8 1.3 Disclaimers..........................................8 1.3.1 Warranty..........................................8 1.3.2 Accuracy..........................................8 1.3.3 Patent Laws........................................8 1.3.4 Trademarks........................................9 1.3.5 Telecom and Radio Spectrum Laws............................9 1.3.6 FOSS License Compliance.................................9 1.4 Source Code Availability.................................. 10 1.5 Abbreviations......................................... 11 1.6 References.......................................... 12 1.6.1 References to ETSI Documents.............................. 12 1.6.2 ETSI/3GPP........................................ 12 1.6.3 IETF............................................ 12 1.7 Contact Information & Support.............................. 13 1.7.1 Direct Contact....................................... 13 1.7.2 Online Resources..................................... 13 The OpenBTS Release 4.0 Public is distributed publicly under the AGPLv3 license. The OpenBTS Release 4.0 Commercial is distributed only to commercial customers, normally under a binary license. The commercial release provides the following improvements over the public release: • Prioritization of emergency calls and IMS-compliant emergency call headers; • All applications in the OpenBTS application suite are configured as upstart services. They start during system initialization, and restart automatically should either one crash or exit; 7 8 CHAPTER 1. GENERAL INFORMATION • Remote management interface (OpenRANUI) over http, integrating subscriber provisioning, SIM card creation, configuration and monitoring tools for all major components of the application suite; • No AGPLv3 license restrictions. 1.1 Scope and Audience This document describes the organization and operation