LoRaMacTest.h

00001 /*!
00002  * \file      LoRaMacTest.h
00003  *
00004  * \brief     LoRa MAC layer test function implementation
00005  *
00006  * \copyright Revised BSD License, see section \ref LICENSE.
00007  *
00008  * \code
00009  *                ______                              _
00010  *               / _____)             _              | |
00011  *              ( (____  _____ ____ _| |_ _____  ____| |__
00012  *               \____ \| ___ |    (_   _) ___ |/ ___)  _ \
00013  *               _____) ) ____| | | || |_| ____( (___| | | |
00014  *              (______/|_____)_|_|_| \__)_____)\____)_| |_|
00015  *              (C)2013 Semtech
00016  *
00017  *               ___ _____ _   ___ _  _____ ___  ___  ___ ___
00018  *              / __|_   _/_\ / __| |/ / __/ _ \| _ \/ __| __|
00019  *              \__ \ | |/ _ \ (__| ' <| _| (_) |   / (__| _|
00020  *              |___/ |_/_/ \_\___|_|\_\_| \___/|_|_\\___|___|
00021  *              embedded.connectivity.solutions===============
00022  *
00023  * \endcode
00024  *
00025  * \author    Miguel Luis ( Semtech )
00026  *
00027  * \author    Gregory Cristian ( Semtech )
00028  *
00029  * \author    Daniel Jäckle ( STACKFORCE )
00030  *
00031  * \defgroup  LORAMACTEST LoRa MAC layer test function implementation
00032  *            This module specifies the API implementation of test function of the LoRaMAC layer.
00033  *            The functions in this file are only for testing purposes only.
00034  * \{
00035  */
00036 #ifndef __LORAMACTEST_H__
00037 #define __LORAMACTEST_H__
00038 
00039 /*!
00040  * \brief   Enabled or disables the reception windows
00041  *
00042  * \details This is a test function. It shall be used for testing purposes only.
00043  *          Changing this attribute may lead to a non-conformance LoRaMac operation.
00044  *
00045  * \param   [IN] enable - Enabled or disables the reception windows
00046  */
00047 void LoRaMacTestRxWindowsOn( bool enable );
00048 
00049 /*!
00050  * \brief   Enables the MIC field test
00051  *
00052  * \details This is a test function. It shall be used for testing purposes only.
00053  *          Changing this attribute may lead to a non-conformance LoRaMac operation.
00054  *
00055  * \param   [IN] txPacketCounter - Fixed Tx packet counter value
00056  */
00057 void LoRaMacTestSetMic( uint16_t txPacketCounter );
00058 
00059 /*!
00060  * \brief   Enabled or disables the duty cycle
00061  *
00062  * \details This is a test function. It shall be used for testing purposes only.
00063  *          Changing this attribute may lead to a non-conformance LoRaMac operation.
00064  *
00065  * \param   [IN] enable - Enabled or disables the duty cycle
00066  */
00067 void LoRaMacTestSetDutyCycleOn( bool enable );
00068 
00069 /*!
00070  * \brief   Sets the channel index
00071  *
00072  * \details This is a test function. It shall be used for testing purposes only.
00073  *          Changing this attribute may lead to a non-conformance LoRaMac operation.
00074  *
00075  * \param   [IN] channel - Channel index
00076  */
00077 void LoRaMacTestSetChannel( uint8_t channel );
00078 
00079 /*! \} defgroup LORAMACTEST */
00080 
00081 #endif // __LORAMACTEST_H__