v5.0.0: add sx126x support, fix ESP32 integration

[terrillmoore]

This is a major release, with potentially breaking changes.

Potentially breaking changes:

• all hal_... global symbols were renamed lmic_hal_.... The effect should be small for user code, but the compliance sketch needed to be fixed. So you may have problems.

Enhancements include:

• support for SX1261 and SX1262 radios
• documentation updates
• bug fixes

Caveats:

• I have not run the RedwoodComm LoRaWAN compliance tests for this release.
• I do not have a SX126x platform for test purposes (recommendations solicited)
• I have not investigated whether things can be integrated more cleanly with modern Arduino CLI/IDE. WIth Arduino CLI, you can pass #define from the command line; I imagine this is also possible with the IDE. There may be better ways to configure the library these days.

What's Changed (automatically generated)

• fix Enable device time request by default in config.h #840: enable device time request by default by @dhineshkumarmcci in fix #840: enable device time request by default #844
• add include for u1_t type by @supcik in add include for u1_t type #914
• Add driver for SX126x modems by @TristanWebber in Add driver for SX126x modems #949
• This is version 4.2.0-pre2 by @terrillmoore in This is version 4.2.0-pre2 #964
• Fixed small typo by @Xraydylan in Fixed small typo #956
• Initialize dht in ttn-abp-feather-us915-dht22 example by @jlesech in Initialize dht in ttn-abp-feather-us915-dht22 example #902
• Update HOWTO-ADD-REGION.md by @wlwatkins in Update HOWTO-ADD-REGION.md #879
• Address various issues related to SX126x support by @terrillmoore in Address various issues related to SX126x support #973
• Rename hal_ exports to lmic_hal_ by @terrillmoore in Rename hal_ exports to lmic_hal_ #974
• Fix AVR regression tests are failing #967: Add DISABLE_LMIC_FAILURE_TO on AVR test compiles to save space by @terrillmoore in Fix #967: Add DISABLE_LMIC_FAILURE_TO on AVR test compiles to save space #975
• Prepare documentation for v5.0.0 release by @terrillmoore in Prepare documentation for v5.0.0 release #980
• Release version v5.0.0 by @terrillmoore in Release version v5.0.0 #981

New Contributors

• @supcik made their first contribution in add include for u1_t type #914
• @TristanWebber made their first contribution in Add driver for SX126x modems #949
• @Xraydylan made their first contribution in Fixed small typo #956
• @jlesech made their first contribution in Initialize dht in ttn-abp-feather-us915-dht22 example #902
• @wlwatkins made their first contribution in Update HOWTO-ADD-REGION.md #879

Full Changelog: v4.1.1...v5.0.0

---

This discussion was created from the release v5.0.0: add sx126x support, fix ESP32 integration.

[aemmenet]

Testing Seeed Studio Wio-SX1262 module. So far no success.
RadioLib runs fine with this modul but uses to much flash memory.
// SX1262 radio = new Module(NSS/CS, Busy, Reset, DIO1);
SX1262 radio = new Module(7, 15, 14, 16); // PA7, PD3, PD2, PD4

[TristanWebber]

Hi Kurt. What's your code?

…

On Sun, 9 Feb 2025, 2:08 am Kurt J. Marti, ***@***.***> wrote: Testing Seeed Studio Wio-SX1262 module. So far no success. — Reply to this email directly, view it on GitHub <#982 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AY6BUJ6U6M3YZ56MVSI52O32OYMYHAVCNFSM6AAAAABR6V3ETKVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTEMJQGM2TSNQ> . You are receiving this because you were mentioned.Message ID: ***@***.*** com>

[TristanWebber]

Ok, it looks like it is failing in init.

The SX126x family, in addition to the pinmap, needs a couple of other things setup. In particular, queryBusyPin(), queryUsingDcdc(), queryUsingDIO2AsRfSwitch() and queryUsingDIO3AsTCXOSwitch() methods from the HalConfiguration_t class may need to be overridden for some boards (refer here. A finished example of this class is in this pinmap). From the Seeed Studio Wio-SX1262 documentation you'll need to establish which of those methods you will need to override. Feel free to create an issue and tag me in it if you want to walk through in more detail.

