TETRA

• Motorola
• Setting up Dummy and LogCollector for a TETRAPack connection
• EBTS
• Dummy
• CTS Log Collector
• MTS
• CTS Updater
• CTS
• Interfacing
• E1/T1 Interface
• FrameRelay over E1
• Detroit (DMR -TETRA) Bridge
• Radio Settings
• Server Bridging
• Asterisk PBX
• SVXLink

Motorola

Setting up Dummy and LogCollector for a TETRAPack connection

Disclaimer

• Please note you follow this guide at your own risk! This is an experimental bridge, and we can't be held responsible if anything bad happens to your precious CTS! 

• This guide is for a Single-BS (one CTS) subnet. If you wish to interconnect more CTSes locally, you'll need to modify the network topology + E1 time slotting accordingly.

Hardware requirements

• Raspberry Pi (4 is ideal, 2GB is ok), with PSU and SD card
• icE1USB
• A USB-Ethernet Adapter
• A CTS (DUH)

Prep work

• Make sure you understand how TetraPack works, its topology, how Dummy and LogCollector operate with each other, etc.
• Before going any further, read this!
• Open up the icE1USB (from the back, with the SMA connector), and swap the jumpers so they match this picture:

CTS Setup

1. Get a clear view of how the CTS is configured, and its necessary configuration files: bssparams.txt, set_x_gp, gm, sc, sub.csv, etc. Please make sure everything works as a standalone site before starting this entire endeavour!
2. You also need good way to remotely connect to the CTS management interface (VNC is a good option).
3. Plan ahead and make a list of the BrandMeister TGs you want your CTS to handle. Add them already to set_x_gp and gm.csv, reboot everything and make sure they already work locally in standalone mode.
4. Open up bssparams.txt on your CTS, and do the following edits. Don't change anything else at this state:

   ## Base-Station Parameters ################################################################
   #### Set the name to something simple, short, no special caracters
   /base-station/name = "CTSBS";
   #### set this to id 1
   /base-station/base-station-id = 1;
   #### add or replace:
   /base-station/standalone-mode = false;
   #### add or replace:
   /base-station/use-local-site-fall-back = false;
   
   ## Air Interface BLE Parameters ###########################################################
   /base-station/BLE/neighbour-cells = 191;
   
   ## SDS Gateway Parameters #################################################################
   #### Remove all other lines, replace by:
   /system/sds-gateway/host-1 = { issi = 262999; ip-address = "44.225.64.18";};
   /system/sds-gateway/host-2 = { issi = 250999; ip-address = "44.225.64.19";};
   /system/sds-gateway/host-3 = { issi = 16777184; ip-address = "44.225.64.20";};
   # These ISSIs will be used for SMS and GPS services (via GWPC emulation, IP addresses don't matter)
   
   ## E1 Layout Parameters ###################################################################
   ### Remove all other E1 layout lines, and replace byt this:
   /network/E1-layout/time-slot-01 = { source-type = "SIGNALLING"; };
   /network/E1-layout/time-slot-02 = { source-type = "SIGNALLING"; };
   /network/E1-layout/time-slot-03 = { source-type = "SIGNALLING"; };
   /network/E1-layout/time-slot-04 = { source-type = "SIGNALLING"; };
   
   #### Real BS transceivers
   /network/E1-layout/time-slot-17 = { source-type = "BS"; base-station-id = 1; l-transceiver-id = 11; };
   
   #### Dummy's emulated BS transceivers
   /network/E1-layout/time-slot-22 = { source-type = "BS"; base-station-id = 8; l-transceiver-id = 11; u-transceiver-id = 12;};
   /network/E1-layout/time-slot-23 = { source-type = "BS"; base-station-id = 8; l-transceiver-id = 13; u-transceiver-id = 14;};
   /network/E1-layout/time-slot-24 = { source-type = "BS"; base-station-id = 8; l-transceiver-id = 15; u-transceiver-id = 16;};
   /network/E1-layout/time-slot-25 = { source-type = "BS"; base-station-id = 8; l-transceiver-id = 17; u-transceiver-id = 18;};
   
   #### Dummy's emulated GWPC encoders
   /network/E1-layout/time-slot-26 = { source-type = "DISP"; };
   /network/E1-layout/time-slot-27 = { source-type = "ISDN"; };
   /network/E1-layout/time-slot-28 = { source-type = "ISDN"; };
   /network/E1-layout/time-slot-29 = { source-type = "ISDN"; };
   /network/E1-layout/time-slot-30 = { source-type = "ISDN"; };
   
   
   ## Network Topology Parameters ############################################################
   #### Remove all other network topology parameters, and replace by this. Don't forget to change CTSNAME to the same name as in line 3!
   /network/topology/gateway-pc     = { name = "Gateway Server"; E1-connection-1 = "BS-8"; };
   /network/topology/base-station-1 = { name = "CTSBS"; E1-connection-1 = "BS-8"; };
   /network/topology/base-station-8 = { name = "DUMMY"; E1-connection-1 = "BS-1"; E1-connection-2 = "GW-PC"; };
   
   

5. Save and reboot the CTS, make sure it still works.
6. Copy bssparams.txt over to your local PC, you'll need it for your Raspberry Pi.
7. Write down the IP address of your CTS BSC computer (mine was 10.10.15.31, but yours will probably be different). 

Software Stack Install

