LoRaWAN

Copyright (c) 2017, Arm Limited and affiliates. More...

Data Structures
struct	rf_ctrls
	Structure to hold RF controls for LoRa Radio. More...
struct	radio_fsk_settings
	FSK modem parameters. More...
struct	radio_fsk_packet_handler
	FSK packet handle. More...
struct	radio_lora_settings
	LoRa modem parameters. More...
struct	radio_lora_packet_handler
	LoRa packet Contains information about a LoRa packet. More...
struct	radio_settings
	Global radio settings. More...
struct	radio_events
	Reporting functions for upper layers. More...
class	LoRaRadio
	Interface for the radios, containing the main functions that a radio needs, and five callback functions. More...
class	LoRaWANInterface
	LoRaWANInterface Class A network interface for LoRaWAN. More...

Typedefs
typedef enum radio_state	radio_state_t
	Radio driver internal state. More...
typedef enum modem_type	radio_modems_t
	Type of modem. More...
typedef struct radio_fsk_settings	radio_fsk_settings_t
	FSK modem parameters. More...
typedef struct radio_fsk_packet_handler	radio_fsk_packet_handler_t
	FSK packet handle. More...
typedef struct radio_lora_settings	radio_lora_settings_t
	LoRa modem parameters. More...
typedef struct radio_lora_packet_handler	radio_lora_packet_handler_t
	LoRa packet Contains information about a LoRa packet. More...
typedef struct radio_settings	radio_settings_t
	Global radio settings. More...
typedef struct radio_events	radio_events_t
	Reporting functions for upper layers. More...

Enumerations
enum	radio_state { RF_IDLE = 0 , RF_RX_RUNNING , RF_TX_RUNNING , RF_CAD }
	Radio driver internal state. More...
enum	modem_type { MODEM_FSK = 0 , MODEM_LORA }
	Type of modem. More...

Detailed Description

Copyright (c) 2017, Arm Limited and affiliates.

License: Revised BSD License, see LICENSE.TXT file include in the project.

SPDX-License-Identifier: Apache-2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Parent class for a LoRa radio driver

SPDX-License-Identifier: Apache-2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Mbed OS LoRaWAN Stack

Copyright (c) 2017, Arm Limited and affiliates.

SPDX-License-Identifier: BSD-3-Clause

Typedef Documentation

radio_state_t

typedef enum radio_state radio_state_t

Radio driver internal state.

Helps identify current state of the transceiver.

radio_modems_t

typedef enum modem_type radio_modems_t

Type of modem.

[LORA/FSK]

radio_fsk_settings_t

typedef struct radio_fsk_settings radio_fsk_settings_t

FSK modem parameters.

Parameters encompassing FSK modulation.

radio_fsk_packet_handler_t

typedef struct radio_fsk_packet_handler radio_fsk_packet_handler_t

FSK packet handle.

Contains information about an FSK packet and various metadata.

radio_lora_settings_t

typedef struct radio_lora_settings radio_lora_settings_t

LoRa modem parameters.

Parameters encompassing LoRa modulation.

radio_lora_packet_handler_t

typedef struct radio_lora_packet_handler radio_lora_packet_handler_t

LoRa packet Contains information about a LoRa packet.

radio_settings_t

typedef struct radio_settings radio_settings_t

Global radio settings.

Contains settings for the overall transceiver operation.

radio_events_t

typedef struct radio_events radio_events_t

Reporting functions for upper layers.

The radio driver reports various vital events to the upper controlling layers using callback functions provided by the upper layers at the initialization phase.

Enumeration Type Documentation

radio_state

enum radio_state

Radio driver internal state.

Helps identify current state of the transceiver.

Enumerator
RF_IDLE	IDLE state. Radio is in idle state.
RF_RX_RUNNING	RX state. Radio is receiving.
RF_TX_RUNNING	TX state. Radio is transmitting.
RF_CAD	CAD state. Radio is detecting channel activity.

Definition at line 78 of file LoRaRadio.h.

modem_type

enum modem_type

Type of modem.

[LORA/FSK]

Enumerator
MODEM_FSK	FSK operation mode. Radio is using FSK modulation.
MODEM_LORA	LoRa operation mode. Radio is using LoRa modulation.

Definition at line 103 of file LoRaRadio.h.