mirror of https://github.com/FreeRTOS/FreeRTOS.git synced 2026-07-30 17:54:14 +00:00

Files

Archit Aggarwal 28e0db8b3b Add support for new MQTT in memory estimator tool (#138 )

* Add support for new MQTT in memory estimator tool

* Fix issues in generating memory estimate report for MQTT Beta2 library

* Update supported libraries' list in README for mqtt-beta1 and mqtt-beta libraries

* Add beta1 suffix for light-mqtt library in README

2020-07-13 11:01:11 -07:00

config_files

Add support for new MQTT in memory estimator tool (#138 )

2020-07-13 11:01:11 -07:00

template

Add support for new MQTT in memory estimator tool (#138 )

2020-07-13 11:01:11 -07:00

json_report_generator.py

Add support for generating JSON report (#81 )

2020-06-05 13:10:51 -07:00

makefile_generator.py

Add the memory estimator tool (#69 )

2020-05-26 12:34:47 -07:00

memory_estimator.py

Add support for new MQTT in memory estimator tool (#138 )

2020-07-13 11:01:11 -07:00

README.md

Add support for new MQTT in memory estimator tool (#138 )

2020-07-13 11:01:11 -07:00

README.md

MemoryEstimator

This utility helps in determining the memory estimates for FreeRTOS libraries.

Usage

python memory_estimator.py -p <path_to_freertos_lts_directory> -o <optimization> -l <library_name>

Where:

<path_to_freertos_lts_directory> is the path to the directory containing FreeRTOS LTS source code.
<optimization> is the compiler optimization level (O0, Os etc).
<library_name> is the library to calculate the memory estimates for.

Options

Short Name	Long Name	Default	Description
-p	--lts-path		Path to the directory containing FreeRTOS LTS code.
-o	--optimization	O0	Compiler optimization level (O0, Os etc).
-l	--lib	`mqtt-beta1`	The library to calculate the memory estimates for. Currently supported libraries are: `mqtt-beta1`, `light-mqtt-beta1`, `mqtt-beta2`, `https`, `shadow`, `jobs`, `ota-mqtt`, `ota-http`, `kernel`
-c	--compiler	arm-none-eabi-gcc	Compiler to use.
-s	--sizetool	arm-none-eabi-size	Size tool to use.
-d	--dontclean		The generated artifacts, which include the generated Makefile and built object files, are deleted by default. Pass `-d` to ensure that the generated artifacts are not deleted.
-g	--generate-report		Pass `-g` to generate a JSON report containing sizes for all libraries. If this option is used, values for `--optimization`, `--lib` and `--dontclean` are ignored.