Functions

Functions of the cellular library.

The cellular library consists of the following functions.

Control plane APIs

• Cellular_Init
  One time initialization function.
• Cellular_Cleanup
  One time deinitialization function.
• Cellular_SetRatPriority
  Configure the priority order in which the networks are searched.
• Cellular_GetRatPriority
  Get the priority order in which the networks are searched.
• Cellular_RfOn
  Turn on RF i.e. turn-off airplane mode.
• Cellular_RfOff
  Turn off RF i.e. turn-on airplane mode.

Hardware info

• Cellular_GetSimCardStatus
  Get SIM card status (activated/Pin set etc.).
• Cellular_GetSimCardInfo
  Get SIM card information (IMSI, SIM Card number etc.).
• Cellular_GetModemInfo
  Get the information about the modem (HW version, FW version etc.).

Network registration

• Cellular_GetRegisteredNetwork
  Get the network on which SIM is currently registered/camped.
• Cellular_GetNetworkTime
  Get the network time.
• Cellular_GetSignalInfo
  Get signal information.
• Cellular_GetServiceStatus
  Get network service status.

Enable data network

• Cellular_SetPdnConfig
  Set PDN config for a PDN context.
• Cellular_GetPdnStatus
  Get status reports for all PDN contexts.
• Cellular_ActivatePdn
  Activate a PDN context.
• Cellular_DeactivatePdn
  Deactivate a PDN context.
• Cellular_GetIPAddress
  Get the IP Address assigned to the module.
• Cellular_SetDns
  Set the DNS server to use.

Device and network status callback functions

• Cellular_RegisterUrcNetworkRegistrationEventCallback
  Register/Remove callback for Network Registration URC events.
• Cellular_RegisterUrcPdnEventCallback
  Register/Remove callback for PDN related URC events.
• Cellular_RegisterUrcSignalStrengthChangedCallback
  Register callback for Signal Strength changed URC events.
• Cellular_RegisterModemEventCallback
  Register callback for all modem related events.
• Cellular_RegisterUrcGenericCallback
  Register generic callback for all other URC events than covered in above callbacks.

Power saveing modes

• Cellular_GetPsmSettings
  Get current PSM settings.
• Cellular_SetPsmSettings
  Set PSM settings.
• Cellular_GetEidrxSettings
  Get current e-I-DRX settings.
• Cellular_SetEidrxSettings
  Set e-I-DRX settings.

Custom AT command

• Cellular_ATCommandRaw
  Send the raw AT command to the module.

Data plan APIs

• Cellular_CreateSocket
  Create a socket.
• Cellular_SocketConnect
  Connect to a remote socket.
• Cellular_SocketSend
  Send data to the connected remote socket.
• Cellular_SocketRecv
  Receive data on a connected socket.
• Cellular_SocketClose
  Close the socket.
• Cellular_GetHostByName
  Resolve a host name using Domain Name Service.
• Cellular_SocketSetSockOpt
  Set options for a socket.
• Cellular_SocketRegisterSocketOpenCallback
  Register Socket open callback on the socket.
• Cellular_SocketRegisterDataReadyCallback
  Register data ready callback on the socket.
• Cellular_SocketRegisterClosedCallback
  Register closed callback on the socket.