SoftRF variant of BASICMAC library is now open source [skip ci]

software/firmware/source/libraries/arduino-basicmac/LICENSE

@@ -0,0 +1,26 @@
+--- Revised 3-Clause BSD License ---
+Copyright (C) 2016-2019, SEMTECH (International) AG.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+ * Neither the name of the copyright holder nor the names of its contributors
+ may be used to endorse or promote products derived from this software
+ without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL SEMTECH BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

software/firmware/source/libraries/arduino-basicmac/examples/ttn-abp/ttn-abp.ino

@@ -0,0 +1,303 @@
+/*******************************************************************************
+ * Copyright (c) 2015 Thomas Telkamp and Matthijs Kooijman
+ *
+ * Permission is hereby granted, free of charge, to anyone
+ * obtaining a copy of this document and accompanying files,
+ * to do whatever they want with them without any restriction,
+ * including, but not limited to, copying, modification and redistribution.
+ * NO WARRANTY OF ANY KIND IS PROVIDED.
+ *
+ * This example sends a valid LoRaWAN packet with payload "Hello,
+ * world!", using frequency and encryption settings matching those of
+ * the The Things Network.
+ *
+ * This uses ABP (Activation-by-personalisation), where a DevAddr and
+ * Session keys are preconfigured (unlike OTAA, where a DevEUI and
+ * application key is configured, while the DevAddr and session keys are
+ * assigned/generated in the over-the-air-activation procedure).
+ *
+ * Note: LoRaWAN per sub-band duty-cycle limitation is enforced (1% in
+ * g1, 0.1% in g2), but not the TTN fair usage policy (which is probably
+ * violated by this sketch when left running for longer)!
+ *
+ * To use this sketch, first register your application and device with
+ * the things network, to set or generate a DevAddr, NwkSKey and
+ * AppSKey. Each device should have their own unique values for these
+ * fields.
+ *
+ * Do not forget to define the radio type correctly in config.h.
+ *
+ *******************************************************************************/
+
+#include <lmic.h>
+#include <hal/hal.h>
+#include <SPI.h>
+
+#define BASICMAC
+
+// LoRaWAN NwkSKey, network session key
+// This is the default Semtech key, which is used by the early prototype TTN
+// network.
+static const PROGMEM u1_t NWKSKEY[16] = { 0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6, 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C };
+
+// LoRaWAN AppSKey, application session key
+// This is the default Semtech key, which is used by the early prototype TTN
+// network.
+static const u1_t PROGMEM APPSKEY[16] = { 0x2B, 0x7E, 0x15, 0x16, 0x28, 0xAE, 0xD2, 0xA6, 0xAB, 0xF7, 0x15, 0x88, 0x09, 0xCF, 0x4F, 0x3C };
+
+// LoRaWAN end-device address (DevAddr)
+static const u4_t DEVADDR = 0x03FF0001; // <-- Change this address for every node!
+
+// These callbacks are only used in over-the-air activation, so they are
+// left empty here (we cannot leave them out completely unless
+// DISABLE_JOIN is set in config.h, otherwise the linker will complain).
+#ifdef BASICMAC
+void os_getJoinEui (u1_t* buf) { }
+void os_getDevEui (u1_t* buf) { }
+void os_getNwkKey (u1_t* buf) { }
+u1_t os_getRegion (void) { return REGCODE_EU868; }
+#else
+void os_getArtEui (u1_t* buf) { }
+void os_getDevEui (u1_t* buf) { }
+void os_getDevKey (u1_t* buf) { }
+#endif
+
+
+// Schedule TX every this many milliseconds (might become longer due to duty
+// cycle limitations).
+const unsigned TX_INTERVAL = 60000;
+
+#ifdef ARDUINO_TRINKET_M0
+ const lmic_pinmap lmic_pins = {
+ .nss = 0, // PA8 / pin 11
+ .rxtx = LMIC_UNUSED_PIN,
+ .rst = 1, // PA2 / pin 3
+ .dio = {7 /* PA0 / pin 1 */, LMIC_UNUSED_PIN /* 8 PA1 / pin 2 */, LMIC_UNUSED_PIN /* 13 PA10 / pin 13 */},
+ };
+#else
+// Feather M0
+// Pin mapping
+const lmic_pinmap lmic_pins = {
+ .nss = 8,
+ .rxtx = LMIC_UNUSED_PIN,
+ .rst = 4,
+ .dio = {3, 5, 6},
+};
+#endif
+
+#ifdef BASICMAC
+extern "C" void onLmicEvent (ev_t ev);
+void onLmicEvent (ev_t ev) {
+#else
+void onEvent (ev_t ev) {
+#endif
+ Serial.print(os_getTime());
+ Serial.print(": ");
+ switch(ev) {
+ case EV_SCAN_TIMEOUT:
+ Serial.println(F("EV_SCAN_TIMEOUT"));
+ break;
+ case EV_BEACON_FOUND:
+ Serial.println(F("EV_BEACON_FOUND"));
+ break;
+ case EV_BEACON_MISSED:
+ Serial.println(F("EV_BEACON_MISSED"));
+ break;
+ case EV_BEACON_TRACKED:
+ Serial.println(F("EV_BEACON_TRACKED"));
+ break;
+ case EV_JOINING:
+ Serial.println(F("EV_JOINING"));
+ break;
+ case EV_JOINED:
+ Serial.println(F("EV_JOINED"));
+ break;
+ case EV_RFU1:
+ Serial.println(F("EV_RFU1"));
+ break;
+ case EV_JOIN_FAILED:
+ Serial.println(F("EV_JOIN_FAILED"));
+ break;
+ case EV_REJOIN_FAILED:
+ Serial.println(F("EV_REJOIN_FAILED"));
+ break;
+ case EV_TXCOMPLETE:
+ Serial.println(F("EV_TXCOMPLETE (includes waiting for RX windows)"));
+ if (LMIC.txrxFlags & TXRX_ACK)
+ Serial.println(F("Received ack"));
+ if (LMIC.dataLen) {
+ Serial.println(F("Received "));
+ Serial.println(LMIC.dataLen);
+ Serial.println(F(" bytes of payload"));
+ }
+ break;
+ case EV_LOST_TSYNC:
+ Serial.println(F("EV_LOST_TSYNC"));
+ break;
+ case EV_RESET:
+ Serial.println(F("EV_RESET"));
+ break;
+ case EV_RXCOMPLETE:
+ // data received in ping slot
+ Serial.println(F("EV_RXCOMPLETE"));
+ break;
+ case EV_LINK_DEAD:
+ Serial.println(F("EV_LINK_DEAD"));
+ break;
+ case EV_LINK_ALIVE:
+ Serial.println(F("EV_LINK_ALIVE"));
+ break;
+#ifdef BASICMAC
+ case EV_SCAN_FOUND:
+ Serial.println(F("EV_SCAN_FOUND"));
+ break;
+ case EV_TXSTART:
+ Serial.println(F("EV_TXSTART,"));
+ break;
+ case EV_TXDONE:
+ Serial.println(F("EV_TXDONE"));
+ break;
+ case EV_DATARATE:
+ Serial.println(F("EV_DATARATE"));
+ break;
+ case EV_START_SCAN:
+ Serial.println(F("EV_START_SCAN"));
+ break;
+ case EV_ADR_BACKOFF:
+ Serial.println(F("EV_ADR_BACKOFF"));
+ break;
+#endif
+ default:
+ Serial.println(F("Unknown event"));
+ break;
+ }
+}
+
+void setup() {
+ Serial.begin(115200);
+ // Wait up to 5 seconds for serial to be opened, to allow catching
+ // startup messages on native USB boards (that do not reset when
+ // serial is opened).
+ unsigned long start = millis();
+ while (millis() - start < 5000 && !Serial);
+ Serial.println(F("Starting"));
+
+ // LMIC init
+ #ifdef BASICMAC
+ os_init(nullptr);
+ #else
+ os_init();
+ #endif
+ // Reset the MAC state. Session and pending data transfers will be discarded.
+ LMIC_reset();
+
+ // Set static session parameters. Instead of dynamically establishing a session
+ // by joining the network, precomputed session parameters are be provided.
+ #ifdef PROGMEM
+ // On AVR, these values are stored in flash and only copied to RAM
+ // once. Copy them to a temporary buffer here, LMIC_setSession will
+ // copy them into a buffer of its own again.
+ uint8_t appskey[sizeof(APPSKEY)];
+ uint8_t nwkskey[sizeof(NWKSKEY)];
+ memcpy_P(appskey, APPSKEY, sizeof(APPSKEY));
+ memcpy_P(nwkskey, NWKSKEY, sizeof(NWKSKEY));
+ LMIC_setSession (0x1, DEVADDR, nwkskey, appskey);
+ #else
+ // If not running an AVR with PROGMEM, just use the arrays directly
+ LMIC_setSession (0x1, DEVADDR, NWKSKEY, APPSKEY);
+ #endif
+
+ #if defined(CFG_eu868)
+ // Set up the channels used by the Things Network, which corresponds
+ // to the defaults of most gateways. Without this, only three base
+ // channels from the LoRaWAN specification are used, which certainly
+ // works, so it is good for debugging, but can overload those
+ // frequencies, so be sure to configure the full frequency range of
+ // your network here (unless your network autoconfigures them).
+ // Setting up channels should happen after LMIC_setSession, as that
+ // configures the minimal channel set.
+ // NA-US channels 0-71 are configured automatically
+#ifdef BASICMAC
+ LMIC_setupChannel(0, 868100000, DR_RANGE_MAP(SF12, SF7)); // g-band
+ //LMIC_setupChannel(1, 868300000, DR_RANGE_MAP(SF12, SF7B)); // g-band
+ LMIC_setupChannel(2, 868500000, DR_RANGE_MAP(SF12, SF7)); // g-band
+ LMIC_setupChannel(3, 867100000, DR_RANGE_MAP(SF12, SF7)); // g-band
+ LMIC_setupChannel(4, 867300000, DR_RANGE_MAP(SF12, SF7)); // g-band
+ LMIC_setupChannel(5, 867500000, DR_RANGE_MAP(SF12, SF7)); // g-band
+ LMIC_setupChannel(6, 867700000, DR_RANGE_MAP(SF12, SF7)); // g-band
+ LMIC_setupChannel(7, 867900000, DR_RANGE_MAP(SF12, SF7)); // g-band
+ LMIC_setupChannel(8, 868800000, DR_RANGE_MAP(FSK, FSK)); // g2-band
+#else
+ LMIC_setupChannel(0, 868100000, DR_RANGE_MAP(DR_SF12, DR_SF7), BAND_CENTI); // g-band
+ LMIC_setupChannel(1, 868300000, DR_RANGE_MAP(DR_SF12, DR_SF7B), BAND_CENTI); // g-band
+ LMIC_setupChannel(2, 868500000, DR_RANGE_MAP(DR_SF12, DR_SF7), BAND_CENTI); // g-band
+ LMIC_setupChannel(3, 867100000, DR_RANGE_MAP(DR_SF12, DR_SF7), BAND_CENTI); // g-band
+ LMIC_setupChannel(4, 867300000, DR_RANGE_MAP(DR_SF12, DR_SF7), BAND_CENTI); // g-band
+ LMIC_setupChannel(5, 867500000, DR_RANGE_MAP(DR_SF12, DR_SF7), BAND_CENTI); // g-band
+ LMIC_setupChannel(6, 867700000, DR_RANGE_MAP(DR_SF12, DR_SF7), BAND_CENTI); // g-band
+ LMIC_setupChannel(7, 867900000, DR_RANGE_MAP(DR_SF12, DR_SF7), BAND_CENTI); // g-band
+ LMIC_setupChannel(8, 868800000, DR_RANGE_MAP(DR_FSK, DR_FSK), BAND_MILLI); // g2-band
+#endif
+ // TTN defines an additional channel at 869.525Mhz using SF9 for class B
+ // devices' ping slots. LMIC does not have an easy way to define set this
+ // frequency and support for class B is spotty and untested, so this
+ // frequency is not configured here.
+ #elif defined(CFG_us915)
+ // NA-US channels 0-71 are configured automatically
+ // but only one group of 8 should (a subband) should be active
+ // TTN recommends the second sub band, 1 in a zero based count.
+ // https://github.com/TheThingsNetwork/gateway-conf/blob/master/US-global_conf.json
+ LMIC_selectSubBand(1);
+ #endif
+
+ // Disable link check validation
+ LMIC_setLinkCheckMode(0);
+
+ // TTN uses SF9 for its RX2 window.
+ #ifdef BASICMAC
+ LMIC.dn2Dr = SF9;
+
+ // Set data rate and transmit power for uplink (note: txpow seems to be ignored by the library)
+ LMIC_setDrTxpow(SF7,14);
+ #else
+ LMIC.dn2Dr = DR_SF9;
+
+ // Set data rate and transmit power for uplink (note: txpow seems to be ignored by the library)
+ LMIC_setDrTxpow(DR_SF7,14);
+ #endif
+
+
+ // Enable this to increase the receive window size, to compensate
+ // for an inaccurate clock. // This compensate for +/- 10% clock
+ // error, a lower value will likely be more appropriate.
+ //LMIC_setClockError(MAX_CLOCK_ERROR * 10 / 100);
+
+ // Queue first packet
+ send_packet();
+}
+
+uint32_t last_packet = 0;
+
+void loop() {
+ // Let LMIC handle background tasks
+ #ifdef BASICMAC
+ os_runstep();
+ #else
+ os_runloop_once();
+ #endif
+
+ // If TX_INTERVAL passed, *and* our previous packet is not still
+ // pending (which can happen due to duty cycle limitations), send
+ // the next packet.
+ if (millis() - last_packet > TX_INTERVAL && !(LMIC.opmode & OP_TXRXPEND))
+ send_packet();
+}
+
+void send_packet(){
+ // Prepare upstream data transmission at the next possible time.
+ uint8_t mydata[] = "Hello, world!";
+ LMIC_setTxData2(1, mydata, sizeof(mydata)-1, 0);
+ Serial.println(F("Packet queued"));
+
+ last_packet = millis();
+}