Skip to content

Commit 6fa7403

Browse files
mluis1mluis1
committed
Added readme.md.
1 parent db810fe commit 6fa7403

File tree

1 file changed

+166
-0
lines changed

1 file changed

+166
-0
lines changed

‎readme.md

+166
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
/ _____) _ | |
2+
( (____ _____ ____ _| |_ _____ ____| |__
3+
\____ \| ___ | (_ _) ___ |/ ___) _ \
4+
_____) ) ____| | | || |_| ____( (___| | | |
5+
(______/|_____)_|_|_| \__)_____)\____)_| |_|
6+
©2013 Semtech
7+
8+
SX1272/76 radio drivers plus Ping-Pong firmware and LoRa MAC node firmware implementation.
9+
=====================================
10+
11+
1. Introduction
12+
----------------
13+
The aim of this project is to show an example of the LoRaMac endpoint firmware
14+
implementation.
15+
16+
**REMARK 1:** Currently only devices of Class A are supported.
17+
18+
**REMARK 2:** The SX1276 device is not yet supported.
19+
20+
2. System schematic and definitions
21+
------------------------------------
22+
The available supported hardware platforms schematics and LoRaMac specification
23+
can be found in the Doc directory.
24+
25+
3. Dependencies
26+
----------------
27+
28+
This program uses the AES algorithm implementation (http://www.gladman.me.uk/)
29+
by Brian Gladman.
30+
31+
This program uses the CMAC algorithm implementation
32+
(http://www.cse.chalmers.se/research/group/dcs/masters/contikisec/) by
33+
Lander Casado, Philippas Tsigas.
34+
35+
This program depends on specific hardware platforms. Currently the supported
36+
platforms are:
37+
38+
- Bleeper
39+
MCU : STM32L151RD - 384K FLASH, 48K RAM, Timers, SPI, I2C,
40+
USART,
41+
USB 2.0 full-speed device/host/OTG controller,
42+
DAC, ADC, DMA
43+
RADIO : SX1272
44+
ANTENNA : Connector for external antenna
45+
BUTTONS : 1 Reset, 16 position encoder
46+
LEDS : 3
47+
SENSORS : Temperature
48+
GPS : Possible through pin header GPS module connection
49+
SDCARD : Yes
50+
EXTENSION HEADER : Yes, 12 pins
51+
REMARK : None.
52+
53+
- LoRaMote-eu868
54+
MCU : STM32L151CB - 128K FLASH, 10K RAM, Timers, SPI, I2C,
55+
USART,
56+
USB 2.0 full-speed device/host/OTG controller,
57+
DAC, ADC, DMA
58+
RADIO : SX1272
59+
ANTENNA : Printed circuit antenna
60+
BUTTONS : No
61+
LEDS : 3
62+
SENSORS : Proximity, Magnetic, 3 axis Accelerometer, Pressure,
63+
Temperature
64+
GPS : Yes, UP501 module
65+
SDCARD : No
66+
EXTENSION HEADER : Yes, 20 pins
67+
REMARK : The MCU and Radio are on an IMST iM880A module
68+
69+
4. Usage
70+
---------
71+
Projects for Ride7 and Keil Integrated Development Environments are available.
72+
73+
5. Changelog
74+
-------------
75+
2014-02-21, v2.0
76+
77+
* General
78+
1. The LoRaMac applications now sends the LED status plus the sensors values.
79+
For the LoRaMote platform the application also sends the GPS coordinates.
80+
81+
* The application payload for the Bleeper platform is as follows:
82+
83+
LoRaMac port 1:
84+
85+
{ 0x00/0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }
86+
---------- ---------- ---------- ---------- ----
87+
| | | | |
88+
LED PRESSURE TEMPERATURE ALTITUDE BATTERY
89+
(barometric)
90+
91+
* The application payload for the LoRaMote platform is as follows:
92+
93+
LoRaMac port 2:
94+
95+
{ 0x00/0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }
96+
---------- ---------- ---------- ---------- ---- ---------------- ---------------- ----------
97+
| | | | | | | |
98+
LED PRESSURE TEMPERATURE ALTITUDE BATTERY LATITUDE LONGITUDE ALTITUDE
99+
(barometric) (gps)
100+
2. Adapted applications to the new MAC layer API.
101+
3. Added sensors drivers implementation.
102+
4. Corrected new or known issues.
103+
* LoRaMac
104+
1. MAC commands implemented
105+
* LinkCheckReq **YES**
106+
* LinkCheckAns **YES**
107+
* LinkADRReq **YES**
108+
* LinkADRAns **YES**
109+
* DevStatusReq **YES**
110+
* DevStatusAns **YES**
111+
* JoinReq **YES (Not tested yet)**
112+
* JoinAccept **YES (Not tested yet)**
113+
2. New MAC layer application API implementation.
114+
* Timers and RTC.
115+
1. Still some issues. They will be corrected on next revisions of the firmware.
116+
117+
2014-01-24, v1.1
118+
119+
* LoRaMac
120+
1. MAC commands implemented
121+
* LinkCheckReq **NO**
122+
* LinkCheckAns **NO**
123+
* LinkADRReq **YES**
124+
* LinkADRAns **YES**
125+
* DevStatusReq **YES**
126+
* DevStatusAns **YES**
127+
2. Implemented an application LED control
128+
If the server sends on port 1 an application payload of one byte with
129+
the following contents:
130+
131+
0: LED off
132+
1: LED on
133+
The node transmits periodically on port 1 the LED status on 1st byte and
134+
the message "Hello World!!!!" the array looks like:
135+
136+
{ 0, 'H', 'e', 'l', 'l', 'o', ' ', 'W', 'o', 'r', 'l', 'd', '!', '!', '!', '!' }
137+
* Timers and RTC.
138+
1. Corrected issues existing in the previous version
139+
2. Known bugs are:
140+
* There is an issue when launching an asynchronous Timer. Will be solved
141+
in a future version
142+
143+
2014-01-20, v1.1.RC1
144+
145+
* Added Doc directory. The directory contains:
146+
1. LoRa MAC specification
147+
2. Bleeper board schematic
148+
* LoRaMac has been updated according to Release1 of the specification. Main changes are:
149+
1. MAC API changed.
150+
2. Frame format.
151+
3 ClassA first ADR implementation.
152+
4. MAC commands implemented
153+
* LinkCheckReq **NO**
154+
* LinkCheckAns **NO**
155+
* LinkADRReq **YES**
156+
* LinkADRAns **NO**
157+
* DevStatusReq **NO**
158+
* DevStatusAns **NO**
159+
160+
* Timers and RTC rewriting. Known bugs are:
161+
1. The Radio wakeup time is taken in account for all timings.
162+
2. When opening the second reception window the microcontroller sometimes doesn't enter in low power mode.
163+
164+
2013-11-28, v1.0
165+
166+
* Initial version of the LoRa MAC node firmware implementation.

0 commit comments

Comments
 (0)