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_init |
To initialize the cellular module |
rs_cellular_open |
To open the cellular connection |
rs_cellular_task |
To processe cellular task |
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_get_gnss_lattitude |
To get the GNSS lattitude value. |
rs_cellular_get_gnss_longtitude |
To get the GNSS longtitude value. |
rs_cellular_get_gnss_hdop |
To get the GNSS hdop value. |
rs_cellular_clear_gnss_value |
To clear the stored GNSS value. |
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_cellular_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_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 connection status of the MQTT client. |
rs_cellular_get_mqtt_publish_state |
To gets the publish state of the MQTT client. |
rs_cellular_set_mqtt_publish_state |
To sets the publish state of the MQTT client. |
rs_cellular_mqtt_publish_data |
To publishes data to an MQTT topic. |
rs_cellular_set_http_config |
To configures the HTTP client for the cellular module. |
rs_cellular_http_open |
To open the HTTP connection with the provided configuration. |
rs_cellular_http_close |
To close the HTTP connection with the provided configuration. |
rs_cellular_http_connect |
To connects to the HTTP server. |
rs_cellular_http_disconnect |
To disconnects from the HTTP server. |
rs_cellular_get_http_connect_request_status |
To gets the HTTP connection request status. |
rs_cellular_http_connect_status |
To gets the current HTTP connection status |
rs_cellular_get_http_publish_state |
To gets the publish state of the HTTP client. |
rs_cellular_set_http_publish_state |
To set the publish state of the HTTP client. |
rs_cellular_get_http_status |
To gets the connection status of the HTTP client. |
rs_cellular_get_http_state |
To gets the current HTTP state. |
rs_cellular_http_post |
To Post data through HTTP. |
rs_cellular_http_getx |
To perform getx request through HTTP. |
rs_cellular_http_get |
To perform get request through HTTP. |
rs_cellular_http_update_header |
To update HTTP header. |
rs_cellular_http_update_url |
To update HTTP url. |
rs_cellular_register_http_callback |
To registers an HTTP callback function. |
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