MultiTech / Mbed OS Dot-AT-Firmware

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

Stable library for mDot.

libmDot

xDot Library

Development library for xDot.

libxDot-dev

Stable library for xDot.

libxDot

CommandTerminal/CmdFreeMemory.cpp@32:823f9d955839, 2020-11-19 (annotated)

Committer:
Jason Reiss
Date:
Thu Nov 19 11:01:49 2020 -0600
Revision:
32:823f9d955839
Parent:
27:5fafd3b26ac3 
Added tag 4.0.0 for changeset d8251067cd3b

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jason Reiss 27:5fafd3b26ac3 1 #include "CmdFreeMemory.h"
Jason Reiss 27:5fafd3b26ac3 2 #include <algorithm>
Jason Reiss 27:5fafd3b26ac3 3
Jason Reiss 27:5fafd3b26ac3 4 CmdFreeMemory::CmdFreeMemory() :
Jason Reiss 27:5fafd3b26ac3 5 Command("Free Memory", "AT+MEM",
Jason Reiss 27:5fafd3b26ac3 6 #if defined(TARGET_MTS_MDOT_F411RE)
Jason Reiss 27:5fafd3b26ac3 7 "Show amount of free RAM available",
Jason Reiss 27:5fafd3b26ac3 8 #else
Jason Reiss 27:5fafd3b26ac3 9 "",
Jason Reiss 27:5fafd3b26ac3 10 #endif
Jason Reiss 27:5fafd3b26ac3 11 "")
Jason Reiss 27:5fafd3b26ac3 12 {
Jason Reiss 27:5fafd3b26ac3 13 _queryable = true;
Jason Reiss 27:5fafd3b26ac3 14 }
Jason Reiss 27:5fafd3b26ac3 15
Jason Reiss 27:5fafd3b26ac3 16 uint32_t CmdFreeMemory::action(const std::vector<std::string>& args)
Jason Reiss 27:5fafd3b26ac3 17 {
Jason Reiss 27:5fafd3b26ac3 18 // In order to get free mem within RTOS
Jason Reiss 27:5fafd3b26ac3 19 // we need to get the main thread's stack pointer
Jason Reiss 27:5fafd3b26ac3 20 // and subtract it with the top of the heap
Jason Reiss 27:5fafd3b26ac3 21 // ------+-------------------+ Last Address of RAM (INITIAL_SP)
Jason Reiss 27:5fafd3b26ac3 22 // | Scheduler Stack |
Jason Reiss 27:5fafd3b26ac3 23 // +-------------------+
Jason Reiss 27:5fafd3b26ac3 24 // | Main Thread Stack |
Jason Reiss 27:5fafd3b26ac3 25 // | | |
Jason Reiss 27:5fafd3b26ac3 26 // | v |
Jason Reiss 27:5fafd3b26ac3 27 // +-------------------+ <- bottom_of_stack/__get_MSP()
Jason Reiss 27:5fafd3b26ac3 28 // RAM | |
Jason Reiss 27:5fafd3b26ac3 29 // | Available RAM |
Jason Reiss 27:5fafd3b26ac3 30 // | |
Jason Reiss 27:5fafd3b26ac3 31 // +-------------------+ <- top_of_heap
Jason Reiss 27:5fafd3b26ac3 32 // | ^ |
Jason Reiss 27:5fafd3b26ac3 33 // | | |
Jason Reiss 27:5fafd3b26ac3 34 // | Heap |
Jason Reiss 27:5fafd3b26ac3 35 // +-------------------+ <- __end__ / HEAP_START (linker defined var)
Jason Reiss 27:5fafd3b26ac3 36 // | ZI |
Jason Reiss 27:5fafd3b26ac3 37 // +-------------------+
Jason Reiss 27:5fafd3b26ac3 38 // | ZI: Shell Stack |
Jason Reiss 27:5fafd3b26ac3 39 // +-------------------+
Jason Reiss 27:5fafd3b26ac3 40 // | ZI: Idle Stack |
Jason Reiss 27:5fafd3b26ac3 41 // +-------------------+
Jason Reiss 27:5fafd3b26ac3 42 // | ZI: Timer Stack |
Jason Reiss 27:5fafd3b26ac3 43 // +-------------------+
Jason Reiss 27:5fafd3b26ac3 44 // | RW |
Jason Reiss 27:5fafd3b26ac3 45 // ------+===================+ First Address of RAM
Jason Reiss 27:5fafd3b26ac3 46 // | |
Jason Reiss 27:5fafd3b26ac3 47 // Flash | |
Jason Reiss 27:5fafd3b26ac3 48 //
Jason Reiss 27:5fafd3b26ac3 49
Jason Reiss 27:5fafd3b26ac3 50 uint32_t bottom_of_stack = __get_MSP();
Jason Reiss 27:5fafd3b26ac3 51 char* top_of_heap = (char *) malloc(sizeof(char));
Jason Reiss 27:5fafd3b26ac3 52 uint32_t diff = bottom_of_stack - (uint32_t) top_of_heap;
Jason Reiss 27:5fafd3b26ac3 53
Jason Reiss 27:5fafd3b26ac3 54 free((void *) top_of_heap);
Jason Reiss 27:5fafd3b26ac3 55
Jason Reiss 27:5fafd3b26ac3 56 CommandTerminal::Serial()->writef("%lu bytes\r\n", diff);
Jason Reiss 27:5fafd3b26ac3 57
Jason Reiss 27:5fafd3b26ac3 58 return 0;
Jason Reiss 27:5fafd3b26ac3 59 }
Jason Reiss 27:5fafd3b26ac3 60
Jason Reiss 27:5fafd3b26ac3 61 bool CmdFreeMemory::verify(const std::vector<std::string>& args)
Jason Reiss 27:5fafd3b26ac3 62 {
Jason Reiss 27:5fafd3b26ac3 63 if (args.size() == 1)
Jason Reiss 27:5fafd3b26ac3 64 return true;
Jason Reiss 27:5fafd3b26ac3 65
Jason Reiss 27:5fafd3b26ac3 66 return false;
Jason Reiss 27:5fafd3b26ac3 67 }