M5 BLE

M5 BLE is a library that M5Stack has developed by wrapping the Low Level BLE of Micropython. It provides simpler and more user-friendly APIs.

BLE Client example:

# client
from m5ble import M5BLE

UUID_SERVICE1 = "6E400011-B5A3-F393-E0A9-E50E24DCCA9E"
UUID_SERVICE1_WR = "6E400012-B5A3-F393-E0A9-E50E24DCCA9E"
UUID_SERVICE1_RD = "6E400013-B5A3-F393-E0A9-E50E24DCCA9E"

UUID_SERVICE2 = "6E400021-B5A3-F393-E0A9-E50E24DCCA9E"
UUID_SERVICE2_WR = "6E400022-B5A3-F393-E0A9-E50E24DCCA9E"
UUID_SERVICE2_RD = "6E400023-B5A3-F393-E0A9-E50E24DCCA9E"

connected = False
def on_connected(client):
    global connected
    print(client._service_handle_map)
    connected = True
    ble.client.set_mtu(128)

def on_disconnected(client, conn_handle, addr_type, addr):
    global connected
    connected = False

ble = M5BLE.Device(verbose=True)
ble.client.scan(target_name_prefix="M5")
ble.client.on_connected(on_connected)

try:
    while True:
        if connected:
            ble.client.write("Hello Service 1", UUID_SERVICE1_WR, UUID_SERVICE1)
            ble.client.write("Hello Service 2", UUID_SERVICE2_WR, UUID_SERVICE2)
            time.sleep(0.1)
            print(ble.client.read(UUID_SERVICE1_RD, UUID_SERVICE1))
            print(ble.client.read(UUID_SERVICE2_RD, UUID_SERVICE2))
        time.sleep(1)
except KeyboardInterrupt:
    gc.collect()
    print("\nExiting...")

BLE Server example:

# server
from m5ble import M5BLE

UUID_SERVICE1 = "6E400011-B5A3-F393-E0A9-E50E24DCCA9E"
UUID_SERVICE1_WR = "6E400012-B5A3-F393-E0A9-E50E24DCCA9E"
UUID_SERVICE1_RD = "6E400013-B5A3-F393-E0A9-E50E24DCCA9E"

UUID_SERVICE2 = "6E400021-B5A3-F393-E0A9-E50E24DCCA9E"
UUID_SERVICE2_WR = "6E400022-B5A3-F393-E0A9-E50E24DCCA9E"
UUID_SERVICE2_RD = "6E400023-B5A3-F393-E0A9-E50E24DCCA9E"

def onReceive(server, client):
    print("onReceive")
    if client.any(UUID_SERVICE1_WR):
        client.write(client.read(UUID_SERVICE1_WR), UUID_SERVICE1_RD)
    if client.any(UUID_SERVICE2_WR):
        client.write(client.read(UUID_SERVICE2_WR), UUID_SERVICE2_RD)

ble = M5BLE.Device(verbose=True)
ble.server.add_service(UUID_SERVICE1, [
    ble.server.create_characteristic(UUID_SERVICE1_RD, notify=True, read=True),
    ble.server.create_characteristic(UUID_SERVICE1_WR, write=True),
])
ble.server.add_service(UUID_SERVICE2, [
    ble.server.create_characteristic(UUID_SERVICE2_RD, notify=True, read=True),
    ble.server.create_characteristic(UUID_SERVICE2_WR, write=True),
])
ble.server.start()
ble.server.on_receive(onReceive)
while True:
    pass

UIFLOW2 client example:

m5ble_client_cores3_example.m5f2

UIFLOW2 server example:

m5ble_server_cores3_example.m5f2

M5BLE

Constructor

class M5BLE.Device(name)

Creates an M5BLE object.

name The BLE broadcast name, used for device discovery and identification.

UIFLOW2:

Device Methods

M5BLE.Device.get_mtu()

Retrieves the maximum transmission unit (MTU) for BLE connections, measured in bytes.

UIFLOW2:

M5BLE.Device.deinit()

Closes the BLE connection and releases resources.

UIFLOW2:

Client Methods

M5BLE.Device.client.on_connected(callback)

Sets the callback function for successful BLE connection.

callback Callback function upon connection, parameter is callback(M5BLE.Client).

UIFLOW2:

M5BLE.Device.client.on_disconnected(callback)

Sets the callback function for BLE disconnection.

callback Callback function upon disconnection, parameters are callback(M5BLE.Client, conn_handle, addr_type, addr).

UIFLOW2:

M5BLE.Device.client.on_server_found(callback)

Sets the callback function for BLE service discovery.

callback Callback function for service discovery, parameters are callback(M5BLE.Client, (name, addr_type, addr, adv_type, rssi, adv_data)).

UIFLOW2:

M5BLE.Device.client.on_scan_finished(callback)

Sets the callback function for the end of BLE scanning.

callback Callback function at the end of scanning, parameter is callback(M5BLE.Client, scan_result=[]).

UIFLOW2:

M5BLE.Device.client.on_read_complete(callback)

Sets the callback function for completed BLE reads.

callback Callback function upon read completion, parameters are callback(M5BLE.Client, conn_handle, value_handle, char_data).

UIFLOW2:

M5BLE.Device.client.on_notify(callback)

Sets the callback function for BLE notifications.

callback Notification callback function, parameter is callback(M5BLE.Client).

UIFLOW2:

M5BLE.Device.client.scan(timeout=2000, connect_on_found=True, target_name_prefix='M5UiFlow', target_uuid=None)

Scans for BLE devices.

timeout Scan timeout, in milliseconds, default is 2000ms.
connect_on_found Whether to automatically connect to devices when found, default is True.
target_name_prefix Name prefix for targeted devices, default is ‘M5UiFlow’.
target_uuid UUID of the targeted device.

UIFLOW2: