Schmatics desk automation

Automated Mechanical Desk Lift System

Quick Start

Automated Development Pipeline (Recommended)

The fastest way to build and test the project:

# Complete pipeline: build + dual motor validation + static analysis
python toolchain/run-pipeline.py all

# Build only
python toolchain/run-pipeline.py clean-build

# Run tests (validates both MT_BASIC and MT_ROBUST motor types)
python toolchain/run-pipeline.py test

# Quick unit test during development
python toolchain/run-pipeline.py unit

# Get help
python toolchain/run-pipeline.py help

📖 Detailed Instructions:

• Pipeline Guide: toolchain/README.md - Complete pipeline manual
• Build Guide: src/README.md - Manual build and test instructions
• Test Overview: tests/README.md - Test suite quick reference

Project Overview

The Automated Mechanical Desk Lift System is a motorized solution for height-adjustable desks, enabling users to easily switch between sitting and standing positions. The system features responsive controls, safety mechanisms to prevent accidents, and reliable operation over the product lifetime. Key features include:

• Configurable motor drivers: Support for both L298N (cost-optimized) and IBT_2 (high-capacity) motor controllers
• Motorized height adjustment from 30 cm to 120 cm
• Support for up to 20 kg load (monitor, keyboard, etc.)
• UP/DOWN buttons for intuitive control
• Immediate halt on button release or obstruction detection
• Robust safety features including limit sensors and current sensing for jam detection
• Smooth, predictable motion for user comfort
• Designed for office environments to improve health and productivity
• Modular architecture for maintainability and future feature expansion
• Comprehensive documentation and testing to ensure quality and reliability
• Open-source hardware and software design for community collaboration and innovation

Motor Driver Options

The system supports two motor driver configurations, selectable at compile-time:

Both drivers share the same software (unified HAL interface) and provide equivalent safety and functionality. See Motor Driver Configuration Guide for build and switching instructions.

Motor Configuration Architecture

The system implements a robust motor configuration encapsulation pattern to support multiple motor driver types:

Design Approach

• Compile-Time Configuration (Current): Motor type is defined at compile-time in src/motor_config.cpp with validation
• Runtime-Ready (Future): Architecture is prepared for NVM-based runtime configuration without code changes
• Encapsulation Interface: MotorConfig_getMotorType() function provides the sole accessor for motor configuration
• Application Transparency: All application logic is motor-type-agnostic; HAL layer handles driver-specific details

Configuration Files

Switching Motor Drivers

# Default: MT_BASIC (L298N)
cmake -S . -B build && cmake --build build

# To use MT_ROBUST (IBT_2): Edit src/motor_config.cpp line 44
# #define MOTOR_TYPE MT_BASIC        <- Change to MT_ROBUST
# Then rebuild:
cmake --build build

Test Coverage

All 37 unit and integration tests validate both motor configurations:

• MT_BASIC: L298N driver (default)
• MT_ROBUST: IBT_2 driver

Tests can be run against either driver by changing the MOTOR_TYPE definition. See 05_SoftwareArchitecture.md (AD-009: Motor Configuration Encapsulation) and 06_00_DetailedDesign.md (Motor Configuration Module) for detailed technical documentation.

Documentation Index

Development Guidelines

Requirements and Design

Project Structure

Root Directory

Source Code (src/)

Tests (tests/)

Training Materials (00_training_context/)

Schematics (schematics/)