Bleeding edge development version of the xDot library for mbed 5. This version of the library is not guaranteed to be stable or well tested and should not be used in production or deployment scenarios.

Dependents:   Dot-Examples Dot-AT-Firmware Dot-Examples TEST_FF1705 ... more

The Dot library provides a LoRaWan certified stack for LoRa communication using MultiTech mDot and xDot devices. The stack is compatible with mbed 5.

Dot Library Version 3 Updates

Dot Library versions 3.x.x require a channel plan to be injected into the stack. Channel plans are included with the 3.x.x Dot Library releases. The following code snippet demonstrates how to create a channel plan and inject it into the stack.

#include "mDot.h"
#include "channel_plans.h"

int main() {
    ChannelPlan* plan = new lora::ChannelPlan_US915();
    assert(plan);
    mDot* dot = mDot::getInstance(plan);
    assert(dot);

    // ...
}

Dot devices must not be deployed with software using a different channel plan than the Dot's default plan! This functionality is for development and testing only!

Multicast Sessions

Multicast sessions and packet rx events in library. When in Class C mode Multicast downlinks can be received. Recieved packets should be filtered on address, counter value will be maintained in the session or can be set explicitly depending on Application support to share Multicast Address, Keys and Counters.

mDot.h

        /**
         * Add a multicast session address and keys
         * Downlink counter is set to 0
         * Up to 3 MULTICAST_SESSIONS can be set
         */
        int32_t setMulticastSession(uint8_t index, uint32_t addr, const uint8_t* nsk, const uint8_t* dsk);
 
        /**
         * Set a multicast session counter
         * Up to 3 MULTICAST_SESSIONS can be set
         */
        int32_t setMulticastDownlinkCounter(uint8_t index, uint32_t count);

mDotEvent.h

The address field was added to PacketRx event.

        virtual void PacketRx(uint8_t port, uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr, lora::DownlinkControl ctrl, uint8_t slot, uint8_t retries, uint32_t address);

The name of the repository can be used to determine which device the stack was compiled for and if it's a development or production-ready build:

A changelog for the Dot library can be found here.

The Dot library version and the version of mbed-os it was compiled against can both be found in the commit message for that revision of the Dot library. Building your application with the same version of mbed-os as what was used to build the Dot library is highly recommended!

The Dot-Examples repository demonstrates how to use the Dot library in a custom application.

The mDot and xDot platform pages have lots of platform specific information and document potential issues, gotchas, etc, and provide instructions for getting started with development. Please take a look at the platform page before starting development as they should answer many questions you will have.

