Skip to main content

UnitMCP package for MCP hardware integration with Ollama LLM and Raspberry Pi hardware control.

Project description

MCP Hardware Project Summary

graph.svg

๐Ÿš€ Project Overview

The MCP Hardware Access Library is a comprehensive Python framework that enables secure hardware control through the Model Context Protocol (MCP). It provides AI agents and automation systems with the ability to interact with physical devices across multiple platforms.

๐Ÿ“Š Project Statistics

  • Total Files: 40+ files
  • Lines of Code: ~5,000+ lines
  • Components: 6 major subsystems
  • Examples: 15+ demonstration scripts
  • Test Coverage: Full client/server tests

๐Ÿ—๏ธ Architecture

Core Components

  1. Client System

    • MCPHardwareClient: Async client for hardware control
    • MCPShell: Interactive command-line interface
    • Pipeline execution support
  2. Server System

    • MCPServer: Main server framework
    • Hardware-specific servers (GPIO, Input, Audio, Camera)
    • Protocol handling and routing
  3. Security Layer

    • Permission management system
    • Client authentication
    • Operation auditing
  4. Pipeline System

    • Automated command sequences
    • Conditional execution
    • Error handling and retries
    • Variable substitution

architecture.svg

๐Ÿ’ก Key Features

1. Hardware Control

  • GPIO Operations: LEDs, buttons, sensors (Raspberry Pi)
  • Input Devices: Keyboard and mouse automation
  • Audio System: Recording, playback, TTS/STT
  • Camera Control: Image capture, face detection, motion detection
  • USB Devices: Device enumeration and management

2. AI Integration

  • Ollama LLM Support: Natural language hardware control
  • Voice Assistant: Speech recognition and synthesis
  • Automated Agents: AI-driven hardware automation

3. Interactive Shell

mcp> led_setup led1 17
mcp> led led1 on
mcp> type "Hello from MCP!"
mcp> pipeline_create automation
mcp> pipeline_run automation

4. Pipeline Automation

steps = [
    PipelineStep("setup", "gpio.setupLED", {"pin": 17}),
    PipelineStep("blink", "gpio.controlLED", {"action": "blink"}),
    PipelineStep("wait", "system.sleep", {"duration": 5})
]
pipeline = Pipeline("demo", steps)
await pipeline.execute(client)

๐Ÿ“ Project Structure

mcp-hardware/
โ”œโ”€โ”€ audio/                 # Audio-related scripts
โ”œโ”€โ”€ build/                 # Build-related files
โ”œโ”€โ”€ hardware/              # Hardware configuration scripts
โ”œโ”€โ”€ install/               # Installation scripts and utilities
โ”œโ”€โ”€ misc/                  # Miscellaneous utilities
โ”œโ”€โ”€ nlp/                   # Natural Language Processing scripts
โ”œโ”€โ”€ python/                # Python-related utilities
โ”œโ”€โ”€ rpi/                   # Raspberry Pi specific scripts
โ”œโ”€โ”€ service/               # Service setup scripts
โ”œโ”€โ”€ ssh/                   # SSH connection utilities
โ”œโ”€โ”€ test/                  # Testing utilities
โ”œโ”€โ”€ update/                # Update and upgrade scripts
โ”œโ”€โ”€ src/unitmcp/           # Main package
โ”‚   โ”œโ”€โ”€ client/                 # Client implementations
โ”‚   โ”œโ”€โ”€ server/                 # Hardware servers
โ”‚   โ”œโ”€โ”€ pipeline/               # Pipeline system
โ”‚   โ”œโ”€โ”€ protocols/              # MCP protocol
โ”‚   โ”œโ”€โ”€ security/               # Permission system
โ”‚   โ””โ”€โ”€ utils/                  # Utilities
โ”œโ”€โ”€ examples/                   # Usage examples
โ”‚   โ”œโ”€โ”€ Basic Controls          # LED, keyboard, mouse
โ”‚   โ”œโ”€โ”€ Automation              # Pipelines, scripts
โ”‚   โ”œโ”€โ”€ AI Integration          # Ollama, voice
โ”‚   โ””โ”€โ”€ Complete Systems        # Traffic light, security
โ””โ”€โ”€ tests/                      # Test suite

๐Ÿš€ Quick Start

Installation

git clone https://github.com/example/mcp-hardware.git
cd mcp-hardware
pip install -e .

Start Server

python examples/start_server.py

Run Examples

