146 lines
3.6 KiB
C++
146 lines
3.6 KiB
C++
// Copyright (c) Sandeep Mistry. All rights reserved.
|
|
// Licensed under the MIT license.
|
|
|
|
// Modifications and additions copyright 2023 by Mark Qvist
|
|
// Obviously still under the MIT license.
|
|
|
|
#ifndef LORA_H
|
|
#define LORA_H
|
|
|
|
#include <Arduino.h>
|
|
#include <SPI.h>
|
|
#include "Modem.h"
|
|
|
|
#define LORA_DEFAULT_SS_PIN 10
|
|
#define LORA_DEFAULT_RESET_PIN 9
|
|
#define LORA_DEFAULT_DIO0_PIN 2
|
|
#define LORA_DEFAULT_RXEN_PIN -1
|
|
#define LORA_DEFAULT_BUSY_PIN -1
|
|
|
|
#define PA_OUTPUT_RFO_PIN 0
|
|
#define PA_OUTPUT_PA_BOOST_PIN 1
|
|
|
|
#define RSSI_OFFSET 157
|
|
|
|
class LoRaClass : public Stream {
|
|
public:
|
|
LoRaClass();
|
|
|
|
int begin(long frequency);
|
|
void end();
|
|
|
|
int beginPacket(int implicitHeader = false);
|
|
int endPacket();
|
|
|
|
int parsePacket(int size = 0);
|
|
int packetRssi();
|
|
int currentRssi();
|
|
uint8_t packetRssiRaw();
|
|
uint8_t currentRssiRaw();
|
|
uint8_t packetSnrRaw();
|
|
float packetSnr();
|
|
long packetFrequencyError();
|
|
|
|
// from Print
|
|
virtual size_t write(uint8_t byte);
|
|
virtual size_t write(const uint8_t *buffer, size_t size);
|
|
|
|
// from Stream
|
|
virtual int available();
|
|
virtual int read();
|
|
virtual int peek();
|
|
virtual void flush();
|
|
|
|
void onReceive(void(*callback)(int));
|
|
|
|
void receive(int size = 0);
|
|
void idle();
|
|
void sleep();
|
|
|
|
bool preInit();
|
|
uint8_t getTxPower();
|
|
void setTxPower(int level, int outputPin = PA_OUTPUT_PA_BOOST_PIN);
|
|
uint32_t getFrequency();
|
|
void setFrequency(long frequency);
|
|
void setSpreadingFactor(int sf);
|
|
long getSignalBandwidth();
|
|
void setSignalBandwidth(long sbw);
|
|
void setCodingRate4(int denominator);
|
|
void setPreambleLength(long length);
|
|
void setSyncWord(int sw);
|
|
uint8_t modemStatus();
|
|
void enableCrc();
|
|
void disableCrc();
|
|
void enableTCXO();
|
|
void disableTCXO();
|
|
|
|
#if MODEM == SX1262
|
|
void enableAntenna();
|
|
void disableAntenna();
|
|
void loraMode();
|
|
void waitOnBusy();
|
|
void executeOpcode(uint8_t opcode, uint8_t *buffer, uint8_t size);
|
|
void executeOpcodeRead(uint8_t opcode, uint8_t *buffer, uint8_t size);
|
|
void writeBuffer(const uint8_t* buffer, size_t size);
|
|
void readBuffer(uint8_t* buffer, size_t size);
|
|
void setModulationParams(uint8_t sf, uint8_t bw, uint8_t cr, int ldro);
|
|
void setPacketParams(long preamble, uint8_t headermode, uint8_t length, uint8_t crc);
|
|
#endif
|
|
|
|
// deprecated
|
|
void crc() { enableCrc(); }
|
|
void noCrc() { disableCrc(); }
|
|
|
|
byte random();
|
|
|
|
void setPins(int ss = LORA_DEFAULT_SS_PIN, int reset = LORA_DEFAULT_RESET_PIN, int dio0 = LORA_DEFAULT_DIO0_PIN, int rxen = LORA_DEFAULT_RXEN_PIN, int busy = LORA_DEFAULT_BUSY_PIN);
|
|
void setSPIFrequency(uint32_t frequency);
|
|
|
|
void dumpRegisters(Stream& out);
|
|
|
|
private:
|
|
void explicitHeaderMode();
|
|
void implicitHeaderMode();
|
|
|
|
void handleDio0Rise();
|
|
|
|
#if MODEM == SX1276 || MODEM == SX1278
|
|
uint8_t readRegister(uint8_t address);
|
|
void writeRegister(uint8_t address, uint8_t value);
|
|
uint8_t singleTransfer(uint8_t address, uint8_t value);
|
|
#elif MODEM == SX1262
|
|
uint8_t readRegister(uint16_t address);
|
|
void writeRegister(uint16_t address, uint8_t value);
|
|
uint8_t singleTransfer(uint8_t opcode, uint16_t address, uint8_t value);
|
|
#endif
|
|
|
|
static void onDio0Rise();
|
|
|
|
void handleLowDataRate();
|
|
void optimizeModemSensitivity();
|
|
|
|
private:
|
|
SPISettings _spiSettings;
|
|
int _ss;
|
|
int _reset;
|
|
int _dio0;
|
|
int _rxen;
|
|
int _busy;
|
|
long _frequency;
|
|
int _txp;
|
|
uint8_t _sf;
|
|
uint8_t _bw;
|
|
uint8_t _cr;
|
|
uint8_t _ldro;
|
|
int _packetIndex;
|
|
int _preambleLength;
|
|
int _implicitHeaderMode;
|
|
int _payloadLength;
|
|
int _crcMode;
|
|
void (*_onReceive)(int);
|
|
};
|
|
|
|
extern LoRaClass LoRa;
|
|
|
|
#endif
|