Amarisoft Tech Academy

https://tech-academy.amarisoft.com/
Admin
Amarisoft Tech Academy is a comprehensive documentation and tutorial platform for Amarisoft's...
Tokens:1,527,154
Snippets:6,967
Trust Score:9
Update:11 months ago
Show doc for...
Tokens:
Raw
### Run UEsim Installation Script Interactively

Source: https://tech-academy.amarisoft.com/Install_UeSim

Executes the UEsim installation script without any options, prompting the user for input at each step to select components for installation. This method is useful for manual configuration.

```shell
./install.sh
```

--------------------------------

### Systemd Commands to Enable and Start pjsua Service

Source: https://tech-academy.amarisoft.com/ims_play_file

These commands are used to install, enable, and start the pjsua systemd service. They copy the service file, reload systemd, enable the service to start on boot, and then start it immediately. Execute these as root.

```bash
cp pjsua.service /lib/systemd/system/
systemctl -q --system daemon-reload
systemctl enable pjsua
systemctl start pjsua
```

--------------------------------

### UESim Tun Interface Setup

Source: https://tech-academy.amarisoft.com/QuickReference_Tutorial

Guide on setting up a Tun interface (IP interface) for individual UEs on UEsim.

```APIDOC
## UESim Tun Interface Setup

### Description
This guide explains how to set up a Tun interface, which provides an IP interface for individual UEs within the UEsim environment.

### Method
GET

### Endpoint
/websites/tech-academy_amarisoft/UESim_Tun.html

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
Documentation content for UESim_Tun.html

#### Response Example
```html
<html>
  <body>
    <h1>How to setup Tun interface (IP interface) for individual UEs on UEsim ?</h1>
    <!-- ... content ... -->
  </body>
</html>
```
```

--------------------------------

### Run UEsim Installation Script with Default Configuration

Source: https://tech-academy.amarisoft.com/Install_UeSim

Executes the UEsim installation script using the '--default' option, which automatically installs all components based on the default configuration without requiring user input. This is a streamlined installation process.

```shell
./install.sh --default
```

--------------------------------

### Start httpd Service

Source: https://tech-academy.amarisoft.com/OutOfBox_WebGui

Starts the httpd service after installation or if it has been stopped. This command is used to ensure the web server is running.

```shell
service httpd start
```

--------------------------------

### Example ltesat Configuration File Structure

Source: https://tech-academy.amarisoft.com/LteSat

An example of the general file format and syntax for ltesat configuration. The specific parameters vary based on test cases, but the overall structure remains consistent across Amarisoft products, typically starting with log options, communication addresses, and then detailed configuration parameters.

```text
log_options
com_addr
// Detailed configuration parameters...
```

--------------------------------

### UEsim Configuration Example (ue-nr-sa-open5gs.cfg)

Source: https://tech-academy.amarisoft.com/Cloud_open5gs

Shows a sample UE (User Equipment) configuration file for a 5G NR Standalone (SA) setup with Open5GS. This configuration includes USIM information, APN, and network slicing details to match Open5GS defaults.

```ini
### UE information configured in ue-nr-sa-open5gs.cfg which is copied and modified from ue-nr.cfg.
### I configured USIM information of open5gs UE DB to match with this configuration and I added apn, network slicing information to match with the default configuration of open5gs default network slice information.
```

--------------------------------

### Install websockets Python Package

Source: https://tech-academy.amarisoft.com/python_websocket_example

Installs the 'websockets' Python package required for the script. Ensure Python 3 and pip are installed and updated.

```bash
python3 -m pip install websockets
```

--------------------------------

### Customize Default UEsim Installation Options

Source: https://tech-academy.amarisoft.com/Install_UeSim

This demonstrates how to customize the default installation options for UEsim. By performing a manual installation and answering the prompts, the system stores your selections in '/root/lte-install' for future default installations.

```shell
# Perform manual installation
./install.sh

# Your selections are stored in /root/lte-install for future default installations.
```

--------------------------------

### Install opencore-amr

Source: https://tech-academy.amarisoft.com/Install_Pjsip

Compiles and installs the opencore-amr library. Requires downloading the source, configuring with a specific prefix, and then building and installing.

```bash
# Download and extract opencore-amr tarball
tar -xvf opencore-amr-*.tar.gz
cd opencore-amr-*

# Configure, build, and install
./configure --prefix=/root/siptrunk
make && make install
```

--------------------------------

### Create Installation Directory

Source: https://tech-academy.amarisoft.com/Install_Pjsip

Creates a dedicated directory for software installations. This command is fundamental for organizing installed packages.

```bash
mkdir -p /root/siptrunk
```

--------------------------------

### Initialize and Start SDR Device (C)

Source: https://tech-academy.amarisoft.com/resources/miniGen

This C code snippet initializes and starts the SDR device. It first opens the SDR device using `msdr_open` and then sets default start parameters using `msdr_set_default_start_params`. It configures global and per-RF port parameters, including sample rate, bandwidth, and channel counts. Finally, it calls `msdr_set_start_params` and `msdr_start` to apply the configuration and begin SDR operation. Error handling is included for device opening and parameter setting failures.

