RAPIDSEA MACROS
Overview
The below macros are used to configure the enable or disable of the modules, protocols, and additional features in the RAPIDSEA code base.
List of Macros
Name of the Macro |
Value |
Description |
|---|---|---|
RS_ENABLE_MODULE_FILTER_MVG_AVG |
0 = Disable, 1 = Enable |
The Filter Moving Average module can be switched active or inactive with this macro. |
RS_ENABLE_MODULE_DISPATCHER |
0 = Disable, 1 = Enable |
The dispatcher module can be switched active or inactive with this macro. |
RS_ENABLE_MODULE_RING_BUFF |
0 = Disable, 1 = Enable |
The Ring Buffer module can be switched active or inactive with this macro. |
RS_ENABLE_MODULE_MSG_QUEUE |
0 = Disable, 1 = Enable |
The Message Queue module can be switched active or inactive with this macro. |
RS_ENABLE_MODULE_FRAMER |
0 = Disable, 1 = Enable |
The Framer module can be switched active or inactive with this macro. |
RS_ENABLE_MODULE_SB_QUEUE |
0 = Disable, 1 = Enable |
The sb module can be switched active or inactive with this macro. |
RS_ENABLE_MODULE_FATFS |
0 = Disable, 1 = Enable |
The fatfs module can be switched active or inactive with this macro. |
RS_ENABLE_MODULE_JSON |
0 = Disable, 1 = Enable |
The json module can be switched active or inactive with this macro. |
RS_ENABLE_MODULE_SYS_CONF |
0 = Disable, 1 = Enable |
The sys configurator module can be switched active or inactive with this macro. |
RS_ENABLE_MODULE_WEBSERVER |
0 = Disable, 1 = Enable |
The webserver module can be switched active or inactive with this macro. |
Name of the Macro |
Value |
Description |
|---|---|---|
RS_ENABLE_PROTOCOL_OBD_SERVER |
0 = Disable, 1 = Enable |
The OBD Server Protocol can be switched active or inactive with this macro. |
RS_ENABLE_PROTOCOL_OBD_CLIENT |
0 = Disable, 1 = Enable |
The OBD Client Protocol can be switched active or inactive with this macro. |
RS_ENABLE_PROTOCOL_UDS_SERVER |
0 = Disable, 1 = Enable |
The UDS Server Protocol can be switched active or inactive with this macro. |
RS_ENABLE_PROTOCOL_UDS_CLIENT |
0 = Disable, 1 = Enable |
The UDS Client Protocol can be switched active or inactive with this macro. |
RS_ENABLE_PROTOCOL_DOIP_SERVER |
0 = Disable, 1 = Enable |
The DOIP Server Protocol can be switched active or inactive with this macro. |
RS_ENABLE_PROTOCOL_DOIP_CLIENT |
0 = Disable, 1 = Enable |
The DOIP Client Protocol can be switched active or inactive with this macro. |
RS_ENABLE_PROTOCOL_MODBUS_SERVER |
0 = Disable, 1 = Enable |
The Modbus Server Protocol can be switched active or inactive with this macro. |
RS_ENABLE_PROTOCOL_MODBUS_CLIENT |
0 = Disable, 1 = Enable |
The Modbus Client Protocol can be switched active or inactive with this macro. |
RS_ENABLE_PROTOCOL_AGENT_SERVER |
0 = Disable, 1 = Enable |
The Agent Server Protocol can be switched active or inactive with this macro. |
RS_ENABLE_PROTOCOL_ANC |
0 = Disable, 1 = Enable |
The ANC can be switched active or inactive with this macro. |
RS_ENABLE_PROTOCOL_DOCAN |
0 = Disable, 1 = Enable |
The DOCAN Protocol can be switched active or inactive with this macro. |
RS_ENABLE_PROTOCOL_BDX |
0 = Disable, 1 = Enable |
The BDX can be switched active or inactive with this macro. |
RS_ENABLE_PROTOCOL_SOMEIP_SERVER |
0 = Disable, 1 = Enable |
The SOMEIP Server Protocol can be switched active or inactive with this macro. |
RS_ENABLE_PROTOCOL_SOMEIP_CLIENT |
0 = Disable, 1 = Enable |
The SOMEIP Client Protocol can be switched active or inactive with this macro. |
RS_ENABLE_PROTOCOL_XCP_SERVER |
0 = Disable, 1 = Enable |
The XCP Server Protocol can be switched active or inactive with this macro. |
Name of the Macro |
Value |
Description |
|---|---|---|
RS_ENABLE_INTERFACE_EEPROM |
0 = Disable, 1 = Enable |
The EEPROM interface can be switched active or inactive with this macro. |
RS_ENABLE_INTERFACE_WDT |
0 = Disable, 1 = Enable |
The WDT interface can be switched active or inactive with this macro. |
RS_ENABLE_INTERFACE_PWM |
0 = Disable, 1 = Enable |
The PWM interface can be switched active or inactive with this macro. |
RS_ENABLE_INTERFACE_FLASH |
0 = Disable, 1 = Enable |
The FLASH interface can be switched active or inactive with this macro. |
RS_ENABLE_INTERFACE_I2C |
0 = Disable, 1 = Enable |
The I2C interface can be switched active or inactive with this macro. |
RS_ENABLE_INTERFACE_SPI |
0 = Disable, 1 = Enable |
The SPI interface can be switched active or inactive with this macro. |
RS_ENABLE_INTERFACE_GPIO |
0 = Disable, 1 = Enable |
The GPIO interface can be switched active or inactive with this macro. |
RS_ENABLE_INTERFACE_UART |
0 = Disable, 1 = Enable |
The UART interface can be switched active or inactive with this macro. |
RS_ENABLE_INTERFACE_RTC |
0 = Disable, 1 = Enable |
The RTC interface can be switched active or inactive with this macro. |
RS_ENABLE_INTERFACE_CAN |
0 = Disable, 1 = Enable |
The CAN interface can be switched active or inactive with this macro. |
RS_ENABLE_INTERFACE_SOCKET |
0 = Disable, 1 = Enable |
The SOCKET interface can be switched active or inactive with this macro. |
RS_ENABLE_INTERFACE_SDCARD |
0 = Disable, 1 = Enable |
The SDCARD interface can be switched active or inactive with this macro. |
Name of the Macro |
Value |
Description |
|---|---|---|
RS_ENABLE_BOOTLOADER |
0 = Disable, 1 = Enable |
The bootloader can be switched active or inactive with this macro. |
Name of the Macro |
Value |
Description |
|---|---|---|
RS_ENABLE_DEVICE_CELLULAR |
0 = Disable, 1 = Enable |
The cellular device can be switched active or inactive with this macro. |
RS_ENABLE_DEVICE_NORFLASH |
0 = Disable, 1 = Enable |
The nor flash device can be switched active or inactive with this macro. |
RS_ENABLE_DEVICE_GRAPHICAL_LCD |
0 = Disable, 1 = Enable |
The graphical lcd device can be switched active or inactive with this macro. |
RS_ENABLE_DEVICE_KEYPAD |
0 = Disable, 1 = Enable |
The keypad device can be switched active or inactive with this macro. |
Name of the Macro |
Value |
Description |
|---|---|---|
RS_ENABLE_MENU_EDITOR |
0 = Disable, 1 = Enable |
The menu editor device manager can be switched active or inactive with this macro. |
RS_ENABLE_STEPPER |
0 = Disable, 1 = Enable |
The stepper driver can be switched active or inactive with this macro. |
RS_ENABLE_LED_MANAGER |
0 = Disable, 1 = Enable |
The led manager can be switched active or inactive with this macro. |
Name of the Macro |
Value |
Description |
|---|---|---|
RS_ENABLE_FORMAT_MDF |
0 = Disable, 1 = Enable |
The MDF format can be switched active or inactive with this macro. |
RS_ENABLE_FORMAT_CSV |
0 = Disable, 1 = Enable |
The CSV format can be switched active or inactive with this macro. |
Name of the Macro |
Value |
Description |
|---|---|---|
RS_ENABLE_VP |
0 = Disable, 1 = Enable |
The Visual Programming feature can be switched active or inactive with this macro. |
RS_ENABLE_FLINT |
0 = Disable, 1 = Enable |
The Flint feature can be switched active or inactive with this macro. |
RS_ENABLE_SPARKLET |
0 = Disable, 1 = Enable |
The Sparklet feature can be switched active or inactive with this macro. |
RS_ENABLE_FLINT_MOD_CONSOLE |
0 = Disable, 1 = Enable |
The flint console module feature can be switched active or inactive with this macro. |
RS_ENABLE_FLINT_MOD_MB_SERVER |
0 = Disable, 1 = Enable |
The flint modbus server module feature can be switched active or inactive with this macro. |
RS_ENABLE_FLINT_MOD_MB_CLIENT |
0 = Disable, 1 = Enable |
The flint modbus client module feature can be switched active or inactive with this macro. |
RS_ENABLE_SYS_CON |
0 = Disable, 1 = Enable |
The system configurator module feature can be switched active or inactive with this macro. |
RS_ENABLE_FLINT_INTERFACE_PWM |
0 = Disable, 1 = Enable |
The flint PWM interface module feature can be switched active or inactive with this macro. |
Configuration Header Details
Documentation from the relevant header as follows:
Warning
doxygenfile: Cannot find file “rs_config.h