Module COMX GSM

Example

Perform a Ping test, establish a TCP connection and send a message via an M5Stack device, while also sending and receiving HTTP requests, and display the results of these operations on the screen.

from m5stack import *
from m5ui import *
from uiflow import *
from comx.sim800 import SIM800

setScreenColor(0x222222)

gsm = SIM800()

if gsm.tcp_client(0, '118.190.93.84', 2317, 'Hai M5'):
  label5.setText('Success')
else:
  label5.setText('Unsuccess')
gsm.http_destroy()
label3.setText(str(gsm.http_services(1, 'http://header.json-json.com/', 'application/x-www-form-urlencoded', 'hai m5')))
label3.setText(str(gsm.http_services(0, 'http://api.m5stack.com/v1', 'application/json', '')))

API

gsm.get_gprs_network_registration()

• Checks the GPRS network registration status, returning whether the module has successfully registered to the GPRS network.

gsm.check_gprs_service()

• Checks the GPRS service status, confirming whether GPRS service is available.

gsm.get_network_registration()

• Checks the network registration status, returning whether the module has successfully registered to a cellular network.

gsm.get_single_quality()

• Checks the signal quality, returning the current signal strength information, which is used to assess the quality of the network connection.

gsm.check_status()

• Checks the module's status, returning the current operating status of the module, including whether it is functioning properly or if there are any errors.

gsm.get_CCID()

• Retrieves the SIM card's CCID (Integrated Circuit Card Identifier), which is the unique identifier of the SIM card.

gsm.get_IMEI()

• Retrieves the device's IMEI (International Mobile Equipment Identity), which is the unique identifier used to identify mobile devices.

gsm.http_destroy()

• Destroys the HTTP session and frees resources. This is used to terminate the current HTTP connection.

gsm.http_services(0, '', 'application/json', '')

• Sends a request using the specified HTTP method (GET, POST, etc.) to a specific URL and processes the response.
  • method: Select the HTTP method, such as GET or POST.
  • url: Specify the target URL.
  • content type: Select the content type, such as JSON or TEXT.
  • payload: The data payload to be sent in POST or PUT requests.

gsm.ping_request('')

• Sends a Ping request to the specified URL to test the responsiveness of that URL or the quality of the network connection.

gsm.set_command_echo_mode(0)

• Sets the command echo mode. 0 disables echoing, 1 enables echoing. When set to OFF, the device will not echo back the command characters after sending AT commands.

gsm.PDP_address(1)

• Sets the context identifier (CID) for the PDP (Packet Data Protocol) address. CID is used to identify the network context.

gsm.set_PDP_context_status(1)

• Sets the PDP context status. Active means activating the PDP context for network connection and data transmission.

gsm.http_services(0, '', 'application/json', '')

• Creates a TCP client connection.
  • method: Specify as TCP protocol.
  • IP: The IP address of the target server.
  • port: The port number of the target server.
  • payload: The data payload to be sent.