You can use WioLoRaWANFieldTester without a need to compile it by following the Quick installation guide. If you want to compile your proper version of it or if you want to contribute on the project by adding feature of fixing some bugs, here are the following steps.
The installation details are available in the related Wio LoRaWan Field tester on disk91.com
- Arduino IDE
- WioTerminal - Toolsuite
- GPS - Adafruit GPS library version 1.5.4 (or 1.7.1)
- QRcode - from Richard More
- Flash - FlashStorage by various version 1.0.0 (this fixes seeed invalid FlashStorage bundled lib)
TFT_eSPI from your Arduino library folder, if not, it will use the local one with wrong pins definition resulting in black screen on boot. This library is included with Seeed SAMD package installed through Boards Manager.
https://files.seeedstudio.com/arduino/package_seeeduino_boards_index.json
- LoRaWAN - MCCI LoRaWAN LMIC library (by IBM, Matthjs Kooljman…) version 3.3.0
- Battery Chassis - Sparkfun BQ27441
- File system - Seeed Arduino FS version 2.0.3 (not yet implemented)
- File system - Seeed Ardunino SFUD version 2.0.1 (not yet implemented)
LoRaWAN library needs to be setup for you local zone:
-
Edit the file lmic_project_config.h located in Document/Arduino/libraries/MCCI_LoRaWAN_LMIC_library/project_config
You need to uncomment the line corresponding to your zone (us915, eu868...) and comment the others. Make sure the other defines are the same as above.
// // Select your radio zone and country // //#define CFG_eu868 1 #define CFG_us915 1 //#define CFG_au915 1 ... #define CFG_sx1276_radio 1 //#define LMIC_USE_INTERRUPTS #define LMIC_LORAWAN_SPEC_VERSION LMIC_LORAWAN_SPEC_VERSION_1_0_2 #define DISABLE_BEACONS #define DISABLE_PING
You need to setup the Mode as Slave (because they did not correctly wired the Serial line on E5 so this is a trick to bypass this hardware problem)
Different setups needs to be performed in Libraries (so you know why I don't really like Arduino eco-system)
- In SoftwareSerial Library (Libraries/Arduino15/packages/seeeduino/hardware/samd/1.8.2/libraries/SoftwareSerial/), in SoftwareSerial.h, change the Buffer Size
#define _SS_MAX_RX_BUFF 128 // RX buffer size- In
Wire.cpp(Libraries/Arduino15/packages/seeeduino/hardware/samd/1.8.2/library/Wire/Wire.cpp), add in the following lines (they are conflicting with Wire from the same package) (&& defined FALSE). This is to wait a fix from Seeed on their package.
#if WIRE_INTERFACES_COUNT > 1
TwoWire Wire1(&PERIPH_WIRE1, PIN_WIRE1_SDA, PIN_WIRE1_SCL);
void WIRE1_IT_HANDLER(void) {
Wire1.onService();
}
#if defined(__SAMD51__) && defined FALSE
void WIRE1_IT_HANDLER_0(void) { Wire1.onService(); }
void WIRE1_IT_HANDLER_1(void) { Wire1.onService(); }
void WIRE1_IT_HANDLER_2(void) { Wire1.onService(); }
void WIRE1_IT_HANDLER_3(void) { Wire1.onService(); }
#endif // __SAMD51__
#endif- In Adafruit_GPS_Library (Documents/Arduino/libraries/Adafruit_GPS_Library/src), in
Adafruit_GPS.h, add the following define to allow SoftwareSerial
#if defined ARDUINO_WIO_TERMINAL
#define ESP8266
#endif - The
config.hfile contains the configuration defines. Enable / Disable what you need
//#define DEBUG // enable extra debug logs on serial
#define HWTARGET LORAE5 // Select the target E5 vs RFM95
#define WITH_SPLASH 1 // Enable splash screen
#define WITH_SPLASH_HELIUM 1 // display helium logo
#define WITH_SPLASH_TTN 1 // display TTN logo
#define WITH_GPS // if defined the GPS code is enable
#define WITH_LIPO // if defined the LiPo status & charging code is enable- The
key.hfile contains the LoRaWAN credential. When all set to 0, the device will expect a serial port configuration as seen in the setup.
When developing it is more convenient to use a static configuration to avoid reconfiguring the device on every firmware update. For this, you can get the credential as defined in the Access Helium device credential for developer section of the documentation.
Then you can directly replace the key.h variable content with what you have copy & paste.
#define __DEVEUI { 0x7B, 0xC9, 0xFF, 0x47, 0xE6, 0x49, 0x41, 0xA7 }
#define __APPEUI { 0xD3, 0x77, 0x5B, 0x2C, 0x39, 0x93, 0x58, 0x20 }
#define __APPKEY { 0xE5, 0xC1, 0xD9, 0x44, 0xB4, 0x0D, 0x5D, 0x1C, 0x8B, 0xFB, 0x14, 0x8B, 0x1E, 0x8C, 0x2C, 0xA5 }There is nothing specific about compilation & upload. If you add feature or fixing bug in you private fork, don't forget to propose a pull-request.
If you want to create an UF2 file for a drag & drop upload on the WIO Terminal, you can use uf2 generator online tool.
- use address 0x4000
- select your binary file compiled from Arduino
- download the file locally
The following Frame format are used: uplink format on port 1:
| Byte | Usage |
|---|---|
0 - 5 |
GSP position see here for details. Decoding see below |
6 - 7 |
Altitude in meters + 1000m ( 1100 = 100m ) |
8 |
HDOP * 10 (11 = 1.1) |
9 |
Sats in view |
When the GPS position is invalid of GPS is disable, the frame is full of 0
downlink response format on port 2:
| Byte | Usage |
|---|---|
0 |
Sequence ID % 255 |
1 |
Min Rssi + 200 (160 = -40dBm) |
2 |
Max Rssi + 200 (160 = -40dBm) |
3 |
Min Distance step 250m |
4 |
Max Distance step 250m |
5 |
Seen hotspot |
The distance is calculated from the GPS position and the hotspot position returned by console meta-data. Under 250m value is 250m, over 32km value is 32km. 0 is considered as invalid response
The following integration and payload transformation allows to decode the gps position and report is to mapper. Thank you Seb for the contribution.
Dicovery uplink format on port 3 (no ack):
| Byte | Usage |
|---|---|
0 - 5 |
GSP position see here for details. Decoding see below |
Discovery is sending 10 messages SF10 on every 40 seconds. All the other information comes from the metadata provided by the network server.
Such a decoder can be use if you do not want to use my backend to report the coordinate to the helium mapper
Create a Functions type Decoder / Custom Script and attach it to a mapper integration callback as it is described in this helium mapper integration page
/*
Helium console function for LoRaWan Field Tester sending mapping information to mappers backend.
https://www.disk91.com/2021/technology/lora/low-cost-lorawan-field-tester/
Result is visible on https://mappers.helium.com/
Built from information available on:
https://docs.helium.com/use-the-network/coverage-mapping/mappers-api/
https://github.com/disk91/WioLoRaWANFieldTester/blob/master/WioLoRaWanFieldTester.ino
https://www.disk91.com/2015/technology/sigfox/telecom-design-sdk-decode-gps-frame/
Integration:
POST https://mappers.helium.com/api/v1/ingest/uplink
*/
function Decoder(bytes, port) {
var decoded = {};
// avoid sending Downlink ACK to integration (Cargo)
if (port === 1) {
var lonSign = (bytes[0]>>7) & 0x01 ? -1 : 1;
var latSign = (bytes[0]>>6) & 0x01 ? -1 : 1;
var encLat = ((bytes[0] & 0x3f)<<17)+
(bytes[1]<<9)+
(bytes[2]<<1)+
(bytes[3]>>7);
var encLon = ((bytes[3] & 0x7f)<<16)+
(bytes[4]<<8)+
bytes[5];
var hdop = bytes[8]/10;
var sats = bytes[9];
const maxHdop = 2;
const minSats = 5;
if ((hdop < maxHdop) && (sats >= minSats)) {
// Send only acceptable quality of position to mappers
decoded.latitude = latSign * (encLat * 108 + 53) / 10000000;
decoded.longitude = lonSign * (encLon * 215 + 107) / 10000000;
decoded.altitude = ((bytes[6]<<8)+bytes[7])-1000;
decoded.accuracy = (hdop*5+5)/10
decoded.hdop = hdop;
decoded.sats = sats;
} else {
decoded.error = "Need more GPS precision (hdop must be <"+maxHdop+
" & sats must be >= "+minSats+") current hdop: "+hdop+" & sats:"+sats;
}
return decoded;
}
return null;
}