```c
s = msdr_open(args);
    if (!s) {
        fprintf(stderr, "msdr_open: could not open SDR device\n");
        exit(1);
    }
    msdr_set_default_start_params(s, params, sizeof(*params), tx_channel_count,
                                  rx_channel_count, rf_port_count);

    /* Global parameters */
    params->clock_source = clock_source;
    params->sync_source = sync_source;
    params->rf_port_count = rf_port_count;

    /* Per rf port */
    rf_ports = malloc(params->rf_port_count * sizeof(*rf_ports));
    memset(rf_ports, 0, params->rf_port_count * sizeof(*rf_ports));

    for (p = 0; p < params->rf_port_count; p++) {
        RFPort *rfp = &rf_ports[p];

        rfp->port_index = p;
        rfp->msdr_state = s;

        params->sample_rate_num[p] = sample_rate;
        params->sample_rate_den[p] = 1;

        /* 1 hyper frame at a time */
        rfp->buf_len = sample_rate / 1000;
        if (rfp->buf_len < 100)
            rfp->buf_len = 100;
        rfp->first_timestamp = 1;

        params->rx_port_channel_count[p] = rx_channel_count;
        for(i = 0; i < rx_channel_count; i++) {
            idx = params->rx_channel_count++;

            params->rx_freq[idx] = tx_freq;
            params->rx_gain[idx] = 0;
            params->rx_bandwidth[idx] = tx_bw;
            params->rx_antenna[idx] = 1;

            rfp->rx_buf[i] = vec_malloc(rfp->buf_len * sizeof(Complex));
        }

        params->tx_port_channel_count[p] = tx_channel_count;
        for (i = 0; i < tx_channel_count; i++) {
            idx = params->tx_channel_count++;

            params->tx_freq[idx] = tx_freq;
            params->tx_gain[idx] = tx_gain;
            params->tx_bandwidth[idx] = tx_bw;

            rfp->tx_buf[i] = vec_malloc(rfp->buf_len * sizeof(Complex));
        }
    }

    /* Start */
    ret = msdr_set_start_params(s, params, sizeof(*params));
    if (ret < 0) {
        fprintf(stderr, "msdr_set_start_params: invalid SDR parameters\n");
        exit(1);
    }
    ret = msdr_start(s);
    /* keep params for runtime commands */
    //msdr_release_start_params(params, sizeof(*params));
    if (ret < 0) {
        fprintf(stderr, "msdr_start: error\n");
        exit(1);
    }
    msdr_tx_gain_adjust(s, &tx_gain);

```

--------------------------------

### Callbox Configuration Example (gnb-sa-open5gs-cloud.cfg)

Source: https://tech-academy.amarisoft.com/Cloud_open5gs

Illustrates a sample gNB (Next Generation NodeB) configuration for a 5G NR Standalone (SA) setup targeting Open5GS in a cloud environment. This file is a modified version of a default gNB configuration file.

```ini
gnb-sa-open5gs-cloud.cfg is used as gNB configuration and it is copied and modified from gnb-sa.cfg.
```

--------------------------------

### Install Amari Callbox Software

Source: https://tech-academy.amarisoft.com/Install_Callbox

This command initiates the installation of the Amari Callbox software. The '--default' parameter automatically selects installer options, simplifying the process. Without it, manual selection is required.

```bash
./install.sh --default

```

--------------------------------

### Executing Amarisoft Installation Script

Source: https://tech-academy.amarisoft.com/install

This command executes the main installation script for Amarisoft. It can be run with various options. Running it without options installs components in /root by default. The '--default' option is for standard Callbox installation with Amarisoft SDR cards.

```bash
./install.sh
```

```bash
./install.sh --default
```

```bash
./install.sh --help
```

--------------------------------

### Install ltesat Tool from Tarball

Source: https://tech-academy.amarisoft.com/LteSat

Details the manual installation process for the ltesat tool, which is included in the installation package but not automatically installed. It involves extracting a specific tarball found within the main installation directory.

```bash
tar xzf tarball_name
```

--------------------------------

### Main SDR Application Execution Flow

Source: https://tech-academy.amarisoft.com/resources/miniGen

Initializes SDR parameters with defaults, parses command-line arguments to override them, sets up SDR device, initializes signal handling, generates TX signal data, starts RX/TX threads for each RF port, initiates a runtime user input thread, and finally shuts down the SDR device gracefully.

```c
int main(int argc, char **argv)
{

    int i, p, idx; 

    args = DEFAULT_ARGS;
    tx_freq = DEFAULT_TX_FREQ;
    sample_rate = DEFAULT_SAMPLE_RATE;
    tx_gain = DEFAULT_TX_GAIN;
    tx_channel_count = 1;
    rx_channel_count = 1;
    rf_port_count = 1;
    tx_bw = 0;
    sync_source = SDR_SYNC_NONE;
    clock_source = SDR_CLOCK_INTERNAL;

    for(;;) {
        c = getopt_long_only(argc, argv, "h", options, &option_index);
        if (c == -1)
            break;
        switch(c) {
        case 0:
            switch(option_index) {
            case 1: /* args */
                args = optarg;
                break;
            case 2: /* tx_freq */
                tx_freq = (int64_t)strtod(optarg, NULL);
                break;
            case 3: /* tx_gain */

```

--------------------------------

### Run Amarisoft LTE Installation Script

Source: https://tech-academy.amarisoft.com/Install_Callbox_MBMSGW

This snippet shows the execution of the main installation script for Amarisoft LTE. It initiates an interactive configuration process where users select components to install, configure network settings (NAT for IPv4/IPv6), and choose hardware options. The script handles package installations and service configurations.

