sigfox_api.h

Go to the documentation of this file.

 
/* ################################## VERSION INFORMATION ################################## */
/* This library supports FH spectrum access to be compliant with FCC standards. */
/* This library supports DC spectrum access to be compliant with ETSI standards. */
/* This library supports LBT spectrum access to be compliant with ARIB standards. */
 
 
/* Warning : this library supports the Monarch feature */
 
 
 
/* ######################################################################################### */
 
 
/* -------------------------------------------------------------------------------------------------------------------------------------
*                                           IMPORTANT NOTE on ERROR CODES
*  -------------------------------------------------------------------------------------------------------------------------------------
*
*  ALL SIGFOX_API_xxx or SIGFOX_REPEATER_API_xxx functions returns an error type sfx_error_t
*
*  The sfx_error_t is composed of the following :
*
*    MSB_____________________________________________LSB
*    15                      8|7                     0
|                       |                      |
|   MANUF_ERROR_CODE    |  SIGFOX_ERROR_CODE   |
||_______________________|______________________|
|
|
|  MANUF_ERROR_CODE :
|     - Represents the error codes for MCU_API_xx, RF_API_xx, SE_API_xx, REPEATER_API_xx
|     - All MCU_API_xx, RF_API_xx, SE_API_xx, REPEATER_API_xx have to return SFX_ERR_NONE when no error
|     - Minimum set of error codes are defined into the mcu_api.h, rf_api.h, se_api.h and repeater_api.h : Manufacturer can define more error codes !
|
|  SIGFOX_ERROR_CODE :
|      - Represents the error codes of the SIGFOX API or internal functions
|      - All the error codes can be found in this file ( sigfox_api.h )
|
|  ------------------------------------------------------------------------------------------------------------------------------------- */
 
#ifndef SIGFOX_API_H
#define SIGFOX_API_H
 
#include "sigfox_types.h"
 
#define SFX_ERR_NONE                                             (sfx_u8)(0x00) 
/*
 * ----------------------------------------------------------------
 * Bytes reserved for SIGFOX ERROR CODES : From 0x10 to 0xBF
 * ----------------------------------------------------------------
 */
 
