Diff: radio/radio.h

Revision:

7:b988b60083a1

Parent:

0:45c4f0364ca4

--- a/radio/radio.h	Wed Feb 17 09:17:18 2016 +0000
+++ b/radio/radio.h	Mon Apr 24 09:26:08 2017 +0000
@@ -57,7 +57,6 @@
      * \param [IN] currentChannel   Index number of the current channel
      */
     void ( *FhssChangeChannel )( uint8_t currentChannel );
-
     /*!
      * @brief CAD Done callback prototype.
      *
@@ -89,35 +88,30 @@
     //-------------------------------------------------------------------------
     //                        Pure virtual functions
     //-------------------------------------------------------------------------
-
     /*!
      * @brief Initializes the radio
      *
      * @param [IN] events Structure containing the driver callback functions
      */
     virtual void Init( RadioEvents_t *events ) = 0;
-
     /*!
      * @brief Return current radio status
      *
      * @param status Radio status.[RF_IDLE, RF_RX_RUNNING, RF_TX_RUNNING]
      */
     virtual RadioState GetStatus( void ) = 0; 
-
     /*!
      * @brief Configures the radio with the given modem
      *
      * @param [IN] modem Modem to be used [0: FSK, 1: LoRa] 
      */
     virtual void SetModem( RadioModems_t modem ) = 0;
-
     /*!
      * @brief Sets the channel frequency
      *
      * @param [IN] freq         Channel RF frequency
      */
     virtual void SetChannel( uint32_t freq ) = 0;
-    
     /*!
      * @brief Sets the channels configuration
      *
@@ -128,7 +122,6 @@
      * @retval isFree         [true: Channel is free, false: Channel is not free]
      */
     virtual bool IsChannelFree( RadioModems_t modem, uint32_t freq, int16_t rssiThresh ) = 0;
-    
     /*!
      * @brief Generates a 32 bits random value based on the RSSI readings
      *
@@ -140,7 +133,6 @@
      * @retval randomValue    32 bits random value
      */
     virtual uint32_t Random( void )= 0;
-    
     /*!
      * @brief Sets the reception parameters
      *
@@ -162,8 +154,8 @@
      * @param [IN] preambleLen  Sets the Preamble length ( LoRa only )
      *                          FSK : N/A ( set to 0 )
      *                          LoRa: Length in symbols ( the hardware adds 4 more symbols )
-     * @param [IN] symbTimeout  Sets the RxSingle timeout value ( LoRa only )
-     *                          FSK : N/A ( set to 0 )
+     * @param [IN] symbTimeout  Sets the RxSingle timeout value
+     *                          FSK : timeout number of bytes
      *                          LoRa: timeout in symbols
      * @param [IN] fixLen       Fixed length packets [0: variable, 1: fixed]
      * @param [IN] payloadLen   Sets payload length when fixed lenght is used
@@ -183,7 +175,6 @@
                                uint8_t payloadLen,
                                bool crcOn, bool freqHopOn, uint8_t hopPeriod,
                                bool iqInverted, bool rxContinuous ) = 0;
-    
     /*!
      * @brief Sets the transmission parameters
      *
@@ -218,7 +209,6 @@
                               uint8_t coderate, uint16_t preambleLen,
                               bool fixLen, bool crcOn, bool freqHopOn,
                               uint8_t hopPeriod, bool iqInverted, uint32_t timeout ) = 0;
-    
     /*!
      * @brief Checks if the given RF frequency is supported by the hardware
      *
@@ -226,7 +216,6 @@
      * @retval isSupported [true: supported, false: unsupported]
      */
     virtual bool CheckRfFrequency( uint32_t frequency ) = 0;
-    
     /*!
      * @brief Computes the packet time on air for the given payload
      *
@@ -237,8 +226,7 @@
      *
      * @retval airTime        Computed airTime for the given packet payload length
      */