```shell
[root@CBC-2023010100 2025-06-13]# ./install.sh Callbox Classic model found Fedora 34 found ************************************************************* * Installing Amarisoft LTE 2025-06-13 (2025-07-03 12:44:18) * ************************************************************* 1) Configuration You can exit install script during this step, nothing will be changed until next step * Do you want to install LTE automatic service ? Package screen may be installed. [Yn] y - Do you want to migrate your config files from current running version ? [Yn] y - Do you want to enable LTE automatic service ? [Yn] y - Do you want to use NAT for IPv4 ? [Yn] y - Do you want to use IPv6 ? [Yn] y - Do you want to use NAT for IPv6 ? [Yn] y - Do you want to turn hyperthreading off (we strongly recommand it) ? [Yn] y * Do you want to install EPC ? Package lksctp-tools may be installed. [Yn] y - Do you want to migrate your config files from current running version ? [Yn] y - Do you want to install IMS ? [Yn] y * Do you want to install eNB ? Package lksctp-tools may be installed. [Yn] y - Do you want to migrate your config files from current running version ? [Yn] y - Select TRX radio frontend: 1) s72 2) n2x0 3) b2x0 4) x3x0 5) n3x0 6) limeSDR 7) limeMini 8) sdr (default) 9) ip > 8 (sdr) - Do you want to use MIMO ? [yN] y * Do you want to install N3IWF ? Package lksctp-tools may be installed. [yN] n * Do you want to install UE simulator ? [yN] n * Do you want to install Spectrum viewer ? [yN] n * Do you want to install LTE probe ? [yN] n * Do you want to install LTE scanner ? [yN] n * Do you want to install Satellite utilities ? [yN] y - Do you want to start automatically ? [Yn] n * Do you want to install MBMS gateway ? Package lksctp-tools may be installed. [Yn] y  - Do you want to migrate your config files from current running version ? [Yn] y * Do you want to install Web interface ? Package apache php may be installed. and enable your web server. [Yn] y * Do you want to install license server ? [yN] n * Do you want to install LTE monitoring ? Package nodejs ssmtp may be installed. [Yn] y - Do you want to migrate your config files from current running version ? [Yn] y 2) Install LTE automatic service 3) Install Web interface 4) Install TRX sdr 5) Install EPC Configure IMS Migrate configuration files 103 config file(s) imported 6) Install eNB Use TRX sdr [TRX] Callbox Classic model found [TRX] Fedora 34 found [TRX] Skipping BTF generation for /root/trx_sdr-linux-2025-06-13/kernel/sdr.ko due to unavailability of vmlinux [TRX] Unload current SDR kernel module [TRX] Initialize SDR kernel module [TRX] * Install kernel module [TRX] * Use mapping: 0 1 [TRX] Devices: /dev/sdr0 /dev/sdr1 [TRX] Check firmwares [TRX] SDR board utilities version 2025-05-16, Copyright (C) 2012-2025 Amarisoft [TRX] Upgrading all sdr devices [TRX] -------------------------------- [TRX] sdr0 SDR50 sdr1 SDR50 [TRX] UpToDate UpToDate [TRX] [TRX] Total time: 2.0 s Migrate configuration files 632 config file(s) imported 7) Install MBMS gateway 8) Install Satellite utilities 9) Install LTE monitoring Migrate configuration files No config file(s) imported 10) Finalize LTE automatic service Migrate configuration files Warning, reference config file ots.default.cfg was modified It has been imported as ots.default.cfg.bak, you may report your changes manually 2 config file(s) imported Disable/stop service alsa-state Start service *************************** * Installation successful * ***************************
```

--------------------------------

### Configure and Test LTE Connection with UEsim

Source: https://tech-academy.amarisoft.com/QuickReference_Tutorial

This guide explains how to run the Amarisoft UEsim for an LTE connection without prior experience. It serves as a basic example for establishing an LTE connection.

--------------------------------

### Start and Stop Trace Logging (Bash)

Source: https://tech-academy.amarisoft.com/OutOfBox_SA

This command enables trace logging for debugging and monitoring network component interactions, particularly during the UE attach process. Running 't' starts the logging, and pressing Enter stops it, returning to the prompt. It's recommended to start logging before powering on the UE to capture the entire initial attach sequence, including PRACH attempts.

```bash
t
# Press [Enter] key to stop the trace logging
```

--------------------------------

### Initiate a Call from PJSIP UA

Source: https://tech-academy.amarisoft.com/LTE_VoLTE_Pjsip

This sequence of commands initiates a call from a PJSIP UA. The 'm' command starts the call initiation process, and the subsequent input prompts for the destination SIP URI. The example shows making a call to 'sip:602@192.168.4.1'.

```bash
m
sip:602@192.168.4.1
```

--------------------------------

### Install Network Monitor Component

Source: https://tech-academy.amarisoft.com/OutOfBox_Monitor

To install the Network Monitor component, you need to use the '--monitor' option when installing the callbox software. This is a prerequisite for using the monitor functionalities.

```bash
callbox software --monitor
```

--------------------------------

### Enable and Start DNS Proxy Service

Source: https://tech-academy.amarisoft.com/vowifi_support

Enables the named service to start automatically on boot and then starts the service immediately. This ensures the DNS proxy is active and running.

```bash
systemctl enable named.service 
systemctl start named.service 
```

--------------------------------

### Install vo-amrwbenc

Source: https://tech-academy.amarisoft.com/Install_Pjsip

Compiles and installs the vo-amrwbenc library, another component for AMR support. Similar to opencore-amr, it involves extraction, configuration, building, and installation.

```bash
# Download and extract vo-amrwbenc tarball
tar -xvf vo-amrwbenc-*.tar.gz
cd vo-amrwbenc-*

# Configure, build, and install
./configure --prefix=/root/siptrunk
make && make install
```