1. Prepare an SD card with a 64-bit Raspbian Bookworm (Debian 12)
2. Update/Upgrade the OS after boot:
   

   sudo apt update && sudo apt upgrade
   reboot

   
   
3. Add the Osmocom repo, as per Osmocom's documentation:
   

   sudo su
   OSMOCOM_REPO="https://downloads.osmocom.org/packages/osmocom:/latest/Debian_12" 
   wget $OSMOCOM_REPO/Release.key
   mv Release.key /etc/apt/trusted.gpg.d/osmocom-latest.asc
   echo "deb [signed-by=/etc/apt/trusted.gpg.d/osmocom-latest.asc] $OSMOCOM_REPO/ ./" > /etc/apt/sources.list.d/osmocom-latest.list
   apt update

4. Install Osmocom E1D:
   

   sudo apt install osmo-e1d

5. Add the TetraPack repository:
   

   wget https://packages.tetrapack.online/install/public.key
   mv public.key tetrapack.asc
   sudo apt-key add tetrapack.asc
   sudo echo "deb [arch=arm64] http://packages.tetrapack.online/repository/ bookworm main" > /etc/apt/sources.list.d/tetrapack.list
   sudo apt update

6. Install TetraPack dummy and cts-logcollector
   

   sudo apt install tetrapack-dummy cts-logcollector

7. Plug in the icE1USB to your Rpi, recover the interface serial number:
   

   sudo lsusb -d 1d50:6145 -v 2> /dev/null | grep iSerial

8. Open (with for instance nano) /etc/osmocom/osmo-e1d.cfg, copy/paste this:
   

   log syslog daemon
   e1d
    interface 0 icE1usb
     usb-serial [interface serial number]
     line 0

9. Reload the service:

   sudo systemctl restart osmo-e1d

Dummy - E1 Link setup

1. Make sure Dummy is off with:

   sudo systemctl stop dummy@default.service 

2. Open/Create /opt/TetraPack/bssparams.txt, and copy/paste the contents from the file created at the CTS setup step. Edit the following lines

   
   ## System Parameters #####################################################################
   ### Edit/Replace
   /system/name = "DUMMY";
   
   
   ## Base-Station Parameters ################################################################
   ### Edit/Replace
   /base-station/name = "DUMMY";
   /base-station/base-station-id = 8;

3. Open/Create /opt/TetraPack/default.env

   # E1D interface and line in format [interface number].[line number]
   DUMMY_LINE=0.0
   
   # Path to CTS topology file (bss3.txt or bssparams.txt)
   DUMMY_TOPOLOGY=/opt/TetraPack/bssparams.txt
   
   # IP address and mask for CTS VTUN interface
   DUMMY_NETWORK="192.168.0.8 mask 255.255.255.0"
   
   # Specific options (multiple values can be delimited with comma):
   # replace-forwarded-link-status - replace IP-forwarded status for both E1 lines status of local BSs/GWPC to up
   # emulated-bs-line1-down        - set E1-1 status of emulated BS to down
   # emulated-bs-line2-down        - set E1-2 status of emulated BS to down
   # emulated-gwpc-line1-down      - set E1-1 status of emulated GWPC to down
   # emulated-gwpc-line2-down      - set E1-2 status of emulated GWPC to down
   DUMMY_OPTION=
   
   # Server connection URI in format http(s)://[user]:[password]@[address]/[path and parameters]
   # If you care about securely stored password, please put credentials into /opt/TetraPack/.netrc (man netrc)
   # REPLACE <YOUR DMR-ID> and <YOUR HOTSPOT/REPEATER PASSWORD> with your radio ID and password :)
   DUMMY_CONNECTION="http://<YOUR DMR-ID>:<YOUR HOTSPOT/REPEATER PASSWORD>@core.tetrapack.online:8081/dummy/?mode=bs+gwpc"
   
   # Instance name for D-BUS IPC interface
   DUMMY_INSTANCE=default
   

4. Save everything, cross your fingers and connect E1.1 from your BSC to the left port of icE1usb, like so:

   

5. The matching LED on the port should stop blinking, and the red LED on E1-1 should turn off. 
6. Try to start dummy from the console:

   cd /opt/TetraPack
   ./run.sh default.env
   
   # First, read starup messages and check that configuration (default.env and bssparams.txt) parsed successfuly
   # Second, check connection: if you see, in blue, "Q.921 connection established", congratulations! Your E1 link works!
   # You should also see "Socket Connection Established" - this means, connection to server established

7. If everything works, Ctrl+C to stop the console instance, and enable the service + start it

   sudo systemctl start dummy@default.service

LogCollector - CTS Management interface setup

1. Connect the USB/Ethernet interface to the Pi, and connect an Ethernet cable from BSC management port to the usb dongle. 
2. Stop LogCollector:

   sudo systemctl stop cts-logcollector@default.service

3. Set a static IP on the interface (probably eth1) on the same range as the BSC, by editing /etc/dhcpcd.conf and adding this:

   # Don't forget to edit your ip address to match the range of your BSC!
   interface eth1
   static ip_address=10.10.15.20
   static routers=10.10.15.1

4. Test if you can connect via telnet:

   telnet [BSC IP ADDR] 51600
   #If you get "220 Network Management Interface is ready.", you're good to go!

