SatSite YateMMI Configuration

To be able to set the RAN equipment, the Network settings must be set first, otherwise only ‘not configured‘ equipment can be set. The BTS configuration will be discussed further on. 

When setting RAN equipment some parts are specific to each equipment and will be set from RAN equipment wizard and others are general therefore are set from BTS / ENB Templates.

YateMMI comes preconfigured

YateMMI comes preconfigured with 2 BTS Templates & 2 ENB Templates.

BTS / ENB Templates, RAN equipment modules can be disabled / enabled from tab Home -> Settings -> Modules by the administrator of the system.

The administrator can set more default templates or modify the ones set by default in defaults.php by creating some arrays in config.php with the particular values of the parameters.

Example:

// the array containing the names of the default templates for BTS
$bts_default_templates = array("bts_rural", "bts_urban");
// all the templates start with the same predefined values for each section, to build the default templates that have different values just create an array with the differences using the name of the default template defined above. Example of the new configuration that will be set in 'bts_rural' template:
$bts_rural_differences = array(
"bts_template" =>array("Radio.Band"=>"850"),
"gprs" => array("RA_COLOUR" => "5", "RAC" => "5")
);

From ‘My Network’ tab the BTS Templates / ENB Templates can be created / edited / deleted. The template that was associated to a RAN equipment can’t be deleted. The default templates that were generated by the system can only be edited, not deleted.

A new template with different configuration can be created by using any of the existing templates in the system. Also only the new templates can be associated to all the equipment that have the selected profile.

  • BTS Templates sections:
    - Basic sections: BTS Template, Radio and Core
    - Advanced sections: Hardware, System, Test
  • ENB Templates sections:
    - Basic sections: ENB Template, Radio
    - Advanced sections: Hardware, System

Each section have subsections. See what parameters can be set for each subsection of a BTS / ENB Template in the attached files (in Documents section bellow): bts_template.odt / enb_template.odt

The interface allows the custom equipment defined with node type ‘sdr’ that was added in the system from ‘Add custom equipment’ page, to be ported automatically into RAN equipment.

A new RAN equipment can be added in the system using the wizard from ‘Add RAN equipment’ button that can be found in tab ‘Equipment’ -> ‘RAN’. Each RAN equipment can have 2 node types: SatSite / LabKit.

  • The SatSite and LTE LabKit can have one of four 'Working modes'
    - LTE enb
    - GSM dataroam
    - GSM roaming
    - GSM nipc - for this one is highly recommended to use the LMI

Depending on the selected working mode the existing templates will be present to be selected from a drop down. Also depending on the working mode chosen the steps will be different. Bellow is the First step description and then the different steps for each type of working mode chosen.

The first step of the Add RAN Equipment wizard contains the following parameters:

  • ‘Name’; the unique name used to identify this equipment
  • ‘Node type’: SatSite / LabKit
  • ‘IP management interface’: the IP address of the management interface. Configuration / interrogation / monitoring requests will be sent to this IP.
  • ‘Serial number’: unique serial number associated to this equipment. The information should be given by the vendor of the equipment, otherwise set any unique numeric value. Example: 1234567
  • ‘State’: the state of the equipment: active / disabled. If disabled no requests will be sent to this equipment.
  • ‘Equipment addresses’: there are 3 choices: Enter manually / Query filtered / Query all
  • ‘Working mode’: LTE enb, GSM dataroam, GSM roaming, GSM nipc
  • ‘Templates’: dropdown with the existing templates
  • ‘Description / Notes’ for the equipment

Examples of RAN Equipment wizard for various working modes

If the node type is SatSite and the working mode chosen is:

  • ‘LTE enb’ the following steps can be set: eNodeB, GTP/MME, Hardware, Extra params, Routing, Scripts
  • ‘GSM dataroam / GSM roaming’ the following steps can be set: GSM, Roaming / Handover, Hardware, Extra params, Routing, Scripts
  • ‘GSM nipc’ the following steps can be set: GSM, Hardware, Extra params, Routing, Scripts

For the node type LabKit the working mode is GSM nipc with the steps: GSM, Hardware, Extra params, Routing, Scripts.

Description of the parameters that can be configured:

  • eNodeB
    • eNodeB Id: unique for each eNodeB in the network. Must be 5 hex digits for a Macro ENB or 7digits for a Home ENB
    • Tracking Aria Code: 4 digit hrx value. This value must be set. There is no default. Ex.: 2A9F.
    • Cell Identity: Must be 7 hex digits. Ex: 0000001.
    • Power Reduction
    • NID1: is between 0 and 167. Must be provided. There is no default.
    • NID2: is between 0 and 2. Must be provided. There is no default.
  • GTP / MME
    • Local address IPv4: the IP address to use with the eNodeB tunnel end
    • Local address IPv6: the Ip address to use with the eNOdeB tunnel end
    • The connections to one / multiple MME(s) depending on the configured YateUCN(s) with MME enabled and S1AP listener(s) already defined in the network.
    ◦  for each connection only the eNodeB local address can be set / modified, the rest should be the values set on the YateUCN listener: MME remote address and DSCP
  • GSM
    • Radio.C0: the C0 ARCFN, also the base ARCFN for a multi-ARCFN configuration. Valid values depend on the selected Radio.Band
    • Identity.LAC: Location Area Code, 16 bits, values 0xFFxx are reserved. For multi-BTS networks, assign a unique LAC to each BTS unit. Interval allowed: 0...65280. Default to 1000 (arbitrary)
    • Identity.CI: Cell ID, 16 bits, should be unique. Interval allowed 0...65353. Default to 10 (arbitrary)
    • Identity.BSIC.BCC: GSM Basestation color code ; lower 3 bits of the BSIC. BCC values in a multi-BTS networks should be assigned so that BTS units with overlapping coverage do not share a BCC. This value will also select the training sequence used for all slots on this unit. Interval allowed 0...7. Default to 2 (arbitrary)
    • Power Reduction: minimum transmitter attenuation level in dB wrt full scale on the D/A output. This sets the maximum power output level in the output power control loop. Interval allowed 0..80, must be less or equal to Radio.PowerManager.MaxAttenDB. Defaults to 0 (dB) (maximum)

