Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[driver] Adding Semtech SX1280/SX1281 driver #1050

Merged
merged 3 commits into from
Aug 15, 2023
Merged

[driver] Adding Semtech SX1280/SX1281 driver #1050

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d214fb7
[architecture] Adding UartDevice for resumable r/w
rasmuskleist Aug 7, 2023
194f3bc
[driver] Adding Semtech SX1280/SX1281 driver
rasmuskleist Aug 7, 2023
517bd84
[example] Adding SX128x LoRa example
rasmuskleist Aug 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -802,17 +802,18 @@ your specific needs.
<td align="center"><a href="https://modm.io/reference/module/modm-driver-stts22h">STTS22H</a></td>
<td align="center"><a href="https://modm.io/reference/module/modm-driver-stusb4500">STUSB4500</a></td>
<td align="center"><a href="https://modm.io/reference/module/modm-driver-sx1276">SX1276</a></td>
<td align="center"><a href="https://modm.io/reference/module/modm-driver-sx128x">SX128X</a></td>
<td align="center"><a href="https://modm.io/reference/module/modm-driver-tcs3414">TCS3414</a></td>
<td align="center"><a href="https://modm.io/reference/module/modm-driver-tcs3472">TCS3472</a></td>
<td align="center"><a href="https://modm.io/reference/module/modm-driver-tlc594x">TLC594x</a></td>
</tr><tr>
<td align="center"><a href="https://modm.io/reference/module/modm-driver-tlc594x">TLC594x</a></td>
<td align="center"><a href="https://modm.io/reference/module/modm-driver-tmp102">TMP102</a></td>
<td align="center"><a href="https://modm.io/reference/module/modm-driver-tmp12x">TMP12x</a></td>
<td align="center"><a href="https://modm.io/reference/module/modm-driver-tmp175">TMP175</a></td>
<td align="center"><a href="https://modm.io/reference/module/modm-driver-touch2046">TOUCH2046</a></td>
<td align="center"><a href="https://modm.io/reference/module/modm-driver-vl53l0">VL53L0</a></td>
<td align="center"><a href="https://modm.io/reference/module/modm-driver-vl6180">VL6180</a></td>
</tr><tr>
<td align="center"><a href="https://modm.io/reference/module/modm-driver-vl6180">VL6180</a></td>
<td align="center"><a href="https://modm.io/reference/module/modm-driver-ws2812">WS2812</a></td>
</tr>
</table>
Expand Down
278 changes: 278 additions & 0 deletions examples/nucleo_g474re/sx128x_lora/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,278 @@
// coding: utf-8
/*
* Copyright (c) 2023, Rasmus Kleist Hørlyck Sørensen
*
* This file is part of the modm project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
// ----------------------------------------------------------------------------

#include <atomic>
#include <cstring>

#include <modm/board.hpp>
#include <modm/debug/logger/logger.hpp>
#include <modm/driver/radio/sx128x.hpp>
#include <modm/platform.hpp>
#include <modm/processing.hpp>

using Sck = GpioA5;
using Miso = GpioA6;
using Mosi = GpioA7;
using SpiMaster = modm::platform::SpiMaster1;

namespace
{

namespace rx
{
std::atomic_bool dio1 = false;
std::atomic_bool dio2 = false;
std::atomic_bool dio3 = false;
}

namespace tx
{
std::atomic_bool dio1 = false;
std::atomic_bool dio2 = false;
std::atomic_bool dio3 = false;
}

static constexpr modm::sx128x::LoRa::ModulationParams modulationParams = {
.spreadingFactor = modm::sx128x::LoRa::ModulationParams::SpreadingFactor::Sf9,
.bandwidth = modm::sx128x::LoRa::ModulationParams::Bandwidth::Bw400,
.codingRate = modm::sx128x::LoRa::ModulationParams::CodingRate::Cr_Li_4_7
};

static constexpr modm::sx128x::LoRa::PacketParams packetParams = {
.preambleLength = 12,
.headerType = modm::sx128x::LoRa::PacketParams::HeaderType::Explicit,
.payloadLength = 4,
.crc = modm::sx128x::LoRa::PacketParams::Crc::Enable,
.invertIq = modm::sx128x::LoRa::PacketParams::InvertIq::Standard
};

}

class RxThread : public modm::sx128x, public modm::pt::Protothread
{
using Reset = GpioB3;
using Busy = GpioB4;
using Dio1 = GpioB5;
using Dio2 = GpioB6;
using Dio3 = GpioB7;

using Nss = GpioD2;
using Transport = modm::Sx128xTransportSpi<SpiMaster, Nss>;

public:
RxThread() {}

inline bool
run()
{
PT_BEGIN();

Nss::setOutput(modm::Gpio::High);
Reset::setOutput(modm::Gpio::Low);
Busy::setInput(modm::platform::Gpio::InputType::PullDown);

Dio1::setInput(modm::platform::Gpio::InputType::PullDown);
Exti::connect<Dio1>(Exti::Trigger::RisingEdge, [](uint8_t) { rx::dio1 = true; });

Dio2::setInput(modm::platform::Gpio::InputType::PullDown);
Exti::connect<Dio2>(Exti::Trigger::RisingEdge, [](uint8_t) { rx::dio2 = true; });

Dio3::setInput(modm::platform::Gpio::InputType::PullDown);
Exti::connect<Dio3>(Exti::Trigger::RisingEdge, [](uint8_t) { rx::dio3 = true; });

PT_CALL(radio.reset());
PT_CALL(radio.setStandby());

// Initialize the sx128x
PT_CALL(radio.setPacketType(PacketType::LoRa));
PT_CALL(radio.setRfFrequency(2457_MHz / radio.frequencyLsb));
PT_CALL(radio.setRegulatorMode(RegulatorMode::Ldo));
PT_CALL(radio.setBufferBaseAddress(0, 0));
PT_CALL(radio.setModulationParams(modulationParams));
PT_CALL(radio.writeRegister(Register::SfAdditionalConfiguration, 0x32));
PT_CALL(radio.writeRegister(Register::FrequencyErrorCorrection, 0x01));
PT_CALL(radio.setPacketParams(packetParams));
PT_CALL(radio.setDioIrqParams(Irq::RxDone | Irq::RxTxTimeout, Irq::RxDone, Irq::RxTxTimeout));
PT_CALL(radio.setRx(sx128x::PeriodBase::ms1, 1000));

MODM_LOG_DEBUG << "Sx128x initialization complete!" << modm::endl;

while (true)
{
if (rx::dio1.exchange(false))
{
PT_CALL(radio.getIrqStatus(&irqStatus));
if (irqStatus.any(Irq::RxDone))
{
PT_CALL(radio.clearIrqStatus(Irq::RxDone | Irq::RxTxTimeout));
PT_CALL(radio.setRx(sx128x::PeriodBase::ms1, 1000));

PT_CALL(radio.getRxBufferStatus(&rxBufferStatus));
PT_CALL(radio.getPacketStatus(&packetStatus));
PT_CALL(radio.readBuffer(rxBufferStatus.rxStartBufferPointer, std::span{buffer, rxBufferStatus.rxPayloadLength}));
salkinium marked this conversation as resolved.
Show resolved Hide resolved

if (rxBufferStatus.rxPayloadLength > 0)
{
uint32_t counter;
std::memcpy((uint8_t *) &counter, buffer, sizeof(counter));
MODM_LOG_DEBUG << "Received Message" << modm::endl;
MODM_LOG_DEBUG << "Counter: " << counter << modm::endl;
}
}
}

if (rx::dio2.exchange(false))
{
PT_CALL(radio.getIrqStatus(&irqStatus));
if (irqStatus.any(Irq::RxTxTimeout))
{
// RxTxTimeout Interrupt received!
// Clear irq and set to rx again.
PT_CALL(radio.clearIrqStatus(Irq::RxTxTimeout));
PT_CALL(radio.setRx(sx128x::PeriodBase::ms1, 1000));
MODM_LOG_DEBUG << "RxTxTimeout Interrupt!" << modm::endl;
}
}
PT_YIELD();
}
PT_END();
}

private:
Irq_t irqStatus;
PacketStatus packetStatus;
RxBufferStatus rxBufferStatus;

modm::Sx128x< Transport, Reset, Busy > radio;

private:
static constexpr size_t bufferSize = 256;
uint8_t buffer[bufferSize];
} rxThread;

class TxThread : public modm::sx128x, public modm::pt::Protothread
{
using Reset = modm::platform::GpioC2;
using Busy = modm::platform::GpioC3;
using Dio1 = modm::platform::GpioA0;
using Dio2 = modm::platform::GpioA1;
using Dio3 = modm::platform::GpioA2;

using Nss = modm::platform::GpioC1;
using Transport = modm::Sx128xTransportSpi<SpiMaster, Nss>;

public:
TxThread() : timer(std::chrono::milliseconds(500)) {}

inline bool
run()
{
PT_BEGIN();

Nss::setOutput(modm::Gpio::High);
Reset::setOutput(modm::Gpio::Low);
Busy::setInput(modm::platform::Gpio::InputType::PullDown);

Dio1::setInput(modm::platform::Gpio::InputType::PullDown);
Exti::connect<Dio1>(Exti::Trigger::RisingEdge, [](uint8_t) { tx::dio1 = true; });

Dio2::setInput(modm::platform::Gpio::InputType::PullDown);
Exti::connect<Dio2>(Exti::Trigger::RisingEdge, [](uint8_t) { tx::dio2 = true; });

Dio3::setInput(modm::platform::Gpio::InputType::PullDown);
Exti::connect<Dio3>(Exti::Trigger::RisingEdge, [](uint8_t) { tx::dio3 = true; });


PT_CALL(radio.reset());
PT_CALL(radio.setStandby());

// Initialize the sx128x
PT_CALL(radio.setPacketType(PacketType::LoRa));
PT_CALL(radio.setRfFrequency(2457_MHz / radio.frequencyLsb));
PT_CALL(radio.setRegulatorMode(RegulatorMode::Ldo));
PT_CALL(radio.setBufferBaseAddress(0, 0));
PT_CALL(radio.setModulationParams(modulationParams));
PT_CALL(radio.writeRegister(Register::SfAdditionalConfiguration, 0x32));
PT_CALL(radio.writeRegister(Register::FrequencyErrorCorrection, 0x01));
PT_CALL(radio.setPacketParams(packetParams));
PT_CALL(radio.setDioIrqParams(Irq::TxDone | Irq::RxTxTimeout, Irq::TxDone, Irq::RxTxTimeout));

MODM_LOG_DEBUG << "Sx128x initialization complete!" << modm::endl;

while (true)
{
if (tx::dio1.exchange(false))
{
PT_CALL(radio.getIrqStatus(&irqStatus));
if (irqStatus.any(Irq::TxDone))
{
PT_CALL(radio.clearIrqStatus(Irq::TxDone));
irqStatus.reset(Irq::TxDone);

MODM_LOG_DEBUG << "Message sent" << modm::endl;
MODM_LOG_DEBUG << "Counter: " << counter << modm::endl;
counter++;
}
}

if (tx::dio2.exchange(false))
{
PT_CALL(radio.getIrqStatus(&irqStatus));
if (irqStatus.any(Irq::RxTxTimeout))
{
PT_CALL(radio.clearIrqStatus(Irq::RxTxTimeout));
irqStatus.reset(Irq::RxTxTimeout);
MODM_LOG_DEBUG << "Received a timeout" << modm::endl;
}
}

if (timer.execute())
{
PT_CALL(radio.writeBuffer(0, std::span<const uint8_t>{(uint8_t *) &counter, sizeof(counter)}));
PT_CALL(radio.setTx(PeriodBase::ms1, 100));
}
PT_YIELD();
}

PT_END();
}

private:
Irq_t irqStatus;
modm::Sx128x< Transport, Reset, Busy > radio;

uint32_t counter = 0;
modm::PeriodicTimer timer;
};

int
main()
{
Board::initialize();

SpiMaster::connect<Mosi::Mosi, Mosi::Mosi, Sck::Sck>();
SpiMaster::initialize<Board::SystemClock, 21.5_MHz>();

MODM_LOG_INFO << "==========SX128x Test==========" << modm::endl;
MODM_LOG_DEBUG << "Debug logging here" << modm::endl;
MODM_LOG_INFO << "Info logging here" << modm::endl;
MODM_LOG_WARNING << "Warning logging here" << modm::endl;
MODM_LOG_ERROR << "Error logging here" << modm::endl;
MODM_LOG_INFO << "===============================" << modm::endl;

while (true)
{
rxThread.run();
}

return 0;
}
15 changes: 15 additions & 0 deletions examples/nucleo_g474re/sx128x_lora/project.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<library>
<extends>modm:nucleo-g474re</extends>
<options>
<option name="modm:build:build.path">../../../build/nucleo_g474re/sx128x_lora</option>
</options>
<modules>
<module>modm:driver:sx128x</module>
<module>modm:platform:exti</module>
<module>modm:platform:gpio</module>
<module>modm:platform:spi:1</module>
<module>modm:processing:protothread</module>
<module>modm:processing:timer</module>
<module>modm:build:scons</module>
</modules>
</library>
Loading