Committer:
Jenkins@KEILDM1.dc.multitech.prv
Date:
Fri Nov 09 14:56:50 2018 -0600
Revision:
133:4ca51f965419
Parent:
131:865d54f61813
xdot-library revision 3.1.0-57-g8e84ec6 and mbed-os revision mbed-os-5.10.2

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 1 /*
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 2 / _____) _ | |
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 3 ( (____ _____ ____ _| |_ _____ ____| |__
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 4 \____ \| ___ | (_ _) ___ |/ ___) _ \
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 5 _____) ) ____| | | || |_| ____( (___| | | |
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 6 (______/|_____)_|_|_| \__)_____)\____)_| |_|
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 7 (C)2013 Semtech
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 8
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 9 Description: Generic radio driver definition
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 10
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 11 License: Revised BSD License, see LICENSE.TXT file include in the project
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 12
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 13 Maintainer: Miguel Luis and Gregory Cristian
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 14 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 15 #ifndef __SXRADIO_H__
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 16 #define __SXRADIO_H__
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 17
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 18 #include <stdint.h>
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 19 #include "rtos.h"
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 20 #include "SxRadioEvents.h"
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 21
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 22 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 23 * \brief Radio driver definition
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 24 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 25 class SxRadio
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 26 {
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 27 public:
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 28 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 29 * Radio driver supported modems
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 30 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 31 typedef enum
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 32 {
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 33 MODEM_FSK = 0,
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 34 MODEM_LORA,
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 35 }RadioModems_t;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 36
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 37 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 38 * Radio driver internal state machine states definition
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 39 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 40 typedef enum
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 41 {
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 42 RF_IDLE = 0,
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 43 RF_RX_RUNNING,
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 44 RF_TX_RUNNING,
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 45 RF_CAD,
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 46 }RadioState_t;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 47
Jenkins@KEILDM1.dc.multitech.prv 127:db053d511848 48 SxRadio(uint32_t WakeupTime) : WakeupTime(WakeupTime), freq_offset(0), State(RF_IDLE), Modem(MODEM_LORA) { }
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 49 virtual ~SxRadio() {};
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 50
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 51 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 52 * \brief Initializes the radio
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 53 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 54 * \param [IN] events Structure containing the driver callback functions
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 55 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 56 virtual void Init( SxRadioEvents *events ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 57 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 58 * \brief Prepares the radio for destruction
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 59 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 60 virtual void Terminate( void ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 61 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 62 * Return current radio status
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 63 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 64 * \param status Radio status.[RF_IDLE, RF_RX_RUNNING, RF_TX_RUNNING]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 65 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 66 virtual RadioState_t Status( void ) { return State; }
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 67 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 68 * \brief Configures the radio with the given modem
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 69 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 70 * \param [IN] modem Modem to be used [0: FSK, 1: LoRa]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 71 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 72 virtual void SetModem( RadioModems_t modem ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 73 virtual RadioModems_t GetModem( void ) { return Modem; }
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 74 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 75 * \brief Sets the channel frequency
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 76 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 77 * \param [IN] freq Channel RF frequency
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 78 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 79 virtual void SetChannel( uint32_t freq ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 80 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 81 * \brief Sets the channels configuration
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 82 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 83 * \param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 84 * \param [IN] freq Channel RF frequency
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 85 * \param [IN] rssiThresh RSSI threshold
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 86 * \param [IN] rssiVal pointer to variable to hold RSSI value if desired - ignored if NULL
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 87 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 88 * \retval isFree [true: Channel is free, false: Channel is not free]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 89 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 90 virtual bool IsChannelFree( RadioModems_t modem, uint32_t freq, uint8_t datarate, int16_t rssiThresh, uint8_t bandwidth, uint32_t timeout = 5000, int16_t *rssiVal = NULL ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 91 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 92 * \brief Generates a 32 bits random value based on the RSSI readings
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 93 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 94 * \remark This function sets the radio in LoRa modem mode and disables
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 95 * all interrupts.
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 96 * After calling this function either Radio.SetRxConfig or
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 97 * Radio.SetTxConfig functions must be called.
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 98 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 99 * \retval randomValue 32 bits random value
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 100 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 101 virtual uint32_t Random( void ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 102 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 103 * \brief Sets the reception parameters
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 104 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 105 * \param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 106 * \param [IN] bandwidth Sets the bandwidth
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 107 * FSK : >= 2600 and <= 250000 Hz
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 108 * LoRa: [0: 125 kHz, 1: 250 kHz,
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 109 * 2: 500 kHz, 3: Reserved]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 110 * \param [IN] datarate Sets the Datarate
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 111 * FSK : 600..300000 bits/s
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 112 * LoRa: [6: 64, 7: 128, 8: 256, 9: 512,
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 113 * 10: 1024, 11: 2048, 12: 4096 chips]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 114 * \param [IN] coderate Sets the coding rate (LoRa only)
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 115 * FSK : N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 116 * LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 117 * \param [IN] bandwidthAfc Sets the AFC Bandwidth (FSK only)
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 118 * FSK : >= 2600 and <= 250000 Hz
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 119 * LoRa: N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 120 * \param [IN] preambleLen Sets the Preamble length
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 121 * FSK : Number of bytes
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 122 * LoRa: Length in symbols (the hardware adds 4 more symbols)
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 123 * \param [IN] symbTimeout Sets the RxSingle timeout value (LoRa only)
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 124 * FSK : N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 125 * LoRa: timeout in symbols
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 126 * \param [IN] fixLen Fixed length packets [0: variable, 1: fixed]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 127 * \param [IN] payloadLen Sets payload length when fixed length is used
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 128 * \param [IN] crcOn Enables/Disables the CRC [0: OFF, 1: ON]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 129 * \param [IN] FreqHopOn Enables disables the intra-packet frequency hopping
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 130 * FSK : N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 131 * LoRa: [0: OFF, 1: ON]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 132 * \param [IN] HopPeriod Number of symbols bewteen each hop
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 133 * FSK : N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 134 * LoRa: Number of symbols
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 135 * \param [IN] iqInverted Inverts IQ signals (LoRa only)
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 136 * FSK : N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 137 * LoRa: [0: not inverted, 1: inverted]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 138 * \param [IN] rxContinuous Sets the reception in continuous mode
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 139 * [false: single mode, true: continuous mode]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 140 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 141 virtual void SetRxConfig( RadioModems_t modem, uint32_t bandwidth,
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 142 uint32_t datarate, uint8_t coderate,
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 143 uint32_t bandwidthAfc, uint16_t preambleLen,
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 144 uint16_t symbTimeout, bool fixLen,
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 145 uint8_t payloadLen,
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 146 bool crcOn, bool FreqHopOn, uint8_t HopPeriod,
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 147 bool iqInverted, bool rxContinuous ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 148 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 149 * \brief Sets the transmission parameters
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 150 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 151 * \param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 152 * \param [IN] power Sets the output power [dBm]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 153 * \param [IN] fdev Sets the frequency deviation (FSK only)
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 154 * FSK : [Hz]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 155 * LoRa: 0
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 156 * \param [IN] bandwidth Sets the bandwidth (LoRa only)
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 157 * FSK : 0
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 158 * LoRa: [0: 125 kHz, 1: 250 kHz,
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 159 * 2: 500 kHz, 3: Reserved]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 160 * \param [IN] datarate Sets the Datarate
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 161 * FSK : 600..300000 bits/s
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 162 * LoRa: [6: 64, 7: 128, 8: 256, 9: 512,
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 163 * 10: 1024, 11: 2048, 12: 4096 chips]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 164 * \param [IN] coderate Sets the coding rate (LoRa only)
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 165 * FSK : N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 166 * LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 167 * \param [IN] preambleLen Sets the preamble length
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 168 * FSK : Number of bytes
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 169 * LoRa: Length in symbols (the hardware adds 4 more symbols)
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 170 * \param [IN] fixLen Fixed length packets [0: variable, 1: fixed]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 171 * \param [IN] crcOn Enables disables the CRC [0: OFF, 1: ON]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 172 * \param [IN] FreqHopOn Enables disables the intra-packet frequency hopping
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 173 * FSK : N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 174 * LoRa: [0: OFF, 1: ON]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 175 * \param [IN] HopPeriod Number of symbols bewteen each hop
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 176 * FSK : N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 177 * LoRa: Number of symbols
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 178 * \param [IN] iqInverted Inverts IQ signals (LoRa only)
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 179 * FSK : N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 180 * LoRa: [0: not inverted, 1: inverted]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 181 * \param [IN] timeout Transmission timeout [us]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 182 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 183 virtual void SetTxConfig( RadioModems_t modem, int8_t power, uint32_t fdev,
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 184 uint32_t bandwidth, uint32_t datarate,
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 185 uint8_t coderate, uint16_t preambleLen,
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 186 bool fixLen, bool crcOn, bool FreqHopOn,
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 187 uint8_t HopPeriod, bool iqInverted, uint32_t timeout ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 188
Jenkins@KEILDM1.dc.multitech.prv 127:db053d511848 189 virtual void SetTxPower(int8_t power) = 0;
Jenkins@KEILDM1.dc.multitech.prv 127:db053d511848 190
Jenkins@KEILDM1.dc.multitech.prv 131:865d54f61813 191 virtual void SetTxContinuousWave( uint32_t freq, int8_t power, uint16_t time ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 192
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 193 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 194 * \brief Checks if the given RF frequency is supported by the hardware
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 195 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 196 * \param [IN] frequency RF frequency to be checked
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 197 * \retval isSupported [true: supported, false: unsupported]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 198 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 199 virtual bool CheckRfFrequency( uint32_t frequency ) { return true; }
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 200 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 201 * \brief Computes the packet time on air for the given payload
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 202 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 203 * \Remark Can only be called once SetRxConfig or SetTxConfig have been called
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 204 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 205 * \param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 206 * \param [IN] pktLen Packet payload length
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 207 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 208 * \retval airTime Computed airTime for the given packet payload length
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 209 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 210 virtual double TimeOnAir( RadioModems_t modem, uint8_t pktLen ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 211 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 212 * \brief Sends the buffer of size. Prepares the packet to be sent and sets
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 213 * the radio in transmission
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 214 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 215 * \param [IN]: buffer Buffer pointer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 216 * \param [IN]: size Buffer size
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 217 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 218 virtual void Send( const uint8_t *buffer, uint8_t size ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 219 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 220 * \brief Sets the radio in sleep mode
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 221 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 222 virtual void Sleep( void ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 223 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 224 * \brief Sets the radio in standby mode
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 225 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 226 virtual void Standby( void ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 227 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 228 * \brief Sets the radio in reception mode for the given time
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 229 * \param [IN] timeout Reception timeout [us]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 230 * [0: continuous, others timeout]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 231 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 232 virtual void Rx( uint32_t timeout ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 233 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 234 * \brief Start a Channel Activity Detection
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 235 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 236 virtual void StartCad( void ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 237 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 238 * \brief Reads the current RSSI value
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 239 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 240 * \retval rssiValue Current RSSI value in [dBm]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 241 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 242 virtual int16_t Rssi( RadioModems_t modem ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 243 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 244 * \brief Writes the radio register at the specified address
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 245 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 246 * \param [IN]: addr Register address
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 247 * \param [IN]: data New register value
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 248 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 249 virtual void Write( uint8_t addr, uint8_t data ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 250 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 251 * \brief Reads the radio register at the specified address
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 252 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 253 * \param [IN]: addr Register address
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 254 * \retval data Register value
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 255 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 256 virtual uint8_t Read ( uint8_t addr ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 257 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 258 * \brief Writes multiple radio registers starting at address
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 259 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 260 * \param [IN] addr First Radio register address
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 261 * \param [IN] buffer Buffer containing the new register's values
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 262 * \param [IN] size Number of registers to be written
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 263 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 264 virtual void WriteBuffer( uint8_t addr, const uint8_t *buffer, uint8_t size ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 265 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 266 * \brief Reads multiple radio registers starting at address
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 267 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 268 * \param [IN] addr First Radio register address
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 269 * \param [OUT] buffer Buffer where to copy the registers data
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 270 * \param [IN] size Number of registers to be read
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 271 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 272 virtual void ReadBuffer( uint8_t addr, uint8_t *buffer, uint8_t size ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 273
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 274 virtual void SignalMacEvent(void) {};
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 275
Jenkins@KEILDM1.dc.multitech.prv 55:8c938c4e4b6a 276 virtual void ResetRadio(void) {};
Jenkins@KEILDM1.dc.multitech.prv 55:8c938c4e4b6a 277
Jenkins@KEILDM1.dc.multitech.prv 104:07cdaa180b72 278 virtual uint32_t GetTimeOnAir(void) = 0;
Jenkins@KEILDM1.dc.multitech.prv 100:4ceefc908bbd 279
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 280 void GrabMutex(void) { mutex.lock(); }
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 281 void ReleaseMutex(void) { mutex.unlock(); }
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 282
Jenkins@KEILDM1.dc.multitech.prv 127:db053d511848 283 int32_t GetFrequencyOffset() { return freq_offset; }
Jenkins@KEILDM1.dc.multitech.prv 127:db053d511848 284 void SetFrequencyOffset(int32_t offset) { freq_offset = offset; }
Jenkins@KEILDM1.dc.multitech.prv 127:db053d511848 285
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 286 const uint32_t WakeupTime;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 287
Jenkins@KEILDM1.dc.multitech.prv 127:db053d511848 288
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 289 protected:
Jenkins@KEILDM1.dc.multitech.prv 127:db053d511848 290 int32_t freq_offset;
Jenkins@KEILDM1.dc.multitech.prv 127:db053d511848 291
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 292 RadioState_t State;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 293
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 294 RadioModems_t Modem;
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 295
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 296 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 297 * Access protection
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 298 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 299 Mutex mutex;
Jenkins@KEILDM1.dc.multitech.prv 127:db053d511848 300
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 301 };
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 302
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 303 #endif // __SXRADIO_H__
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 304