Merge Lacuna Basic MAC

.github/workflows/compile-arduino-examples.yml

@@ -0,0 +1,74 @@
+name: Compile Arduino examples
+on: [push, pull_request]
+jobs:
+ build:
+ name: ${{ matrix.board }} / ${{ matrix.region }} / ${{ matrix.transceiver }}
+ runs-on: ubuntu-latest
+ env:
+ PLATFORM_DEFAULT_URL: https://arduino.esp8266.com/stable/package_esp8266com_index.json,https://dl.espressif.com/dl/package_esp32_index.json,https://github.com/stm32duino/BoardManagerFiles/raw/master/STM32/package_stm_index.json,https://lacunaspace.github.io/arduino-STM32L4-Lacuna/package_STM32L4_Lacuna_boards_index.json
+ strategy:
+ matrix:
+ board:
+ - arduino:avr:mega
+ - arduino:samd:arduino_zero_edbg
+ - esp8266:esp8266:generic
+ - esp32:esp32:ttgo-lora32-v1
+ - lacunaspace:stm32l4:Lacuna-LS200
+ # Just a random STM32 board
+ - STM32:stm32:Nucleo_64:pnum=NUCLEO_F401RE
+ region:
+ - CFG_eu868
+ - CFG_us915
+ transceiver:
+ - BRD_sx1272_radio
+ - BRD_sx1276_radio
+ - BRD_sx1261_radio
+ - BRD_sx1262_radio
+ include:
+ # Older compilers (used by STM32 and ESP) seem to get confused
+ # by the REGION initializers and produce (seemingly unfixable)
+ # missing-field-initializers warnings. So just ignore these
+ # for these boards.
+ - board: esp8266:esp8266:generic
+ extra_flags: -Wno-error=missing-field-initializers
+ # The STM32 cores have unused-parameter warnings in the core,
+ # so these (this also ignores the same warnings in the sketch
+ # and library, which is not ideal, but this seems to be the
+ # only way to fix this).
+ - board: lacunaspace:stm32l4:Lacuna-LS200
+ extra_flags: -Wno-error=unused-parameter -Wno-error=missing-field-initializers
+ - board: STM32:stm32:Nucleo_64:pnum=NUCLEO_F401RE
+ extra_flags: -Wno-error=unused-parameter -Wno-error=missing-field-initializers
+
+ # Run the entire matrix, even if one failed
+ fail-fast: false
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v2
+
+ - name: Generate Arduino library
+ # Generate twice, once to be moved into the Arduino directory and
+ # once to compile the examples from
+ run: |
+ ./target/arduino/export.sh BasicMacCustom
+ ./target/arduino/export.sh BasicMacArduino
+
+ - name: Compile all examples
+ uses: ArminJo/arduino-test-compile@v3
+ with:
+ arduino-board-fqbn: ${{ matrix.board }}
+ platform-default-url: ${{ env.PLATFORM_DEFAULT_URL }}
+ sketch-names-find-start: ./BasicMacArduino/examples/
+ # Normally, all .ino files are treated as separate sketches, but
+ # this is just a secondary .ino file that does not need to be
+ # separately compiled.
+ sketches-exclude: standard-pinmaps
+ build-properties: >
+ {"All": "
+ -DBASICMAC_DUMMY_PINMAP
+ -D${{matrix.region}}
+ -D${{matrix.transceiver}}
+ -Werror
+ ${{matrix.extra_flags}}
+ "}

.github/workflows/compile-projects.yml

@@ -0,0 +1,42 @@
+name: Compile projects
+on: [push, pull_request]
+jobs:
+ build:
+ name: ${{matrix.target}}
+ runs-on: ubuntu-latest
+ strategy:
+ matrix:
+ target:
+ # List taken from ex-join project, there might be more valid
+ # combinations.
+ - b_l072z_lrwan1
+ - nucleo_l073rz-sx1276mb1las
+ - nucleo_l073rz-sx1272mbed
+ - nucleo_l073rz-sx1276mb1mas
+ - nucleo_l053r8-sx1276mb1las
+ - nucleo_l053r8-sx1261mbed
+ - nucleo_l053r8-sx1262mbed
+
+ # Run the entire matrix, even if one failed
+ fail-fast: false
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v2
+ with:
+ submodules: true
+
+ - name: Install compiler
+ run: sudo apt install gcc-arm-none-eabi
+
+ - name: Setup python
+ uses: actions/setup-python@v2
+ with:
+ python-version: '3.x' # Version range or exact version of a Python version to use, using SemVer's version range syntax
+
+ - name: Install python packages
+ run: python -m pip install lz4 pycryptodome click intelhex pyyaml
+
+ - name: Compile project
+ run: |
+ make -C projects/ex-join TARGET="${{matrix.target}}" || exit 1

.github/workflows/create-arduino-lib.yml

@@ -0,0 +1,21 @@
+name: Create Arduino Library
+on: [push, pull_request]
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v2
+
+ - name: Generate Arduino library
+ run: |
+ # Create two directory levels, so the inner one ends up in the
+ # generated zip
+ mkdir ArduinoLibrary
+ ./target/arduino/export.sh ArduinoLibrary/Basicmac
+
+ - name: Upload artifact
+ uses: actions/upload-artifact@v2
+ with:
+ name: ArduinoLibrary
+ path: ArduinoLibrary

README.md

@@ -1,4 +1,4 @@
-# Basic MAC
+# BasicMAC
 
 [Basic MAC](https://basicmac.io) is a portable implementation of the LoRa
 Alliance®'s LoRaWAN® specification in the C programming language. It is a fork
@@ -13,3 +13,143 @@ Branch | Travis CI
 #### Getting Started
 
 View the [Getting Started Guide](https://basicmac.io/guide/gettingstarted.html).
+
+
+## This repository
+This repository contains an Arduino port of the BasicMAC library.
+However, the port is done without changing the structure of the
+repository itself, so development can continue on other targets at the
+same time.
+
+### Development status
+
+This master branch should be working, testing and contributions are
+welcome. There are still some rough edges, so this should not be
+considered a finished version. The final 2.2 release by Semtech was only
+recently integrated and has seen limited testing.
+
+Initially, development of this repository has been quite unstable, with
+lots of history editing and rebasing, but the intention is to keep the
+master branch stable now (i.e. no force pushes). Rebasing and history
+editing might still happen in other branches and is encourage in
+pullrequests to keep history clean.
+
+The API is still likely to change in a breaking way, especially wrt
+configuration.
+
+### Notable and breaking changes
+
+This section lists notable changes, in particular those that can break
+existing sketches. For full details, see the git changelog.
+
+ - 2020-07-14: On Arduino, the default config is changed to SX1262. If
+ your board uses SX1276 (the old default), you need to modify
+ `target-config.h` in the library.
+
+ - 2020-07-14: On SX126x, DIO3 is no longer configured to control a TCXO
+ by default. If your board needs this, it must be explicitly enabled.
+ On Arduino, set the `tcxo` field of the pin map to
+ `LMIC_CONTROLLED_BY_DIO3`. With Makefile-based stm32, define
+ `LMIC_DIO3_CONTROLS_TCXO` on the compiler commandline.
+
+ - 2020-07-14: On SX126x, DIO2 is no longer configured to control a TXRX
+ antenna switch by default. If your board needs this (most likely it
+ does), it must be explicitly enabled. On Arduino, set the `tx`
+ field of the pin map to `LMIC_CONTROLLED_BY_DIO2`. With
+ Makefile-based stm32, define `LMIC_DIO2_CONTROLS_TXRX` on the
+ compiler commandline.
+
+### Relation to other projects
+
+BasicMAC is a privately developed fork of LMIC, which was released
+publically by Semtech in 2019. In 2020, Semtech has announced it no
+longer intends to develop or support BasicMAC, so this repository is
+intended to become the primary repository for BasicMAC.
+
+This repository borrows heavily from the Arduino LMIC port that was
+first published at https://github.com/matthijskooijman/arduino-lmic/.
+There are some other LMIC versions (notably
+https://github.com/mcci-catena/arduino-lmic) for Arduino based off
+matthijskooijman's version and have seen more development, but no effort
+has been made to incorporate any changes from there.
+
+Ideally, all of these LMIC and BasicMAC-based projects would unify their
+efforts in a repository that is not Arduino-specific, but given that
+there have been signficant changes in both BasicMAC and the MCCI
+versions compared to the original IBM LMIC version, this might be a
+challenge (both technically, and project-wise).
+
+### Using this repository on Arduino
+
+This repository is not directly usable as an Arduino library, in order
+to keep the directory structure more generic. To use it in Arduino,
+there is a bash script that generates an Arduino library out of it. To do so,
+make a git checkout of this repository and from the root of it, run:
+
+ ./target/arduino/export.sh --link ~/Arduino/libraries/BasicMAC
+
+The `--link` parameter makes the script generate symlinks into the
+original repository, allowing you to make changes to the library there
+and have them reflected in the Arduino version directly. If you omit
+`--link`, copies will be made instead.
+
+The directory name passed is created and becomes the library directory,
+it should be in your Arduino sketchbook's `libraries` directly (the path
+shown should work with the default Arduino IDE configuration).
+
+This script was tested on Linux, should work on OSX as well, might work
+on Windows (if you have bash).
+
+### Using this repository without Arduino
+
+To build and upload without Arduino, a makefile-based build system is
+present in the `projects` subdirectory. It currently only supports
+STM32, on some specific boards.
+
+To use it, go into the example project directory (`projects/ex-join`)
+and run `make`.
+
+Some effort has been made to keep these builds working, but actual
+testing of the code in this repository has only been done under Arduino
+(Makefile-based builds are only automatically compile-tested), so the
+Makefile-based builds might very well be broken.
+
+### Hardware support
+
+This port is intended to work on any Arduino board, regardless of
+architecture. It was tested on AVR, SAMD and STM32 boards, and with
+SX1272, SX1276 and SX1262 radios.
+
+Unfortunately, BasicMAC is quite a bit bigger than LMIC, so it seems it
+does not fit in an atmega328p anymore. PROGMEM optimizations have not
+been applied yet, but those would only free up RAM, not flash (and now
+the ttn-otaa example compiles down to 35k of flash, with only 32k
+available).
+
+So far, only EU868 has been tested. Other regions are supported, but are
+not currently tested.
+
+### Converting from LMIC
+
+BasicMAC is based on LMIC and largely works in the same way. Sketches
+can likely be largely reused, though some small changes need to be made.
+See for example [this commit][migrate-examples] for the changes needed to the examples.
+
+Additionally the pinmap was significantly changed, so look at one of the
+current examples to see how that looks now.
+
+[migrate-examples]: https://github.com/LacunaSpace/basicmac/commit/1505722c912c8cb0cfff2e18b115f9f2c1a62d0f
+=======
+[Basic MAC](https://basicmac.io) is a portable implementation of the LoRa
+Alliance®'s LoRaWAN® specification in the C programming language. It is a fork
+of IBM's LMiC library, and supports multiple regions, which are selectable at
+compile and/or run time. It can handle Class A, Class B, and Class C devices.
+
+#### Status
+Branch | Travis CI
+-------|----------
+[`master`](https://github.com/mkuyper/basicmac/tree/master) | [![Build Status](https://travis-ci.com/mkuyper/basicmac.svg?branch=master)](https://travis-ci.com/mkuyper/basicmac)
+
+#### Getting Started
+
+View the [Getting Started Guide](https://basicmac.io/guide/gettingstarted.html).