lorawan.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Manivannan Sadhasivam <[email protected]>
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_LORAWAN_LORAWAN_H_
#define ZEPHYR_INCLUDE_LORAWAN_LORAWAN_H_
 
#include <zephyr/device.h>
#include <zephyr/sys/slist.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum lorawan_class {
 LORAWAN_CLASS_A = 0x00, 
 LORAWAN_CLASS_B = 0x01, 
 LORAWAN_CLASS_C = 0x02, 
};
 
enum lorawan_act_type {
 LORAWAN_ACT_OTAA = 0, 
 LORAWAN_ACT_ABP, 
};
 
enum lorawan_channels_mask_size {
 LORAWAN_CHANNELS_MASK_SIZE_AS923 = 1, 
 LORAWAN_CHANNELS_MASK_SIZE_AU915 = 6, 
 LORAWAN_CHANNELS_MASK_SIZE_CN470 = 6, 
 LORAWAN_CHANNELS_MASK_SIZE_CN779 = 1, 
 LORAWAN_CHANNELS_MASK_SIZE_EU433 = 1, 
 LORAWAN_CHANNELS_MASK_SIZE_EU868 = 1, 
 LORAWAN_CHANNELS_MASK_SIZE_KR920 = 1, 
 LORAWAN_CHANNELS_MASK_SIZE_IN865 = 1, 
 LORAWAN_CHANNELS_MASK_SIZE_US915 = 6, 
 LORAWAN_CHANNELS_MASK_SIZE_RU864 = 1, 
};
 
enum lorawan_datarate {
 LORAWAN_DR_0 = 0, 
 LORAWAN_DR_1, 
 LORAWAN_DR_2, 
 LORAWAN_DR_3, 
 LORAWAN_DR_4, 
 LORAWAN_DR_5, 
 LORAWAN_DR_6, 
 LORAWAN_DR_7, 
 LORAWAN_DR_8, 
 LORAWAN_DR_9, 
 LORAWAN_DR_10, 
 LORAWAN_DR_11, 
 LORAWAN_DR_12, 
 LORAWAN_DR_13, 
 LORAWAN_DR_14, 
 LORAWAN_DR_15, 
};
 
enum lorawan_region {
 LORAWAN_REGION_AS923, 
 LORAWAN_REGION_AU915, 
 LORAWAN_REGION_CN470, 
 LORAWAN_REGION_CN779, 
 LORAWAN_REGION_EU433, 
 LORAWAN_REGION_EU868, 
 LORAWAN_REGION_KR920, 
 LORAWAN_REGION_IN865, 
 LORAWAN_REGION_US915, 
 LORAWAN_REGION_RU864, 
};
 
enum lorawan_message_type {
 LORAWAN_MSG_UNCONFIRMED = 0, 
 LORAWAN_MSG_CONFIRMED, 
};
 
struct lorawan_join_otaa {
 uint8_t *join_eui;
 uint8_t *nwk_key;
 uint8_t *app_key;
 uint16_t dev_nonce;
};
 
struct lorawan_join_abp {
 uint32_t dev_addr;
 uint8_t *app_skey;
 uint8_t *nwk_skey;
 uint8_t *app_eui;
};
 
struct lorawan_join_config {
 union {
 struct lorawan_join_otaa otaa; 
 struct lorawan_join_abp abp; 
 };
 
 uint8_t *dev_eui;
 
 enum lorawan_act_type mode;
};
 
#define LW_RECV_PORT_ANY UINT16_MAX
 
struct lorawan_downlink_cb {
 uint16_t port;
 void (*cb)(uint8_t port, bool data_pending,
 int16_t rssi, int8_t snr,
 uint8_t len, const uint8_t *data);
 sys_snode_t node;
};
 
typedef uint8_t (*lorawan_battery_level_cb_t)(void);
 
typedef void (*lorawan_dr_changed_cb_t)(enum lorawan_datarate dr);
 
void lorawan_register_battery_level_callback(lorawan_battery_level_cb_t cb);
 
void lorawan_register_downlink_callback(struct lorawan_downlink_cb *cb);
 
void lorawan_register_dr_changed_callback(lorawan_dr_changed_cb_t cb);
 
int lorawan_join(const struct lorawan_join_config *config);
 
int lorawan_start(void);
 
int lorawan_send(uint8_t port, uint8_t *data, uint8_t len, enum lorawan_message_type type);
 
int lorawan_set_class(enum lorawan_class dev_class);
 
int lorawan_set_conf_msg_tries(uint8_t tries);
 
void lorawan_enable_adr(bool enable);
 
int lorawan_set_channels_mask(uint16_t *channels_mask, size_t channels_mask_size);
 
int lorawan_set_datarate(enum lorawan_datarate dr);
 
enum lorawan_datarate lorawan_get_min_datarate(void);
 
void lorawan_get_payload_sizes(uint8_t *max_next_payload_size,
 uint8_t *max_payload_size);
 
int lorawan_set_region(enum lorawan_region region);
 
#ifdef CONFIG_LORAWAN_APP_CLOCK_SYNC
 
int lorawan_clock_sync_run(void);
 
int lorawan_clock_sync_get(uint32_t *gps_time);
 
#endif /* CONFIG_LORAWAN_APP_CLOCK_SYNC */
 
#ifdef CONFIG_LORAWAN_FRAG_TRANSPORT
 
int lorawan_frag_transport_run(void (*transport_finished_cb)(void));
 
#endif /* CONFIG_LORAWAN_FRAG_TRANSPORT */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_LORAWAN_LORAWAN_H_ */