#define SFX_ERR_API_OPEN                                         (sfx_u8)(0x10) 
#define SFX_ERR_API_OPEN_STATE                                   (sfx_u8)(0x11) 
#define SFX_ERR_API_OPEN_GET_NVMEM_MEMORY_OVERLAP                (sfx_u8)(0x12) 
#define SFX_ERR_API_OPEN_RC_PTR                                  (sfx_u8)(0x13) 
#define SFX_ERR_API_OPEN_MACRO_CHANNEL_WIDTH                     (sfx_u8)(0x14) 
#define SFX_ERR_API_CLOSE_FREE                                   (sfx_u8)(0x20) 
#define SFX_ERR_API_CLOSE_STATE                                  (sfx_u8)(0x21) 
#define SFX_ERR_API_SEND_FRAME_DATA_LENGTH                       (sfx_u8)(0x30) 
#define SFX_ERR_API_SEND_FRAME_RESPONSE_PTR                      (sfx_u8)(0x31) 
#define SFX_ERR_API_SEND_FRAME_DELAY_OOB_ACK                     (sfx_u8)(0x32) 
#define SFX_ERR_API_SEND_FRAME_DATA_PTR                          (sfx_u8)(0x33) 
#define SFX_ERR_API_SEND_BIT_RESPONSE_PTR                        (sfx_u8)(0x34) 
#define SFX_ERR_API_SEND_OOB_TYPE                                (sfx_u8)(0x35) 
#define SFX_ERR_API_SET_STD_CONFIG_CARRIER_SENSE_CONFIG          (sfx_u8)(0x40) 
#define SFX_ERR_API_SET_STD_CONFIG_FH_CHANNELS                   (sfx_u8)(0x41) 
#define SFX_ERR_API_SEND_TEST_FRAME_DEVICE_ID                    (sfx_u8)(0x50) 
#define SFX_ERR_API_SEND_TEST_FRAME_STATE                        (sfx_u8)(0x51) 
#define SFX_ERR_API_SEND_TEST_FRAME_DATA_LENGTH                  (sfx_u8)(0x52) 
#define SFX_ERR_API_SEND_TEST_FRAME_DATA_PTR                     (sfx_u8)(0x53) 
#define SFX_ERR_API_SEND_TEST_STORE_NVM                          (sfx_u8)(0x54) 
#define SFX_ERR_API_RECEIVE_TEST_FRAME_DEVICE_ID                 (sfx_u8)(0x55) 
#define SFX_ERR_API_RECEIVE_TEST_FRAME_STATE                     (sfx_u8)(0x56) 
#define SFX_ERR_API_START_CONTINUOUS_TRANSMISSION                (sfx_u8)(0x57) 
#define SFX_ERR_API_START_CONTINUOUS_TRANSMISSION_STATE          (sfx_u8)(0x58) 
#define SFX_ERR_API_STOP_CONTINUOUS_TRANSMISSION                 (sfx_u8)(0x59) 
#define SFX_ERR_API_STOP_CONTINUOUS_TRANSMISSION_STATE           (sfx_u8)(0x5A) 
#define SFX_ERR_API_GET_INITIAL_PAC                              (sfx_u8)(0x5B) 
#define SFX_ERR_API_GET_VERSION                                  (sfx_u8)(0x5C) 
#define SFX_ERR_API_GET_VERSION_WRONG_TYPE                       (sfx_u8)(0x5D) 
#define SFX_ERR_API_SWITCH_PUBLIC_KEY                            (sfx_u8)(0x5E) 
#define SFX_ERR_INT_EXECUTE_COM_SEQUENCE_STATE                   (sfx_u8)(0x60) 
#define SFX_ERR_INT_EXECUTE_COM_SEQUENCE_NVM_STORAGE_MESSAGE     (sfx_u8)(0x61) 
#define SFX_ERR_INT_EXECUTE_COM_SEQUENCE_NVM_STORAGE_ACK         (sfx_u8)(0x62) 
#define SFX_ERR_INT_EXECUTE_COM_SEQUENCE_NVM_STORAGE_RCSYNC      (sfx_u8)(0x63) 
#define SFX_ERR_INT_EXECUTE_COM_SEQUENCE_DELAY_OOB_ACK           (sfx_u8)(0x64) 
#define SFX_ERR_INT_PROCESS_UPLINK_START_TIMER_FH_IN_DL          (sfx_u8)(0x70) 
#define SFX_ERR_INT_PROCESS_UPLINK_WAIT_FOR_END_TIMER_FH_IN_DL   (sfx_u8)(0x71) 
#define SFX_ERR_INT_PROCESS_UPLINK_TIMER_FH                      (sfx_u8)(0x72) 
#define SFX_ERR_INT_PROCESS_UPLINK_WAIT_FOR_END_TIMER_FH         (sfx_u8)(0x73) 
#define SFX_ERR_INT_PROCESS_UPLINK_DELAY_INTERFRAME              (sfx_u8)(0x74) 
#define SFX_ERR_INT_PROCESS_UPLINK_TIMER_DOWNLINK                (sfx_u8)(0x75) 
#define SFX_ERR_INT_PROCESS_UPLINK_CS_RETRY                      (sfx_u8)(0x76) 
#define SFX_ERR_INT_PROCESS_UPLINK_CS_RETRY_START_TIMER          (sfx_u8)(0x77) 
#define SFX_ERR_INT_PROCESS_UPLINK_CS_RETRY_STOP_TIMER           (sfx_u8)(0x78) 
#define SFX_ERR_INT_PROCESS_UPLINK_CS_RETRY_DELAY_ATTEMPT        (sfx_u8)(0x79) 
#define SFX_ERR_INT_PROCESS_UPLINK_CS_REPETITION                 (sfx_u8)(0x7A) 
#define SFX_ERR_INT_PROCESS_UPLINK_CS_REPETITION_START_TIMER     (sfx_u8)(0x7B) 
#define SFX_ERR_INT_PROCESS_UPLINK_CS_REPETITION_STOP_TIMER      (sfx_u8)(0x7C) 
#define SFX_ERR_INT_PROCESS_UPLINK_CS_REPETITION_STOP_TIMER_2    (sfx_u8)(0x7D) 
#define SFX_ERR_INT_PROCESS_UPLINK_CS_TIMEOUT                    (sfx_u8)(0x7E) 
#define SFX_ERR_INT_BUILD_FRAME_SE                               (sfx_u8)(0x90) 
#define SFX_ERR_INT_BUILD_FRAME                                  (sfx_u8)(0x91) 
#define SFX_ERR_INT_BUILD_FRAME_OOB_SERVICE                      (sfx_u8)(0x92) 
#define SFX_ERR_INT_BUILD_FRAME_OOB_DOWNLINK_ACK                 (sfx_u8)(0x93) 
#define SFX_ERR_INT_BUILD_FRAME_OOB_REPEATER_STATUS              (sfx_u8)(0x94) 
#define SFX_ERR_INT_BUILD_FRAME_OOB_RC_SYNC                      (sfx_u8)(0x95) 
#define SFX_ERR_INT_BUILD_FRAME_PAYLOAD_CRYPTED                  (sfx_u8)(0x96) 
#define SFX_ERR_INT_SEND_SINGLE_FRAME                            (sfx_u8)(0x97) 
#define SFX_ERR_INT_PROCESS_DOWNLINK                             (sfx_u8)(0x98) 
#define SFX_ERR_INT_GET_DEVICE_ID                                (sfx_u8)(0x99) 
#define SFX_ERR_INT_GET_RECEIVED_FRAMES                          (sfx_u8)(0x9A) 
#define SFX_ERR_INT_GET_RECEIVED_FRAMES_TIMEOUT                  (sfx_u8)(0x9B) 
#define SFX_ERR_INT_GET_RECEIVED_FRAMES_WAIT_NOT_EXECUTED        (sfx_u8)(0x9C) 
#define SFX_ERR_INT_GET_DEVICE_INFO                              (sfx_u8)(0x9D) 
#define SFX_ERR_INT_GET_DEVICE_INFO_CRC                          (sfx_u8)(0x9E) 
#define SFX_ERR_INT_GET_DEVICE_INFO_CERTIFICATE                  (sfx_u8)(0x9F) 
#define SFX_ERR_API_SET_RC_SYNC_PERIOD                                     (sfx_u8)(0xB0) 
#define SFX_ERR_API_SET_RC_SYNC_PERIOD_VALUE                               (sfx_u8)(0xB1) 
#define SFX_ERR_MONARCH_API_EXECUTE_RC_SCAN_STATE                           (sfx_u8)(0xB2) 
#define SFX_ERR_MONARCH_API_EXECUTE_RC_SCAN                                 (sfx_u8)(0xB3) 
#define SFX_ERR_MONARCH_API_EXECUTE_RC_SCAN_NULL_CALLBACK                   (sfx_u8)(0xB4) 
#define SFX_ERR_MONARCH_API_STOP_RC_SCAN_STATE                              (sfx_u8)(0xB5) 
#define SFX_ERR_MONARCH_API_STOP_RC_SCAN                                    (sfx_u8)(0xB6) 
#define SFX_ERR_CALLBACK_MONARCH_SCAN_TIMEOUT_CB_STATE                      (sfx_u8)(0xB7) 
#define SFX_ERR_CALLBACK_MONARCH_SCAN_TIMEOUT                               (sfx_u8)(0xB8) 
#define SFX_ERR_CALLBACK_MONARCH_PATTERN_FREQUENCY_RESULT_STATE             (sfx_u8)(0xB9) 
#define SFX_ERR_CALLBACK_MONARCH_PATTERN_FREQUENCY_RESULT                   (sfx_u8)(0xBA) 
#define SFX_ERR_CALLBACK_MONARCH_PATTERN_FREQUENCY_RESULT_WRONG_PATTERN     (sfx_u8)(0xBB) 
#define SFX_ERR_CALLBACK_MONARCH_PATTERN_FREQUENCY_RESULT_WRONG_FREQ        (sfx_u8)(0xBC) 
/*
 * -----------------------------------------------------------------------------
 * Bytes reserved for SIGFOX ADDONS ERROR CODES : From 0xC0 to 0xDF
 * -----------------------------------------------------------------------------
 */
 
 
#define SFX_ERR_INT_DOWNLINK_CONFIGURATION                                  (sfx_u8)(0xE0) 
/* Define Radio Configuration */
#define NA                                    0 /* Used to store Not applicable values in config words or open parameters */
 
#define RC1_OPEN_UPLINK_CENTER_FREQUENCY      (sfx_u32)(868130000) /* Hz */
#define RC1_OPEN_DOWNLINK_CENTER_FREQUENCY    (sfx_u32)(869525000) /* Hz */
#define RC1_MACRO_CHANNEL_WIDTH               (sfx_u32)(192000) /* Hz */
#define RC1_UPLINK_MODULATION                 SFX_DBPSK_100BPS
#define RC1_UPLINK_SPECTRUM_ACCESS            SFX_DC
 