# Basic LED control
python examples/led_control.py

# Interactive shell
python -m unitmcp.client.shell

# Pipeline automation
python examples/pipeline_demo.py

AI Agent <-> MCP Client <-> MCP Servers <-> Hardware Drivers

๐Ÿ“š Example Applications

1. Traffic Light System

  • Simulates complete traffic light with LEDs
  • Pedestrian crossing functionality
  • Timing control and sequencing

2. Security System

  • Motion detection alerts
  • Camera surveillance
  • Multi-sensor integration
  • Automated responses

3. Voice Assistant

  • Natural language commands
  • Hardware control via speech
  • Voice feedback and confirmation

4. Automation Workflows

  • Automated testing sequences
  • Data entry automation
  • System monitoring and alerts

๐Ÿ”ง Supported Platforms

  • Raspberry Pi: Full GPIO and hardware support
  • Linux: Input automation, audio, camera
  • Windows: Keyboard/mouse control, audio
  • macOS: Input devices, limited hardware

๐Ÿ›ก๏ธ Security Features

  • Fine-grained permission system
  • Client authentication
  • Operation auditing
  • Secure protocol communication
  • Input validation and sanitization

๐Ÿ“ˆ Performance

  • Asynchronous architecture
  • Efficient protocol handling
  • Resource pooling
  • Optimized for real-time control

๐Ÿ”„ Integration Options

Python Applications

from unitmcp import MCPHardwareClient

async with MCPHardwareClient() as client:
    await client.control_led("led1", "on")

Shell Scripts

#!/bin/bash
echo "led_setup led1 17" | python -m unitmcp.client.shell
echo "led led1 on" | python -m unitmcp.client.shell

AI Agents

from unitmcp.examples.ollama_integration import OllamaHardwareAgent

agent = OllamaHardwareAgent()
await agent.process_command("Turn on the lights")

๐ŸŽฏ Use Cases

  1. Home Automation: Control lights, sensors, and devices
  2. Robotics: Motor control, sensor integration
  3. Testing Automation: UI testing, hardware validation
  4. Education: Learning hardware programming
  5. Prototyping: Rapid hardware development
  6. Accessibility: Voice-controlled systems

๐Ÿ”ฎ Future Enhancements

  • Web interface dashboard
  • Cloud integration
  • Mobile app control
  • More hardware support
  • Machine learning integration
  • Distributed systems support

๐Ÿ“ž Getting Help

  • Documentation: See README.md and examples
  • Issues: GitHub issue tracker
  • Community: Discussion forums
  • Support: support@example.com

๐Ÿ™ Acknowledgments

  • Anthropic MCP team for the protocol
  • Raspberry Pi Foundation for hardware libraries
  • Open source community for contributions

The MCP Hardware project provides a robust foundation for building hardware automation systems, AI-controlled devices, and interactive hardware applications. With its modular architecture and comprehensive examples, developers can quickly create sophisticated hardware control solutions.

project.svg

Project details


Download files

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

Source Distribution

unitmcp-0.1.46.tar.gz (1.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

unitmcp-0.1.46-py3-none-any.whl (216.3 kB view details)

Uploaded Python 3

File details

Details for the file unitmcp-0.1.46.tar.gz.

File metadata

  • Download URL: unitmcp-0.1.46.tar.gz
  • Upload date:
  • Size: 1.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for unitmcp-0.1.46.tar.gz
Algorithm Hash digest
SHA256 1886bc466540ba88976d486f8e9f30a9519215d0dead0297d758a858d41d69be
MD5 a57fa9353e1c1677ff790ba0ba0eaa66
BLAKE2b-256 2aafa98d24811d06031aa3403474659fa2c927bfb7969c7000d8ce89eaf27da3

See more details on using hashes here.

File details

Details for the file unitmcp-0.1.46-py3-none-any.whl.

File metadata

  • Download URL: unitmcp-0.1.46-py3-none-any.whl
  • Upload date:
  • Size: 216.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for unitmcp-0.1.46-py3-none-any.whl
Algorithm Hash digest
SHA256 1aef21481d2295cd482834fc3a4514917f632f7680c99b3d67a76003c5c68fa4
MD5 5b460c8fe7ad51177ff8e10605130cff
BLAKE2b-256 1b8b16022446c122f4ee58a1f5eeb8e785ef4b0260cdb39b4238eb68ad8be32e

See more details on using hashes here.

Supported by

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