Cellular Manager – Architecture

Created on March 18, 2024

Document Scope:


Low Level Design, or LLD, is the system design to be used for development, modeling the behavior of the software component.

  • Cellular Manager Architecture.
  • Cellular Manager State Machine.
  • Cellular Manager Sequence Diagrams.
  • Cellular Manager Data Model.
  • Cellular modem LIBQMI APIS.
  • Cellular manager’s RBUS APIs.

Cellular Manager Architecture



Cellular Manager State Machine


Principles of the state machine:

The CellularManage state machine will depend on a set of data model objects and parameter values grouped together into a state according to properties that affect or reflect the states of a cellular modem.

The principles of the state machine:

  • A cellular manager state occupies an interval of time.
  • A CellularManager state is associated with an abstraction represented by data model objects, satisfying some condition(s).
  • CellularManager changes its state not only as a direct consequence of the current input, but it is also dependent on some past history of its inputs.
  • Device.Cellular.Interface.Status==DOWN can be caused by different causes related to network access, but mainly related to two:

    • Loss of coverage when the received signal is below the sensitivity level.
    • Attach reject, where the MME rejects the access and the backoff algorithm in the modem becomes applicable to retrying the attach.

Cellular Manager Data Model content depending on status.


Cellular Manager Sequence Diagram


Cellular Manager sequence diagrams describe the interaction between different entities by focusing on the sequence of messages that are exchanged, along with their corresponding occurrence specifications on the lifelines.

Based on the requirements, we have defined three services to be implemented by Cellular Manager:

  1. The cellular manager will manage the modem to provide internet access using the default bearer for IPv4 and IPv6.
  2. The cellular manager will analyze the cellular radio signal and expose a parameter with the score of the radio conditions to place the device in a convenient place.
  3. The cellular manager will extract and expose all valuable information related to mobility management, session management, and radio resources for telemetry purposes.

The sequence diagram can be better understood in combination with the state machine.

Cellular Manager Internet Service Access Service.

To access the internet, our cellular modem will need to register with the MNO network and establish an EPS connection to a packet gateway. Our registration will be for EPS only, and the EPS session will be based on a single default bearer (NON-GBR).

Before starting the registration, we will need to configure a number of global parameters (or defaults) and one or more access point profiles to establish the EPS bearer. This information could be provisioned in advance via WEBCONFIG.

CellularManager Data Model


Device.Cellular.

Device.Cellular.X_RDK_Enable

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose a switch to activate or deactivate the modem based on configurable power capabilities in the cellular modem.

BOOLEAN

NONE

TRUE

RW ON-CHANGE

Device.Cellular.X_RDK_Status

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the status of the modem, according to Cellular Manager the state machine

ENUMERATION


DOWN,DEACTIVATED,DEREGISTERED,

REGISTERED,CONNECTED

DOWN

R ON-CHANGE

Device.Cellular.X_RDK_Model

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the hardware model of the cellular modem.

STRING

NONE

NONE

R NONE

Device.Cellular.X_RDK_HardwareRevision

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the hardware revision of the cellular modem.

STRING

NONE

N.A

R NONE

Device.Cellular.X_RDK_Vendor

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the OEM vendor of the cellular modem.

STRING

NONE

N.A

R NONE

Device.Cellular.X_RDK_ControlInterface

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the device interface used to control the modem, it will be used for informative purposes to distinguish communication drivers, for instance cdc-wdm0 implies the use of QMI.

STRING

NONE

cdc-wdm0

R NONE

Device.Cellular.X_RDK_ControlInterfaceStatus

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the status of the device interface used to control the modem

ENUMERATION


OPENED,CLOSED

CLOSE

R ON-CHANGE

Device.Cellular.X_RDK_DataInterface

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the device interface used to forward traffic through the cellular network.

STRING

NONE

WWAN0

R NONE

Device.Cellular.X_RDK_DataInterfaceStatus

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the status of the device interface used to forward data to the modem.

ENUMERATION


OPENED,CLOSED

CLOSE

R ON-CHANGE

Device.Cellular.X_RDK_Imei

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the imei identifier used by the modem for identification purposes.

STRING

15 digits (digits 0-9)

0

R NONE

