{"id":13673744,"url":"https://github.com/HelTecAutomation/ESP32_LoRaWAN","last_synced_at":"2025-04-28T11:30:44.711Z","repository":{"id":37821748,"uuid":"145949433","full_name":"HelTecAutomation/ESP32_LoRaWAN","owner":"HelTecAutomation","description":"Transplanted from Semtech LoRaWAN(https://github.com/Lora-net/LoRaMac-node) protocol to \"ESP32 + Arduino\" platform. Use RTC, support deep sleep, only working with ESP32 + LoRa boards made by HelTec Automation(TM). Need a unique license to use it.","archived":false,"fork":false,"pushed_at":"2024-03-22T05:16:53.000Z","size":7698,"stargazers_count":344,"open_issues_count":58,"forks_count":109,"subscribers_count":32,"default_branch":"master","last_synced_at":"2024-11-11T13:35:44.715Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Assembly","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HelTecAutomation.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-24T06:06:30.000Z","updated_at":"2024-11-07T09:50:20.000Z","dependencies_parsed_at":"2023-01-30T23:31:10.358Z","dependency_job_id":null,"html_url":"https://github.com/HelTecAutomation/ESP32_LoRaWAN","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HelTecAutomation%2FESP32_LoRaWAN","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HelTecAutomation%2FESP32_LoRaWAN/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HelTecAutomation%2FESP32_LoRaWAN/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HelTecAutomation%2FESP32_LoRaWAN/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HelTecAutomation","download_url":"https://codeload.github.com/HelTecAutomation/ESP32_LoRaWAN/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251304678,"owners_count":21567920,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-02T11:00:20.986Z","updated_at":"2025-04-28T11:30:41.595Z","avatar_url":"https://github.com/HelTecAutomation.png","language":"Assembly","funding_links":[],"categories":["Libraries"],"sub_categories":[],"readme":"# This Library had been Stoped to maintenance\n\n- **The library had stop maintenance on December 20th, 2022**, and will not compatible with the [Heltec WiFi Kit Series (V0.0.7)](https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/releases/tag/0.0.7) or newer development framework.\n\n- **A full functions of LoRaWAN library already included in [Heltec ESP32 library](https://github.com/HelTecAutomation/Heltec_ESP32).** We strongly recommend using the [Heltec ESP32 library](https://github.com/HelTecAutomation/Heltec_ESP32) for your new project development.\n\n- If you have any questions, please fell free to contact us: support@heltec.cn.\n\n\n\n\n## Contents\n\n- [The Overview](#the-overview)\n- [Installing](#installing)\n- [Features](#features)\n- [Test information](#test-information)\n- [How to use this library](#how-to-use-this-library)\n- [Contact us](#contact-us)\n\n# The Overview\n\n- **This library must work with newest [Heltec_ESP32 development framework](https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series)**\n  - *For now, new features still not included in the release version, must install this framework via Git.*\n- This library is make LoRaWAN 1.0.2 protocol running with ESP32. Only support the ESP32 + LoRa series products made by [HelTec Automation(TM)](heltec.org), and a [LoRa gateway](https://heltec.org/proudct_center/lora/lora-gateway/) is must needed;\n- LoRaWAN relevant parameters are defined in the .ino file;\n- This library is transplanted from https://github.com/Lora-net/LoRaMac-node;\n- Use RTC and deep sleep mode supported, only a few milliseconds wake up in a cycle;\n- **[Heltec LoRa Node Family]([Heltec Automation(TM) products index page](https://docs.heltec.cn/#/en/products/lora/lora_node/heltec_lora_node_list)).**\n\n\n# Installing\n\nTo install this library:\n\n- install it using the Arduino Library manager (\"Sketch\" -\u003e \"Include Library\" -\u003e \"Manage Libraries...\"), or\n- download a zip file from GitHub using the \"Download ZIP\" button and install it using the IDE (\"Sketch\" -\u003e \"Include Library\" -\u003e \"Add .ZIP Library...\"\n- clone this git repository into your sketchbook/libraries folder.\n\nFor more info, see https://www.arduino.cc/en/Guide/Libraries\n\n# Features\n\nThe `ESP32_LoRaWAN` library provides a fairly complete LoRaWAN Class A and Class C implementation. The latest update (February 10th, 2020) has full region support (KR920, AS923, US915, etc.).\n\nThe following functions are included:\n - LoRaWAN protocol V1.0.2 Class A and Class C;\n - Use ESP32's internal RTC (15KHz);\n - All [ESP32 + LoRa](https://heltec.org/proudct_center/lora/lora-node/) boards made by [Heltec Automation(TM)](heltec.org) can use this library;\n - Support deep sleep and stop mode;\n - Receive and print downlink payload;\n - Print and OLED show downlink data length and RSSI;\n - An unique license related to Chip ID is needed, you can check your license here: http://www.heltec.cn/search/\n\n# Test information\n\n![](img/02.png)\n - Gateway: [HT-M01 Mini LoRa Gateway](http://www.heltec.cn/project/ht-m01-lora-gateway/?lang=en) + Raspberry Pi Zero W\n - Node: [WIFI LoRa 32 V2](https://heltec.org/project/wifi-lora-32/), [Wireless Stick](https://heltec.org/project/wireless-stick/), [Wireless Stick Lite](https://heltec.org/project/wireless-stick-lite/)\n - Lora Server:\n    - [Heltec Cloud Server](http://cloud.heltec.org/);\n    - [TTN](https://www.thethingsnetwork.org/).\n - Arduino 1.8.10\n\n| working band | status |\n| :----------------: | :------------:|\n| EU433 | not test |\n| CN470 | work well |\n| EU863 | work well |\n| US915 | work well |\n| AU916 | work well |\n| CN779 | not test |\n| AS923 | not test |\n| KR920 | not test |\n| IN865 | not test |\n| US915_HYBRID | not test |\n\n**What certainly works:**\n\n - Sending payload to a LoRa gateway via LoRaWAN protocol;\n - Encryption and message integrity checking;\n - Over-the-air activation (OTAA / joining);\n - Deep sleep and wake up；\n - Class A operation;\n - Class C operation;\n - ABP mode.\n\n**What has not been tested:**\n\n - Receiving downlink packets in the RX2 window.\n\n# How to use this library\nThe only different with a common Arduino library is need a unique license. It's relate to ESP32 Chip ID.\n\n### How to get your board's Chip ID?\n - Use this simple example to read your Chip ID: https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/tree/master/esp32/libraries/ESP32/examples/ChipID/GetChipID\n\n### How to get the unique license?\n - http://www.heltec.cn/search/ Open this page and input your ChipID\n\nOnly the boards made after August 2018 can be checked from this page, if you have a former version, you can mail to support@heltec.cn and improve you already have a Heltec Automation made board.\n\n### Choose the right working band you need\n\nChoose working band you need In the Arduino tools menu: \n\n![](img/01.png)\n\n\n\nFor more details about how to use this library, please refer to this document:\n\n[ESP32 LoRaWAN library usage](https://heltec-automation-docs.readthedocs.io/en/latest/esp32/lorawan/index.html).\n\n\u0026nbsp;\n\n### How to Use This Library in Platform.io?\n\nThe options in the Tools menu is relate to the [Heltec ESP32 development framework](https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series), but in the Platform.io, it's use original [Espressif ESP32 framework](https://github.com/espressif/arduino-esp32). So we need additional definition the `build_flags` in `platformio.ini` file.\n\n```shell\nbuild_flags = \n   -D REGION_CN470\n   -D ACTIVE_REGION=LORAMAC_REGION_CN470\n   -D LoRaWAN_DEBUG_LEVEL=0\n```\n\n![](img/03.png)\n\n\n# Contact us\n- **Website：[https://heltec.org](https://heltec.org/)**\n- **Document Page: [https://docs.heltec.cn](https://docs.heltec.cn)**\n- **Forum: [http://community.heltec.cn/](http://community.heltec.cn/)**\n- **Twitter: [https://twitter.com/HeltecOrg](https://twitter.com/HeltecOrg)**\n- **Face Book: [https://www.facebook.com/heltec.automation.5](https://www.facebook.com/heltec.automation.5)**\n\n# Issue/Bug report template\nBefore reporting an issue, make sure you've searched for similar one that was already created. Also make sure to go through all the issues labeled as [for reference](https://github.com/HelTecAutomation/ESP32_LoRaWAN/issues).\n\nAlso you can talk in our forum: [http://community.heltec.cn/](http://community.heltec.cn/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHelTecAutomation%2FESP32_LoRaWAN","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FHelTecAutomation%2FESP32_LoRaWAN","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHelTecAutomation%2FESP32_LoRaWAN/lists"}