--------------------------------

### Install PJSIP with AMR Support

Source: https://tech-academy.amarisoft.com/Install_Pjsip

Builds and installs the PJSIP application, enabling AMR codec support via the --with-opencore-amr configuration flag. This involves dependency checks, cleaning, and building.

```bash
# Download and extract PJSIP tarball
tar -xvf pjsip-*.tar.gz
cd pjsip-*

# Configure, build, and install
./configure --with-opencore-amr=/root/siptrunk
make dep && make clean && make
```

--------------------------------

### Install bind-chroot Package

Source: https://tech-academy.amarisoft.com/vowifi_support

Installs the bind-chroot package, which is necessary for creating a DNS proxy server. This is a prerequisite for the subsequent DNS proxy configuration steps.

```bash
dnf install bind-chroot
```

--------------------------------

### Verify Installed Release Directory Structure

Source: https://tech-academy.amarisoft.com/Install_Callbox_MBMSGW

This command lists the contents of the installation directory, typically '/root', to verify that the Amarisoft LTE components have been installed correctly. It checks for the presence of key subdirectories such as enb, mme, ue, ots, and trx_ip, confirming the successful deployment of the software.

```shell
ls /root
```

--------------------------------

### Print Default SDR Configuration and Setup Signal Handling (C)

Source: https://tech-academy.amarisoft.com/resources/miniGen

This C code snippet prints the default SDR configuration parameters to the console and sets up signal handling for interrupt signals (SIGINT). It formats and displays values such as transmit frequency, sample rate, channel count, gain, bandwidth, sync source, and clock source. The `signal` function is used to register a handler (`intHandler`) for SIGINT, allowing for graceful program termination. Dependencies include standard C libraries for input/output and signal processing.

```c
printf("[Default] tx_freq=%0.3f MHz \n[Default] sample_rate=%0.3f MHz \n[Default] channels=%d\n"
           "[Default] tx_gain=%0.1f dB \n[Default] tx_bandwidth=%0.3f MHz\n"
           "[Default] sync_source=%s \n[Default] clock_source=%s\n",
           tx_freq / 1e6, sample_rate / 1e6, tx_channel_count,
           tx_gain, tx_bw / 1e6,
           sync_source_str[sync_source],
           clock_source_str[clock_source]);

    keep_running = 1;
    signal(SIGINT, intHandler);
    
    //GenerateQAM(rf_ports[0].tx_buf[0], rf_ports[0].buf_len, 256);

    
    for (p = 0; p < rf_port_count; p++) {
        RFPort *rfp = &rf_ports[p];

```

--------------------------------

### Configure Network Interface Setup Script and Algorithms

Source: https://tech-academy.amarisoft.com/config/ltemme/mme-ims-1_DualSim_DSDS

Specifies the script to be executed for network interface setup and the preferred NAS ciphering and integrity algorithms. The setup script receives parameters for interface configuration, while algorithm preferences define security protocols.

```json
  /* Setup script for the network interface.
     If no script is given, no network interface is created.
     Script is called for each PDN with following parameters:
        1) Interface name
        2) PDN index
        3) Access Point Name
        4) IP version: 'ipv4' or 'ipv6'
        5) IP address: first IP address for ipv4 and link local address for IPv6
        6) First IP address
        7) Last IP address
  */
  tun_setup_script: "mme-ifup",

  /* NAS ciphering algorithm preference. EEA0 is always the last. */
  nas_cipher_algo_pref: [ ],
  /* NAS integrity algorithm preference. EIA0 is always the last. */
  nas_integ_algo_pref: [ 2, 1 ],

  /* user data base */
  include "ue_db-ims-dsds-1_DualSim_DSDS.cfg",
}
```

--------------------------------

### Install iperf on Ubuntu

Source: https://tech-academy.amarisoft.com/throughput

Command to install the iperf tool on Ubuntu systems, essential for network throughput analysis.

```bash
sudo apt-get install iperf
```

--------------------------------

### Start pjsua SIP Client

Source: https://tech-academy.amarisoft.com/ims_play_file

This command launches the pjsua SIP client using the specified configuration file. It assumes you are in the pjproject source directory and have `pjsua.cfg` and `test.wav` present. Adjust paths if necessary.

```bash
./pjproject-2.10/pjsip-apps/bin/pjsua-x86_64-unknown-linux-gnu --config-file=pjsua.cfg
```

--------------------------------

### OutOfBox UEsim SA

Source: https://tech-academy.amarisoft.com/QuickReference_Tutorial

Guide on how to run Amarisoft UEsim for NR SA connections without prior experience.

```APIDOC
## OutOfBox UEsim SA

### Description
This guide explains how to run the Amarisoft UEsim with a NR SA connection as an example, intended for users with no prior experience.

### Method
GET

### Endpoint
/websites/tech-academy_amarisoft/OutOfBox_UEsim_SA.html

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
Documentation content for OutOfBox_UEsim_SA.html

#### Response Example
```html
<html>
  <body>
    <h1>How to run Amarisoft UEsim without any experience (NR SA connection as an example) ?</h1>
    <!-- ... content ... -->
  </body>
</html>
```
```

--------------------------------

### RRC Setup - Uplink Configuration (PUSCH)

Source: https://tech-academy.amarisoft.com/NR_SA_ULMIMO

Example of the RRC Setup message from gNB, specifically detailing the `uplinkConfig` for PUSCH. It shows configurations for `maxRank`, `n_layer`, and SRS, crucial for UL MIMO operation.