#define RC2_OPEN_UPLINK_START_OF_TABLE        (sfx_u32)(902200000) /* Hz, The center frequency of RC2 is defined by the activated channels in config words */
#define RC2_OPEN_DOWNLINK_CENTER_FREQUENCY    (sfx_u32)(905200000) /* Hz */
#define RC2_MACRO_CHANNEL_WIDTH               (sfx_u32)(192000) /* Hz */
#define RC2_UPLINK_MODULATION                 SFX_DBPSK_600BPS
#define RC2_UPLINK_SPECTRUM_ACCESS            SFX_FH
#define RC2_SET_STD_CONFIG_LM_WORD_0          (sfx_u32)0x000001FF /* LM = Long Message */
#define RC2_SET_STD_CONFIG_LM_WORD_1          (sfx_u32)0x00000000
#define RC2_SET_STD_CONFIG_LM_WORD_2          (sfx_u32)0x00000000
#define RC2_SET_STD_TIMER_ENABLE              (sfx_bool)(SFX_TRUE) /* Enable Timer for FH duty cycle*/
#define RC2_SET_STD_TIMER_DISABLE             (sfx_bool)(SFX_FALSE) /* Disable timer feature*/
#define RC2_SET_STD_CONFIG_SM_WORD_0          (sfx_u32)0x00000001 /* SM = Short message */
#define RC2_SET_STD_CONFIG_SM_WORD_1          (sfx_u32)0x00000000
#define RC2_SET_STD_CONFIG_SM_WORD_2          (sfx_u32)0x00000000
 
#define RC3A_OPEN_CS_CENTER_FREQUENCY         (sfx_u32)(923200000) /* Hz */
#define RC3A_OPEN_CS_BANDWIDTH                (sfx_u32)(200000) /* Hz */
#define RC3A_OPEN_UPLINK_CENTER_FREQUENCY     (sfx_u32)(923200000) /* Hz */
#define RC3A_OPEN_DOWNLINK_CENTER_FREQUENCY   (sfx_u32)(922200000) /* Hz */
#define RC3A_MACRO_CHANNEL_WIDTH              (sfx_u32)(36000) /* Hz */
#define RC3A_UPLINK_MODULATION                SFX_DBPSK_100BPS
#define RC3A_UPLINK_SPECTRUM_ACCESS           SFX_LBT
#define RC3A_CS_THRESHOLD                     (sfx_s8)(-80) /* dBm */
 
#define RC3C_OPEN_CS_CENTER_FREQUENCY         (sfx_u32)(923200000) /* Hz */
#define RC3C_OPEN_CS_BANDWIDTH                (sfx_u32)(200000) /* Hz */
#define RC3C_OPEN_UPLINK_CENTER_FREQUENCY     (sfx_u32)(923200000) /* Hz */
#define RC3C_OPEN_DOWNLINK_CENTER_FREQUENCY   (sfx_u32)(922200000) /* Hz */
#define RC3C_MACRO_CHANNEL_WIDTH              (sfx_u32)(192000) /* Hz */
#define RC3C_UPLINK_MODULATION                SFX_DBPSK_100BPS
#define RC3C_UPLINK_SPECTRUM_ACCESS           SFX_LBT
#define RC3C_CS_THRESHOLD                     (sfx_s8)(-80) /* dBm */
 
#define RC4_OPEN_UPLINK_START_OF_TABLE        (sfx_u32)(902200000) /* Hz, The center frequency of RC4 is defined by the activated channels in config words */
#define RC4_OPEN_DOWNLINK_CENTER_FREQUENCY    (sfx_u32)(922300000) /* Hz */
#define RC4_MACRO_CHANNEL_WIDTH               (sfx_u32)(192000) /* Hz */
#define RC4_UPLINK_MODULATION                 SFX_DBPSK_600BPS
#define RC4_UPLINK_SPECTRUM_ACCESS            SFX_FH
#define RC4_SET_STD_CONFIG_LM_WORD_0          (sfx_u32)0x00000000 /* LM = Long Message */
#define RC4_SET_STD_CONFIG_LM_WORD_1          (sfx_u32)0xF0000000
#define RC4_SET_STD_CONFIG_LM_WORD_2          (sfx_u32)0x0000001F
#define RC4_SET_STD_TIMER_ENABLE              (sfx_bool)(SFX_TRUE) /* Enable Timer for FH duty cycle*/
#define RC4_SET_STD_TIMER_DISABLE             (sfx_bool)(SFX_FALSE) /* Disable timer feature*/
#define RC4_SET_STD_CONFIG_SM_WORD_0          (sfx_u32)0x00000000 /* SM = Short message */
#define RC4_SET_STD_CONFIG_SM_WORD_1          (sfx_u32)0x40000000
#define RC4_SET_STD_CONFIG_SM_WORD_2          (sfx_u32)0x00000000
 
#define RC5_OPEN_CS_CENTER_FREQUENCY          (sfx_u32)(923300000) /* Hz */
#define RC5_OPEN_CS_BANDWIDTH                 (sfx_u32)(200000) /* Hz */
#define RC5_OPEN_UPLINK_CENTER_FREQUENCY      (sfx_u32)(923300000) /* Hz */
#define RC5_OPEN_DOWNLINK_CENTER_FREQUENCY    (sfx_u32)(922300000) /* Hz */
#define RC5_MACRO_CHANNEL_WIDTH               (sfx_u32)(192000) /* Hz */
#define RC5_UPLINK_MODULATION                 SFX_DBPSK_100BPS
#define RC5_UPLINK_SPECTRUM_ACCESS            SFX_LBT
#define RC5_CS_THRESHOLD                      (sfx_s8)(-65) /* dBm */
 
#define RC6_OPEN_UPLINK_CENTER_FREQUENCY      (sfx_u32)(865200000) /* Hz */
#define RC6_OPEN_DOWNLINK_CENTER_FREQUENCY    (sfx_u32)(866300000) /* Hz */
#define RC6_MACRO_CHANNEL_WIDTH               (sfx_u32)(192000) /* Hz */
#define RC6_UPLINK_MODULATION                 SFX_DBPSK_100BPS
#define RC6_UPLINK_SPECTRUM_ACCESS            SFX_DC
 
#define RC7_OPEN_UPLINK_CENTER_FREQUENCY      (sfx_u32)(868800000) /* Hz */
#define RC7_OPEN_DOWNLINK_CENTER_FREQUENCY    (sfx_u32)(869100000) /* Hz */
#define RC7_MACRO_CHANNEL_WIDTH               (sfx_u32)(192000) /* Hz */
#define RC7_UPLINK_MODULATION                 SFX_DBPSK_100BPS
#define RC7_UPLINK_SPECTRUM_ACCESS            SFX_DC
 
#define RC101_OPEN_UPLINK_CENTER_FREQUENCY    (sfx_u32)(68862500) /* Hz */
#define RC101_OPEN_DOWNLINK_CENTER_FREQUENCY  (sfx_u32)(72912500) /* Hz */
#define RC101_MACRO_CHANNEL_WIDTH             (sfx_u32)(12500) /* Hz */
#define RC101_UPLINK_MODULATION               SFX_DBPSK_100BPS
#define RC101_UPLINK_SPECTRUM_ACCESS          SFX_DC
 
 
/* ----------------------------------------------
 * IMPORTANT INFORMATION :
 * ----------------------------------------------
 * The SIGFOX Library needs to be opened with
 * one of the below configurations.
 * ----------------------------------------------
 */