Roaming / Handover

  • Roaming - VLR / MSC connection
    • Reg SIP: the format is IP:Port where SIP requests are sent. It is required to set Reg SIP or Nodes SIP. Example: 192.168.1.245:5058
    • Nodes SIP: JSON object: node => IP:Port of each YateUCN server node, which is computed based on the TMSI received from the handset. This ensures that registrations are always sent to the same YateUCN server. It is required to set either Reg SIP or Nodes SIP. Example: { "123": "192.168.1.176:5058", "101":"192.168.1.245"}
    • My SIP: string: IP:Port for the local SIP listener. Unless otherwise configured, this is the IP of the machine where YateBTS is installed. Example: 192.168.1.168
    • Gstn location: string: unique number that identifies the cell in the national database associated to each base station by the network operator.
  • GPRS ROAMING - SGSN connections
    • NNSF bits: node selection bits. Set in Network settings. Global for whole network. This is the number of bits used by Node selection function when deriving an UCN node from TMSI. Example: 8
    • Explicitly map network nodes to IP address. Mapping between NNSF Node value and GTPc / GTPu IP from UCN's S1 GTP interfaces. Example: 20=10.0.0.1, 23=10.2.74.9
  • Handover
    • Neighbors: comma separated list of neighbor SIP addresses. Each neighbor will be periodically queried for target handover availability. This parameter is not present if the template chosen has not Handover enabled. Example: 10.0.0.1, 10.0.0.2, 10.0.0.3:5065. Default is empty

Hardware

Set customer-specific parameters for site equipment, site specific information and parameters for safety shutdown equipment.

Site info:

  • Site location: no default value is provided. The format for this field is latitude, longitude ddd.dddddd,ddd.dddddd.
  • Site name
  • Antenna direction: The direction the antenna is pointed, in degrees from true north.No default is provided.
  • Antenna beam width: Default is omni, 360 degrees reporting Period
  • Reporting period in minutes for HW status. Default is 15 minutes.
  • Site equipment This is an area for customer-specific parameters for other site equipment, like antennas, cables, and anything else too \”dumb\” to carry its own configuration and identifying information. No defaults are provided.
  • Antenna type: string, the antenna type.
  • Antenna serial number: string, the antenna serial number.
  • Antenna cable type: string, the antenna cable type.
  • Antenna cable length: string, the antenna cable length.
  • Power supply type: string, the power supply type.
  • Power supply serial: number String, the power supply serial number.
  • Custom parameters: that will be stored on the equipment. They are not used in configuration but are kept for informative purpose. They are stored in key=value form. The keys should not match any of the above keys. Ex: antenna_serial_number2=342134, antenna_cable_length2=0.5

Extra params

Extra parameters that will be sent to this equipment in API configuration requests. This extra parameters values will override the ones set in the template chosen.

  • Extra param: describes the name of the parameter as API configuration request expects. You can select from a predefined list or insert a custom param name. The predefined list contains:
    – empty_begin – Bool – UCN, SMSC
    – reject_ta – Bool – MME
    – local_pdn – Bool – MME
    – multi_pdn – Bool – MME
    – paging_cnt Integer – MMe
    – paging_int – Integer – MME
    – paging_max – Integer – MME
    – paging_drx – Bool – MME
    – empty_force – Bool – SMSC
    – home_mt_sms – Bool – SMSC
  • Data type: can be bool, string or number, this will allow setting the value accordingly.
  • Value: the value of the extra param. The value must be the same type as the one specified in the field ‘Data type’.
  • Equipment type: this field specifies where this extra param is used. This is only used for displaying params grouped by the set of the equipment type, but later on , could be used as a filter for applying extra params.
  • Status: describes the status of the extra param. By disabling it, the extra param will not be included in the API configuration request.

Routing

Configure specific rules for templates that will be written in regexroute file.

  • Name of template, optional, used for adding comments in the written file to make reading easier.
  • Rule String, mandatory. Contains the rules that are to be written for this template in regexroute. The string must be in valid Yate configuration format.
  • Status of the Regexrouting Rule. By disabling it, the Regexrouting Rule will not be included in the API configuration request.

Scripts

Push small JavaScript scripts to the equipment to add/modify the product’s features.

  • Name of the script. Will be used as part of a filename. Must contain only letters, digits, underscores and dashes and should start with letter.
  • Script: String, mandatory. Contains the JavaScript to be pushed to the equipment. The format must be in correct Yate JavaScript syntax. Status The status of the Script. By disabling it, the Script will not beincluded in the API configuration request.

For each RAN equipment the following actions can be done:

  • Edit
  • Status
  • View Logs
  • Restart Service
  • Reload
  • Force Calibration
  • Force config
  • View JSON
  • Delete
  • LMI

When adding RAN equipment in various modes you need to have UCN equipment defined with:

  • for LTE ENB – S1AP Listener
  • for GSM roaming – VLR SIP Listener of type ran
  • for GSM dataroam – VLR SIP Listerner of type ran & S1 GTP interface