4. First steps

Compatible architectures and boards

The Beelan-LoRaWAN library is designed to be compatible with various architectures and boards that support the Arduino framework. Some architectures and boards that are commonly used and should be compatible with the library:

• Arduino Classic Family
• Arduino MKR Family
• STM32 Boards
• ESP8266 Boards
• ESP32 Boards
• Electronic Cats BastWAN
• Electronic Cats CatWAN USB-Stick
• Electronic Cats CatWAN Relay Board
• Electronic Cats CatWAN Shield
• Cytron Shield LoRa-RFM
• Dragino

This library has been tested with the following boards:

• Arduino Uno
• WeMos D1 R2 (ESP8266 family board)
• ESP32
• Electronic Cats CatWAN USB-Stick
• Electronic Cats Bast-WAN (Based on SAMR34)
• NINA B302 is NRF52840 core
• STMDuino
• RENESAS compatible boards

Note: while the library is supposed to compile correctly on these architectures, it might require specific hardware features that may be available only on some boards.

We encourage you to explore the capabilities of our library with various architectures beyond what we have initially tested and documented. If you find that it functions effectively, we would greatly appreciate your collaboration in reporting your findings. Your feedback is invaluable in helping us improve our library and ensure its compatibility with a diverse range of setups. There are two ways you can contribute your insights:

• Issue Reporting: If you encounter any challenges, unexpected behaviors, or bugs while using our library with a different architecture, please open an GitHub issue.
• Pull Request: In case you discover improvements, optimizations, or modifications that enhance the compatibility of our library with a particular architecture, we encourage you to share your work by opening a pull request.

By embracing different architectures and collaborating with us through issue reporting or pull requests, you contribute to the growth and robustness of our library. Together, we can build a more comprehensive and adaptable tool for all users.

For more information to Arduino boards families, please visit: Arduino Documentation

When using the library, it's important to ensure that you have the appropriate hardware connections, pin mappings, and libraries for the specific board you are using.

Installing Beelan-LoRaWAN library

Downloading and Installing Arduino IDE

Click here to read “Download and install Arduino IDE” article.

After installing the Arduino IDE you should see the next window.

After installing the Arduino IDE, it will be essential to install the library in order to start utilizing the Beelan-LoRaWAN. Perform the next steps to install the Beelan-LoRaWAN library.

Install the library

Quick Installing

To install, in the Arduino IDE, go to Sketch > Include Library > Manage Libraries.

Use the Arduino Library Manager and search for “Beelan LoraWAN”.

Manual Installing

To do this, it is necessary to download the library for this repository.

Go to the main page of the repository, https://github.com/ElectronicCats/Beelan-LoRaWAN, and download the files in ZIP format.

Then you will need to add it to Arduino.

In the Arduino IDE, go to: Sketch > Include Library select Add .ZIP Library.

You will be prompted to select the library you would like to add. Navigate to the .zip file's location and open it.

Return to the Sketch > Include Library menu. You should now see the library. It is ready to be used in your sketch. The zip file will have been expanded in the libraries' folder in your Arduino sketches directory.