CketCube_cfg_Module_t | KETCube module definition |
CketCube_cfg_ModuleCfgByte_t | KETCube module configuration byte |
CketCube_hdc1080_Init_t | HDC1080 Init structure definition |
CketCube_InterModMsg_t | KETCube inter-module message |
CketCube_lora_moduleCfg_t | KETCube lora module configuration byte. Derived from |
CketCube_rxDisplay_Data_t | KETCube rxDisplay data structure |
CketCube_terminal_buffer_t | |
CketCube_terminal_cmd_t | KETCube terminal command definition |
CketCube_UART_descriptor_t | UART descriptor structure |
CketCube_batMeas_battery_t | KETCube battery deffinition |
CketCube_bmeX80_Calib_t | Calibration data structure |
CketCube_cfg_Module_t | KETCube module definition |
CketCube_cfg_ModuleCfgByte_t | KETCube module configuration byte |
CketCube_hdc1080_Init_t | HDC1080 Init structure definition |
CketCube_InterModMsg_t | KETCube inter-module message |
CketCube_lora_moduleCfg_t | KETCube lora module configuration byte. Derived from |
CketCube_rxDisplay_Data_t | KETCube rxDisplay data structure |
CketCube_terminal_buffer_t | |
CketCube_terminal_cmd_t | KETCube terminal command definition |
CketCube_Timer_usage_t | Timer Usage |
CketCube_UART_descriptor_t | UART descriptor structure |
Files | |
file | ketCube_asyncTx.c |
This file contains the KETCube AsyncTx module. | |
file | ketCube_asyncTx.h [code] |
This file contains the KETCube AsyncTx module definitions. | |
file | ketCube_cfg.c |
This file contains the KETCube configuration module. | |
file | ketCube_cfg.h [code] |
This file contains definitions for the KETCube configuration. | |
file | ketCube_common.c |
KETCube common. | |
file | ketCube_common.h [code] |
KETCube common definitions. | |
file | ketCube_starNet.h [code] |
This file contains definitions for the KETCube starNet module. | |
file | ketCube_txDisplay.c |
This file contains the KETCube module txDisplay. | |
file | ketCube_txDisplay.h [code] |
This file contains the KETCube txDisplay module definitions. | |
Files | |
file | ketCube_gpio.c |
This file contains the ketCube GPIO driver. | |
file | ketCube_gpio.h [code] |
This file contains definitions for the ketCube GPIO driver. | |
file | ketCube_i2c.c |
This file contains the ketCube I2C driver. | |
file | ketCube_i2c.h [code] |
This file contains definitions for the ketCube I2C driver. | |
file | ketCube_i2s.c |
This file contains the ketCube I2S driver. | |
file | ketCube_i2s.h [code] |
This file contains definitions for the ketCube I2S driver. | |
file | ketCube_mainBoard.h [code] |
Definitions for KETCube main board. | |
file | ketCube_timer.c |
This file contains the ketCube Timer(s) driver. | |
file | ketCube_timer.h [code] |
This file contains definitions for the ketCube Timer(s) driver. | |
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
+Macros | |
#define | KETCUBE_BMEX80_CHIP_ID_REG 0xD0 |
#define | KETCUBE_BMEX80_CALIB_2_FIRST_REG 0xE1 |
#define | KETCUBE_BMEX80_HUMIDITY_REG 0XFD |
#define | KETCUBE_BMEX80_TEMPERATURE_REG 0XFA |
#define | KETCUBE_BMEX80_PRESSURE_REG 0XF7 |
#define | KETCUBE_BMEX80_CTRL_MEAS_REG 0XF4 |
#define | KETCUBE_BMEX80_STATUS_REG 0XF3 |
#define | KETCUBE_BMEX80_CTRL_HUM_REG 0XF2 |
#define | KETCUBE_BMEX80_CALIB_1_FIRST_REG 0x88 |
#define KETCUBE_BMEX80_CALIB_1_FIRST_REG 0x88 | +
#define KETCUBE_BMEX80_CALIB_2_FIRST_REG 0xE1 | +
#define KETCUBE_BMEX80_CHIP_ID_REG 0xD0 | +
#define KETCUBE_BMEX80_CTRL_HUM_REG 0XF2 | +
#define KETCUBE_BMEX80_CTRL_MEAS_REG 0XF4 | +
#define KETCUBE_BMEX80_HUMIDITY_REG 0XFD | +
#define KETCUBE_BMEX80_PRESSURE_REG 0XF7 | +
#define KETCUBE_BMEX80_STATUS_REG 0XF3 | +
#define KETCUBE_BMEX80_TEMPERATURE_REG 0XFA | +
Reference divider settings for Channel 0.
+ @@ -202,6 +212,8 @@Channel 0 MSB Conversion Result and status.
+ @@ -258,6 +270,8 @@Channel 0 LSB Conversion Result and status.
+ @@ -314,6 +328,8 @@Device ID. For FDC2214: 0x3055.
+ @@ -384,6 +400,8 @@Manufacturer ID. For FDC2214: 0x5449.
+ @@ -412,6 +430,8 @@Reference Count setting for Channel 0.
+ @@ -468,6 +488,8 @@Reference Count setting for Channel 0.
+ @@ -538,6 +560,8 @@Channel 0 Settling Reference Count.
+ diff --git a/docs/html/group__KETCUBE__FDC2214__fn.html b/docs/html/group__KETCUBE__FDC2214__fn.html index 7672ec5..0cb2212 100644 --- a/docs/html/group__KETCUBE__FDC2214__fn.html +++ b/docs/html/group__KETCUBE__FDC2214__fn.html @@ -50,9 +50,12 @@ketCube_cfg_ModError_t ketCube_fdc2214_UnInit | +ketCube_cfg_ModError_t ketCube_fdc2214_SleepEnter | +( | +void | +) | ++ |
Uninitialize the FDC2214 sensor.
+KETCUBE_CFG_MODULE_OK | in case of success |
KETCUBE_CFG_MODULE_ERROR | in case of failure |
ketCube_cfg_ModError_t ketCube_fdc2214_SleepExit | ( | void | ) | diff --git a/docs/html/group__KETCUBE__FDC2214__settingsn.html b/docs/html/group__KETCUBE__FDC2214__settingsn.html new file mode 100644 index 0000000..e249baa --- /dev/null +++ b/docs/html/group__KETCUBE__FDC2214__settingsn.html @@ -0,0 +1,481 @@ + + + + + + + +
+ KETCube
+
+ |
+
+Macros | |
#define | KETCUBE_FDC2214_I2C_ADDRESS (uint8_t) (0x2A << 1) |
I2C slave (FDC2214) address. More... | |
#define | KETCUBE_FDC2214_I2C_TIMEOUT 1000 |
Timeout value for I2C communication [ms]. More... | |
#define | KETCUBE_FDC2214_I2C_WU 100 |
Wake-up time [ms]. More... | |
#define | KETCUBE_FDC2214_I2C_TRY 50 |
I2C try when not successfull. More... | |
#define | FDC2214_SD_PORT KETCUBE_MAIN_BOARD_PIN_PWM_PORT |
FDC2214 Shut-Down. More... | |
#define | FDC2214_SD_PIN KETCUBE_MAIN_BOARD_PIN_PWM_PIN |
FDC2214 Shut-Down. More... | |
#define | FDC2214_INT_PORT KETCUBE_MAIN_BOARD_PIN_INT_PORT |
FDC2214 INT. More... | |
#define | FDC2214_INT_PIN KETCUBE_MAIN_BOARD_PIN_INT_PIN |
FDC2214 INT. More... | |
#define | FDC2214_LED_PORT KETCUBE_MAIN_BOARD_PIN_MOSI_PORT |
Indication LED. More... | |
#define | FDC2214_LED_PIN KETCUBE_MAIN_BOARD_PIN_MOSI_PIN |
Indication LED. More... | |
#define | FDC2214_USE_EXTERNAL_OSC TRUE |
Enable/Disable external oscillator. More... | |
#define | FDC2214_ENABLE_INT FALSE |
Enable FDC2214 interrupt. More... | |
#define | FDC2214_ENABLE_SLEEP TRUE |
Enter sleep mode instead of shut-down when KETCube goes low-power mode. More... | |
#define | FDC2214_LED_INDICATION TRUE |
Enable LED indication. More... | |
#define | FDC2214_LED_THRESHOLD_LOW 1000 |
FDC2214 raw value difference used to indicate significant capacity difference by using LED. More... | |
#define | FDC2214_LED_THRESHOLD_HIGH 10000 |
FDC2214 raw value difference used to indicate significant capacity difference by using LED. More... | |
#define | FDC2214_LED_CHAN FDC2214_CH0 |
FDC2214 channel used for LED indication,. More... | |
#define | FDC2214_RCOUNT 0xFFFF |
#define | FDC2214_SETTLECOUNT 0x0400 |
SettleCount - to stabilize oscilaltions. More... | |
#define | FDC2214_CHAN_SEQ FDC2214_SINGLE_CH0 |
Selected/active channel(s),. More... | |
#define | FDC2214_DGL_FILTER FDC2214_DGLF_10 |
Selected Deglitch filter,. More... | |
#define | FDC2214_SENSTYPE FDC2214_SENSTYPE_SINGLE_ENDED |
Selected sensor type,. More... | |
#define FDC2214_CHAN_SEQ FDC2214_SINGLE_CH0 | +
Selected/active channel(s),.
+#define FDC2214_DGL_FILTER FDC2214_DGLF_10 | +
Selected Deglitch filter,.
+#define FDC2214_ENABLE_INT FALSE | +
Enable FDC2214 interrupt.
+ +#define FDC2214_ENABLE_SLEEP TRUE | +
Enter sleep mode instead of shut-down when KETCube goes low-power mode.
+ +#define FDC2214_INT_PIN KETCUBE_MAIN_BOARD_PIN_INT_PIN | +
FDC2214 INT.
+ +#define FDC2214_INT_PORT KETCUBE_MAIN_BOARD_PIN_INT_PORT | +
FDC2214 INT.
+ +#define FDC2214_LED_CHAN FDC2214_CH0 | +
FDC2214 channel used for LED indication,.
+#define FDC2214_LED_INDICATION TRUE | +
Enable LED indication.
+ +#define FDC2214_LED_PIN KETCUBE_MAIN_BOARD_PIN_MOSI_PIN | +
Indication LED.
+ +#define FDC2214_LED_PORT KETCUBE_MAIN_BOARD_PIN_MOSI_PORT | +
Indication LED.
+ +#define FDC2214_LED_THRESHOLD_HIGH 10000 | +
FDC2214 raw value difference used to indicate significant capacity difference by using LED.
+ +#define FDC2214_LED_THRESHOLD_LOW 1000 | +
FDC2214 raw value difference used to indicate significant capacity difference by using LED.
+ +#define FDC2214_RCOUNT 0xFFFF | +
#define FDC2214_SD_PIN KETCUBE_MAIN_BOARD_PIN_PWM_PIN | +
FDC2214 Shut-Down.
+ +#define FDC2214_SD_PORT KETCUBE_MAIN_BOARD_PIN_PWM_PORT | +
FDC2214 Shut-Down.
+ +#define FDC2214_SENSTYPE FDC2214_SENSTYPE_SINGLE_ENDED | +
Selected sensor type,.
+#define FDC2214_SETTLECOUNT 0x0400 | +
SettleCount - to stabilize oscilaltions.
+ +#define FDC2214_USE_EXTERNAL_OSC TRUE | +
Enable/Disable external oscillator.
+ +#define KETCUBE_FDC2214_I2C_ADDRESS (uint8_t) (0x2A << 1) | +
I2C slave (FDC2214) address.
+#define KETCUBE_FDC2214_I2C_TIMEOUT 1000 | +
Timeout value for I2C communication [ms].
+ +#define KETCUBE_FDC2214_I2C_TRY 50 | +
I2C try when not successfull.
+ +#define KETCUBE_FDC2214_I2C_WU 100 | +
Wake-up time [ms].
+ +ADC Resolution.
+Internal voltage reference was calibrated at 3V.
+ @@ -106,6 +113,8 @@Internal voltage reference calibration value VREFINT_CAL.
+ diff --git a/docs/html/group__KETCube__AsyncTx.html b/docs/html/group__KETCube__AsyncTx.html new file mode 100644 index 0000000..c0e116b --- /dev/null +++ b/docs/html/group__KETCube__AsyncTx.html @@ -0,0 +1,66 @@ + + + + + + + +
+ KETCube
+
+ |
+
KETCube Async Tx module. +More...
++Modules | |
Public Functions | |
KETCube Async Tx module.
+
+ KETCube
+
+ |
+
+Functions | |
ketCube_cfg_ModError_t | ketCube_AsyncTx_Init (ketCube_InterModMsg_t ***msg) |
ketCube_cfg_ModError_t | ketCube_AsyncTx_ProcessData (ketCube_InterModMsg_t *msg) |
ketCube_cfg_ModError_t ketCube_AsyncTx_Init | +( | +ketCube_InterModMsg_t *** | +msg | ) | ++ |
ketCube_cfg_ModError_t ketCube_AsyncTx_ProcessData | +( | +ketCube_InterModMsg_t * | +msg | ) | ++ |
+ KETCube
+
+ |
+
KETCube BMEx80 module. +More...
++Modules | |
Public Defines | |
Public defines. | |
Public Functions | |
Public functions. | |
BMEx80 Registers | |
KETCube BMEx80 module.
+
+ KETCube
+
+ |
+
Public defines. +More...
++Data Structures | |
struct | ketCube_bmeX80_Calib_t |
Calibration data structure. More... | |
+Macros | |
#define | BME_CONCAT_BYTES(msb, lsb) (((uint16_t)msb << 8) | (uint16_t)lsb) |
Macro to combine two 8 bit data's to form a 16 bit data. More... | |
#define | BME680_T2_LSB_REG 1 |
Array Index to Field data mapping for Calibration Data of BME680. More... | |
#define | BME680_T2_MSB_REG 2 |
#define | BME680_T3_REG 3 |
#define | BME680_P1_LSB_REG 5 |
#define | BME680_P1_MSB_REG 6 |
#define | BME680_P2_LSB_REG 7 |
#define | BME680_P2_MSB_REG 8 |
#define | BME680_P3_REG 9 |
#define | BME680_P4_LSB_REG 11 |
#define | BME680_P4_MSB_REG 12 |
#define | BME680_P5_LSB_REG 13 |
#define | BME680_P5_MSB_REG 14 |
#define | BME680_P7_REG 15 |
#define | BME680_P6_REG 16 |
#define | BME680_P8_LSB_REG 19 |
#define | BME680_P8_MSB_REG 20 |
#define | BME680_P9_LSB_REG 21 |
#define | BME680_P9_MSB_REG 22 |
#define | BME680_P10_REG 23 |
#define | BME680_H2_MSB_REG 25 |
#define | BME680_H2_LSB_REG 26 |
#define | BME680_H1_LSB_REG 26 |
#define | BME680_H1_MSB_REG 27 |
#define | BME680_H3_REG 28 |
#define | BME680_H4_REG 29 |
#define | BME680_H5_REG 30 |
#define | BME680_H6_REG 31 |
#define | BME680_H7_REG 32 |
#define | BME680_T1_LSB_REG 33 |
#define | BME680_T1_MSB_REG 34 |
#define | BME680_GH2_LSB_REG 35 |
#define | BME680_GH2_MSB_REG 36 |
#define | BME680_GH1_REG 37 |
#define | BME680_GH3_REG 38 |
#define | KETCUBE_BMEX80_I2C_ADDRESS (uint8_t) (0x76 << 1) /* SDO pin LOW */ |
I2C address. More... | |
#define | KETCUBE_BMEX80_CALIB_2_LENGTH 16 |
#define | KETCUBE_BMEX80_CHIP_ID 0x60 |
#define | KETCUBE_BMEX80_CALIB_1_LENGTH 26 |
#define | KETCUBE_BMEX80_MEASURING_SHIFT 3 |
+Enumerations | |
enum | ketCube_bmeX80_OS_H_t { + KETCUBE_BMEX80_OS_H_X0 = (uint8_t) 0x00, +KETCUBE_BMEX80_OS_H_X1 = (uint8_t) 0x01, +KETCUBE_BMEX80_OS_H_X2 = (uint8_t) 0x02, +KETCUBE_BMEX80_OS_H_X4 = (uint8_t) 0x03, + + KETCUBE_BMEX80_OS_H_X8 = (uint8_t) 0x04, +KETCUBE_BMEX80_OS_H_X16 = (uint8_t) 0x05 + + } |
Relative humidity oversampling. More... | |
enum | ketCube_bmeX80_OS_T_t { + KETCUBE_BMEX80_OS_T_X0 = (uint8_t) 0x00, +KETCUBE_BMEX80_OS_T_X1 = (uint8_t) 0x01, +KETCUBE_BMEX80_OS_T_X2 = (uint8_t) 0x02, +KETCUBE_BMEX80_OS_T_X4 = (uint8_t) 0x03, + + KETCUBE_BMEX80_OS_T_X8 = (uint8_t) 0x04, +KETCUBE_BMEX80_OS_T_X16 = (uint8_t) 0x05 + + } |
Temperature oversampling. More... | |
enum | ketCube_bmeX80_OS_P_t { + KETCUBE_BMEX80_OS_P_X0 = (uint8_t) 0x00, +KETCUBE_BMEX80_OS_P_X1 = (uint8_t) 0x01, +KETCUBE_BMEX80_OS_P_X2 = (uint8_t) 0x02, +KETCUBE_BMEX80_OS_P_X4 = (uint8_t) 0x03, + + KETCUBE_BMEX80_OS_P_X8 = (uint8_t) 0x04, +KETCUBE_BMEX80_OS_P_X16 = (uint8_t) 0x05 + + } |
Pressure oversampling. More... | |
Public defines.
+#define BME680_GH1_REG 37 | +
#define BME680_GH2_LSB_REG 35 | +
#define BME680_GH2_MSB_REG 36 | +
#define BME680_GH3_REG 38 | +
#define BME680_H1_LSB_REG 26 | +
#define BME680_H1_MSB_REG 27 | +
#define BME680_H2_LSB_REG 26 | +
#define BME680_H2_MSB_REG 25 | +
#define BME680_H3_REG 28 | +
#define BME680_H4_REG 29 | +
#define BME680_H5_REG 30 | +
#define BME680_H6_REG 31 | +
#define BME680_H7_REG 32 | +
#define BME680_P10_REG 23 | +
#define BME680_P1_LSB_REG 5 | +
#define BME680_P1_MSB_REG 6 | +
#define BME680_P2_LSB_REG 7 | +
#define BME680_P2_MSB_REG 8 | +
#define BME680_P3_REG 9 | +
#define BME680_P4_LSB_REG 11 | +
#define BME680_P4_MSB_REG 12 | +
#define BME680_P5_LSB_REG 13 | +
#define BME680_P5_MSB_REG 14 | +
#define BME680_P6_REG 16 | +
#define BME680_P7_REG 15 | +
#define BME680_P8_LSB_REG 19 | +
#define BME680_P8_MSB_REG 20 | +
#define BME680_P9_LSB_REG 21 | +
#define BME680_P9_MSB_REG 22 | +
#define BME680_T1_LSB_REG 33 | +
#define BME680_T1_MSB_REG 34 | +
#define BME680_T2_LSB_REG 1 | +
Array Index to Field data mapping for Calibration Data of BME680.
+ +#define BME680_T2_MSB_REG 2 | +
#define BME680_T3_REG 3 | +
#define BME_CONCAT_BYTES | +( | ++ | msb, | +
+ | + | + | lsb | +
+ | ) | +(((uint16_t)msb << 8) | (uint16_t)lsb) | +
Macro to combine two 8 bit data's to form a 16 bit data.
+ +#define KETCUBE_BMEX80_CALIB_1_LENGTH 26 | +
#define KETCUBE_BMEX80_CALIB_2_LENGTH 16 | +
#define KETCUBE_BMEX80_CHIP_ID 0x60 | +
#define KETCUBE_BMEX80_I2C_ADDRESS (uint8_t) (0x76 << 1) /* SDO pin LOW */ | +
I2C address.
+ +#define KETCUBE_BMEX80_MEASURING_SHIFT 3 | +
enum ketCube_bmeX80_OS_H_t | +
Relative humidity oversampling.
+Enumerator | |
---|---|
KETCUBE_BMEX80_OS_H_X0 | measurement skipped, output 0X8000 + |
KETCUBE_BMEX80_OS_H_X1 | 16 bit resolution, 1 sample + |
KETCUBE_BMEX80_OS_H_X2 | 16 bit resolution, 2 samples + |
KETCUBE_BMEX80_OS_H_X4 | 16 bit resolution, 4 samples + |
KETCUBE_BMEX80_OS_H_X8 | 16 bit resolution, 8 samples + |
KETCUBE_BMEX80_OS_H_X16 | 16 bit resolution, 16 samples + |
enum ketCube_bmeX80_OS_P_t | +
Pressure oversampling.
+Enumerator | |
---|---|
KETCUBE_BMEX80_OS_P_X0 | measurement skipped, output 0X8000 + |
KETCUBE_BMEX80_OS_P_X1 | 16 bit resolution, 1 sample + |
KETCUBE_BMEX80_OS_P_X2 | 17 bit resolution, 2 samples + |
KETCUBE_BMEX80_OS_P_X4 | 18 bit resolution, 4 samples + |
KETCUBE_BMEX80_OS_P_X8 | 19 bit resolution, 8 samples + |
KETCUBE_BMEX80_OS_P_X16 | 20 bit resolution, 16 samples + |
enum ketCube_bmeX80_OS_T_t | +
Temperature oversampling.
+Enumerator | |
---|---|
KETCUBE_BMEX80_OS_T_X0 | measurement skipped, output 0X8000 + |
KETCUBE_BMEX80_OS_T_X1 | 16 bit resolution, 1 sample + |
KETCUBE_BMEX80_OS_T_X2 | 17 bit resolution, 2 samples + |
KETCUBE_BMEX80_OS_T_X4 | 18 bit resolution, 4 samples + |
KETCUBE_BMEX80_OS_T_X8 | 19 bit resolution, 8 samples + |
KETCUBE_BMEX80_OS_T_X16 | 20 bit resolution, 16 samples + |
+ KETCube
+
+ |
+
Public functions. +More...
++Functions | |
ketCube_cfg_ModError_t | ketCube_bmeX80_Init (ketCube_InterModMsg_t ***msg) |
ketCube_cfg_ModError_t | ketCube_bmeX80_UnInit (void) |
ketCube_cfg_ModError_t | ketCube_bmeX80_ReadData (uint8_t *buffer, uint8_t *len) |
Public functions.
+ketCube_cfg_ModError_t ketCube_bmeX80_Init | +( | +ketCube_InterModMsg_t *** | +msg | ) | ++ |
ketCube_cfg_ModError_t ketCube_bmeX80_ReadData | +( | +uint8_t * | +buffer, | +
+ | + | uint8_t * | +len | +
+ | ) | ++ |
ketCube_cfg_ModError_t ketCube_bmeX80_UnInit | +( | +void | +) | ++ |
KETCube Modules providing communication functionality.
diff --git a/docs/html/group__KETCube__Core.html b/docs/html/group__KETCube__Core.html index b3e6262..51b2d26 100644 --- a/docs/html/group__KETCube__Core.html +++ b/docs/html/group__KETCube__Core.html @@ -50,6 +50,9 @@Modules | |||||
KETCube AsyncTx | |||||
KETCube Async Tx module. | |||||
KETCube Configuration Manager | |||||
KETCube Configuration Manager. | |||||
Modules | |
FDC2214 Settings | |
Public Functions | |
KETCUBE_FDC2214_Registers | |
-Macros | |
#define | KETCUBE_FDC2214_I2C_ADDRESS (uint8_t) (0x2A << 1) |
I2C slave (FDC2214) address. More... | |
#define | KETCUBE_FDC2214_I2C_TIMEOUT 0x1000 /*<! Value of Timeout when I2C communication fails */ |
I2C Timeout. More... | |
+Enumerations | |
enum | ketCube_fdc2214_chan_t { FDC2214_CH0 = 0x0, +FDC2214_CH1 = 0x1, +FDC2214_CH2 = 0x2, +FDC2214_CH3 = 0x3 + } |
FDC2214 Channels. More... | |
enum | ketCube_fdc2214_chanSeq_t { + FDC2214_SINGLE_CH0 = 0x0, +FDC2214_SINGLE_CH1 = 0x1, +FDC2214_SINGLE_CH2 = 0x2, +FDC2214_SINGLE_CH3 = 0x3, + + FDC2214_SEQ_CH_01 = (0x1 << 4), +FDC2214_SEQ_CH_012 = (0x2 << 4), +FDC2214_SEQ_CH_0123 = (0x3 << 4) + + } |
Channel Sequencing. More... | |
enum | ketCube_fdc2214_dglFilter_t { FDC2214_DGLF_1 = 0x1, +FDC2214_DGLF_3 = 0x4, +FDC2214_DGLF_10 = 0x5, +FDC2214_DGLF_33 = 0x7 + } |
Deglitch Filter. More... | |
enum | ketCube_fdc2214_sensType_t { FDC2214_SENSTYPE_DIFFERENTIAL, +FDC2214_SENSTYPE_SINGLE_ENDED + } |
Sensor type. More... | |
KETCube FDC2214 module.
-#define KETCUBE_FDC2214_I2C_ADDRESS (uint8_t) (0x2A << 1) | +enum ketCube_fdc2214_chan_t |
enum ketCube_fdc2214_chanSeq_t | +
Channel Sequencing.
+Enumerator | |
---|---|
FDC2214_SINGLE_CH0 | Enable single channel 0. + |
FDC2214_SINGLE_CH1 | Enable single channel 1. + |
FDC2214_SINGLE_CH2 | Enable single channel 2. + |
FDC2214_SINGLE_CH3 | Enable single channel 3. + |
FDC2214_SEQ_CH_01 | Sequence channels 0 and 2. + |
FDC2214_SEQ_CH_012 | Sequence channels 0 and 1 and 2. + |
FDC2214_SEQ_CH_0123 | Sequence channels 0 and 1 and 2 and 3. + |
#define KETCUBE_FDC2214_I2C_TIMEOUT 0x1000 /*<! Value of Timeout when I2C communication fails */ | +enum ketCube_fdc2214_dglFilter_t |
enum ketCube_fdc2214_sensType_t | +
+ KETCube
+
+ |
+
KETCube GPIO driver. +More...
++Modules | |
Public Functions | |
Public functions. | |
+Typedefs | |
typedef void(* | ketCube_GPIO_VoidFn_t) (void) |
Pointer to a IRQ Handler Function. More... | |
+Enumerations | |
enum | ketCube_gpio_pin_t { + KETCUBE_GPIO_NOPIN = 0, +KETCUBE_GPIO_PIN_0 = GPIO_PIN_0, +KETCUBE_GPIO_PIN_1 = GPIO_PIN_1, +KETCUBE_GPIO_PIN_2 = GPIO_PIN_2, + + KETCUBE_GPIO_PIN_3 = GPIO_PIN_3, +KETCUBE_GPIO_PIN_4 = GPIO_PIN_4, +KETCUBE_GPIO_PIN_5 = GPIO_PIN_5, +KETCUBE_GPIO_PIN_6 = GPIO_PIN_6, + + KETCUBE_GPIO_PIN_7 = GPIO_PIN_7, +KETCUBE_GPIO_PIN_8 = GPIO_PIN_8, +KETCUBE_GPIO_PIN_9 = GPIO_PIN_9, +KETCUBE_GPIO_PIN_10 = GPIO_PIN_10, + + KETCUBE_GPIO_PIN_11 = GPIO_PIN_11, +KETCUBE_GPIO_PIN_12 = GPIO_PIN_12, +KETCUBE_GPIO_PIN_13 = GPIO_PIN_13, +KETCUBE_GPIO_PIN_14 = GPIO_PIN_14, + + KETCUBE_GPIO_PIN_15 = GPIO_PIN_15 + + } |
List of GPIO PINs. More... | |
enum | ketCube_gpio_port_t { + KETCUBE_GPIO_PA = GPIOA_BASE, +KETCUBE_GPIO_PB = GPIOB_BASE, +KETCUBE_GPIO_PC = GPIOC_BASE, +KETCUBE_GPIO_PD = GPIOD_BASE, + + KETCUBE_GPIO_PE = GPIOE_BASE, +KETCUBE_GPIO_PH = GPIOH_BASE + + } |
GPIO Ports. More... | |
KETCube GPIO driver.
+typedef void(* ketCube_GPIO_VoidFn_t) (void) | +
Pointer to a IRQ Handler Function.
+ +enum ketCube_gpio_pin_t | +
List of GPIO PINs.
+Enumerator | |
---|---|
KETCUBE_GPIO_NOPIN | |
KETCUBE_GPIO_PIN_0 | |
KETCUBE_GPIO_PIN_1 | |
KETCUBE_GPIO_PIN_2 | |
KETCUBE_GPIO_PIN_3 | |
KETCUBE_GPIO_PIN_4 | |
KETCUBE_GPIO_PIN_5 | |
KETCUBE_GPIO_PIN_6 | |
KETCUBE_GPIO_PIN_7 | |
KETCUBE_GPIO_PIN_8 | |
KETCUBE_GPIO_PIN_9 | |
KETCUBE_GPIO_PIN_10 | |
KETCUBE_GPIO_PIN_11 | |
KETCUBE_GPIO_PIN_12 | |
KETCUBE_GPIO_PIN_13 | |
KETCUBE_GPIO_PIN_14 | |
KETCUBE_GPIO_PIN_15 |
enum ketCube_gpio_port_t | +
+ KETCube
+
+ |
+
Public functions. +More...
++Functions | |
ketCube_cfg_DrvError_t | ketCube_GPIO_Init (ketCube_gpio_port_t port, uint16_t pin, GPIO_InitTypeDef *initStruct) |
Initializes the GPIO PIN(s) More... | |
ketCube_cfg_DrvError_t | ketCube_GPIO_SetIrq (ketCube_gpio_port_t port, ketCube_gpio_pin_t pin, uint32_t prio, ketCube_GPIO_VoidFn_t irqHandler) |
Records the interrupt handler for the GPIO object. More... | |
void | ketCube_GPIO_Write (ketCube_gpio_port_t port, ketCube_gpio_pin_t pin, bool bit) |
Writes the bit value to the GPIO PIN. More... | |
bool | ketCube_GPIO_Read (ketCube_gpio_port_t port, ketCube_gpio_pin_t pin) |
Reads the current PIN value. More... | |
void | EXTI0_1_IRQHandler (void) |
void | EXTI2_3_IRQHandler (void) |
void | EXTI4_15_IRQHandler (void) |
Public functions.
+void EXTI0_1_IRQHandler | +( | +void | +) | ++ |
void EXTI2_3_IRQHandler | +( | +void | +) | ++ |
void EXTI4_15_IRQHandler | +( | +void | +) | ++ |
ketCube_cfg_DrvError_t ketCube_GPIO_Init | +( | +ketCube_gpio_port_t | +port, | +
+ | + | uint16_t | +pin, | +
+ | + | GPIO_InitTypeDef * | +initStruct | +
+ | ) | ++ |
Initializes the GPIO PIN(s)
+port | GPIO port |
pin | GPIO PIN |
initStruct | GPIO_InitTypeDef intit structure |
KETCUBE_CFG_DRV_OK | in case of success |
KETCUBE_CFG_DRV_ERROR | in case of failure |
bool ketCube_GPIO_Read | +( | +ketCube_gpio_port_t | +port, | +
+ | + | ketCube_gpio_pin_t | +pin | +
+ | ) | ++ |
Reads the current PIN value.
+port | GPIO port |
pin | GPIO PIN |
bit | TRUE if PIN value is '1', else return FALSE |
ketCube_cfg_DrvError_t ketCube_GPIO_SetIrq | +( | +ketCube_gpio_port_t | +port, | +
+ | + | ketCube_gpio_pin_t | +pin, | +
+ | + | uint32_t | +prio, | +
+ | + | ketCube_GPIO_VoidFn_t | +irqHandler | +
+ | ) | ++ |
Records the interrupt handler for the GPIO object.
+port | GPIO port |
pin | GPIO PIN |
prio | NVIC priority (0 is highest) |
irqHandler | pointer to handling function |
KETCUBE_CFG_DRV_OK | in case of success |
KETCUBE_CFG_DRV_ERROR | in case of failure |
void ketCube_GPIO_Write | +( | +ketCube_gpio_port_t | +port, | +
+ | + | ketCube_gpio_pin_t | +pin, | +
+ | + | bool | +bit | +
+ | ) | ++ |
Writes the bit value to the GPIO PIN.
+port | GPIO port |
pin | GPIO PIN |
bit | TRUE if PIN value is '1', else return FALSE |
+Enumerations | |
enum | ketCube_I2C_SPEED_t { KETCUBE_I2C_SPEED_100KHZ = 0x10A13E56, +KETCUBE_I2C_SPEED_400KHZ = 0x00B1112E + } |
I2C Speed selection. More... | |
Public defines.
@@ -248,20 +251,6 @@#define KETCUBE_I2C_SPEED 100000 | -
#define KETCUBE_I2C_TIMING_100KHZ 0x10A13E56 /* Analog Filter ON, Rise Time 400ns, Fall Time 100ns */ | +enum ketCube_I2C_SPEED_t |
#define KETCUBE_I2C_TIMING_400KHZ 0x00B1112E /* Analog Filter ON, Rise Time 250ns, Fall Time 100ns */ | -
Public functions.
ketCube_cfg_ModError_t ketCube_I2C_AnalogWriteReg | +( | +uint8_t | +devAddr, | +
+ | + | uint8_t | +regAddr, | +
+ | + | uint8_t | +data | +
+ | ) | ++ |
Write AnalogDevices I2C periph 8-bit register.
+devAddr | I2C Address |
regAddr | register address |
data | 8-bit register value |
KETCUBE_CFG_MODULE_OK | in case of success |
KETCUBE_CFG_MODULE_ERROR | in case of failure |
uint8_t ketCube_I2C_ReadRawData | +( | +uint8_t | +Addr, | +
+ | + | uint8_t * | +pBuffer, | +
+ | + | uint16_t | +Size | +
+ | ) | ++ |
ketCube_cfg_ModError_t ketCube_I2C_STMReadBlock | +( | +uint8_t | +devAddr, | +
+ | + | uint8_t | +regAddr, | +
+ | + | uint8_t * | +data, | +
+ | + | uint8_t | +len, | +
+ | + | uint8_t | +try | +
+ | ) | ++ |
Read STM I2C Single 8-bit register.
+devAddr | I2C Address |
regAddr | register address |
data | pointer to 8-bit value |
len | data length to read |
try | # of tries when I2C failed |
KETCUBE_CFG_MODULE_OK | in case of success |
KETCUBE_CFG_MODULE_ERROR | in case of failure |
ketCube_cfg_ModError_t ketCube_I2C_STMReadSingle | +( | +uint8_t | +devAddr, | +
+ | + | uint8_t | +regAddr, | +
+ | + | uint8_t * | +data, | +
+ | + | uint8_t | +try | +
+ | ) | ++ |
Read STM I2C Single 8-bit register.
+devAddr | I2C Address |
regAddr | register address |
data | pointer to 8-bit value |
try | # of tries when I2C failed |
KETCUBE_CFG_MODULE_OK | in case of success |
KETCUBE_CFG_MODULE_ERROR | in case of failure |
ketCube_cfg_ModError_t ketCube_I2C_STMWriteSingle | +( | +uint8_t | +devAddr, | +
+ | + | uint8_t | +regAddr, | +
+ | + | uint8_t * | +data, | +
+ | + | uint8_t | +try | +
+ | ) | ++ |
Write STM I2C Single 8-bit register.
+devAddr | I2C Address |
regAddr | register address |
data | pointer to 8-bit value |
try | # of tries when I2C failed |
KETCUBE_CFG_MODULE_OK | in case of success |
KETCUBE_CFG_MODULE_ERROR | in case of failure |
uint8_t ketCube_I2C_WriteRawData | +( | +uint8_t | +Addr, | +
+ | + | uint8_t * | +pBuffer, | +
+ | + | uint16_t | +Size | +
+ | ) | ++ |
+ KETCube
+
+ |
+
KETCube I2S module. +More...
++Modules | |
Public Deffinitions | |
Public defines. | |
Public Functions | |
Public functions. | |
KETCube I2S module.
+
+ KETCube
+
+ |
+
Public defines. +More...
++Macros | |
#define | KETCUBE_I2S_HANDLE SPI2 |
#define | KETCUBE_I2S_SAMPLE_RATE I2S_AUDIOFREQ_32K /*<! Available: 8,11,16,22,32,44,48 kHz */ |
#define | KETCUBE_I2S_CLK_ENABLE() __SPI2_CLK_ENABLE() |
#define | KETCUBE_I2S_FORCE_RESET() __SPI2_FORCE_RESET() |
#define | KETCUBE_I2S_RELEASE_RESET() __SPI2_RELEASE_RESET() |
#define | KETCUBE_I2S_WS_CK_SD_GPIO_CLK_ENABLE() __GPIOB_CLK_ENABLE() |
#define | KETCUBE_I2S_WS_CK_SD_AF GPIO_AF0_SPI2 |
#define | KETCUBE_I2S_WS_CK_SD_GPIO_PORT GPIOB |
#define | KETCUBE_I2S_WS_PIN GPIO_PIN_12 |
#define | KETCUBE_I2S_CK_PIN GPIO_PIN_13 |
#define | KETCUBE_I2S_SD_PIN GPIO_PIN_15 |
#define | KETCUBE_I2S_EV_IRQn SPI2_IRQn |
Public defines.
+#define KETCUBE_I2S_CK_PIN GPIO_PIN_13 | +
#define KETCUBE_I2S_CLK_ENABLE | +( | +) | +__SPI2_CLK_ENABLE() | +
#define KETCUBE_I2S_EV_IRQn SPI2_IRQn | +
#define KETCUBE_I2S_FORCE_RESET | +( | +) | +__SPI2_FORCE_RESET() | +
#define KETCUBE_I2S_HANDLE SPI2 | +
#define KETCUBE_I2S_RELEASE_RESET | +( | +) | +__SPI2_RELEASE_RESET() | +
#define KETCUBE_I2S_SAMPLE_RATE I2S_AUDIOFREQ_32K /*<! Available: 8,11,16,22,32,44,48 kHz */ | +
#define KETCUBE_I2S_SD_PIN GPIO_PIN_15 | +
#define KETCUBE_I2S_WS_CK_SD_AF GPIO_AF0_SPI2 | +
#define KETCUBE_I2S_WS_CK_SD_GPIO_CLK_ENABLE | +( | +) | +__GPIOB_CLK_ENABLE() | +
#define KETCUBE_I2S_WS_CK_SD_GPIO_PORT GPIOB | +
#define KETCUBE_I2S_WS_PIN GPIO_PIN_12 | +
+ KETCube
+
+ |
+
Public functions. +More...
++Functions | |
ketCube_cfg_ModError_t | ketCube_I2S_Init (void) |
Configures I2S interface. More... | |
ketCube_cfg_ModError_t | ketCube_I2S_UnInit (void) |
Public functions.
+ketCube_cfg_ModError_t ketCube_I2S_Init | +( | +void | +) | ++ |
Configures I2S interface.
+KETCUBE_CFG_MODULE_OK | in case of success |
KETCUBE_CFG_MODULE_ERROR | in case of failure |
ketCube_cfg_ModError_t ketCube_I2S_UnInit | +( | +void | +) | ++ |
+ KETCube
+
+ |
+
KETCube LIS2HH12 module. +More...
++Modules | |
Public Defines | |
Public defines. | |
Public Functions | |
Public functions. | |
+Macros | |
#define | KETCUBE_LIS2HH12_I2C_ADDRESS (uint8_t) (0x1D << 1) |
I2C slave (LIS2HH12) address. More... | |
#define | KETCUBE_LIS2HH12_WHO_AM_I 0x41 |
KETCube LIS2HH12 module.
+#define KETCUBE_LIS2HH12_I2C_ADDRESS (uint8_t) (0x1D << 1) | +
I2C slave (LIS2HH12) address.
+#define KETCUBE_LIS2HH12_WHO_AM_I 0x41 | +
+ KETCube
+
+ |
+
+Macros | |
#define | KETCUBE_LIS2HH12_RESOLUTION_HIGH 0x01U<<7 |
#define | KETCUBE_LIS2HH12_RESOLUTION_NORMAL 0x00U |
#define | KETCUBE_LIS2HH12_ODR_0_PDN 0x00U |
#define | KETCUBE_LIS2HH12_ODR_10Hz 0x01U<<4 |
#define | KETCUBE_LIS2HH12_ODR_50Hz 0x02U<<4 |
#define | KETCUBE_LIS2HH12_ODR_100Hz 0x03U<<4 |
#define | KETCUBE_LIS2HH12_ODR_200Hz 0x04U<<4 |
#define | KETCUBE_LIS2HH12_ODR_400Hz 0x05U<<4 |
#define | KETCUBE_LIS2HH12_ODR_800Hz 0x06U<<4 |
#define | KETCUBE_LIS2HH12_DATA_LATCH 0x01U<<3 |
#define | KETCUBE_LIS2HH12_DATA_UPDATE 0x00U |
#define | KETCUBE_LIS2HH12_X_ENABLE 0x01U |
#define | KETCUBE_LIS2HH12_Y_ENABLE 0x01U<<1 |
#define | KETCUBE_LIS2HH12_Z_ENABLE 0x01U<<2 |
#define KETCUBE_LIS2HH12_DATA_LATCH 0x01U<<3 | +
#define KETCUBE_LIS2HH12_DATA_UPDATE 0x00U | +
#define KETCUBE_LIS2HH12_ODR_0_PDN 0x00U | +
#define KETCUBE_LIS2HH12_ODR_100Hz 0x03U<<4 | +
#define KETCUBE_LIS2HH12_ODR_10Hz 0x01U<<4 | +
#define KETCUBE_LIS2HH12_ODR_200Hz 0x04U<<4 | +
#define KETCUBE_LIS2HH12_ODR_400Hz 0x05U<<4 | +
#define KETCUBE_LIS2HH12_ODR_50Hz 0x02U<<4 | +
#define KETCUBE_LIS2HH12_ODR_800Hz 0x06U<<4 | +
#define KETCUBE_LIS2HH12_RESOLUTION_HIGH 0x01U<<7 | +
#define KETCUBE_LIS2HH12_RESOLUTION_NORMAL 0x00U | +
#define KETCUBE_LIS2HH12_X_ENABLE 0x01U | +
#define KETCUBE_LIS2HH12_Y_ENABLE 0x01U<<1 | +
#define KETCUBE_LIS2HH12_Z_ENABLE 0x01U<<2 | +
+ KETCube
+
+ |
+
+Macros | |
#define | KETCUBE_LIS2HH12_FIFO_EN 0x01U << 7 |
#define | KETCUBE_LIS2HH12_FIFO_DIS 0x00U |
#define | KETCUBE_LIS2HH12_FIFO_TSH_EN 0x01U << 6 |
#define | KETCUBE_LIS2HH12_FIFO_TSH_DIS 0x00U |
#define | KETCUBE_LIS2HH12_INT1_INACT_EN 0x01U << 5 |
#define | KETCUBE_LIS2HH12_INT1_INACT_DIS 0x00U |
#define | KETCUBE_LIS2HH12_INT1_IG2_EN 0x01U << 4 |
#define | KETCUBE_LIS2HH12_INT1_IG2_DIS 0x00U |
#define | KETCUBE_LIS2HH12_INT1_IG1_EN 0x01U << 3 |
#define | KETCUBE_LIS2HH12_INT1_IG1_DIS 0x00U |
#define | KETCUBE_LIS2HH12_INT1_OVR_EN 0x01U << 2 |
#define | KETCUBE_LIS2HH12_INT1_OVR_DIS 0x00U |
#define | KETCUBE_LIS2HH12_INT1_FTH_EN 0x01U << 1 |
#define | KETCUBE_LIS2HH12_INT1_FTH_DIS 0x00U |
#define | KETCUBE_LIS2HH12_INT1_DRDY_EN 0x01U |
#define | KETCUBE_LIS2HH12_INT1_DRDY_DIS 0x00U |
#define KETCUBE_LIS2HH12_FIFO_DIS 0x00U | +
#define KETCUBE_LIS2HH12_FIFO_EN 0x01U << 7 | +
#define KETCUBE_LIS2HH12_FIFO_TSH_DIS 0x00U | +
#define KETCUBE_LIS2HH12_FIFO_TSH_EN 0x01U << 6 | +
#define KETCUBE_LIS2HH12_INT1_DRDY_DIS 0x00U | +
#define KETCUBE_LIS2HH12_INT1_DRDY_EN 0x01U | +
#define KETCUBE_LIS2HH12_INT1_FTH_DIS 0x00U | +
#define KETCUBE_LIS2HH12_INT1_FTH_EN 0x01U << 1 | +
#define KETCUBE_LIS2HH12_INT1_IG1_DIS 0x00U | +
#define KETCUBE_LIS2HH12_INT1_IG1_EN 0x01U << 3 | +
#define KETCUBE_LIS2HH12_INT1_IG2_DIS 0x00U | +
#define KETCUBE_LIS2HH12_INT1_IG2_EN 0x01U << 4 | +
#define KETCUBE_LIS2HH12_INT1_INACT_DIS 0x00U | +
#define KETCUBE_LIS2HH12_INT1_INACT_EN 0x01U << 5 | +
#define KETCUBE_LIS2HH12_INT1_OVR_DIS 0x00U | +
#define KETCUBE_LIS2HH12_INT1_OVR_EN 0x01U << 2 | +
+ KETCube
+
+ |
+
+Macros | |
#define | KETCUBE_LIS2HH12_AOI_EN 0x01U << 7 |
#define | KETCUBE_LIS2HH12_AOI_DIS 0x00U |
#define | KETCUBE_LIS2HH12_6D_EN 0x01U << 6 |
#define | KETCUBE_LIS2HH12_6D_DIS 0x00U |
#define | KETCUBE_LIS2HH12_ZHIGH_EN 0x01U << 5 |
#define | KETCUBE_LIS2HH12_ZHIGH_DIS 0x00U |
#define | KETCUBE_LIS2HH12_ZLOW_EN 0x01U << 4 |
#define | KETCUBE_LIS2HH12_ZLOW_DIS 0x00U |
#define | KETCUBE_LIS2HH12_YHIGH_EN 0x01U << 3 |
#define | KETCUBE_LIS2HH12_YHIGH_DIS 0x00U |
#define | KETCUBE_LIS2HH12_YLOW_EN 0x01U << 2 |
#define | KETCUBE_LIS2HH12_YLOW_DIS 0x00U |
#define | KETCUBE_LIS2HH12_XHIGH_EN 0x01U << 1 |
#define | KETCUBE_LIS2HH12_XHIGH_DIS 0x00U |
#define | KETCUBE_LIS2HH12_XLOW_EN 0x01U |
#define | KETCUBE_LIS2HH12_XLOW_DIS 0x00U |
#define KETCUBE_LIS2HH12_6D_DIS 0x00U | +
#define KETCUBE_LIS2HH12_6D_EN 0x01U << 6 | +
#define KETCUBE_LIS2HH12_AOI_DIS 0x00U | +
#define KETCUBE_LIS2HH12_AOI_EN 0x01U << 7 | +
#define KETCUBE_LIS2HH12_XHIGH_DIS 0x00U | +
#define KETCUBE_LIS2HH12_XHIGH_EN 0x01U << 1 | +
#define KETCUBE_LIS2HH12_XLOW_DIS 0x00U | +
#define KETCUBE_LIS2HH12_XLOW_EN 0x01U | +
#define KETCUBE_LIS2HH12_YHIGH_DIS 0x00U | +
#define KETCUBE_LIS2HH12_YHIGH_EN 0x01U << 3 | +
#define KETCUBE_LIS2HH12_YLOW_DIS 0x00U | +
#define KETCUBE_LIS2HH12_YLOW_EN 0x01U << 2 | +
#define KETCUBE_LIS2HH12_ZHIGH_DIS 0x00U | +
#define KETCUBE_LIS2HH12_ZHIGH_EN 0x01U << 5 | +
#define KETCUBE_LIS2HH12_ZLOW_DIS 0x00U | +
#define KETCUBE_LIS2HH12_ZLOW_EN 0x01U << 4 | +
+ KETCube
+
+ |
+
+Macros | |
#define | KETCUBE_LIS2HH12_TEMP_L 0x0BU |
#define | KETCUBE_LIS2HH12_TEMP_H 0x0CU |
#define | KETCUBE_LIS2HH12_WHO_AM_I_REG 0x0FU |
#define | KETCUBE_LIS2HH12_ACT_TSH 0x1EU |
#define | KETCUBE_LIS2HH12_ACT_DUR 0x1FU |
#define | KETCUBE_LIS2HH12_CTRL_REG1 0x20U |
Main CTRL Register. More... | |
#define | KETCUBE_LIS2HH12_CTRL_REG2 0x21U |
#define | KETCUBE_LIS2HH12_CTRL_REG3 0x22U |
Interrupt control. More... | |
#define | KETCUBE_LIS2HH12_CTRL_REG4 0x23U |
#define | KETCUBE_LIS2HH12_CTRL_REG5 0x24U |
#define | KETCUBE_LIS2HH12_CTRL_REG6 0x25U |
#define | KETCUBE_LIS2HH12_CTRL_REG7 0x26U |
#define | KETCUBE_LIS2HH12_STATUS_REG 0x27U |
#define | KETCUBE_LIS2HH12_OUT_X_L 0x28U |
#define | KETCUBE_LIS2HH12_OUT_X_H 0x29U |
#define | KETCUBE_LIS2HH12_OUT_Y_L 0x2AU |
#define | KETCUBE_LIS2HH12_OUT_Y_H 0x2BU |
#define | KETCUBE_LIS2HH12_OUT_Z_L 0x2CU |
#define | KETCUBE_LIS2HH12_OUT_Z_H 0x2DU |
#define | KETCUBE_LIS2HH12_FIFO_CTRL 0x2EU |
#define | KETCUBE_LIS2HH12_FIFO_SRC 0x2FU |
#define | KETCUBE_LIS2HH12_INT1_CFG 0x30U |
#define | KETCUBE_LIS2HH12_INT1_SOURCE 0x31U |
#define | KETCUBE_LIS2HH12_INT1_TSH_X1 0x32U |
#define | KETCUBE_LIS2HH12_INT1_TSH_Y1 0x33U |
#define | KETCUBE_LIS2HH12_INT1_TSH_Z1 0x34U |
#define | KETCUBE_LIS2HH12_INT1_DURATION 0x35U |
#define | KETCUBE_LIS2HH12_INT2_CFG 0x36U |
#define | KETCUBE_LIS2HH12_INT2_SOURCE 0x37U |
#define | KETCUBE_LIS2HH12_INT2_TSH 0x38U |
#define | KETCUBE_LIS2HH12_INT2_DURATION 0x39U |
#define | KETCUBE_LIS2HH12_INT2_XL_REF 0x3AU |
#define | KETCUBE_LIS2HH12_INT2_XH_REF 0x3BU |
#define | KETCUBE_LIS2HH12_INT2_YL_REF 0x3CU |
#define | KETCUBE_LIS2HH12_INT2_YH_REF 0x3DU |
#define | KETCUBE_LIS2HH12_INT2_ZL_REF 0x3EU |
#define | KETCUBE_LIS2HH12_INT2_ZH_REF 0x3FU |
#define KETCUBE_LIS2HH12_ACT_DUR 0x1FU | +
#define KETCUBE_LIS2HH12_ACT_TSH 0x1EU | +
#define KETCUBE_LIS2HH12_CTRL_REG1 0x20U | +
Main CTRL Register.
+ +#define KETCUBE_LIS2HH12_CTRL_REG2 0x21U | +
#define KETCUBE_LIS2HH12_CTRL_REG3 0x22U | +
Interrupt control.
+ +#define KETCUBE_LIS2HH12_CTRL_REG4 0x23U | +
#define KETCUBE_LIS2HH12_CTRL_REG5 0x24U | +
#define KETCUBE_LIS2HH12_CTRL_REG6 0x25U | +
#define KETCUBE_LIS2HH12_CTRL_REG7 0x26U | +
#define KETCUBE_LIS2HH12_FIFO_CTRL 0x2EU | +
#define KETCUBE_LIS2HH12_FIFO_SRC 0x2FU | +
#define KETCUBE_LIS2HH12_INT1_CFG 0x30U | +
#define KETCUBE_LIS2HH12_INT1_DURATION 0x35U | +
#define KETCUBE_LIS2HH12_INT1_SOURCE 0x31U | +
#define KETCUBE_LIS2HH12_INT1_TSH_X1 0x32U | +
#define KETCUBE_LIS2HH12_INT1_TSH_Y1 0x33U | +
#define KETCUBE_LIS2HH12_INT1_TSH_Z1 0x34U | +
#define KETCUBE_LIS2HH12_INT2_CFG 0x36U | +
#define KETCUBE_LIS2HH12_INT2_DURATION 0x39U | +
#define KETCUBE_LIS2HH12_INT2_SOURCE 0x37U | +
#define KETCUBE_LIS2HH12_INT2_TSH 0x38U | +
#define KETCUBE_LIS2HH12_INT2_XH_REF 0x3BU | +
#define KETCUBE_LIS2HH12_INT2_XL_REF 0x3AU | +
#define KETCUBE_LIS2HH12_INT2_YH_REF 0x3DU | +
#define KETCUBE_LIS2HH12_INT2_YL_REF 0x3CU | +
#define KETCUBE_LIS2HH12_INT2_ZH_REF 0x3FU | +
#define KETCUBE_LIS2HH12_INT2_ZL_REF 0x3EU | +
#define KETCUBE_LIS2HH12_OUT_X_H 0x29U | +
#define KETCUBE_LIS2HH12_OUT_X_L 0x28U | +
#define KETCUBE_LIS2HH12_OUT_Y_H 0x2BU | +
#define KETCUBE_LIS2HH12_OUT_Y_L 0x2AU | +
#define KETCUBE_LIS2HH12_OUT_Z_H 0x2DU | +
#define KETCUBE_LIS2HH12_OUT_Z_L 0x2CU | +
#define KETCUBE_LIS2HH12_STATUS_REG 0x27U | +
#define KETCUBE_LIS2HH12_TEMP_H 0x0CU | +
#define KETCUBE_LIS2HH12_TEMP_L 0x0BU | +
#define KETCUBE_LIS2HH12_WHO_AM_I_REG 0x0FU | +
+ KETCube
+
+ |
+
Public defines. +More...
++Modules | |
LIS2HH12 Registers | |
LIS2HH12 CTRL1 flags | |
LIS2HH12 CTRL3 flags | |
LIS2HH12 IG_CFG1 flags | |
+Enumerations | |
enum | ketCube_lis2hh12_Int1_Src_t { + KETCUBE_LIS2HH12_INT1_SRC_XLOW = 0x00U, +KETCUBE_LIS2HH12_INT1_SRC_XHIGH = 0x01U, +KETCUBE_LIS2HH12_INT1_SRC_YLOW = 0x02U, +KETCUBE_LIS2HH12_INT1_SRC_YHIGH = 0x04U, + + KETCUBE_LIS2HH12_INT1_SRC_ZLOW = 0x08U, +KETCUBE_LIS2HH12_INT1_SRC_ZHIGH = 0x10U + + } |
Public defines.
+enum ketCube_lis2hh12_Int1_Src_t | +
KETCube LoRa module.
@@ -292,6 +298,36 @@ketCube_cfg_ModError_t ketCube_lora_AsyncSend | +( | +uint8_t * | +buffer, | +
+ | + | uint8_t * | +len | +
+ | ) | ++ |
Process lora state and prepare data (for asynchronous send)...
+ +void ketCube_lora_processCustomData | +( | +uint8_t * | +buffer, | +
+ | + | uint8_t | +len | +
+ | ) | ++ |
Process custom data.
+buffer | received data |
KETCube LoRa module commandline deffinition.
void HW_GetUniqueId | +( | +uint8_t * | +id | ) | ++ |
Modules | |
KETCube GPIO driver | |
KETCube GPIO driver. | |
KETCube I2C | |
KETCube I2C module. | |
KETCube I2S | |
KETCube I2S module. | |
KETCube Main Board | |
KETCube Configuration Manager. | |
KETCube timer | |
KETCube Timer module. | |
KETCube peripheral drivers for KETCube Modules.
diff --git a/docs/html/group__KETCube__Modules.html b/docs/html/group__KETCube__Modules.html index 78f354b..508c960 100644 --- a/docs/html/group__KETCube__Modules.html +++ b/docs/html/group__KETCube__Modules.html @@ -52,9 +52,10 @@Macros | |
#define | KETCUBE_MODULES_SENSOR_BYTES 64 |
#define | KETCUBE_MODULES_SENSOR_BYTES 512 |
Max number of bytes which can be read from all sensors. More... | |
#define | ketCube_modules_CNT (KETCUBE_LISTS_MODULEID_LAST) |
#define | ketCube_modules_CNT (KETCUBE_LISTS_MODULEID_LAST) |
@@ -78,7 +79,6 @@
Variables | List of KETCube modules. More... | | |
#define ketCube_modules_CNT (KETCUBE_LISTS_MODULEID_LAST) | +#define ketCube_modules_CNT (KETCUBE_LISTS_MODULEID_LAST) |
#define KETCUBE_MODULES_SENSOR_BYTES 64 | +#define KETCUBE_MODULES_SENSOR_BYTES 512 |
Max number of bytes which can be read from all sensors.
+List of KETCube modules.
- diff --git a/docs/html/group__KETCube__RxDisplay__fn.html b/docs/html/group__KETCube__RxDisplay__fn.html index c1f1ff6..ed21e08 100644 --- a/docs/html/group__KETCube__RxDisplay__fn.html +++ b/docs/html/group__KETCube__RxDisplay__fn.html @@ -48,10 +48,8 @@Initialize rxDisplay module.
-KETCUBE_CFG_MODULE_OK | in case of success |
KETCUBE_CFG_MODULE_ERROR | in case of failure |
Process data – display on serial line.
-KETCUBE_CFG_MODULE_OK | in case of success |
KETCUBE_CFG_MODULE_ERROR | in case of failure |
+ KETCube
+
+ |
+
Public functions. +More...
++Functions | |
ketCube_cfg_ModError_t | ketCube_lis2hh12_Init (ketCube_InterModMsg_t ***msg) |
uint8_t | ketCube_lis2h12_Get_Int (void) |
ketCube_cfg_ModError_t | ketCube_lis2hh12_UnInit (void) |
ketCube_cfg_ModError_t | ketCube_lis2hh12_ReadData (uint8_t *buffer, uint8_t *len) |
Public functions.
+uint8_t ketCube_lis2h12_Get_Int | +( | +void | +) | ++ |
ketCube_cfg_ModError_t ketCube_lis2hh12_Init | +( | +ketCube_InterModMsg_t *** | +msg | ) | ++ |
ketCube_cfg_ModError_t ketCube_lis2hh12_ReadData | +( | +uint8_t * | +buffer, | +
+ | + | uint8_t * | +len | +
+ | ) | ++ |
ketCube_cfg_ModError_t ketCube_lis2hh12_UnInit | +( | +void | +) | ++ |
KETCube Modules providing sensor functionality.
diff --git a/docs/html/group__KETCube__StarNet.html b/docs/html/group__KETCube__StarNet.html index 0353adc..ba25964 100644 --- a/docs/html/group__KETCube__StarNet.html +++ b/docs/html/group__KETCube__StarNet.html @@ -59,10 +59,13 @@
@@ -98,6 +101,8 @@ Hz for US, define: 915000000 Hz. + @@ -112,6 +117,8 @@
+dBm +Enumeration Type Documentationdiff --git a/docs/html/group__KETCube__StarNet__fn.html b/docs/html/group__KETCube__StarNet__fn.html index 7ea880e..f5427a3 100644 --- a/docs/html/group__KETCube__StarNet__fn.html +++ b/docs/html/group__KETCube__StarNet__fn.html @@ -214,7 +214,7 @@
|
( | ) | -KETCUBE_TERMINAL_PRINTF("\r \r") | +ketCube_terminal_ClearCmdLine() |
#define KETCUBE_TERMINAL_DEBUG FALSE /*<! Turn ON/OFF low-level debug messages */ | +#define KETCUBE_TERMINAL_DEBUG FALSE /*<! Turn ON/OFF low-level debug messages */ |
#define KETCUBE_TERMINAL_ECHO TRUE /*<! Turn ON/OFF echo */ | +#define KETCUBE_TERMINAL_ECHO TRUE /*<! Turn ON/OFF echo */ |
#define KETCUBE_TERMINAL_MODDEBUG TRUE /*<! Turn ON/OFF structured debug messages */ | +#define KETCUBE_TERMINAL_MODDEBUG TRUE /*<! Turn ON/OFF structured debug messages */ |
void ketCube_terminal_ClearCmdLine | +( | +void | +) | ++ |
Clear command line.
+Use to clear user input and prompt
+ +void ketCube_terminal_CoreSeverityPrintln | +( | +ketCube_severity_t | +msgSeverity, | +
+ | + | char * | +format, | +
+ | + | + | ... | +
+ | ) | ++ |
Print Debug info to serial line + newline.
+msgSeverity | mesage severity |
format | printf-style format string |
args |
Print Debug info to serial line.
+Print Debug info to serial line + newline.
+void ketCube_terminal_ModSeverityPrintln | +( | +ketCube_severity_t | +msgSeverity, | +
+ | + | ketCube_cfg_moduleIDs_t | +modId, | +
+ | + | char * | +format, | +
+ | + | va_list | +args | +
+ | ) | ++ |
Print Debug info to serial line + newline.
+msgSeverity | mesage severity |
modID | mesage origin moduleID |
format | printf-style format string |
args | va_list |
Print current unfinished command.
-Use when it is necessary to print something and not to disrupt
+Use when it is necessary to print something and not to disrupt current command
+ + + + +void ketCube_terminal_UsartPrint | +( | +char * | +format, | +
+ | + | + | ... | +
+ | ) | ++ |
List of KETCube terminal commands.
- diff --git a/docs/html/group__KETCube__Terminal__SeverityPrintFn.html b/docs/html/group__KETCube__Terminal__SeverityPrintFn.html new file mode 100644 index 0000000..634d471 --- /dev/null +++ b/docs/html/group__KETCube__Terminal__SeverityPrintFn.html @@ -0,0 +1,243 @@ + + + + + + + +
+ KETCube
+
+ |
+
KETCube Terminal Severity print functions. +More...
++Functions | |
static void | ketCube_terminal_AlwaysPrintln (ketCube_cfg_moduleIDs_t modId, char *format,...) |
static void | ketCube_terminal_NewDebugPrintln (ketCube_cfg_moduleIDs_t modId, char *format,...) |
static void | ketCube_terminal_ErrorPrintln (ketCube_cfg_moduleIDs_t modId, char *format,...) |
static void | ketCube_terminal_InfoPrintln (ketCube_cfg_moduleIDs_t modId, char *format,...) |
KETCube Terminal Severity print functions.
+The following functions enable severity-configurable printing
+
+
|
+ +inlinestatic | +
+
|
+ +inlinestatic | +
+
|
+ +inlinestatic | +
+
|
+ +inlinestatic | +
+ KETCube
+
+ |
+
KETCube Timer module. +More...
++Modules | |
Public Functions | |
Public functions. | |
+Data Structures | |
struct | ketCube_Timer_usage_t |
Timer Usage. More... | |
+Enumerations | |
enum | ketCube_Timer_list_t { + KETCUBE_TIMER_LIST_TIM2, +KETCUBE_TIMER_LIST_TIM3, +KETCUBE_TIMER_LIST_TIM21, +KETCUBE_TIMER_LIST_TIM22, + + KETCUBE_TIMER_LIST_TIM6, +KETCUBE_TIMER_LIST_TIM7, +KETCUBE_TIMER_LIST_LPTIM, +KETCUBE_TIMER_LIST_CNT + + } |
List of available timers. More... | |
KETCube Timer module.
+enum ketCube_Timer_list_t | +
List of available timers.
+Enumerator | |
---|---|
KETCUBE_TIMER_LIST_TIM2 | 16-bit auto-reload up/down counter + |
KETCUBE_TIMER_LIST_TIM3 | 16-bit auto-reload up/down counter + |
KETCUBE_TIMER_LIST_TIM21 | 16-bit auto-reload up/down counter. + |
KETCUBE_TIMER_LIST_TIM22 | 16-bit auto-reload up/down counter. + |
KETCUBE_TIMER_LIST_TIM6 | A generic 16-bit timebase. + |
KETCUBE_TIMER_LIST_TIM7 | A generic 16-bit timebase. + |
KETCUBE_TIMER_LIST_LPTIM | The low-power timer. + |
KETCUBE_TIMER_LIST_CNT | of timers+ |
+ KETCube
+
+ |
+
Public functions. +More...
++Functions | |
ketCube_cfg_ModError_t | ketCube_Timer_Init (ketCube_Timer_list_t tim) |
Configures Timer(s) More... | |
Public functions.
+ketCube_cfg_ModError_t ketCube_Timer_Init | +( | +ketCube_Timer_list_t | +tim | ) | ++ |
Configures Timer(s)
+tim | requested timer |
KETCUBE_CFG_MODULE_OK | in case of success |
KETCUBE_CFG_MODULE_ERROR | in case of failure – requested timer already used; resource not available |
UART supported channels.
+Enumerator | |||
---|---|---|---|
KETCUBE_UART_CHANNEL_1 | |||
KETCUBE_UART_CHANNEL_2 |
ketCube_cfg_ModError_t ketCube_UART_ReleasePin | +( | +uint32_t | +pin, | +
+ | + | GPIO_TypeDef * | +port | +
+ | ) | ++ |
Release pin - setup as input pin.
+This can help in low-power modes to avoid leakage when uart pin(s) drive(s) something.
+pin | pin number |
port | port in which the pin resembles |
KETCUBE_CFG_MODULE_OK | in case of success |
KETCUBE_CFG_MODULE_ERROR | in case of failure |
void ketCube_UART_TransmitCallback | +( | +ketCube_UART_ChannelNo_t | +channel | ) | ++ |
+ KETCube
+
+ |
+
KETCube batMeas cnt module. +More...
++Modules | |
Public Functions | |
+Data Structures | |
struct | ketCube_batMeas_battery_t |
KETCube battery deffinition. More... | |
+Typedefs | |
typedef struct ketCube_batMeas_battery_t | ketCube_batMeas_battery_t |
KETCube battery deffinition. More... | |
+Enumerations | |
enum | ketCube_batMeas_cfgAdr_t { KETCUBE_BATMEAS_CFGADR_CFG = 0, +KETCUBE_BATMEAS_CFGADR_BAT = 1 + } |
enumerator of M-BUS configuration options addresses More... | |
enum | ketCube_batMeas_cfgLen_t { KETCUBE_BATMEAS_CFGLEN_CFG = 1, +KETCUBE_BATMEAS_CFGLEN_BAT = 1 + } |
enumerator of M-BUS configuration options lengths More... | |
enum | ketCube_batMeas_battList_t { KETCUBE_BATMEAS_BATLIST_CR2032 = 0, +KETCUBE_BATMEAS_BATLIST_LS33600, +KETCUBE_BATMEAS_BATLIST_LAST + } |
List of available S0 errors. More... | |
+Variables | |
ketCube_batMeas_battery_t | ketCube_batMeas_batList [] |
List of supported batteries. More... | |
uint8_t | ketCube_batMeas_selectedBattery |
KETCube batMeas cnt module.
+typedef struct ketCube_batMeas_battery_t ketCube_batMeas_battery_t | +
KETCube battery deffinition.
+ +enum ketCube_batMeas_battList_t | +
enum ketCube_batMeas_cfgAdr_t | +
enum ketCube_batMeas_cfgLen_t | +
ketCube_batMeas_battery_t ketCube_batMeas_batList[] | +
List of supported batteries.
+ +uint8_t ketCube_batMeas_selectedBattery | +
+ KETCube
+
+ |
+
+Functions | |
ketCube_cfg_ModError_t | ketCube_batMeas_Init (ketCube_InterModMsg_t ***msg) |
Configures S0 Counter(s) More... | |
ketCube_cfg_ModError_t | ketCube_batMeas_ReadData (uint8_t *buffer, uint8_t *len) |
Read battery data. More... | |
ketCube_cfg_ModError_t ketCube_batMeas_Init | +( | +ketCube_InterModMsg_t *** | +msg | ) | ++ |
Configures S0 Counter(s)
+KETCUBE_CFG_MODULE_OK | in case of success |
KETCUBE_CFG_MODULE_ERROR | in case of failure |
ketCube_cfg_ModError_t ketCube_batMeas_ReadData | +( | +uint8_t * | +buffer, | +
+ | + | uint8_t * | +len | +
+ | ) | ++ |
Read battery data.
+buffer | pointer to fuffer for storing the result of milivolt mesurement |
len | data len in bytes |
KETCUBE_CFG_MODULE_OK | in case of success |
KETCUBE_CFG_MODULE_ERROR | in case of failure |
KETCube Configuration Manager. More...
-Modules | |
Included KETCube Modules | |
Data Structures | |
struct | ketCube_InterModMsg_t |
typedef struct ketCube_InterModMsg_t | ketCube_InterModMsg_t |
KETCube inter-module message. More... | |
typedef enum ketCube_severity_t | ketCube_severity_t |
KETCube debug severity definition. More... | |
typedef ketCube_cfg_ModError_t(* | ketCube_cfg_ModVoidFn_t) (void) |
Pointer to function returning ketCube_cfg_ModError_t. More... | |
Enumerations | |
enum | ketCube_cfg_moduleIDs_t { - KETCUBE_LISTS_MODULEID_LORA, -KETCUBE_LISTS_MODULEID_DEBUGDISPLAY, -KETCUBE_LISTS_MODULEID_HDC1080, -KETCUBE_LISTS_MODULEID_BATMEAS, - - KETCUBE_LISTS_MODULEID_ADC, -KETCUBE_LISTS_MODULEID_STARNET_CONCENTRATOR, -KETCUBE_LISTS_MODULEID_STARNET_NODE, -KETCUBE_LISTS_MODULEID_FDC2214, - - KETCUBE_LISTS_MODULEID_RXDISPLAY, -KETCUBE_LISTS_MODULEID_LAST - - } |
List of module Indeces. More... | |
enum | ketCube_cfg_AllocEEPROM_t { KETCUBE_EEPROM_ALLOC_CORE = 0, KETCUBE_EEPROM_ALLOC_MODULES = 64 } |
Error code type. More... | |
enum | ketCube_cfg_DrvError_t { KETCUBE_CFG_DRV_OK = (uint8_t) 0, +KETCUBE_CFG_DRV_ERROR = !(KETCUBE_CFG_MODULE_OK) + } |
Error code type. More... | |
enum | ketCube_severity_t { KETCUBE_CFG_SEVERITY_NONE = 0x0, +KETCUBE_CFG_SEVERITY_ERROR = 0x1, +KETCUBE_CFG_SEVERITY_INFO = 0x2, +KETCUBE_CFG_SEVERITY_DEBUG = 0x3 + } |
KETCube debug severity definition. More... | |
Functions | |
ketCube_cfg_Error_t | ketCube_cfg_Load (uint8_t *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
ketCube_cfg_Error_t | ketCube_cfg_Load (uint8_t *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
Load configuration data from EEPROM. More... | |
ketCube_cfg_Error_t | ketCube_cfg_LoadStr (char *data, uint8_t buffLen, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
ketCube_cfg_Error_t | ketCube_cfg_LoadStr (char *data, uint8_t buffLen, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
Load configuration data from EEPROM to string. More... | |
ketCube_cfg_Error_t | ketCube_cfg_Save (uint8_t *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
ketCube_cfg_Error_t | ketCube_cfg_Save (uint8_t *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
Save configuration data to EEPROM. More... | |
ketCube_cfg_Error_t | ketCube_cfg_SaveStr (char *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
ketCube_cfg_Error_t | ketCube_cfg_SaveStr (char *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
Save configuration data to EEPROM from string. More... | |
typedef enum ketCube_severity_t ketCube_severity_t | +
KETCube debug severity definition.
+enum ketCube_cfg_DrvError_t | +
enum ketCube_cfg_moduleIDs_t | +enum ketCube_severity_t |
List of module Indeces.
+KETCube debug severity definition.
Enumerator | |
---|---|
KETCUBE_LISTS_MODULEID_LORA | |
KETCUBE_LISTS_MODULEID_DEBUGDISPLAY | |
KETCUBE_LISTS_MODULEID_HDC1080 | |
KETCUBE_LISTS_MODULEID_BATMEAS | |
KETCUBE_LISTS_MODULEID_ADC | |
KETCUBE_LISTS_MODULEID_STARNET_CONCENTRATOR | |
KETCUBE_LISTS_MODULEID_STARNET_NODE | |
KETCUBE_LISTS_MODULEID_FDC2214 | |
KETCUBE_LISTS_MODULEID_RXDISPLAY | |
KETCUBE_LISTS_MODULEID_LAST | |
Enumerator | |
KETCUBE_CFG_SEVERITY_NONE | |
KETCUBE_CFG_SEVERITY_ERROR | |
KETCUBE_CFG_SEVERITY_INFO | |
KETCUBE_CFG_SEVERITY_DEBUG |
Functions | |
static void | ketCube_common_Dec2int (int32_t *output, char *str, uint8_t len) |
Convert DEC string to 4 byte signed integer. More... | |
static uint8_t | ketCube_common_Min (uint8_t a, uint8_t b) |
Return minimum of two bytes. More... | |
static uint8_t | ketCube_common_Max (uint8_t a, uint8_t b) |
Return maximum of two bytes. More... | |
static uint16_t | ketCube_common_Med (uint16_t *values, uint16_t size) |
Return median from an array of shorts. More... | |
static uint16_t | ketCube_common_Avg (uint16_t *values, uint16_t size) |
Return median from an array of shorts. More... | |
static uint16_t | ketCube_common_swapW (uint16_t n) |
Swap word (16-bit) values. More... | |
static void | ketCube_common_BasicErrorHandler () |
Basic Error Handler. More... | |
+Variables | |
char | ketCube_common_buffer [] |
KETCube Common deffinitions nd inline functions.
@@ -93,6 +121,22 @@boolean FALSE
+ +#define KETCUBE_COMMON_BUFFER_LEN 50 | +
boolean TRUE
+
+
|
+ +inlinestatic | +
Return median from an array of shorts.
+values | shorts array |
size | array size |
avg | median |
+
|
+ +inlinestatic | +
Basic Error Handler.
+ +
+
|
+ +inlinestatic | +
Return maximum of two bytes.
+a | a number |
b | a number |
max | maximum |
+
|
+ +inlinestatic | +
Return median from an array of shorts.
+values | shorts array |
size | array size |
med | median |
+
|
+ +inlinestatic | +
Return minimum of two bytes.
+a | a number |
b | a number |
min | minimum |
+
|
+ +inlinestatic | +
Swap word (16-bit) values.
+This is intended for conversion when different Endianity is used
+n | a 16-bit number |
n | with swapped bytes |
char ketCube_common_buffer[] | +
Shared buffer for common usage anywhere.
+Macros | |
#define | KETCUBE_CORECFG_MIN_BASEPERIOD 500 |
#define | KETCUBE_CORECFG_SKIP_SLEEP_PERIOD FALSE |
Skip sleep period (perform sensing at maximum speed) More... | |
#define | KETCUBE_CORECFG_MIN_BASEPERIOD 5000 |
Minimal period for periodic events. More... | |
#define | KETCUBE_CORECFG_MIN_STARTDELAY 500 |
#define | KETCUBE_CORECFG_MIN_STARTDELAY 1000 |
Minimal delay - the first periodic action is run at this time after power-on. More... | |
#define | KETCUBE_CORECFG_DEFAULT_SEVERITY KETCUBE_CFG_SEVERITY_ERROR |
Default KETCube core severity. More... | |
Enumerations | |
enum | ketCube_coreCfg_Addr_t { KETCUBE_CORECFG_ADR_BASEPERIOD = 0, -KETCUBE_CORECFG_ADR_STARTDELAY = 4 +KETCUBE_CORECFG_ADR_STARTDELAY = 4, +KETCUBE_CORECFG_ADR_SEVERITY = 8 } |
Core CFG data relative addr. More... | |
Variables | |
uint32_t | ketCube_coreCfg_BasePeriod |
This period is used by KETCube core to run periodic events. More... | |
uint32_t | ketCube_coreCfg_StartDelay |
This delay is used instead ketCube_coreCfg_BasePeriod to run periodic events at the first time. More... | |
ketCube_severity_t | ketCube_coreCfg_severity |
Core messages severity. More... | |
KETCube Core configuration.
#define KETCUBE_CORECFG_DEFAULT_SEVERITY KETCUBE_CFG_SEVERITY_ERROR | +
Default KETCube core severity.
+ +#define KETCUBE_CORECFG_MIN_BASEPERIOD 500 | +#define KETCUBE_CORECFG_MIN_BASEPERIOD 5000 |
Minimal period for periodic events.
+#define KETCUBE_CORECFG_MIN_STARTDELAY 500 | +#define KETCUBE_CORECFG_MIN_STARTDELAY 1000 | +
Minimal delay - the first periodic action is run at this time after power-on.
+ +#define KETCUBE_CORECFG_SKIP_SLEEP_PERIOD FALSE |
Skip sleep period (perform sensing at maximum speed)
+This period is used by KETCube core to run periodic events.
+ + + + +ketCube_severity_t ketCube_coreCfg_severity | +
Core messages severity.
+This delay is used instead ketCube_coreCfg_BasePeriod to run periodic events at the first time.
+ diff --git a/docs/html/group__KETCube__inc__mod.html b/docs/html/group__KETCube__inc__mod.html deleted file mode 100644 index c76e109..0000000 --- a/docs/html/group__KETCube__inc__mod.html +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - - -
- KETCube
-
- |
-
-Macros | |
#define | KETCUBE_CFG_INC_MOD_LORA |
#define | KETCUBE_CFG_INC_MOD_DEBUGDISPLAY |
#define | KETCUBE_CFG_INC_MOD_HDC1080 |
#define | KETCUBE_CFG_INC_MOD_BATMEAS |
#define | KETCUBE_CFG_INC_MOD_ADC |
#define | KETCUBE_CFG_INC_MOD_STARNET |
#define | KETCUBE_CFG_INC_MOD_FDC2214 |
#define | KETCUBE_CFG_INC_MOD_RXDISPLAY |
Define/undefine to include/exclude KETCube modules
-#define KETCUBE_CFG_INC_MOD_ADC | -
#define KETCUBE_CFG_INC_MOD_BATMEAS | -
#define KETCUBE_CFG_INC_MOD_DEBUGDISPLAY | -
#define KETCUBE_CFG_INC_MOD_FDC2214 | -
#define KETCUBE_CFG_INC_MOD_HDC1080 | -
#define KETCUBE_CFG_INC_MOD_LORA | -
#define KETCUBE_CFG_INC_MOD_RXDISPLAY | -
#define KETCUBE_CFG_INC_MOD_STARNET | -
KETCube Configuration Manager. More...
-Macros | |
#define | KETCUBE_MAIN_BOARD_LED1_PIN GPIO_PIN_5 |
#define | KETCUBE_MAIN_BOARD_LED1_GPIO_PORT GPIOB |
#define | KETCUBE_MAIN_BOARD_LED1_GPIO_CLK_ENABLE() __HAL_RCC_GPIOB_CLK_ENABLE() |
#define | KETCUBE_MAIN_BOARD_LED1_GPIO_CLK_DISABLE() __HAL_RCC_GPIOB_CLK_DISABLE() |
#define | KETCUBE_MAIN_BOARD_LED1_On() HAL_GPIO_WritePin(KETCUBE_MAIN_BOARD_LED1_GPIO_PORT, KETCUBE_MAIN_BOARD_LED1_PIN, GPIO_PIN_SET) |
#define | KETCUBE_MAIN_BOARD_LED1_Off() HAL_GPIO_WritePin(KETCUBE_MAIN_BOARD_LED1_GPIO_PORT, KETCUBE_MAIN_BOARD_LED1_PIN, GPIO_PIN_RESET) |
#define | KETCUBE_MAIN_BOARD_LED1_Toggle() HAL_GPIO_TogglePin(KETCUBE_MAIN_BOARD_LED1_GPIO_PORT, KETCUBE_MAIN_BOARD_LED1_PIN) |
#define | KETCUBE_MAIN_BOARD_LED2_PIN GPIO_PIN_6 |
#define | KETCUBE_MAIN_BOARD_LED2_GPIO_PORT GPIOB |
#define | KETCUBE_MAIN_BOARD_LED2_GPIO_CLK_ENABLE() __HAL_RCC_GPIOB_CLK_ENABLE() |
#define | KETCUBE_MAIN_BOARD_LED2_GPIO_CLK_DISABLE() __HAL_RCC_GPIOB_CLK_DISABLE() |
#define | KETCUBE_MAIN_BOARD_LED2_On() HAL_GPIO_WritePin(KETCUBE_MAIN_BOARD_LED2_GPIO_PORT, KETCUBE_MAIN_BOARD_LED2_PIN, GPIO_PIN_SET) |
#define | KETCUBE_MAIN_BOARD_LED2_Off() HAL_GPIO_WritePin(KETCUBE_MAIN_BOARD_LED2_GPIO_PORT, KETCUBE_MAIN_BOARD_LED2_PIN, GPIO_PIN_RESET) |
#define | KETCUBE_MAIN_BOARD_LED2_Toggle() HAL_GPIO_TogglePin(KETCUBE_MAIN_BOARD_LED2_GPIO_PORT, KETCUBE_MAIN_BOARD_LED2_PIN) |
+Modules | |
KETCube options | |
KETCube mainBoard Solder Jumpers and optional parts. | |
Socket PINs | |
KETCube mainBoard SOCKET PINs. | |
Debug LEDs | |
KETCube mainBoard Debug LEDs. | |
-Functions | |
static void | ketCube_MainBoard_LED1_Init () |
static void | ketCube_MainBoard_LED2_Init () |
+Enumerations | |
enum | ketCube_MainBoard_revs_t { + KETCUBE_MAIN_REV_A = 0, +KETCUBE_MAIN_REV_B, +KETCUBE_MAIN_REV_C, +KETCUBE_MAIN_REV_D, + + KETCUBE_MAIN_REV_E, +KETCUBE_MAIN_REV_DEV + + } |
Main Board revisions. More... | |
enum | ketCube_MainBoard_SJ_t { KETCUBE_MAIN_BOARD_SJ_OPEN = 0, +KETCUBE_MAIN_BOARD_SJ_12, +KETCUBE_MAIN_BOARD_SJ_23 + } |
Solder Jumper configuration options. More... | |
KETCube Configuration Manager.
This KETCube module incorporates the static in-code and NVM (EEPROM) configuration management
-#define KETCUBE_MAIN_BOARD_LED1_GPIO_CLK_DISABLE | -( | -) | -__HAL_RCC_GPIOB_CLK_DISABLE() | +enum ketCube_MainBoard_revs_t |
#define KETCUBE_MAIN_BOARD_LED1_GPIO_CLK_ENABLE | -( | -) | -__HAL_RCC_GPIOB_CLK_ENABLE() | -
#define KETCUBE_MAIN_BOARD_LED1_GPIO_PORT GPIOB | -
#define KETCUBE_MAIN_BOARD_LED1_Off | -( | -) | -HAL_GPIO_WritePin(KETCUBE_MAIN_BOARD_LED1_GPIO_PORT, KETCUBE_MAIN_BOARD_LED1_PIN, GPIO_PIN_RESET) | -
#define KETCUBE_MAIN_BOARD_LED1_On | -( | -) | -HAL_GPIO_WritePin(KETCUBE_MAIN_BOARD_LED1_GPIO_PORT, KETCUBE_MAIN_BOARD_LED1_PIN, GPIO_PIN_SET) | -
#define KETCUBE_MAIN_BOARD_LED1_PIN GPIO_PIN_5 | -
#define KETCUBE_MAIN_BOARD_LED1_Toggle | -( | -) | -HAL_GPIO_TogglePin(KETCUBE_MAIN_BOARD_LED1_GPIO_PORT, KETCUBE_MAIN_BOARD_LED1_PIN) | -
#define KETCUBE_MAIN_BOARD_LED2_GPIO_CLK_DISABLE | -( | -) | -__HAL_RCC_GPIOB_CLK_DISABLE() | -
#define KETCUBE_MAIN_BOARD_LED2_GPIO_CLK_ENABLE | -( | -) | -__HAL_RCC_GPIOB_CLK_ENABLE() | -
#define KETCUBE_MAIN_BOARD_LED2_GPIO_PORT GPIOB | -
#define KETCUBE_MAIN_BOARD_LED2_Off | -( | -) | -HAL_GPIO_WritePin(KETCUBE_MAIN_BOARD_LED2_GPIO_PORT, KETCUBE_MAIN_BOARD_LED2_PIN, GPIO_PIN_RESET) | -
#define KETCUBE_MAIN_BOARD_LED2_On | -( | -) | -HAL_GPIO_WritePin(KETCUBE_MAIN_BOARD_LED2_GPIO_PORT, KETCUBE_MAIN_BOARD_LED2_PIN, GPIO_PIN_SET) | -
#define KETCUBE_MAIN_BOARD_LED2_PIN GPIO_PIN_6 | -
#define KETCUBE_MAIN_BOARD_LED2_Toggle | -( | -) | -HAL_GPIO_TogglePin(KETCUBE_MAIN_BOARD_LED2_GPIO_PORT, KETCUBE_MAIN_BOARD_LED2_PIN) | -
|
- -inlinestatic | -
-
|
- -inlinestatic | -
Enumerator | |
---|---|
KETCUBE_MAIN_BOARD_SJ_OPEN | Solder jumper is OPEN. + |
KETCUBE_MAIN_BOARD_SJ_12 | Solder jumper PADs 1 and 2 are CLOSED (this holds for all solder jumpers) + |
KETCUBE_MAIN_BOARD_SJ_23 | Solder jumper PADs 2 and 3 are CLOSED (this holds for 3-PAD solder jumpers) + |
+ KETCube
+
+ |
+
KETCube mainBoard Debug LEDs. +More...
++Macros | |
#define | KETCUBE_MAIN_BOARD_LED1_PIN KETCUBE_GPIO_PIN_5 |
#define | KETCUBE_MAIN_BOARD_LED1_GPIO_PORT KETCUBE_GPIO_PB |
#define | KETCUBE_MAIN_BOARD_LED2_PIN KETCUBE_GPIO_PIN_6 |
#define | KETCUBE_MAIN_BOARD_LED2_GPIO_PORT KETCUBE_GPIO_PB |
KETCube mainBoard Debug LEDs.
+#define KETCUBE_MAIN_BOARD_LED1_GPIO_PORT KETCUBE_GPIO_PB | +
#define KETCUBE_MAIN_BOARD_LED1_PIN KETCUBE_GPIO_PIN_5 | +
#define KETCUBE_MAIN_BOARD_LED2_GPIO_PORT KETCUBE_GPIO_PB | +
#define KETCUBE_MAIN_BOARD_LED2_PIN KETCUBE_GPIO_PIN_6 | +
+ KETCube
+
+ |
+
KETCube mainBoard Solder Jumpers and optional parts. +More...
++Macros | |
#define | KETCUBE_MAIN_BOARD_REV (KETCUBE_MAIN_REV_DEV - 1) |
The current board revision,. More... | |
#define | KETCUBE_MAIN_BOARD_OPTION_SJ1 KETCUBE_MAIN_BOARD_SJ_12 |
Connect PA8 to IO3. More... | |
#define | KETCUBE_MAIN_BOARD_OPTION_SJ7 KETCUBE_MAIN_BOARD_SJ_OPEN |
Connect Vref to IO3. More... | |
#define | KETCUBE_MAIN_BOARD_OPTION_SJ2 KETCUBE_MAIN_BOARD_SJ_12 |
MuRaTa radio powered. More... | |
#define | KETCUBE_MAIN_BOARD_OPTION_SJ3 KETCUBE_MAIN_BOARD_SJ_12 |
MuRaTa sleep Mode control. More... | |
#define | KETCUBE_MAIN_BOARD_OPTION_SJ8 KETCUBE_MAIN_BOARD_SJ_OPEN |
MuRaTa sleep Mode control. More... | |
#define | KETCUBE_MAIN_BOARD_OPTION_SJ5 KETCUBE_MAIN_BOARD_SJ_12 |
HDC1080 connected. More... | |
#define | KETCUBE_MAIN_BOARD_OPTION_SJ6 KETCUBE_MAIN_BOARD_SJ_12 |
HDC1080 connected. More... | |
#define | KETCUBE_MAIN_BOARD_OPTION_SJ9 KETCUBE_MAIN_BOARD_SJ_23 |
12 == NRST to IO4; 23 == PA5 to IO4 More... | |
#define | KETCUBE_MAIN_BOARD_OPTION_SJ10 KETCUBE_MAIN_BOARD_SJ_12 |
Vref to 3V3. More... | |
KETCube mainBoard Solder Jumpers and optional parts.
+#define KETCUBE_MAIN_BOARD_OPTION_SJ1 KETCUBE_MAIN_BOARD_SJ_12 | +
Connect PA8 to IO3.
+ +#define KETCUBE_MAIN_BOARD_OPTION_SJ10 KETCUBE_MAIN_BOARD_SJ_12 | +
Vref to 3V3.
+ +#define KETCUBE_MAIN_BOARD_OPTION_SJ2 KETCUBE_MAIN_BOARD_SJ_12 | +
MuRaTa radio powered.
+ +#define KETCUBE_MAIN_BOARD_OPTION_SJ3 KETCUBE_MAIN_BOARD_SJ_12 | +
MuRaTa sleep Mode control.
+ +#define KETCUBE_MAIN_BOARD_OPTION_SJ5 KETCUBE_MAIN_BOARD_SJ_12 | +
HDC1080 connected.
+ +#define KETCUBE_MAIN_BOARD_OPTION_SJ6 KETCUBE_MAIN_BOARD_SJ_12 | +
HDC1080 connected.
+ +#define KETCUBE_MAIN_BOARD_OPTION_SJ7 KETCUBE_MAIN_BOARD_SJ_OPEN | +
Connect Vref to IO3.
+ +#define KETCUBE_MAIN_BOARD_OPTION_SJ8 KETCUBE_MAIN_BOARD_SJ_OPEN | +
MuRaTa sleep Mode control.
+ +#define KETCUBE_MAIN_BOARD_OPTION_SJ9 KETCUBE_MAIN_BOARD_SJ_23 | +
12 == NRST to IO4; 23 == PA5 to IO4
+ +#define KETCUBE_MAIN_BOARD_REV (KETCUBE_MAIN_REV_DEV - 1) | +
The current board revision,.
+
+ KETCube
+
+ |
+
KETCube mainBoard SOCKET PINs. +More...
++Macros | |
#define | KETCUBE_MAIN_BOARD_PIN_IO1_PIN KETCUBE_GPIO_PIN_10 |
#define | KETCUBE_MAIN_BOARD_PIN_IO1_PORT KETCUBE_GPIO_PA |
#define | KETCUBE_MAIN_BOARD_PIN_IO2_PIN KETCUBE_GPIO_PIN_9 |
#define | KETCUBE_MAIN_BOARD_PIN_IO2_PORT KETCUBE_GPIO_PA |
#define | KETCUBE_MAIN_BOARD_PIN_IO3_PIN KETCUBE_GPIO_PIN_8 |
#define | KETCUBE_MAIN_BOARD_PIN_IO3_PORT KETCUBE_GPIO_PA |
#define | KETCUBE_MAIN_BOARD_PIN_IO4_PIN KETCUBE_GPIO_PIN_5 |
#define | KETCUBE_MAIN_BOARD_PIN_IO4_PORT KETCUBE_GPIO_PA |
#define | KETCUBE_MAIN_BOARD_PIN_AN_PIN KETCUBE_GPIO_PIN_4 |
#define | KETCUBE_MAIN_BOARD_PIN_AN_PORT KETCUBE_GPIO_PA |
#define | KETCUBE_MAIN_BOARD_PIN_RST_PIN KETCUBE_GPIO_PIN_0 |
#define | KETCUBE_MAIN_BOARD_PIN_RST_PORT KETCUBE_GPIO_PA |
#define | KETCUBE_MAIN_BOARD_PIN_CS_PIN KETCUBE_GPIO_PIN_12 |
#define | KETCUBE_MAIN_BOARD_PIN_CS_PORT KETCUBE_GPIO_PB |
#define | KETCUBE_MAIN_BOARD_PIN_SCK_PIN KETCUBE_GPIO_PIN_13 |
#define | KETCUBE_MAIN_BOARD_PIN_SCK_PORT KETCUBE_GPIO_PB |
#define | KETCUBE_MAIN_BOARD_PIN_MISO_PIN KETCUBE_GPIO_PIN_14 |
#define | KETCUBE_MAIN_BOARD_PIN_MISO_PORT KETCUBE_GPIO_PB |
#define | KETCUBE_MAIN_BOARD_PIN_MOSI_PIN KETCUBE_GPIO_PIN_15 |
#define | KETCUBE_MAIN_BOARD_PIN_MOSI_PORT KETCUBE_GPIO_PB |
#define | KETCUBE_MAIN_BOARD_PIN_PWM_PIN KETCUBE_GPIO_PIN_2 |
#define | KETCUBE_MAIN_BOARD_PIN_PWM_PORT KETCUBE_GPIO_PB |
#define | KETCUBE_MAIN_BOARD_PIN_INT_PIN KETCUBE_GPIO_PIN_7 |
#define | KETCUBE_MAIN_BOARD_PIN_INT_PORT KETCUBE_GPIO_PB |
#define | KETCUBE_MAIN_BOARD_PIN_RX_PIN KETCUBE_GPIO_PIN_3 |
#define | KETCUBE_MAIN_BOARD_PIN_RX_PORT KETCUBE_GPIO_PA |
#define | KETCUBE_MAIN_BOARD_PIN_TX_PIN KETCUBE_GPIO_PIN_2 |
#define | KETCUBE_MAIN_BOARD_PIN_TX_PORT KETCUBE_GPIO_PA |
#define | KETCUBE_MAIN_BOARD_PIN_SCL_PIN KETCUBE_GPIO_PIN_8 |
#define | KETCUBE_MAIN_BOARD_PIN_SCL_PORT KETCUBE_GPIO_PB |
#define | KETCUBE_MAIN_BOARD_PIN_SDA_PIN KETCUBE_GPIO_PIN_9 |
#define | KETCUBE_MAIN_BOARD_PIN_SDA_PORT KETCUBE_GPIO_PB |
KETCube mainBoard SOCKET PINs.
+#define KETCUBE_MAIN_BOARD_PIN_AN_PIN KETCUBE_GPIO_PIN_4 | +
#define KETCUBE_MAIN_BOARD_PIN_AN_PORT KETCUBE_GPIO_PA | +
#define KETCUBE_MAIN_BOARD_PIN_CS_PIN KETCUBE_GPIO_PIN_12 | +
#define KETCUBE_MAIN_BOARD_PIN_CS_PORT KETCUBE_GPIO_PB | +
#define KETCUBE_MAIN_BOARD_PIN_INT_PIN KETCUBE_GPIO_PIN_7 | +
#define KETCUBE_MAIN_BOARD_PIN_INT_PORT KETCUBE_GPIO_PB | +
#define KETCUBE_MAIN_BOARD_PIN_IO1_PIN KETCUBE_GPIO_PIN_10 | +
#define KETCUBE_MAIN_BOARD_PIN_IO1_PORT KETCUBE_GPIO_PA | +
#define KETCUBE_MAIN_BOARD_PIN_IO2_PIN KETCUBE_GPIO_PIN_9 | +
#define KETCUBE_MAIN_BOARD_PIN_IO2_PORT KETCUBE_GPIO_PA | +
#define KETCUBE_MAIN_BOARD_PIN_IO3_PIN KETCUBE_GPIO_PIN_8 | +
#define KETCUBE_MAIN_BOARD_PIN_IO3_PORT KETCUBE_GPIO_PA | +
#define KETCUBE_MAIN_BOARD_PIN_IO4_PIN KETCUBE_GPIO_PIN_5 | +
#define KETCUBE_MAIN_BOARD_PIN_IO4_PORT KETCUBE_GPIO_PA | +
#define KETCUBE_MAIN_BOARD_PIN_MISO_PIN KETCUBE_GPIO_PIN_14 | +
#define KETCUBE_MAIN_BOARD_PIN_MISO_PORT KETCUBE_GPIO_PB | +
#define KETCUBE_MAIN_BOARD_PIN_MOSI_PIN KETCUBE_GPIO_PIN_15 | +
#define KETCUBE_MAIN_BOARD_PIN_MOSI_PORT KETCUBE_GPIO_PB | +
#define KETCUBE_MAIN_BOARD_PIN_PWM_PIN KETCUBE_GPIO_PIN_2 | +
#define KETCUBE_MAIN_BOARD_PIN_PWM_PORT KETCUBE_GPIO_PB | +
#define KETCUBE_MAIN_BOARD_PIN_RST_PIN KETCUBE_GPIO_PIN_0 | +
#define KETCUBE_MAIN_BOARD_PIN_RST_PORT KETCUBE_GPIO_PA | +
#define KETCUBE_MAIN_BOARD_PIN_RX_PIN KETCUBE_GPIO_PIN_3 | +
#define KETCUBE_MAIN_BOARD_PIN_RX_PORT KETCUBE_GPIO_PA | +
#define KETCUBE_MAIN_BOARD_PIN_SCK_PIN KETCUBE_GPIO_PIN_13 | +
#define KETCUBE_MAIN_BOARD_PIN_SCK_PORT KETCUBE_GPIO_PB | +
#define KETCUBE_MAIN_BOARD_PIN_SCL_PIN KETCUBE_GPIO_PIN_8 | +
#define KETCUBE_MAIN_BOARD_PIN_SCL_PORT KETCUBE_GPIO_PB | +
#define KETCUBE_MAIN_BOARD_PIN_SDA_PIN KETCUBE_GPIO_PIN_9 | +
#define KETCUBE_MAIN_BOARD_PIN_SDA_PORT KETCUBE_GPIO_PB | +
#define KETCUBE_MAIN_BOARD_PIN_TX_PIN KETCUBE_GPIO_PIN_2 | +
#define KETCUBE_MAIN_BOARD_PIN_TX_PORT KETCUBE_GPIO_PA | +
+ KETCube
+
+ |
+
KETCube txDisplay module allows to vizualize KETCube Tx data. +More...
++Enumerations | |
enum | ketCube_txDisplay_cfgAddr_t { KETCUBE_TXDISPLAY_CFGADR_CFG = 0 + } |
txDisplay CFG data relative addr. More... | |
enum | ketCube_txDisplay_cfgLen_t { KETCUBE_TXDISPLAY_CFGLEN_CFG = 1 + } |
Length of txDisplay CFG data. More... | |
+Functions | |
ketCube_cfg_ModError_t | ketCube_txDisplay_Init (ketCube_InterModMsg_t ***msg) |
ketCube_cfg_ModError_t | ketCube_txDisplay_Send (uint8_t *buffer, uint8_t *len) |
KETCube txDisplay module allows to vizualize KETCube Tx data.
+enum ketCube_txDisplay_cfgAddr_t | +
enum ketCube_txDisplay_cfgLen_t | +
ketCube_cfg_ModError_t ketCube_txDisplay_Init | +( | +ketCube_InterModMsg_t *** | +msg | ) | ++ |
ketCube_cfg_ModError_t ketCube_txDisplay_Send | +( | +uint8_t * | +buffer, | +
+ | + | uint8_t * | +len | +
+ | ) | ++ |
The KETCube Actuating Modules group is currently empty.
KETCube Module Drivers provide functionality required by modules (drivers). They do not represent data IN/OUT functionality out of the KETCube platform bounds and they are MCU-specific but not external peripheral specific (e.g. I2C support).
-E.g.: if KETCube ADC (KETCube Sensing Modules) and KETCube LoRa (KETCube Communication Modules) modules are enabled, data produced by the ADC module are delivered thru LoRaWAN network to the cloud.
+Enable KETCube ADC (KETCube Sensing Modules) and KETCube LoRa (KETCube Communication Modules) modules. Set-up LoRa module and the LoRaWAN server appropriately. Data produced by the ADC module are now delivered thru LoRaWAN network to the cloud.
diff --git a/docs/html/ketCube__adc_8h_source.html b/docs/html/ketCube__adc_8h_source.html
index fc5baaf..165f80b 100644
--- a/docs/html/ketCube__adc_8h_source.html
+++ b/docs/html/ketCube__adc_8h_source.html
@@ -46,9 +46,9 @@
57 #define KETCUBE_ADC_VDDA_VREFINT_CAL ((uint32_t) 3000) //< Internal voltage reference was calibrated at 3V 58 #define KETCUBE_ADC_VREFINT_CAL_ADDR ((uint16_t*) ((uint32_t) 0x1FF80078)) //< Internal voltage reference calibration value VREFINT_CAL
+Go to the documentation of this file.This file contains definitions for the KETCube configuration. ketCube_cfg_ModError_t ketCube_ADC_Init(ketCube_InterModMsg_t ***msg) Configures ADC PIN. Definition: ketCube_adc.c:63 ketCube_cfg_ModError_t ketCube_ADC_ReadData(uint8_t *buffer, uint8_t *len) Get milivolt value form PA4. Definition: ketCube_adc.c:88
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ketCube_asyncTx.c File Reference
+
+
+
+This file contains the KETCube AsyncTx module. +More... +#include <string.h> + #include "ketCube_asyncTx.h" + #include "ketCube_lora.h" + #include "ketCube_common.h" + #include "ketCube_modules.h" + #include "ketCube_terminal.h" + Detailed Description+This file contains the KETCube AsyncTx module. + +
+ |
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.
+
+ KETCube
+
+ |
+
This file contains the KETCube AsyncTx module definitions. +More...
+ +Go to the source code of this file.
++Functions | |
ketCube_cfg_ModError_t | ketCube_AsyncTx_Init (ketCube_InterModMsg_t ***msg) |
ketCube_cfg_ModError_t | ketCube_AsyncTx_ProcessData (ketCube_InterModMsg_t *msg) |
This file contains the KETCube AsyncTx module definitions.
+ +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.
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
This file contains definitions for the KETCube batMeas module. +More...
+#include "stm32l0xx_hal.h"
#include "stm32l0xx_hal_lptim.h"
#include "hw.h"
#include "timeServer.h"
#include "ketCube_common.h"
#include "ketCube_timer.h"
#include "ketCube_batMeas.h"
#include "ketCube_terminal.h"
+Macros | |
#define | KETCUBE_BATMEAS_VDDA_VREFINT_CAL ((uint32_t) 3000) |
#define | KETCUBE_BATMEAS_VREFINT_CAL ((uint16_t*) ((uint32_t) 0x1FF80078)) |
+Functions | |
ketCube_cfg_ModError_t | ketCube_batMeas_Init (ketCube_InterModMsg_t ***msg) |
Configures S0 Counter(s) More... | |
ketCube_cfg_ModError_t | ketCube_batMeas_DeInit (ketCube_InterModMsg_t ***msg) |
DeInit buzzer Beacon. More... | |
uint8_t | ketcube_batLevel_GetBattery (void) |
This function returns the battery level. More... | |
ketCube_cfg_ModError_t | ketCube_batMeas_ReadData (uint8_t *buffer, uint8_t *len) |
Read battery data. More... | |
+Variables | |
ketCube_batMeas_battery_t | ketCube_batMeas_batList [] |
List of supported batteries. More... | |
uint8_t | ketCube_batMeas_selectedBattery = KETCUBE_BATMEAS_BATLIST_CR2032 |
This file contains definitions for the KETCube batMeas module.
+ +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.
+#define KETCUBE_BATMEAS_VDDA_VREFINT_CAL ((uint32_t) 3000) | +
#define KETCUBE_BATMEAS_VREFINT_CAL ((uint16_t*) ((uint32_t) 0x1FF80078)) | +
uint8_t ketcube_batLevel_GetBattery | +( | +void | +) | ++ |
This function returns the battery level.
+none |
battery | level scaled to 1B - 1 (very low) to 254 (fully charged) |
ketCube_cfg_ModError_t ketCube_batMeas_DeInit | +( | +ketCube_InterModMsg_t *** | +msg | ) | ++ |
DeInit buzzer Beacon.
+KETCUBE_CFG_MODULE_OK | in case of success |
KETCUBE_CFG_MODULE_ERROR | in case of failure |
+ KETCube
+
+ |
+
This file contains definitions for the KETCube batMeas module. +More...
+#include "ketCube_cfg.h"
Go to the source code of this file.
++Data Structures | |
struct | ketCube_batMeas_battery_t |
KETCube battery deffinition. More... | |
+Typedefs | |
typedef struct ketCube_batMeas_battery_t | ketCube_batMeas_battery_t |
KETCube battery deffinition. More... | |
+Enumerations | |
enum | ketCube_batMeas_cfgAdr_t { KETCUBE_BATMEAS_CFGADR_CFG = 0, +KETCUBE_BATMEAS_CFGADR_BAT = 1 + } |
enumerator of M-BUS configuration options addresses More... | |
enum | ketCube_batMeas_cfgLen_t { KETCUBE_BATMEAS_CFGLEN_CFG = 1, +KETCUBE_BATMEAS_CFGLEN_BAT = 1 + } |
enumerator of M-BUS configuration options lengths More... | |
enum | ketCube_batMeas_battList_t { KETCUBE_BATMEAS_BATLIST_CR2032 = 0, +KETCUBE_BATMEAS_BATLIST_LS33600, +KETCUBE_BATMEAS_BATLIST_LAST + } |
List of available S0 errors. More... | |
+Functions | |
ketCube_cfg_ModError_t | ketCube_batMeas_Init (ketCube_InterModMsg_t ***msg) |
Configures S0 Counter(s) More... | |
ketCube_cfg_ModError_t | ketCube_batMeas_ReadData (uint8_t *buffer, uint8_t *len) |
Read battery data. More... | |
+Variables | |
ketCube_batMeas_battery_t | ketCube_batMeas_batList [] |
List of supported batteries. More... | |
uint8_t | ketCube_batMeas_selectedBattery |
This file contains definitions for the KETCube batMeas module.
+ +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.
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
#include "ketCube_cfg.h"
#include "ketCube_common.h"
#include "ketCube_terminal.h"
#include "ketCube_batMeas.h"
+Macros | |
#define | __KETCUBE_BATMEAS_CMD_H |
+Functions | |
void | ketCube_terminal_cmd_set_batMeas_bat (void) |
void | ketCube_terminal_cmd_show_batMeas_bat (void) |
void | ketCube_terminal_cmd_show_batMeas_list (void) |
#define __KETCUBE_BATMEAS_CMD_H | +
void ketCube_terminal_cmd_set_batMeas_bat | +( | +void | +) | ++ |
void ketCube_terminal_cmd_show_batMeas_bat | +( | +void | +) | ++ |
void ketCube_terminal_cmd_show_batMeas_list | +( | +void | +) | ++ |
+ KETCube
+
+ |
+
This file contains the BMEx80 (BME280 and BME680) driver. +More...
+#include "stm32l0xx_hal.h"
#include "stm32l0xx_hal_i2c.h"
#include "ketCube_cfg.h"
#include "ketCube_terminal.h"
#include "ketCube_i2c.h"
#include "ketCube_bmeX80.h"
+Functions | |
void | bench_StoreData_BME280 (int16_t temperature, uint16_t humidity, uint16_t pressure) |
This file contains the BMEx80 (BME280 and BME680) driver.
+ +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.
+void bench_StoreData_BME280 | +( | +int16_t | +temperature, | +
+ | + | uint16_t | +humidity, | +
+ | + | uint16_t | +pressure | +
+ | ) | ++ |
+ KETCube
+
+ |
+
This file contains definitions for the BMEx80 (BME280 and BME680) driver. +More...
+ +Go to the source code of this file.
++Data Structures | |
struct | ketCube_bmeX80_Calib_t |
Calibration data structure. More... | |
+Macros | |
#define | KETCUBE_BMEX80_SENSOR_TYPE_BME280 |
#define | BME_CONCAT_BYTES(msb, lsb) (((uint16_t)msb << 8) | (uint16_t)lsb) |
Macro to combine two 8 bit data's to form a 16 bit data. More... | |
#define | BME680_T2_LSB_REG 1 |
Array Index to Field data mapping for Calibration Data of BME680. More... | |
#define | BME680_T2_MSB_REG 2 |
#define | BME680_T3_REG 3 |
#define | BME680_P1_LSB_REG 5 |
#define | BME680_P1_MSB_REG 6 |
#define | BME680_P2_LSB_REG 7 |
#define | BME680_P2_MSB_REG 8 |
#define | BME680_P3_REG 9 |
#define | BME680_P4_LSB_REG 11 |
#define | BME680_P4_MSB_REG 12 |
#define | BME680_P5_LSB_REG 13 |
#define | BME680_P5_MSB_REG 14 |
#define | BME680_P7_REG 15 |
#define | BME680_P6_REG 16 |
#define | BME680_P8_LSB_REG 19 |
#define | BME680_P8_MSB_REG 20 |
#define | BME680_P9_LSB_REG 21 |
#define | BME680_P9_MSB_REG 22 |
#define | BME680_P10_REG 23 |
#define | BME680_H2_MSB_REG 25 |
#define | BME680_H2_LSB_REG 26 |
#define | BME680_H1_LSB_REG 26 |
#define | BME680_H1_MSB_REG 27 |
#define | BME680_H3_REG 28 |
#define | BME680_H4_REG 29 |
#define | BME680_H5_REG 30 |
#define | BME680_H6_REG 31 |
#define | BME680_H7_REG 32 |
#define | BME680_T1_LSB_REG 33 |
#define | BME680_T1_MSB_REG 34 |
#define | BME680_GH2_LSB_REG 35 |
#define | BME680_GH2_MSB_REG 36 |
#define | BME680_GH1_REG 37 |
#define | BME680_GH3_REG 38 |
#define | KETCUBE_BMEX80_I2C_ADDRESS (uint8_t) (0x76 << 1) /* SDO pin LOW */ |
I2C address. More... | |
#define | KETCUBE_BMEX80_CALIB_2_LENGTH 16 |
#define | KETCUBE_BMEX80_CHIP_ID 0x60 |
#define | KETCUBE_BMEX80_CALIB_1_LENGTH 26 |
#define | KETCUBE_BMEX80_MEASURING_SHIFT 3 |
#define | KETCUBE_BMEX80_CHIP_ID_REG 0xD0 |
#define | KETCUBE_BMEX80_CALIB_2_FIRST_REG 0xE1 |
#define | KETCUBE_BMEX80_HUMIDITY_REG 0XFD |
#define | KETCUBE_BMEX80_TEMPERATURE_REG 0XFA |
#define | KETCUBE_BMEX80_PRESSURE_REG 0XF7 |
#define | KETCUBE_BMEX80_CTRL_MEAS_REG 0XF4 |
#define | KETCUBE_BMEX80_STATUS_REG 0XF3 |
#define | KETCUBE_BMEX80_CTRL_HUM_REG 0XF2 |
#define | KETCUBE_BMEX80_CALIB_1_FIRST_REG 0x88 |
+Enumerations | |
enum | ketCube_bmeX80_OS_H_t { + KETCUBE_BMEX80_OS_H_X0 = (uint8_t) 0x00, +KETCUBE_BMEX80_OS_H_X1 = (uint8_t) 0x01, +KETCUBE_BMEX80_OS_H_X2 = (uint8_t) 0x02, +KETCUBE_BMEX80_OS_H_X4 = (uint8_t) 0x03, + + KETCUBE_BMEX80_OS_H_X8 = (uint8_t) 0x04, +KETCUBE_BMEX80_OS_H_X16 = (uint8_t) 0x05 + + } |
Relative humidity oversampling. More... | |
enum | ketCube_bmeX80_OS_T_t { + KETCUBE_BMEX80_OS_T_X0 = (uint8_t) 0x00, +KETCUBE_BMEX80_OS_T_X1 = (uint8_t) 0x01, +KETCUBE_BMEX80_OS_T_X2 = (uint8_t) 0x02, +KETCUBE_BMEX80_OS_T_X4 = (uint8_t) 0x03, + + KETCUBE_BMEX80_OS_T_X8 = (uint8_t) 0x04, +KETCUBE_BMEX80_OS_T_X16 = (uint8_t) 0x05 + + } |
Temperature oversampling. More... | |
enum | ketCube_bmeX80_OS_P_t { + KETCUBE_BMEX80_OS_P_X0 = (uint8_t) 0x00, +KETCUBE_BMEX80_OS_P_X1 = (uint8_t) 0x01, +KETCUBE_BMEX80_OS_P_X2 = (uint8_t) 0x02, +KETCUBE_BMEX80_OS_P_X4 = (uint8_t) 0x03, + + KETCUBE_BMEX80_OS_P_X8 = (uint8_t) 0x04, +KETCUBE_BMEX80_OS_P_X16 = (uint8_t) 0x05 + + } |
Pressure oversampling. More... | |
+Functions | |
ketCube_cfg_ModError_t | ketCube_bmeX80_Init (ketCube_InterModMsg_t ***msg) |
ketCube_cfg_ModError_t | ketCube_bmeX80_UnInit (void) |
ketCube_cfg_ModError_t | ketCube_bmeX80_ReadData (uint8_t *buffer, uint8_t *len) |
This file contains definitions for the BMEx80 (BME280 and BME680) driver.
+ +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.
+#define KETCUBE_BMEX80_SENSOR_TYPE_BME280 | +
+ KETCube
+
+ |
+
Functions | |
ketCube_cfg_Error_t | ketCube_cfg_Load (uint8_t *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
ketCube_cfg_Error_t | ketCube_cfg_Load (uint8_t *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
Load configuration data from EEPROM. More... | |
ketCube_cfg_Error_t | ketCube_cfg_LoadStr (char *data, uint8_t buffLen, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
ketCube_cfg_Error_t | ketCube_cfg_LoadStr (char *data, uint8_t buffLen, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
Load configuration data from EEPROM to string. More... | |
ketCube_cfg_Error_t | ketCube_cfg_SaveStr (char *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
ketCube_cfg_Error_t | ketCube_cfg_SaveStr (char *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
Save configuration data to EEPROM from string. More... | |
ketCube_cfg_Error_t | ketCube_cfg_Save (uint8_t *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
ketCube_cfg_Error_t | ketCube_cfg_Save (uint8_t *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
Save configuration data to EEPROM. More... | |
Go to the source code of this file.
KETCube module definition. More... | |
-Macros | |
#define | KETCUBE_CFG_INC_MOD_LORA |
#define | KETCUBE_CFG_INC_MOD_DEBUGDISPLAY |
#define | KETCUBE_CFG_INC_MOD_HDC1080 |
#define | KETCUBE_CFG_INC_MOD_BATMEAS |
#define | KETCUBE_CFG_INC_MOD_ADC |
#define | KETCUBE_CFG_INC_MOD_STARNET |
#define | KETCUBE_CFG_INC_MOD_FDC2214 |
#define | KETCUBE_CFG_INC_MOD_RXDISPLAY |
Typedefs | |
typedef struct ketCube_InterModMsg_t | ketCube_InterModMsg_t |
KETCube inter-module message. More... | |
typedef enum ketCube_severity_t | ketCube_severity_t |
KETCube debug severity definition. More... | |
typedef ketCube_cfg_ModError_t(* | ketCube_cfg_ModVoidFn_t) (void) |
Pointer to function returning ketCube_cfg_ModError_t. More... | |
Enumerations | |
enum | ketCube_cfg_moduleIDs_t { - KETCUBE_LISTS_MODULEID_LORA, -KETCUBE_LISTS_MODULEID_DEBUGDISPLAY, -KETCUBE_LISTS_MODULEID_HDC1080, -KETCUBE_LISTS_MODULEID_BATMEAS, - - KETCUBE_LISTS_MODULEID_ADC, -KETCUBE_LISTS_MODULEID_STARNET_CONCENTRATOR, -KETCUBE_LISTS_MODULEID_STARNET_NODE, -KETCUBE_LISTS_MODULEID_FDC2214, - - KETCUBE_LISTS_MODULEID_RXDISPLAY, -KETCUBE_LISTS_MODULEID_LAST - - } |
List of module Indeces. More... | |
enum | ketCube_cfg_AllocEEPROM_t { KETCUBE_EEPROM_ALLOC_CORE = 0, KETCUBE_EEPROM_ALLOC_MODULES = 64 } |
Error code type. More... | |
enum | ketCube_cfg_DrvError_t { KETCUBE_CFG_DRV_OK = (uint8_t) 0, +KETCUBE_CFG_DRV_ERROR = !(KETCUBE_CFG_MODULE_OK) + } |
Error code type. More... | |
enum | ketCube_severity_t { KETCUBE_CFG_SEVERITY_NONE = 0x0, +KETCUBE_CFG_SEVERITY_ERROR = 0x1, +KETCUBE_CFG_SEVERITY_INFO = 0x2, +KETCUBE_CFG_SEVERITY_DEBUG = 0x3 + } |
KETCube debug severity definition. More... | |
Functions | |
ketCube_cfg_Error_t | ketCube_cfg_Load (uint8_t *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
ketCube_cfg_Error_t | ketCube_cfg_Load (uint8_t *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
Load configuration data from EEPROM. More... | |
ketCube_cfg_Error_t | ketCube_cfg_LoadStr (char *data, uint8_t buffLen, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
ketCube_cfg_Error_t | ketCube_cfg_LoadStr (char *data, uint8_t buffLen, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
Load configuration data from EEPROM to string. More... | |
ketCube_cfg_Error_t | ketCube_cfg_Save (uint8_t *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
ketCube_cfg_Error_t | ketCube_cfg_Save (uint8_t *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
Save configuration data to EEPROM. More... | |
ketCube_cfg_Error_t | ketCube_cfg_SaveStr (char *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
ketCube_cfg_Error_t | ketCube_cfg_SaveStr (char *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
Save configuration data to EEPROM from string. More... | |
+ KETCube
+
+ |
+
KETCube common. +More...
+#include "ketCube_common.h"
+Variables | |
char | ketCube_common_buffer [KETCUBE_COMMON_BUFFER_LEN] |
KETCube common.
+ +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.
+Functions | |
static void | ketCube_common_Dec2int (int32_t *output, char *str, uint8_t len) |
Convert DEC string to 4 byte signed integer. More... | |
static uint8_t | ketCube_common_Min (uint8_t a, uint8_t b) |
Return minimum of two bytes. More... | |
static uint8_t | ketCube_common_Max (uint8_t a, uint8_t b) |
Return maximum of two bytes. More... | |
static uint16_t | ketCube_common_Med (uint16_t *values, uint16_t size) |
Return median from an array of shorts. More... | |
static uint16_t | ketCube_common_Avg (uint16_t *values, uint16_t size) |
Return median from an array of shorts. More... | |
static uint16_t | ketCube_common_swapW (uint16_t n) |
Swap word (16-bit) values. More... | |
static void | ketCube_common_BasicErrorHandler () |
Basic Error Handler. More... | |
+Variables | |
char | ketCube_common_buffer [] |
KETCube common definitions.
-Developed by: The SmartCampus Team Department of Technologies and Measurement www.smartcampus.cz | www.zcu.cz
diff --git a/docs/html/ketCube__common_8h_source.html b/docs/html/ketCube__common_8h_source.html index 9f95673..8da5a24 100644 --- a/docs/html/ketCube__common_8h_source.html +++ b/docs/html/ketCube__common_8h_source.html @@ -46,14 +46,21 @@This file contains the KETCube core configuration.
diff --git a/docs/html/ketCube__coreCfg_8h.html b/docs/html/ketCube__coreCfg_8h.html index a2525ae..7b91b9c 100644 --- a/docs/html/ketCube__coreCfg_8h.html +++ b/docs/html/ketCube__coreCfg_8h.html @@ -60,15 +60,24 @@Macros | |
#define | KETCUBE_CORECFG_MIN_BASEPERIOD 500 |
#define | KETCUBE_CORECFG_SKIP_SLEEP_PERIOD FALSE |
Skip sleep period (perform sensing at maximum speed) More... | |
#define | KETCUBE_CORECFG_MIN_BASEPERIOD 5000 |
Minimal period for periodic events. More... | |
#define | KETCUBE_CORECFG_MIN_STARTDELAY 500 |
#define | KETCUBE_CORECFG_MIN_STARTDELAY 1000 |
Minimal delay - the first periodic action is run at this time after power-on. More... | |
#define | KETCUBE_CORECFG_DEFAULT_SEVERITY KETCUBE_CFG_SEVERITY_ERROR |
Default KETCube core severity. More... | |
Enumerations | |
enum | ketCube_coreCfg_Addr_t { KETCUBE_CORECFG_ADR_BASEPERIOD = 0, -KETCUBE_CORECFG_ADR_STARTDELAY = 4 +KETCUBE_CORECFG_ADR_STARTDELAY = 4, +KETCUBE_CORECFG_ADR_SEVERITY = 8 } |
Core CFG data relative addr. More... | |
Variables | |
uint32_t | ketCube_coreCfg_BasePeriod |
This period is used by KETCube core to run periodic events. More... | |
uint32_t | ketCube_coreCfg_StartDelay |
This delay is used instead ketCube_coreCfg_BasePeriod to run periodic events at the first time. More... | |
ketCube_severity_t | ketCube_coreCfg_severity |
Core messages severity. More... | |
This file contains the KETCube core configuration defs.
diff --git a/docs/html/ketCube__coreCfg_8h_source.html b/docs/html/ketCube__coreCfg_8h_source.html index 2644b26..37ff2ef 100644 --- a/docs/html/ketCube__coreCfg_8h_source.html +++ b/docs/html/ketCube__coreCfg_8h_source.html @@ -46,14 +46,17 @@#include "ketCube_i2c.h"
#include "ketCube_fdc2214.h"
-Macros | |
#define | FDC2214_GPIO_PORT GPIOB |
#define | FDC2214_SD_PIN GPIO_PIN_2 |
#define | FDC2214_INT_PIN GPIO_PIN_7 |
#define | FDC2214_SD_CLK_ENABLE() __HAL_RCC_GPIOB_CLK_ENABLE() |
#define | FDC2214_SD_CLK_DISABLE() __HAL_RCC_GPIOB_CLK_DISABLE() |
#define | FDC2214_ON() HAL_GPIO_WritePin(FDC2214_GPIO_PORT, FDC2214_SD_PIN, GPIO_PIN_RESET) |
#define | FDC2214_OFF() HAL_GPIO_WritePin(FDC2214_GPIO_PORT, FDC2214_SD_PIN, GPIO_PIN_SET) |
Functions | |
static void | ketCube_fdc2214_on (void) |
Exit the FDC2214 shut-down mode. More... | |
static void | ketCube_fdc2214_off (void) |
Enter the FDC2214 shut-down mode. More... | |
static ketCube_cfg_ModError_t | ketCube_fdc2214_writeReg (uint8_t regAddr, uint16_t *reg, const char *str) |
Generic function to write the FDC2214 register. More... | |
static ketCube_cfg_ModError_t | ketCube_fdc2214_readReg (uint8_t regAddr, uint16_t *reg, const char *str) |
Generic function to read the FDC2214 register. More... | |
static ketCube_cfg_ModError_t | ketCube_fdc2214_wakeUp (void) |
Exit the FDC2214 sleep-down mode. More... | |
static ketCube_cfg_ModError_t | ketCube_fdc2214_sleep (void) |
Enter the FDC2214 sleep-down mode. More... | |
static ketCube_cfg_ModError_t | ketCube_fdc2214_reset (void) |
Soft-reset the FDC2214 sensor. More... | |
static void | ketCube_fdc2214_LEDIndication (uint32_t raw) |
LED indication. More... | |
void | ketCube_fdc2214_irqStatusUpdated () |
ketCube_cfg_ModError_t | ketCube_fdc2214_Init (ketCube_InterModMsg_t ***msg) |
Initialize the FDC2214 sensor. More... | |
ketCube_cfg_ModError_t | ketCube_fdc2214_UnInit (void) |
Initialize the FDC2214 sensor. More... | |
ketCube_cfg_ModError_t | ketCube_fdc2214_SleepEnter (void) |
Uninitialize the FDC2214 sensor. More... | |
ketCube_cfg_ModError_t | ketCube_fdc2214_SleepExit (void) |
Initialize the FDC2214 sensor. More... | |
ketCube_cfg_ModError_t | ketCube_fdc2214_ReadData (uint8_t *buffer, uint8_t *len) |
Read data from FDC2214 sensor. More... | |
+Variables | |
static uint32_t | pastValue |
This file contains the FDC2214 driver.
-Developed by: The SmartCampus Team Department of Technologies and Measurement www.smartcampus.cz | www.zcu.cz
@@ -104,113 +121,355 @@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.
-void ketCube_fdc2214_irqStatusUpdated | +( | +) | ++ |
|
+ +static | +
LED indication.
+raw | fdc2214 current raw value produced by fdc2214 sensor |
|
+ +inlinestatic | +
Enter the FDC2214 shut-down mode.
+KETCUBE_CFG_MODULE_OK | in case of success |
KETCUBE_CFG_MODULE_ERROR | in case of failure |
|
+ +inlinestatic | +
Exit the FDC2214 shut-down mode.
+KETCUBE_CFG_MODULE_OK | in case of success |
KETCUBE_CFG_MODULE_ERROR | in case of failure |
+
|
+ +static | +
Generic function to read the FDC2214 register.
+KETCUBE_CFG_MODULE_OK | in case of success |
KETCUBE_CFG_MODULE_ERROR | in case of failure |
|
+ +inlinestatic | +
Soft-reset the FDC2214 sensor.
+KETCUBE_CFG_MODULE_OK | in case of success |
KETCUBE_CFG_MODULE_ERROR | in case of failure |
|
+ +static | +
Enter the FDC2214 sleep-down mode.
+KETCUBE_CFG_MODULE_OK | in case of success |
KETCUBE_CFG_MODULE_ERROR | in case of failure |
|
+ +static | +
Exit the FDC2214 sleep-down mode.
+KETCUBE_CFG_MODULE_OK | in case of success |
KETCUBE_CFG_MODULE_ERROR | in case of failure |
+
|
+ +static | +
Generic function to write the FDC2214 register.
+KETCUBE_CFG_MODULE_OK | in case of success |
KETCUBE_CFG_MODULE_ERROR | in case of failure |
|
+ +static | +
#include "ketCube_cfg.h"
#include "ketCube_common.h"
#include "ketCube_mainBoard.h"
#include "ketCube_gpio.h"
Go to the source code of this file.
Macros | |
#define | KETCUBE_FDC2214_I2C_ADDRESS (uint8_t) (0x2A << 1) |
I2C slave (FDC2214) address. More... | |
#define | KETCUBE_FDC2214_I2C_TIMEOUT 0x1000 /*<! Value of Timeout when I2C communication fails */ |
I2C Timeout. More... | |
#define | KETCUBE_FDC2214_DATA_CH0 0x00 |
Channel 0 MSB Conversion Result and status. More... | |
#define | KETCUBE_FDC2214_DATA_LSB_CH0 0x01 |
Channel 0 LSB Conversion Result and status. More... | |
#define | KETCUBE_FDC2214_DATA_CH1 0x02 |
#define | KETCUBE_FDC2214_DATA_LSB_CH3 0x07 |
#define | KETCUBE_FDC2214_RCOUNT_CH0 0x08 |
Reference Count setting for Channel 0. More... | |
#define | KETCUBE_FDC2214_RCOUNT_CH1 0x09 |
#define | KETCUBE_FDC2214_RCOUNT_CH3 0x0B |
#define | KETCUBE_FDC2214_OFFSET_CH0 0x0C |
Reference Count setting for Channel 0. More... | |
#define | KETCUBE_FDC2214_OFFSET_CH1 0x0D |
#define | KETCUBE_FDC2214_OFFSET_CH3 0x0F |
#define | KETCUBE_FDC2214_SETTLECOUNT_CH0 0x10 |
Channel 0 Settling Reference Count. More... | |
#define | KETCUBE_FDC2214_SETTLECOUNT_CH1 0x11 |
#define | KETCUBE_FDC2214_SETTLECOUNT_CH3 0x13 |
#define | KETCUBE_FDC2214_CLOCK_DIVIDERS_CH0 0x14 |
Reference divider settings for Channel 0. More... | |
#define | KETCUBE_FDC2214_CLOCK_DIVIDERS_CH1 0x15 |
#define | KETCUBE_FDC2214_DRIVE_CURRENT_CH3 0x21 |
#define | KETCUBE_FDC2214_MANUFACTURER_ID 0x7E |
Manufacturer ID. For FDC2214: 0x5449. More... | |
#define | KETCUBE_FDC2214_DEVICE_ID 0x7F |
Device ID. For FDC2214: 0x3055. More... | |
#define | KETCUBE_FDC2214_I2C_ADDRESS (uint8_t) (0x2A << 1) |
I2C slave (FDC2214) address. More... | |
#define | KETCUBE_FDC2214_I2C_TIMEOUT 1000 |
Timeout value for I2C communication [ms]. More... | |
#define | KETCUBE_FDC2214_I2C_WU 100 |
Wake-up time [ms]. More... | |
#define | KETCUBE_FDC2214_I2C_TRY 50 |
I2C try when not successfull. More... | |
#define | FDC2214_SD_PORT KETCUBE_MAIN_BOARD_PIN_PWM_PORT |
FDC2214 Shut-Down. More... | |
#define | FDC2214_SD_PIN KETCUBE_MAIN_BOARD_PIN_PWM_PIN |
FDC2214 Shut-Down. More... | |
#define | FDC2214_INT_PORT KETCUBE_MAIN_BOARD_PIN_INT_PORT |
FDC2214 INT. More... | |
#define | FDC2214_INT_PIN KETCUBE_MAIN_BOARD_PIN_INT_PIN |
FDC2214 INT. More... | |
#define | FDC2214_LED_PORT KETCUBE_MAIN_BOARD_PIN_MOSI_PORT |
Indication LED. More... | |
#define | FDC2214_LED_PIN KETCUBE_MAIN_BOARD_PIN_MOSI_PIN |
Indication LED. More... | |
#define | FDC2214_USE_EXTERNAL_OSC TRUE |
Enable/Disable external oscillator. More... | |
#define | FDC2214_ENABLE_INT FALSE |
Enable FDC2214 interrupt. More... | |
#define | FDC2214_ENABLE_SLEEP TRUE |
Enter sleep mode instead of shut-down when KETCube goes low-power mode. More... | |
#define | FDC2214_LED_INDICATION TRUE |
Enable LED indication. More... | |
#define | FDC2214_LED_THRESHOLD_LOW 1000 |
FDC2214 raw value difference used to indicate significant capacity difference by using LED. More... | |
#define | FDC2214_LED_THRESHOLD_HIGH 10000 |
FDC2214 raw value difference used to indicate significant capacity difference by using LED. More... | |
#define | FDC2214_LED_CHAN FDC2214_CH0 |
FDC2214 channel used for LED indication,. More... | |
#define | FDC2214_RCOUNT 0xFFFF |
#define | FDC2214_SETTLECOUNT 0x0400 |
SettleCount - to stabilize oscilaltions. More... | |
#define | FDC2214_CHAN_SEQ FDC2214_SINGLE_CH0 |
Selected/active channel(s),. More... | |
#define | FDC2214_DGL_FILTER FDC2214_DGLF_10 |
Selected Deglitch filter,. More... | |
#define | FDC2214_SENSTYPE FDC2214_SENSTYPE_SINGLE_ENDED |
Selected sensor type,. More... | |
+Enumerations | |
enum | ketCube_fdc2214_chan_t { FDC2214_CH0 = 0x0, +FDC2214_CH1 = 0x1, +FDC2214_CH2 = 0x2, +FDC2214_CH3 = 0x3 + } |
FDC2214 Channels. More... | |
enum | ketCube_fdc2214_chanSeq_t { + FDC2214_SINGLE_CH0 = 0x0, +FDC2214_SINGLE_CH1 = 0x1, +FDC2214_SINGLE_CH2 = 0x2, +FDC2214_SINGLE_CH3 = 0x3, + + FDC2214_SEQ_CH_01 = (0x1 << 4), +FDC2214_SEQ_CH_012 = (0x2 << 4), +FDC2214_SEQ_CH_0123 = (0x3 << 4) + + } |
Channel Sequencing. More... | |
enum | ketCube_fdc2214_dglFilter_t { FDC2214_DGLF_1 = 0x1, +FDC2214_DGLF_3 = 0x4, +FDC2214_DGLF_10 = 0x5, +FDC2214_DGLF_33 = 0x7 + } |
Deglitch Filter. More... | |
enum | ketCube_fdc2214_sensType_t { FDC2214_SENSTYPE_DIFFERENTIAL, +FDC2214_SENSTYPE_SINGLE_ENDED + } |
Sensor type. More... | |
Functions | |||||||
ketCube_cfg_ModError_t | ketCube_fdc2214_Init (ketCube_InterModMsg_t ***msg) | ||||||
Initialize the FDC2214 sensor. More... | |||||||
ketCube_cfg_ModError_t | ketCube_fdc2214_UnInit (void) | ||||||
Initialize the FDC2214 sensor. More... | |||||||
ketCube_cfg_ModError_t | ketCube_fdc2214_SleepEnter (void) | ||||||
Uninitialize the FDC2214 sensor. More... | |||||||
ketCube_cfg_ModError_t | ketCube_fdc2214_SleepExit (void) | ||||||
Initialize the FDC2214 sensor. More... | |||||||
ketCube_cfg_ModError_t | ketCube_fdc2214_ReadData (uint8_t *buffer, uint8_t *len) | ||||||
Read data from FDC2214 sensor. More... | |||||||
+ KETCube
+
+ |
+
This file contains the ketCube GPIO driver. +More...
+#include "stm32l0xx_hal.h"
#include "ketCube_cfg.h"
#include "ketCube_gpio.h"
#include "ketCube_terminal.h"
+Macros | |
#define | RCC_GPIO_CLK_ENABLE(__GPIO_PORT__) |
#define | RCC_GPIO_CLK_DISABLE(__GPIO_PORT__) |
+Functions | |
IRQn_Type | MSP_GetIRQn (uint16_t GPIO_Pin) |
static uint8_t | ketCube_GPIO_GetBitPos (uint16_t pin) |
Get the position of the bit. More... | |
void | ketCube_GPIO_noneIrqHandler () |
Dummy irq handler. More... | |
ketCube_cfg_DrvError_t | ketCube_GPIO_Init (ketCube_gpio_port_t port, uint16_t pin, GPIO_InitTypeDef *initStruct) |
Initializes the GPIO PIN(s) More... | |
ketCube_cfg_DrvError_t | ketCube_GPIO_SetIrq (ketCube_gpio_port_t port, ketCube_gpio_pin_t pin, uint32_t prio, ketCube_GPIO_VoidFn_t irqHandler) |
Records the interrupt handler for the GPIO object. More... | |
void | ketCube_GPIO_Write (ketCube_gpio_port_t port, ketCube_gpio_pin_t pin, bool bit) |
Writes the bit value to the GPIO PIN. More... | |
bool | ketCube_GPIO_Read (ketCube_gpio_port_t port, ketCube_gpio_pin_t pin) |
Reads the current PIN value. More... | |
void | HAL_GPIO_EXTI_Callback (ketCube_gpio_pin_t pin) |
Execute the irqHandler This function redefines a weak deffinition from stm32l0xx_hal_gpio.c. More... | |
void | EXTI0_1_IRQHandler (void) |
void | EXTI2_3_IRQHandler (void) |
void | EXTI4_15_IRQHandler (void) |
+Variables | |
static ketCube_GPIO_VoidFn_t | ketCube_GPIO_IrqHandlers [16] = { NULL } |
This file contains the ketCube GPIO driver.
+ +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.
+#define RCC_GPIO_CLK_DISABLE | +( | ++ | __GPIO_PORT__ | ) | ++ |
#define RCC_GPIO_CLK_ENABLE | +( | ++ | __GPIO_PORT__ | ) | ++ |
void HAL_GPIO_EXTI_Callback | +( | +ketCube_gpio_pin_t | +pin | ) | ++ |
Execute the irqHandler This function redefines a weak deffinition from stm32l0xx_hal_gpio.c.
+pin | GPIO PIN |
+
|
+ +inlinestatic | +
Get the position of the bit.
+pin | pin (0 .. 15) |
pos | the position of the bit |
void ketCube_GPIO_noneIrqHandler | +( | +) | ++ |
Dummy irq handler.
+ +IRQn_Type MSP_GetIRQn | +( | +uint16_t | +GPIO_Pin | ) | ++ |
+
|
+ +static | +
+ KETCube
+
+ |
+
This file contains definitions for the ketCube GPIO driver. +More...
+ +Go to the source code of this file.
++Typedefs | |
typedef void(* | ketCube_GPIO_VoidFn_t) (void) |
Pointer to a IRQ Handler Function. More... | |
+Enumerations | |
enum | ketCube_gpio_pin_t { + KETCUBE_GPIO_NOPIN = 0, +KETCUBE_GPIO_PIN_0 = GPIO_PIN_0, +KETCUBE_GPIO_PIN_1 = GPIO_PIN_1, +KETCUBE_GPIO_PIN_2 = GPIO_PIN_2, + + KETCUBE_GPIO_PIN_3 = GPIO_PIN_3, +KETCUBE_GPIO_PIN_4 = GPIO_PIN_4, +KETCUBE_GPIO_PIN_5 = GPIO_PIN_5, +KETCUBE_GPIO_PIN_6 = GPIO_PIN_6, + + KETCUBE_GPIO_PIN_7 = GPIO_PIN_7, +KETCUBE_GPIO_PIN_8 = GPIO_PIN_8, +KETCUBE_GPIO_PIN_9 = GPIO_PIN_9, +KETCUBE_GPIO_PIN_10 = GPIO_PIN_10, + + KETCUBE_GPIO_PIN_11 = GPIO_PIN_11, +KETCUBE_GPIO_PIN_12 = GPIO_PIN_12, +KETCUBE_GPIO_PIN_13 = GPIO_PIN_13, +KETCUBE_GPIO_PIN_14 = GPIO_PIN_14, + + KETCUBE_GPIO_PIN_15 = GPIO_PIN_15 + + } |
List of GPIO PINs. More... | |
enum | ketCube_gpio_port_t { + KETCUBE_GPIO_PA = GPIOA_BASE, +KETCUBE_GPIO_PB = GPIOB_BASE, +KETCUBE_GPIO_PC = GPIOC_BASE, +KETCUBE_GPIO_PD = GPIOD_BASE, + + KETCUBE_GPIO_PE = GPIOE_BASE, +KETCUBE_GPIO_PH = GPIOH_BASE + + } |
GPIO Ports. More... | |
+Functions | |
ketCube_cfg_DrvError_t | ketCube_GPIO_Init (ketCube_gpio_port_t port, uint16_t pin, GPIO_InitTypeDef *initStruct) |
Initializes the GPIO PIN(s) More... | |
ketCube_cfg_DrvError_t | ketCube_GPIO_SetIrq (ketCube_gpio_port_t port, ketCube_gpio_pin_t pin, uint32_t prio, ketCube_GPIO_VoidFn_t irqHandler) |
Records the interrupt handler for the GPIO object. More... | |
void | ketCube_GPIO_Write (ketCube_gpio_port_t port, ketCube_gpio_pin_t pin, bool bit) |
Writes the bit value to the GPIO PIN. More... | |
bool | ketCube_GPIO_Read (ketCube_gpio_port_t port, ketCube_gpio_pin_t pin) |
Reads the current PIN value. More... | |
void | EXTI0_1_IRQHandler (void) |
void | EXTI2_3_IRQHandler (void) |
void | EXTI4_15_IRQHandler (void) |
This file contains definitions for the ketCube GPIO driver.
+ +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.
+
+ KETCube
+
+ |
+
This file contains the HDC1080 driver.
Developed by: The SmartCampus Team Department of Technologies and Measurement www.smartcampus.cz | www.zcu.cz
diff --git a/docs/html/ketCube__hdc1080_8h.html b/docs/html/ketCube__hdc1080_8h.html index e61b4ef..96d596d 100644 --- a/docs/html/ketCube__hdc1080_8h.html +++ b/docs/html/ketCube__hdc1080_8h.html @@ -154,7 +154,7 @@This file contains definitions for the HDC1080 driver.
Developed by: The SmartCampus Team Department of Technologies and Measurement www.smartcampus.cz | www.zcu.cz
diff --git a/docs/html/ketCube__hdc1080_8h_source.html b/docs/html/ketCube__hdc1080_8h_source.html index 92b02c6..b2dd8f1 100644 --- a/docs/html/ketCube__hdc1080_8h_source.html +++ b/docs/html/ketCube__hdc1080_8h_source.html @@ -46,47 +46,47 @@#include "stm32l0xx_hal_i2c.h"
#include "ketCube_cfg.h"
#include "ketCube_i2c.h"
#include "ketCube_terminal.h"
Functions | |
static void | ketCube_I2C_Error (uint8_t Addr) |
Manages error callback by re-initializing I2C. More... | |
static void | ketCube_I2C_Error () |
Manages error callback by re-initializing I2C. More... | |
ketCube_cfg_ModError_t | ketCube_I2C_Init (void) |
Configures I2C interface. More... | |
uint8_t | ketCube_I2C_WriteData (uint8_t Addr, uint8_t Reg, uint8_t *pBuffer, uint16_t Size) |
uint8_t | ketCube_I2C_WriteRawData (uint8_t Addr, uint8_t *pBuffer, uint16_t Size) |
uint8_t | ketCube_I2C_ReadRawData (uint8_t Addr, uint8_t *pBuffer, uint16_t Size) |
ketCube_cfg_ModError_t | ketCube_I2C_TexasReadReg (uint8_t devAddr, uint8_t regAddr, uint16_t *data) |
Read TexasInstruments I2C periph 16-bit register. More... | |
ketCube_cfg_ModError_t | ketCube_I2C_TexasWriteReg (uint8_t devAddr, uint8_t regAddr, uint16_t *data) |
Write TexasInstruments I2C periph 16-bit register. More... | |
ketCube_cfg_ModError_t | ketCube_I2C_STMReadSingle (uint8_t devAddr, uint8_t regAddr, uint8_t *data, uint8_t try) |
Read STM I2C Single 8-bit register. More... | |
ketCube_cfg_ModError_t | ketCube_I2C_AnalogWriteReg (uint8_t devAddr, uint8_t regAddr, uint8_t data) |
Write AnalogDevices I2C periph 8-bit register. More... | |
ketCube_cfg_ModError_t | ketCube_I2C_STMReadBlock (uint8_t devAddr, uint8_t regAddr, uint8_t *data, uint8_t len, uint8_t try) |
Read STM I2C Single 8-bit register. More... | |
ketCube_cfg_ModError_t | ketCube_I2C_STMWriteSingle (uint8_t devAddr, uint8_t regAddr, uint8_t *data, uint8_t try) |
Write STM I2C Single 8-bit register. More... | |
Variables | ( | -uint8_t | -Addr | ) | +) |
Manages error callback by re-initializing I2C.
-Addr | I2C Address |
None | |
#define | KETCUBE_I2C_TIMEOUT 0x5000 /*<! The value of the maximal timeout for BUS waiting loops */ |
#define | KETCUBE_I2C_TIMING_100KHZ 0x10A13E56 /* Analog Filter ON, Rise Time 400ns, Fall Time 100ns */ |
#define | KETCUBE_I2C_TIMING_400KHZ 0x00B1112E /* Analog Filter ON, Rise Time 250ns, Fall Time 100ns */ |
#define | KETCUBE_I2C_SPEED 100000 |
#define | KETCUBE_I2C_CLK_ENABLE() __I2C1_CLK_ENABLE() |
#define | KETCUBE_I2C_SCL_SDA_GPIO_CLK_ENABLE() __GPIOB_CLK_ENABLE() |
#define | KETCUBE_I2C_EV_IRQn I2C1_IRQn |
+Enumerations | |
enum | ketCube_I2C_SPEED_t { KETCUBE_I2C_SPEED_100KHZ = 0x10A13E56, +KETCUBE_I2C_SPEED_400KHZ = 0x00B1112E + } |
I2C Speed selection. More... | |
Functions | |
ketCube_cfg_ModError_t | ketCube_I2C_Init (void) |
uint8_t | ketCube_I2C_WriteData (uint8_t Addr, uint8_t Reg, uint8_t *pBuffer, uint16_t Size) |
uint8_t | ketCube_I2C_WriteRawData (uint8_t Addr, uint8_t *pBuffer, uint16_t Size) |
uint8_t | ketCube_I2C_ReadRawData (uint8_t Addr, uint8_t *pBuffer, uint16_t Size) |
ketCube_cfg_ModError_t | ketCube_I2C_TexasWriteReg (uint8_t devAddr, uint8_t regAddr, uint16_t *data) |
Write TexasInstruments I2C periph 16-bit register. More... | |
ketCube_cfg_ModError_t | ketCube_I2C_TexasReadReg (uint8_t devAddr, uint8_t RegAddr, uint16_t *data) |
Read TexasInstruments I2C periph 16-bit register. More... | |
ketCube_cfg_ModError_t | ketCube_I2C_STMWriteSingle (uint8_t devAddr, uint8_t regAddr, uint8_t *data, uint8_t try) |
Write STM I2C Single 8-bit register. More... | |
ketCube_cfg_ModError_t | ketCube_I2C_STMReadSingle (uint8_t devAddr, uint8_t RegAddr, uint8_t *data, uint8_t try) |
Read STM I2C Single 8-bit register. More... | |
ketCube_cfg_ModError_t | ketCube_I2C_STMReadBlock (uint8_t devAddr, uint8_t regAddr, uint8_t *data, uint8_t len, uint8_t try) |
Read STM I2C Single 8-bit register. More... | |
ketCube_cfg_ModError_t | ketCube_I2C_AnalogWriteReg (uint8_t devAddr, uint8_t regAddr, uint8_t data) |
Write AnalogDevices I2C periph 8-bit register. More... | |
This file contains definitions for the ketCube I2C driver.
-Developed by: The SmartCampus Team Department of Technologies and Measurement www.smartcampus.cz | www.zcu.cz
diff --git a/docs/html/ketCube__i2c_8h_source.html b/docs/html/ketCube__i2c_8h_source.html index b8194f8..a894155 100644 --- a/docs/html/ketCube__i2c_8h_source.html +++ b/docs/html/ketCube__i2c_8h_source.html @@ -46,14 +46,23 @@
+ KETCube
+
+ |
+
This file contains the ketCube I2S driver. +More...
+#include "stm32l0xx_hal.h"
#include "stm32l0xx_hal_i2s.h"
#include "ketCube_cfg.h"
#include "ketCube_i2s.h"
+Functions | |
ketCube_cfg_ModError_t | ketCube_I2S_Init (void) |
Configures I2S interface. More... | |
+Variables | |
I2S_HandleTypeDef | KETCUBE_I2S_Handle |
static uint8_t | initRuns = 0 |
This file contains the ketCube I2S driver.
+ +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.
+
+
|
+ +static | +
I2S_HandleTypeDef KETCUBE_I2S_Handle | +
+ KETCube
+
+ |
+
This file contains definitions for the ketCube I2S driver. +More...
+ +Go to the source code of this file.
++Macros | |
#define | KETCUBE_I2S_HANDLE SPI2 |
#define | KETCUBE_I2S_SAMPLE_RATE I2S_AUDIOFREQ_32K /*<! Available: 8,11,16,22,32,44,48 kHz */ |
#define | KETCUBE_I2S_CLK_ENABLE() __SPI2_CLK_ENABLE() |
#define | KETCUBE_I2S_FORCE_RESET() __SPI2_FORCE_RESET() |
#define | KETCUBE_I2S_RELEASE_RESET() __SPI2_RELEASE_RESET() |
#define | KETCUBE_I2S_WS_CK_SD_GPIO_CLK_ENABLE() __GPIOB_CLK_ENABLE() |
#define | KETCUBE_I2S_WS_CK_SD_AF GPIO_AF0_SPI2 |
#define | KETCUBE_I2S_WS_CK_SD_GPIO_PORT GPIOB |
#define | KETCUBE_I2S_WS_PIN GPIO_PIN_12 |
#define | KETCUBE_I2S_CK_PIN GPIO_PIN_13 |
#define | KETCUBE_I2S_SD_PIN GPIO_PIN_15 |
#define | KETCUBE_I2S_EV_IRQn SPI2_IRQn |
+Functions | |
ketCube_cfg_ModError_t | ketCube_I2S_Init (void) |
Configures I2S interface. More... | |
ketCube_cfg_ModError_t | ketCube_I2S_UnInit (void) |
This file contains definitions for the ketCube I2S driver.
+ +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.
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
This file contains the ICS43432 microphone module. +More...
+#include "ketCube_cfg.h"
#include "ketCube_terminal.h"
#include "ketCube_i2s.h"
#include "ketCube_ics43432.h"
#include "hw.h"
This file contains the ICS43432 microphone module.
+ +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.
+
+ KETCube
+
+ |
+
This file contains definitions for the ICS43432 microphone module. +More...
+#include "ketCube_coreCfg.h"
Go to the source code of this file.
++Macros | |
#define | KETCUBE_ICS43432_10_dBSPL 27U |
#define | KETCUBE_ICS43432_20_dBSPL 84U |
#define | KETCUBE_ICS43432_30_dBSPL 265U |
#define | KETCUBE_ICS43432_40_dBSPL 839U |
#define | KETCUBE_ICS43432_50_dBSPL 2653U |
#define | KETCUBE_ICS43432_60_dBSPL 8389U |
#define | KETCUBE_ICS43432_70_dBSPL 26527U |
#define | KETCUBE_ICS43432_80_dBSPL 83886U |
#define | KETCUBE_ICS43432_90_dBSPL 265271U |
#define | KETCUBE_ICS43432_100_dBSPL 838861U |
#define | KETCUBE_ICS43432_110_dBSPL 2652711U |
#define | KETCUBE_ICS43432_120_dBSPL 8388608U |
#define | KETCUBE_ICS43432_NOISE_LED_PORT GPIOB |
#define | KETCUBE_ICS43432_NOISE_LED_PIN GPIO_PIN_2 |
#define | KETCUBE_ICS43432_MAX_SAMPLE_COUNT KETCUBE_I2S_SAMPLE_RATE * KETCUBE_CORECFG_MIN_BASEPERIOD / 1000 |
+Functions | |
ketCube_cfg_ModError_t | ketCube_ics43432_Init (ketCube_InterModMsg_t ***msg) |
ketCube_cfg_ModError_t | ketCube_ics43432_UnInit (void) |
ketCube_cfg_ModError_t | ketCube_ics43432_ReadData (uint8_t *buffer, uint8_t *len) |
void | SPI2_IRQHandler (void) |
This file contains definitions for the ICS43432 microphone module.
+ +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.
+#define KETCUBE_ICS43432_100_dBSPL 838861U | +
#define KETCUBE_ICS43432_10_dBSPL 27U | +
#define KETCUBE_ICS43432_110_dBSPL 2652711U | +
#define KETCUBE_ICS43432_120_dBSPL 8388608U | +
#define KETCUBE_ICS43432_20_dBSPL 84U | +
#define KETCUBE_ICS43432_30_dBSPL 265U | +
#define KETCUBE_ICS43432_40_dBSPL 839U | +
#define KETCUBE_ICS43432_50_dBSPL 2653U | +
#define KETCUBE_ICS43432_60_dBSPL 8389U | +
#define KETCUBE_ICS43432_70_dBSPL 26527U | +
#define KETCUBE_ICS43432_80_dBSPL 83886U | +
#define KETCUBE_ICS43432_90_dBSPL 265271U | +
#define KETCUBE_ICS43432_MAX_SAMPLE_COUNT KETCUBE_I2S_SAMPLE_RATE * KETCUBE_CORECFG_MIN_BASEPERIOD / 1000 | +
#define KETCUBE_ICS43432_NOISE_LED_PIN GPIO_PIN_2 | +
#define KETCUBE_ICS43432_NOISE_LED_PORT GPIOB | +
ketCube_cfg_ModError_t ketCube_ics43432_Init | +( | +ketCube_InterModMsg_t *** | +msg | ) | ++ |
ketCube_cfg_ModError_t ketCube_ics43432_ReadData | +( | +uint8_t * | +buffer, | +
+ | + | uint8_t * | +len | +
+ | ) | ++ |
ketCube_cfg_ModError_t ketCube_ics43432_UnInit | +( | +void | +) | ++ |
void SPI2_IRQHandler | +( | +void | +) | ++ |
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
This file contains the LIS2HH12 module. +More...
+#include "ketCube_cfg.h"
#include "ketCube_terminal.h"
#include "ketCube_i2c.h"
#include "ketCube_lis2hh12.h"
This file contains the LIS2HH12 module.
+ +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.
+
+ KETCube
+
+ |
+
This file contains definitions for the LIS2HH12 module. +More...
+ +Go to the source code of this file.
++Macros | |
#define | KETCUBE_LIS2HH12_I2C_ADDRESS (uint8_t) (0x1D << 1) |
I2C slave (LIS2HH12) address. More... | |
#define | KETCUBE_LIS2HH12_WHO_AM_I 0x41 |
#define | KETCUBE_LIS2HH12_TEMP_L 0x0BU |
#define | KETCUBE_LIS2HH12_TEMP_H 0x0CU |
#define | KETCUBE_LIS2HH12_WHO_AM_I_REG 0x0FU |
#define | KETCUBE_LIS2HH12_ACT_TSH 0x1EU |
#define | KETCUBE_LIS2HH12_ACT_DUR 0x1FU |
#define | KETCUBE_LIS2HH12_CTRL_REG1 0x20U |
Main CTRL Register. More... | |
#define | KETCUBE_LIS2HH12_CTRL_REG2 0x21U |
#define | KETCUBE_LIS2HH12_CTRL_REG3 0x22U |
Interrupt control. More... | |
#define | KETCUBE_LIS2HH12_CTRL_REG4 0x23U |
#define | KETCUBE_LIS2HH12_CTRL_REG5 0x24U |
#define | KETCUBE_LIS2HH12_CTRL_REG6 0x25U |
#define | KETCUBE_LIS2HH12_CTRL_REG7 0x26U |
#define | KETCUBE_LIS2HH12_STATUS_REG 0x27U |
#define | KETCUBE_LIS2HH12_OUT_X_L 0x28U |
#define | KETCUBE_LIS2HH12_OUT_X_H 0x29U |
#define | KETCUBE_LIS2HH12_OUT_Y_L 0x2AU |
#define | KETCUBE_LIS2HH12_OUT_Y_H 0x2BU |
#define | KETCUBE_LIS2HH12_OUT_Z_L 0x2CU |
#define | KETCUBE_LIS2HH12_OUT_Z_H 0x2DU |
#define | KETCUBE_LIS2HH12_FIFO_CTRL 0x2EU |
#define | KETCUBE_LIS2HH12_FIFO_SRC 0x2FU |
#define | KETCUBE_LIS2HH12_INT1_CFG 0x30U |
#define | KETCUBE_LIS2HH12_INT1_SOURCE 0x31U |
#define | KETCUBE_LIS2HH12_INT1_TSH_X1 0x32U |
#define | KETCUBE_LIS2HH12_INT1_TSH_Y1 0x33U |
#define | KETCUBE_LIS2HH12_INT1_TSH_Z1 0x34U |
#define | KETCUBE_LIS2HH12_INT1_DURATION 0x35U |
#define | KETCUBE_LIS2HH12_INT2_CFG 0x36U |
#define | KETCUBE_LIS2HH12_INT2_SOURCE 0x37U |
#define | KETCUBE_LIS2HH12_INT2_TSH 0x38U |
#define | KETCUBE_LIS2HH12_INT2_DURATION 0x39U |
#define | KETCUBE_LIS2HH12_INT2_XL_REF 0x3AU |
#define | KETCUBE_LIS2HH12_INT2_XH_REF 0x3BU |
#define | KETCUBE_LIS2HH12_INT2_YL_REF 0x3CU |
#define | KETCUBE_LIS2HH12_INT2_YH_REF 0x3DU |
#define | KETCUBE_LIS2HH12_INT2_ZL_REF 0x3EU |
#define | KETCUBE_LIS2HH12_INT2_ZH_REF 0x3FU |
#define | KETCUBE_LIS2HH12_RESOLUTION_HIGH 0x01U<<7 |
#define | KETCUBE_LIS2HH12_RESOLUTION_NORMAL 0x00U |
#define | KETCUBE_LIS2HH12_ODR_0_PDN 0x00U |
#define | KETCUBE_LIS2HH12_ODR_10Hz 0x01U<<4 |
#define | KETCUBE_LIS2HH12_ODR_50Hz 0x02U<<4 |
#define | KETCUBE_LIS2HH12_ODR_100Hz 0x03U<<4 |
#define | KETCUBE_LIS2HH12_ODR_200Hz 0x04U<<4 |
#define | KETCUBE_LIS2HH12_ODR_400Hz 0x05U<<4 |
#define | KETCUBE_LIS2HH12_ODR_800Hz 0x06U<<4 |
#define | KETCUBE_LIS2HH12_DATA_LATCH 0x01U<<3 |
#define | KETCUBE_LIS2HH12_DATA_UPDATE 0x00U |
#define | KETCUBE_LIS2HH12_X_ENABLE 0x01U |
#define | KETCUBE_LIS2HH12_Y_ENABLE 0x01U<<1 |
#define | KETCUBE_LIS2HH12_Z_ENABLE 0x01U<<2 |
#define | KETCUBE_LIS2HH12_FIFO_EN 0x01U << 7 |
#define | KETCUBE_LIS2HH12_FIFO_DIS 0x00U |
#define | KETCUBE_LIS2HH12_FIFO_TSH_EN 0x01U << 6 |
#define | KETCUBE_LIS2HH12_FIFO_TSH_DIS 0x00U |
#define | KETCUBE_LIS2HH12_INT1_INACT_EN 0x01U << 5 |
#define | KETCUBE_LIS2HH12_INT1_INACT_DIS 0x00U |
#define | KETCUBE_LIS2HH12_INT1_IG2_EN 0x01U << 4 |
#define | KETCUBE_LIS2HH12_INT1_IG2_DIS 0x00U |
#define | KETCUBE_LIS2HH12_INT1_IG1_EN 0x01U << 3 |
#define | KETCUBE_LIS2HH12_INT1_IG1_DIS 0x00U |
#define | KETCUBE_LIS2HH12_INT1_OVR_EN 0x01U << 2 |
#define | KETCUBE_LIS2HH12_INT1_OVR_DIS 0x00U |
#define | KETCUBE_LIS2HH12_INT1_FTH_EN 0x01U << 1 |
#define | KETCUBE_LIS2HH12_INT1_FTH_DIS 0x00U |
#define | KETCUBE_LIS2HH12_INT1_DRDY_EN 0x01U |
#define | KETCUBE_LIS2HH12_INT1_DRDY_DIS 0x00U |
#define | KETCUBE_LIS2HH12_AOI_EN 0x01U << 7 |
#define | KETCUBE_LIS2HH12_AOI_DIS 0x00U |
#define | KETCUBE_LIS2HH12_6D_EN 0x01U << 6 |
#define | KETCUBE_LIS2HH12_6D_DIS 0x00U |
#define | KETCUBE_LIS2HH12_ZHIGH_EN 0x01U << 5 |
#define | KETCUBE_LIS2HH12_ZHIGH_DIS 0x00U |
#define | KETCUBE_LIS2HH12_ZLOW_EN 0x01U << 4 |
#define | KETCUBE_LIS2HH12_ZLOW_DIS 0x00U |
#define | KETCUBE_LIS2HH12_YHIGH_EN 0x01U << 3 |
#define | KETCUBE_LIS2HH12_YHIGH_DIS 0x00U |
#define | KETCUBE_LIS2HH12_YLOW_EN 0x01U << 2 |
#define | KETCUBE_LIS2HH12_YLOW_DIS 0x00U |
#define | KETCUBE_LIS2HH12_XHIGH_EN 0x01U << 1 |
#define | KETCUBE_LIS2HH12_XHIGH_DIS 0x00U |
#define | KETCUBE_LIS2HH12_XLOW_EN 0x01U |
#define | KETCUBE_LIS2HH12_XLOW_DIS 0x00U |
+Enumerations | |
enum | ketCube_lis2hh12_Int1_Src_t { + KETCUBE_LIS2HH12_INT1_SRC_XLOW = 0x00U, +KETCUBE_LIS2HH12_INT1_SRC_XHIGH = 0x01U, +KETCUBE_LIS2HH12_INT1_SRC_YLOW = 0x02U, +KETCUBE_LIS2HH12_INT1_SRC_YHIGH = 0x04U, + + KETCUBE_LIS2HH12_INT1_SRC_ZLOW = 0x08U, +KETCUBE_LIS2HH12_INT1_SRC_ZHIGH = 0x10U + + } |
+Functions | |
ketCube_cfg_ModError_t | ketCube_lis2hh12_Init (ketCube_InterModMsg_t ***msg) |
uint8_t | ketCube_lis2h12_Get_Int (void) |
ketCube_cfg_ModError_t | ketCube_lis2hh12_UnInit (void) |
ketCube_cfg_ModError_t | ketCube_lis2hh12_ReadData (uint8_t *buffer, uint8_t *len) |
This file contains definitions for the LIS2HH12 module.
+ +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.
+
+ KETCube
+
+ |
+
Functions | |
ketCube_cfg_ModError_t | ketCube_lora_Send (uint8_t *buffer, uint8_t *len) |
Process lora state and prepare data... More... | |
ketCube_cfg_ModError_t | ketCube_lora_AsyncSend (uint8_t *buffer, uint8_t *len) |
Process lora state and prepare data (for asynchronous send)... More... | |
ketCube_cfg_ModError_t | ketCube_lora_SleepEnter (void) |
Prepare sleep mode. More... | |
__weak void | ketCube_lora_processCustomData (uint8_t *buffer, uint8_t len) |
Process custom data. More... | |
Variables | |
static uint8_t | dataBufferLen |
static uint8_t | txPort |
This file contains the KETCube module wrapper for Semtech's LoRa.
-Developed by: The SmartCampus Team Department of Technologies and Measurement www.smartcampus.cz | www.zcu.cz
@@ -162,6 +172,21 @@LoRaWAN application port
#define LORAWAN_ASYNCAPP_PORT 3 | +
LoRaWAN application port for Async messagess
+
|
+ +static | +
This file contains the KETCube module wrapper for Semtech's LoRa.
diff --git a/docs/html/ketCube__lora_8h_source.html b/docs/html/ketCube__lora_8h_source.html index e5d4298..61e2a12 100644 --- a/docs/html/ketCube__lora_8h_source.html +++ b/docs/html/ketCube__lora_8h_source.html @@ -46,46 +46,50 @@#include "stm32l0xx_hal.h"
#include "stm32l0xx_hal_gpio.h"
#include "stdlib.h"
#include "ketCube_gpio.h"
Go to the source code of this file.
Macros | |
#define | KETCUBE_MAIN_BOARD_LED1_PIN GPIO_PIN_5 |
#define | KETCUBE_MAIN_BOARD_REV (KETCUBE_MAIN_REV_DEV - 1) |
The current board revision,. More... | |
#define | KETCUBE_MAIN_BOARD_OPTION_SJ1 KETCUBE_MAIN_BOARD_SJ_12 |
Connect PA8 to IO3. More... | |
#define | KETCUBE_MAIN_BOARD_OPTION_SJ7 KETCUBE_MAIN_BOARD_SJ_OPEN |
Connect Vref to IO3. More... | |
#define | KETCUBE_MAIN_BOARD_OPTION_SJ2 KETCUBE_MAIN_BOARD_SJ_12 |
MuRaTa radio powered. More... | |
#define | KETCUBE_MAIN_BOARD_OPTION_SJ3 KETCUBE_MAIN_BOARD_SJ_12 |
MuRaTa sleep Mode control. More... | |
#define | KETCUBE_MAIN_BOARD_OPTION_SJ8 KETCUBE_MAIN_BOARD_SJ_OPEN |
MuRaTa sleep Mode control. More... | |
#define | KETCUBE_MAIN_BOARD_OPTION_SJ5 KETCUBE_MAIN_BOARD_SJ_12 |
HDC1080 connected. More... | |
#define | KETCUBE_MAIN_BOARD_OPTION_SJ6 KETCUBE_MAIN_BOARD_SJ_12 |
HDC1080 connected. More... | |
#define | KETCUBE_MAIN_BOARD_OPTION_SJ9 KETCUBE_MAIN_BOARD_SJ_23 |
12 == NRST to IO4; 23 == PA5 to IO4 More... | |
#define | KETCUBE_MAIN_BOARD_OPTION_SJ10 KETCUBE_MAIN_BOARD_SJ_12 |
Vref to 3V3. More... | |
#define | KETCUBE_MAIN_BOARD_PIN_IO1_PIN KETCUBE_GPIO_PIN_10 |
#define | KETCUBE_MAIN_BOARD_PIN_IO1_PORT KETCUBE_GPIO_PA |
#define | KETCUBE_MAIN_BOARD_PIN_IO2_PIN KETCUBE_GPIO_PIN_9 |
#define | KETCUBE_MAIN_BOARD_PIN_IO2_PORT KETCUBE_GPIO_PA |
#define | KETCUBE_MAIN_BOARD_PIN_IO3_PIN KETCUBE_GPIO_PIN_8 |
#define | KETCUBE_MAIN_BOARD_PIN_IO3_PORT KETCUBE_GPIO_PA |
#define | KETCUBE_MAIN_BOARD_PIN_IO4_PIN KETCUBE_GPIO_PIN_5 |
#define | KETCUBE_MAIN_BOARD_PIN_IO4_PORT KETCUBE_GPIO_PA |
#define | KETCUBE_MAIN_BOARD_PIN_AN_PIN KETCUBE_GPIO_PIN_4 |
#define | KETCUBE_MAIN_BOARD_PIN_AN_PORT KETCUBE_GPIO_PA |
#define | KETCUBE_MAIN_BOARD_PIN_RST_PIN KETCUBE_GPIO_PIN_0 |
#define | KETCUBE_MAIN_BOARD_PIN_RST_PORT KETCUBE_GPIO_PA |
#define | KETCUBE_MAIN_BOARD_PIN_CS_PIN KETCUBE_GPIO_PIN_12 |
#define | KETCUBE_MAIN_BOARD_PIN_CS_PORT KETCUBE_GPIO_PB |
#define | KETCUBE_MAIN_BOARD_PIN_SCK_PIN KETCUBE_GPIO_PIN_13 |
#define | KETCUBE_MAIN_BOARD_PIN_SCK_PORT KETCUBE_GPIO_PB |
#define | KETCUBE_MAIN_BOARD_PIN_MISO_PIN KETCUBE_GPIO_PIN_14 |
#define | KETCUBE_MAIN_BOARD_PIN_MISO_PORT KETCUBE_GPIO_PB |
#define | KETCUBE_MAIN_BOARD_PIN_MOSI_PIN KETCUBE_GPIO_PIN_15 |
#define | KETCUBE_MAIN_BOARD_PIN_MOSI_PORT KETCUBE_GPIO_PB |
#define | KETCUBE_MAIN_BOARD_PIN_PWM_PIN KETCUBE_GPIO_PIN_2 |
#define | KETCUBE_MAIN_BOARD_PIN_PWM_PORT KETCUBE_GPIO_PB |
#define | KETCUBE_MAIN_BOARD_PIN_INT_PIN KETCUBE_GPIO_PIN_7 |
#define | KETCUBE_MAIN_BOARD_PIN_INT_PORT KETCUBE_GPIO_PB |
#define | KETCUBE_MAIN_BOARD_PIN_RX_PIN KETCUBE_GPIO_PIN_3 |
#define | KETCUBE_MAIN_BOARD_PIN_RX_PORT KETCUBE_GPIO_PA |
#define | KETCUBE_MAIN_BOARD_PIN_TX_PIN KETCUBE_GPIO_PIN_2 |
#define | KETCUBE_MAIN_BOARD_PIN_TX_PORT KETCUBE_GPIO_PA |
#define | KETCUBE_MAIN_BOARD_PIN_SCL_PIN KETCUBE_GPIO_PIN_8 |
#define | KETCUBE_MAIN_BOARD_PIN_SCL_PORT KETCUBE_GPIO_PB |
#define | KETCUBE_MAIN_BOARD_PIN_SDA_PIN KETCUBE_GPIO_PIN_9 |
#define | KETCUBE_MAIN_BOARD_PIN_SDA_PORT KETCUBE_GPIO_PB |
#define | KETCUBE_MAIN_BOARD_LED1_PIN KETCUBE_GPIO_PIN_5 |
#define | KETCUBE_MAIN_BOARD_LED1_GPIO_PORT GPIOB |
#define | KETCUBE_MAIN_BOARD_LED1_GPIO_PORT KETCUBE_GPIO_PB |
#define | KETCUBE_MAIN_BOARD_LED1_GPIO_CLK_ENABLE() __HAL_RCC_GPIOB_CLK_ENABLE() |
#define | KETCUBE_MAIN_BOARD_LED1_GPIO_CLK_DISABLE() __HAL_RCC_GPIOB_CLK_DISABLE() |
#define | KETCUBE_MAIN_BOARD_LED1_On() HAL_GPIO_WritePin(KETCUBE_MAIN_BOARD_LED1_GPIO_PORT, KETCUBE_MAIN_BOARD_LED1_PIN, GPIO_PIN_SET) |
#define | KETCUBE_MAIN_BOARD_LED1_Off() HAL_GPIO_WritePin(KETCUBE_MAIN_BOARD_LED1_GPIO_PORT, KETCUBE_MAIN_BOARD_LED1_PIN, GPIO_PIN_RESET) |
#define | KETCUBE_MAIN_BOARD_LED1_Toggle() HAL_GPIO_TogglePin(KETCUBE_MAIN_BOARD_LED1_GPIO_PORT, KETCUBE_MAIN_BOARD_LED1_PIN) |
#define | KETCUBE_MAIN_BOARD_LED2_PIN GPIO_PIN_6 |
#define | KETCUBE_MAIN_BOARD_LED2_PIN KETCUBE_GPIO_PIN_6 |
#define | KETCUBE_MAIN_BOARD_LED2_GPIO_PORT GPIOB |
#define | KETCUBE_MAIN_BOARD_LED2_GPIO_PORT KETCUBE_GPIO_PB |
#define | KETCUBE_MAIN_BOARD_LED2_GPIO_CLK_ENABLE() __HAL_RCC_GPIOB_CLK_ENABLE() |
#define | KETCUBE_MAIN_BOARD_LED2_GPIO_CLK_DISABLE() __HAL_RCC_GPIOB_CLK_DISABLE() |
#define | KETCUBE_MAIN_BOARD_LED2_On() HAL_GPIO_WritePin(KETCUBE_MAIN_BOARD_LED2_GPIO_PORT, KETCUBE_MAIN_BOARD_LED2_PIN, GPIO_PIN_SET) |
#define | KETCUBE_MAIN_BOARD_LED2_Off() HAL_GPIO_WritePin(KETCUBE_MAIN_BOARD_LED2_GPIO_PORT, KETCUBE_MAIN_BOARD_LED2_PIN, GPIO_PIN_RESET) |
#define | KETCUBE_MAIN_BOARD_LED2_Toggle() HAL_GPIO_TogglePin(KETCUBE_MAIN_BOARD_LED2_GPIO_PORT, KETCUBE_MAIN_BOARD_LED2_PIN) |
-Functions | |
static void | ketCube_MainBoard_LED1_Init () |
static void | ketCube_MainBoard_LED2_Init () |
+Enumerations | |
enum | ketCube_MainBoard_revs_t { + KETCUBE_MAIN_REV_A = 0, +KETCUBE_MAIN_REV_B, +KETCUBE_MAIN_REV_C, +KETCUBE_MAIN_REV_D, + + KETCUBE_MAIN_REV_E, +KETCUBE_MAIN_REV_DEV + + } |
Main Board revisions. More... | |
enum | ketCube_MainBoard_SJ_t { KETCUBE_MAIN_BOARD_SJ_OPEN = 0, +KETCUBE_MAIN_BOARD_SJ_12, +KETCUBE_MAIN_BOARD_SJ_23 + } |
Solder Jumper configuration options. More... | |
Definitions for KETCube main board.
-Developed by: The SmartCampus Team Department of Technologies and Measurement www.smartcampus.cz | www.zcu.cz
diff --git a/docs/html/ketCube__mainBoard_8h_source.html b/docs/html/ketCube__mainBoard_8h_source.html index 749ee96..7fbc80b 100644 --- a/docs/html/ketCube__mainBoard_8h_source.html +++ b/docs/html/ketCube__mainBoard_8h_source.html @@ -46,16 +46,18 @@#include "ketCube_common.h"
#include "ketCube_modules.h"
#include "ketCube_terminal.h"
#include "hw_msp.h"
#include "ketCube_lora.h"
#include "ketCube_i2c.h"
#include "ketCube_hdc1080.h"
#include "ketCube_fdc2214.h"
#include "ketCube_adc.h"
#include "ketCube_starNet.h"
#include "ketCube_rxDisplay.h"
#include "../../Projects/src/ketCube_moduleList.c"
Functions |
Variables | |||||||||
ketCube_cfg_Module_t | ketCube_modules_List [ketCube_modules_CNT] | ||||||||
List of KETCube modules. More... | |||||||||
uint8_t | SensorBuffer [KETCUBE_MODULES_SENSOR_BYTES] | ||||||||
uint8_t | SensorBufferSize = 0 |
Macros | |
#define | KETCUBE_MODULES_SENSOR_BYTES 64 |
#define | KETCUBE_MODULES_SENSOR_BYTES 512 |
Max number of bytes which can be read from all sensors. More... | |
#define | ketCube_modules_CNT (KETCUBE_LISTS_MODULEID_LAST) |
#define | ketCube_modules_CNT (KETCUBE_LISTS_MODULEID_LAST) |
@@ -85,7 +86,6 @@
Variables | List of KETCube modules. More... | | |
#include "ketCube_rxDisplay.h"
#include "ketCube_common.h"
#include "ketCube_terminal.h"
-Functions | |
ketCube_cfg_ModError_t | ketCube_rxDisplay_Init (ketCube_InterModMsg_t ***msg) |
Initialize rxDisplay module. More... | |
ketCube_cfg_ModError_t | ketCube_rxDisplay_ProcessData (ketCube_InterModMsg_t *msg) |
Process data – display on serial line. More... | |
This file contains the KETCube RxDisplay module.
@@ -250,7 +250,7 @@
diff --git a/docs/html/ketCube__starNet_8h.html b/docs/html/ketCube__starNet_8h.html
index e627a1d..b2eb5c8 100644
--- a/docs/html/ketCube__starNet_8h.html
+++ b/docs/html/ketCube__starNet_8h.html
@@ -63,10 +63,13 @@
Macros#define | KETCUBE_STARNET_RF_FREQUENCY 868000000 | | Hz for US, define: 915000000 Hz. More... | | #define | KETCUBE_STARNET_TX_OUTPUT_POWER 14 | | dBm More... | | #define | KETCUBE_STARNET_RX_DATA_BUFFER_LEN 64 | | Rx Data buffer length. More... | | |
diff --git a/docs/html/ketCube__starNet_8h_source.html b/docs/html/ketCube__starNet_8h_source.html
index ddb90c7..0821478 100644
--- a/docs/html/ketCube__starNet_8h_source.html
+++ b/docs/html/ketCube__starNet_8h_source.html
@@ -46,14 +46,14 @@
ketCube_cfg_ModError_t ketCube_starNet_SleepEnter(void) Prepare sleep mode. Definition: ketCube_starNet.c:111 ketCube_cfg_ModError_t ketCube_starNet_SleepEnter(void) Prepare sleep mode. Definition: ketCube_starNet.c:111 Definition: ketCube_starNet.h:76 ketCube_cfg_ModError_t ketCube_starNet_receiveData(void) Receive sensor data. Definition: ketCube_starNet.c:216 KETCube common definitions. ketCube_starNet_NodeType_t ketCube_starNet_nodeType Definition: ketCube_starNet.c:82 ketCube_cfg_ModError_t ketCube_starNet_sendData(uint8_t *buffer, uint8_t *len) Send sensor data. Definition: ketCube_starNet.c:235 ketCube_cfg_ModError_t ketCube_starNet_sendData(uint8_t *buffer, uint8_t *len) Send sensor data. Definition: ketCube_starNet.c:236 Definition: ketCube_starNet.h:75 This file contains definitions for the KETCube configuration. This file contains definitions for the terminal. ketCube_cfg_ModError_t ketCube_starNet_ConcentratorInit(ketCube_InterModMsg_t ***msg) Initialize starNet Concentrator. Definition: ketCube_starNet.c:168 ketCube_cfg_ModError_t ketCube_starNet_NodeInit(ketCube_InterModMsg_t ***msg) Initialize starNet Node. Definition: ketCube_starNet.c:203 Definition: ketCube_starNet.h:67 |
+Macros | |
#define | KETCUBE_TERMINAL_USART_INSTANCE USART1 |
#define | KETCUBE_TERMINAL_USART_IRQn USART1_IRQn |
#define | KETCUBE_TERMINAL_USART_BR 9600 |
#define | KETCUBE_TERMINAL_USART_CHANNEL KETCUBE_UART_CHANNEL_1 |
#define | KETCUBE_TERMINAL_USART_CLK_ENABLE() __USART1_CLK_ENABLE(); |
#define | KETCUBE_TERMINAL_USART_RX_GPIO_CLK_ENABLE() __GPIOA_CLK_ENABLE() |
#define | KETCUBE_TERMINAL_USART_TX_GPIO_CLK_ENABLE() __GPIOA_CLK_ENABLE() |
#define | KETCUBE_TERMINAL_USART_FORCE_RESET() __USART1_FORCE_RESET() |
#define | KETCUBE_TERMINAL_USART_RELEASE_RESET() __USART1_RELEASE_RESET() |
#define | KETCUBE_TERMINAL_USART_TX_PIN GPIO_PIN_9 |
#define | KETCUBE_TERMINAL_USART_TX_GPIO_PORT GPIOA |
#define | KETCUBE_TERMINAL_USART_TX_AF GPIO_AF4_USART1 |
#define | KETCUBE_TERMINAL_USART_RX_PIN GPIO_PIN_10 |
#define | KETCUBE_TERMINAL_USART_RX_GPIO_PORT GPIOA |
#define | KETCUBE_TERMINAL_USART_RX_AF GPIO_AF4_USART1 |
#define | USART_BUFFER_SIZE 256 |
Functions | |
static uint8_t | ketCube_terminal_getNextParam (uint8_t ptr) |
Return next command parameter index. More... | |
static void | ketCube_terminal_printCmdList (uint16_t cmdIndex, uint8_t level) |
Prints command list at index/level. More... | |
static void | ketCube_terminal_saveCfgHEXStr (char *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
static void | ketCube_terminal_saveCfgHEXStr (char *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
A wrapper to ketCube_cfg_SaveStr function. More... | |
static void | ketCube_terminal_saveCfgDECStr (char *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
static void | ketCube_terminal_saveCfgDECStr (char *data, ketCube_cfg_moduleIDs_t id, ketCube_cfg_AllocEEPROM_t addr, ketCube_cfg_LenEEPROM_t len) |
A wrapper to ketCube_cfg_saveStr function. More... | |
static void | ketCube_terminal_cmd_reload (void) |
static void | ketCube_terminal_cmd_show_core_startDelay (void) |
Show KETCube start delay. More... | |
static void | ketCube_terminal_cmd_show_core_severity (void) |
Show KETCube severity. More... | |
static void | ketCube_terminal_cmd_set_core_basePeriod (void) |
Set KETCube base period. More... | |
static void | ketCube_terminal_cmd_set_core_startDelay (void) |
Set KETCube start delay. More... | |
static void | ketCube_terminal_cmd_set_core_severity (void) |
Set KETCube severity. More... | |
void | ketCube_terminal_cmd_help (void) |
void | ketCube_terminal_cmd_about (void) |
void | ketCube_terminal_cmd_enableDisable (bool enable) |
Enable/disable given KETCube module. More... | |
void | ketCube_terminal_usartIoInit (void) |
void | ketCube_terminal_usartIoDeInit (void) |
void | ketCube_terminal_usartRx (void) |
void | ketCube_terminal_usartTx (void) |
void | ketCube_terminal_usartErrorCallback (void) |
void | ketCube_terminal_usartWakeupCallback (void) |
void | ketCube_terminal_UsartPrintVa (char *format, va_list args) |
void | ketCube_terminal_UsartPrint (char *format,...) |
bool | IsNewCharReceived (void) |
char | GetNewChar (void) |
void | ketCube_terminal_Init (void) |
Init terminal. More... | |
void | ketCube_terminal_UpdateCmdLine (void) |
Print current unfinished command. More... | |
void | ketCube_terminal_ClearCmdLine (void) |
Clear command line. More... | |
void | ketCube_terminal_ProcessCMD (void) |
Process user input. More... | |
void | ketCube_terminal_Print (char *format,...) |
Print format to serial line. More... | |
void | ketCube_terminal_CoreSeverityPrintln (ketCube_severity_t msgSeverity, char *format,...) |
Print Debug info to serial line + newline. More... | |
void | ketCube_terminal_ModSeverityPrintln (ketCube_severity_t msgSeverity, ketCube_cfg_moduleIDs_t modId, char *format, va_list args) |
Print Debug info to serial line + newline. More... | |
void | ketCube_terminal_DebugPrintln (char *format,...) |
Print Debug info to serial line + newline. More... | |
Variables | |
static UART_HandleTypeDef | ketCube_terminal_UsartHandle |
static ketCube_UART_descriptor_t | ketCube_terminal_UsartDescriptor |
static volatile uint8_t | usartRxWrite = 0 |
static volatile uint8_t | usartRxRead = 0 |
static char | usartRxBuffer [USART_BUFFER_SIZE] |
static char | usartTxBuffer [USART_BUFFER_SIZE] |
static ketCube_terminal_buffer_t | commandHistory [KETCUBE_TERMINAL_HISTORY_LEN] |
static char * | commandBuffer = (char *) &(commandHistory[0].buffer[0]) |
static uint8_t | commandParams |
ketCube_terminal_cmd_t | ketCube_terminal_commands [] |
List of KETCube terminal commands. More... | |
This file contains the KETCube Terminal.
-Developed by: The SmartCampus Team Department of Technologies and Measurement www.smartcampus.cz | www.zcu.cz
@@ -166,7 +252,283 @@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.
-#define KETCUBE_TERMINAL_USART_BR 9600 | +
#define KETCUBE_TERMINAL_USART_CHANNEL KETCUBE_UART_CHANNEL_1 | +
#define KETCUBE_TERMINAL_USART_CLK_ENABLE | +( | +) | +__USART1_CLK_ENABLE(); | +
#define KETCUBE_TERMINAL_USART_FORCE_RESET | +( | +) | +__USART1_FORCE_RESET() | +
#define KETCUBE_TERMINAL_USART_INSTANCE USART1 | +
#define KETCUBE_TERMINAL_USART_IRQn USART1_IRQn | +
#define KETCUBE_TERMINAL_USART_RELEASE_RESET | +( | +) | +__USART1_RELEASE_RESET() | +
#define KETCUBE_TERMINAL_USART_RX_AF GPIO_AF4_USART1 | +
#define KETCUBE_TERMINAL_USART_RX_GPIO_CLK_ENABLE | +( | +) | +__GPIOA_CLK_ENABLE() | +
#define KETCUBE_TERMINAL_USART_RX_GPIO_PORT GPIOA | +
#define KETCUBE_TERMINAL_USART_RX_PIN GPIO_PIN_10 | +
#define KETCUBE_TERMINAL_USART_TX_AF GPIO_AF4_USART1 | +
#define KETCUBE_TERMINAL_USART_TX_GPIO_CLK_ENABLE | +( | +) | +__GPIOA_CLK_ENABLE() | +
#define KETCUBE_TERMINAL_USART_TX_GPIO_PORT GPIOA | +
#define KETCUBE_TERMINAL_USART_TX_PIN GPIO_PIN_9 | +
#define USART_BUFFER_SIZE 256 | +
char GetNewChar | +( | +void | +) | ++ |
bool IsNewCharReceived | +( | +void | +) | ++ |
void ketCube_terminal_cmd_set_core_startDelay | +void ketCube_terminal_cmd_set_core_severity | ( | void | ) | @@ -357,12 +719,12 @@
void ketCube_terminal_cmd_show_core_basePeriod | +void ketCube_terminal_cmd_set_core_startDelay | ( | void | ) | @@ -385,12 +747,12 @@
void ketCube_terminal_cmd_show_core_startDelay | +void ketCube_terminal_cmd_show_core_basePeriod | ( | void | ) | @@ -413,32 +775,130 @@
|
+ +static | +
Execute command-in-buffer.
+Show KETCube severity.
+
|
+ +static | +
Show KETCube start delay.
+ +void ketCube_terminal_execCMD | +( | +void | +) | ++ |
Execute command-in-buffer.
+ +
+
|
+ +static | +
Return next command parameter index.
+ptr | index where to start parameter search |
index | next parameter index |
A wrapper to ketCube_cfg_saveStr function.
-Provides textual output to terminal is provided
+Provides textual output to terminal
@@ -571,7 +1031,7 @@void ketCube_terminal_usartErrorCallback | +( | +void | +) | ++ |
void ketCube_terminal_usartIoDeInit | +( | +void | +) | ++ |
void ketCube_terminal_usartIoInit | +( | +void | +) | ++ |
void ketCube_terminal_UsartPrintVa | +( | +char * | +format, | +
+ | + | va_list | +args | +
+ | ) | ++ |
void ketCube_terminal_usartRx | +( | +void | +) | ++ |
void ketCube_terminal_usartTx | +( | +void | +) | ++ |
void ketCube_terminal_usartWakeupCallback | +( | +void | +) | ++ |
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
This file contains definitions for the terminal. More...
-#include "ketCube_common.h"
#include <stdarg.h>
#include <stdlib.h>
#include "ketCube_common.h"
#include "ketCube_cfg.h"
#include "vcom.h"
Macros | |
#define | KETCUBE_TERMINAL_DEBUG FALSE /*<! Turn ON/OFF low-level debug messages */ |
#define | KETCUBE_TERMINAL_DEBUG FALSE /*<! Turn ON/OFF low-level debug messages */ |
#define | KETCUBE_TERMINAL_MODDEBUG TRUE /*<! Turn ON/OFF structured debug messages */ |
#define | KETCUBE_TERMINAL_MODDEBUG TRUE /*<! Turn ON/OFF structured debug messages */ |
#define | KETCUBE_TERMINAL_ECHO TRUE /*<! Turn ON/OFF echo */ |
#define | KETCUBE_TERMINAL_ECHO TRUE /*<! Turn ON/OFF echo */ |
#define | KETCUBE_TERMINAL_HISTORY_LEN 3 /*<! Remember last 3 commands */ |
#define | KETCUBE_TERMINAL_CMD_MAX_LEN 128 /*<! Max command length */ |
#define | KETCUBE_TERMINAL_PRINTF(...) vcom_Send(__VA_ARGS__) |
#define | KETCUBE_TERMINAL_PRINTF(...) ketCube_terminal_UsartPrint(__VA_ARGS__) |
#define | KETCUBE_TERMINAL_PROMPT() KETCUBE_TERMINAL_PRINTF(">> ") |
#define | KETCUBE_TERMINAL_ENDL() KETCUBE_TERMINAL_PRINTF("\n\r") |
#define | KETCUBE_TERMINAL_CLR_LINE() KETCUBE_TERMINAL_PRINTF("\r \r") |
#define | KETCUBE_TERMINAL_CLR_LINE() ketCube_terminal_ClearCmdLine() |
@@ -107,27 +109,45 @@
void | ketCube_terminal_UpdateCmdLine (void) | | Print current unfinished command. More... | | void | ketCube_terminal_cmd_about (void) | | void | ketCube_terminal_cmd_help (void) | | void | ketCube_terminal_Print (char *format,...) | | Print format to serial line. More... | | void | ketCube_terminal_Println (char *format,...) | | Print line to serial line + newline. More... | | void | ketCube_terminal_DebugPrint (char *format,...) | | Print Debug info to serial line. More... | | void | ketCube_terminal_DebugPrintln (char *format,...) | | Print Debug info to serial line + newline. More... | | |
Variables | |
ketCube_terminal_cmd_t | ketCube_terminal_commands [] |
List of KETCube terminal commands. More... | |
+ KETCube
+
+ |
+
This file contains the ketCube Timer(s) driver. +More...
++Functions | |
ketCube_cfg_ModError_t | ketCube_Timer_Init (ketCube_Timer_list_t tim) |
Configures Timer(s) More... | |
+Variables | |
ketCube_Timer_usage_t | timerUsed = { 0, 0, 0, 0, 0, 0, 0 } |
This file contains the ketCube Timer(s) driver.
+ +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.
+ketCube_Timer_usage_t timerUsed = { 0, 0, 0, 0, 0, 0, 0 } | +
+ KETCube
+
+ |
+
This file contains definitions for the ketCube Timer(s) driver. +More...
+#include "ketCube_cfg.h"
Go to the source code of this file.
++Data Structures | |
struct | ketCube_Timer_usage_t |
Timer Usage. More... | |
+Enumerations | |
enum | ketCube_Timer_list_t { + KETCUBE_TIMER_LIST_TIM2, +KETCUBE_TIMER_LIST_TIM3, +KETCUBE_TIMER_LIST_TIM21, +KETCUBE_TIMER_LIST_TIM22, + + KETCUBE_TIMER_LIST_TIM6, +KETCUBE_TIMER_LIST_TIM7, +KETCUBE_TIMER_LIST_LPTIM, +KETCUBE_TIMER_LIST_CNT + + } |
List of available timers. More... | |
+Functions | |
ketCube_cfg_ModError_t | ketCube_Timer_Init (ketCube_Timer_list_t tim) |
Configures Timer(s) More... | |
This file contains definitions for the ketCube Timer(s) driver.
+ +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.
+
+ KETCube
+
+ |
+
+ KETCube
+
+ |
+
This file contains the KETCube module txDisplay. +More...
+#include <stdio.h>
#include <string.h>
#include "ketCube_cfg.h"
#include "ketCube_common.h"
#include "ketCube_terminal.h"
#include "ketCube_modules.h"
#include "ketCube_txDisplay.h"
This file contains the KETCube module txDisplay.
+ +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.
+
+ KETCube
+
+ |
+
This file contains the KETCube txDisplay module definitions. +More...
+ +Go to the source code of this file.
++Enumerations | |
enum | ketCube_txDisplay_cfgAddr_t { KETCUBE_TXDISPLAY_CFGADR_CFG = 0 + } |
txDisplay CFG data relative addr. More... | |
enum | ketCube_txDisplay_cfgLen_t { KETCUBE_TXDISPLAY_CFGLEN_CFG = 1 + } |
Length of txDisplay CFG data. More... | |
+Functions | |
ketCube_cfg_ModError_t | ketCube_txDisplay_Init (ketCube_InterModMsg_t ***msg) |
ketCube_cfg_ModError_t | ketCube_txDisplay_Send (uint8_t *buffer, uint8_t *len) |
This file contains the KETCube txDisplay module definitions.
+ +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.
+
+ KETCube
+
+ |
+
Variables |
DEFINE_CALLBACK_FNC | +( | +TransmitCallback | +, | +
+ | + | fnTransmitCallback | ++ |
+ | ) | ++ |
TX complete callback for given channel.
+channel | UART channel |
▼KETCube Core | KETCube Core Parts |
▼KETCube Configuration Manager | KETCube Configuration Manager |
Included KETCube Modules | |
KETCube Common Deffinitions | KETCube Common deffinitions nd inline functions |
▼KETCube CfgCore | KETCube Core configuration |
Public Functions | |
KETCube Modules | KETCube Modules |
▼KETCube RxDisplay | KETCube Rx Display module |
Public Functions | |
▼KETCube Terminal | KETCube serial terminal |
KETCube LoRa CMD | KETCube LoRa module commandline deffinition |
▼KETCube AsyncTx | KETCube Async Tx module |
Public Functions | |
KETCube Configuration Manager | KETCube Configuration Manager |
KETCube Common Deffinitions | KETCube Common deffinitions nd inline functions |
▼KETCube CfgCore | KETCube Core configuration |
Public Functions | |
KETCube Modules | KETCube Modules |
▼KETCube RxDisplay | KETCube Rx Display module |
Public Functions | |
▼KETCube Terminal | KETCube serial terminal |
KETCube Terminal Severity print functions | KETCube Terminal Severity print functions |
KETCube LoRa CMD | KETCube LoRa module commandline deffinition |
▼KETCube Modules | KETCube Extension Modules |
▼KETCube Sensing Modules | KETCube Modules providing sensor functionality |
▼KETCube ADC | KETCube ADC module |
Public Functions | |
▼KETCube FDC2214 | KETCube FDC2214 module |
Public Functions | |
KETCUBE_FDC2214_Registers | |
▼KETCube HDC1080 | KETCube HDC1080 module |
▼Public Defines | Public defines |
HDC1080 Registers | |
Public Functions | Public functions |
▼KETCube batMeas | KETCube batMeas cnt module |
Public Functions | |
▼KETCube BMEx80 | KETCube BMEx80 module |
Public Defines | Public defines |
Public Functions | Public functions |
BMEx80 Registers | |
▼KETCube FDC2214 | KETCube FDC2214 module |
FDC2214 Settings | |
Public Functions | |
KETCUBE_FDC2214_Registers | |
▼KETCube HDC1080 | KETCube HDC1080 module |
▼Public Defines | Public defines |
HDC1080 Registers | |
Public Functions | Public functions |
▼KETCube LIS2HH12 | KETCube LIS2HH12 module |
▼Public Defines | Public defines |
LIS2HH12 Registers | |
LIS2HH12 CTRL1 flags | |
LIS2HH12 CTRL3 flags | |
LIS2HH12 IG_CFG1 flags | |
Public Functions | Public functions |
KETCube Actuating Modules | KETCube Modules providing actuator functionality |
▼KETCube Communication Modules | KETCube Modules providing communication functionality |
KETCube LoRa | KETCube LoRa module |
▼KETCube StarNet | KETCube StarNet module |
Public Functions | |
▼KETCube Drivers | KETCube peripheral drivers |
▼KETCube Core Drivers | KETCube peripheral drivers for KETCube Core |
KETCube EEPROM driver | KETCube EEPROM driver for STM32L082 |
KETCube UART driver | KETCube UART driver for STM32L0 |
▼KETCube Module Drivers | KETCube peripheral drivers for KETCube Modules |
▼KETCube I2C | KETCube I2C module |
Public Deffinitions | Public defines |
Public Functions | Public functions |
KETCube Main Board | KETCube Configuration Manager |
KETCube txDisplay | KETCube txDisplay module allows to vizualize KETCube Tx data |
▼KETCube Drivers | KETCube peripheral drivers |
▼KETCube Core Drivers | KETCube peripheral drivers for KETCube Core |
KETCube EEPROM driver | KETCube EEPROM driver for STM32L082 |
KETCube UART driver | KETCube UART driver for STM32L0 |
▼KETCube Module Drivers | KETCube peripheral drivers for KETCube Modules |
▼KETCube GPIO driver | KETCube GPIO driver |
Public Functions | Public functions |
▼KETCube I2C | KETCube I2C module |
Public Deffinitions | Public defines |
Public Functions | Public functions |
▼KETCube I2S | KETCube I2S module |
Public Deffinitions | Public defines |
Public Functions | Public functions |
▼KETCube Main Board | KETCube Configuration Manager |
KETCube options | KETCube mainBoard Solder Jumpers and optional parts |
Socket PINs | KETCube mainBoard SOCKET PINs |
Debug LEDs | KETCube mainBoard Debug LEDs |
▼KETCube timer | KETCube Timer module |
Public Functions | Public functions |
+ KETCube
+
+ |
+
Timer Usage. + More...
+ +#include <ketCube_timer.h>
+Data Fields | |
bool | tim2:1 |
bool | tim3:1 |
bool | tim21:1 |
bool | tim22:1 |
bool | tim6:1 |
bool | tim7:1 |
bool | lptim:1 |
Timer Usage.
+bool ketCube_Timer_usage_t::lptim | +
bool ketCube_Timer_usage_t::tim2 | +
bool ketCube_Timer_usage_t::tim21 | +
bool ketCube_Timer_usage_t::tim22 | +
bool ketCube_Timer_usage_t::tim3 | +
bool ketCube_Timer_usage_t::tim6 | +
bool ketCube_Timer_usage_t::tim7 | +
ketCube_UART_SimpleCbFn_t ketCube_UART_descriptor_t::fnTransmitCallback | +
+ KETCube
+
+ |
+
KETCube battery deffinition. + More...
+ +#include <ketCube_batMeas.h>
+Data Fields | |
char * | batName |
char * | batDescr |
uint16_t | batCharged |
uint16_t | batDischarged |
KETCube battery deffinition.
+uint16_t ketCube_batMeas_battery_t::batCharged | +
char* ketCube_batMeas_battery_t::batDescr | +
uint16_t ketCube_batMeas_battery_t::batDischarged | +
char* ketCube_batMeas_battery_t::batName | +
+ KETCube
+
+ |
+
Calibration data structure. + More...
+ +#include <ketCube_bmeX80.h>
+Data Fields | |
uint16_t | dig_T1 |
int16_t | dig_T2 |
int16_t | dig_T3 |
uint16_t | dig_P1 |
int16_t | dig_P2 |
int16_t | dig_P3 |
int16_t | dig_P4 |
int16_t | dig_P5 |
int16_t | dig_P6 |
int16_t | dig_P7 |
int16_t | dig_P8 |
int16_t | dig_P9 |
uint8_t | dig_H1 |
int16_t | dig_H2 |
uint8_t | dig_H3 |
int16_t | dig_H4 |
int16_t | dig_H5 |
int8_t | dig_H6 |
int32_t | t_fine |
Calibration data structure.
+uint8_t ketCube_bmeX80_Calib_t::dig_H1 | +
int16_t ketCube_bmeX80_Calib_t::dig_H2 | +
uint8_t ketCube_bmeX80_Calib_t::dig_H3 | +
int16_t ketCube_bmeX80_Calib_t::dig_H4 | +
int16_t ketCube_bmeX80_Calib_t::dig_H5 | +
int8_t ketCube_bmeX80_Calib_t::dig_H6 | +
uint16_t ketCube_bmeX80_Calib_t::dig_P1 | +
int16_t ketCube_bmeX80_Calib_t::dig_P2 | +
int16_t ketCube_bmeX80_Calib_t::dig_P3 | +
int16_t ketCube_bmeX80_Calib_t::dig_P4 | +
int16_t ketCube_bmeX80_Calib_t::dig_P5 | +
int16_t ketCube_bmeX80_Calib_t::dig_P6 | +
int16_t ketCube_bmeX80_Calib_t::dig_P7 | +
int16_t ketCube_bmeX80_Calib_t::dig_P8 | +
int16_t ketCube_bmeX80_Calib_t::dig_P9 | +
uint16_t ketCube_bmeX80_Calib_t::dig_T1 | +
int16_t ketCube_bmeX80_Calib_t::dig_T2 | +
int16_t ketCube_bmeX80_Calib_t::dig_T3 | +
int32_t ketCube_bmeX80_Calib_t::t_fine | +
uint8_t ketCube_cfg_ModuleCfgByte_t::RFU | +
ketCube_severity_t ketCube_cfg_ModuleCfgByte_t::severity | +
KETCube lora module configuration byte. Derived from.
@@ -119,6 +121,20 @@ketCube_severity_t ketCube_lora_moduleCfg_t::severity | +