#define RC1   {RC1_OPEN_UPLINK_CENTER_FREQUENCY,   RC1_OPEN_DOWNLINK_CENTER_FREQUENCY,   RC1_MACRO_CHANNEL_WIDTH,   RC1_UPLINK_MODULATION,   RC1_UPLINK_SPECTRUM_ACCESS, {NA,NA,NA}}
#define RC2   {RC2_OPEN_UPLINK_START_OF_TABLE,     RC2_OPEN_DOWNLINK_CENTER_FREQUENCY,   RC2_MACRO_CHANNEL_WIDTH,   RC2_UPLINK_MODULATION,   RC2_UPLINK_SPECTRUM_ACCESS, {NA,NA,NA}}
#define RC3A  {RC3A_OPEN_UPLINK_CENTER_FREQUENCY,  RC3A_OPEN_DOWNLINK_CENTER_FREQUENCY,  RC3A_MACRO_CHANNEL_WIDTH,  RC3A_UPLINK_MODULATION,  RC3A_UPLINK_SPECTRUM_ACCESS, {RC3A_OPEN_CS_CENTER_FREQUENCY,RC3A_OPEN_CS_BANDWIDTH, RC3A_CS_THRESHOLD}}
#define RC3C  {RC3C_OPEN_UPLINK_CENTER_FREQUENCY,  RC3C_OPEN_DOWNLINK_CENTER_FREQUENCY,  RC3C_MACRO_CHANNEL_WIDTH,  RC3C_UPLINK_MODULATION,  RC3C_UPLINK_SPECTRUM_ACCESS, {RC3C_OPEN_CS_CENTER_FREQUENCY,RC3C_OPEN_CS_BANDWIDTH, RC3C_CS_THRESHOLD}}
 
#define RC4   {RC4_OPEN_UPLINK_START_OF_TABLE,     RC4_OPEN_DOWNLINK_CENTER_FREQUENCY,   RC4_MACRO_CHANNEL_WIDTH,   RC4_UPLINK_MODULATION,   RC4_UPLINK_SPECTRUM_ACCESS, {NA,NA,NA}}
#define RC5   {RC5_OPEN_UPLINK_CENTER_FREQUENCY,   RC5_OPEN_DOWNLINK_CENTER_FREQUENCY,   RC5_MACRO_CHANNEL_WIDTH,   RC5_UPLINK_MODULATION,   RC5_UPLINK_SPECTRUM_ACCESS, {RC5_OPEN_CS_CENTER_FREQUENCY,RC5_OPEN_CS_BANDWIDTH, RC5_CS_THRESHOLD}}
#define RC6   {RC6_OPEN_UPLINK_CENTER_FREQUENCY,   RC6_OPEN_DOWNLINK_CENTER_FREQUENCY,   RC6_MACRO_CHANNEL_WIDTH,   RC6_UPLINK_MODULATION,   RC6_UPLINK_SPECTRUM_ACCESS, {NA,NA,NA}}
#define RC7   {RC7_OPEN_UPLINK_CENTER_FREQUENCY,   RC7_OPEN_DOWNLINK_CENTER_FREQUENCY,   RC7_MACRO_CHANNEL_WIDTH,   RC7_UPLINK_MODULATION,   RC7_UPLINK_SPECTRUM_ACCESS, {NA,NA,NA}}
#define RC101 {RC101_OPEN_UPLINK_CENTER_FREQUENCY, RC101_OPEN_DOWNLINK_CENTER_FREQUENCY, RC101_MACRO_CHANNEL_WIDTH, RC101_UPLINK_MODULATION, RC101_UPLINK_SPECTRUM_ACCESS, {NA,NA,NA}}
 
#define RC2_LM_CONFIG  {RC2_SET_STD_CONFIG_LM_WORD_0, RC2_SET_STD_CONFIG_LM_WORD_1, RC2_SET_STD_CONFIG_LM_WORD_2} 
#define RC4_LM_CONFIG  {RC4_SET_STD_CONFIG_LM_WORD_0, RC4_SET_STD_CONFIG_LM_WORD_1, RC4_SET_STD_CONFIG_LM_WORD_2} 
#define RC2_SM_CONFIG  {RC2_SET_STD_CONFIG_SM_WORD_0, RC2_SET_STD_CONFIG_SM_WORD_1, RC2_SET_STD_CONFIG_SM_WORD_2} 
#define RC4_SM_CONFIG  {RC4_SET_STD_CONFIG_SM_WORD_0, RC4_SET_STD_CONFIG_SM_WORD_1, RC4_SET_STD_CONFIG_SM_WORD_2} 
#define RC3A_CONFIG    {0x00000003,0x00001388,0x00000000} 
#define RC3C_CONFIG    {0x00000003,0x00001388,0x00000000} 
#define RC5_CONFIG     {0x00000003,0x00001388,0x00000000} 
#define ID_LENGTH      (sfx_u8)(4) /* Size of device identifier */
#define PAC_LENGTH     (sfx_u8)(8) /* Size of device initial PAC */
 
/********************************
 * \enum sfx_spectrum_access_t
 * \brief Data type for Spectrum Access
 * Define as bit mask value so that we can combine
 * them if needed (not yet implemented)
 *******************************/
typedef enum
{
    SFX_FH   = 1, 
    SFX_LBT  = 2, 
    SFX_DC   = 4, 
}sfx_spectrum_access_t;
 
/********************************
 * \enum sfx_version_type_t
 * \brief Enum to be used in SIGFOX_API_get_version
 *******************************/
typedef enum
{
    VERSION_SIGFOX    = 0, 
    VERSION_MCU       = 1, 
    VERSION_RF        = 2, 
    VERSION_MONARCH   = 5, 
}sfx_version_type_t;
 
typedef enum
{
    AUTHENTICATION_OFF   = 0, 
    AUTHENTICATION_ON    = 1, 
}sfx_authentication_mode_t;
 
typedef enum
{
    DL_TIMEOUT        = 0,
    DL_PASSED         = 1,
}sfx_rx_state_enum_t;
 
/********************************
 * \enum sfx_oob_enum_t
 * \brief This enum contains all the OOB frame types
 * that can be send by the user application
 *******************************/
typedef enum
{
    SFX_OOB_SERVICE = 0,
    SFX_OOB_RC_SYNC,
    SFX_MAX_OOB_LIST_SIZE,
}sfx_oob_enum_t;
 
/********************************
 * \enum sfx_state_t
 * \brief State Machine constants
 * The state machine will never
 * returns automatically to SFX_STATE_READY
 * if an error has occured during
 * frame transmissions
 *******************************/
