Marcelo Aquino
28c4f3f19e
* Signing support with MAX_PAYLOAD>32 Support in the signing backends to handle configurations where MAX_PAYLOAD is more than 32 bytes. Fixes #748 * Support big message signatures Support for signing messages larger than 32 bytes. This is not fully testable with the current version of the library but the change would add theoretical support for signing any sized messages. Fixes #749 * Have gw properly indicate whitelisting preferences If the gateway hold a signing whitelist, inform all nodes of this requirement and not just nodes that hold whitelists themselves. Fixes #806 * Harden security The flag MY_SIGNING_GW_REQUEST_SIGNATURES_FROM_ALL has been removed. Gateway will now request signatures from everyone by default. In addition to this, no nodes in the network will allow clearing of signing/whitelisting preferences by OTA commands by default. If the old behaviour is needed (suitable for gradual signing roll out and development purposes) a new flag, MY_SIGNING_WEAK_SECURITY can be set. Fixes #807 * Signing debug messages rewritten All signing related debug has been rewritten to better match other core debug printouts. Also, backends are updated to have a smaller implementation delta. * Simplified signing option implemented Enable by MY_SIGNING_SIMPLE_PASSWD. Signing, and signing requirements will be enabled, as will encryption. Whitelisting is optional. The value provided to MY_SIGNING_SIMPLE_PASSWD is used as HMAC and AES key. Whitelists use the first 8 bytes of the password and the ninth byte from the node ID as serial. Password is required to be at least 8 characters wide. It is zero padded if it is not long enough to cover the AES (16 bytes) and HMAC (32 bytes) keys. It is not recommended to have a password shorter than 32 bytes, and there is no need for a password longer than 32 bytes. * Add documentation section for signing debug * Add nRF5 encryption to simple signing option * Restructure MySigning documentation * Minor fixes for Linux
622 lines
21 KiB
C
622 lines
21 KiB
C
/*
|
|
* The MySensors Arduino library handles the wireless radio link and protocol
|
|
* between your home built sensors/actuators and HA controller of choice.
|
|
* The sensors forms a self healing radio network with optional repeaters. Each
|
|
* repeater and gateway builds a routing tables in EEPROM which keeps track of the
|
|
* network topology allowing messages to be routed to nodes.
|
|
*
|
|
* Created by Henrik Ekblad <henrik.ekblad@mysensors.org>
|
|
* Copyright (C) 2013-2017 Sensnology AB
|
|
* Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors
|
|
*
|
|
* Documentation: http://www.mysensors.org
|
|
* Support Forum: http://forum.mysensors.org
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* version 2 as published by the Free Software Foundation.
|
|
*
|
|
* RFM69 driver refactored for Mysensors
|
|
*
|
|
* Based on :
|
|
* - LowPowerLab RFM69 Lib Copyright Felix Rusu (2014), felix@lowpowerlab.com
|
|
* - Automatic Transmit Power Control class derived from RFM69 library.
|
|
* Discussion and details in this forum post: https://lowpowerlab.com/forum/index.php/topic,688.0.html
|
|
* Copyright Thomas Studwell (2014,2015)
|
|
* - Mysensors generic radio driver implementation, Copyright (C) 2017 Olivier Mauti <olivier@mysensors.org>
|
|
*
|
|
* Changes by : @tekka, @scalz, @marceloagno
|
|
*
|
|
* Definitions for Semtech SX1231/H radios:
|
|
* http://www.semtech.com/images/datasheet/sx1231.pdf
|
|
* http://www.semtech.com/images/datasheet/sx1231h.pdf
|
|
*/
|
|
|
|
/**
|
|
* @file RFM69_new.h
|
|
*
|
|
* @defgroup RFM69Newgrp RFM69New
|
|
* @ingroup internals
|
|
* @{
|
|
*
|
|
* RFM69 driver-related log messages, format: [!]SYSTEM:[SUB SYSTEM:]MESSAGE
|
|
* - [!] Exclamation mark is prepended in case of error
|
|
*
|
|
* |E| SYS | SUB | Message | Comment
|
|
* |-|-------|-------|-----------------------------------|-----------------------------------------------------------------------------------
|
|
* | | RFM69 | INIT | | Initialise RFM69 radio
|
|
* | | RFM69 | INIT | PIN,CS=%d,IQP=%d,IQN=%d[,RST=%d] | Pin configuration: chip select (CS), IRQ pin (IQP), IRQ number (IQN), Reset (RST)
|
|
* |!| RFM69 | INIT | SANCHK FAIL | Sanity check failed, check wiring or replace module
|
|
* | | RFM69 | PTX | NO ADJ | TX power level, no adjustment
|
|
* | | RFM69 | PTX | LEVEL=%d dbM | TX power level, set to (LEVEL) dBm
|
|
* | | RFM69 | SLEEP | | Radio in sleep mode
|
|
* | | RFM69 | SAC | SEND ACK,TO=%d,RSSI=%d | ACK sent to (TO), RSSI of incoming message (RSSI)
|
|
* | | RFM69 | ATC | ADJ TXL,cR=%d,tR=%d,TXL=%d | Adjust TX power level (TXL) to match set RSSI (sR), current RSSI (cR)
|
|
* | | RFM69 | SWR | SEND,TO=%d,RETRY=%d | Send to (TO), retry if no ACK received (RETRY)
|
|
* | | RFM69 | SWR | ACK,FROM=%d,SEQ=%d,RSSI=%d | ACK received from (FROM), sequence nr (SEQ), ACK RSSI (RSSI)
|
|
* |!| RFM69 | SWR | NACK | Message sent, no ACK received
|
|
* | | RFM69 | SPP | PCT=%d,TX LEVEL=%d | Set TX level, input TX percent (PCT)
|
|
*
|
|
* @brief API declaration for RFM69
|
|
*
|
|
*/
|
|
|
|
#ifndef _RFM69_h
|
|
#define _RFM69_h
|
|
|
|
#include "RFM69registers_new.h"
|
|
|
|
#if defined(ARDUINO_ARCH_AVR)
|
|
#if defined(__AVR_ATmega32U4__)
|
|
#define DEFAULT_RFM69_IRQ_PIN (3) //!< DEFAULT_RFM69_IRQ_PIN
|
|
#else
|
|
#define DEFAULT_RFM69_IRQ_PIN (2) //!< DEFAULT_RFM69_IRQ_PIN
|
|
#endif
|
|
#define DEFAULT_RFM69_IRQ_NUM digitalPinToInterrupt(DEFAULT_RFM69_IRQ_PIN) //!< DEFAULT_RFM69_IRQ_NUM
|
|
#elif defined(ARDUINO_ARCH_ESP8266)
|
|
#define DEFAULT_RFM69_IRQ_PIN (2) //!< DEFAULT_RFM69_IRQ_PIN
|
|
#define DEFAULT_RFM69_IRQ_NUM digitalPinToInterrupt(DEFAULT_RFM69_IRQ_PIN) //!< DEFAULT_RFM69_IRQ_NUM
|
|
#elif defined(ARDUINO_ARCH_ESP32)
|
|
#warning not implemented yet
|
|
#elif defined(ARDUINO_ARCH_SAMD)
|
|
#define DEFAULT_RFM69_IRQ_PIN (2) //!< DEFAULT_RFM69_IRQ_PIN
|
|
#define DEFAULT_RFM69_IRQ_NUM digitalPinToInterrupt(DEFAULT_RFM69_IRQ_PIN) //!< DEFAULT_RFM69_IRQ_NUM
|
|
#elif defined(LINUX_ARCH_RASPBERRYPI)
|
|
#define DEFAULT_RFM69_IRQ_PIN (22) //!< DEFAULT_RFM69_IRQ_PIN
|
|
#define DEFAULT_RFM69_IRQ_NUM DEFAULT_RFM69_IRQ_PIN //!< DEFAULT_RFM69_IRQ_NUM
|
|
#elif defined(ARDUINO_ARCH_STM32F1)
|
|
#define DEFAULT_RFM69_IRQ_PIN (PA3) //!< DEFAULT_RFM69_IRQ_PIN
|
|
#define DEFAULT_RFM69_IRQ_NUM DEFAULT_RFM69_IRQ_PIN //!< DEFAULT_RFM69_IRQ_NUM
|
|
#elif defined(TEENSYDUINO)
|
|
#define DEFAULT_RFM69_IRQ_PIN (8) //!< DEFAULT_RFM69_IRQ_PIN
|
|
#define DEFAULT_RFM69_IRQ_NUM digitalPinToInterrupt(DEFAULT_RFM69_IRQ_PIN) //!< DEFAULT_RFM69_IRQ_NUM
|
|
#else
|
|
#define DEFAULT_RFM69_IRQ_PIN (2) //!< DEFAULT_RFM69_IRQ_PIN
|
|
#define DEFAULT_RFM69_IRQ_NUM (2) //!< DEFAULT_RFM69_IRQ_NUM
|
|
#endif
|
|
|
|
#define DEFAULT_RFM69_CS_PIN (SS) //!< DEFAULT_RFM69_CS_PIN
|
|
|
|
// SPI settings
|
|
#define RFM69_SPI_DATA_ORDER MSBFIRST //!< SPI data order
|
|
#define RFM69_SPI_DATA_MODE SPI_MODE0 //!< SPI mode
|
|
|
|
// SPI clock divier for non-transaction implementations
|
|
#if (MY_RFM69_SPI_SPEED >= F_CPU / 2)
|
|
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV2 //!< SPI clock divider 2
|
|
#elif (MY_RFM69_SPI_SPEED >= F_CPU / 4)
|
|
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV4 //!< SPI clock divider 4
|
|
#elif (MY_RFM69_SPI_SPEED >= F_CPU / 8)
|
|
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV8 //!< SPI clock divider 8
|
|
#elif (MY_RFM69_SPI_SPEED >= F_CPU / 16)
|
|
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV16 //!< SPI clock divider 16
|
|
#elif (MY_RFM69_SPI_SPEED >= F_CPU / 32)
|
|
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV32 //!< SPI clock divider 32
|
|
#elif (MY_RFM69_SPI_SPEED >= F_CPU / 64)
|
|
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV64 //!< SPI clock divider 64
|
|
#elif (MY_RFM69_SPI_SPEED >= F_CPU / 128)
|
|
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV128 //!< SPI clock divider 128
|
|
#else
|
|
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV256 //!< SPI clock divider 256
|
|
#endif
|
|
|
|
#if defined (ARDUINO) && !defined (__arm__) && !defined (_SPI)
|
|
#include <SPI.h>
|
|
#if defined(MY_SOFTSPI)
|
|
SoftSPI<MY_SOFT_SPI_MISO_PIN, MY_SOFT_SPI_MOSI_PIN, MY_SOFT_SPI_SCK_PIN, RFM69_SPI_DATA_MODE> _SPI;
|
|
#else
|
|
#define _SPI SPI
|
|
#endif
|
|
#else
|
|
#if defined(__arm__) || defined(__linux__)
|
|
#include <SPI.h>
|
|
#else
|
|
extern HardwareSPI SPI; //!< SPI
|
|
#endif
|
|
|
|
#if !defined(_SPI)
|
|
#define _SPI SPI //!< SPI
|
|
#endif
|
|
#endif
|
|
|
|
|
|
// Additional radio settings
|
|
#define RFM69_SYNCVALUE1 (0x2D) //!< Make this compatible with sync1 byte of RFM12B lib
|
|
|
|
#if (MY_RFM69HW==true)
|
|
// RFM69H(C)W
|
|
#define RFM69_VERSION_HW //!< HW version
|
|
#define RFM69_MIN_POWER_LEVEL_DBM ((rfm69_powerlevel_t)-2) //!< min. power level, -18dBm
|
|
#if defined(MY_RFM69_MAX_POWER_LEVEL_DBM)
|
|
#define RFM69_MAX_POWER_LEVEL_DBM MY_RFM69_MAX_POWER_LEVEL_DBM //!< MY_RFM69_MAX_POWER_LEVEL_DBM
|
|
#else
|
|
#define RFM69_MAX_POWER_LEVEL_DBM ((rfm69_powerlevel_t)20) //!< max. power level, +20dBm
|
|
#endif
|
|
#else
|
|
// RFM69(C)W
|
|
#define RFM69_MIN_POWER_LEVEL_DBM ((rfm69_powerlevel_t)-18) //!< min. power level, -18dBm
|
|
#if defined(MY_RFM69_MAX_POWER_LEVEL_DBM)
|
|
#define RFM69_MAX_POWER_LEVEL_DBM MY_RFM69_MAX_POWER_LEVEL_DBM //!< MY_RFM69_MAX_POWER_LEVEL_DBM
|
|
#else
|
|
#define RFM69_MAX_POWER_LEVEL_DBM ((rfm69_powerlevel_t)13) //!< max. power level, +13dBm
|
|
#endif
|
|
#endif
|
|
|
|
#define RFM69_FIFO_SIZE (0xFFu) //!< Max number of bytes the Rx/Tx FIFO can hold
|
|
#define RFM69_MAX_PACKET_LEN (0x40u) //!< This is the maximum number of bytes that can be carried
|
|
#define RFM69_ATC_TARGET_RANGE_PERCENT (5u) //!< ATC target range +/-%
|
|
#define RFM69_PACKET_HEADER_VERSION (1u) //!< RFM69 packet header version
|
|
#define RFM69_MIN_PACKET_HEADER_VERSION (1u) //!< Minimal RFM69 packet header version
|
|
#define RFM69_RETRIES (5u) //!< Retries in case of failed transmission
|
|
#define RFM69_RETRY_TIMEOUT_MS (200ul) //!< Timeout for ACK, adjustments needed if modem configuration changed (air time different)
|
|
#define RFM69_MODE_READY_TIMEOUT_MS (50ul) //!< Timeout for mode ready
|
|
#define RFM69_TX_LIMIT_MS (1*1000ul) //!< Timeout for packet sent
|
|
|
|
#define RFM69_ACK_REQUESTED (7u) //!< RFM69 header, controlFlag, bit 7
|
|
#define RFM69_ACK_RECEIVED (6u) //!< RFM69 header, controlFlag, bit 6
|
|
#define RFM69_ACK_RSSI_REPORT (5u) //!< RFM69 header, controlFlag, bit 5
|
|
|
|
#define RFM69_BROADCAST_ADDRESS (255u) //!< Broadcasting address
|
|
#define RFM69_TARGET_RSSI_DBM (-60) //!< RSSI target
|
|
#define RFM69_HIGH_POWER_DBM (18u) //!< High power threshold, dBm
|
|
#define RFM69_PROMISCUOUS (false) //!< RFM69 promiscuous mode
|
|
|
|
#define RFM69_RSSItoInternal(__value) ((uint8_t)-(__value*2)) //!< RSSI converting macro
|
|
#define RFM69_internalToRSSI(__value) ((int16_t)-(__value/2)) //!< RSSI converting macro
|
|
|
|
// helper macros
|
|
#define RFM69_getACKRequested(__value) ((bool)bitRead(__value,RFM69_ACK_REQUESTED)) //!< getACKRequested
|
|
#define RFM69_setACKRequested(__value, __flag) bitWrite(__value,RFM69_ACK_REQUESTED,__flag) //!< setACKRequested
|
|
#define RFM69_getACKReceived(__value) ((bool)bitRead(__value,RFM69_ACK_RECEIVED)) //!< getACKReceived
|
|
#define RFM69_setACKReceived(__value, __flag) bitWrite(__value,RFM69_ACK_RECEIVED,__flag) //!< setACKReceived
|
|
#define RFM69_setACKRSSIReport(__value, __flag) bitWrite(__value,RFM69_ACK_RSSI_REPORT,__flag) //!< setACKRSSIReport
|
|
#define RFM69_getACKRSSIReport(__value) ((bool)bitRead(__value,RFM69_ACK_RSSI_REPORT)) //!< getACKRSSIReport
|
|
|
|
|
|
// Register access
|
|
#define RFM69_READ_REGISTER (0x7Fu) //!< reading register
|
|
#define RFM69_WRITE_REGISTER (0x80u) //!< writing register
|
|
|
|
// CAD & CSMA
|
|
#define RFM69_CAD_TIMEOUT_MS (2*1000ul) //!< Channel activity detection timeout
|
|
#define RFM69_CSMA_LIMIT_DBM (-90) //!< upper RX signal sensitivity threshold in dBm for carrier sense access
|
|
#define RFM69_CSMA_TIMEOUT_MS (1000ul) //!< CSMA timeout
|
|
|
|
// powerup delay
|
|
#define RFM69_POWERUP_DELAY_MS (100u) //!< Power up delay, allow VCC to settle, transport to become fully operational
|
|
|
|
// available frequency bands, non trivial values to avoid misconfiguration
|
|
#define RFM69_315MHZ (315000000ul) //!< RFM69_315MHZ
|
|
#define RFM69_433MHZ (433920000ul) //!< RFM69_433MHZ, center frequencz 433.92 MHz
|
|
#define RFM69_868MHZ (868000000ul) //!< RFM69_868MHZ
|
|
#define RFM69_915MHZ (915000000ul) //!< RFM69_915MHZ
|
|
|
|
/*
|
|
#if !defined(RFM69_FREQ_MSB)
|
|
#define RFM69_FREQ_MSB (uint8_t)(MY_RFM69_FREQUENCY == RFM69_315MHZ ? RFM69_FRFMSB_315 : (MY_RFM69_FREQUENCY == RFM69_433MHZ ? RFM69_FRFMSB_433_92 : (MY_RFM69_FREQUENCY == RFM69_868MHZ ? RFM69_FRFMSB_868 : RFM69_FRFMSB_915))) //!< FREQ_MSB
|
|
#endif
|
|
|
|
#if !defined(RFM69_FREQ_MID)
|
|
#define RFM69_FREQ_MID (uint8_t)(MY_RFM69_FREQUENCY == RFM69_315MHZ ? RFM69_FRFMID_315 : (MY_RFM69_FREQUENCY == RFM69_433MHZ ? RFM69_FRFMID_433_92 : (MY_RFM69_FREQUENCY == RFM69_868MHZ ? RFM69_FRFMID_868 : RFM69_FRFMID_915))) //!< FREQ_MID
|
|
#endif
|
|
|
|
#if !defined(RFM69_FREQ_LSB)
|
|
#define RFM69_FREQ_LSB (uint8_t)(MY_RFM69_FREQUENCY == RFM69_315MHZ ? RFM69_FRFLSB_315 : (MY_RFM69_FREQUENCY == RFM69_433MHZ ? RFM69_FRFLSB_433_92 : (MY_RFM69_FREQUENCY == RFM69_868MHZ ? RFM69_FRFLSB_868 : RFM69_FRFLSB_915))) //!< FREQ_LSB
|
|
#endif
|
|
*/
|
|
#define RFM69_COURSE_TEMP_COEF (-90) //!< puts the temperature reading in the ballpark, user can fine tune the returned value
|
|
#define RFM69_FXOSC (32*1000000ul) //!< OSC freq, 32MHz
|
|
#define RFM69_FSTEP (RFM69_FXOSC / 524288.0f) //!< FXOSC / 2^19 = 32MHz / 2^19 (p13 in datasheet)
|
|
|
|
#if defined(MY_RFM69_ENABLE_LISTENMODE)
|
|
#define RFM69_LISTEN_RX_US MY_RFM69_DEFAULT_LISTEN_RX_US //!< RFM69_LISTEN_RX_US
|
|
#define RFM69_LISTEN_IDLE_US MY_RFM69_DEFAULT_LISTEN_IDLE_US //!< RFM69_LISTEN_IDLE_US
|
|
#endif
|
|
|
|
|
|
/**
|
|
* @brief Radio modes
|
|
*/
|
|
typedef enum {
|
|
RFM69_RADIO_MODE_RX = 0, //!< RX mode
|
|
RFM69_RADIO_MODE_TX = 1, //!< TX mode
|
|
RFM69_RADIO_MODE_CAD = 2, //!< CAD mode
|
|
RFM69_RADIO_MODE_SLEEP = 3, //!< SLEEP mode
|
|
RFM69_RADIO_MODE_STDBY = 4, //!< STDBY mode
|
|
RFM69_RADIO_MODE_SYNTH = 5, //!< SYNTH mode
|
|
RFM69_RADIO_MODE_LISTEN = 6 //!< LISTEN mode
|
|
} rfm69_radio_mode_t;
|
|
|
|
/**
|
|
* @brief Sequence number data type
|
|
*/
|
|
typedef uint8_t rfm69_sequenceNumber_t;
|
|
/**
|
|
* @brief RSSI data type
|
|
*/
|
|
typedef uint8_t rfm69_RSSI_t;
|
|
/**
|
|
* @brief SNR data type
|
|
*/
|
|
typedef int8_t rfm69_SNR_t;
|
|
/**
|
|
* @brief Control flag data type
|
|
*/
|
|
typedef uint8_t rfm69_controlFlags_t;
|
|
/**
|
|
* @brief Power level in dBm
|
|
*/
|
|
typedef int8_t rfm69_powerlevel_t;
|
|
|
|
/**
|
|
* @brief RFM69 header
|
|
* IMPORTANT: Do not change order (see datasheet for packet structure)
|
|
*/
|
|
typedef struct {
|
|
uint8_t packetLen; //!< Packet length
|
|
uint8_t recipient; //!< Payload recipient
|
|
uint8_t version; //!< Header version
|
|
uint8_t sender; //!< Payload sender
|
|
rfm69_controlFlags_t controlFlags; //!< Control flags, used for ACK
|
|
rfm69_sequenceNumber_t sequenceNumber; //!< Packet sequence number, used for ACK
|
|
} __attribute__((packed)) rfm69_header_t;
|
|
/**
|
|
* @brief RFM69 ACK packet structure
|
|
*/
|
|
typedef struct {
|
|
rfm69_sequenceNumber_t sequenceNumber; //!< sequence number
|
|
rfm69_RSSI_t RSSI; //!< RSSI
|
|
} __attribute__((packed)) rfm69_ack_t;
|
|
|
|
#define RFM69_HEADER_LEN sizeof(rfm69_header_t) //!< Size header inside payload
|
|
#define RFM69_MAX_PAYLOAD_LEN (RFM69_MAX_PACKET_LEN - RFM69_HEADER_LEN) //!< Max payload length
|
|
|
|
/**
|
|
* @brief Packet structure
|
|
*/
|
|
typedef struct {
|
|
union {
|
|
struct {
|
|
rfm69_header_t header; //!< Packet header
|
|
union {
|
|
uint8_t payload[RFM69_MAX_PAYLOAD_LEN]; //!< Union: Data Payload, i.e. MySensors message
|
|
rfm69_ack_t ACK; //!< Union: ACK payload (internal)
|
|
};
|
|
};
|
|
uint8_t data[RFM69_MAX_PACKET_LEN]; //!< RAW data access
|
|
};
|
|
uint8_t payloadLen; //!< Length of payload (excluding header)
|
|
rfm69_RSSI_t RSSI; //!< RSSI of current packet, RSSI = value - 137
|
|
} __attribute__((packed)) rfm69_packet_t;
|
|
|
|
|
|
/**
|
|
* @brief RFM69 internal variables
|
|
*/
|
|
typedef struct {
|
|
uint8_t address; //!< Node address
|
|
rfm69_packet_t currentPacket; //!< Buffer for current packet
|
|
rfm69_sequenceNumber_t txSequenceNumber; //!< RFM69_txSequenceNumber
|
|
rfm69_powerlevel_t powerLevel; //!< TX power level dBm
|
|
uint8_t ATCtargetRSSI; //!< ATC: target RSSI
|
|
// 8 bit
|
|
rfm69_radio_mode_t radioMode : 3; //!< current transceiver state
|
|
bool dataSent : 1; //!< Data sent
|
|
bool dataReceived : 1; //!< data received
|
|
bool ackReceived : 1; //!< ack received
|
|
bool ATCenabled : 1; //!< ATC enabled
|
|
bool listenModeEnabled : 1; //!< Listen Mode enabled
|
|
} rfm69_internal_t;
|
|
|
|
#if defined(MY_RFM69_ENABLE_LISTENMODE)
|
|
uint8_t rxListenCoef;
|
|
uint8_t rxListenResolution;
|
|
uint8_t idleListenCoef;
|
|
uint8_t idleListenResolution;
|
|
uint32_t listenCycleDurationUs;
|
|
#endif
|
|
|
|
#define LOCAL static //!< static
|
|
|
|
/**
|
|
* @brief Initialise the driver transport hardware and software
|
|
* @param frequencyHz Frequency in Hz
|
|
* @return True if initialisation succeeded
|
|
*/
|
|
LOCAL bool RFM69_initialise(const uint32_t frequencyHz);
|
|
|
|
/**
|
|
* @brief Set the driver/node address
|
|
* @param addr
|
|
*/
|
|
LOCAL void RFM69_setAddress(const uint8_t addr);
|
|
|
|
/**
|
|
* @brief Get driver/node address
|
|
* @return Node address
|
|
*/
|
|
LOCAL uint8_t RFM69_getAddress(void);
|
|
|
|
/**
|
|
* @brief Tests whether a new message is available
|
|
* @return True if a new, complete, error-free uncollected message is available to be retreived by @ref RFM69_recv()
|
|
*/
|
|
LOCAL bool RFM69_available(void);
|
|
|
|
/**
|
|
* @brief If a valid message is received, copy it to buf and return length. 0 byte messages are permitted.
|
|
* @param buf Location to copy the received message
|
|
* @param maxBufSize Max buffer size
|
|
* @return Number of bytes
|
|
*/
|
|
LOCAL uint8_t RFM69_recv(uint8_t* buf, const uint8_t maxBufSize);
|
|
|
|
/**
|
|
* @brief RFM69_sendFrame
|
|
* @param packet
|
|
* @param increaseSequenceCounter
|
|
* @return True if packet sent
|
|
*/
|
|
LOCAL bool RFM69_sendFrame(rfm69_packet_t &packet, const bool increaseSequenceCounter = true);
|
|
|
|
/**
|
|
* @brief RFM69_send
|
|
* @param recipient
|
|
* @param data
|
|
* @param len
|
|
* @param flags
|
|
* @param increaseSequenceCounter
|
|
* @return True if frame sent
|
|
*/
|
|
LOCAL bool RFM69_send(const uint8_t recipient, uint8_t* data, const uint8_t len,
|
|
const rfm69_controlFlags_t flags, const bool increaseSequenceCounter = true);
|
|
|
|
/**
|
|
* @brief Sets the transmitter and receiver center frequency
|
|
* @param frequencyHz Frequency in Hz
|
|
*/
|
|
LOCAL void RFM69_setFrequency(const uint32_t frequencyHz);
|
|
|
|
/**
|
|
* @brief Sets the transmitter power output level, and configures the transmitter pin
|
|
* @param newPowerLevel Transmitter power level in dBm (-18 to +20dBm)
|
|
* @return True power level adjusted
|
|
*/
|
|
LOCAL bool RFM69_setTxPowerLevel(rfm69_powerlevel_t newPowerLevel);
|
|
|
|
/**
|
|
* @brief Reports the transmitter power output level in dBm
|
|
* @return power level
|
|
*/
|
|
LOCAL rfm69_powerlevel_t RFM69_getTxPowerLevel(void);
|
|
/**
|
|
* @brief Reports the transmitter power output level in percents
|
|
* @return power level
|
|
*/
|
|
LOCAL uint8_t RFM69_getTxPowerPercent(void);
|
|
/**
|
|
* @brief Sets the radio into low-power sleep mode
|
|
* @return true if sleep mode was successfully entered
|
|
*/
|
|
LOCAL bool RFM69_sleep(void);
|
|
/**
|
|
* @brief Sets the radio to standby mode
|
|
* @return true if standby mode was successfully entered
|
|
*/
|
|
LOCAL bool RFM69_standBy(void);
|
|
/**
|
|
* @brief Power down radio (HW)
|
|
*/
|
|
LOCAL void RFM69_powerDown(void);
|
|
/**
|
|
* @brief Power up radio (HW)
|
|
*/
|
|
LOCAL void RFM69_powerUp(void);
|
|
|
|
/**
|
|
* @brief RFM69_sendACK
|
|
* @param recipient
|
|
* @param sequenceNumber
|
|
* @param RSSI (rfm95_RSSI_t)
|
|
*/
|
|
LOCAL void RFM69_sendACK(const uint8_t recipient, const rfm69_sequenceNumber_t sequenceNumber,
|
|
const rfm69_RSSI_t RSSI);
|
|
|
|
/**
|
|
* @brief RFM69_sendWithRetry
|
|
* @param recipient
|
|
* @param buffer
|
|
* @param bufferSize
|
|
* @param retries
|
|
* @param retryWaitTimeMS
|
|
* @return True if packet successfully sent
|
|
*/
|
|
LOCAL bool RFM69_sendWithRetry(const uint8_t recipient, const void* buffer,
|
|
const uint8_t bufferSize,
|
|
const uint8_t retries = RFM69_RETRIES, const uint32_t retryWaitTimeMS = RFM69_RETRY_TIMEOUT_MS);
|
|
|
|
/**
|
|
* @brief RFM69_setRadioMode
|
|
* @param newRadioMode
|
|
* @return True if mode changed
|
|
*/
|
|
LOCAL bool RFM69_setRadioMode(const rfm69_radio_mode_t newRadioMode);
|
|
|
|
/**
|
|
* @brief Low level interrupt handler
|
|
*/
|
|
LOCAL void RFM69_interruptHandler(void);
|
|
|
|
/**
|
|
* @brief RFM69_getSendingRSSI
|
|
* @return RSSI Own RSSI as measured at the receiving node of last sent packet (if ACK & ATC enabled)
|
|
*/
|
|
LOCAL int16_t RFM69_getSendingRSSI(void);
|
|
|
|
/**
|
|
* @brief RFM69_getReceivingRSSI
|
|
* @return RSSI Signal strength of last received packet
|
|
*/
|
|
LOCAL int16_t RFM69_getReceivingRSSI(void);
|
|
/**
|
|
* @brief RFM69_executeATC
|
|
* @param currentRSSI
|
|
* @param targetRSSI
|
|
* @return True if power level adjusted
|
|
*/
|
|
LOCAL bool RFM69_executeATC(const rfm69_RSSI_t currentRSSI, const rfm69_RSSI_t targetRSSI);
|
|
|
|
// TEMP ADDED
|
|
/**
|
|
* @brief RFM69_setConfiguration Set general radio register configuration TODO temp use setmodemregisters
|
|
*/
|
|
LOCAL void RFM69_setConfiguration(void);
|
|
|
|
/**
|
|
* @brief RFM69_isModeReady
|
|
* @return True if Mode Ready is ok, false is timeout
|
|
*/
|
|
LOCAL bool RFM69_isModeReady(void);
|
|
|
|
/**
|
|
* @brief RFM69_sanityCheck detect HW defect, configuration errors or interrupted SPI line
|
|
* @return True if radio sanity check passed
|
|
*/
|
|
LOCAL bool RFM69_sanityCheck(void);
|
|
|
|
|
|
/**
|
|
* @brief RFM69_encrypt Set encryption mode
|
|
* @param key if key is null, encryption is disabled. Key has to be 16 bytes!
|
|
*/
|
|
LOCAL void RFM69_encrypt(const char* key);
|
|
|
|
/**
|
|
* @brief RFM69_setHighPowerRegs
|
|
* @param onOff
|
|
*/
|
|
LOCAL void RFM69_setHighPowerRegs(const bool onOff);
|
|
|
|
/**
|
|
* @brief RFM69_readRSSI
|
|
* @param forceTrigger
|
|
* @return RSSI (internal format)
|
|
*/
|
|
LOCAL rfm69_RSSI_t RFM69_readRSSI(bool forceTrigger = false);
|
|
|
|
/**
|
|
* @brief RFM69_ATCmode
|
|
* @param targetRSSI Target RSSI for transmitter (default -60)
|
|
* @param onOff True to enable ATC
|
|
*/
|
|
LOCAL void RFM69_ATCmode(const bool onOff, const int16_t targetRSSI = RFM69_TARGET_RSSI_DBM);
|
|
|
|
// ************************ LISTENMODE SECTION ************************
|
|
|
|
#if defined(MY_RFM69_ENABLE_LISTENMODE)
|
|
|
|
/**
|
|
* @brief RFM69_listenModeApplyHighSpeedSettings Set high speed settings
|
|
*/
|
|
LOCAL void RFM69_listenModeApplyHighSpeedSettings(void);
|
|
|
|
/**
|
|
* @brief RFM69_ListenModeStart Switch radio to listen Mode in prep for sleep until burst
|
|
*/
|
|
LOCAL void RFM69_ListenModeStart(void);
|
|
|
|
/**
|
|
* @brief RFM69_listenModeEnd Exit listen mode and reinit the radio
|
|
* @return
|
|
*/
|
|
LOCAL bool RFM69_listenModeEnd(void);
|
|
|
|
/**
|
|
* @brief RFM69_listenModeReset Reset listen mode
|
|
*/
|
|
LOCAL void RFM69_listenModeReset(void);
|
|
|
|
/**
|
|
* @brief RFM69_reinitRadio Restore previous radio settigns for normal mode
|
|
* @return
|
|
*/
|
|
LOCAL bool RFM69_reinitRadio(void);
|
|
|
|
/**
|
|
* @brief RFM69_listenModeSendBurst This repeatedly sends the message to the target node for
|
|
* the duration of an entire listen cycle. The amount of time remaining in the burst is
|
|
* transmitted to the receiver, and it is expected that the receiver
|
|
* wait for the burst to end before attempting a reply.
|
|
* @param recipient
|
|
* @param data
|
|
* @param len
|
|
*/
|
|
LOCAL void RFM69_listenModeSendBurst(const uint8_t recipient, uint8_t* data, const uint8_t len);
|
|
|
|
/**
|
|
* @brief getUsForResolution
|
|
* @param resolution
|
|
* @return
|
|
*/
|
|
LOCAL uint32_t RFM69_getUsForResolution(uint8_t resolution);
|
|
|
|
/**
|
|
* @brief getCoefForResolution
|
|
* @param resolution
|
|
* @param duration
|
|
* @return
|
|
*/
|
|
LOCAL uint32_t RFM69_getCoefForResolution(uint8_t resolution, uint32_t duration);
|
|
|
|
/**
|
|
* @brief RFM69_chooseResolutionAndCoef
|
|
* @param resolutions
|
|
* @param duration
|
|
* @param resolOut
|
|
* @param coefOut
|
|
* @return
|
|
*/
|
|
LOCAL bool RFM69_chooseResolutionAndCoef(uint8_t *resolutions, uint32_t duration, uint8_t& resolOut,
|
|
uint8_t& coefOut);
|
|
|
|
/**
|
|
* @brief RFM69_listenModeSetDurations
|
|
* @param rxDuration
|
|
* @param idleDuration
|
|
* @return
|
|
*/
|
|
LOCAL bool RFM69_listenModeSetDurations(uint32_t& rxDuration, uint32_t& idleDuration);
|
|
|
|
/**
|
|
* @brief RFM69_listenModeGetDurations
|
|
* @param rxDuration
|
|
* @param idleDuration
|
|
*/
|
|
LOCAL void RFM69_listenModeGetDurations(uint32_t &rxDuration, uint32_t &idleDuration);
|
|
|
|
#endif
|
|
|
|
#endif
|
|
|
|
/** @}*/
|