Skip to main content

Utilities for MrT

Project description

MrT Framework

Modular Reusability and Testing Framework

MrT is a collection of reusable modules that can be easily integrated into new projects. Each module is designed and maintained according to guidelines and standards to keep consistency. This allows uniform implementation, documentation and testing.

Modules

There are three types of modules in the MrT framework Platforms, Devices, and Utilities

Platforms

Platforms are abstractions for specific platforms. This could be an OS or an MCU family. Each platform contains abstracted interfaces such as GPIO, Uart, SPI, and I2C. This allows the device modules to have a common interface for all platforms. When using a platform module, check the Readme for the module for the integrations steps specific to that platform. Normally these are just the steps to include the Modules directory in the projects include path, and define the MRT_PLATFORM symbol

Devices

Devices are modules for supporting commonly used ICs in projects. This would include common sensors, flash/eeprom memory, displays, battery charge controllers, etc.

Device modules contain all the logic needed for their operation and communicate using abstracted interfaces from platform modules

Utilities

Utilities are modules that provide a common functionality with no need for abstraction i.e., they do not depend on any specific hardware or platform. These include Fifos, Hashing functions, encoders/decoders, and messaging protocols. Because these do not rely on any hardware, they can be used without a Platform module

Getting Started

This section of the document gives a basic overview of installing and using the modules

Installation

The code modules themselves are imported as submodules, so there are no libraries that need to be installed. But there is a toolset mrtutils which makes it easier to manage the modules.

pip install mrtutils

Integrating MrT into your project

cd <path/to/project>

mrt-config <relative/path/for/MrT/root>

This will open the mrt-config tool which allows you to select which modules you would like to integrate into your project. The UI is based on menuconfig to be as flexible as possible in terms of where you can run it, ie in containers or remote development environments over ssh.

docs/images/mrt-config.png

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mrtutils-0.3.39.tar.gz (174.5 kB view details)

Uploaded Source

Built Distribution

mrtutils-0.3.39-py3-none-any.whl (198.9 kB view details)

Uploaded Python 3

File details

Details for the file mrtutils-0.3.39.tar.gz.

File metadata

  • Download URL: mrtutils-0.3.39.tar.gz
  • Upload date:
  • Size: 174.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.3

File hashes

Hashes for mrtutils-0.3.39.tar.gz
Algorithm Hash digest
SHA256 8f7b326e8426ecdcaebbbf92a118ce51e94c9f275f2b9fa90e2d429b518a5575
MD5 bd56fc5172012764fd5d306cadb32508
BLAKE2b-256 3674a74b6eb1de41b0ac3edc0140552f473a76acf26760a4076976f6976260d8

See more details on using hashes here.

File details

Details for the file mrtutils-0.3.39-py3-none-any.whl.

File metadata

  • Download URL: mrtutils-0.3.39-py3-none-any.whl
  • Upload date:
  • Size: 198.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.3

File hashes

Hashes for mrtutils-0.3.39-py3-none-any.whl
Algorithm Hash digest
SHA256 b8cbca40c463f870456936d18af3502bbddf4aad1a29389e5ab98d9d5ccaf8a7
MD5 3e16351c6df707e270a84038e8559c4d
BLAKE2b-256 7c435a5eb5c55acb12f7d8c1018aec4b58f345baef2e9bd2cdce31036a40e398

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page