typedef enum
{
    SFX_STATE_IDLE             = 0, 
    SFX_STATE_NOT_CONFIGURED   = 1, 
    SFX_STATE_READY            = 2, 
    SFX_STATE_UPLINK           = 3, 
    SFX_STATE_DOWNLINK         = 4, 
    SFX_STATE_MONARCH_LISTENING_SWEEP   = 6, 
    SFX_STATE_MONARCH_LISTENING_WINDOW  = 7, 
}sfx_state_t;
 
/********************************
 * \enum sfx_modulation_type_t
 * \brief Uplink Modulation type with baudrate
 *******************************/
typedef enum
{
    SFX_NO_MODULATION = 0, 
    SFX_DBPSK_100BPS  = 1, 
    SFX_DBPSK_600BPS  = 2, 
}sfx_modulation_type_t;
 
/********************************
 * \enum sfx_nvmem_t
 * \brief Data type for Nv memory access
 * Saving PN and Sequence are mandatory
 * for backend compatibility
 *******************************/
/* FH information required, seq_num stored in nv_mem */
typedef enum
{
    SFX_NVMEM_PN         = 0, 
    SFX_NVMEM_SEQ_NUM    = 2, 
    SFX_NVMEM_FH         = 4, 
    SFX_NVMEM_RL         = 6, 
    SFX_NVMEM_BLOCK_SIZE = 7,
}sfx_nvmem_t;
 
 
/********************************
 * \enum sfx_rf_mode_t
 * \brief Functionnal mode for RF chip
 *******************************/
typedef enum
{
    SFX_RF_MODE_TX = 0, 
    SFX_RF_MODE_RX = 1, 
    SFX_RF_MODE_CS200K_RX = 2, 
    SFX_RF_MODE_CS300K_RX = 3, 
    SFX_RF_MODE_MONARCH   = 4, 
}sfx_rf_mode_t;
 
/********************************
 * \enum sfx_delay_t
 * \brief Delay type
 *******************************/
typedef enum
{
    SFX_DLY_INTER_FRAME_TRX = 0, 
    SFX_DLY_INTER_FRAME_TX  = 1, 
    SFX_DLY_OOB_ACK         = 2, 
    SFX_DLY_CS_SLEEP        = 3, 
}sfx_delay_t;
 
/********************************
 * \enum sfx_credentials_use_key_t
 * \brief Key to use for MANUF_API_aes_128_cbc_encrypt()
 *******************************/
typedef enum
{
    CREDENTIALS_PRIVATE_KEY = 0, 
    CREDENTIALS_KEY_IN_ARGUMENT, 
}sfx_credentials_use_key_t;
 
/********************************
 * \struct sfx_rc_specific_t
 * \brief Radio configuration substruture for specific radio configuration
 * All parameters requested to define
 * radio configuration subsctructure.
 *******************************/
typedef struct sfx_rc_specific_t
{
    sfx_u32 open_cs_frequency; 
    sfx_u32 open_cs_bandwidth; 
    sfx_s8 cs_threshold; 
}sfx_rc_specific_t;
 
/********************************
 * \struct sfx_rc_t
 * \brief Radio configuration structure
 * All parameters requested to define
 * radio configuration.
 *******************************/
typedef struct sfx_rc_t
{
    sfx_u32 open_tx_frequency; 
    sfx_u32 open_rx_frequency; 
    sfx_u32 macro_channel_width; 
    sfx_modulation_type_t modulation; 
    sfx_spectrum_access_t spectrum_access; 
    sfx_rc_specific_t specific_rc; 
}sfx_rc_t;
 
/*
 ***************************************
 *          Sigfox Library API
 ***************************************
 */
 
/*!******************************************************************
 * \fn sfx_error_t SIGFOX_API_open(sfx_rc_t *rc)
 * \brief This function initialises library (mandatory). The SIGFOX_API_open function will :
 *  - Allocate memory for library
 *  - Save the input parameters once (Can't be changed till SIGFOX_API_close call)
 *  - Read the non volatile memory content
 *  - Set the global state to SFX_STATE_READY
 *
 * \param[in] sfx_rc_t *rc                      Pointer on the Radio Configuration Zone: it is mandatory
 *                                              to use already existing RCx define.
 *
 * \retval  The sfx_error_t is composed of the following :
 *
 *    MSB_____________________________________________LSB
 *    15                      8|7                     0
 *     |                       |                      |
 *     |   MANUF_ERROR_CODE    |  SIGFOX_ERROR_CODE   |
 *     |_______________________|______________________|
 *
 *  SIGFOX_ERROR_CODE for this function : SFX_ERR_NONE and SFX_ERR_API_OPEN_xx
 *
 *******************************************************************/
sfx_error_t SIGFOX_API_open(sfx_rc_t* rc);
 
/*!******************************************************************
 * \fn sfx_error_t SIGFOX_API_close(void)
 * \brief This function closes the library (Free the allocated memory
 * of SIGFOX_API_open and close RF)
 *
 * \retval  The sfx_error_t is composed of the following :
 *
 *    MSB_____________________________________________LSB
 *    15                      8|7                     0
 *     |                       |                      |
 *     |   MANUF_ERROR_CODE    |  SIGFOX_ERROR_CODE   |
 *     |_______________________|______________________|
 *
 *  SIGFOX_ERROR_CODE for this function : SFX_ERR_NONE and SFX_ERR_API_CLOSE_xx
 *
 *******************************************************************/
sfx_error_t SIGFOX_API_close(void);
 
/*!******************************************************************
 * \fn sfx_error_t SIGFOX_API_send_frame(sfx_u8 *customer_data, sfx_u8 customer_data_length, sfx_u8 *customer_response, sfx_u8 tx_mode, sfx_bool initiate_downlink_flag)
 * \brief Send a standard SIGFOX frame with customer payload. Customer
 * payload cannot exceed 12 Bytes.<BR>
 *  - In downlink :
 *      * Send uplink frames
 *      * Receive downlink frame
 *      * Send out of band frame (Voltage, temperature and RSSI)
 *      .
 *  - In uplink :
 *      * Send uplink frames
 *      .
 * \param[in] sfx_u8 *customer_data               Data to transmit
 * \param[in] sfx_u8 customer_data_length         Data length in Bytes
 * \param[out] sfx_u8 *customer_response          Returned 8 Bytes data in case of downlink
 * \param[in] sfx_u8 tx_mode                      tx_mode shall be set to 2.
 * \param[in] sfx_bool initiate_downlink_flag     Flag to initiate a downlink response
 *
 * \retval  The sfx_error_t is composed of the following :
 *
 *    MSB_____________________________________________LSB
 *    15                      8|7                     0
 *     |                       |                      |
 *     |   MANUF_ERROR_CODE    |  SIGFOX_ERROR_CODE   |
 *     |_______________________|______________________|
 *
 *  SIGFOX_ERROR_CODE for this function : SFX_ERR_NONE and SFX_ERR_API_SEND_FRAME_xx  or  SFX_ERR_INT_xx
 *
 *******************************************************************/