I suspect I should make a new example in the library for the SX126x family, because any SX126x board that doesn't already have a pinmap in the HAL will need this treatment.

[aemmenet]

Thank you for the extensive, very detailed reply. I'm sure I need some time to process the information. I'll be happy to get back to you as soon as I have further questions or informations. The new Seeed Studio module Wio-SX1262 will certainly increase the desire for an MCCI LMIC solution.

A new SX1262 example in the library would certainly help to better understand the new requirements in the setup.

[TristanWebber]

Kurt, I have added a PR for a new example showing how to do advanced configuration, including for SX126x family radios. You should be able to access the example, even though the PR is not merged.

Based on Seeed's documentation for the Wio-SX1262, the following would configure it correctly, and you would need to add the four communications pins (SS, BUSY, DIO1, RST) between your host controller and the radio:

// Advanced HalConfiguration
// Example is for Wio-SX1262 for XIAO
class cHalConfiguration_t: public Arduino_LMIC::HalConfiguration_t
{
public:
    // All SX126x series modems need the busy pin to be defined
    // by overriding the `queryBusyPin()` method.
    virtual u1_t queryBusyPin(void) override { return YOUR_BUSY_PIN; };

    // Wio-SX1262 uses DC-DC buck regulator
    virtual bool queryUsingDcdc(void) override { return true; };

    // Wio-SX1262 uses DIO2 to drive rf switch
    virtual bool queryUsingDIO2AsRfSwitch(void) override { return true; };

    // Wio-SX1262 uses DIO3 to drive power supply to TXCO
    virtual bool queryUsingDIO3AsTCXOSwitch(void) override { return true; };
};

cHalConfiguration_t myConfig;

// Pin mapping
const lmic_pinmap lmic_pins = {
    .nss = YOUR_SS_PIN,
    .rxtx = LMIC_UNUSED_PIN,
    .rst = YOUR_RST_PIN,
    .dio = {YOUR_DIO1_PIN, LMIC_UNUSED_PIN, LMIC_UNUSED_PIN},
    .rxtx_rx_active = 0,
    .rssi_cal = 10,
    .spi_freq = 8000000,
    // Advanced configurations are passed to the pinmap via pConfig
    .pConfig = &myConfig,
};

[aemmenet]

Based on Your configuration suggestion my Wio-SX1262 example sketch is running fine! Thank you very much for the great help.

18:42:31.536 -> Starting
18:42:31.536 ->
18:42:31.715 -> Sensor Bosch BME280:
18:42:31.715 -> Temperature = 23.53 °C
18:42:31.715 -> Humidity = 38.00 %
18:42:31.715 -> Pressure = 967.33 mbar
18:42:31.715 ->
18:42:31.715 -> Packet queued
18:42:31.715 -> 95802: EV_JOINING
18:42:33.700 -> 217275: EV_TXSTART
18:42:38.871 -> 540886: EV_JOINED
18:42:38.871 ->
18:42:39.366 -> NetID: 19
18:42:39.366 -> DevAddr: 260Bxxxx
18:42:39.366 -> AppSKey: 59-65-0B-86-E8-42-5E-D0-xx-xx-xx-xx-xx-xx-xx-xx
18:42:39.366 -> NwkSKey: 38-E4-86-1D-35-68-80-20-xx-xx-xx-xx-xx-xx-xx-xx
18:42:39.409 ->
18:42:39.409 -> 574648: EV_TXSTART
18:42:45.562 -> 959303: EV_TXCOMPLETE (includes waiting for RX windows)
18:42:45.562 -> Up: 1, Down: 0
18:42:45.562 ->

I will document my project in more detail here: https://github.com/aemmenet/polylab#work-in-progress-mikrobus-board-with-seeed-studio-wio-sx1262-module

[terrillmoore]

Code has been merged onto HEAD (#999). A patch release is pending.