ketCube_cfg_Module_t Struct Reference

KETCube module definition. More...

#include <ketCube_cfg.h>

Data Fields
char *	name
char *	descr
ketCube_moduleID_t	id
ketCube_cfg_ModInitFn_t	fnInit
ketCube_cfg_ModVoidFn_t	fnSleepEnter
ketCube_cfg_ModVoidFn_t	fnSleepExit
ketCube_cfg_ModDataFn_t	fnGetSensorData
ketCube_cfg_ModDataFn_t	fnSendData
ketCube_cfg_ModVoidFn_t	fnReceiveData
ketCube_cfg_ModDataPtrFn_t	fnProcessMsg
ketCube_cfg_ModuleCfgByte_t *	cfgPtr
ketCube_cfg_LenEEPROM_t	cfgLen
ketCube_cfg_AllocEEPROM_t	EEpromBase

Detailed Description

KETCube module definition.

Field Documentation

cfgLen

ketCube_cfg_LenEEPROM_t ketCube_cfg_Module_t::cfgLen

of module configuration bytes: min = 1; max = 255; note that the first configuration byte is always set to TRUE when module is enabled and to FALSE when disabled (all bits are cleared)

cfgPtr

ketCube_cfg_ModuleCfgByte_t* ketCube_cfg_Module_t::cfgPtr

Pointer to actual/running KETCube configuration

descr

char* ketCube_cfg_Module_t::descr

Human-readable module description/help

EEpromBase

ketCube_cfg_AllocEEPROM_t ketCube_cfg_Module_t::EEpromBase

EEPROM base for module configuration

fnGetSensorData

ketCube_cfg_ModDataFn_t ketCube_cfg_Module_t::fnGetSensorData

Module function to get module data into buffer (sensors)

fnInit

ketCube_cfg_ModInitFn_t ketCube_cfg_Module_t::fnInit

Module init function

fnProcessMsg

ketCube_cfg_ModDataPtrFn_t ketCube_cfg_Module_t::fnProcessMsg

Module function to process data by this module

fnReceiveData

ketCube_cfg_ModVoidFn_t ketCube_cfg_Module_t::fnReceiveData

Module function to initialize periodic data reception by using communication module

fnSendData

ketCube_cfg_ModDataFn_t ketCube_cfg_Module_t::fnSendData

Module function to send data by communication module (the KETCube system period)

fnSleepEnter

ketCube_cfg_ModVoidFn_t ketCube_cfg_Module_t::fnSleepEnter

DeInitialize module when entering sleep mode

fnSleepExit

ketCube_cfg_ModVoidFn_t ketCube_cfg_Module_t::fnSleepExit

Initialize module when returning from sleep mode

id

ketCube_moduleID_t ketCube_cfg_Module_t::id

Module global unique identifier

name

char* ketCube_cfg_Module_t::name

Module name

---

The documentation for this struct was generated from the following file:

• KETCube/core/ketCube_cfg.h