Skip to content

Latest commit

 

History

History
204 lines (158 loc) · 7.53 KB

README.md

File metadata and controls

204 lines (158 loc) · 7.53 KB
Raw

Sigfox End-Point RF & Protocol addon (EP_ADDON_RFP)

Description

The Sigfox End-Point RF & Protocol addon shows an example of the RF & Protocol test implementation. This addon is an application of the Sigfox End-Point library which offers a new API (provided in the sigfox_ep_addon_rfp_api.h file) to execute Sigfox test modes.

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

EP_ADDON_RFP EP_LIB
v1.5 >= v3.5
v1.4 v3.2 to v3.4
v1.3 v3.2 to v3.4
v1.2 v3.2 to v3.4
v1.1 v3.1
v1.0 v3.0

Stack architecture

Compilation flags for optimization

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

The CERTIFICATION flag must be enabled to use this addon.

How to add Sigfox RF & Protocol 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 RF & Protocol 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-rfp folder.

To add the Sigfox RF & Protocol 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-rfp.git

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

git commit --message "Add Sigfox End Point RF and Protocol addon submodule."
git push

With the submodule, you can easily:

  • Update the addon to the latest version:
cd lib/sigfox-ep-addon-rfp/
git pull
git checkout master
  • Use a specific release:
cd lib/sigfox-ep-addon-rfp/
git pull
git checkout <tag>

Raw source code

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

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

Precompiled source code

You can download or clone any release of the Sigfox End-Point RF & Protocol 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-rfp.git

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

cd sigfox-ep-addon-rfp/
mkdir build
cd build/
  • Precompiling by reading the sigfox_ep_flags.h file:
cmake -DSIGFOX_EP_LIB_DIR=<sigfox-ep-lib path> \
      -DUSE_SIGFOX_EP_FLAGS_H=ON ..
make precompil_sigfox_ep_addon_rfp
  • Precompiling by entering the flags selection on command line:
cmake -DSIGFOX_EP_LIB_DIR=<sigfox-ep-lib path> \
      -DUSE_SIGFOX_EP_FLAGS_H=OFF \
      -DRC1_ZONE=ON \
      -DRC2_ZONE=ON \
      -DRC3C_ZONE=ON \
      -DRC3D_ZONE=ON \
      -DRC4_ZONE=ON \
      -DRC5_ZONE=ON \
      -DRC6_ZONE=ON \
      -DRC7_ZONE=ON \
      -DAPPLICATION_MESSAGES=ON \
      -DCONTROL_KEEP_ALIVE_MESSAGE=ON \
      -DBIDIRECTIONAL=ON \
      -DASYNCHRONOUS=ON \
      -DLOW_LEVEL_OPEN_CLOSE=ON \
      -DREGULATORY=ON \
      -DLATENCY_COMPENSATION=ON \
      -DSINGLE_FRAME=ON \
      -DUL_BIT_RATE_BPS=OFF \
      -DTX_POWER_DBM_EIRP=OFF \
      -DT_IFU_MS=OFF \
      -DT_CONF_MS=OFF \
      -DUL_PAYLOAD_SIZE=OFF \
      -DCRC_HW=OFF \
      -DMESSAGE_COUNTER_ROLLOVER=OFF \
      -DPARAMETERS_CHECK=ON \
      -DCERTIFICATION=ON \
      -DPUBLIC_KEY_CAPABLE=ON \
      -DVERBOSE=ON \
      -DERROR_CODES=ON \
      -DERROR_STACK=12 ..
make precompil_sigfox_ep_addon_rfp

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 RF & Protocol addon and build a static library.

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

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

cd sigfox-ep-addon-rfp/
mkdir build
cd build/
  • Building by reading the sigfox_ep_flags.h file:
cmake -DSIGFOX_EP_LIB_DIR=<sigfox-ep-lib path> \
      -DUSE_SIGFOX_EP_FLAGS_H=ON ..
make sigfox_ep_addon_rfp
  • Building by entering the flags selection on command line:
cmake -DSIGFOX_EP_LIB_DIR=<sigfox-ep-lib path> \
      -DUSE_SIGFOX_EP_FLAGS_H=OFF \
      -DRC1_ZONE=ON \
      -DRC2_ZONE=ON \
      -DRC3C_ZONE=ON \
      -DRC3D_ZONE=ON \
      -DRC4_ZONE=ON \
      -DRC5_ZONE=ON \
      -DRC6_ZONE=ON \
      -DRC7_ZONE=ON \
      -DAPPLICATION_MESSAGES=ON \
      -DCONTROL_KEEP_ALIVE_MESSAGE=ON \
      -DBIDIRECTIONAL=ON \
      -DASYNCHRONOUS=ON \
      -DLOW_LEVEL_OPEN_CLOSE=ON \
      -DREGULATORY=ON \
      -DLATENCY_COMPENSATION=ON \
      -DSINGLE_FRAME=ON \
      -DPARAMETERS_CHECK=ON \
      -DCERTIFICATION=ON \
      -DPUBLIC_KEY_CAPABLE=ON \
      -DVERBOSE=ON \
      -DCRC_HW=OFF \
      -DERROR_CODES=ON \
      -DUL_BIT_RATE_BPS=OFF \
      -DT_IFU_MS=OFF \
      -DT_CONF_MS=OFF \
      -DUL_PAYLOAD_SIZE=OFF \
      -DMESSAGE_COUNTER_ROLLOVER=OFF \
      -DERROR_STACK=12 ..
make sigfox_ep_addon_rfp

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