KETCube
ketCube_starNet.h
Go to the documentation of this file.
1 
45 /* Define to prevent recursive inclusion -------------------------------------*/
46 #ifndef __KETCUBE_STARNET_H
47 #define __KETCUBE_STARNET_H
48 
49 #include "ketCube_cfg.h"
50 #include "ketCube_common.h"
51 #include "ketCube_terminal.h"
52 
65 
68 
69 
70 #if defined( REGION_AS923 )
71 
72 #define KETCUBE_STARNET_RF_FREQUENCY 923000000 // Hz
73 
74 #elif defined( REGION_AU915 )
75 
76 #define KETCUBE_STARNET_RF_FREQUENCY 915000000 // Hz
77 
78 #elif defined( REGION_CN470 )
79 
80 #define KETCUBE_STARNET_RF_FREQUENCY 470000000 // Hz
81 
82 #elif defined( REGION_CN779 )
83 
84 #define KETCUBE_STARNET_RF_FREQUENCY 779000000 // Hz
85 
86 #elif defined( REGION_EU433 )
87 
88 #define KETCUBE_STARNET_RF_FREQUENCY 433000000 // Hz
89 
90 #elif defined( REGION_EU868 )
91 
92 #define KETCUBE_STARNET_RF_FREQUENCY 868000000 // Hz
93 
94 #elif defined( REGION_KR920 )
95 
96 #define KETCUBE_STARNET_RF_FREQUENCY 920000000 // Hz
97 
98 #elif defined( REGION_IN865 )
99 
100 #define KETCUBE_STARNET_RF_FREQUENCY 865000000 // Hz
101 
102 #elif defined( REGION_US915 )
103 
104 #define KETCUBE_STARNET_RF_FREQUENCY 915000000 // Hz
105 
106 #elif defined( REGION_RU864 )
107 
108 #define KETCUBE_STARNET_RF_FREQUENCY 864000000 // Hz
109 
110 #else
111  #error "Define the frequency band in the compiler options."
112 #endif
113 
114 
115 #define KETCUBE_STARNET_TX_OUTPUT_POWER 14
116 #define KETCUBE_STARNET_DATA_BUFFER_LEN 64
121 typedef enum {
122  KETCUBE_STARNET_OK = (uint8_t) 0,
125 
129 typedef enum {
136 
143 
147 typedef enum {
151 
153 
162 
164 extern ketCube_cfg_ModError_t ketCube_starNet_sendData(uint8_t * buffer,
165  uint8_t * len);
166 
167 
168 
179 #endif /* __KETCUBE_STARNET_H */
ketCube_starNet_State_t
ketCube_starNet_State_t
StarNet states.
Definition: ketCube_starNet.h:129
KETCUBE_STARNET_ERROR
@ KETCUBE_STARNET_ERROR
Definition: ketCube_starNet.h:123
ketCube_starNetNode_moduleCfg
ketCube_starNet_moduleCfg_t ketCube_starNetNode_moduleCfg
Definition: ketCube_starNet.c:64
KETCUBE_STARNET_STATE_RX_DONE
@ KETCUBE_STARNET_STATE_RX_DONE
Definition: ketCube_starNet.h:138
ketCube_InterModMsg_t
KETCube inter-module message.
Definition: ketCube_cfg.h:116
KETCUBE_STARNET_STATE_TX_NEW_DATA
@ KETCUBE_STARNET_STATE_TX_NEW_DATA
Definition: ketCube_starNet.h:132
ketCube_starNet_moduleCfg_t::coreCfg
ketCube_cfg_ModuleCfgByte_t coreCfg
Definition: ketCube_starNet.h:63
ketCube_starNet_sendData
ketCube_cfg_ModError_t ketCube_starNet_sendData(uint8_t *buffer, uint8_t *len)
Send sensor data.
Definition: ketCube_starNet.c:289
ketCube_starNet_ConcentratorInit
ketCube_cfg_ModError_t ketCube_starNet_ConcentratorInit(ketCube_InterModMsg_t ***msg)
Initialize starNet Concentrator.
Definition: ketCube_starNet.c:261
ketCube_cfg_ModuleCfgByte_t
KETCube module configuration byte.
Definition: ketCube_cfg.h:147
KETCUBE_STARNET_STATE_RX_PROGRESS
@ KETCUBE_STARNET_STATE_RX_PROGRESS
Definition: ketCube_starNet.h:139
KETCUBE_STARNET_CONCENTRATOR
@ KETCUBE_STARNET_CONCENTRATOR
Definition: ketCube_starNet.h:148
KETCUBE_STARNET_STATE_TX_DONE
@ KETCUBE_STARNET_STATE_TX_DONE
Definition: ketCube_starNet.h:131
KETCUBE_STARNET_STATE_TX_READY
@ KETCUBE_STARNET_STATE_TX_READY
Definition: ketCube_starNet.h:130
KETCUBE_STARNET_STATE_TX_ERROR
@ KETCUBE_STARNET_STATE_TX_ERROR
Definition: ketCube_starNet.h:135
ketCube_starNet_NodeType_t
ketCube_starNet_NodeType_t
Node type.
Definition: ketCube_starNet.h:147
KETCUBE_STARNET_STATE_RX_TIMEOUT
@ KETCUBE_STARNET_STATE_RX_TIMEOUT
Definition: ketCube_starNet.h:140
ketCube_starNet_NodeInit
ketCube_cfg_ModError_t ketCube_starNet_NodeInit(ketCube_InterModMsg_t ***msg)
Initialize starNet Node.
Definition: ketCube_starNet.c:273
KETCUBE_STARNET_OK
@ KETCUBE_STARNET_OK
Definition: ketCube_starNet.h:122
KETCUBE_STARNET_STATE_TX_TIMEOUT
@ KETCUBE_STARNET_STATE_TX_TIMEOUT
Definition: ketCube_starNet.h:134
ketCube_terminal.h
This file contains definitions for the terminal.
ketCube_common.h
KETCube common definitions.
KETCUBE_STARNET_NODE
@ KETCUBE_STARNET_NODE
Definition: ketCube_starNet.h:149
ketCube_starNet_moduleCfg_t
KETCube module configuration.
Definition: ketCube_starNet.h:62
KETCUBE_STARNET_STATE_RX_ERROR
@ KETCUBE_STARNET_STATE_RX_ERROR
Definition: ketCube_starNet.h:141
ketCube_starNet_SleepEnter
ketCube_cfg_ModError_t ketCube_starNet_SleepEnter(void)
Prepare sleep mode.
Definition: ketCube_starNet.c:106
KETCUBE_STARNET_STATE_TX_PROGRESS
@ KETCUBE_STARNET_STATE_TX_PROGRESS
Definition: ketCube_starNet.h:133
ketCube_starNetConcentrator_moduleCfg
ketCube_starNet_moduleCfg_t ketCube_starNetConcentrator_moduleCfg
Definition: ketCube_starNet.c:63
KETCUBE_STARNET_STATE_RX_READY
@ KETCUBE_STARNET_STATE_RX_READY
Definition: ketCube_starNet.h:137
ketCube_starNet_nodeType
ketCube_starNet_NodeType_t ketCube_starNet_nodeType
Definition: ketCube_starNet.c:85
ketCube_cfg.h
This file contains definitions for the KETCube configuration.
ketCube_starNet_Error_t
ketCube_starNet_Error_t
Error code type.
Definition: ketCube_starNet.h:121
ketCube_cfg_ModError_t
ketCube_cfg_ModError_t
Error code type.
Definition: ketCube_cfg.h:100
ketCube_starNet_moduleCfg_t
struct ketCube_starNet_moduleCfg_t ketCube_starNet_moduleCfg_t
KETCube module configuration.