AT command firmware for MultiTech Dot devices.

Fork of mDot_AT_firmware by MultiTech

Dot Library Not Included!

Because these example programs can be used for both mDot and xDot devices, the LoRa stack is not included. The libmDot library should be imported if building for mDot devices. The libxDot library should be imported if building for xDot devices. The AT firmware was last tested with mbed-os-5.4.7. Using a version past mbed-os-5.4.7 will cause the build to fail. The library used with the AT firmware has to match the mbed-os version.

Dot Library Version 3 Updates

Dot Library versions 3.x.x require a channel plan to be injected into the stack. The Dot-Examples and Dot-AT-Firmware do this by defining a macro called "CHANNEL_PLAN" that controls the channel plan that will be used in the examples. Available channel plans will be in the Dot Library repository in the plans folder.

Revision 20 and earlier of Dot-Examples and revision 15 and earlier of Dot-AT-Firmware should be used with Dot Library versions prior to 3.0.0.

Fota Library

Th Fota Library must be added to compile for mDot 3.1.0 with Fota support. Latest dev libraries and 3.2.0 release will include Fota with libmDot/libxDot.

AT Firmware Description

This AT Firmware is what ships on mDot and xDot devices. It provides an AT command interface for using the mDot or xDot for LoRa communication.

AT command documentation can be found on Multitech.com.

The firmware changelog can be found here. The library changelog can be found here.

Dot Libraries

Dot Library Limitations

The commit messages in libmDot-mbed5 and libmDot-dev-mbed5 specify the version of the Dot library the commit contains and the version of mbed-os it was compiled against. We recommend building your application with the version of mbed-os specified in the commit message of the version of the Dot library you're using. This will ensure that you don't run into any runtime issues caused by differences in the mbed-os versions.

Stable and development libraries are available for both mDot and xDot platforms. The library chosen must match the target platform. Compiling for the mDot platform with the xDot library or vice versa will not succeed.

mDot Library

Development library for mDot.

libmDot-dev-mbed5

Stable library for mDot.

Import librarylibmDot-mbed5

Stable version of the mDot library for mbed 5. This version of the library is suitable for deployment scenarios. See lastest commit message for version of mbed-os library that has been tested against.

xDot Library

Development library for xDot.

libxDot-dev-mbed5

Stable library for xDot.

Import librarylibxDot-mbed5

Stable version of the xDot library for mbed 5. This version of the library is suitable for deployment scenarios.

main.cpp

Committer:
Jason Reiss
Date:
4 months ago
Revision:
33:5c0252521669
Parent:
28:c222ca8383f4

File content as of revision 33:5c0252521669:

#include "mbed.h"
#include "mDot.h"
#include "CommandTerminal.h"
#include "ChannelPlans.h"

#if defined(TARGET_XDOT_L151CC) && defined(FOTA)
#include "SPIFBlockDevice.h"
#include "DataFlashBlockDevice.h"
#endif

mbed::UnbufferedSerial debug_port(USBTX, USBRX, LOG_DEFAULT_BAUD_RATE);

FileHandle *mbed::mbed_override_console(int fd)
{
    return &debug_port;
}


#if defined(TARGET_MTS_MDOT_F411RE)
#define AT_TX_PIN   XBEE_DOUT
#define AT_RX_PIN   XBEE_DIN
#define AT_RTS_PIN  XBEE_RTS
#define AT_CTS_PIN  XBEE_CTS
#elif defined(TARGET_XDOT_L151CC)
#define AT_TX_PIN   UART1_TX
#define AT_RX_PIN   UART1_RX
#define AT_RTS_PIN  UART1_RTS
#define AT_CTS_PIN  UART1_CTS
#else
#error Unsupported target
#endif

#ifndef CHANNEL_PLAN
#define CHANNEL_PLAN CP_US915
#endif

#ifndef UNIT_TEST
#ifndef UNIT_TEST_MDOT_LIB

DigitalIn boot(PA_5);

