Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Fork of OmniWheels by
lorawan_data_structures.h File Reference
Contains common data structures used by Mbed-OS LoRaWAN mplementation. More...
Go to the source code of this file.
Detailed Description
Contains common data structures used by Mbed-OS LoRaWAN mplementation.
______ _ / _____) _ | | ( (____ _____ ____ _| |_ _____ ____| |__ \____ \| ___ | (_ _) ___ |/ ___) _ \ _____) ) ____| | | || |_| ____( (___| | | | (______/|_____)_|_|_| \__)_____)\____)_| |_| (C)2013 Semtech ___ _____ _ ___ _ _____ ___ ___ ___ ___ / __|_ _/_\ / __| |/ / __/ _ \| _ \/ __| __| \__ \ | |/ _ \ (__| ' <| _| (_) | / (__| _| |___/ |_/_/ \_\___|_|\_\_| \___/|_|_\\___|___| embedded.connectivity.solutions===============
Description: LoRa PHY layer
License: Revised BSD License, see LICENSE.TXT file include in the project
Maintainer: Miguel Luis ( Semtech ), Gregory Cristian ( Semtech ) and Daniel Jaeckle ( STACKFORCE )
Copyright (c) 2017, Arm Limited and affiliates. SPDX-License-Identifier: BSD-3-Clause
Definition in file lorawan_data_structures.h.
Typedef Documentation
| typedef struct compliance_test compliance_test_t |
LoRaWAN compliance tests support data.
| typedef struct lora_channels_s loramac_channel_t |
Structure to hold A list of LoRa Channels.
| typedef struct lorawan_connect lorawan_connect_t |
lorawan_connect_t structure
A structure representing the parameters for different connections.
| typedef enum lorawan_connect_type lorawan_connect_type_t |
Enum of LoRaWAN connection type.
The LoRaWAN connection type specifies how an end-device connects to the gateway.
| typedef enum lora_events lorawan_event_t |
LoRaWAN callback functions.
| typedef struct lorawan_session lorawan_session_t |
LoRaWAN session.
A structure for keeping session details.
| typedef enum lorawan_status lorawan_status_t |
LoRaMAC status.
| typedef uint32_t lorawan_time_t |
Timer time variable definition.
Definition at line 44 of file lorawan_data_structures.h.
| typedef struct multicast_params_s multicast_params_t |
LoRaMAC multicast channel parameter.
Enumeration Type Documentation
LoRaMAC battery level indicator.
- Enumerator:
BAT_LEVEL_EXT_SRC An external power source.
BAT_LEVEL_EMPTY Battery level empty.
BAT_LEVEL_FULL Battery level full.
BAT_LEVEL_NO_MEASURE Battery level - no measurement available.
Definition at line 531 of file lorawan_data_structures.h.
| enum device_class_t |
LoRaWAN device classes definition.
LoRaWAN Specification V1.0.2, chapter 2.1.
- Enumerator:
Definition at line 137 of file lorawan_data_structures.h.
| enum lora_events |
LoRaWAN callback functions.
Definition at line 2275 of file lorawan_data_structures.h.
The enumeration containing the status of the operation of a MAC service.
- Enumerator:
Definition at line 621 of file lorawan_data_structures.h.
LoRaMac internal states
Definition at line 1991 of file lorawan_data_structures.h.
| enum lorawan_connect_type |
Enum of LoRaWAN connection type.
The LoRaWAN connection type specifies how an end-device connects to the gateway.
- Enumerator:
LORAWAN_CONNECTION_OTAA Over The Air Activation.
LORAWAN_CONNECTION_ABP Activation By Personalization.
Definition at line 1618 of file lorawan_data_structures.h.
| enum lorawan_status |
LoRaMAC status.
- Enumerator:
Definition at line 1556 of file lorawan_data_structures.h.
| enum mac_frame_type_t |
LoRaMAC frame types.
LoRaWAN Specification V1.0.2, chapter 4.2.1, table 1.
- Enumerator:
Definition at line 405 of file lorawan_data_structures.h.
| enum mcps_type_t |
LoRaMAC data services.
The following table list the primitives supported by a specific MAC data service:
Name | Request | Indication | Response | Confirm --------------------- | :-----: | :--------: | :------: | :-----: MCPS_UNCONFIRMED | YES | YES | NO | YES MCPS_CONFIRMED | YES | YES | NO | YES MCPS_MULTICAST | NO | YES | NO | NO MCPS_PROPRIETARY | YES | YES | NO | YES
The following table provides links to the function implementations of the related MCPS primitives:
Primitive | Function ---------------- | :---------------------: MCPS-Request | LoRaMacMlmeRequest MCPS-Confirm | MacMcpsConfirm in loramac_primitives_t MCPS-Indication | MacMcpsIndication in loramac_primitives_t
- Enumerator:
MCPS_UNCONFIRMED Unconfirmed LoRaMAC frame.
MCPS_CONFIRMED Confirmed LoRaMAC frame.
MCPS_MULTICAST Multicast LoRaMAC frame.
MCPS_PROPRIETARY Proprietary frame.
Definition at line 746 of file lorawan_data_structures.h.
| enum mib_type_t |
LoRa MAC Information Base (MIB).
The following table lists the MIB parameters and the related attributes:
Attribute | Get | Set --------------------------------- | :-: | :-: MIB_DEVICE_CLASS | YES | YES MIB_NETWORK_JOINED | YES | YES MIB_ADR | YES | YES MIB_NET_ID | YES | YES MIB_DEV_ADDR | YES | YES MIB_NWK_SKEY | YES | YES MIB_APP_SKEY | YES | YES MIB_PUBLIC_NETWORK | YES | YES MIB_REPEATER_SUPPORT | YES | YES MIB_CHANNELS | YES | NO MIB_RX2_CHANNEL | YES | YES MIB_CHANNELS_MASK | YES | YES MIB_CHANNELS_DEFAULT_MASK | YES | YES MIB_CHANNELS_NB_REP | YES | YES MIB_MAX_RX_WINDOW_DURATION | YES | YES MIB_RECEIVE_DELAY_1 | YES | YES MIB_RECEIVE_DELAY_2 | YES | YES MIB_JOIN_ACCEPT_DELAY_1 | YES | YES MIB_JOIN_ACCEPT_DELAY_2 | YES | YES MIB_CHANNELS_DATARATE | YES | YES MIB_CHANNELS_DEFAULT_DATARATE| YES | YES MIB_CHANNELS_TX_POWER | YES | YES MIB_CHANNELS_DEFAULT_TX_POWER| YES | YES MIB_UPLINK_COUNTER | YES | YES MIB_DOWNLINK_COUNTER | YES | YES MIB_MULTICAST_CHANNEL | YES | NO MIB_SYSTEM_MAX_RX_ERROR | YES | YES MIB_MIN_RX_SYMBOLS | YES | YES MIB_ANTENNA_GAIN | YES | YES
The following table provides links to the function implementations of the related MIB primitives:
Primitive | Function ---------------- | :---------------------: MIB-Set | LoRaMacMibSetRequestConfirm MIB-Get | LoRaMacMibGetRequestConfirm
- Enumerator:
Definition at line 1139 of file lorawan_data_structures.h.
| enum mlme_type_t |
LoRaMAC management services.
The following table list the primitives supported by a specific MAC management service:
Name | Request | Indication | Response | Confirm ---------------------------- | :-----: | :--------: | :------: | :-----: MLME_JOIN | YES | NO | NO | YES MLME_LINK_CHECK | YES | NO | NO | YES MLME_TXCW | YES | NO | NO | YES MLME_SCHEDULE_UPLINK | NO | YES | NO | NO
The following table provides links to the function implementations of the related MLME primitives.
Primitive | Function ---------------- | :---------------------: MLME-Request | LoRaMacMlmeRequest MLME-Confirm | MacMlmeConfirm in loramac_primitives_t MLME-Indication | MacMlmeIndication in loramac_primitives_t
- Enumerator:
Definition at line 950 of file lorawan_data_structures.h.
| enum mote_mac_cmds_t |
LoRaMAC mote MAC commands.
LoRaWAN Specification V1.0.2, chapter 5, table 4.
- Enumerator:
Definition at line 445 of file lorawan_data_structures.h.
| enum rx_msg_type |
lora_mac_rx_message_type_t
An enum representing a structure for RX messages.
- Enumerator:
LORAMAC_RX_MLME_CONFIRM lora_mac_mlme_confirm_t
LORAMAC_RX_MCPS_CONFIRM lora_mac_mcps_confirm_t
LORAMAC_RX_MCPS_INDICATION lora_mac_mcps_indication_t
Definition at line 1756 of file lorawan_data_structures.h.
| enum rx_slot_t |
LoRaMAC receive window enumeration
- Enumerator:
Definition at line 267 of file lorawan_data_structures.h.
| enum server_mac_cmds_t |
LoRaMAC server MAC commands.
LoRaWAN Specification V1.0.2 chapter 5, table 4.
- Enumerator:
Definition at line 489 of file lorawan_data_structures.h.
Generated on Fri Jul 22 2022 04:54:06 by
1.7.2
