takashi kadono / Mbed OS Nucleo_446

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.

Dependencies:   ssd1331

mbed-os/features/lorawan/LoRaWANInterface.h@3:f3764f852aa8, 2018-10-11 (annotated)

Committer:
kadonotakashi
Date:
Thu Oct 11 02:27:46 2018 +0000
Revision:
3:f3764f852aa8
Parent:
0:8fdf9a60065b 
Nucreo 446 + SSD1331 test version;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kadonotakashi 0:8fdf9a60065b 1 /**
kadonotakashi 0:8fdf9a60065b 2 * Copyright (c) 2017, Arm Limited and affiliates.
kadonotakashi 0:8fdf9a60065b 3 * SPDX-License-Identifier: Apache-2.0
kadonotakashi 0:8fdf9a60065b 4 *
kadonotakashi 0:8fdf9a60065b 5 * Licensed under the Apache License, Version 2.0 (the "License");
kadonotakashi 0:8fdf9a60065b 6 * you may not use this file except in compliance with the License.
kadonotakashi 0:8fdf9a60065b 7 * You may obtain a copy of the License at
kadonotakashi 0:8fdf9a60065b 8 *
kadonotakashi 0:8fdf9a60065b 9 * http://www.apache.org/licenses/LICENSE-2.0
kadonotakashi 0:8fdf9a60065b 10 *
kadonotakashi 0:8fdf9a60065b 11 * Unless required by applicable law or agreed to in writing, software
kadonotakashi 0:8fdf9a60065b 12 * distributed under the License is distributed on an "AS IS" BASIS,
kadonotakashi 0:8fdf9a60065b 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kadonotakashi 0:8fdf9a60065b 14 * See the License for the specific language governing permissions and
kadonotakashi 0:8fdf9a60065b 15 * limitations under the License.
kadonotakashi 0:8fdf9a60065b 16 */
kadonotakashi 0:8fdf9a60065b 17
kadonotakashi 0:8fdf9a60065b 18 #ifndef LORAWANINTERFACE_H_
kadonotakashi 0:8fdf9a60065b 19 #define LORAWANINTERFACE_H_
kadonotakashi 0:8fdf9a60065b 20
kadonotakashi 0:8fdf9a60065b 21 #include "platform/Callback.h"
kadonotakashi 0:8fdf9a60065b 22 #include "platform/ScopedLock.h"
kadonotakashi 0:8fdf9a60065b 23 #include "LoRaWANStack.h"
kadonotakashi 0:8fdf9a60065b 24 #include "LoRaRadio.h"
kadonotakashi 0:8fdf9a60065b 25 #include "LoRaWANBase.h"
kadonotakashi 0:8fdf9a60065b 26
kadonotakashi 0:8fdf9a60065b 27 class LoRaPHY;
kadonotakashi 0:8fdf9a60065b 28
kadonotakashi 0:8fdf9a60065b 29 class LoRaWANInterface: public LoRaWANBase {
kadonotakashi 0:8fdf9a60065b 30
kadonotakashi 0:8fdf9a60065b 31 public:
kadonotakashi 0:8fdf9a60065b 32
kadonotakashi 0:8fdf9a60065b 33 /** Constructs a LoRaWANInterface using the LoRaWANStack instance underneath.
kadonotakashi 0:8fdf9a60065b 34 *
kadonotakashi 0:8fdf9a60065b 35 * Currently, LoRaWANStack is a singleton and you should only
kadonotakashi 0:8fdf9a60065b 36 * construct a single instance of LoRaWANInterface.
kadonotakashi 0:8fdf9a60065b 37 *
kadonotakashi 0:8fdf9a60065b 38 * LoRaWANInterface will construct PHY based on "lora.phy" setting in mbed_app.json.
kadonotakashi 0:8fdf9a60065b 39 *
kadonotakashi 0:8fdf9a60065b 40 * @param radio A reference to radio object
kadonotakashi 0:8fdf9a60065b 41 */
kadonotakashi 0:8fdf9a60065b 42 LoRaWANInterface(LoRaRadio &radio);
kadonotakashi 0:8fdf9a60065b 43
kadonotakashi 0:8fdf9a60065b 44 /** Constructs a LoRaWANInterface using the user provided PHY object.
kadonotakashi 0:8fdf9a60065b 45
kadonotakashi 0:8fdf9a60065b 46 * @param radio A reference to radio object
kadonotakashi 0:8fdf9a60065b 47 * @param phy A reference to PHY object
kadonotakashi 0:8fdf9a60065b 48 */
kadonotakashi 0:8fdf9a60065b 49 LoRaWANInterface(LoRaRadio &radio, LoRaPHY &phy);
kadonotakashi 0:8fdf9a60065b 50
kadonotakashi 0:8fdf9a60065b 51 virtual ~LoRaWANInterface();
kadonotakashi 0:8fdf9a60065b 52
kadonotakashi 0:8fdf9a60065b 53 // From LoRaWANBase:
kadonotakashi 0:8fdf9a60065b 54 virtual lorawan_status_t initialize(events::EventQueue *queue);
kadonotakashi 0:8fdf9a60065b 55 virtual lorawan_status_t connect();
kadonotakashi 0:8fdf9a60065b 56 virtual lorawan_status_t connect(const lorawan_connect_t &connect);
kadonotakashi 0:8fdf9a60065b 57 virtual lorawan_status_t disconnect();
kadonotakashi 0:8fdf9a60065b 58 virtual lorawan_status_t add_link_check_request();
kadonotakashi 0:8fdf9a60065b 59 virtual void remove_link_check_request();
kadonotakashi 0:8fdf9a60065b 60 virtual lorawan_status_t set_datarate(uint8_t data_rate);
kadonotakashi 0:8fdf9a60065b 61 virtual lorawan_status_t enable_adaptive_datarate();
kadonotakashi 0:8fdf9a60065b 62 virtual lorawan_status_t disable_adaptive_datarate();
kadonotakashi 0:8fdf9a60065b 63 virtual lorawan_status_t set_confirmed_msg_retries(uint8_t count);
kadonotakashi 0:8fdf9a60065b 64 virtual lorawan_status_t set_channel_plan(const lorawan_channelplan_t &channel_plan);
kadonotakashi 0:8fdf9a60065b 65 virtual lorawan_status_t get_channel_plan(lorawan_channelplan_t &channel_plan);
kadonotakashi 0:8fdf9a60065b 66 virtual lorawan_status_t remove_channel_plan();
kadonotakashi 0:8fdf9a60065b 67 virtual lorawan_status_t remove_channel(uint8_t index);
kadonotakashi 0:8fdf9a60065b 68 virtual int16_t send(uint8_t port, const uint8_t *data, uint16_t length, int flags);
kadonotakashi 0:8fdf9a60065b 69 virtual int16_t receive(uint8_t port, uint8_t *data, uint16_t length, int flags);
kadonotakashi 0:8fdf9a60065b 70 virtual int16_t receive(uint8_t *data, uint16_t length, uint8_t &port, int &flags);
kadonotakashi 0:8fdf9a60065b 71 virtual lorawan_status_t add_app_callbacks(lorawan_app_callbacks_t *callbacks);
kadonotakashi 0:8fdf9a60065b 72 virtual lorawan_status_t set_device_class(const device_class_t device_class);
kadonotakashi 0:8fdf9a60065b 73 virtual lorawan_status_t get_tx_metadata(lorawan_tx_metadata &metadata);
kadonotakashi 0:8fdf9a60065b 74 virtual lorawan_status_t get_rx_metadata(lorawan_rx_metadata &metadata);
kadonotakashi 0:8fdf9a60065b 75 virtual lorawan_status_t get_backoff_metadata(int &backoff);
kadonotakashi 0:8fdf9a60065b 76 virtual lorawan_status_t cancel_sending(void);
kadonotakashi 0:8fdf9a60065b 77
kadonotakashi 0:8fdf9a60065b 78 void lock(void)
kadonotakashi 0:8fdf9a60065b 79 {
kadonotakashi 0:8fdf9a60065b 80 _lw_stack.lock();
kadonotakashi 0:8fdf9a60065b 81 }
kadonotakashi 0:8fdf9a60065b 82 void unlock(void)
kadonotakashi 0:8fdf9a60065b 83 {
kadonotakashi 0:8fdf9a60065b 84 _lw_stack.unlock();
kadonotakashi 0:8fdf9a60065b 85 }
kadonotakashi 0:8fdf9a60065b 86
kadonotakashi 0:8fdf9a60065b 87
kadonotakashi 0:8fdf9a60065b 88 private:
kadonotakashi 0:8fdf9a60065b 89 typedef mbed::ScopedLock<LoRaWANInterface> Lock;
kadonotakashi 0:8fdf9a60065b 90
kadonotakashi 0:8fdf9a60065b 91 LoRaWANStack _lw_stack;
kadonotakashi 0:8fdf9a60065b 92
kadonotakashi 0:8fdf9a60065b 93 /** PHY object if created by LoRaWANInterface
kadonotakashi 0:8fdf9a60065b 94 *
kadonotakashi 0:8fdf9a60065b 95 * PHY object if LoRaWANInterface has created it.
kadonotakashi 0:8fdf9a60065b 96 * If PHY object is provided by the application, this pointer is NULL.
kadonotakashi 0:8fdf9a60065b 97 */
kadonotakashi 0:8fdf9a60065b 98 LoRaPHY *_default_phy;
kadonotakashi 0:8fdf9a60065b 99 };
kadonotakashi 0:8fdf9a60065b 100
kadonotakashi 0:8fdf9a60065b 101 #endif /* LORAWANINTERFACE_H_ */