Device.Cellular.X_RDK_Firmware

Device.Cellular.X_RDK_Firmware.CurrentImageVersion

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the current Firmware version installed in the cellular modem.


STRING

maximum 25 characters

N.A

R NONE

Device.Cellular.X_RDK_Firmware.FallbackImageVersion

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

This object will expose the firmware version used for fallback in case of a failure during upgrade.

STRING

maximum 25 characters

N.A

R NONE

Device.Cellular.Interface.{i}.

Device.Cellular.Interface.{i}.Enable

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Switch to enable or disable the cellular interface, controlling network registration.

BOOLEAN

NONE

TRUE

WR ON-CHANGE

Device.Cellular.Interface.{i}.Status

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the status of the cellular interface based on its capability to access the cellular network, this object will expose the registration status for this interface, taking in account, ATTACH accept, ATTACH rejects, DETACH from network, lost coverage or problems during cell search and access.

ENUMERATION

UP, DOWN

DETACHED

R ON-CHANGE

Device.Cellular.Interface.{i}.X_RDK_RegisteredService

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

This object will expose the service granted to access the network, for data access, only PS (EPS only) will be applicable service. 

ENUMERATION

PS,CS,PS+CS

NONE

R ON-CHANGE

Device.Cellular.Interface.{i}.X_RDK_PhyConnectedStatus

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the flag to be used by WAN manager to detect the interface.

BOOLEAN

NONE

FALSE

R ON-CHANGE

Device.Cellular.Interface.{i}.X_RDK_LinkAvailableStatus

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the flag to be used by WAN manager to detect when the  EPS bearer is connected.

BOOLEAN

NONE

FALSE

R ON-CHANGE

Device.Cellular.Interface.{i}.X_RDK_Imei

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the imei identifier used by the cellular interface, maintained for compatibility with the current TR181 BBF data model.

STRING

15 digits (digits 0-9)

0

R NONE

Device.Cellular.Interface.{i}.X_RDK_Iccid

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose integrated circuit card identifier of the UICC or MNO profile used for registration.

STRING


18-20 digits (digits 0-9)

N.A

R NONE

Device.Cellular.Interface.{i}.RadioAccessTechnology

Device.Cellular.interface.{i}.RadioAccessTechnology.Supported

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the list of supported RAT’s in the modem.

Comma separated STRING

(5G, LTE,UMTS,GSM)

N.A

R NONE

Device.Cellular.interface.{i}.RadioAccessTechnology.Preferred

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the list of preferred RAT’s, the most preferred will be the first element in the string

Comma separated STRING

(5G, LTE,UMTS,GSM)

N.A

R NONE

Device.Cellular.interface.{i}.RadioAccessTechnology.Current

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

This object will expose the current RAT used in the serving cell.Expose RAT in use

ENUMERATION

(5G, LTE,UMTS,GSM)

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_RadioSignal

Device.Cellular.Interface.{i}.X_RDK_RadioSignal.Rssi
DESCRIPTION TYPE RESTRICTIONS DEFAULT ACCESS SUBSCRIPTION
Expose the total signal strength received at the modem. INT8 (units DBM) RANGE (-117 dBm to -25 dBm) N.A R

ON-CHANGE

ON-INTERVAL

Device.Cellular.Interface.{i}.X_RDK_RadioSignal.Snr
DESCRIPTION TYPE RESTRICTIONS DEFAULT ACCESS SUBSCRIPTION
Expose signal to noise ratio. INT8 (units DB) RANGE (0 dB to 20 dB) N.A R

ON-CHANGE

ON-INTERVAL

Device.Cellular.Interface.{i}.X_RDK_RadioSignal.Rsrp
DESCRIPTION TYPE RESTRICTIONS DEFAULT ACCESS SUBSCRIPTION
Expose the signal strength received at the modem from a radio station. INT16 (units DBM) RANGE (-155 dBm to -44 dBm) N.A R

ON-CHANGE

ON-INTERVAL

Device.Cellular.Interface.{i}.X_RDK_RadioSignal.Rsrq
DESCRIPTION TYPE RESTRICTIONS DEFAULT ACCESS SUBSCRIPTION
Expose the signal quality received at the modem. INT8 (units DBM) RANGE (-43 dB to 20 dB) N.A R