```asn1
message c1: rrcSetup: {
...
    uplinkConfig {
      initialUplinkBWP {
        pucch-Config setup: {
...
        },
        pusch-Config setup: {
          txConfig codebook,
          dmrs-UplinkForPUSCH-MappingTypeA setup: {
            dmrs-AdditionalPosition pos1,
            transformPrecodingDisabled {
            }
          },
          pusch-PowerControl {
...
          },
          resourceAllocation resourceAllocationType1,
          codebookSubset nonCoherent,
          maxRank 4,
          uci-OnPUSCH setup: {
...
          }
        },
...
      },
...
    }
...
}
```

--------------------------------

### RRC Setup Message Example (SA)

Source: https://tech-academy.amarisoft.com/NR_SA_SRS

This snippet illustrates a sample RrcSetup message sent by gNB to configure NR SA. It includes various Radio Bearer and Cell Group configurations. Note that the specific values are examples and may vary based on test requirements.

```text
message c1: rrcSetup: {
    rrc-TransactionIdentifier 0,
    criticalExtensions rrcSetup: {
        radioBearerConfig {
            ...
        },
        masterCellGroup {
            ...
        },
        mac-CellGroupConfig {
            ...
        },
        physicalCellGroupConfig {
            pdsch-HARQ-ACK-Codebook dynamic
        },
        spCellConfig {
            spCellConfigDedicated {
                initialDownlinkBWP {
                    pdcch-Config setup: {
                        ...
                    },
                    pdsch-Config setup: {
                        ...
                    },
                    firstActiveDownlinkBWP-Id 0
                },
                uplinkConfig {
                    initialUplinkBWP {
                        pucch-Config setup: {
                            ...
                        },
                        pusch-Config setup: {
                            ...
                        },
                        srs-Config setup: {
                            srs-ResourceSetToAddModList {
                                {
                                    srs-ResourceSetId 0,
                                    srs-ResourceIdList {
                                        0
                                    },
                                    resourceType aperiodic: {
                                        aperiodicSRS-ResourceTrigger 1,
                                        slotOffset 4
                                    },
                                    usage codebook,
                                    p0 -84,
                                    pathlossReferenceRS ssb-Index: 0
                                }
                            },
                            srs-ResourceToAddModList {
                                {
                                    srs-ResourceId 0,
                                    nrofSRS-Ports port1,
                                    transmissionComb n2: {
                                        combOffset-n2 0,
                                        cyclicShift-n2 7
                                    },
                                    resourceMapping {
                                        startPosition 1,
                                        nrofSymbols n1,
                                        repetitionFactor n1
                                    },
                                    freqDomainPosition 0,
                                    freqDomainShift 5,
                                    freqHopping {
                                        c-SRS 11,
                                        b-SRS 3,
                                        b-hop 0
                                    },
                                    groupOrSequenceHopping neither,
                                    resourceType aperiodic: {
                                    },
                                    sequenceId 500
                                }
                            }
                        }
                    },
                    firstActiveUplinkBWP-Id 0,
                    pusch-ServingCellConfig setup: {
                    }
                },
                pdcch-ServingCellConfig setup: {
                },
                pdsch-ServingCellConfig setup: {
                    nrofHARQ-ProcessesForPDSCH n16,
                    maxMIMO-Layers 2
                },
                csi-MeasConfig setup: {
                    ...
                },
                tag-Id 0
            }
        }
    }
}
```

--------------------------------

### RrcResume Message to Setup RRC (SA)

Source: https://tech-academy.amarisoft.com/NR_RrcInactive

This RrcResume message is sent by the gNB to establish the RRC connection, similar to an RRC Setup message. It carries necessary radio protocol parameters to re-establish the call connection. Note that IE values are examples and may vary.

```SA
message c1: rrcResume: {
  rrc-TransactionIdentifier 0,
  criticalExtensions rrcResume: {
    radioBearerConfig {
      ..
    },
    masterCellGroup {
      cellGroupId 0,
      rlc-BearerToAddModList {
        ..
      },
      mac-CellGroupConfig {
        ..
      },
      spCellConfig {
        spCellConfigDedicated {
          uplinkConfig {
            initialUplinkBWP {
              pucch-Config setup: {
                ..
              },
              resourceToReleaseList {
                ..
              },
              schedulingRequestResourceToAddModList {
                ..
              }
            },
            srs-Config setup: {
              ...
            }
          }
        },
        csi-MeasConfig setup: {
          ...
        },
        tag-Id 0
      }
    }
  }
}
```

--------------------------------

### RemoteAPI Overview and Usage

Source: https://tech-academy.amarisoft.com/QuickReference_Tutorial

Introduction to Amarisoft's RemoteAPI and how to use it.

```APIDOC
## RemoteAPI Overview and Usage

### Description
This guide provides an overview of Amarisoft's RemoteAPI and details on how to effectively utilize its functionalities.

### Method
GET

### Endpoint
/websites/tech-academy_amarisoft/RemoteAPI.html

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
Documentation content for RemoteAPI.html

#### Response Example
```html
<html>
  <body>
    <h1>What is RemoteAPI and How to use it ?</h1>
    <!-- ... content ... -->
  </body>
</html>
```
```

--------------------------------

### RRC Setup Message Configuration (NR SA)

Source: https://tech-academy.amarisoft.com/NR_SA_PUCCH

This code snippet represents the RRC Setup message sent by a gNB to configure a User Equipment (UE) for NR SA. It includes detailed configurations for radio bearers, MAC, PDCCH, PDSCH, and PUCCH. Note that specific IE values are examples and should be adjusted based on test requirements.

