LoRa868 Cap

Cap LoRa868 是一款专为 Cardputer-Adv 设计的高性能 LoRa 通信和 GNSS 全球导航扩展模块。

支持以下产品:

UIFLOW2 应用示例

发送端

在 UiFlow2 中打开 cardputer_adv_lora868_cap_sender_example.m5f2 项目。

使用键盘输入要发送的文本，然后按 ENTER 键发送。

UiFlow2 代码块：

示例输出：

None

接收端

在 UiFlow2 中打开 cardputer_adv_lora868_cap_receiver_example.m5f2 项目。

此示例接收并显示数据。

UiFlow2 代码块：

示例输出：

None

GPS 使用

在 UiFlow2 中打开 cardputer_adv_lora868_cap_gps_example.m5f2 项目。

此示例演示如何使用 LoRa868 Cap 的 GPS 功能。

UiFlow2 代码块：

示例输出：

None

MicroPython 示例

发送端

使用键盘输入要发送的文本，然后按 ENTER 键发送。

MicroPython 代码块：

# SPDX-FileCopyrightText: 2025 M5Stack Technology CO LTD
#
# SPDX-License-Identifier: MIT

import os, sys, io
import M5
from M5 import *
from hardware import MatrixKeyboard
from cap import LoRa868Cap
from unit import KeyCode


kb = None
cap_lora868 = None


keycode = None
key = None
buf = None


def kb_pressed_event(kb_0):
    global kb, cap_lora868, keycode, key, buf
    keycode = kb.get_key()
    if keycode >= 0x20 and keycode <= 0x7E:
        key = chr(keycode)
        buf = str(buf) + str(key)
        M5.Lcd.printf(key)
    elif keycode == (KeyCode.KEYCODE_ENTER):
        cap_lora868.send(buf, None)
        buf = ""
        M5.Lcd.fillScreen(0x000000)
        M5.Lcd.setCursor(0, 0)
        M5.Lcd.printf("\n")
        M5.Lcd.printf(">>> ")


def setup():
    global kb, cap_lora868, keycode, key, buf

    M5.begin()
    Widgets.fillScreen(0x000000)

    cap_lora868 = LoRa868Cap(
        freq_khz=868000,
        bw="250",
        sf=8,
        coding_rate=8,
        preamble_len=12,
        syncword=0x12,
        output_power=10,
    )
    kb = MatrixKeyboard()
    kb.set_callback(kb_pressed_event)
    M5.Lcd.setFont(Widgets.FONTS.DejaVu12)
    M5.Lcd.setTextColor(0xFFFFFF, 0x000000)
    M5.Lcd.setCursor(0, 0)
    M5.Lcd.printf(">>> ")
    buf = ""


def loop():
    global kb, cap_lora868, keycode, key, buf
    M5.update()


if __name__ == "__main__":
    try:
        setup()
        while True:
            loop()
    except (Exception, KeyboardInterrupt) as e:
        try:
            from utility import print_error_msg

            print_error_msg(e)
        except ImportError:
            print("please update to latest firmware")

示例输出：

None

接收端

此示例接收并显示数据。

MicroPython 代码块：

# SPDX-FileCopyrightText: 2025 M5Stack Technology CO LTD
#
# SPDX-License-Identifier: MIT

import os, sys, io
import M5
from M5 import *
import time
from cap import LoRa868Cap


cap_lora868 = None


lora_data = None
cur_time = None
time_buf = None
rx_text = None


def cap_lora868_receive_event(received_data):
    global cap_lora868, lora_data, cur_time, time_buf, rx_text
    lora_data = received_data
    cur_time = time.gmtime()
    time_buf = ""
    time_buf = str(time_buf) + str("[")
    time_buf = str(time_buf) + str((cur_time[3]))
    time_buf = str(time_buf) + str(":")
    time_buf = str(time_buf) + str((cur_time[4]))
    time_buf = str(time_buf) + str(":")
    time_buf = str(time_buf) + str((cur_time[5]))
    time_buf = str(time_buf) + str("] -> ")
    M5.Lcd.print(time_buf, 0x33FF33)
    rx_text = lora_data.decode()
    M5.Lcd.print(rx_text, 0xFFFFFF)
    M5.Lcd.printf("\n")


