ketCube_lora.h File Reference

This file contains the KETCube module wrapper for Semtech's LoRa. More...

#include "ketCube_cfg.h"
#include "ketCube_common.h"
#include "LoRaMac.h"

Go to the source code of this file.

Data Structures
struct	ketCube_lora_cfg_t
struct	ketCube_lora_moduleCfg_t
	KETCube lora module configuration. More...

Macros
#define	KETCUBE_LORA_SELCFG_KETCube   0
#define	KETCUBE_LORA_SELCFG_STATIC   1
#define	KETCUBE_LORA_SELCFG_SELECTED   KETCUBE_LORA_SELCFG_KETCube
#define	KETCUBE_LORA_RX_BUFFER_LEN   64

Typedefs
typedef struct ketCube_lora_cfg_t	ketCube_lora_cfg_t
typedef struct ketCube_lora_moduleCfg_t	ketCube_lora_moduleCfg_t
	KETCube lora module configuration. More...

Enumerations
enum	ketCube_lora_selDeveui_t { KETCUBE_LORA_SELDEVEUI_BOARD = 0, KETCUBE_LORA_SELDEVEUI_CUSTOM = 1 }
	LoRa devAddr type. More...
enum	ketCube_lora_selConnMethod_t { KETCUBE_LORA_SELCONNMETHOD_OTAA = 0, KETCUBE_LORA_SELCONNMETHOD_ABP = 1 }
	LoRa connection type. More...
enum	ketCube_lora_cfgLen_t {   KETCUBE_LORA_CFGLEN_DEVEUI = 8, KETCUBE_LORA_CFGLEN_APPEUI = 8, KETCUBE_LORA_CFGLEN_APPKEY = 16, KETCUBE_LORA_CFGLEN_NETID = 3,   KETCUBE_LORA_CFGLEN_NWKKEY = 16, KETCUBE_LORA_CFGLEN_DEVADDR = 4, KETCUBE_LORA_CFGLEN_NWKSENCKEY = 16, KETCUBE_LORA_CFGLEN_SNWKSINTKEY = 16,   KETCUBE_LORA_CFGLEN_FNWKSINTKEY = 16, KETCUBE_LORA_CFGLEN_APPSKEY = 16 }
	Length of LoRa CFG data. More...

Functions
ketCube_cfg_ModError_t	ketCube_lora_Init (ketCube_InterModMsg_t ***msg)
	Load basic module configuration data from EEPROM. More...
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...
ketCube_cfg_ModError_t	ketCube_lora_SleepExit (void)
	Exit sleep mode. More...
void	ketCube_lora_processCustomData (uint8_t *buffer, uint8_t len)
	Process custom data. More...

Variables
ketCube_lora_moduleCfg_t	ketCube_lora_moduleCfg

Detailed Description

This file contains the KETCube module wrapper for Semtech's LoRa.

Author

Jan Belohoubek

Version

0.1

Date

2018-01-05

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.