KETCube
Macros | Variables
ketCube_moduleList.c File Reference

This file contains the KETCube module list. More...

#include <stddef.h>
#include "ketCube_cfg.h"
#include "ketCube_coreCfg.h"
#include "ketCube_common.h"
#include "ketCube_module_id.h"
#include "hw_msp.h"
#include "ketCube_lora.h"
#include "ketCube_i2c.h"
#include "ketCube_hdcX080.h"
#include "ketCube_batMeas.h"
#include "ketCube_adc.h"
#include "ketCube_starNet.h"
#include "ketCube_rxDisplay.h"
#include "ketCube_asyncTx.h"
#include "ketCube_txDisplay.h"
#include "ketCube_ics43432.h"
#include "ketCube_bmeX80.h"
#include "ketCube_lis2hh12.h"
#include "ketCube_testRadio.h"
#include "ketCube_uart2WAN.h"

Macros

#define DEF_MODULE(name, descr, moduleId, initFn, sleepEnter, sleepExit, getSensData, sendData, recvData, processData, cfgStruct)
 

Variables

ketCube_cfg_Module_t ketCube_modules_List [ketCube_modules_CNT]
 List of KETCube modules. More...
 

Detailed Description

This file contains the KETCube module list.

Author
Jan Belohoubek
Version
0.2
Date
2018-10-31
Attention

© Copyright (c) 2018 University of West Bohemia in Pilsen All rights reserved.

Developed by: The SmartCampus Team Department of Technologies and Measurement www.smartcampus.cz | www.zcu.cz

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal with the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE SOFTWARE.

Macro Definition Documentation

◆ DEF_MODULE

#define DEF_MODULE (   name,
  descr,
  moduleId,
  initFn,
  sleepEnter,
  sleepExit,
  getSensData,
  sendData,
  recvData,
  processData,
  cfgStruct 
)
Value:
{ \
((char*) &(name)),\
((char*) &(descr)), \
moduleId, \
(ketCube_cfg_ModVoidFn_t) (sleepEnter), \
(ketCube_cfg_ModVoidFn_t) (sleepExit), \
(ketCube_cfg_ModDataFn_t) (getSensData), \
(ketCube_cfg_ModDataFn_t) (sendData), \
(ketCube_cfg_ModVoidFn_t) (recvData), \
(ketCube_cfg_ModDataPtrFn_t) (processData), \
(ketCube_cfg_ModuleCfgByte_t *) &(cfgStruct), \
(ketCube_cfg_LenEEPROM_t) sizeof(cfgStruct), \
}

Define a KETCube module

Parameters
namemodule name
descrhuman-readable module description
moduleIdpersistent module ID
initFnmodule initialization function pointer
sleepEntermodule sleep-enter function pointer
sleepExitmodule sleep-exit function pointer
getSensDatagetSensorData() module function - for sensing modules
sendDatasendData() module function - for communication modules
recvsDatarecv() module function - for communication modules
processDataprocessData() callback function for inter-module messages
cfgStructname of the module configuration-holding structure
ketCube_cfg_ModDataPtrFn_t
ketCube_cfg_ModError_t(* ketCube_cfg_ModDataPtrFn_t)(ketCube_InterModMsg_t *msg)
Definition: ketCube_cfg.h:142
ketCube_cfg_ModuleCfgByte_t
KETCube module configuration byte.
Definition: ketCube_cfg.h:147
ketCube_cfg_ModInitFn_t
ketCube_cfg_ModError_t(* ketCube_cfg_ModInitFn_t)(ketCube_InterModMsg_t ***msg)
Definition: ketCube_cfg.h:139
ketCube_cfg_ModDataFn_t
ketCube_cfg_ModError_t(* ketCube_cfg_ModDataFn_t)(uint8_t *buffer, uint8_t *len)
Definition: ketCube_cfg.h:141
ketCube_cfg_AllocEEPROM_t
ketCube_cfg_AllocEEPROM_t
Allocated CFG EEPROM addreses.
Definition: ketCube_cfg.h:68
ketCube_cfg_LenEEPROM_t
ketCube_cfg_LenEEPROM_t
Length of CFG EEPROM data.
Definition: ketCube_cfg.h:80
ketCube_cfg_ModVoidFn_t
ketCube_cfg_ModError_t(* ketCube_cfg_ModVoidFn_t)(void)
Pointer to function returning ketCube_cfg_ModError_t.
Definition: ketCube_cfg.h:137