Skip to content

Preprocessor Configuration

jaenrig-ifx edited this page Nov 5, 2020 · 3 revisions

The src/config sources provides the C-macro level library configuration.

Through defines configuration the different modules of the library are conditionally compiled. Thus, only the code needed is added to the binary. The main selectable parameters are:

  • Hall Speed module. It can be enabled/disabled. When disabled, the Timer module is also discarded.
  • Software Framework. #ifdef/#ifnef guards are added to all source files for the framework specifc sources. Through the #define parameters, the development framework can be selected.

Config Files

The configuration folder includes 3 files:

  • hall-conf-opts.hpp. All the library configuration macro define options.
  • hall-conf.hpp. This is the actual configuration file.
  • hall-conf-dfl.hpp. This is the defult configuration. This file is included (#include) in hall-conf.hpp. If any optional parameter is not defined, then the default value will be set in this file. If any user selectable mandatory configuration is not set, an error will be thrown during compilation, requesting the definition of such parameter.