def setup():
    global cap_lora868, lora_data, cur_time, time_buf, rx_text

    M5.begin()
    Widgets.fillScreen(0x000000)

    cap_lora868 = LoRa868Cap(
        freq_khz=868000,
        bw="250",
        sf=8,
        coding_rate=8,
        preamble_len=12,
        syncword=0x12,
        output_power=10,
    )
    cap_lora868.set_irq_callback(cap_lora868_receive_event)
    M5.Lcd.setFont(Widgets.FONTS.DejaVu12)
    M5.Lcd.setCursor(0, 0)
    M5.Lcd.setTextScroll(True)
    cap_lora868.start_recv()


def loop():
    global cap_lora868, lora_data, cur_time, time_buf, rx_text
    M5.update()


if __name__ == "__main__":
    try:
        setup()
        while True:
            loop()
    except (Exception, KeyboardInterrupt) as e:
        try:
            from utility import print_error_msg

            print_error_msg(e)
        except ImportError:
            print("please update to latest firmware")

示例输出：

None

GPS 使用

此示例演示如何使用 LoRa868 Cap 的 GPS 功能。

MicroPython 代码块：

# SPDX-FileCopyrightText: 2025 M5Stack Technology CO LTD
#
# SPDX-License-Identifier: MIT

import os, sys, io
import M5
from M5 import *
from cap import GPSCap


label0 = None
label1 = None
label2 = None
cap_lora868 = None


def setup():
    global label0, label1, label2, cap_lora868

    M5.begin()
    Widgets.fillScreen(0x000000)
    label0 = Widgets.Label("label0", 11, 16, 1.0, 0xFFFFFF, 0x222222, Widgets.FONTS.DejaVu18)
    label1 = Widgets.Label("label1", 11, 46, 1.0, 0xFFFFFF, 0x222222, Widgets.FONTS.DejaVu18)
    label2 = Widgets.Label("label2", 10, 77, 1.0, 0xFFFFFF, 0x222222, Widgets.FONTS.DejaVu18)

    cap_lora868 = GPSCap(id=2)


def loop():
    global label0, label1, label2, cap_lora868
    M5.update()
    label0.setText(str(cap_lora868.get_latitude()))
    label1.setText(str(cap_lora868.get_longitude()))
    label2.setText(str(cap_lora868.get_gps_time()))


if __name__ == "__main__":
    try:
        setup()
        while True:
            loop()
    except (Exception, KeyboardInterrupt) as e:
        try:
            from utility import print_error_msg

            print_error_msg(e)
        except ImportError:
            print("please update to latest firmware")

示例输出：

None

API参考

class LoRa868Cap

class cap.lora868.LoRa868Cap(freq_khz=868000, bw='250', sf=8, coding_rate=8, preamble_len=12, syncword=18, output_power=10)

基类：object

创建一个 LoRa868Cap 对象。

参数:

pin_rst (int) – (RST) 复位引脚号。
pin_cs (int) – (NSS) 片选引脚号。
pin_irq (int) – (IRQ) 中断引脚号。
pin_busy (int) – (BUSY) 忙碌引脚号。
freq_khz (int) – LoRa 射频频率，单位为 KHz，范围为 850000 KHz 至 930000 KHz。
bw (str) – 带宽，选项包括： - "7.8": 7.8 KHz - "10.4": 10.4 KHz - "15.6": 15.6 KHz - "20.8": 20.8 KHz - "31.25": 31.25 KHz - "41.7": 41.7 KHz - "62.5": 62.5 KHz - "125": 125 KHz - "250": 250 KHz - "500": 500 KHz
sf (int) – 扩频因子，范围从 7 到 12。较高的扩频因子可以接收到更弱的信号，但数据速率较慢。
coding_rate (int) – 前向纠错 (FEC) 编码率，表示为 4/N，范围从 5 到 8。
preamble_len (int) – 前导码序列的长度，以符号为单位，范围从 0 到 255。
syncword (int) – 用于标记数据帧开始的同步字，默认为 0x12。
output_power (int) – 输出功率，单位为 dBm，范围从 -9 到 22。

UiFlow2 代码块：

MicroPython 代码块：

from cap import LoRa868Cap

cap_lora868_0 = LoRa868Cap(5, 1, 10, 2, 868000, '250', 8, 8, 12, 0x12, 10)

set_freq(freq_khz=868000)

设置频率，单位为 kHz。

参数:: freq_khz (int) – 频率，单位为 kHz (850000 ~ 930000)，默认为 868000。
返回类型:: None

UiFlow2 代码块：

MicroPython 代码块：

module_lora868v12_0.set_freq(868000)

set_sf(sf)

设置扩频因子 (SF)。

参数:: sf (int) – 扩频因子 (7 ~ 12)
返回类型:: None

UiFlow2 代码块：

MicroPython 代码块：

