======== CELLULAR ======== .. sidebar:: Contents .. contents:: :depth: 3 :local: The cellular interface provides connection to mobile broadband networks using standards defined by 3GPP (3rd Generation Partnership Project). 3GPP has defined a wide range of standards such as GSM, GPRS, UMTS, HSDPA, LTE, 5G, and so forth, that show different properties: range of coverage, minimum latency achievable, downlink/uplink max throughput, etc. The cellular interface is implemented using "modules" from different vendors, and depending on the "module" installed in each device, each cellular interface will have different capabilities. Operational commands :osdx:op:`interfaces cellular show capabilities` can be used to list the cellular interfaces that are configurable on the system, as well as relevant information about the "modules" installed in the device. *Example:* .. code-block:: none admin@osdx$ interfaces cellular show capabilities cell0 Module Manufacturer: Quectel Module Model: EC25E Module Firmware: EC25EFAR06A01M4G_TEL Hardware Revision: 10000 IMEI: 866308062070222 Radio Interfaces: gsm, umts, lte Data Service Capability: non-simultaneous-cs-ps Maximum TX/RX rate supported: 50000/100000 Kbps Bands: gsm-dcs-1800, gsm-900-extended, gsm-900-primary, wcdma-2100, wcdma-850-us, wcdma-900 LTE bands: 1, 3, 5, 7, 8, 20, 38, 40, 41 Profile ======= Once the cellular interfaces available in the system are known, they can be configured. To do this, the first thing to do is define a cellular profile, which will later be assigned to the cellular interface to be configured. To create a cellular profile, use the :osdx:cfg:`cellular profile *` command, assigning it a name and adjusting different parameters: * ``apn``: configures the APN (Access Point Name) used to establish connection to the mobile broadband network (mandatory). * ``username``: configures the username to be used in network authentication. * ``password``: configures the password to be used in network authentication. * ``auth``: configures the protocol to be used in network authentication. Being able to select one of the following values (default, **both**). * ``chap``: to use the Challenge Handshake Authentication Protocol. * ``pap``: to use the Password Authentication Protocol. * ``both``: Use CHAP and PAP. Once the cellular profile has been created, the cellular interface can be configured. To do this, use the :osdx:cfg:`interfaces cellular *` command, indicating the name of the interface you want to configure (eg: cell0). Additionally, it is necessary to select the cellular profile used by this interface, for this the ``profile`` field is used. Personal Identification Number (PIN) ==================================== In order to establish a connection to the mobile broadband network, it is necessary to have a SIM card inserted in the corresponding slot of the device. Sometimes the SIM card may be locked by a PIN code. In these cases, it is required to configure the PIN code of the inserted SIM card through the ``pin`` field. Once the cellular interface is configured, the status of the SIM card can be checked through the :osdx:op:`interfaces cellular * show network-status` operational command. *Example:* .. code-block:: none :emphasize-lines: 2 admin@osdx$ interfaces cellular cell0 show network-status SIM status = OK Registration state = registered Public Land Mobile Network code = 21407 Public Land Mobile Network name = Movistar Network technology currently in use = lte Current Service Domain registered = cs-ps (capable cs-ps) Current Roaming status = off 3GPP Cell ID = 28195870 Radio Band = eutran-3 Channel = 1301 LTE Tracking Area Code (TAC) = 11091 RX level (dBm) = -69 Coverage level = 4 (**** ) Sometimes network connectivity issues can be caused by SIM card related errors. This can be checked using the previous operational command, where instead of displaying the message **"SIM status = OK"**, it will display the message **"SIM Status = LOCKED"**, and in parentheses the corresponding error. Below are the most common errors that can occur: * ``SIM not inserted``: the system does not find any SIM card inserted in the device. * ``PIN not configured``: the inserted SIM card is locked by PIN code, and this code has not been added to the configuration. * ``Incorrect password``: the inserted SIM card is locked by PIN code, and the code added to the configuration is incorrect. * ``SIM PUK required``: the inserted SIM card is locked by PUK code. The **"SIM PUK required"** error usually occurs when the number of attempts to enter a correct PIN code on the SIM card is exceeded, and consequently, it is locked by PUK code. To solve this, the operational command :osdx:op:`interfaces cellular * open-at-terminal` must be launched and then write **AT+CPIN="12345678","1234"** in the AT terminal (being **12345678** the PUK code of the SIM card, and **1234** the new PIN code that you want to assign to the SIM card). If the AT terminal then displays **OK**, it means that the SIM card has been unlocked successfully. *Example:* .. code-block:: none admin@osdx$ interfaces cellular cell0 open-at-terminal AT+CPIN="12345678","1234" OK Examples ======== Imagine that you want to configure the cellular interface **cell0**, for which a SIM card is inserted whose PIN code is **1234**. Additionally, you want to connect this interface to the mobile broadband network through the APN **oper_apn.com** and using only the UMTS/HSDPA technology. In OSDx, this can be achieved by entering the following commands: .. code-block:: none set cellular profile CELPROFILE apn oper_apn.com set cellular profile CELPROFILE pin 1234 set interfaces cellular cell0 address dhcp set interfaces cellular cell0 profile CELPROFILE :doc:`Here `, you can find more examples related to ``interfaces cellular``. Monitoring ========== In OSDx there are several operational commands related to ``interfaces cellular``, which can display information of interest or allow some action to be executed on these interfaces. Until now, some of these operational commands have been detailed, such as: * The :osdx:op:`interfaces cellular show capabilities` command, that displays a list of cellular interfaces that are configurable on the system, as well as relevant information about the "modules" installed in the device. * The :osdx:op:`interfaces cellular * show network-status` command, which shows information about the state of the radio link (SIM status, registration state, network technology currently in use, ...). * The :osdx:op:`interfaces cellular * open-at-terminal` command, which allows opening a terminal in which to execute AT commands (for example, to unlock the SIM card by inserting the PUK code). But these are not the only operational commands available in OSDx that are related to ``interfaces cellular``. * The :osdx:op:`interfaces cellular * show device-info` command displays information about the "module" installed in the device. *Example:* .. code-block:: none admin@osdx$ interfaces cellular cell0 show device-info Module Manufacturer = Quectel Module Model = EC25E Module Firmware = EC25EFAR06A01M4G_TEL Hardware Revision = 10000 IMEI = 866308062070222 IMSI = 214075541654235 ICCID = 8934075700105849704F Radio Interfaces = gsm, umts, lte Data Service Capability = non-simultaneous-cs-ps Maximum TX/RX rate supported = 50000/100000 Kbps Temperature = 44 * The :osdx:op:`interfaces cellular * show supported-bands` command displays the bands supported by the "module" installed on the device. *Example:* .. code-block:: none admin@osdx$ interfaces cellular cell0 show supported-bands Bands = gsm-dcs-1800, gsm-900-extended, gsm-900-primary, wcdma-2100, wcdma-850-us, wcdma-900 LTE bands = 1, 3, 5, 7, 8, 20, 38, 40, 41 * The :osdx:op:`interfaces cellular * show preferred-bands` command shows the bands selected as preferred to be used by the cellular interface. *Example:* .. code-block:: none admin@osdx$ interfaces cellular cell0 show preferred-bands Bands preference = gsm-dcs-1800, gsm-900-extended, gsm-900-primary, wcdma-2100, wcdma-850-us, wcdma-900 LTE bands preference = 1, 3, 5, 7, 8, 20, 38, 40, 41 * The :osdx:op:`interfaces cellular * show cell-info` command displays information about the serving cell and neighboring cells. *Example:* .. code-block:: none admin@osdx$ interfaces cellular cell0 show cell-info LTE intrafrequency info: UE in idle mode = no PLMN ID coded = 21407 Tracking Area Code = 11091 Global cell ID = 28195872 E-UTRA absolute RF channel number = 2850 LTE serving cell ID = 290 Cell #0 Physical cell ID = 290 Current RSRQ (dB) = -11.300000 Current RSRP (dBm) = -109.300000 Current RSSI (dBm) = -76.200000 Cell selection Rx Level = 0 LTE interfrequency info: UE in idle mode = no LTE info - Neighboring GSM: UE in idle mode = no LTE info - Neighboring WCDMA: UE in idle mode = no * The :osdx:op:`interfaces cellular * show signal-quality` command displays information about the quality of the signal received by the module. *Example:* .. code-block:: none admin@osdx$ interfaces cellular cell0 show signal-quality LTE: RSSI (dBm) = -78 RSRP (dBm) = -109 RSRQ (dB) = -8 SNR (dB) = 12.000000 Rx Chain #0 Radio tuned = yes Rx Level (dBm) = -80.700000 ECIO (dB) = 8.400000 RSRP (dBm) = 109.100000 Phase (deg) = 0.000000 Rx Chain #1 Radio tuned = yes Rx Level (dBm) = -82.200000 ECIO (dB) = 8.200000 RSRP (dBm) = 110.400000 Phase (deg) = 0.000000 * The :osdx:op:`interfaces cellular * show network-data-connection` command displays information about the network data connection. *Example:* .. code-block:: none admin@osdx$ interfaces cellular cell0 show network-data-connection Connection status = connected Traffic channel status = active Max. TX channel rate (bps) = 50000000 Max. RX channel rate (bps) = 150000000 IPv4 address = 37.13.233.100 IPv4 mask = 255.255.255.248 IPv4 gateway = 37.13.233.101 IPv4 primary DNS = 80.58.61.250 IPv4 secondary DNS = 80.58.61.254 * Finally, the :osdx:op:`interfaces cellular * reconnect` command allows the user to force a reconnection of the cellular interface to the mobile broadband network. Command Summary =============== .. osdx:cmdtree:: cfg cellular interfaces cellular .. osdx:cmdtree:: op interfaces cellular