sfx_error_t SIGFOX_API_send_frame(sfx_u8* customer_data,
                                  sfx_u8 customer_data_length,
                                  sfx_u8* customer_response,
                                  sfx_u8 tx_mode,
                                  sfx_bool initiate_downlink_flag);
 
/*!******************************************************************
 * \fn sfx_error_t SIGFOX_API_send_bit(sfx_bool bit_value, sfx_u8 *customer_response, sfx_u8 tx_mode, sfx_bool initiate_downlink_flag)
 * \brief Send a standard SIGFOX frame with null customer payload.
 * This frame is the shortest that SIGFOX library can generate.
 * Data is contained on 1 sfx_bool
 *  - In downlink :
 *      * Send uplink frames
 *      * Receive downlink frame
 *      * Send out of band frame (Voltage, temperature and RSSI)
 *      .
 *  - In uplink :
 *      * Send uplink frames
 *      .
 *  .
 *
 * \param[in] sfx_bool bit_value                Bit state (SFX_TRUE or SFX_FALSE)
 * \param[out] sfx_u8 *customer_response        Returned 8 Bytes data in case of downlink
 * \param[in] sfx_u8 tx_mode                    tx_mode shall be set to 2.
 * \param[in] sfx_bool initiate_downlink_flag   Flag to initiate a downlink response
 *
 * \retval  The sfx_error_t is composed of the following :
 *
 *    MSB_____________________________________________LSB
 *    15                      8|7                     0
 *     |                       |                      |
 *     |   MANUF_ERROR_CODE    |  SIGFOX_ERROR_CODE   |
 *     |_______________________|______________________|
 *
 *  SIGFOX_ERROR_CODE for this function : SFX_ERR_NONE and SFX_ERR_API_SEND_BIT_xx  or  SFX_ERR_INT_xx
 *
 *******************************************************************/
sfx_error_t SIGFOX_API_send_bit(sfx_bool bit_value,
                                sfx_u8* customer_response,
                                sfx_u8 tx_mode,
                                sfx_bool initiate_downlink_flag);
 
/*!******************************************************************
 * \fn sfx_error_t SIGFOX_API_send_outofband(sfx_oob_enum_t oob_type)
 * \brief Send an out of band SIGFOX frame which the type is passed as parameter
 * of the function.<BR>
 * Data is composed of information about the chip itself (Voltage,
 * Temperature).<BR>
 *  - In uplink :
 *      * Send uplink frames (3)
 *  .
 * This function must be called by application every 24 hours maximum
 * or never if application has some energy critical constraints with
 * the SFX_OOB_SERVICE enum value
 *
 * If Payload encryption is supported and activated, the user can
 * synchronize the device and the backend with sending SFX_OOB_RC_SYNC
 *
 * In case REPEATER feature is present, the enum SFX_OOB_REPEATER_STATUS
 * can be sent. This frame contains the counters related to the repeater operations.
 * The counters are part of a shared memory between the Application
 * and the Sigfox Library.
 **.
 *
 * \param[in] sfx_oob_enum_t oob_type    Type of the OOB frame to send
 *
 * \retval  The sfx_error_t is composed of the following :
 *
 *    MSB_____________________________________________LSB
 *    15                      8|7                     0
 *     |                       |                      |
 *     |   MANUF_ERROR_CODE    |  SIGFOX_ERROR_CODE   |
 *     |_______________________|______________________|
 *
 *  SIGFOX_ERROR_CODE for this function : SFX_ERR_NONE and SFX_ERR_INT_xx
 *
 *******************************************************************/
sfx_error_t SIGFOX_API_send_outofband(sfx_oob_enum_t oob_type);
 
/*!******************************************************************
 * \fn sfx_error_t SIGFOX_API_set_std_config(sfx_u32 config_words[3], sfx_bool timer_enable)
 * \brief This function must be used to configure specific variables for standard.
 *        It is mandatory to call this function after SIGFOX_API_open() for FH and LBT.
 *
 * <B> FH (Frequency Hopping )</B>: config words to enable/disable 192KHz macro channels authorized for
 * transmission.<BR>Each macro channel is separated from another of 300 kHz<BR>
 * At least 9 macro channel must be enabled to ensure the
 * minimum of 50 FCC channels (9*6 = 54).<BR>
 * <B>WARNING : This function should be called each time you open the library
 * or your FCC configuration will not be applied</B><BR>
 *
 * Use the RC defined above to configure the macro channels
 *
 * <B>The example below shows you the Long Message configuration
 * <B>Example :</B> To enable Macro channel 1 to 9, that is to say 902.2MHz
 * to 904.6MHz with 902.2MHz as main Macro channel, you must set :<BR>
 * <B>config_words[0]</B> = [0x000001FF]<BR>
 * <B>config_words[1]</B> = [0x00000000]<BR>
 * <B>config_words[2]</B> = [0x00000000]<BR>
 *
 * \verbatim
 * Macro Channel Value MHz : | 902.2MHz | 902.5MHz | 902.8MHz | 903.1MHz | 903.4MHz | 903.7MHz | 904.0MHz | 904.3MHz | 904.6MHz | 904.9MHz | 905.2MHz | ...     ...      | 911.5MHz |
 * Macro Channel Value     : | Chn 1    | Chn 2    | Chn 3    | Chn 4    | Chn 5    | Chn 6    | Chn 7    | Chn 8    | Chn 9    | Chn 10   | Chn 11   | ...     ...      | Chn 32   |
 * config_words[0] bit     : | bit 0    | bit 1    | bit 2    | bit 3    | bit 4    | bit 5    | bit 6    | bit 7    | bit 8    | bit 9    | bit 10   | ...     ...      | bit 31   |
 *
 * Macro Channel Value MHz : | 911.8MHz | 912.1MHz | 912.4MHz | 912.7MHz | 913.0MHz | 913.3MHz | 913.6MHz | 913.9MHz | 914.2MHz | 914.5MHz | 914.8MHz | ...     ...      | 921.1MHz |
 * Macro Channel Value     : | Chn 33   | Chn 34   | Chn 35   | Chn 36   | Chn 37   | Chn 38   | Chn 39   | Chn 40   | Chn 41   | Chn 42   | Chn 43   | ...     ...      | Chn 64   |
 * config_words[1] bit     : | bit 0    | bit 1    | bit 2    | bit 3    | bit 4    | bit 5    | bit 6    | bit 7    | bit 8    | bit 9    | bit 10   | ...     ...      | bit 31   |
 *
 * Macro Channel Value MHz : | 921.4MHz | 921.7MHz | 922.0MHz | 922.3MHz | 922.6MHz | 922.9MHz | 923.2MHz | 923.5MHz | 923.8MHz | 924.1MHz | 924.4MHz | ... | 927.7MHz |
 * Macro Channel Value     : | Chn 65   | Chn 66   | Chn 67   | Chn 68   | Chn 69   | Chn 70   | Chn 71   | Chn 72   | Chn 73   | Chn 74   | Chn 75   | ... | Chn 86   |
 * config_words[2] bit     : | bit 0    | bit 1    | bit 2    | bit 3    | bit 4    | bit 5    | bit 6    | bit 7    | bit 8    | bit 9    | bit 10   | ... | bit 21   |
 * \endverbatim
 *
 * <B>DC (Duty Cycle)</B>: This function has no effect in DC spectrum access ( used for the ETSI standard ).</B><BR>
 *
 * <B>LBT (Listen Before Talk)</B> : Carrier Sense feature for the First frame can be configured.
 *           - config_word[0] : number of attempts to send the first frame [ has to be greater or equal to 1]
 *           - config_word[1] : maximum carrier sense sliding window (in ms) [ has to be greater than 6 ms ( CS_MIN_DURATION_IN_MS + 1 ) ]
 *           - config_word[2] :
 *                  . bit 8   : set the value to 1 to indicate that the device will use the full operationnal radio band.( 192kHz )
 *                  . bit 7-3 : number of Carrier Sense attempts.
 *                  . bit 2-0 : number of frames sent.
 *           - timer_enable : unused
 * <BR><BR>
 * The delay between several attempts of Carrier Sense for the first frame is set by SFX_DLY_CS_SLEEP
 *
 * \param[in] sfx_u32 config_words[3]           Meaning depends on the standard (as explained above)
 * \param[in] sfx_bool timer_enable             Enable timer feature for FH
 *
 * \retval  The sfx_error_t is composed of the following :
 *
 *    MSB_____________________________________________LSB
 *    15                      8|7                     0
 *     |                       |                      |
 *     |   MANUF_ERROR_CODE    |  SIGFOX_ERROR_CODE   |
 *     |_______________________|______________________|
 *
 *  SIGFOX_ERROR_CODE for this function : SFX_ERR_NONE and SFX_ERR_API_SET_CONFIG_xx
 *
 *******************************************************************/