ON-CHANGE

ON-INTERVAL

Device.Cellular.Interface.{i}.X_RDK_RadioSignal.Trx
DESCRIPTION TYPE RESTRICTIONS DEFAULT ACCESS SUBSCRIPTION
Expose the transmitted power level. INT8 NONE N.A R

ON-CHANGE

ON-INTERVAL

Device.Cellular.Interface.{i}.X_RDK_RadioSignal.RadioEnvConditions

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the score of the radio reception coverage conditions.

ENUMERATION


EXCELLENT, GOOD, FAIR, POOR, UNAVAILABLE

UNAVAILABLE

R ON-CHANGE

Device.Cellular.Interface.{i}.X_RDK_PlmnAccess

Device.Cellular.Interface.{i}.X_RDK_PlmnAccess.RoamingEnable

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the switch to activate roaming for this interface.



BOOLEAN

NONE

TRUE

R NONE

Device.Cellular.Interface.{i}.X_RDK_PlmnAccess.RoamingStatus

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose if the device is in roaming or in the home PLMN after registration

ENUMERATION

HOME,VISITOR HOME R ON-CHANGE

Device.Cellular.interface.{i}.X_RDK_PlmnAccess.HomeNetwork.Mcc

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the home network PLMN MCC

STRING

3 digits (0 to 9)

N.A

R NONE

Device.Cellular.interface.{i}.X_RDK_PlmnAccess.HomeNetwork.Mnc

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the home network PLMN MNC

STRING

3 digits (0 to 9)

N.A

R NONE

Device.Cellular.interface.{i}.X_RDK_PlmnAccess.HomeNetwork.Name

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the home network PLMN network name

STRING

Maximum 25 characters

N.A

R NONE

Device.Cellular.interface.{i}.X_RDK_PlmnAccess.AvailableNetworks.{n}

Device.Cellular.interface.{i}.X_RDK_PlmnAccess.AvailableNetworks.{n}.Mcc

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the MCC of a network in the list of available networks.

STRING


3 digits (0 to 9)

N.A

R NONE

Device.Cellular.interface.{i}.X_RDK_PlmnAccess.AvailableNetworks.{n}.Mnc

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the MNC of the network in the PLMN list of available networks

STRING


3 digits (0 to 9)

N.A

R NONE

Device.Cellular.interface.{i}.X_RDK_PlmnAccess.AvailableNetworks.{n}.Name

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the name of one of the networks in the PLMN list.

STRING


Maximum 25 characters.

N.A

R NONE

Device.Cellular.interface.{i}.X_RDK_PlmnAccess.AvailableNetworks.{n}.Allowed

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose if the network is allowed as home network or for roaming

BOOLEAN


NONE

N.A

R NONE

Device.Cellular.interface.{i}.X_RDK_PlmnAccess.PreferredNetworks.{n}

Device.Cellular.interface.{i}.X_RDK_PlmnAccess.PreferredNetworks.{n}.Mcc

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the MCC of a network in the list of preferred networks.

STRING


3 digits (0 to 9)

N.A

R NONE

Device.Cellular.interface.{i}.X_RDK_PlmnAccess.PreferredNetworks.{n}.Mnc

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the MNC of a network in the list of preferred networks.

STRING


3 digits (0 to 9)

N.A

R NONE

Device.Cellular.interface.{i}.X_RDK_PlmnAccess.PreferredNetworks.{n}.Name

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the name of a network in the list of preferred networks.

STRING


Maximum 25 characters.

N.A

R NONE

Device.Cellular.interface.{i}.X_RDK_PlmnAccess.NetworkInUse

Device.Cellular.interface.{i}.X_RDK_PlmnAccess.NetworkInUse.Mcc

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the MCC of the network in use

STRING

3 digits (0 to 9)

N.A

R NONE

Device.Cellular.interface.{i}.X_RDK_PlmnAccess.NetworkInUse.Mnc

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the MNC of the network in use.

STRING

3 digits (0 to 9)

N.A

R NONE

Device.Cellular.interface.{i}.X_RDK_PlmcAccess.NetworkInUse.Name

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the network name in use

STRING

