#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... | |
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.
Sets local handles to NULL. These handles will be set when the subsystem is activated by the MAC layer.
| ~LoRaMacChannelPlan | ( | ) |
Destructor.
Does nothing
| void activate_channelplan_subsystem | ( | LoRaPHY * | phy | ) |
Activates Channel Planning subsystem.
Stores pointers to PHY layer MIB subsystem
| phy | pointer 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.
| plan | a reference to application provided channel plan structure which gets filled in with active channel plan data. |
| channel_list | pointer to structure containing channel information |
| lorawan_status_t remove_plan | ( | ) |
Remove the active channel plan.
Drops the whole channel list except the 'Default Channels' ofcourse.
| lorawan_status_t remove_single_channel | ( | uint8_t | id | ) |
Remove a single channel from the plan.
| id | the channel id which needs to be removed |
| 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.
| plan | a reference to application channel plan. PHY layer takes a copy of the channel parameters provided within. |
