{"id":13673742,"url":"https://github.com/ElectronicCats/Beelan-LoRaWAN","last_synced_at":"2025-04-28T11:30:40.849Z","repository":{"id":35168211,"uuid":"167842998","full_name":"ElectronicCats/Beelan-LoRaWAN","owner":"ElectronicCats","description":"A LoRaWAN library for compatible arduino board ","archived":false,"fork":false,"pushed_at":"2025-03-25T19:30:15.000Z","size":851,"stargazers_count":206,"open_issues_count":3,"forks_count":88,"subscribers_count":22,"default_branch":"master","last_synced_at":"2025-04-23T15:03:39.544Z","etag":null,"topics":["arduino","arduino-api","arduino-library","arduino-lorawan-library","beelan-lorawan","lora","lorawan","lorawan-library","ttn"],"latest_commit_sha":null,"homepage":"https://www.beelan.mx","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ElectronicCats.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-27T18:27:05.000Z","updated_at":"2025-04-21T19:12:34.000Z","dependencies_parsed_at":"2023-12-03T02:24:14.651Z","dependency_job_id":"30abeae3-f836-4c4c-99a7-a4338ff7f106","html_url":"https://github.com/ElectronicCats/Beelan-LoRaWAN","commit_stats":{"total_commits":248,"total_committers":31,"mean_commits":8.0,"dds":0.6330645161290323,"last_synced_commit":"0c2c694d3a4fe4be0d61aba223204290b94a42a2"},"previous_names":["beelanmx/beelan-lorawan"],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ElectronicCats%2FBeelan-LoRaWAN","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ElectronicCats%2FBeelan-LoRaWAN/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ElectronicCats%2FBeelan-LoRaWAN/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ElectronicCats%2FBeelan-LoRaWAN/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ElectronicCats","download_url":"https://codeload.github.com/ElectronicCats/Beelan-LoRaWAN/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251304673,"owners_count":21567919,"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":["arduino","arduino-api","arduino-library","arduino-lorawan-library","beelan-lorawan","lora","lorawan","lorawan-library","ttn"],"created_at":"2024-08-02T11:00:20.872Z","updated_at":"2025-04-28T11:30:40.210Z","avatar_url":"https://github.com/ElectronicCats.png","language":"C++","funding_links":["https://github.com/sponsors/ElectronicCats"],"categories":["Libraries"],"sub_categories":[],"readme":"![LibraryBuild](https://github.com/BeelanMX/Beelan-LoRaWAN/workflows/LibraryBuild/badge.svg?branch=master)\n\nArduino LoRaWAN library\n====================\nThis repository contains the simple LoRaWAN library encapsulated to run in the generic platform, allowing using the SX1272, SX1276 transceivers and compatible modules (such as some HopeRF RFM9x modules).\n\nThis repository is all based on the library originally created by [Ideetron B.V.](https://github.com/Ideetron) This library is slightly\nmodified and this [repo]( https://git.antares.id/lorawan-loraid/arduino-loraid), with the principal purpose to have an LoRaWAN MAC layer for arduino with an easy API.\n\n\u003ca href=\"https://github.com/ElectronicCats/Beelan-LoRaWAN/wiki\"\u003e\n  \u003cimg src=\"https://github.com/ElectronicCats/flipper-shields/assets/44976441/6aa7f319-3256-442e-a00d-33c8126833ec\" width=\"200\" height=\"104\" /\u003e\n\u003c/a\u003e\n\nFeatures\n--------\nThe Arduino LoRaWAN library supports LoRaWAN Class A and Class C implementations operating in EU-868, AS-923, US-915 and AU-915 bands. Notice that this library is fairly simple with the aim of demonstrating the LoRaWAN capabilities.\n\n### What certainly works:\n - Sending packets uplink, taking into account duty cycling.\n - Custom frequencies and data rate settings.\n - Receiving downlink packets in the RX1 window (EU-868, AS-923,US-915,AU-915).\n - Over-the-air activation (OTAA / joining) (EU-868, AS-923).\n - Class C operation.\n - Receiving downlink packets in the RX1 window (US-915).\n - Receiving downlink packets in the RX2 window.\n - Over-the-air activation (OTAA / joining) (US-915). \n\n### What has not been tested:\n - Receiving and processing MAC commands.\n\nIf you try one of these untested features and it works, be sure to let\nus know (creating a Github issue is probably the best way for that, also so you can submit a pull request to improve this repository).\n\nInstalling the library\n----------\nPlease refer to the wiki's [first steps](https://github.com/ElectronicCats/Beelan-LoRaWAN/wiki/2.-First-steps) section for instructions on installing the library.\n\nConfiguration\n-------------\nA number of features can be configured or disabled by editing the\n`config.h` file in the library folder. Unfortunately the Arduino\nenvironment does not offer any way to do this (compile-time)\nconfiguration from the sketch, so be careful to recheck your\nconfiguration when you switch between sketches or update the library.\n\nAt the very least, you should set the right type of board in config.h, most other values should be fine at their defaults.\n\nWhen using the US_915 you need to select which sub-band you will use, by default it is sub-band 6.\n\nWe have to manually set the frequency plan (EU_868, US_915, AS_923, AS_923_2...) in the Config.h of the library.\n\nSupported hardware\n------------------\nThis library is intended to be used with plain LoRa transceivers,\nconnecting to them using SPI. In particular, the SX1272 and SX1276\nfamilies are supported (which should include SX1273, SX1277, SX1278 and\nSX1279 which only differ in the available frequencies, bandwidths and\nspreading factors). It has been tested with both SX1272 and SX1276\nchips, using the Semtech SX1272 evaluation board and the HopeRF RFM92\nand RFM95 boards (which supposedly contain an SX1272 and SX1276 chip\nrespectively).\n\nSome of the supported pre-built board currently available in the market are:\n\n- [Electronic Cats BastWAN](https://electroniccats.com/store/bastwan/)\n- [Electronic Cats CatWAN USB-Stick](https://electroniccats.com/store/catwan-usb-stick/)\n- [Electronic Cats CatWAN Relay Board](https://electroniccats.com/store/catwan-relay-board/)\n- [Electronic Cats CatWAN Shield](https://electroniccats.com/store/loracatshield/)\n- [Cytron Shield LoRa-RFM](https://www.cytron.io/p-shield-lora-rfm) \n- [Dragino](http://www.dragino.com/products/module/item/102-lora-shield.html) \n\n\nThis library has been tested using:\n\n- Arduino Uno\n- WeMos D1 R2 (ESP8266 family board)\n- ESP32\n- Electronic Cats CatWAN USB-Stick\n- Electronic Cats Bast-WAN (Based on SAMR34)\n- NINA B302 is NRF52840 core\n- STMDuino\n- RENESAS compatible boards\n\nConnections\n-----------\nTo make this library work, your Arduino (or whatever Arduino-compatible\nboard you are using) should be connected to the transceiver. The exact\nconnections are a bit dependent on the transceiver board and Arduino\nused, so this section tries to explain what each connection is for and\nin what cases it is (not) required.\n\n\nPin mapping\n-----------\nAs described above, most connections can use arbitrary I/O pins on the\nArduino side. To tell the arduino LoRaWAN library about these, a pin mapping struct is used in the sketch file.\n\nFor example, this could look like this:\n\n\tsRFM_pins RFM_pins = {\n\t  \t.CS = SS,\n\t  \t.RST = RFM_RST,\n\t  \t.DIO0 = RFM_DIO0,\n\t  \t.DIO1 = RFM_DIO1,\n\t  \t.DIO2 = RFM_DIO2,\n\t  \t.DIO5 = RFM_DIO5\n  \t}; \n  \t\nAPI\n--------\n - See [API.md](API.md).\n\nTests\n-------\n - See [Test Folder](test/README.md) \n\n## How to contribute \u003cimg src=\"https://electroniccats.com/wp-content/uploads/2018/01/fav.png\" height=\"35\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/gist/ManulMax/2d20af60d709805c55fd784ca7cba4b9/raw/bcfeac7604f674ace63623106eb8bb8471d844a6/github.gif\" height=\"30\"\u003e\n Contributions are welcome! \n\nPlease read the document  [**Contribution Manual**](https://github.com/ElectronicCats/electroniccats-cla/blob/main/electroniccats-contribution-manual.md)  which will show you how to contribute your changes to the project.\n\n✨ Thanks to all our [contributors](https://github.com/ElectronicCats/Beelan-LoRaWAN/graphs/contributors)! ✨\n\nSee  [**_Electronic Cats CLA_**](https://github.com/ElectronicCats/electroniccats-cla/blob/main/electroniccats-cla.md) for more information.\n\nSee the [**community code of conduct**](https://github.com/ElectronicCats/electroniccats-cla/blob/main/electroniccats-community-code-of-conduct.md)   for a vision of the community we want to build and what we expect from it.\n\nMaintainer\n-------\n\nElectronic Cats invests time and resources providing this open source design, please support Electronic Cats and open-source hardware by purchasing products from Electronic Cats!\nThanks Beelan\n\n\u003ca href=\"https://github.com/sponsors/ElectronicCats\"\u003e\n \u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://electroniccats.com/wp-content/uploads/2020/07/Badge_GHS.png\" height=\"104\" /\u003e\n \u003c/p\u003e\n\u003c/a\u003e\n\nLicense\n-------\nMost source files in this repository are made available under the\n[MIT License](https://github.com/ElectronicCats/Beelan-LoRaWAN/blob/master/LICENSE.txt). The examples which use a more liberal\nlicense. Some of the AES code is available under the LGPL. Refer to each\nindividual source file for more details.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FElectronicCats%2FBeelan-LoRaWAN","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FElectronicCats%2FBeelan-LoRaWAN","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FElectronicCats%2FBeelan-LoRaWAN/lists"}