ketCube_starNet.h File Reference

This file contains definitions for the KETCube starNet node and concentrator modules. More...

#include "ketCube_cfg.h"
#include "ketCube_common.h"
#include "ketCube_terminal.h"

Go to the source code of this file.

Data Structures
struct	ketCube_starNet_moduleCfg_t
	KETCube module configuration. More...

Macros
#define	KETCUBE_STARNET_TX_OUTPUT_POWER   14
#define	KETCUBE_STARNET_DATA_BUFFER_LEN   64

Typedefs
typedef struct ketCube_starNet_moduleCfg_t	ketCube_starNet_moduleCfg_t
	KETCube module configuration. More...

Enumerations
enum	ketCube_starNet_Error_t { KETCUBE_STARNET_OK = (uint8_t) 0, KETCUBE_STARNET_ERROR = !KETCUBE_STARNET_OK }
	Error code type. More...
enum	ketCube_starNet_State_t {   KETCUBE_STARNET_STATE_TX_READY, KETCUBE_STARNET_STATE_TX_DONE, KETCUBE_STARNET_STATE_TX_NEW_DATA, KETCUBE_STARNET_STATE_TX_PROGRESS,   KETCUBE_STARNET_STATE_TX_TIMEOUT, KETCUBE_STARNET_STATE_TX_ERROR, KETCUBE_STARNET_STATE_RX_READY, KETCUBE_STARNET_STATE_RX_DONE,   KETCUBE_STARNET_STATE_RX_PROGRESS, KETCUBE_STARNET_STATE_RX_TIMEOUT, KETCUBE_STARNET_STATE_RX_ERROR }
	StarNet states. More...
enum	ketCube_starNet_NodeType_t { KETCUBE_STARNET_CONCENTRATOR, KETCUBE_STARNET_NODE }
	Node type. More...

Functions
ketCube_cfg_ModError_t	ketCube_starNet_NodeInit (ketCube_InterModMsg_t ***msg)
	Initialize starNet Node. More...
ketCube_cfg_ModError_t	ketCube_starNet_ConcentratorInit (ketCube_InterModMsg_t ***msg)
	Initialize starNet Concentrator. More...
ketCube_cfg_ModError_t	ketCube_starNet_SleepEnter (void)
	Prepare sleep mode. More...
ketCube_cfg_ModError_t	ketCube_starNet_sendData (uint8_t *buffer, uint8_t *len)
	Send sensor data. More...

Variables
ketCube_starNet_moduleCfg_t	ketCube_starNetConcentrator_moduleCfg
ketCube_starNet_moduleCfg_t	ketCube_starNetNode_moduleCfg
ketCube_starNet_NodeType_t	ketCube_starNet_nodeType

Detailed Description

This file contains definitions for the KETCube starNet node and concentrator modules.

Author

Jan Belohoubek

Version

0.2

Date

2019-08-27

Attention

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

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

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

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimers.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimers in the documentation and/or other materials provided with the distribution.
• Neither the names of The SmartCampus Team, Department of Technologies and Measurement and Faculty of Electrical Engineering University of West Bohemia in Pilsen, nor the names of its contributors may be used to endorse or promote products derived from this Software without specific prior written permission.

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.