int main()
{
#if defined(DEBUG_MAC) && defined(TARGET_MTS_MDOT_F411RE)
    lora::ChannelPlan* plan = new lora::ChannelPlan_US915();
    mDot* dot = mDot::getInstance(plan);
#else
#if CHANNEL_PLAN == CP_AS923
    lora::ChannelPlan_AS923 plan;
#elif CHANNEL_PLAN == CP_AS923_2
    lora::ChannelPlan_AS923 plan;
#elif CHANNEL_PLAN == CP_AS923_3
    lora::ChannelPlan_AS923 plan;
#elif CHANNEL_PLAN == CP_US915
    lora::ChannelPlan_US915 plan;
#elif CHANNEL_PLAN == CP_AU915
    lora::ChannelPlan_AU915 plan;
#elif CHANNEL_PLAN == CP_EU868
    lora::ChannelPlan_EU868 plan;
#elif CHANNEL_PLAN == CP_KR920
    lora::ChannelPlan_KR920 plan;
#elif CHANNEL_PLAN == CP_IN865
    lora::ChannelPlan_IN865 plan;
#elif CHANNEL_PLAN == CP_AS923_JAPAN
    lora::ChannelPlan_AS923_Japan plan;
#elif CHANNEL_PLAN == CP_AS923_JAPAN1
    lora::ChannelPlan_AS923_Japan1 plan;
#elif CHANNEL_PLAN == CP_AS923_JAPAN2
    lora::ChannelPlan_AS923_Japan2 plan;
#elif CHANNEL_PLAN == CP_RU864
    lora::ChannelPlan_RU864 plan;
#endif
#if defined(TARGET_XDOT_L151CC) && defined(FOTA)

    mbed::BlockDevice* ext_bd = NULL;

    ext_bd = new SPIFBlockDevice();
    int ret = ext_bd->init();
    if (ext_bd->init() < 0) {
        delete ext_bd;
        ext_bd = new DataFlashBlockDevice();
        ret = ext_bd->init();
        // Check for zero size because DataFlashBlockDevice doesn't
        // return an error if the chip is not present
        if ((ret < 0) || (ext_bd->size() == 0)) {
            delete ext_bd;
            ext_bd = NULL;
        }
    }

    mDot* dot = mDot::getInstance(&plan, ext_bd);

    if (ext_bd != NULL) {
        logInfo("External flash device detected, type: %s, size: 0x%08x",
            ext_bd->get_type(), (uint32_t)ext_bd->size());
    }
#else
    mDot* dot = mDot::getInstance(&plan);
#endif
#endif //MTS_MDOT_F411RE
    assert(dot);

#if defined(DEBUG_MAC) && defined(TARGET_MTS_MDOT_F411RE)
    logDebug("Loading default channel plan %02x", dot->getDefaultFrequencyBand());
    switch (dot->getDefaultFrequencyBand()) {
        case lora::ChannelPlan::AS923:
        case lora::ChannelPlan::AS923_2:
        case lora::ChannelPlan::AS923_3:
            delete plan;
            plan = new lora::ChannelPlan_AS923();
            break;

        case lora::ChannelPlan::US915:
        case lora::ChannelPlan::US915_OLD:
            delete plan;
            plan = new lora::ChannelPlan_US915();
            break;

        case lora::ChannelPlan::AU915:
        case lora::ChannelPlan::AU915_OLD:
            delete plan;
            plan = new lora::ChannelPlan_AU915();
            break;

        case lora::ChannelPlan::EU868:
        case lora::ChannelPlan::EU868_OLD:
            delete plan;
            plan = new lora::ChannelPlan_EU868();
            break;

        case lora::ChannelPlan::KR920:
            delete plan;
            plan = new lora::ChannelPlan_KR920();
            break;

        case lora::ChannelPlan::AS923_JAPAN:
            delete plan;
            plan = new lora::ChannelPlan_AS923_Japan();
            break;

        case lora::ChannelPlan::AS923_JAPAN1:
            delete plan;
            plan = new lora::ChannelPlan_AS923_Japan1();
            break;

        case lora::ChannelPlan::AS923_JAPAN2:
            delete plan;
            plan = new lora::ChannelPlan_AS923_Japan2();
            break;

        case lora::ChannelPlan::IN865:
            delete plan;
            plan = new lora::ChannelPlan_IN865();
            break;

        case lora::ChannelPlan::RU864:
            delete plan;
            plan = new lora::ChannelPlan_RU864();
            break;

        default:
            logInfo("Default channel plan not valid Defaulting US915");
            delete plan;
            plan = new lora::ChannelPlan_US915();
            break;
    }
    dot->setChannelPlan(plan);
#endif
    // Seed the RNG
    srand(dot->getRadioRandom());


    PinName rtsPin = NC;
    PinName ctsPin = NC;
    if (dot->getFlowControl()) {
        rtsPin = AT_RTS_PIN;
        ctsPin = AT_CTS_PIN;
    }

    mts::ATSerial serial(AT_TX_PIN, AT_RX_PIN, rtsPin, ctsPin, dot->getBaud());

    debug_port.baud(dot->getDebugBaud());

    CommandTerminal term(serial);
    CommandTerminal::_dot = dot;

    Fota::getInstance(dot);

    term.init();

    term.start();
}

#endif // UNIT_TEST
#endif