5. Through that telnet interface, you can check if you got a good E1 link with Dummy:

   login a
   cd network
   netstat
   #Look at the table that pops up, and focus on the "Links" column
   #260-rsp
   #260-Node    Links     DD      AI    ISDN    DISP
   #260---------------------------------------------
   #260-BS-1      u -      u       u       -       -
   #260-BS-2      ? ?      ?       ?       -       -
   #260-BS-3      ? ?      ?       ?       -       -
   #260-BS-4      ? ?      ?       ?       -       -
   #260-BS-5      ? ?      ?       ?       -       -
   #260-BS-6      ? ?      ?       ?       -       -
   #260-BS-7      ? ?      ?       ?       -       -
   #260-BS-8      u u      u       u       -       -
   #260-GWPC      d u      u       -       u       d
   #260-
   #260 .
   #BS-1 should have first link on U, BS-8 should have both U, and GWPC should have D U
   #If it's not the case, check the topology with:
   cd topology
   ls
   #Should show this: 
   #260-      d-- gateway-pc
   #260-      d-- base-station-1
   #260-      d-- base-station-8
   #If not, check your bssparams.txt on both the CTS and the Pi, something is wrong. 
   
   
   

6. Close the Telnet session (Ctrl+c), open /opt/LogCollector/default.env, and change the ip address:

   # [IP of basestation] [dummy instance name] [basestation ID (1-8)]
   COMMAND_ARGUMENTS=[YOUR BSC IP] default 1

7. Enable/Restart LogCollector, wait for a bit and see if you get data coming from the CTS when you place a call or attach to a group:

   sudo systemctl enable cts-logcollector@default.service
   sudo systemctl start cts-logcollector@default.service
   #Let's monitor syslog to see if it recovers logs from the CTS. You should see a bunch of lines show up.
   tail -f /var/log/syslog | grep cts

8. If it works, great! LogCollector is ready. Ctrl+C to quit tail, carry on to the rest

EBTS

Introduction 

Currently the Motorola Enhanced Base Station (EBTS) alone is quite limited feature-wise: only simplex group calls, no SDS, no status calls, no packet data - The Connection to our Virtual Core does however remove some of the following issues with LST

1. No LST! (No Red Lights on TSC, and No Annoying Notification on the Front of your Radios)
2. Network Wide Group Calling - TGS Configured in our Core are Routed between ALL Linked BTS Sites
3. Local Site Private Calling - Having a Linked site allows for 1-1 Private Calling (NOT FULL DUPLEX). Simply Dial the ISSI Number of the radio you wish to dial and hit PTT, this will call the radio and establish a 1-1 Call
4. Wide Area Private Calling - As Above, Just across the network! - Call your buddys across the world via their ISSI Number.

The aim of this guide is to help you get your EBTS connected to our Virtual Core, and enjoy all TETRA features (+ TPC interconnects, coming soon™). 

Disclaimer

• Follow this guide at your own risk! This is an experimental bridge, and we can't be held responsible if anything bad happens to your precious EBTS! 

• Supplied Configurations for Cisco Connectivity are Examples/Known Working Configurations, it is down to the Site Sysop to Secure their own System from unauthorised access

Prep Work

• Before starting this endeavor, get in touch with the Core Network Team, you'll need some specific configurations files for your site (Cisco and EBTS)
• You must have a basic understanding of the TETRA standard (how it behaves, how to program radios with MCC/MNCs, add talkgroups).
• Modifications on the EBTS settings will also be needed, make sure you're also feeling at ease with that.
• Some Linux Console knowledge as well as basic Cisco usage will also come in handy.

Connection methods

Option 1 - Cisco router

