Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions
LoRaMacChannelPlan Class Reference

#include <LoRaMacChannelPlan.h>

Public Member Functions

 LoRaMacChannelPlan ()
 Constructor. More...
 
 ~LoRaMacChannelPlan ()
 Destructor. More...
 
void activate_channelplan_subsystem (LoRaPHY *phy)
 Activates Channel Planning subsystem. More...
 
lorawan_status_t set_plan (const lorawan_channelplan_t &plan)
 Set a given channel plan. More...
 
lorawan_status_t get_plan (lorawan_channelplan_t &plan, const channel_params_t *channel_list)
 Access the active channel plan. More...
 
lorawan_status_t remove_plan ()
 Remove the active channel plan. More...
 
lorawan_status_t remove_single_channel (uint8_t id)
 Remove a single channel from the plan. More...
 

Detailed Description

/ _____) _ | |
( (____ _____ ____ _| |_ _____ ____| |__
\____ \| ___ | (_ _) ___ |/ ___) _ \
_____) ) ____| | | || |_| ____( (___| | | |
(______/|_____)_|_|_| \__)_____)\____)_| |_|
(C)2013 Semtech
___ _____ _ ___ _ _____ ___ ___ ___ ___
/ __|_ _/_\ / __| |/ / __/ _ \| _ \/ __| __|
\__ \ | |/ _ \ (__| ' <| _| (_) | / (__| _|
|___/ |_/_/ \_\___|_|\_\_| \___/|_|_\\___|___|
embedded.connectivity.solutions===============

Description: LoRaWAN stack layer that controls both MAC and PHY underneath

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 at line 34 of file LoRaMacChannelPlan.h.

Constructor & Destructor Documentation

Constructor.

Sets local handles to NULL. These handles will be set when the subsystem is activated by the MAC layer.

Destructor.

Does nothing

Member Function Documentation

void activate_channelplan_subsystem ( LoRaPHY phy)

Activates Channel Planning subsystem.

Stores pointers to PHY layer MIB subsystem

Parameters
phypointer to PHY layer
lorawan_status_t get_plan ( lorawan_channelplan_t plan,
const channel_params_t channel_list 
)

Access the active channel plan.

Used to get active channel plan.

Parameters
plana reference to application provided channel plan structure which gets filled in with active channel plan data.
channel_listpointer to structure containing channel information
Returns
LORAWAN_STATUS_OK if everything goes well otherwise a negative error code is returned.
lorawan_status_t remove_plan ( )

Remove the active channel plan.

Drops the whole channel list except the 'Default Channels' ofcourse.

Returns
LORAWAN_STATUS_OK if everything goes well otherwise a negative error code is returned.
lorawan_status_t remove_single_channel ( uint8_t  id)

Remove a single channel from the plan.

Parameters
idthe channel id which needs to be removed
Returns
LORAWAN_STATUS_OK if everything goes well otherwise a negative error code is returned.
lorawan_status_t set_plan ( const lorawan_channelplan_t plan)

Set a given channel plan.

Used to set application provided channel plan. This API can be used to set a single channel as well to the existing channel plan.

Parameters
plana reference to application channel plan. PHY layer takes a copy of the channel parameters provided within.
Returns
LORAWAN_STATUS_OK if everything goes well otherwise a negative error code is returned.
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.