From 381328d3cd12f0ee15754cafbb25c313a004f766 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20J=C3=A4ckle?= Date: Fri, 13 May 2016 13:45:58 +0200 Subject: [PATCH] Update LoRaWAN documentation to version 4.2.0 --- LoRaMac-doc/_comissioning_8h_source.html | 34 +- LoRaMac-doc/_lo_ra_mac-board_8h_source.html | 260 +++--- LoRaMac-doc/_lo_ra_mac_8h.html | 32 +- LoRaMac-doc/_lo_ra_mac_8h.js | 2 + LoRaMac-doc/_lo_ra_mac_8h_source.html | 802 +++++++++--------- LoRaMac-doc/_lo_ra_mac_crypto_8h.html | 4 +- LoRaMac-doc/_lo_ra_mac_crypto_8h_source.html | 4 +- LoRaMac-doc/_lo_ra_mac_test_8h.html | 4 +- LoRaMac-doc/_lo_ra_mac_test_8h_source.html | 4 +- LoRaMac-doc/annotated.html | 4 +- ...class_a_2_lo_ra_mote_2main_8c-example.html | 94 +- ...class_b_2_lo_ra_mote_2main_8c-example.html | 94 +- ...class_c_2_lo_ra_mote_2main_8c-example.html | 94 +- LoRaMac-doc/classes.html | 4 +- .../dir_24160e34e4c9d28811ffbfcc3d05f36d.html | 4 +- .../dir_2f0e5c18ad01314d8d34be8f44398fab.html | 4 +- .../dir_335d385ad0448da65716bb819c6d1316.html | 4 +- .../dir_648780a1c0efb5e8cbd6e84bb9d44d47.html | 4 +- .../dir_939f02d2bb5d3a9fe7f3ebec6e6b54c4.html | 4 +- .../dir_941c9cad6a3381206e45dd84c4fa11e6.html | 4 +- .../dir_99c5e573314e4f8c1ba32c7af9331df6.html | 4 +- .../dir_a669f5507d465e006b0d6477c99a97ee.html | 4 +- .../dir_dafd1c82bc8ee7a0dbc693dabb8190c5.html | 4 +- .../dir_e08a4d3a7fda69fe1b3d591f04ec25db.html | 4 +- LoRaMac-doc/examples.html | 4 +- LoRaMac-doc/files.html | 4 +- LoRaMac-doc/functions.html | 7 +- LoRaMac-doc/functions_vars.html | 7 +- LoRaMac-doc/globals.html | 10 +- LoRaMac-doc/globals_defs.html | 4 +- LoRaMac-doc/globals_enum.html | 4 +- LoRaMac-doc/globals_eval.html | 10 +- LoRaMac-doc/globals_func.html | 4 +- LoRaMac-doc/graph_legend.html | 4 +- LoRaMac-doc/group___l_o_r_a_m_a_c.html | 128 +-- LoRaMac-doc/group___l_o_r_a_m_a_c.js | 3 + .../group___l_o_r_a_m_a_c___c_r_y_p_t_o.html | 4 +- .../group___l_o_r_a_m_a_c_t_e_s_t.html | 4 +- ...roup___l_o_r_a_m_a_c_union_mib_param__t.js | 1 + LoRaMac-doc/index.html | 4 +- LoRaMac-doc/modules.html | 4 +- LoRaMac-doc/navtreedata.js | 2 +- LoRaMac-doc/navtreeindex0.js | 50 +- LoRaMac-doc/navtreeindex1.js | 93 +- LoRaMac-doc/search/all_2.js | 1 + LoRaMac-doc/search/all_9.js | 1 + LoRaMac-doc/search/all_a.js | 1 + LoRaMac-doc/search/enumvalues_3.js | 1 + LoRaMac-doc/search/enumvalues_4.js | 1 + LoRaMac-doc/search/variables_2.js | 1 + LoRaMac-doc/struct_lo_ra_mac_callback__t.html | 4 +- .../struct_lo_ra_mac_primitives__t.html | 4 +- ...ct_mib_request_confirm__t__coll__graph.map | 12 +- ...ct_mib_request_confirm__t__coll__graph.md5 | 2 +- ...ct_mib_request_confirm__t__coll__graph.png | Bin 87215 -> 88373 bytes .../union_mib_param__t__coll__graph.map | 10 +- .../union_mib_param__t__coll__graph.md5 | 2 +- .../union_mib_param__t__coll__graph.png | Bin 81462 -> 82219 bytes 58 files changed, 986 insertions(+), 881 deletions(-) diff --git a/LoRaMac-doc/_comissioning_8h_source.html b/LoRaMac-doc/_comissioning_8h_source.html index f702240..dc85aab 100644 --- a/LoRaMac-doc/_comissioning_8h_source.html +++ b/LoRaMac-doc/_comissioning_8h_source.html @@ -33,7 +33,7 @@ Logo
LoRaMAC Layer -  4.1.0 +  4.2.0
Documentation of the API
@@ -134,32 +134,34 @@
28 
29 #if( OVER_THE_AIR_ACTIVATION != 0 )
30 
-
37 #define LORAWAN_DEVICE_EUI { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }
-
38 
-
42 #define LORAWAN_APPLICATION_EUI { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }
+
34 #define IEEE_OUI 0x00, 0x00, 0x00
+
35 
+
42 #define LORAWAN_DEVICE_EUI { IEEE_OUI, 0x00, 0x00, 0x00, 0x00, 0x00 }
43 
-
47 #define LORAWAN_APPLICATION_KEY { 0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6, 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C }
+
47 #define LORAWAN_APPLICATION_EUI { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }
48 
-
49 #else
-
50 
-
54 #define LORAWAN_NETWORK_ID ( uint32_t )0
+
52 #define LORAWAN_APPLICATION_KEY { 0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6, 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C }
+
53 
+
54 #else
55 
-
63 #define LORAWAN_DEVICE_ADDRESS ( uint32_t )0x00000000
-
64 
-
68 #define LORAWAN_NWKSKEY { 0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6, 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C }
+
59 #define LORAWAN_NETWORK_ID ( uint32_t )0
+
60 
+
68 #define LORAWAN_DEVICE_ADDRESS ( uint32_t )0x00000000
69 
-
73 #define LORAWAN_APPSKEY { 0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6, 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C }
+
73 #define LORAWAN_NWKSKEY { 0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6, 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C }
74 
-
75 #endif
-
76 
-
77 #endif // __LORA_COMISSIONING_H__
+
78 #define LORAWAN_APPSKEY { 0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6, 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C }
+
79 
+
80 #endif
+
81 
+
82 #endif // __LORA_COMISSIONING_H__
-
+