Maximum 25 characters.

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_CellTopology

Device.Cellular.Interface.{i}.X_RDK_CellTopology.ServingCell.GlobalCellId

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the global cell identifier of the current serving cell.

STRING


N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_CellTopology.ServingCell.PhysicalCellId

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the global cell identifier of the current physical serving cell.

STRING


N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_CellTopology.ServingCell.PlmnId

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the PLMNid of the serving cell

STRING

MCC+MNC

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_CellTopology.ServingCell.Rat

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the radio access type of the current serving cell.

ENUMERATION

GSM,UMTS,LTE,5G

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_CellTopology.ServingCell.RadioBand

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the radio band of the current serving cell.

STRING


N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_CellTopology.ServingCell.AbsoluteRfcn

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the ARFCN for LTE

(DL for FDD) 

UINT8

LTE RANGE(0 to 65535)

0

R NONE

Device.Cellular.interface.{i}.X_RDK_CellTopology.ServingCell.AreaCode

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose information of the tracking area code of the current serving cell .

STRING

8 digits (0 to 9)

N.A

R NONE

Device.Cellular.interface.{i}.X_RDK_CellTopology.ServingCell.Rsrp

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the Rsrp at the modem from a radio station.

INT16

(units DBM)

RANGE (-155 dBm to -44 dBm)

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_CellTopology.X_RDK_NeighborCellList.{i}.PhysicalCellId

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the cell id of one of the neighbor cells in the neighbour list.

STRING


N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_CellTopology.NeighborCellList.{i}.PlmnId

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the PLMNid of the neighbor cell.

STRING

MCC+MNC

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_CellTopology.NeighborCellList.{i}.Rat

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the RAT of one of the neighbor cells in the neighbor list.

ENUMERATION

GSM,UMTS,LTE,5G

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_CellTopology.NeighborCellList.{i}.AbsoluteRfcn

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the radio frequency channel of one of the neighbours in the neighbour list.

UINT8

0-65535

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_CellTopology.NeighborCellList.{i}.Rssi

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Exposes the RSSI at the modem from a neighbor cell

INT8

RANGE (-117 dBm to -125 dBm)

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_CellTopology.NeighborCellList.{i}.Rsrp

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Exposes the RSRP received at the modem from a neighbor cell

INT8

RANGE (-155 dBm to -44 dBm)

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_CellTopology.NeighborCellList.{i}.Rsrq

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Exposes the RSRQ received at the modem from a neighbor cell

INT8

RANGE (-43 dB to 20 dB)

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_ContextProfile.{i}

Device.Cellular.Interface.{i}.X_RDK_ContextProfile.{i}.MnoName

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Exposes the  name of the MNO carrier where this context profile is applicable.

STRING


MAXIMUM 25 CHARACTERS

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_ContextProfile.{i}.Status

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Exposes the activation status of the  LTE EPS bearer.

ENUMERATION

ACTIVE, INACTIVE

N.A

R ON-CHANGE

Device.Cellular.Interface.{i}.X_RDK_ContextProfile.{i}.DefaultBearer

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Exposes the type of EPS bearer established with the PGW.

BOOLEAN

NONE

TRUE

R NONE

Device.Cellular.Interface.{i}.X_RDK_ContextProfile.{i}.Apn

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the url of the the access point for the established the EPS bearer.

STRING

NONE

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_ContextProfile.{i}.IpAddressFamily

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the IP address family of the EPS bearer established.

ENUMERATION

IPv4, IPv6, IPv4IPv6

ipV4ipV6

R NONE

Device.Cellular.Interface.{i}.X_RDK_ContextProfile.{i}.Ipv4Address

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the provisioned IPv4 address of the established bearer.

STRING

NONE

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_ContextProfile.{i}.Ipv4SubnetMask

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the IPv4 subnet mask.

STRING

NONE

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_ContextProfile.{i}.Ipv4Gateway

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the IPv4 address of the gateway.

STRING

NONE

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_ContextProfile.{i}.Ipv4PrimaryDns

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the IPv4 address of the Primary DNS.

STRING

NONE

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_ContextProfile.{i}.Ipv4SecondaryDns

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the IPv4 address of the Secondary DNS.

STRING

