From 7d57e650b248af8822874ceb8ca41f2a7c786107 Mon Sep 17 00:00:00 2001 From: jgromes Date: Thu, 6 Jul 2023 16:50:58 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=20f3549?= =?UTF-8?q?03864f404e306b5ffeaed3ea097bef0ef7d=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _lo_ra_w_a_n_8h_source.html | 144 ++++++++++++++++++--------------- _physical_layer_8h_source.html | 2 +- functions_s.html | 20 ++--- search/all_10.js | 4 +- search/functions_f.js | 4 +- 5 files changed, 92 insertions(+), 82 deletions(-) diff --git a/_lo_ra_w_a_n_8h_source.html b/_lo_ra_w_a_n_8h_source.html index b59b6232..ca5f8661 100644 --- a/_lo_ra_w_a_n_8h_source.html +++ b/_lo_ra_w_a_n_8h_source.html @@ -260,78 +260,88 @@ $(document).ready(function(){initNavTree('_lo_ra_w_a_n_8h_source.html',''); init
196 // supported bands
197 extern const LoRaWANBand_t EU868;
198 extern const LoRaWANBand_t US915;
-
199 
-
204 class LoRaWANNode {
-
205  public:
-
211  LoRaWANNode(PhysicalLayer* phy, const LoRaWANBand_t* band);
-
212 
-
217  void wipe();
-
218 
-
223  int16_t begin();
-
224 
-
235  int16_t beginOTAA(uint64_t appEUI, uint64_t devEUI, uint8_t* nwkKey, uint8_t* appKey, bool force = false);
-
236 
-
246  int16_t beginAPB(uint32_t addr, uint8_t net, uint8_t* nwkSKey, uint8_t* appSKey);
-
247 
-
248  #if defined(RADIOLIB_BUILD_ARDUINO)
-
255  int16_t uplink(String& str, uint8_t port);
-
256  #endif
-
257 
-
264  int16_t uplink(const char* str, uint8_t port);
-
265 
-
273  int16_t uplink(uint8_t* data, size_t len, uint8_t port);
-
274 
-
281  int16_t configureChannel(uint8_t chan, uint8_t dr);
-
282 
-
283 #if !defined(RADIOLIB_GODMODE)
-
284  private:
-
285 #endif
-
286  PhysicalLayer* phyLayer;
-
287  const LoRaWANBand_t* band;
-
288 
-
289  // the following is either provided by the network server (OTAA)
-
290  // or directly entered by the user (ABP)
-
291  uint32_t devAddr;
-
292  uint8_t appSKey[RADIOLIB_AES128_KEY_SIZE];
-
293  uint8_t fNwkSIntKey[RADIOLIB_AES128_KEY_SIZE];
-
294  uint8_t sNwkSIntKey[RADIOLIB_AES128_KEY_SIZE];
-
295  uint8_t nwkSEncKey[RADIOLIB_AES128_KEY_SIZE];
-
296  uint8_t rxDelay;
-
297  float availableChannelsFreq[5];
-
298  uint16_t availableChannelsMask[6];
-
299 
-
300  // currently configured data rate DR0 - DR15 (band-dependent!)
-
301  uint8_t dataRate;
-
302 
-
303  // currently configured channel (band-dependent!)
-
304  uint8_t chIndex;
-
305 
-
306  // method to generate message integrity code
-
307  uint32_t generateMIC(uint8_t* msg, size_t len, uint8_t* key);
-
308 
-
309  // method to verify message integrity code
-
310  // it assumes that the MIC is the last 4 bytes of the message
-
311  bool verifyMIC(uint8_t* msg, size_t len, uint8_t* key);
+
199 extern const LoRaWANBand_t CN780;
+
200 extern const LoRaWANBand_t EU433;
+
201 extern const LoRaWANBand_t AU915;
+
202 extern const LoRaWANBand_t CN500;
+
203 extern const LoRaWANBand_t AS923;
+
204 extern const LoRaWANBand_t KR920;
+
205 extern const LoRaWANBand_t IN865;
+
206 
+
211 class LoRaWANNode {
+
212  public:
+
218  LoRaWANNode(PhysicalLayer* phy, const LoRaWANBand_t* band);
+
219 
+
224  void wipe();
+
225 
+
230  int16_t begin();
+
231 
+
242  int16_t beginOTAA(uint64_t appEUI, uint64_t devEUI, uint8_t* nwkKey, uint8_t* appKey, bool force = false);
+
243 
+
253  int16_t beginAPB(uint32_t addr, uint8_t net, uint8_t* nwkSKey, uint8_t* appSKey);
+
254 
+
255  #if defined(RADIOLIB_BUILD_ARDUINO)
+
262  int16_t uplink(String& str, uint8_t port);
+
263  #endif
+
264 
+
271  int16_t uplink(const char* str, uint8_t port);
+
272 
+
280  int16_t uplink(uint8_t* data, size_t len, uint8_t port);
+
281 
+
288  int16_t configureChannel(uint8_t chan, uint8_t dr);
+
289 
+
290 #if !defined(RADIOLIB_GODMODE)
+
291  private:
+
292 #endif
+
293  PhysicalLayer* phyLayer;
+
294  const LoRaWANBand_t* band;
+
295 
+
296  // the following is either provided by the network server (OTAA)
+
297  // or directly entered by the user (ABP)
+
298  uint32_t devAddr;
+
299  uint8_t appSKey[RADIOLIB_AES128_KEY_SIZE];
+
300  uint8_t fNwkSIntKey[RADIOLIB_AES128_KEY_SIZE];
+
301  uint8_t sNwkSIntKey[RADIOLIB_AES128_KEY_SIZE];
+
302  uint8_t nwkSEncKey[RADIOLIB_AES128_KEY_SIZE];
+
303  uint8_t rxDelay;
+
304  float availableChannelsFreq[5];
+
305  uint16_t availableChannelsMask[6];
+
306 
+
307  // LoRaWAN revision (1.0 vs 1.1)
+
308  uint8_t rev;
+
309 
+
310  // currently configured data rate DR0 - DR15 (band-dependent!)
+
311  uint8_t dataRate;
312 
-
313  int16_t setPhyProperties();
-
314 
-
315  // network-to-host conversion method - takes data from network packet and converts it to the host endians
-
316  template<typename T>
-
317  static T ntoh(uint8_t* buff, size_t size = 0);
+
313  // currently configured channel (band-dependent!)
+
314  uint8_t chIndex;
+
315 
+
316  // method to generate message integrity code
+
317  uint32_t generateMIC(uint8_t* msg, size_t len, uint8_t* key);
318 
-
319  // host-to-network conversion method - takes data from host variable and and converts it to network packet endiands
-
320  template<typename T>
-
321  static void hton(uint8_t* buff, T val, size_t size = 0);
-
322 };
-
323 
-
324 #endif
-
LoRaWANNode
LoRaWAN-compatible node (class A device).
Definition: LoRaWAN.h:204
+
319  // method to verify message integrity code
+
320  // it assumes that the MIC is the last 4 bytes of the message
+
321  bool verifyMIC(uint8_t* msg, size_t len, uint8_t* key);
+
322 
+
323  int16_t setPhyProperties();
+
324 
+
325  // network-to-host conversion method - takes data from network packet and converts it to the host endians
+
326  template<typename T>
+
327  static T ntoh(uint8_t* buff, size_t size = 0);
+
328 
+
329  // host-to-network conversion method - takes data from host variable and and converts it to network packet endiands
+
330  template<typename T>
+
331  static void hton(uint8_t* buff, T val, size_t size = 0);
+
332 };
+
333 
+
334 #endif
+
LoRaWANNode
LoRaWAN-compatible node (class A device).
Definition: LoRaWAN.h:211
LoRaWANNode::beginOTAA
int16_t beginOTAA(uint64_t appEUI, uint64_t devEUI, uint8_t *nwkKey, uint8_t *appKey, bool force=false)
Join network by performing over-the-air activation. By this procedure, the device will perform an exc...
Definition: LoRaWAN.cpp:49
LoRaWANNode::wipe
void wipe()
Wipe internal persistent parameters. This will reset all counters and saved variables,...
Definition: LoRaWAN.cpp:23
-
LoRaWANNode::beginAPB
int16_t beginAPB(uint32_t addr, uint8_t net, uint8_t *nwkSKey, uint8_t *appSKey)
Join network by performing activation by personalization. In this procedure, all necessary configurat...
Definition: LoRaWAN.cpp:219
+
LoRaWANNode::beginAPB
int16_t beginAPB(uint32_t addr, uint8_t net, uint8_t *nwkSKey, uint8_t *appSKey)
Join network by performing activation by personalization. In this procedure, all necessary configurat...
Definition: LoRaWAN.cpp:222
LoRaWANNode::LoRaWANNode
LoRaWANNode(PhysicalLayer *phy, const LoRaWANBand_t *band)
Default constructor.
Definition: LoRaWAN.cpp:18
-
LoRaWANNode::configureChannel
int16_t configureChannel(uint8_t chan, uint8_t dr)
Configure the radio to a given channel frequency and data rate.
Definition: LoRaWAN.cpp:352
-
LoRaWANNode::uplink
int16_t uplink(const char *str, uint8_t port)
Send a message to the server.
Definition: LoRaWAN.cpp:232
+
LoRaWANNode::configureChannel
int16_t configureChannel(uint8_t chan, uint8_t dr)
Configure the radio to a given channel frequency and data rate.
Definition: LoRaWAN.cpp:361
+
LoRaWANNode::uplink
int16_t uplink(const char *str, uint8_t port)
Send a message to the server.
Definition: LoRaWAN.cpp:235
LoRaWANNode::begin
int16_t begin()
Join network by loading information from persistent storage.
Definition: LoRaWAN.cpp:28
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:33
LoRaWANBand_t
Structure to save information about LoRaWAN band.
Definition: LoRaWAN.h:167
diff --git a/_physical_layer_8h_source.html b/_physical_layer_8h_source.html index 70d298a4..4332f30a 100644 --- a/_physical_layer_8h_source.html +++ b/_physical_layer_8h_source.html @@ -280,7 +280,7 @@ $(document).ready(function(){initNavTree('_physical_layer_8h_source.html',''); i
BellClient
Client for Bell modem communication. The public interface is the same as Arduino Serial.
Definition: BellModem.h:57
FSK4Client
Client for FSK-4 communication. The public interface is the same as Arduino Serial.
Definition: FSK4.h:15
HellClient
Client for Hellschreiber transmissions.
Definition: Hellschreiber.h:90
-
LoRaWANNode
LoRaWAN-compatible node (class A device).
Definition: LoRaWAN.h:204
+
LoRaWANNode
LoRaWAN-compatible node (class A device).
Definition: LoRaWAN.h:211
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:31
MorseClient
Client for Morse Code communication. The public interface is the same as Arduino Serial.
Definition: Morse.h:93
PagerClient
Client for Pager communication.
Definition: Pager.h:62
diff --git a/functions_s.html b/functions_s.html index 49ffc5bf..31c68c58 100644 --- a/functions_s.html +++ b/functions_s.html @@ -407,7 +407,7 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable() , RF69
  • setReceivePipe() -: nRF24 +: nRF24
  • setRecvSequence() : AX25Frame @@ -481,9 +481,9 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable() , PhysicalLayer , RF69 , Si443x -, SX126x -, SX127x -, SX128x +, SX126x +, SX127x +, SX128x
  • setTCXO() : SX126x @@ -617,14 +617,14 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable()
  • standby() : BellClient -, CC1101 +, CC1101 , FSK4Client , nRF24 -, PhysicalLayer +, PhysicalLayer , RF69 , RTTYClient -, Si443x -, SX126x +, Si443x +, SX126x , SX127x , SX128x
    • @@ -639,7 +639,7 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable() : SX1280
  • startReceive() -: CC1101 +: CC1101 , nRF24 , PagerClient , PhysicalLayer @@ -647,7 +647,7 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable() , Si443x , SX126x , SX127x -, SX128x +, SX128x
  • startReceiveDutyCycle() : SX126x diff --git a/search/all_10.js b/search/all_10.js index b0913ff1..7495c452 100644 --- a/search/all_10.js +++ b/search/all_10.js @@ -110,8 +110,8 @@ var searchData= ['spistatuscommand_394',['SPIstatusCommand',['../class_module.html#a06d8d4257c584b57a529fcc405d87c79',1,'Module']]], ['spistreamerror_395',['SPIstreamError',['../class_module.html#a66b06e69d57b97116bed1c6f185381f1',1,'Module']]], ['spistreamtype_396',['SPIstreamType',['../class_module.html#a34927454be3a34df8a5a586c46c428af',1,'Module']]], - ['spitransfer_397',['spiTransfer',['../class_radio_lib_hal.html#aebcaaf0cefdaaf5b572d4261e472ac8a',1,'RadioLibHal']]], - ['spitransfer_398',['SPItransfer',['../class_module.html#a78dd39aa71d97e2220a880df8162fdde',1,'Module']]], + ['spitransfer_397',['SPItransfer',['../class_module.html#a78dd39aa71d97e2220a880df8162fdde',1,'Module']]], + ['spitransfer_398',['spiTransfer',['../class_radio_lib_hal.html#aebcaaf0cefdaaf5b572d4261e472ac8a',1,'RadioLibHal']]], ['spitransferstream_399',['SPItransferStream',['../class_module.html#ac3586c8d4013cbdd22cf34032632c181',1,'Module']]], ['spiwritecommand_400',['SPIwriteCommand',['../class_module.html#ae89764d15e8df5694a6aec0e18f72d3f',1,'Module']]], ['spiwriteregister_401',['SPIwriteRegister',['../class_module.html#a4437af6552e258e95ed8ed452afa6dd4',1,'Module']]], diff --git a/search/functions_f.js b/search/functions_f.js index 565c1784..34de7f52 100644 --- a/search/functions_f.js +++ b/search/functions_f.js @@ -99,8 +99,8 @@ var searchData= ['spireadregisterburst_759',['SPIreadRegisterBurst',['../class_module.html#a874e030f1931e606e380930d37dd83ee',1,'Module']]], ['spireadstream_760',['SPIreadStream',['../class_module.html#a085415b49ff72238f118b937ad896cbd',1,'Module::SPIreadStream(uint8_t *cmd, uint8_t cmdLen, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)'],['../class_module.html#ab9fc874adc8dbe7c3f1fd3c267c27708',1,'Module::SPIreadStream(uint8_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)']]], ['spisetregvalue_761',['SPIsetRegValue',['../class_module.html#a081191402ad5c49e6c21982fc4587b77',1,'Module']]], - ['spitransfer_762',['spiTransfer',['../class_radio_lib_hal.html#aebcaaf0cefdaaf5b572d4261e472ac8a',1,'RadioLibHal']]], - ['spitransfer_763',['SPItransfer',['../class_module.html#a78dd39aa71d97e2220a880df8162fdde',1,'Module']]], + ['spitransfer_762',['SPItransfer',['../class_module.html#a78dd39aa71d97e2220a880df8162fdde',1,'Module']]], + ['spitransfer_763',['spiTransfer',['../class_radio_lib_hal.html#aebcaaf0cefdaaf5b572d4261e472ac8a',1,'RadioLibHal']]], ['spitransferstream_764',['SPItransferStream',['../class_module.html#ac3586c8d4013cbdd22cf34032632c181',1,'Module']]], ['spiwriteregister_765',['SPIwriteRegister',['../class_module.html#a4437af6552e258e95ed8ed452afa6dd4',1,'Module']]], ['spiwriteregisterburst_766',['SPIwriteRegisterBurst',['../class_module.html#af474f82d00fffc1ee0fc8def2c7f220c',1,'Module']]],