Module IoT Base NB

API

nbiot.get_gprs_network_registration()

• Checks if the device is registered on the GPRS network.

nbiot.get_network_registration()

• Checks if the device is successfully registered on the network (general network registration check).

nbiot.get_single_quality()

• Checks the signal quality of the current network and returns signal strength information.

nbiot.check_status()

• Checks the status of the module to see if it's working properly or if there are any issues.

nbiot.coap_destroy()

• Destroys the CoAP connection, closing the CoAP session or releasing related resources.

nbiot.coap_get('/m5stack-get')

• Executes a CoAP GET request with the specified URL. You can set security options, but here none is selected (None).

nbiot.coap_to_connect('120.77.157.90', 5683)

• Initializes the CoAP connection by specifying the target server's IP address (e.g., 120.77.157.90) and port (e.g., 5683).

nbiot.coap_post('/m5stack-post', '', content_format=0)

• Sends a CoAP POST request with the specified URL. The content (payload) is sent in plain text (TEXT_PLAIN) format. The URL here is /m5stack-post.

nbiot.coap_put('/m5stack-put', '', content_format=0)

• Sends a CoAP PUT request with the specified URL, used to update resources or data. The payload's content format is also TEXT_PLAIN, and the URL is /m5stack-put.

nbiot.get_ezdata(ezdata_get_NRZBHcb, 'GCJ3Ic5h2eXnzV3rT3bBXvrncCaJnART', '')

• Asynchronously retrieves data from the cloud platform by specifying the topic and token.

nbiot.remove_ezdata('GCJ3Ic5h2eXnzV3rT3bBXvrncCaJnART', '')

• Removes the specified topic from the cloud platform using the given token.

nbiot.set_ezdata('GCJ3Ic5h2eXnzV3rT3bBXvrncCaJnART', '', '', 0)

• Saves data to the specified topic, with a token for verification.

nbiot.get_CCID()

• Retrieves the CCID (Integrated Circuit Card Identifier) of the device, typically used to identify the SIM card.

nbiot.get_IMEI()

• Retrieves the IMEI (International Mobile Equipment Identity) of the device, used to uniquely identify mobile devices.

nbiot.modbus_init(15, 13, 115200, 1, 1)

• Initializes Modbus communication, configuring the Tx and Rx pins, baud rate, mode (master/slave), and slave address.

modbus.read_coils(1, 1, 0)

• Reads the status of coils from the specified slave address and start address, with configurable coil quantity.

modbus.read_discrete_inputs(1, 1, 0)

• Reads the status of discrete inputs from the specified slave address, with configurable start address and input quantity.

modbus.read_holding_registers(1, 1, 0, True)

• Reads the values of holding registers, specifying slave address, start address, and register quantity, with an option to read signed values.

modbus.read_input_registers(1, 1, 0, True)

• Reads the values of input registers, specifying slave address, start address, and register quantity, with an option to read signed data.

modbus.write_multiple_coils(1, 1, 0)

• Writes output values to multiple coils, specifying slave address, start address, and output values.

modbus.write_multiple_registers(1, 1, 0, True)

• Writes values to multiple registers, specifying slave address, start address, register values, with an

option to write signed data.

modbus.write_single_coil(1, 1, 0)

• Writes output values to a single coil, specifying slave address, output address, and output value.

modbus.write_single_register(1, 1, 0, True)

• Writes values to a single register, specifying slave address, register address, and register value, with an option to write signed data.

1~8

• Sets the function code of the slave for reading coil status.
  • 1:READ_COILS_STATUS
  • 2:READ_INPUT_STATUS
  • 3:READ_HOLDING_REGISTERS
  • 4:READ_INPUT_REGISTERS
  • 5:WRITE_SINGLE_COIL
  • 6:WRITE_SINGLE_REGISTER
  • 7:WRITE_MULTIPLE_COILS
  • 8:WRITE_MULTIPLE_REGISTERS

modbus.find_address

• Retrieves the address information of the slave.

modbus.find_function

• Retrieves the current function code being used.

modbus.find_quantity

• Retrieves the number of data points to be read.

modbus.function_init(1, 0, 0)

• Initializes the Modbus slave function, setting the start address and quantity to be read, used for reading coil status.

modbus.receive_req_create_pdu()

• Used to receive the Application Data Unit (ADU) request from the master.

modbus.create_slave_response(1)

• Sends the ADU response, typically used by the slave to reply to the master request.

modbus.update_process(1, 0, 0, [0, 0, 0])

• Updates the Modbus function block (e.g., READ_COILS_STATUS) data, setting the start address, quantity, and values to write.

nbiot.modem_power(True)

• Controls the power switch of the communication module, with options to turn it on or off.

nbiot.mqtt_check_connection()

• Checks the MQTT connection status, ensuring the device is properly connected to the MQTT server.

nbiot.mqtt_to_connect('mqtt.m5stack.com', 1883, '', '', '', 120)

• Initializes the connection to the MQTT server, setting the server address, port, client ID, username, password, and heartbeat interval. Used to connect to the MQTT server for data communication.

nbiot.mqtt_disconnect()

• Disconnects from the MQTT server.

nbiot.mqtt_poll()

• Polls and receives messages from the MQTT server.

nbiot.mqtt_publish('', '', 0)

• Publishes a message to the specified MQTT topic, including the payload and Quality of Service (QoS) level.

nbiot.mqtt_subscribe('', iotbase_mqtt_cb, 0)

• Subscribes to the specified MQTT topic, receiving messages from that topic. QoS defines the message service quality level.

def iotbase_mqtt_cb(nb_mq_topic, nb_mq_payload):
  global ezdata_value1, nb_topic, nb_msg
  nb_topic = nb_mq_topic
  nb_msg = nb_mq_payload
  pass

• Registers a callback function to handle messages received from the subscribed MQTT topic. nb_topic and nb_msg are used to get the topic and message content.

nbiot.mqtt_unsubscribe('')

• Unsubscribes from the specified MQTT topic.

nbiot.poweroff()

• Powers off the module, usually for saving energy or shutting down the device.

nbiot.reset()

• Resets the module, restoring it to its initial state.

nbiot.set_command_echo_mode(0)

• Sets the command echo mode. You can choose whether to display the command echo returned by the device when executing commands.

<img class="blockly_svg" src=" https://m5stack.oss-cn-shenzhen.aliy

uncs.com/resource/docs/static/assets/img/uiflow/blockly/modules/iot_base_nb/uiflow_block_iotbase_uart_any.svg">

modbus._mdbus_uart.any()

• Checks and retains cached data, used to determine whether there is unread data in the UART buffer.

modbus._mdbus_uart.read()

• Reads all data in the UART buffer.

modbus._mdbus_uart.readline()

• Reads a line of data from UART until a newline character is encountered.

modbus._mdbus_uart.read(10)

• Reads the specified number of characters from UART. In this example, it reads 10 characters.

modbus._mdbus_uart.write('')

• Writes the specified text or data to the UART port.

modbus._mdbus_uart.write(''+"\r\n")

• Writes the specified text or data to the UART port in the form of a line, appending a newline character at the end.

modbus._mdbus_uart.write(bytes([0, 0, 0]))

• Writes raw data to the UART in the form of a byte list. This block can send binary data, commonly used for transmitting raw or non-text data.