All eNB and gNB services publishes the Amarisoft websocket API on a public link accessible anywhere in the world through our Worldwide CDN.
This tutorial will show you how to use this API.
Find the Websocket Informations
Go to your eNB or gNB service and scroll to the connection parameters:
Disable eNB / gNB xlog
To use the Amarisoft websocket, it is best to disable eNB / gNB xlog (by disabling the corresponding option in your eNB / gNB parameters)
Using Amarisoft GUI
Here are the steps to follow to add one of your eNB / gNB services on the Amarisoft WEB GUI (once you do it the interface will remember it unless you wipe your browser local data):
- Go to https://tech-academy.amarisoft.com/web-gui/
- Click on "Server"
- In "Name", enter your ORS name (or any name you want)
- In "Address", enter your websocket hostname, then the websocket port in the following field
- For versions older than 1.0.412 the hostname is missing "/websocket" after the hostname and you need to add it, it should be softinstXXX.host.vifib.net/websocket and not softinstXXX.host.vifib.net
- Check "SSL"
- Click Create
- Click "Update" on the next window that appears
Then, you will get multiple tabs at the top of the screen:
- "Logs" to view the eNb / gNB logs (useful for debugging why a phone doesn't connect)
- You can click on your server name to get useful radio measures:
- The terminal icon (monitor) will open an interactive CLI
- In "Info" button will allow you to check information on your cell
- The "RF" button will allow you to check the TX and RX gains and increase or decrease them
- The "constellations" button will allow you to show IQ constellation
- You will get the list of active connected UE's on the left pane
Here are some useful commands in the monitor (interactive CLI):
- "t" command: shows a real-time trace of connected UEs, very useful to debug the radio quality: https://tech-academy.amarisoft.com/userguide_callbox_advanced.doc#cbfb46c29922c7c539623f29f26391e1-3
- ideally cqi should be equal to 15, and phr should always be positive, if you see it is negative then you might need to change the "TX Power offset" parameter in your eNB / gNB services (it is best to contact us, normally this parameters has a good default value)
- "t spl" command: shows TX and RX power levels: RX max value should be around -10, adjust your RX gain accordingly
- "s1" or "ng": check MME / AMF connection
- "tx_gain" and "rx_gain": adjust TX and RX gain
- "help": show all commands
If you are unable to use the monitor, it means you need to disable xlog eNB / gNB as stated above
Please follow this tutorial from Amarisoft for more details: https://tech-academy.amarisoft.com/RemoteAPI.html