```asn
message c1: rrcSetup: {
  rrc-TransactionIdentifier 0,
  criticalExtensions rrcSetup: {
    radioBearerConfig {
      srb-ToAddModList {
        {
          srb-Identity 1
        }
      }
    },
    masterCellGroup {
      cellGroupId 0,
      rlc-BearerToAddModList {
        {
          logicalChannelIdentity 1,
          servedRadioBearer srb-Identity: 1,
          mac-LogicalChannelConfig {
            ul-SpecificParameters {
              priority 1,
              prioritisedBitRate infinity,
              bucketSizeDuration ms5,
              logicalChannelGroup 0,
              schedulingRequestID 0,
              logicalChannelSR-Mask FALSE,
              logicalChannelSR-DelayTimerApplied FALSE
            }
          }
        }
      },
      mac-CellGroupConfig {
        schedulingRequestConfig {
          schedulingRequestToAddModList {
            {
              schedulingRequestId 0,
              sr-TransMax n64
            }
          }
        },
        bsr-Config {
          periodicBSR-Timer sf20,
          retxBSR-Timer sf320
        },
        tag-Config {
          tag-ToAddModList {
            {
              tag-Id 0,
              timeAlignmentTimer infinity
            }
          }
        },
        phr-Config setup: {
          phr-PeriodicTimer sf500,
          phr-ProhibitTimer sf200,
          phr-Tx-PowerFactorChange dB3,
          multiplePHR FALSE,
          dummy FALSE,
          phr-Type2OtherCell FALSE,
          phr-ModeOtherCG real
        },
        skipUplinkTxDynamic FALSE
      },
      physicalCellGroupConfig {
        pdsch-HARQ-ACK-Codebook dynamic
      },
      spCellConfig {
        spCellConfigDedicated {
          initialDownlinkBWP {
            pdcch-Config setup: {
              controlResourceSetToAddModList {
                {
                  controlResourceSetId 3,
                  frequencyDomainResources '111111110000000000000000000000000000000000000'B,
                  duration 1,
                  cce-REG-MappingType nonInterleaved: NULL,
                  precoderGranularity sameAsREG-bundle
                },
                {
                  controlResourceSetId 4,
                  frequencyDomainResources '000011110000000000000000000000000000000000000'B,
                  duration 1,
                  cce-REG-MappingType nonInterleaved: NULL,
                  precoderGranularity sameAsREG-bundle
                }
              },
              searchSpacesToAddModList {
                {
                  searchSpaceId 2,
                  controlResourceSetId 3,
                  monitoringSlotPeriodicityAndOffset sl1: NULL,
                  monitoringSymbolsWithinSlot '10000000000000'B,
                  nrofCandidates {
                    aggregationLevel1 n0,
                    aggregationLevel2 n4,
                    aggregationLevel4 n2,
                    aggregationLevel8 n1,
                    aggregationLevel16 n0
                  },
                  searchSpaceType ue-Specific: {
                    dci-Formats formats0-1-And-1-1
                  }
                },
                {
                  searchSpaceId 3,
                  controlResourceSetId 4,
                  monitoringSlotPeriodicityAndOffset sl1: NULL,
                  monitoringSymbolsWithinSlot '10000000000000'B,
                  nrofCandidates {
                    aggregationLevel1 n0,
                    aggregationLevel2 n4,
                    aggregationLevel4 n2,
                    aggregationLevel8 n1,
                    aggregationLevel16 n0
                  },
                  searchSpaceType ue-Specific: {
                    dci-Formats formats0-1-And-1-1
                  }
                }
              }
            },
            pdsch-Config setup: {
              dmrs-DownlinkForPDSCH-MappingTypeA setup: {
                dmrs-AdditionalPosition pos1
              },
              tci-StatesToAddModList {
                {
                  tci-StateId 0,
                  qcl-Type1: {
                    referenceSignal ssb: 0,
                    qcl-Type typeD
                  }
                }
              },
              resourceAllocation resourceAllocationType1,
              rbg-Size config1,
              prb-BundlingType staticBundling: {
                bundleSize wideband
              },
              zp-CSI-RS-ResourceToAddModList {
                {
                  zp-CSI-RS-ResourceId 0,
                  resourceMapping {
                    frequencyDomainAllocation row4: '100'B,
                    nrofPorts p4,
                    firstOFDMSymbolInTimeDomain 4,
                    cdm-Type fd-CDM2,
                    density one: NULL,
                    freqBand {
                      startingRB 0,
                      nrofRBs 108
                    }
                  },
                  periodicityAndOffset slots80: 1
                }
              },
              p-ZP-CSI-RS-ResourceSet setup: {
                zp-CSI-RS-ResourceSetId 0,
                zp-CSI-RS-ResourceIdList {
                  0
                }
              }
            }
          },
          firstActiveDownlinkBWP-Id 0,
          uplinkConfig {
            initialUplinkBWP {
              pucch-Config setup: {
                resourceSetToAddModList {
                  {
                    pucch-ResourceSetId 0,
                    resourceList {
                      0,
                      1,
                      2,
                      3,
                      4,
                      5,
                      6,
                      7
                    }
                  },
                  {
                    pucch-ResourceSetId 1,
                    resourceList {
                      8,
                      9,
                      10,
                      11
                    }
                  }
                },
                resourceToAddModList {
                  {
                    pucch-ResourceId 0,
                    startingPRB 105,
                    intraSlotFrequencyHopping enabled,
                    secondHopPRB 0,
                    format format1: {
                      initialCyclicShift 1,
                      nrofSymbols 14,
                      startingSymbolIndex 0,
                      timeDomainOCC 0
                    }
                  },
                  {
                    pucch-ResourceId 1,
                    startingPRB 105,
                    intraSlotFrequencyHopping enabled,
                    secondHopPRB 0,
                    format format1: {
                      initialCyclicShift 5,
                      nrofSymbols 14,
                      startingSymbolIndex 0,
                      timeDomainOCC 0
                    }
                  },
                  {
                    pucch-ResourceId 2,
                    startingPRB 105,
                    intraSlotFrequencyHopping enabled,
                    secondHopPRB 0,
                    format format1: {
                      initialCyclicShift 9,
                      nrofSymbols 14,
                      startingSymbolIndex 0,
                      timeDomainOCC 0
                    }
                  },
                  {
                    pucch-ResourceId 3,
                    startingPRB 105,
                    intraSlotFrequencyHopping enabled,
                    secondHopPRB 0,
                    format format1: {
                      initialCyclicShift 1,
                      nrofSymbols 14,
                      startingSymbolIndex 0,
                      timeDomainOCC 1
                    }
                  },
                  {
                    pucch-ResourceId 4,
                    startingPRB 105,
                    intraSlotFrequencyHopping enabled,
                    secondHopPRB 0,
                    format format1: {
                      initialCyclicShift 5,
                      nrofSymbols 14,
                      startingSymbolIndex 0,
                      timeDomainOCC 1
                    }
                  },
                  {
                    pucch-ResourceId 5,
                    startingPRB 105,
                    intraSlotFrequencyHopping enabled,
                    secondHopPRB 0,
                    format format1: {
                      initialCyclicShift 9,
                      nrofSymbols 14,
                      startingSymbolIndex 0,
                      timeDomainOCC 1
                    }
                  },
                  {
                    pucch-ResourceId 6,
                    startingPRB 105,
                    intraSlotFrequencyHopping enabled,
                    secondHopPRB 0,
                    format format1: {
                      initialCyclicShift 1,
                      nrofSymbols 14,
                      startingSymbolIndex 0,
                      timeDomainOCC 2
                    }
                  },
                  {
                    pucch-ResourceId 7,
                    startingPRB 105,
                    intraSlotFrequencyHopping enabled,
                    secondHopPRB 0,
                    format format1: {
                      initialCyclicShift 5,
                      nrofSymbols 14,
                      startingSymbolIndex 0,
                      timeDomainOCC 2
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### Systemd Service Unit File for pjsua

Source: https://tech-academy.amarisoft.com/ims_play_file

This systemd unit file (`pjsua.service`) defines how to manage the pjsua process as a service. It specifies dependencies, the command to start the service (linking to `pjsua.sh`), restart behavior, and user. Ensure the `ExecStart` path is absolute.

```ini
[Unit]
Description=PJSUA
Requires=lte.service
After=lte.service