-    virtual double TimeOnAir ( RadioModems_t modem, uint8_t pktLen ) = 0;
-    
+    virtual uint32_t TimeOnAir ( RadioModems_t modem, uint8_t pktLen ) = 0;
     /*!
      * @brief Sends the buffer of size. Prepares the packet to be sent and sets
      *        the radio in transmission
@@ -247,43 +235,44 @@
      * @param [IN]: size       Buffer size
      */
     virtual void Send( uint8_t *buffer, uint8_t size ) = 0;
-    
     /*!
      * @brief Sets the radio in sleep mode
      */
     virtual void Sleep( void ) = 0;
-    
     /*!
      * @brief Sets the radio in standby mode
      */
     virtual void Standby( void ) = 0;
-    
     /*!
      * @brief Sets the radio in CAD mode
      */
     virtual void StartCad( void ) = 0;
-    
     /*!
      * @brief Sets the radio in reception mode for the given time
      * @param [IN] timeout Reception timeout [us]
      *                     [0: continuous, others timeout]
      */
     virtual void Rx( uint32_t timeout ) = 0;
-    
     /*!
      * @brief Sets the radio in transmission mode for the given time
      * @param [IN] timeout Transmission timeout [us]
      *                     [0: continuous, others timeout]
      */
     virtual void Tx( uint32_t timeout ) = 0;
-    
+    /*!
+     * @brief Sets the radio in continuous wave transmission mode
+     *
+     * @param [IN]: freq       Channel RF frequency
+     * @param [IN]: power      Sets the output power [dBm]
+     * @param [IN]: time       Transmission mode timeout [s]
+     */
+    virtual void SetTxContinuousWave( uint32_t freq, int8_t power, uint16_t time ) = 0;
     /*!
      * @brief Reads the current RSSI value
      *
      * @retval rssiValue Current RSSI value in [dBm]
      */
     virtual int16_t GetRssi ( RadioModems_t modem ) = 0;
-    
     /*!
      * @brief Writes the radio register at the specified address
      *
@@ -291,7 +280,6 @@
      * @param [IN]: data New register value
      */
     virtual void Write ( uint8_t addr, uint8_t data ) = 0;
-    
     /*!
      * @brief Reads the radio register at the specified address
      *
@@ -299,7 +287,6 @@
      * @retval data Register value
      */
     virtual uint8_t Read ( uint8_t addr ) = 0;
-    
     /*!
      * @brief Writes multiple radio registers starting at address
      *
@@ -308,7 +295,6 @@
      * @param [IN] size   Number of registers to be written
      */
     virtual void Write( uint8_t addr, uint8_t *buffer, uint8_t size ) = 0;
-    
     /*!
      * @brief Reads multiple radio registers starting at address
      *
@@ -317,23 +303,20 @@
      * @param [IN] size Number of registers to be read
      */
     virtual void Read ( uint8_t addr, uint8_t *buffer, uint8_t size ) = 0;
-    
     /*!
-     * @brief Writes the buffer contents to the SX1276 FIFO
+     * @brief Writes the buffer contents to the Radio FIFO
      *
      * @param [IN] buffer Buffer containing data to be put on the FIFO.
      * @param [IN] size Number of bytes to be written to the FIFO
      */
     virtual void WriteFifo( uint8_t *buffer, uint8_t size ) = 0;
-
     /*!
-     * @brief Reads the contents of the SX1276 FIFO
+     * @brief Reads the contents of the Radio FIFO
      *
      * @param [OUT] buffer Buffer where to copy the FIFO read data.
      * @param [IN] size Number of bytes to be read from the FIFO
      */
     virtual void ReadFifo( uint8_t *buffer, uint8_t size ) = 0;
-    
     /*!
      * @brief Sets the maximum payload length.
      *
@@ -341,6 +324,14 @@
      * @param [IN] max        Maximum payload length in bytes
      */
     virtual void SetMaxPayloadLength( RadioModems_t modem, uint8_t max ) = 0;
+    /*!
+     * @brief Sets the network to public or private. Updates the sync byte.
+     *
+     * @remark Applies to LoRa modem only
+     *
+     * @param [IN] enable if true, it enables a public network
+     */
+    virtual void SetPublicNetwork( bool enable ) = 0;
 };
 
 #endif // __RADIO_H__