Structure containing single access to bits

+
Collaboration diagram for LoRaMacFrameCtrl_t::sCtrlBits:
Collaboration graph
@@ -870,7 +873,8 @@
-
+

Structure containing single access to bits

+
Collaboration diagram for LoRaMacFlags_t::sMacFlagBits:
Collaboration graph
@@ -1434,7 +1438,8 @@
-
Examples:
classA/LoRaMote/main.c, classB/LoRaMote/main.c, and classC/LoRaMote/main.c.
+

LoRaMAC MLME-Request structure

+
Examples:
classA/LoRaMote/main.c, classB/LoRaMote/main.c, and classC/LoRaMote/main.c.
Collaboration diagram for MlmeReq_t:
@@ -1568,11 +1573,11 @@
Collaboration graph
- - - - - + + + + +
[legend]
@@ -1618,6 +1623,14 @@

Related MIB type: MIB_CHANNELS_DATARATE

+ + + @@ -1781,12 +1794,12 @@
Collaboration graph
- - - - - - + + + + + +
[legend]
+int8_t +ChannelsDefaultDatarate +

Channels data rate

+

Related MIB type: MIB_CHANNELS_DEFAULT_DATARATE

+
uint16_t * ChannelsMask
@@ -1853,7 +1866,7 @@

Macro Definition Documentation

- +
#define ACK_TIMEOUT   2000000#define ACK_TIMEOUT   2000
@@ -1866,7 +1879,7 @@

Macro Definition Documentation

- +
#define ACK_TIMEOUT_RND   1000000#define ACK_TIMEOUT_RND   1000
@@ -1905,11 +1918,11 @@

Macro Definition Documentation

- +
#define BEACON_INTERVAL   128000000#define BEACON_INTERVAL   128000
-

Beacon interval in us

+

Beacon interval in ms

@@ -1931,11 +1944,11 @@

Macro Definition Documentation

- +
#define JOIN_ACCEPT_DELAY1   5000000#define JOIN_ACCEPT_DELAY1   5000
-

