diff --git a/Heltec-WiFi-LoRa-32-V2/longfi-us915/README.md b/Heltec-WiFi-LoRa-32-V2/longfi-us915/README.md new file mode 100644 index 0000000..8c9f072 --- /dev/null +++ b/Heltec-WiFi-LoRa-32-V2/longfi-us915/README.md @@ -0,0 +1,63 @@ +# Heltec WiFi LoRa 32 V2 + +This example demonstrates sending a simple data packet using a Heltec Wifi LoRa 32 V2 development board. Please follow every instruction step below from top to bottom. + +[Heltec LoRa 32 V2 Product Page](https://heltec.org/project/wifi-lora-32/) +[Heltec LoRa 32 V2 Docs](https://heltec-automation-docs.readthedocs.io/en/latest/esp32/index.html) + +## Installing the Heltec ESP32 Library + +From the Arduino IDE, open the Library Manager (Sketch->Include Library->Manage Libraries). In the search box, type Heltec ESP32 and look for `Heltec ESP32 Dev-Boards`. Select the latest version and install. + +## Install Serial Driver +Find Directions [here](https://heltec-automation-docs.readthedocs.io/en/latest/general/establish_serial_connection.html). + +## Install Arduino-ESP32 Board Support +Find Directions [here](https://heltec-automation-docs.readthedocs.io/en/latest/esp32+arduino/quick_start.html#via-arduino-board-manager) + +## Select Board +Arduino IDE: +1. Select Tools -> Board: -> WiFi LoRa 32(V2) + +## Select Region +Arduino IDE: +1. Select Tools -> LoRaWAN Region: -> REGION_US915 + +## Obtain Heltec License Key + +### Upload `GetChipID` example +Arduino IDE: +1. Select File -> Examples -> ESP32 -> ChipID -> GetChipID +2. Select Tools -> Port: "COM# or ttyACM#" +3. Select Sketch -> Upload +4. Wait for Done uploading message +5. Select Tools -> Serial Monitor +Serial Monitor Window +1. Select 115200 baud from bottom right dropdown. +2. You should see something that looks like this every second `ESP32 Chip ID = ############` +3. Save this Chip ID + +### Obtain License Key with Chip ID +1.Go to [resource.heltec.cn/search](http://resource.heltec.cn/search) +2. Enter ChipID +3. Save license field, will look like `0x########,0x#########,0x########,0x########` + +## Upload `OTAA_OLED` example +Arduino IDE: +1. Select File -> Examples -> ESP32_LoRaWAN -> OTAA_LED +2. Enter License Key at line 32 +``` +uint32_t license[4] = {`0x########,0x#########,0x########,0x########}; +``` +3. Enter DevEUI(msb), AppEUI(msb), and AppKey(msb) from Helium Console, at lines 34,35,36. +``` +uint8_t DevEui[] = { FILL_ME_IN }; +uint8_t AppEui[] = { FILL_ME_IN }; +uint8_t AppKey[] = { FILL_ME_IN }; +``` +4. Select Sketch -> Upload. +5. Wait for Done uploading message +6. Select Tools -> Serial Monitor +Serial Monitor Window +1. Select 115200 baud from bottom right dropdown. +2. Wait for device to successfully join, may take 1-3 min, and show several failures. Do not be alarmed by the failures, it is expected. \ No newline at end of file diff --git a/Heltec-WiFi-LoRa-32-V2/longfi-us915/longfi-us915.ino b/Heltec-WiFi-LoRa-32-V2/longfi-us915/longfi-us915.ino new file mode 100644 index 0000000..20899e4 --- /dev/null +++ b/Heltec-WiFi-LoRa-32-V2/longfi-us915/longfi-us915.ino @@ -0,0 +1,162 @@ +/* + * HelTec Automation(TM) LoRaWAN 1.0.2 OTAA example use OTAA, CLASS A + * + * Function summary: + * + * - use internal RTC(150KHz); + * + * - Include stop mode and deep sleep mode; + * + * - 15S data send cycle; + * + * - Informations output via serial(115200); + * + * - Only ESP32 + LoRa series boards can use this library, need a license + * to make the code run(check you license here: http://www.heltec.cn/search ); + * + * You can change some definition in "Commissioning.h" and "LoRaMac-definitions.h" + * + * HelTec AutoMation, Chengdu, China. + * 成都惠利特自动化科技有限公司 + * https://heltec.org + * support@heltec.cn + * + *this project also release in GitHub: + *https://github.com/HelTecAutomation/ESP32_LoRaWAN +*/ + +#include +#include "Arduino.h" + +/*license for Heltec ESP32 LoRaWan, quary your ChipID relevant license: http://resource.heltec.cn/search */ +uint32_t license[4] = {0xC1670CF8, 0x19C71AD5, 0x6CE47540, 0x8CF267EC}; +/* OTAA para*/ +uint8_t DevEui[] = { FILL_ME_IN }; +uint8_t AppEui[] = { FILL_ME_IN }; +uint8_t AppKey[] = { FILL_ME_IN }; + +/* ABP para*/ +uint8_t NwkSKey[] = { 0x15, 0xb1, 0xd0, 0xef, 0xa4, 0x63, 0xdf, 0xbe, 0x3d, 0x11, 0x18, 0x1e, 0x1e, 0xc7, 0xda,0x85 }; +uint8_t AppSKey[] = { 0xd7, 0x2c, 0x78, 0x75, 0x8c, 0xdc, 0xca, 0xbf, 0x55, 0xee, 0x4a, 0x77, 0x8d, 0x16, 0xef,0x67 }; +uint32_t DevAddr = ( uint32_t )0x007e6ae1; + +/*LoraWan Class, Class A and Class C are supported*/ +DeviceClass_t loraWanClass = CLASS_A; + +/*the application data transmission duty cycle. value in [ms].*/ +uint32_t appTxDutyCycle = 15000; + +/*OTAA or ABP*/ +bool overTheAirActivation = true; + +/*ADR enable*/ +bool loraWanAdr = false; + +/* Indicates if the node is sending confirmed or unconfirmed messages */ +bool isTxConfirmed = false; + +/* Application port */ +uint8_t appPort = 2; + +/*! +* Number of trials to transmit the frame, if the LoRaMAC layer did not +* receive an acknowledgment. The MAC performs a datarate adaptation, +* according to the LoRaWAN Specification V1.0.2, chapter 18.4, according +* to the following table: +* +* Transmission nb | Data Rate +* ----------------|----------- +* 1 (first) | DR +* 2 | DR +* 3 | max(DR-1,0) +* 4 | max(DR-1,0) +* 5 | max(DR-2,0) +* 6 | max(DR-2,0) +* 7 | max(DR-3,0) +* 8 | max(DR-3,0) +* +* Note, that if NbTrials is set to 1 or 2, the MAC will not decrease +* the datarate, in case the LoRaMAC layer did not receive an acknowledgment +*/ +uint8_t confirmedNbTrials = 8; + +/*LoraWan debug level, select in arduino IDE tools. +* None : print basic info. +* Freq : print Tx and Rx freq, DR info. +* Freq && DIO : print Tx and Rx freq, DR, DIO0 interrupt and DIO1 interrupt info. +* Freq && DIO && PW: print Tx and Rx freq, DR, DIO0 interrupt, DIO1 interrupt, MCU sleep and MCU wake info. +*/ +uint8_t debugLevel = LoRaWAN_DEBUG_LEVEL; + +/*LoraWan region, select in arduino IDE tools*/ +LoRaMacRegion_t loraWanRegion = ACTIVE_REGION; + + +static void prepareTxFrame( uint8_t port ) +{ + appDataSize = 4;//AppDataSize max value is 64 + appData[0] = 0x00; + appData[1] = 0x01; + appData[2] = 0x02; + appData[3] = 0x03; +} + +// Add your initialization code here +void setup() +{ + if(mcuStarted==0) + { + LoRaWAN.displayMcuInit(); + } + Serial.begin(115200); + while (!Serial); + SPI.begin(SCK,MISO,MOSI,SS); + Mcu.init(SS,RST_LoRa,DIO0,DIO1,license); + deviceState = DEVICE_STATE_INIT; +} + +// The loop function is called in an endless loop +void loop() +{ + switch( deviceState ) + { + case DEVICE_STATE_INIT: + { + LoRaWAN.init(loraWanClass,loraWanRegion); + break; + } + case DEVICE_STATE_JOIN: + { + LoRaWAN.displayJoining(); + LoRaWAN.join(); + break; + } + case DEVICE_STATE_SEND: + { + LoRaWAN.displaySending(); + prepareTxFrame( appPort ); + LoRaWAN.send(loraWanClass); + deviceState = DEVICE_STATE_CYCLE; + break; + } + case DEVICE_STATE_CYCLE: + { + // Schedule next packet transmission + txDutyCycleTime = appTxDutyCycle + randr( -APP_TX_DUTYCYCLE_RND, APP_TX_DUTYCYCLE_RND ); + LoRaWAN.cycle(txDutyCycleTime); + deviceState = DEVICE_STATE_SLEEP; + break; + } + case DEVICE_STATE_SLEEP: + { + LoRaWAN.displayAck(); + LoRaWAN.sleep(loraWanClass,debugLevel); + break; + } + default: + { + deviceState = DEVICE_STATE_INIT; + break; + } + } +} \ No newline at end of file