• A working EBTS/MBTS setup in lone site trunking mode (bare minimum: Base Radio + Site Controller). Don't forget an RS-232/USB converter if your computer doesn't a native DB9 connector!
• Raspberry Pi. You can also use a Mikrotik router, but this is not documented here (you'll need to install and configure ZeroTier, and bridge it to a LAN port).
  
• Cisco 2600XM Series router + E1 Card (either one or two ports, both will work). You'll also need an additional Ethernet USB Dongle for the Pi. Make sure you also have a console cable.
• An E1 Crossover cable (RJ45 plugs). Schematic is as follows: 

The complete setup will look like this:

Raspberry Pi Setup

1. Prepare an SD Card with a 64-Bit version of Raspberry OS Lite(Bookworm being the latest, We Don't Need a GUI). Don't forget to configure SSH and WiFi if you plan to use it. You can also use an additional USB/Ethernet dongle instead of Wifi (you'll need an available ethernet port to connect to the Cisco Router either way).
2. Update/Upgrade the OS after boot:

   sudo apt get update && sudo apt upgrade
   reboot

3. Download and run the following configuration script. This will create the bridging interface, and add you to the ZeroTier network: 

   wget https://ecooper.co.uk/TPC/CiscoPiSetup.sh | sudo bash

4. Connect the USB-Ethernet dongle if needed, and reboot. Connect the Cisco Router FastEthernet0/0 port to the dongle, and your WAN network to the Pi's onboard jack (or to the main Pi Ethernet jack if you're using Wifi to get online).
   
   
   

   Sometimes the Pi will pick either the internal Eth or the Dongle Eth to be Eth0. If you notice that you cannot get a connection via your LAN to the Pi, try swapping the connection to the Cisco over.

Cisco Router Setup

1. Connect your computer to the Console port of the router (via either an USB/RS232 adapter or a native DB9 port if you're lucky enough to still have one). Open up your favourite terminal program (I personally use putty) at 9600 baud. 
2. Follow these steps to reset your router to factory defaults.
3. Once you finish step 8 on this before-mentioned guide, type "no" then enter. 
4. Check your Firmware Version:

   show version
   Cisco IOS Software, C2600 Software (C2600-IPBASEK9-M), Version 12.4(12), RELEASE SOFTWARE (fc1) is Required

5. If you see any other version than what's mentioned above, reach out to one of the Core Network Team to update it. 
6. Open the Cisco Router config file you received (see "Prep Work") and copy its content (Ctrl+C). Enable the console and enter configuration mode: 

   config t
   Ctrl+V (paste)
   end
   write mem

7. Once done, you should be able to ping the Core via:

   ping 192.168.250.254

8. Almost there! If for some reason your FastEthernet0/0 interface didn't go up, type: 

   config t
   int Fast0/0
   no shutdown
   end
   write mem

Option 2 - icE1usb interface

Please read article FrameRelay-over-E1 Daemon (FRED)

After FRED install please edit /opt/FRED/default.env and run following command:

sudo /opt/FRED/dimetra-setup.sh

EBTS Site Controller

1. Connect a USB/RS232 (or native DB9, again) from your computer to the service access port of the TSC. Open up BTS Service Software (aka TESS), select Dimetra 5.2. Password is sys*mgr. Under Configuration ==> Direct Settings, make sure you selected the right COM Port. 
2. Select Connection ==> Connect Direct. Turn on the TSC and wait for it to boot up completely. If it's already on, just press on enter, you should get a prompt for a user/password. Defaults should be factory/factory. 
3. Select Upload Configuration, and download the latest file from the Site Controller. Once done, close the connection via Connection ==> Close Connection.
4. Open the TSC Configuration file you just pulled via File ==> Open. Edit the Site Configuration via Personality ==> Modify. Click on "Edit Site Controller"
5. From the Core Team, you should have received the following data: Site ID, BTS IP Address, PVC Primary, PVC Backup and Network Mgr IP Address. Make sure you have them close by, you'll need them now.
6. Check your configuration matches the screenshots below, and copy over your site-specific data: 

   

    

   

   

    

    

   

    

7. Once you're finished, double check everything. Save the file, and reconnect to the TSC (Connection ==> Connect Direct). 
   
8. Click on Connection ==> Send Files. Select "Configuration Files" and select the file you just saved. In the “File Download” window, enter a version label, check “Use Next” and click on “Update Selected Items”. Press OK to start the transfer. You'll get a prompt to select which configuration file to replace. Select the one with all the minus signs.
10. Remember when uploading the new configuration to update the "Use Next" Flag
12. Reset the TSC by issuing the "reset" command on the terminal. Wait for the reboot, and log yourself in again (with factory/factory)
13. Type the following commands to enable Site Link: 

    .sitelink -e1
    .e1config -crdStart 1 -crd 31 -ts16Skip off -portNo 1 -crc on
    reset

14. After reboot, your TSC should now be connected to the Core Network! Enjoy :)

Final Steps

Once you have connected your BTS to the Core Network, Please go to https://map.tetrapack.online and register your user.
When an admin approves your user, you can log in and add your BTS to the map!

You will need the following information available when registering your BTS:
Zerotier Client ID: you will get this when setting up your Pi for Either Cisco or FRED configuration. 
TX Frequency
RX Frequency
Duplex Table
Duplex Spacing

Once the BTS is approved by an Admin it will appear automatically on our BTS Map!

Cable Management Mod for Option 1

I found it quite convenient to put the Pi inside the empty Primary Network Module slot. A small mounting plate with double sided tape, another one for the USB/Eth dongle, and it's already much cleaner! 

Bonus points if you use the Cisco Router's power supply to supply 5V to the Pi! Just solder a couple of wires on the edge card connector at the front of the router's mainboard. Leftmost pin is GND, then 12V (don't solder there!) then 5V. Double and triple check with a multimeter before hooking the Pi up. 

Pins 2 and 6 on the Pi can respectively be used as 5V and GND. An old servo connector does the job quite well! 

Dummy

Intro

• Gateway software to run on on-site E1 connection (see article E1/T1 Interface)
• Transmits application-level messages between CTS E1 and TetraPack Core
• Decodes/encodes full signalling stack:
  • E1 handler  \
  • HDLC FSM  - (normally done by IC on BSC411 board)
  • Q.921 FSM  /
• Inter-site Connect transport including priority management (normally done by ISCD2.EXE)
• Decodes/encodes E1 and pre-buffer carrier streams (normally done by BSC411/TR412 boards)
• Partially emulates BSS.EXE/GWS.EXE (presence / status updates)
• VTUN over E1 between CTS and host (does not forward to the server)
• Uses the same bss3.txt configuration file as a base-station
• Has additional D-BUS API to pass specific data types such CTS logs to the server
• Debian 11 arm64 or amd64, tested on Raspberry Pi 3*, CM4 and Intel x64 PC
• Typical IP bandwith 4-100 Kbits/sec

* Some revisions of Raspberry Pi 3 have issues with icE1usb connection stability due to USB NIC

P2-TP-Feb2023.pdf

Configuration

Default configuration file is /opt/TetraPack/default.env

# E1D interface and line in format [interface number].[line number]
DUMMY_LINE=0.0

# Path to CTS topology file (bss.txt or bssparams.txt)
DUMMY_TOPOLOGY=/opt/TetraPack/bssparams.txt

# IP address and mask for CTS VTUN interface
DUMMY_NETWORK="192.168.0.8 mask 255.255.255.0"

# Specific options (multiple values can be delimited with comma):
# replace-forwarded-link-status - replace IP-forwarded status for both E1 lines status of local BSs/GWPC to up
# emulated-bs-line1-down        - set E1-1 status of emulated BS to down
# emulated-bs-line2-down        - set E1-2 status of emulated BS to down
# emulated-gwpc-line1-down      - set E1-1 status of emulated GWPC to down
# emulated-gwpc-line2-down      - set E1-2 status of emulated GWPC to down
DUMMY_OPTION=

# Server connection URI in format http(s)://[user]:[password]@[address]/[path and parameters]
# If you care about securely stored password, please put credentials into /opt/TetraPack/.netrc (man netrc)
DUMMY_CONNECTION="http://xxxxxx:password@core.tetrapack.online:8081/dummy/?emulation=bs+gwpc"

# Instance name for D-BUS IPC interface
DUMMY_INSTANCE=default

Connection URL

Parameters:

• emulation
  • bs - tells Core to emulate basestation, required to deliver group and private calls. Emulated basestation will use ID from topology file (/base-station/base-station-id)
  • gwpc - tells Core to emulate GWPC, required to forward SMS, location, etc. Please don't use if you have GWPC on-site

Topology

bssparams.txt is used to map CTS system topology and E1 layout as well as a system configuration. Parameter /base-station/base-station-id is used as identifier of emulated basestation (identifier of GWPC is hardcoded in CTS).

A capacity (amount of concurrent calls) of emulated basestation depends on amount on configured virtual transceivers for this basestation. Capacity = [count of transceivers] * 4 - 1

Please keep in mind that due to specific of CTS system topology must me configured as a chain of nodes, connected end-to-end. For example if you have two physical BSs, topology file has to be configured in scheme BS1 <-> BS2 <-> emulated BS <-> emulated GWPC. Regarding to this scheme you have to have properly configured termination endpoint in the main configuration (.env):

# emulated-bs-line1-down        - set E1-1 status of emulated BS to down
# emulated-bs-line2-down        - set E1-2 status of emulated BS to down
# emulated-gwpc-line1-down      - set E1-1 status of emulated GWPC to down
# emulated-gwpc-line2-down      - set E1-2 status of emulated GWPC to down
DUMMY_OPTION=emulated-gwpc-line1-down

Multiple instances

You can have several separated CTS systems connected to one or more core servers (for example, production and test). For such case you need to have several .env files for each configuration. use sudo ./setup.sh install to register all instances.

Also it's possible to run dummy in command line - sudo ./run.sh <configuration.env>

CTS Log Collector

CTS Log Collector is an additional software for Dummy. It connects to CTS basestation via TCP to logging ports and forward log entries to locally installed dummy.

The need

CTS Log Collector does following important things:

• gets GSSI attachments (Scan List) information from logs and passes to the core - required to manage group routing  (no such data in signalling)
• passes log to logging server to simplify analysis of issues

Configuration

# [IP of basestation] [dummy instance name] [basestation ID (1-8)]
COMMAND_ARGUMENTS=10.0.0.1 default 1

MTS

Motorola's MTS Series of Tetra Base Stations are currently supported in TetraPack.

Installation

curl http://packages.tetrapack.online/install/tools/MTS/mts-setup.sh | sudo bash

CTS Updater

CTS Updater (update-cts.py) is a small script to upload and update CTS configuration or database remotely and without restart. Better to run it on the same Linux system where dummy runs.

Utility creates index data, starts specific embedded ftp server, connects to CTS and initiates update. After updating it stops.

Installation

sudo apt install python3-pip python3-pyftpdlib
sudo pip install telnetlib3

Please make sure, you don't use firewall between your CTS and Linux. Also please make sure you have no ftp servers run on Linux system or use port TCP 21.

Usage

$ sudo ./update-cts.py <IP-address of CTS> [db|cfg] <path to folder>

Exit codes:

• 0 - Success
• 1 - Error on Linux system
• 2 - Error on CTS system

Update database

$ ls db1/
sum-gm.csv sum-gp.csv sum-sc.csv sum-sub.csv
$ sudo ./update-cts.py 10.2.0.10 db db1 ; echo $?

Update configuration

$ ls -l cfg1/
bssparams.txt
$ sudo ./update-cts.py 10.2.0.10 cfg cfg1 ; echo $?

CTS

Motorola CTS-x00 is a series of basestations for CompactTETRA product line of Motorola. Literally its OEM-product of DAMM with software from Frequentis.

Following articles is about how to connect it to TetraPack:

• Setting up Dummy and LogCollector
• Dummy
• E1 Interface
• CTS Log Collector
• CTS Updater

 

Interfacing

E1/T1 Interface

Why not TDMoIP / CESoIP?

Usual E1/T1 over IP protocols use generic frames over IP transfer that makes more than 2 megabits constant rate with up to 8000 packets per second. That approach:

• not suitable for distributed sites with limited internet access
• makes constant parasite load on the servers
• requires delays to compensate jitters
• has issues with asynchronous-to-synchronous transition

Fur such kind of integrations we prefer to have our own agent software on-site with hardware E1/T1 interfaces.

• good timings driven by E1/T1 clock or GPS
• good framing due to synchronous composition on the site
• less traffic due to transfer only valuable demultiplexed information

icE1usb

We have chosen Osmocom icE1usb as a primary interface for our projects for several reasons:

• good compatibility with big range of hardware hosts due to use of USB
• in opposite to most of DAHDI interfaces it is in production
• open-source hardware design
• open-source user-space driver, no need for the kernel driver
• suitable API for our purposes (at least full-frame mode)
• available at Sysmocom's web shop

User manual can be found here.

NOTICE

Please be careful! Or your device will be damaged! Front-panel RJ45 connectors accepts 120 Om E1. Back-panel RJ45 is for GPIO and accepts TTL only. Don't try to connect the device to Ethernet. USB-C port should be connected to computer, since it's just an interface. Minijack connector is only to reprogram firmware. Also please configure properly internal jumpers to master (NE) or slave (NT) E1 mode.

PLEASE READ USER MANUAL FIRST.

Hardware configuration

Almost in all our cases you need this interface in NT (Network Termination) mode. In this mode the interface works as a network side and you can use a normal Ethernet cable for connection (no crossing required).

To change the mode, unscrew the 2 PH0 screws on the side with the 2 RJ45 jacks. You’ll also need to unscrew the nut on the SMA jack on the other side. After that, the cover plate and rubber gasket around the 2 RJ45 jacks can be removed. The PCB can be slid out of the case.

Then swap the jumpers so they match this picture:

Driver installation

You can get Osmocom E1D from Osmocom's Debian repository (amd64, arm64). 

sudo apt install extrepo
sudo extrepo enable osmocom-latest
sudo apt update
sudo apt install -y osmo-e1d

Driver configuration

/etc/osmocom/osmo-e1d.cfg

log syslog daemon
 logging level force-all fatal
e1d
 interface 0 icE1usb
  usb-serial [interface serial number]
  line 0
  line 1

More information about logging section can be found here, here and here.
(If you care about configuration file format, please check the sources here).

How to find a serial number of connected icE1usb:

sudo lsusb -d 1d50:6145 -v 2> /dev/null | grep iSerial

Reload a service:

sudo systemctl restart osmo-e1d

You can also test your configuration from the command line:

sudo osmo-e1d -c /etc/osmocom/osmo-e1d.cfg

Recomended settings

/etc/rsyslog.d/99-e1d.conf 

if ($programname contains "osmo-e1d") and (($msg contains "Received Only 0 bytes") or ($msg contains "TS read underflow")) then {
  ~/dev/null
  stop
}

/etc/systemd/system/osmo-e1d.service.d/override.conf

[Service]
TimeoutStopSec=2s

Issues with the second E1 port

Please note that on many XHCI host controllers there seem to be implementation flaws in the XHCI host controller firmware preventing the activation of both icE1usb ports simultaneously. The XHCI controller firmware erroneously claims that there is insufficient bus bandwidth. However, the same icE1usb hardware/firmware works perfectly fine with OHCI, UHCI and EHCI host controllers. See https://osmocom.org/projects/e1-t1-adapter/wiki/Isochronous_USB_Issues for a user-maintained list of USB hosts / controllers and whether or not they work with two E1 ports.

In most installations it's not a real issue, because of need in a single port only.

We have tested it with following equipment:

• Raspberry Pi 3, 4, CM4 - only first E1 port is working 
• Raspberry Pi 5 - both E1 ports are working when connected to blue USB port

FrameRelay over E1

FrameRelay-over-E1 Daemon (FRED)

Intro

• Gateway software to run on on-site E1 connection (see article E1/T1 Interface)
• Bridges IPv4/IPv6/Ethernet packets between Linux kernel and FrameRelay over E1 (RFC 2427, RFC 2590)
• Suitable to connect Motorola EBTS (can be used instead of Cisco routers with E1 card installed)
• Supports FRF.12 (inner and outer) fragmentation for incoming traffic (Frame Relay -> Linux)
• Implements basic DCE-PVC LMI with support of ITU-T Q.933-A, ANSI T1.617-D, GOF (automatic detection)
• Acts via TUN/TAP network interfaces (one per DLCI) on Linux side
• Debian 12 arm64 or amd64, tested on Raspberry Pi CM4, Raspberry Pi 5

Installation

sudo apt install extrepo
sudo extrepo enable osmocom-latest
curl http://packages.tetrapack.online/install/tools/Debian/add-repository.sh | bash
sudo apt install -y osmo-e1d fred

Configuration

Default configuration file is /opt/FRED/default.env

#
# Parameters for FRED binary
#

# E1D interface and line in format <interface number>.<line number>
FRED_LINE=0.0

# E1 slot list in format <first slot>-<last slot>
FRED_SLOT_LIST=1-31

# FrameRelay feature list in format <option>[,...]
# FRF.12-OUTER - outer frame sequence counting and fragmentation (incoming frames only supported)
FRED_FEATURE_LIST=

# DLCI list in format <DLCI>:<type>[,...]
# LMI-DCE-PVC
# IP  - IP bridge (RFC 2427 for IPv4, RFC 2590 for IPv6)
# ETH - Ethernet bridge (RFC 2427)
FRED_DLCI_LIST=0:LMI-DCE-PVC,16:IP,17:IP

# Path to configuration script to manage IP interface configuration on up and down
FRED_SCRIPT=./dimetra-hook.sh

#
# Parameters for dimetra-hook.sh
#

# Zone ID
DIMETRA_ZONE=1

# Local Site ID
DIMETRA_SITE=12

# FrameRelay DLCIs
DIMETRA_DLCI_PRIMARY=16
DIMETRA_DLCI_SECONDARY=17

# When set, routes will be added to FRR's OSPF prefix list
FRR_PREFIX_LIST=dimetra

Use with Dimetra

FRED package includes prepared scripts to establish connection between EBTS and Dimetra MPVPN network. 

sudo /opt/FRED/dimetra-setup.sh

Best settings for EBTS TSC will be:

.sitelink -e1
.e1config -crdStart 1 -crd 31 -ts16Skip off -portNo 1 -crc on
reset

Multiple instances

You can have several separated systems connected to a local Linux system. For such case you need to have several .env files for each configuration. use sudo ./setup.sh install to register all instances.

Also it's possible to run FRED in command line - sudo ./run.sh <configuration.env>

Detroit (DMR -TETRA) Bridge

Radio Settings

Specific setting for bridged individual calls

It's recommended to use these settings on the TETRA radio to have better user experience on TETRA side

• PTT Call Back Timer - Disabled
  (respond for initial delay on call DMR->TETRA)
• Hook Method for Outgoing Simplex Individual Call - Direct
  (respond only for transmitted call properties, the bridge is tolerant to this setting)
• Preferred Hook Method for Incoming Simplex Individual Call - Direct
  (allows TETRA radio to hook a call automatically - DMR side doesn't know about when the call hooked)

Specific setting for bridged group calls

It's recommended to use these settings on the TETRA radio to have better user experience on TETRA side

• PTT during Received Group Call - Enabled
  (allows to transmit to group without waiting, suitable for busy groups)

Location reporting

Core supports LIP and NMEA reports over SDS. Typical ISSI is xxx999 (same as in DMR), where xxx is a MCC of connected core.

Server Bridging

Asterisk PBX

Disclaimer

• TransitBridge is only available on the same host as TetraPack Core, so the target of this document is a server administrator. Other Asterisk systems can be connected to transit Asterisk system via IAX2, SIP, etc.

• TransitBridge (as well as DetroitBridge) is plug-and-play, no extra configuration required.

• TransitBridge channel driver uses only default dialplan context. Please use GotoIf or Lua.

• Some TETRA Systems (at least CTS) don't support external numbers (PSTN on PABX) for messaging.

• Some TETRA Systems (at least CTS) don't support PABX calls (PSTN or ISSI only).

Modules

• codec_pack.so - TETRA codec definitions and translations, uses our own library CodecPack.so
• chan_transit.so - TransitBridge channel driver

Environment variables

CODECPACK=/<path>/CodecPack.so

asterisk.conf

[options]
systemname = <numeric ID of local system>

Dialplan

Outbound calls

Dial(Transit/<Core ID>/<ISSI>[/<options>])

Where options are:

• s - Use simplex call with PTT control (RADIO_KEY/RADIO_UNKEY, see app_rpt)
• t - Use PSTN call (source ISSI 16777184, CALERID(num) is passed as an external number)
• b - Use PBX call (source ISSI 16777186, CALERID(num) is passed as an external number)
• n<ISSI> - Use specified source ISSI and pass CALLERID(num) as an external number
• c<0-3> - Use service number 0-3 (at this moment only 0 / ACELP is supported)
• p<0-15> - Set call priority

By-default duplex individual call with ACELP (0) and normal priority (0) will be created.

Example:

Dial(Transit/2505/${EXTEN}/t)

Inbound calls

Channel variables:

• TRANSIT_TYPE=ISSI - Extension ID contains destination ISSI
• TRANSIT_TYPE=Number - Extension ID contains destination external number
• TRANSIT_FLOW=PTT - Simplex call
• TRANSIT_ISSI=<ISSI> - Destination ISSI
  (only when TRANSIT_TYPE=Number, should contain 16777184 for PTSN call or 16777186 for PBX call)
• TRANSIT_PRIORITY=<0-15> - Call priority

Outbound messages

MessageSend(Transit:<Link ID>[/<Destination ISSI>][,<Source ISSI>[ <External Number>]])

Please keep your eyes on formatting. There no spaces in <to> section, no space after comma in <from> section and only single space between source ISSI and external number.

Channel variables:

• MESSAGE(to)=<ISSI>
• MESSAGE(from)=<ISSI>
• MESSAGE(body)=<Text>
  
• MESSAGE_SEND_STATUS - Will be set to SUCCESS, when the message accepted by the basestation (TNSDS-REPORT result=0), timeout is 500 milliseconds.

  Asterisk API said, it corresponds to message enqueuing, not delivery, but we have a bit more. :)

Inbound messages

Channel variables:

• MESSAGE(to)=<ISSI/External Number>
• MESSAGE(from)=<ISSI>
• MESSAGE(body)=<Text>
• MESSAGE_DATA(TRANSIT_TYPE)=ISSI - Extension ID and MESSAGE(to) contain destination ISSI
• MESSAGE_DATA(TRANSIT_TYPE)=Number - Extension ID and MESSAGE(to) contain destination external number
  
• MESSAGE_DATA(TRANSIT_ISSI)=<ISSI> - Destination ISSI
  (only when MESSAGE_DATA(TRANSIT_TYPE)=Number, should contain 16777184 for PTSN call or 16777186 for PBX)

TransitBridge sends delivery report when terminal requested that. Delivery status depends on the status of dialplan proceeding.

Technical Information

Channel ID format

Transit/<Link ID>:<Session UUID>

• Link ID - decimal TetraPack Core instance identifier
• Session UUID - global call session UUID, used in TetraPack Core and BrandMeister Core (in lower case)

Specific Hangup-Cause codes

Transit <TETRA disconnect-cause code>

Get TETRA disconnect-cause codes at Table 14.55 in ETSI EN 300 392-2 V3.8.1. Read more about Hangup Cause here.

Dialplan example

exten => 9XXXXXXX,1,Dial(Transit/2505/${EXTEN:1}/t)
same  => n,NoOp(Disconnect Cause: ${HANGUPCAUSE(${HANGUPCAUSE_KEYS()},tech)})
same  => n,HangUp()
exten => 16777184,1,NoOp(Incoming message)
same  => n,NoOp(From: ${MESSAGE(from)})
same  => n,NoOp(To: ${MESSAGE(to)})
same  => n,NoOp(Body: ${MESSAGE(body)})
same  => n,NoOp(TRANSIT_TYPE: ${MESSAGE_DATA(TRANSIT_TYPE)})
same  => n,MessageSend(Transit:2505/${MESSAGE(from)},16777184 911)
same  => n,NoOp(Message send status: ${MESSAGE_SEND_STATUS})

SVXLink

SVXLink sources

• https://github.com/dl1hrc/svxlink/tree/tetra-contrib/ - Custom version that passes ISSIs through SVXReflector, it also has our patches applied to SVXReflector and ReflectorLogic.
• https://github.com/sm0svx/svxlink/ - Original version

Note for owners of SVXLink nodes running TetraLogic

• Please use latest version of SVXLink software.

• Please use the same CALLSIGN in [ReflectorLogic] and [TetraLogic] to make our bridges pass talker ISSI correctly.

Note for owners of SVXReflector servers for TETRA

• Please use latest version of SVXReflector (at least 16082023) software.

• Reflector to Reflector links does not pass originating ISSI.

Administrating SVXLink bridges

Disclaimer about information bellow

• DockStation is only available on the same host as TetraPack Core, so the target of following information in this article is a server administrator.
  

• DockLogic is an external Logic module is supplied outside SVXLInk.

Modules

• DockLogic.so - SVXLink Logic module that implements our own Dock IPC protocol, uses our own library CodecPack.so
• DockLogic.tcl - Supplementary script, required by SVXLink

Environment variables

CODECPACK=/<path>/CodecPack.so

svxlink.conf

[GLOBAL]
MODULE_PATH=/opt/SVXLink/lib/svxlink
CFG_DIR=/opt/SVXLink/etc/svxlink/svxlink.d
LOGICS=DockLogic,ReflectorLogic
LINKS=Link
TIMESTAMP_FORMAT="%c"

# Should be always 8 KHz!
CARD_SAMPLE_RATE=8000

[DockLogic]
TYPE=Dock
RX=Rx1
TX=Tx1
CALLSIGN=<Node call, should be completely the same as ReflectorLogic has>
EVENT_HANDLER=/opt/SVXLink/share/svxlink/events.tcl

# TetraPack Core IPC socket path
SOCKET=/tmp/Dock-<TetraPack Core ID>

# GSSI at TetraPack Core
GSSI=<GSSI of talk group at TetraPack>

# Default ISSI (used when ISSI is unknown)
ISSI=9999

# MNI for Qso:info messages (4 digits for MCC and 5 digits for MNC)
MNI=090116383

[Rx1]
TYPE=Dock

[Tx1]
TYPE=Dock

# Delay (in 60 ms frames) in bridged call start (SVXLink -> TetraPack), required for ISSI detection heuristics 
DELAY=5

# Preprocessing: Gain -> AGC -> Suppressor -> Normalizer

# Gain BEFORE preprocessing (0.1 .. 1.0, default is 1.0)
GAIN=0.75

# AGC, value is AGC target
# Comment or remove to disable
# AGC=8000

# Suppressor:
# 0 - Berouti spectral subtraction
# 1 - Wiener scalar filtering
# 2 - Two-step scalar filtering
# 3 - Two-step scaler filtering with gain
# 4 - Two-step phishing filtering
# 5 - Two-step phishing filtering with gain
# Comment or remove to disable
SUPPRESSOR=0

# Normalize audio, including dynamic compression and DC correction
NORMALIZER=1

[ReflectorLogic]
TYPE=Reflector
HOSTS=<SVXReflector's DNS/IP address>
CALLSIGN="<Node call>"
AUTH_KEY="<Key>"
UDP_HEARTBEAT_INTERVAL=5
DEFAULT_TG=<Bridged SVXReflector's TG>
MONITOR_TGS=<Bridged SVXReflector's TG>
EVENT_HANDLER=/opt/SVXLink/share/svxlink/events.tcl
MUTE_FIRST_TX_LOC=0
MUTE_FIRST_TX_REM=0

[Link]
CONNECT_LOGICS=DockLogic,ReflectorLogic
DEFAULT_ACTIVE=1
TIMEOUT=0