// readme

Arduino Apps Brick Library

The library is composed of configurable and reusable โ€˜Bricksโ€™, based on optional infrastructure (executed via Docker Compose) and wrapping Pythonยฎ code (to simplify code usage).

What is a Brick?

A Brick is a modular, reusable building block that provides specific functionality for Arduino applications. Each Brick is self-contained with standardized configuration, consistent APIs, and optional Docker service definitions.

Directory Structure

Every Brick must follow this standardized directory structure:

src/arduino/app_bricks/brick_name/
โ”œโ”€โ”€ __init__.py                 # Required: Public API exports
โ”œโ”€โ”€ brick_config.yaml          # Required: Brick metadata
โ”œโ”€โ”€ brick_compose.yaml         # Optional: Docker services
โ”œโ”€โ”€ README.md                  # Required: Documentation
โ”œโ”€โ”€ [implementation_files.py]  # Brick logic
โ””โ”€โ”€ [assets]                   # Static resources

Brick usage examples live in the app-bricks-examples repository, under the bricks/ folder.

Configuration variables

VariableDescription
APP_HOMEBase applicationโ€ฆ