Join accept receive delay 1 in us

+

Join accept receive delay 1 in ms

@@ -1944,11 +1957,11 @@

Macro Definition Documentation

- +
#define JOIN_ACCEPT_DELAY2   6000000#define JOIN_ACCEPT_DELAY2   6000
-

Join accept receive delay 2 in us

+

Join accept receive delay 2 in ms

@@ -1996,11 +2009,11 @@

Macro Definition Documentation

- +
#define MAC_STATE_CHECK_TIMEOUT   1000000#define MAC_STATE_CHECK_TIMEOUT   1000
-

Check the Mac layer state every MAC_STATE_CHECK_TIMEOUT in us

+

Check the Mac layer state every MAC_STATE_CHECK_TIMEOUT in ms

@@ -2035,11 +2048,11 @@

Macro Definition Documentation

- +
#define MAX_RX_WINDOW   3000000#define MAX_RX_WINDOW   3000
-

Class A&B maximum receive window delay in us

+

Class A&B maximum receive window delay in ms

@@ -2048,11 +2061,11 @@

Macro Definition Documentation

- +
#define RECEIVE_DELAY1   1000000#define RECEIVE_DELAY1   1000
-

Class A&B receive delay 1 in us

+

Class A&B receive delay 1 in ms

@@ -2061,11 +2074,11 @@

Macro Definition Documentation

- +
#define RECEIVE_DELAY2   2000000#define RECEIVE_DELAY2   2000
-

Class A&B receive delay 2 in us

+

Class A&B receive delay 2 in ms

@@ -2183,6 +2196,9 @@

Enumeration Type Documentation

LORAMAC_EVENT_INFO_STATUS_DOWNLINK_REPEATED 

A frame with an invalid downlink counter was received. The downlink counter of the frame was equal to the local copy of the downlink counter of the node.

+LORAMAC_EVENT_INFO_STATUS_DOWNLINK_TOO_MANY_FRAMES_LOSS  +

The node has lost MAX_FCNT_GAP or more frames.

+ LORAMAC_EVENT_INFO_STATUS_ADDRESS_FAIL 

An address error occured

@@ -2460,11 +2476,13 @@

Enumeration Type Documentation

MIB_CHANNELS_DATARATE YES YES +MIB_CHANNELS_DEFAULT_DATARATEYES YES + MIB_CHANNELS_TX_POWER YES YES -MIB_UPLINK_COUNTER YES NO +MIB_UPLINK_COUNTER YES YES -MIB_DOWNLINK_COUNTER YES NO +MIB_DOWNLINK_COUNTER YES YES MIB_MULTICAST_CHANNEL YES NO @@ -2534,25 +2552,31 @@

Enumeration Type Documentation

LoRaWAN Specification V1.0, chapter 5.2

MIB_MAX_RX_WINDOW_DURATION  -

Maximum receive window duration in [us]

+

Maximum receive window duration in [ms]

LoRaWAN Specification V1.0, chapter 3.3.3

MIB_RECEIVE_DELAY_1  -

Receive delay 1 in [us]

+

Receive delay 1 in [ms]

LoRaWAN Specification V1.0, chapter 6

MIB_RECEIVE_DELAY_2  -

Receive delay 2 in [us]

+

Receive delay 2 in [ms]

LoRaWAN Specification V1.0, chapter 6

MIB_JOIN_ACCEPT_DELAY_1  -

Join accept delay 1 in [us]

+

Join accept delay 1 in [ms]

LoRaWAN Specification V1.0, chapter 6

MIB_JOIN_ACCEPT_DELAY_2  -

Join accept delay 2 in [us]

+

Join accept delay 2 in [ms]

LoRaWAN Specification V1.0, chapter 6

+MIB_CHANNELS_DEFAULT_DATARATE  +

Default Data rate of a channel

+

LoRaWAN Specification V1.0, chapter 7

+

EU868 - [DR_0, DR_1, DR_2, DR_3, DR_4, DR_5, DR_6, DR_7]

+

US915 - [DR_0, DR_1, DR_2, DR_3, DR_4, DR_8, DR_9, DR_10, DR_11, DR_12, DR_13]

+ MIB_CHANNELS_DATARATE 

Data rate of a channel

LoRaWAN Specification V1.0, chapter 7

@@ -3031,7 +3055,7 @@

Function Documentation