sfx_error_t SIGFOX_API_set_std_config(sfx_u32 config_words[3],
                                      sfx_bool timer_enable);
 
/*!******************************************************************
 * \fn sfx_error_t SIGFOX_API_start_continuous_transmission(sfx_u32 frequency, sfx_modulation_type_t type);
 * \brief Executes a continuous wave or modulation depending on the parameter type
 *        SIGFOX_API_stop_continuous_transmission has to be called to stop the continuous transmission.
 *
 * \param[in] sfx_u32 frequency                Frequency at which the signal has to be generated
 * \param[in] sfx_modulation_type_t type       Type of modulation to use in continuous mode.
 *
 * \retval  The sfx_error_t is composed of the following :
 *
 *    MSB_____________________________________________LSB
 *    15                      8|7                     0
 *     |                       |                      |
 *     |   MANUF_ERROR_CODE    |  SIGFOX_ERROR_CODE   |
 *     |_______________________|______________________|
 *
 *  SIGFOX_ERROR_CODE for this function : SFX_ERR_API_START_CONTINUOUS_TRANSMISSION_xx
 *******************************************************************/
sfx_error_t SIGFOX_API_start_continuous_transmission(sfx_u32 frequency, sfx_modulation_type_t type);
 
/*!******************************************************************
 * \fn sfx_error_t SIGFOX_API_stop_continuous_transmission(void);
 * \brief Stop the current continuous transmission
 *
 * \retval  The sfx_error_t is composed of the following :
 *
 *    MSB_____________________________________________LSB
 *    15                      8|7                     0
 *     |                       |                      |
 *     |   MANUF_ERROR_CODE    |  SIGFOX_ERROR_CODE   |
 *     |_______________________|______________________|
 *
 *  SIGFOX_ERROR_CODE for this function : SFX_ERR_API_STOP_CONTINUOUS_TRANSMISSION_xx
 *******************************************************************/
sfx_error_t SIGFOX_API_stop_continuous_transmission(void);
 
/*!******************************************************************
 * \fn sfx_error_t SIGFOX_API_send_test_frame(sfx_u32 frequency, sfx_u8 * customer_data, sfx_u8 customer_data_length, sfx_bool initiate_downlink_flag )
 * Send only 1 repetition
 *
 * \brief This function builds a Sigfox Frame with the customer payload and send it at a specific frequency
 *        Use this function ONLY with Certification ID ( 0xFEDCBA98 ) otherwise an issue occurs.
 *
 *
 * \param[in] sfx_u32 frequency                 Frequency at which the wave is generated
 * \param[in] sfx_u8 *customer_data             Data to transmit
 * \param[in] sfx_u8 customer_data_length       Data length in Bytes
 * \param[in] sfx_bool initiate_downlink_flag   Flag to initiate a downlink response
 *
 *    MSB_____________________________________________LSB
 *    15                      8|7                     0
 *     |                       |                      |
 *     |   MANUF_ERROR_CODE    |  SIGFOX_ERROR_CODE   |
 *     |_______________________|______________________|
 *
 *  SIGFOX_ERROR_CODE for this function : SFX_ERR_API_SEND_TEST_FRAME_xx
 *******************************************************************/
sfx_error_t SIGFOX_API_send_test_frame(sfx_u32 frequency, sfx_u8* customer_data, sfx_u8 customer_data_length, sfx_bool initiate_downlink_flag);
 
/*!******************************************************************
 * \fn sfx_error_t SIGFOX_API_receive_test_frame( sfx_u32 frequency, sfx_authentication_mode_t mode, sfx_u8 * buffer, sfx_u8 timeout, sfx_s16 * rssi  );
 *
 * \brief This function waits for a valid downlink frame during timeout time and return in customer_data the data received.
 *        Use this function ONLY with Certification ID ( 0xFEDCBA98 ) otherwise an issue occurs.
 *
 *
 * \param[in] sfx_u32 frequency                 Frequency at which the wave is generated
 * \param[in] sfx_authentication_mode_t         Mode ( AUTHENTICATION_ON or AUTHENTICATION_OFF)
 * \param[in/out] buffer                        Depends of the Authentication mode :
 *                                               - if AUTHENTICATION_OFF : buffer is used as input to check the bit stream of the received frame
 *                                               - if AUTHENTICATION_ON  : buffer is used as output to get the received Payload
 * \param[in] sfx_u8 timeout                    Timeout for the reception of a valid downlink frame
 * \param[in] sfx_s16 * rssi                    RSSI of the received frame ( only valid for AUTHENTICATION_ON as in AUTHENTICATION_OFF, the rssi of the frames received
 *                                              are returned through the MCU_API_report_test_result function)
 *
 *    MSB_____________________________________________LSB
 *    15                      8|7                     0
 *     |                       |                      |
 *     |   MANUF_ERROR_CODE    |  SIGFOX_ERROR_CODE   |
 *     |_______________________|______________________|
 *
 *  SIGFOX_ERROR_CODE for this function : SFX_ERR_NONE and SFX_ERR_API_RECEIVE_TEST_FRAME_xx
 *******************************************************************/