module_lora868v12_0.set_sf(7)

set_bw(bw)

设置带宽。

参数:: bw (str) – 带宽，单位 kHz，字符串格式。必须是 ‘7.8’、’10.4’、’15.6’、’20.8’、’31.25’、’41.7’、’62.5’、’125’、’250’、’500’ 中的一个。
返回类型:: None

UiFlow2 代码块：

MicroPython 代码块：

module_lora868v12_0.set_bw(bw)

set_coding_rate(coding_rate)

设置编码率。

参数:: coding_rate (int) – 编码率 (5 ~ 8)
返回类型:: None

UiFlow2 代码块：

MicroPython 代码块：

module_lora868v12_0.set_coding_rate(coding_rate)

set_syncword(syncword)

设置同步字。

参数:: syncword (int) – 同步字 (0 ~ 0xFF)
返回类型:: None

UiFlow2 代码块：

MicroPython 代码块：

module_lora868v12_0.set_syncword(syncword)

set_preamble_len(preamble_len)

设置前导码长度。

参数:: preamble_len (int) – 前导码长度，范围：0~255。
返回类型:: None

UiFlow2 代码块：

MicroPython 代码块：

module_lora868v12_0.set_preamble_len(preamble_len)

set_output_power(output_power)

设置输出功率，单位 dBm。

参数:: output_power (int) – 输出功率，单位 dBm (-9 ~ 22)
返回类型:: None

UiFlow2 代码块：

MicroPython 代码块：

module_lora868v12_0.set_output_power(output_power)

send(packet, tx_at_ms=None)

发送数据

参数:

packet (str | list | tuple | int | bytearray) – 要发送的数据。
tx_at_ms (int) – 发送数据的时间戳（毫秒，可选）。默认为 None。
packet

返回:

时间戳

返回类型:

int

发送一个数据包，并在数据包发送后返回时间戳。

UiFlow2 代码块：

MicroPython 代码块：

module_lora868v12_0.send()

recv(timeout_ms=None, rx_length=255, rx_packet=None)

接收数据

参数:

timeout_ms (int) – 超时时间（毫秒，可选）。默认为 None。
rx_length (int) – 要读取的数据长度。默认为 0xFF。
rx_packet (RxPacket) – 一个 RxPacket 实例（可选），用于重用。

返回:

接收到的数据包实例

返回类型:

RxPacket

尝试接收一个 LoRa 数据包。如果超时则返回 None，否则返回接收到的数据包实例。

UiFlow2 代码块：

MicroPython 代码块：

data = module_lora868v12_0.recv()

start_recv()

开始接收数据

该方法启动开始接收数据的过程。

UiFlow2 代码块：

MicroPython 代码块：

module_lora868v12_0.start_recv()

返回类型:: None

set_irq_callback(callback)

设置在 IRQ 上执行的中断回调函数。

参数:: callback – 中断触发时要调用的回调函数。该回调函数不应接受任何参数，也不应返回任何内容。
返回类型:: None

UiFlow2 代码块：

MicroPython 代码块：

module_lora868v12_0.set_irq_callback()

standby()

将模块设置为待机模式。

将 LoRa 模块置于待机模式，功耗更低。

UiFlow2 代码块：

MicroPython 代码块：

module_lora868v12_0.standby()

返回类型:: None

sleep()

将模块设置为睡眠模式。

通过将模块置于深度睡眠模式来降低功耗。

UiFlow2 代码块：

MicroPython 代码块：

module_lora868v12_0.sleep()

返回类型:: None

irq_triggered()

检查 IRQ 触发。

返回:: 如果自上次发送或接收开始以来已触发中断服务例程 (ISR)，则返回 True。
返回类型:: bool

UiFlow2 代码块：

MicroPython 代码块：

module_lora868v12_0.irq_triggered()

class GPSCap

class cap.lora868.GPSCap(id=1, rx=None, tx=None, pps=-1)

基类：ATGM336H

使用特定的 UART ID 和端口初始化 GPSCap 以进行通信。

参数:

id (int) – 与 GPS 模块通信的 UART ID。可以是 0、1 或 2。
rx (int) – 用于 UART 通信的 RX 引脚。如果没有，则使用开发板定义的默认引脚。
tx (int) – 用于 UART 通信的 TX 引脚。如果没有，则使用板定义的默认引脚。
pps (int) – PPS（每秒脉冲）引脚，用于高精度时间同步。默认值为 -1（未使用）。

UiFlow2 代码块：

MicroPython 代码块：

from cap import GPSCap
gps_0 = GPSCap(id=2)