[Service]
Type=simple
ExecStart=/data/sip/pjsua.sh
Restart=always
RestartSec=5
User=root

[Install]
WantedBy=multi-user.target
WantedBy=lte.service
```

--------------------------------

### Implement RemoteAPI in Python Text-Based Program

Source: https://tech-academy.amarisoft.com/QuickReference_Tutorial

This example demonstrates how to implement the Amarisoft RemoteAPI within a simple, text-based Python program. It serves as a basic starting point for script-based device control.

```python
import socket

def send_remote_api_command(command):
    host = '127.0.0.1'  # Or the IP of your Amarisoft device
    port = 5555         # Default RemoteAPI port

    try:
        with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
            s.connect((host, port))
            s.sendall(command.encode())
            response = s.recv(1024)
            return response.decode()
    except ConnectionRefusedError:
        return "Error: Connection refused. Is the RemoteAPI server running?"
    except Exception as e:
        return f"Error: {e}"

# Example usage:
command_to_send = "get version"
result = send_remote_api_command(command_to_send)
print(f"Command: {command_to_send}\nResponse: {result}")

command_to_send = "set tx_freq 2100000000"
result = send_remote_api_command(command_to_send)
print(f"Command: {command_to_send}\nResponse: {result}")

```

--------------------------------

### Power On UEsim

Source: https://tech-academy.amarisoft.com/TRX_IP

This command initiates the UEsim (User Equipment simulator) by powering it on. This is a prerequisite step before testing UE-related functionalities or observing network interactions from the UE's perspective.

```bash
power_on
```

--------------------------------

### Initialize Dummy TRX Start Process (C)

Source: https://tech-academy.amarisoft.com/TRX_API

This C function initializes the dummy start process for a TRX session. It validates RF port count, sets sample rate, TX/RX channel counts, and computes the initial RX timestamp. It also records the last display time. Dependencies include `TRXState`, `TRXDriverParams2`, `gettimeofday`, and `get_time_us`.

```c
static int trx_dummy_start(TRXState *s1, const TRXDriverParams2 *p) {
    TRXDummyState *s = s1->opaque;
    struct timeval tv;
    if (p->rf_port_count != 1) return -1; /* only one TX port is supported */
    s->sample_rate = p->sample_rate[0].num / p->sample_rate[0].den;
    s->tx_channel_count = p->tx_channel_count;
    s->rx_channel_count = p->rx_channel_count;
    gettimeofday(&tv, NULL);
    /* compute first RX timetamp in sample rate units */
    s->rx_timestamp = (int64_t)tv.tv_sec * s->sample_rate +  ((int64_t)tv.tv_usec * s->sample_rate / 1000000);
    s->last_disp_time = get_time_us();
    return 0;
}
```

--------------------------------

### OutOfBox UEsim LTE

Source: https://tech-academy.amarisoft.com/QuickReference_Tutorial

Guide on how to run Amarisoft UEsim for LTE connections without prior experience.

```APIDOC
## OutOfBox UEsim LTE

