Sigfox End-Point Type Approval addon (EP_ADDON_TA)

Description

The Sigfox End-Point Type Approval addon provides utility functions to pass regulatory certifications with the new Sigfox end point library.

The table below shows the versions compatibility between this addon and the Sigfox End-Point library.

EP_ADDON_TA	EP_LIB
v2.0	>= v4.0
v1.1	v3.5 to v3.6
v1.0	v3.4

The application is divided into three modes detailed thereafter.

Continuous wave (CW)

After implementing the corresponding RF_API functions, this mode generates a continuous wave (modulated or not) which can be used for output power measurement and TX spurious tests.

Continuous Sigfox uplink (CSUL)

This mode continuously sends a configurable number of Sigfox uplink frames. In the particular case of FCC certification in RC2 and RC4 zones, the SIGFOX_EP_ADDON_TA_API_FH_MODE_ALL_MACRO_CHANNELS option (equivalent to the LONG_MESSAGE configuration of the old Sigfox library) is helpful to send Sigfox messages in all FCC macro channels and perform the related tests.

Continuous Sigfox downlink (CSDL)

This mode puts the device in continuous reception mode with configurable timeout, in order to perform RX spurious tests and resiliency tests.

Stack architecture

Compilation flags for optimization

This addon inherits all the Sigfox End-Point library flags and can be optimized accordingly.

The SIGFOX_EP_CERTIFICATION flag must be enabled to use this addon.

How to add Sigfox Type Approval addon to your project

Dependencies

The only dependency of this addon is the Sigfox End-Point library source code.

Submodule

The best way to embed the Sigfox End-Point Type Approval addon into your project is to use a Git submodule, in a similar way to the library. The addon will be seen as a sub-repository with independant history. It will be much easier to upgrade the addon or to switch between versions when necessary, by using the common git pull and git checkout commands within the sigfox-ep-addon-ta folder.

To add the Sigfox type approval addon submodule, go to your project location and run the following commands:

mkdir lib
cd lib/
git submodule add https://github.com/sigfox-tech-radio/sigfox-ep-addon-ta.git

This will clone the Sigfox End-Point Type Approval addon repository. At project level, you can commit the submodule creation with the following commands:

git commit --message "Add Sigfox End Point Type Approval addon submodule."
git push

With the submodule, you can easily:

• Update the addon to the latest version:

cd lib/sigfox-ep-addon-ta/
git pull
git checkout master

• Use a specific release:

cd lib/sigfox-ep-addon-ta/
git pull
git checkout <tag>

Raw source code

You can download or clone any release of the Sigfox End-Point Type Approval addon and copy all files into your project.

git clone https://github.com/sigfox-tech-radio/sigfox-ep-addon-ta.git

Precompiled source code

You can download or clone any release of the Sigfox End-Point Type Approval addon and copy all files into your project. If you do not plan to change your compilation flags in the future, you can perform a precompilation step before copying the file in your project. The precompilation will remove all preprocessor directives according to your flags selection, in order to produce a more readable code. Then you can copy the new files into your project.

git clone https://github.com/sigfox-tech-radio/sigfox-ep-addon-ta.git

To perform the precompilation, you have to install cmake and unifdef tools, and run the following commands:

cd sigfox-ep-addon-ta/
mkdir build
cd build/

