Cellular
Cellular Overview
Cellular technology refers to the use of radio frequency (RF) communication systems based on a network of geographically distributed cells, each served by a cell tower or base station. It forms the foundation of mobile communication systems, enabling wireless communication for voice, data, and messaging services. Cellular networks are used in mobile phones, IoT devices, and various other wireless communication applications.
Application Interface
The below table captures the functions that are to be called from the application layer.
Function |
Description |
|---|---|
rs_cellular_open |
To open the cellular connection |
rs_cellular_process |
To process the cellular task |
rs_cellular_set_config |
To configure the cellular instance. |
rs_cellular_is_powered |
To checks if the cellular module is powered on. |
rs_cellular_connect |
To connects to the cellular network. |
rs_cellular_disconnect |
To disconnects from the cellular network. |
rs_cellular_is_connected |
To Checks if the cellular module is connected to the network. |
rs_cellular_get_network_regstatus |
To retrieves the network registration status. |
rs_cellular_get_status |
To retrieves the cellular status. |
rs_cellular_set_gps_interval |
To sets the GNSS update interval for the cellular instance. |
rs_cellular_set_mqtt_config |
To configures the MQTT client for the cellular module. |
rs_cellular_mqtt_open |
To opens an MQTT connection with the provided configuration. |
rs_cellular_register_callback |
To registers a callback function for cellular operations. |
rs_cellular_mqtt_close |
To closes an MQTT connection. |
rs_get_mqtt_state |
To gets the current state of the MQTT connection |
rs_cellular_register_mqtt_callback |
To registers an MQTT callback function. |
rs_cellular_mqtt_connect |
To connects to the MQTT broker |
rs_cellular_mqtt_disconnect |
To disconnects from the MQTT broker. |
rs_cellular_mqtt_disconnect |
To disconnects from the MQTT broker. |
rs_cellular_get_mqtt_connect_req_status |
To gets the MQTT connection request status. |
rs_cellular_set_mqtt_socket_id |
To sets the socket ID for the MQTT connection. |
rs_cellular_mqtt_connect_status |
To gets the current MQTT connection status |
rs_cellular_get_mqtt_status |
To gets the publish state of the MQTT client. |
rs_cellular_get_mqtt_publish_state |
To disconnects from the MQTT broker. |
rs_cellular_mqtt_publish_data |
To publishes data to an MQTT topic. |
Error Code
Every API’s for the Serial returns some success or failure values. Please refer below section,
Cellular Header Details
Documentation from the relevant header as follows:
Warning
doxygenfile: Cannot find file “rs_cellular.h