NONE

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_ContextProfile.{i}.Ipv6Address

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the IPv6 address bound to the bearer.

STRING

NONE

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_ContextProfile.{i}.Ipv6Gateway

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the IPv6 address for the default gateway bound to the bearer.

STRING

NONE

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_ContextProfile.{i}.Ipv6PrimaryDns

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the IPv6 address for the primary DNS bound to the bearer.

STRING

NONE

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_ContextProfile.{i}.Ipv6SecondaryDns

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the IPv6 address for the primary DNS bound to the bearer.

STRING

NONE

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_ContextProfile.{i}.MtuSize

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose MTU size allowed for the EPS bearer

UINT8

NONE

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_ContextProfile.{i}.Interface

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Exposes the name of the interface in sue to transport the PDN connection traffic from the CPE.

STRING

NONE

N.A

R NONE

Device.Cellular.Interface.{i}.X_RDK_Statistics

Device.Cellular.Interface.{i}.X_RDK_Statistics.BytesSent

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

The total number of bytes transmitted out of the interface, including framing characters.

UINT32

NONE

0

R NONE

Device.Cellular.Interface.{i}.X_RDK_Statistics.BytesReceived

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

The total number of bytes received on the interface, including framing characters.

UINT32

NONE

0

R NONE

Device.Cellular.Interface.{i}.X_RDK_Statistics.PacketsSent

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

The total number of packets transmitted out of the interface.

UINT32

NONE

0

R NONE

Device.Cellular.Interface.{i}.X_RDK_Statistics.PacketsReceived

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

The total number of packets received on the interface.

UINT32

NONE

0

R NONE

Device.Cellular.Interface.{i}.X_RDK_Statistics.PacketsSentDrop

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

The total number of packets sent drop by the interface.

UINT32

NONE

0

R ON-INTERVAL

Device.Cellular.Interface.{i}.X_RDK_Statistics.PacketsReceivedDrop

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

The total number of packets receive drop by the interface.

UINT32

NONE

0

R ON-INTERVAL

Device.Cellular.Interface.{i}.X_RDK_Statistics.UpStreamMaxBitRate

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the maximum attainable and theoretical upstream bit rate.

UINT16


NONE

N.A

R ON-INTERVAL

Device.Cellular.Interface.{i}.X_RDK_Statistics.DownStreamMaxBitRate

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the maximum attainable and theoretical downstream bit rate.

UINT16

NONE

N.A

R NONE

Device.Cellular.X_RDK_Uicc.{i}

Device.Cellular.X_RDK_Uicc.{i}.Enable

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the switch to POWER ON  the SIM in the slot “i”

BOOLEAN

NONE TRUE WR NONE

Device.Cellular.X_RDK_Uicc.{i}.MnoName

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the name of the MNO for this UICC in the slot “i”.

STRING


NONE

N.A

R NONE

Device.Cellular.X_RDK_Uicc.{i}.Iccid

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose integrated circuit identifier of the sim in the slot “i”

STRING


18-20 digits (digits 0-9)

N.A

R NONE

Device.Cellular.X_RDK_Uicc.{i}.Msisdn

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose integrated circuit identifier of the sim this slot

STRING


18-20 digits (digits 0-9)

N.A

R NONE

Device.Cellular.X_RDK_Uicc.{i}.Status

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose SIM status of the SIM card in this slot

ENUMERATION

VALID, BLOCKED, ERROR,EMPTY

N.A

R NONE

Device.Cellular.X_RDK_Euicc

Device.Cellular.X_RDK_Euicc.Enable

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the switch to activate the SIM

BOOLEAN

NONE N.A WR NONE

Device.Cellular.X_RDK_Euicc.Eid

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose integrated circuit identifier of the sim this slot

STRING


NONE

N.A

R NONE

Device.Cellular.X_RDK_Euicc.MnoProfile.{i}.Enable

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the switch to activate of the sim this profile

BOOLEAN


NONE

N.A

R NONE

Device.Cellular.X_RDK_Euicc.MnoProfile.{i}.MnoName

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose MNO name for which this profile is applicable

STRING

NONE

N.A

R NONE

Device.Cellular.X_RDK_Euicc.MnoProfile.{i}.Iccid

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose integrated circuit identifier of the profile.