cmake -DSIGFOX_EP_LIB_DIR=<sigfox-ep-lib path> \
      -DSIGFOX_EP_RC1_ZONE=ON \
      -DSIGFOX_EP_RC2_ZONE=ON \
      -DSIGFOX_EP_RC3_LBT_ZONE=ON \
      -DSIGFOX_EP_RC3_LDC_ZONE=ON \
      -DSIGFOX_EP_RC4_ZONE=ON \
      -DSIGFOX_EP_RC5_ZONE=ON \
      -DSIGFOX_EP_RC6_ZONE=ON \
      -DSIGFOX_EP_RC7_ZONE=ON \
      -DSIGFOX_EP_APPLICATION_MESSAGES=ON \
      -DSIGFOX_EP_CONTROL_KEEP_ALIVE_MESSAGE=ON \
      -DSIGFOX_EP_BIDIRECTIONAL=ON \
      -DSIGFOX_EP_ASYNCHRONOUS=ON \
      -DSIGFOX_EP_LOW_LEVEL_OPEN_CLOSE=ON \
      -DSIGFOX_EP_REGULATORY=ON \
      -DSIGFOX_EP_LATENCY_COMPENSATION=ON \
      -DSIGFOX_EP_SINGLE_FRAME=ON \
      -DSIGFOX_EP_UL_BIT_RATE_BPS=OFF \
      -DSIGFOX_EP_TX_POWER_DBM_EIRP=OFF \
      -DSIGFOX_EP_T_IFU_MS=OFF \
      -DSIGFOX_EP_T_CONF_MS=OFF \
      -DSIGFOX_EP_UL_PAYLOAD_SIZE=OFF \
      -DSIGFOX_EP_AES_HW=ON \
      -DSIGFOX_EP_CRC_HW=OFF \
      -DSIGFOX_EP_MESSAGE_COUNTER_ROLLOVER=OFF \
      -DSIGFOX_EP_PARAMETERS_CHECK=ON \
      -DSIGFOX_EP_CERTIFICATION=ON \
      -DSIGFOX_EP_PUBLIC_KEY_CAPABLE=ON \
      -DSIGFOX_EP_VERBOSE=ON \
      -DSIGFOX_EP_ERROR_CODES=ON \
      -DSIGFOX_EP_ERROR_STACK=12 ..

make precompil_sigfox_ep_addon_ta

The new files will be generated in the build/precompil folder.

Static library

You can also download or clone any release of the Sigfox End-Point Type Approval addon and build a static library.

git clone https://github.com/sigfox-tech-radio/sigfox-ep-addon-ta.git

To build a static library, you have to install cmake tool and run the following commands:

cd sigfox-ep-addon-ta/
mkdir build
cd build/

cmake -DSIGFOX_EP_LIB_DIR=<sigfox-ep-lib path> \
      -DSIGFOX_EP_RC1_ZONE=ON \
      -DSIGFOX_EP_RC2_ZONE=ON \
      -DSIGFOX_EP_RC3_LBT_ZONE=ON \
      -DSIGFOX_EP_RC3_LDC_ZONE=ON \
      -DSIGFOX_EP_RC4_ZONE=ON \
      -DSIGFOX_EP_RC5_ZONE=ON \
      -DSIGFOX_EP_RC6_ZONE=ON \
      -DSIGFOX_EP_RC7_ZONE=ON \
      -DSIGFOX_EP_APPLICATION_MESSAGES=ON \
      -DSIGFOX_EP_CONTROL_KEEP_ALIVE_MESSAGE=ON \
      -DSIGFOX_EP_BIDIRECTIONAL=ON \
      -DSIGFOX_EP_ASYNCHRONOUS=ON \
      -DSIGFOX_EP_LOW_LEVEL_OPEN_CLOSE=ON \
      -DSIGFOX_EP_REGULATORY=ON \
      -DSIGFOX_EP_LATENCY_COMPENSATION=ON \
      -DSIGFOX_EP_SINGLE_FRAME=ON \
      -DSIGFOX_EP_UL_BIT_RATE_BPS=OFF \
      -DSIGFOX_EP_TX_POWER_DBM_EIRP=OFF \
      -DSIGFOX_EP_T_IFU_MS=OFF \
      -DSIGFOX_EP_T_CONF_MS=OFF \
      -DSIGFOX_EP_UL_PAYLOAD_SIZE=OFF \
      -DSIGFOX_EP_AES_HW=ON \
      -DSIGFOX_EP_CRC_HW=OFF \
      -DSIGFOX_EP_MESSAGE_COUNTER_ROLLOVER=OFF \
      -DSIGFOX_EP_PARAMETERS_CHECK=ON \
      -DSIGFOX_EP_CERTIFICATION=ON \
      -DSIGFOX_EP_PUBLIC_KEY_CAPABLE=ON \
      -DSIGFOX_EP_VERBOSE=ON \
      -DSIGFOX_EP_ERROR_CODES=ON \
      -DSIGFOX_EP_ERROR_STACK=12 ..

make sigfox_ep_addon_ta

The archive will be generated in the build/lib folder.