sfx_error_t SIGFOX_API_receive_test_frame(sfx_u32 frequency, sfx_authentication_mode_t mode, sfx_u8* buffer, sfx_u8 timeout, sfx_s16* rssi);
 
/*!******************************************************************
 * \fn sfx_error_t SIGFOX_API_get_version(sfx_u8 **version, sfx_u8 *size, sfx_version_type_t type)
 * \brief Returns current SIGFOX library version, or RF Version, or MCU version etc ..., in ASCII format ( depending on the type )
 *
 * \param[out] sfx_u8 **version                 Pointer to Byte array (ASCII format) containing library version
 * \param[out] sfx_u8 *size                     Size of the byte array pointed by *version
 * \param[in]  sfx_version_type_t type          Type of the version ( MCU, RF, ... )
 *
 * \retval  The sfx_error_t is composed of the following :
 *
 *    MSB_____________________________________________LSB
 *    15                      8|7                     0
 *     |                       |                      |
 *     |   MANUF_ERROR_CODE    |  SIGFOX_ERROR_CODE   |
 *     |_______________________|______________________|
 *
 *  SIGFOX_ERROR_CODE for this function : SFX_ERR_NONE and  SFX_ERR_API_GET_VERSION_xx
 *******************************************************************/
sfx_error_t SIGFOX_API_get_version(sfx_u8** version, sfx_u8* size, sfx_version_type_t type);
 
/*!******************************************************************
 * \fn sfx_error_t SIGFOX_API_get_info(sfx_u8* returned_info);
 * \brief This function is to return info on send frame depending on
 * the mode you're using.<BR>
 * <B> In DC and FH :</B> returned_info is always 0.<BR>
 * <B> In LBT :</B> returned_info = bit[7-3]: Carrier Sense attempts
 * and bit[2-0]: Number of frames sent
 *
 * \param[out] sfx_u8* returned_info            Returned value by library
 *
 * \retval  The sfx_error_t is composed of the following :
 *
 *    MSB_____________________________________________LSB
 *    15                      8|7                     0
 *     |                       |                      |
 *     |   MANUF_ERROR_CODE    |  SIGFOX_ERROR_CODE   |
 *     |_______________________|______________________|
 *
 *  SIGFOX_ERROR_CODE for this function : SFX_ERR_NONE
 *
 *******************************************************************/
sfx_error_t SIGFOX_API_get_info(sfx_u8* returned_info);
 
/*!******************************************************************
 * \fn sfx_error_t SIGFOX_API_get_device_id(sfx_u8 *dev_id)
 * \brief This function copies the ID of the device to the pointer given in parameter.
 * The ID is \link ID_LENGTH \endlink bytes length and is in binary format.
 *
 * \param[in] none
 * \param[out] sfx_u8* dev_id                   Pointer where to write the device ID
 *
 * \retval  The sfx_error_t is composed of the following :
 *
 *    MSB_____________________________________________LSB
 *    15                      8|7                     0
 *     |                       |                      |
 *     |   MANUF_ERROR_CODE    |  SIGFOX_ERROR_CODE   |
 *     |_______________________|______________________|
 *
 *  SIGFOX_ERROR_CODE for this function : SFX_ERR_NONE or SFX_ERR_API_GET_DEVICE_ID_xx
 *
 *******************************************************************/
sfx_error_t SIGFOX_API_get_device_id(sfx_u8* dev_id);
 
/*!******************************************************************
 * \fn sfx_error_t SIGFOX_API_get_initial_pac(sfx_u8 *initial_pac);
 * \brief Get the value of the PAC stored in the device. This value is
 * used when the device is registered for the first time on the backend.
 *
 * \param[in] none
 * \param[out] sfx_u8* initial_pac              Pointer to initial PAC
 *
 * \retval  The sfx_error_t is composed of the following :
 *
 *    MSB_____________________________________________LSB
 *    15                      8|7                     0
 *     |                       |                      |
 *     |   MANUF_ERROR_CODE    |  SIGFOX_ERROR_CODE   |
 *     |_______________________|______________________|
 *
 *  SIGFOX_ERROR_CODE for this function : SFX_ERR_NONE or SFX_ERR_API_GET_INITIAL_PAC_xx
 *
 *******************************************************************/
sfx_error_t SIGFOX_API_get_initial_pac(sfx_u8* initial_pac);
 
/*!******************************************************************
 * \fn sfx_error_t SIGFOX_API_switch_public_key(sfx_bool use_public_key)
 * \brief Switch device on public or private key.
 *
 * \param[in] sfx_bool use_public_key        Switch to public key if SFX_TRUE, private key else
 *
 *    MSB_____________________________________________LSB
 *    15                      8|7                     0
 *     |                       |                      |
 *     |   MANUF_ERROR_CODE    |  SIGFOX_ERROR_CODE   |
 *     |_______________________|______________________|
 *
 *  SIGFOX_ERROR_CODE for this function : SFX_ERR_NONE or SFX_ERR_API_SWITCH_PUBLIC_KEY_xx
 *
 *******************************************************************/
sfx_error_t SIGFOX_API_switch_public_key(sfx_bool use_public_key);
 
/*!******************************************************************
 * \fn sfx_error_t SIGFOX_API_set_rc_sync_period(sfx_u16 rc_sync_period)
 * \brief Set the period for transmission of RC Sync frame
 * By default, when payload is encrypted, a RC Sync frame is transmitted by the device
 * every 4096 messages transmissions (ie. when the sequence number loops to 0) to
 * 're-synchronize' the device with the backend (from a payload encryption point of view).
 * This transmission period could be reduced through this function. Then, a RC Sync frame
 * will be transmitted every 'rc_sync_period' transmissions of a 'normal' frame.
 * The value 0 corresponds to the default behavior, ie a RC Sync frame transmitted every
 * 4096 messages transmissions.
 * As sequence number is on 12 bits, setting a rc_sync_period with a value more than (4095 - 1)
 * will return an error.
 *
 * \param[in] sfx_u16 rollover_counter_period    Transmission period of the RC Sync frame (in number of 'normal' frames)
 *
 *    MSB_____________________________________________LSB
 *    15                      8|7                     0
 *     |                       |                      |
 *     |   MANUF_ERROR_CODE    |  SIGFOX_ERROR_CODE   |
 *     |_______________________|______________________|
 *
 *  SIGFOX_ERROR_CODE for this function : SFX_ERR_NONE or SFX_ERR_API_SET_RC_SYNC_PERIOD_xx
 *
 *******************************************************************/
sfx_error_t SIGFOX_API_set_rc_sync_period(sfx_u16 rc_sync_period);
 
#endif