MQTTPoE Unit
The MQTTPoE Unit
is an Ethernet communication module specifically designed for MQTT communication. It features supports PoE power and embedded W5500 Ethernet chip, which enables seamless connectivity to Ethernet networks. The module also includes a UART communication interface, allowing for control via AT commands. In addition, it integrates an RJ45 adaptive 10/100M network port for easy network connectivity.
Note
The PoE version has integrated PoE power, with 1.2A@5V (6W) load capability.
Support the following products:
Micropython Example:
import os, sys, io
import M5
from M5 import *
from unit import MQTTPoEUnit
import time
def mqtt_0_SubTopic_event(data):
global mqttpoe_0
print(data[0])
print(data[1])
mqttpoe_0 = MQTTPoEUnit(port=(18, 17))
mqttpoe_0.set_client('m5-mqtt-2024', 'mqtt.m5stack.com', 1883, '', '', 120)
mqttpoe_0.set_subscribe('SubTopic', mqtt_0_SubTopic_event, 0)
mqttpoe_0.set_connect()
while True:
mqttpoe_0.check_msg()
time.sleep_ms(50)
UIFLOW2 Example:
class MQTTPoEUnit
Constructors
- class MQTTPoEUnit(port=(, ))
Create a MQTTPoEUnit object
- The parameters is:
port
uart pin tuple, which contains:(tx_pin, rx_pin)
.
UIFLOW2:
Methods
- MQTTPoEUnit.set_client(client_id, server, port=0, username=None, password=None, keepalive=0)
- Parameters:
client_id (str) – the unique client id string used when connecting to the broker.
server (str) – the hostname or IP address of the remote broker.
port (int) – the network port of the server host to connect to.
username (str or None) – a username for broker authentication.
password (str or None) – a password for broker authentication.
keepalive (int) – maximum period in seconds allowed between communications with the broker. If no other messages are being exchanged, this controls the rate at which the client will send ping messages to the broker.
UIFLOW2:
- MQTTPoEUnit.set_connect()
Connect to a server.
UIFLOW2:
- MQTTPoEUnit.set_disconnect()
Disconnect from a server, release resources.
UIFLOW2:
- MQTTPoEUnit.set_publish(topic, msg, qos=0)
Publish a message.
- Parameters:
UIFLOW2:
- MQTTPoEUnit.set_subscribe(topic, handler, qos=0)
Subscribe to a topic.
- Parameters:
topic (str or bytes or bytearray) – a string specifying the subscription topic to subscribe to.
handler (function) – called when a message has been received on a topic that the client subscribes to and the message does match an existing topic filter callback.
qos (int) – the desired quality of service level for the subscription. Defaults to 0.
Note
When using this block, the “MQTT connect” block must be set after this block
The server can only subscribe to four topics at a time
UIFLOW2:
An handler showing a message has been received:
def mqtt_0_SubTopic_event(data): print("topic:", data[0]) print("msg:", data[1])
On uiflow2, you can get the topic and message of the current handler through and .
- MQTTPoEUnit.check_msg()
Important
check_msg()
is “main loop iteration” methods, blocking and non-blocking version. They should be called periodically in a loop,check_msg()
if you don’t have any other foreground tasks to perform (i.e. your app just reacts to subscribed MQTT messages).Note that you don’t need to call
check_msg()
if you only publish messages.check for a server message.
UIFLOW2:
- MQTTPoEUnit.check_modem_is_ready()
To check whether the communication with the MQTT unit has been successful.
Return:
bool
: True or False
UIFLOW2:
- MQTTPoEUnit.get_firmware_version()
Get the current firmware version number.
Return:
string
UIFLOW2:
- MQTTPoEUnit.get_baudrate()
Get the current baud rate of the module and the default baud rate is 9600.
Return:
int
: 4800, 9600, 19200, 34800, 115200, 230400
UIFLOW2:
- MQTTPoEUnit.get_network_status()
To check whether the network status is connected or disconnected.
Return:
int
: 0 ~ 1
UIFLOW2:
- MQTTPoEUnit.get_network_parameters(param)
Get the current actual IP address, subnet mask, gateway and DNS server of the module.
- The parameters is:
param
: IP address = 0, subnet mask = 1, gateway = 2, DNS server = 3.
UIFLOW2:
- MQTTPoEUnit.get_mac_address()
Get the current MAC address of the module and MAC address the format is: XX-XX-XX-XX-XX-XX.
Return:
string
: “XX-XX-XX-XX-XX-XX”
UIFLOW2:
- MQTTPoEUnit.get_static_ip(param)
Get the current actual IP address, subnet mask and gateway of the module.
- The parameters is:
param
: IP address = 0, subnet mask = 1, gateway = 2, DNS server = 3.
UIFLOW2:
- MQTTPoEUnit.get_dhcp_status()
Get the inquire about enable/disable DHCP status
Return:
int
: 1: Enable, 0: Disable
UIFLOW2:
- MQTTPoEUnit.set_dhcp_state(state)
Set the enable/disable DHCP
- The parameters is:
state
: Disable = 0, Enable = 1.
UIFLOW2:
- MQTTPoEUnit.set_static_ip(ip, subnet, gateway)
Set the static IP address of the MQTT module.
Note
When the DHCP function is enabled, the static IP setting will not be enabled.
- The parameters is:
ip
: “xxx.xxx.xxx.xxx”subnet
: “xxx.xxx.xxx.xxx”gateway
: “xxx.xxx.xxx.xxx”
UIFLOW2: