You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+48-38Lines changed: 48 additions & 38 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,50 +18,50 @@
18
18
19
19
The aim of this project is to show an example of the endpoint LoRaWAN stack implementation.
20
20
21
-
This LoRaWAN stack implements all regions defined in "LoRaWAN Regional Parameters v1.0.2rB" document. Class A and Class C endpoint implementation
22
-
is fully compatible with "LoRaWAN specification 1.0.2".
21
+
This project has 3 active branches in place. The **[master](https://github.com/Lora-net/LoRaMac-node/tree/master)** branch which provides the latest released source code ([v4.4.1](https://github.com/Lora-net/LoRaMac-node/releases/tag/v4.4.1)), the **[develop](https://github.com/Lora-net/LoRaMac-node/tree/develop)** branch which provides the current source code development status to be released next ([Milestone 4.4.2](https://github.com/Lora-net/LoRaMac-node/milestone/2)) and the **[feature/5.0.0](https://github.com/Lora-net/LoRaMac-node/tree/feature/5.0.0)** branch which provides a preview of the current source code development status for [LoRaWAN Specification v1.1](https://lora-alliance.org/resource-hub/lorawantm-specification-v11) specification.([Milestone 5.0.0](https://github.com/Lora-net/LoRaMac-node/milestone/3))
23
22
24
-
Each LoRaWAN application example includes the LoRaWAN certification protocol implementation.
23
+
* The [master](https://github.com/Lora-net/LoRaMac-node/tree/master) branch implementation is based on [LoRaWAN Specification v1.0.2](https://lora-alliance.org/resource-hub/lorawantm-specification-v102) and [LoRaWAN Regional Parameters v1.0.2rB](https://www.lora-alliance.org/resource-hub/lorawantm-regional-parameters-v102rb) specifications.
24
+
ClassA and ClassC end-device classes are fully implemented.
25
25
26
-
SX1272/76 radio drivers are also provided.
27
-
In case only point to point links are required a Ping-Pong application is provided as example.
26
+
* The [develop](https://github.com/Lora-net/LoRaMac-node/tree/develop) branch implementation is based on [LoRaWAN Specification v1.0.3](https://lora-alliance.org/resource-hub/lorawantm-specification-v103) and [LoRaWAN Regional Parameters v1.0.3rA](https://www.lora-alliance.org/resource-hub/lorawantm-regional-parameters-v103ra) specifications.
27
+
ClassA, ClassB and ClassC end-device classes are fully implemented.
28
28
29
-
*The LoRaWAN stack API documentation can be found at: http://stackforce.github.io/LoRaMac-doc/*
29
+
* The [feature/5.0.0](https://github.com/Lora-net/LoRaMac-node/tree/feature/5.0.0) branch implementation is based on [LoRaWAN Specification v1.1](https://lora-alliance.org/resource-hub/lorawantm-specification-v11) and [LoRaWAN Regional Parameters v1.1rB](https://lora-alliance.org/resource-hub/lorawantm-regional-parameters-v11rb) specifications.
30
+
ClassA, ClassB and ClassC end-device classes are fully implemented.
30
31
31
-
## System schematic and definitions
32
+
The [develop](https://github.com/Lora-net/LoRaMac-node/tree/develop)and [feature/5.0.0](https://github.com/Lora-net/LoRaMac-node/tree/feature/5.0.0) branches both rely on a software emulated secure-element implementation. Please refer to the [Secure element API](https://github.com/Lora-net/LoRaMac-node/wiki/secure-element) document for further information.
32
33
33
-
The available supported hardware platforms schematics can be found in the Doc directory.
34
+
This project also provides SX1272/73, SX1276/77/78/79 and SX1261/2 radio drivers.
34
35
35
-
## Acknowledgments
36
+
For each currently supported platform example applications are provided.
36
37
37
-
The mbed (https://mbed.org/) project was used at the beginning as source of
38
-
inspiration.
38
+
***LoRaMac/classA**: ClassA end-device example application.
39
39
40
-
This program uses the AES algorithm implementation (http://www.gladman.me.uk/) by Brian Gladman.
40
+
***LoRaMac/classB**: ClassB end-device example application.
41
41
42
-
This program uses the CMAC algorithm implementation
43
-
(http://www.cse.chalmers.se/research/group/dcs/masters/contikisec/) by Lander Casado, Philippas Tsigas.
42
+
***LoRaMac/classC**: ClassC end-device example application.
43
+
44
+
***ping-pong**: Point to point RF link example application.
44
45
45
-
## Dependencies
46
+
***rx-sensi**: Example application useful to measure the radio sensitivity level using an RF generator.
46
47
47
-
This program depends on specific hardware platforms. Currently the supported
48
-
platforms are:
48
+
***tx-cw**: Example application to show how to generate an RF Continuous Wave transmission.
49
+
50
+
**Note**: *Each LoRaWAN application example (LoRaMac/classX) includes an implementation of the LoRa-Alliacne; LoRaWAN certification protocol.*
51
+
52
+
**Note**: *The LoRaWAN stack API documentation can be found at: http://stackforce.github.io/LoRaMac-doc/*
53
+
54
+
## Supported platforms
55
+
56
+
This project currently provides support for the below platforms.
57
+
This project can be ported to other platforms using different MCU than the ones currently supported.
58
+
The [Porting Guide](http://stackforce.github.io/LoRaMac-doc/_p_o_r_t_i_n_g__g_u_i_d_e.html) document provides guide lines on how to port the project to other platforms.
0 commit comments