STRING


18-20 digits (digits 0-9)

N.A

R NONE

Device.Cellular.X_RDK_Euicc.MnoProfile.{i}.Msisdn

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the MSISDN of the profile.

STRING


E.164

N.A

R NONE

Device.Cellular.X_RDK_Euicc.MnoProfile.{i}.Imsi

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose IMSI of the profile.

STRING


MAX 15 DIGITS

N.A

R NONE

Device.Cellular.X_RDK_Euicc.MnoProfile.{i}.Status

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose profile status.

ENUMERATION

VALID, BLOCKED, ERROR,EMPTY

N.A

R ON-CHANGE

Device.Cellular.AccessPoint.{i}.

Device.Cellular.AccessPoint.{i}.Enable

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the switch to make the APN in the usable.

BOOLEAN

NONE

TRUE

R ON-CHANGE

Device.Cellular.AccessPoint.{i}.X_RDK_MnoName

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose MNO name for which this profile is applicable

STRING

MAX 25 CHARACTERS

N.A

R NONE

Device.Cellular.AccessPoint.{i}.X_RDK_Roaming

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose a flag to define if this access point profile can be used during roaming.

BOOLEAN

NONE

TRUE

R NONE

Device.Cellular.AccessPoint.{i}.Apn

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the url of the Apn.

STRING

MAXIMUM 25 CHARACTERS

N.A

R NONE

Device.Cellular.AccessPoint.{i}.X_RDK_ApnAuthentication

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the type of apn authentication

STRING

PAP,CHAP,NONE

NONE

R NONE

Device.Cellular.AccessPoint.{i}.UserName

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose authentication user name 

STRING

MAXIMUM 25 CHARACTERS

N.A

R NONE

Device.Cellular.AccessPoint.{i}.Password

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose authentication password

STRING

MAXIMUM 25 CHARACTERS

N.A

R NONE

Device.Cellular.AccessPoint.{i}.X_RDK_IpAddressFamily

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the IP address family used pdp context

ENUMERATION

IPv4,IPv6,IPv4IPv6

IPv4IPv6

R NONE

Device.Cellular.AccessPoint.{i}.X_RDK_PdpInterfaceConfig

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose how obtain internet configuration for this context profile

ENUMERATION

NAS,DHCP

NAS

R NONE

Device.Cellular.AccessPoint.{i}.X_RDK_DefaultProfile

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose if this access point profile is DEFAULT or not for the bearer creation.

BOOLEAN

NONE

FALSE

R NONE

Device.Cellular.AccessPoint.{i}.X_RDK_ProfileId

DESCRIPTION

TYPE

RESTRICTIONS

DEFAULT

ACCESS SUBSCRIPTION

Expose the index of the profile as saved into persistent memory in the SIM/MODEM.

UINT8

NONE

NONE

RW NONE
TR181-CellularManager
<?xml version="1.0" encoding="UTF-8"?>
<dm:document
   <model
    name="Device:2.xx-cellularManager root object definition to be added to Device.">
    <bibliography>
      <reference id="3GPP specs">
        <name>Describes the DATA model in TR181 format for RDK-B CellularManager</name>
        <organization></organization>
        <hyperlink>http://www.3gpp.org</hyperlink>
      </reference>
    </bibliography>
	<object
      name="Device.Cellular"
      access="readOnly"
      minEntries="1"
      maxEntries="1">
      <description>
        The top-level object for a Device.Cellular.
      </description>
   		<parameter
            name="Enable"
            description="Expose a switch to activate or deactivate cellular access"
            access="readWrite">
            <syntax>
              <boolean/>
            </syntax>
          </parameter>
      	<object
        name="Device.Cellular.X_RDK_Firmware"
        access="readOnly">
        	<parameter
            name="CurrentImageVersion"
            description="Provides the information of the current FW version running in the modem"
            access="readOnly">
            <syntax>
              <string>
                <size maxLength="256" />
              </string>
            </syntax>
        	</parameter>
    	</object>
    </object>
</model>
</dm:document>

For further details of the abbreviations, kindly refer to the Glossary – RDK – RDK Central Wiki

Go To Top