### Description
This guide explains how to run the Amarisoft UEsim with an LTE connection as an example, intended for users with no prior experience.

### Method
GET

### Endpoint
/websites/tech-academy_amarisoft/OutOfBox_UEsim_LTE.html

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
Documentation content for OutOfBox_UEsim_LTE.html

#### Response Example
```html
<html>
  <body>
    <h1>How to run Amarisoft UEsim without any experience (LTE connection as an example) ?</h1>
    <!-- ... content ... -->
  </body>
</html>
```
```

--------------------------------

### RrcSetup Message Structure (SA)

Source: https://tech-academy.amarisoft.com/NR_SA_DMRS_PDSCH

An example of the RRC Setup message sent by the gNB to configure NR SA. This snippet illustrates key parameters within the 'radioBearerConfig', 'masterCellGroup', and 'spCellConfig' sections, particularly focusing on PDSCH and PUSCH configurations including DMRS settings.

```text
{
message c1: rrcSetup: {
	rrc-TransactionIdentifier 0,
	criticalExtensions rrcSetup: {
		radioBearerConfig {
		...
		},
		masterCellGroup: {
			cellGroupId 0,
			rlc-BearerToAddModList {
			...
			},
			mac-CellGroupConfig {
			...
			},
			physicalCellGroupConfig: {
				pdsch-HARQ-ACK-Codebook dynamic
			},
			spCellConfig: {
				spCellConfigDedicated: {
					initialDownlinkBWP: {
						pdcch-Config setup: {
						...
						},
						pdsch-Config setup: {
							dmrs-DownlinkForPDSCH-MappingTypeA setup: {
								dmrs-AdditionalPosition pos1
							},
						...
					},
					firstActiveDownlinkBWP-Id 0,
					uplinkConfig: {
						initialUplinkBWP: {
							pucch-Config setup: {
							...
						},
						pusch-Config setup: {
							txConfig codebook,
							dmrs-UplinkForPUSCH-MappingTypeA setup: {
								dmrs-AdditionalPosition pos1,
								transformPrecodingDisabled {
								}
							},
							...
						},
						srs-Config setup: {
						...
						},
						firstActiveUplinkBWP-Id 0,
						pusch-ServingCellConfig setup: {
						}
					},
					pdcch-ServingCellConfig setup: {
					},
					pdsch-ServingCellConfig setup: {
					...
					},
					csi-MeasConfig setup: {
					...
					}
				}
			},
			tag-Id 0
	}
}
}
```

--------------------------------

### SIB1 Configuration for Transform Precoding (SA)

Source: https://tech-academy.amarisoft.com/NR_SA_PUSCH_TransformPrecoding

This snippet shows the SIB1 message configuration, specifically enabling transform precoding for Msg1. It details parameters within the uplinkConfigCommon and initialUplinkBWP sections, demonstrating the setup for PRACH and related configurations. Note that IE values are examples and may vary.

```ASN.1
message c1: systemInformationBlockType1: {
cellSelectionInfo {
...
},
cellAccessRelatedInfo {
...
},
connEstFailureControl {
...
},
servingCellConfigCommon {
downlinkConfigCommon {
frequencyInfoDL {
...
},
initialDownlinkBWP {
genericParameters {
locationAndBandwidth 13750,
subcarrierSpacing kHz30
},
pdcch-ConfigCommon setup: {
...
},
pdsch-ConfigCommon setup: {
...
}
},
bcch-Config {
...
},
pcch-Config {
...
}
},
uplinkConfigCommon {
frequencyInfoUL {
scs-SpecificCarrierList {
{
offsetToCarrier 0,
subcarrierSpacing kHz30,
carrierBandwidth 51
}
}
},
initialUplinkBWP {
genericParameters {
locationAndBandwidth 13750,
subcarrierSpacing kHz30
},
rach-ConfigCommon setup: {
rach-ConfigGeneric {
prach-ConfigurationIndex 160,
msg1-FDM one,
msg1-FrequencyStart 3,
zeroCorrelationZoneConfig 15,
preambleReceivedTargetPower -110,
preambleTransMax n7,
powerRampingStep dB4,
ra-ResponseWindow sl20
},
ssb-perRACH-OccasionAndCB-PreamblesPerSSB one: n8,
ra-ContentionResolutionTimer sf64,
prach-RootSequenceIndex l139: 1,
msg1-SubcarrierSpacing kHz30,
restrictedSetConfig unrestrictedSet,
msg3-transformPrecoder enabled
},
pusch-ConfigCommon setup: {
...
},
pucch-ConfigCommon setup: {
...
}
},
timeAlignmentTimerCommon infinity
},
ssb-PositionsInBurst {
...
},
ssb-PeriodicityServingCell ms20,
tdd-UL-DL-ConfigurationCommon {
...
},
...
},
ue-TimersAndConstants {
...
}
```

--------------------------------

### Get Core Dump Pattern (Linux)

Source: https://tech-academy.amarisoft.com/bug

This command displays the current pattern used by the Linux kernel for naming core dump files. Understanding this pattern helps in locating core dump files on systems other than Fedora 26+. The output indicates where core files are stored.

```shell
cat /proc/sys/kernel/core_pattern
```
Tokens:
Raw