mfcli 0.2.2__tar.gz → 0.2.4__tar.gz

{mfcli-0.2.2 → mfcli-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mfcli
-Version: 0.2.2
+Version: 0.2.4
 Summary: AI-powered CLI for analyzing hardware engineering documents
 Author: Multifactor AI
 License: MIT

mfcli-0.2.4/mfcli/__init__.py

@@ -0,0 +1,14 @@
+"""mfcli - AI-powered CLI for analyzing hardware engineering documents"""
+
+try:
+    from importlib.metadata import version, PackageNotFoundError
+    try:
+        __version__ = version("mfcli")
+    except PackageNotFoundError:
+        # Package is not installed, fallback to a default version
+        __version__ = "0.2.3"
+except ImportError:
+    # Python < 3.8
+    __version__ = "0.2.3"
+
+__all__ = ["__version__"]

mfcli-0.2.4/mfcli/alembic/versions/f1234567890a_make_bom_description_nullable.py

@@ -0,0 +1,36 @@
+"""Make BOM description field nullable
+
+Revision ID: f1234567890a
+Revises: e0f2b5765c72
+Create Date: 2026-01-18 18:54:00.000000
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = 'f1234567890a'
+down_revision: Union[str, Sequence[str], None] = 'e0f2b5765c72'
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    """Upgrade schema - make description nullable."""
+    # Make description field nullable
+    with op.batch_alter_table('bom', schema=None) as batch_op:
+        batch_op.alter_column('description',
+                              existing_type=sa.String(length=600),
+                              nullable=True)
+
+
+def downgrade() -> None:
+    """Downgrade schema - make description non-nullable."""
+    # Make description field non-nullable again
+    with op.batch_alter_table('bom', schema=None) as batch_op:
+        batch_op.alter_column('description',
+                              existing_type=sa.String(length=600),
+                              nullable=False)

{mfcli-0.2.2 → mfcli-0.2.4}/mfcli/cli/main.py

@@ -3,6 +3,7 @@ import argparse
 import os.path
 from pathlib import Path
 
+from mfcli import __version__
 from mfcli.cli.dependencies import check_dependencies
 from mfcli.crud.project import init_project, read_project_config_file
 from mfcli.models.project_metadata import ProjectConfig
@@ -76,6 +77,11 @@ def run_cli():
         prog=cli_prog_name,
         description=desc
     )
+    parser.add_argument(
+        "-v", "--version",
+        action="version",
+        version=f"%(prog)s {__version__}"
+    )
     sub = parser.add_subparsers(dest="command", required=True)
     init_cmd = sub.add_parser(
         "init",
@@ -107,6 +113,11 @@ def run_cli():
         action="store_true",
         help="Skip confirmation prompt"
     )
+    clean_cmd.add_argument(
+        "--all",
+        action="store_true",
+        help="Delete entire ChromaDB and SQLite database for a complete fresh start (instead of just current project)"
+    )
 
     add_cmd = sub.add_parser(
         "add",
@@ -175,7 +186,7 @@ def run_cli():
     if args.command == "init":
         init_project(args.name)
     elif args.command == "clean":
-        clean_app_data(args.accept)
+        clean_app_data(args.accept, args.all)
     else:
         project_config = read_project_config_file()
         if args.command == "run":

{mfcli-0.2.2 → mfcli-0.2.4}/mfcli/constants/file_types.py

@@ -11,6 +11,7 @@ class FileTypes(BaseEnum):
     NET = 3
     CIR = 4
     PDF = 5
+    SCH = 6
 
 
 class FileSubtypes(BaseEnum):
@@ -119,6 +120,15 @@ SupportedFileTypes = {
             "MCU_DATASHEET",
             "REFERENCE_MANUAL"
         }
+    },
+    "SCH": {
+        "mime_types": {
+            "text/plain",
+            "application/octet-stream"
+        },
+        "subtypes": {
+            "SCHEMATIC"
+        }
     }
 }
 

{mfcli-0.2.2 → mfcli-0.2.4}/mfcli/models/bom.py

@@ -14,7 +14,7 @@ class BOMSchema(BaseModel):
     reference: str = Field(..., description="Reference designators (C1, R3, U2, etc.)")
     value: str = Field(..., description="Electrical value or part name (10kΩ, MSPM0L1306)")
     quantity: int = Field(..., description="Quantity of identical components")
-    description: str = Field(..., description="General text describing component")
+    description: Optional[str] = Field(None, description="General text describing component")
 
     # Optional fields
     manufacturer: Optional[str] = Field(None, description="Manufacturer name")
@@ -47,7 +47,7 @@ class BOM(SQLModel, table=True):
     reference: str = Field(max_length=100, nullable=False)
     value: str = Field(max_length=255, nullable=False)
     quantity: int = Field(nullable=False)
-    description: str = Field(max_length=600, nullable=False)
+    description: Optional[str] = Field(default=None, max_length=600, nullable=True)
 
     # Optional fields
     manufacturer: Optional[str] = Field(default=None, max_length=255)

mfcli-0.2.4/mfcli/models/schematic_cheatsheet.py

@@ -0,0 +1,121 @@
+from typing import List, Dict, Optional
+
+from pydantic import BaseModel, Field
+
+
+class ClockSource(BaseModel):
+    """Clock source information."""
+    name: str = Field(..., description="Clock source name (e.g., 'HSE', 'LSE', 'PLL')")
+    frequency: str = Field("", description="Clock frequency (e.g., '16MHz', '32.768kHz')")
+    source_type: str = Field("", description="Type: crystal, oscillator, RC, external")
+    components: List[str] = Field(default_factory=list, description="Associated components (crystals, caps, etc.)")
+
+
+class MCUSummary(BaseModel):
+    """MCU configuration summary."""
+    mcu_part: str = Field("", description="MCU part number")
+    clock_sources: List[ClockSource] = Field(default_factory=list, description="Clock configuration")
+    reset_circuit: str = Field("", description="Reset circuit description (supervisor IC, RC, button, etc.)")
+    boot_configuration: str = Field("", description="Boot mode pins and configuration")
+    programming_interface: str = Field("", description="Programming interface description (SWD, JTAG, etc.)")
+    notes: str = Field("", description="Additional MCU configuration notes")
+
+
+class PinMapping(BaseModel):
+    """Single pin to net mapping."""
+    pin_number: str = Field(..., description="MCU pin number or name")
+    net_name: str = Field(..., description="Net name from schematic")
+    function: str = Field("", description="Pin function/purpose")
+    direction: str = Field("", description="Input/Output/Bidirectional")
+
+
+class PinMap(BaseModel):
+    """Pin mappings for meaningful/named nets only."""
+    pins: List[PinMapping] = Field(default_factory=list, description="List of pin to net mappings")
+    notes: str = Field("", description="Additional notes about pin assignments")
+
+
+class BusDevice(BaseModel):
+    """Device on a communication bus."""
+    device_name: str = Field(..., description="Device name or part number")
+    ref_des: str = Field(..., description="Reference designator")
+    address: str = Field("", description="Bus address (for I2C) or chip select (for SPI)")
+    irq_pin: str = Field("", description="Interrupt pin net name")
+    reset_pin: str = Field("", description="Reset pin net name")
+    enable_pin: str = Field("", description="Enable/chip enable pin net name")
+    other_signals: Dict[str, str] = Field(default_factory=dict, description="Other control signals")
+
+
+class BusDefinition(BaseModel):
+    """Communication bus definition."""
+    bus_type: str = Field(..., description="Bus type: I2C, SPI, UART, CAN, etc.")
+    bus_name: str = Field("", description="Bus instance name (e.g., 'I2C1', 'SPI2')")
+    signal_nets: Dict[str, str] = Field(default_factory=dict, description="Signal to net mapping (e.g., {'SCL': 'I2C_SCL', 'SDA': 'I2C_SDA'})")
+    devices: List[BusDevice] = Field(default_factory=list, description="Devices connected to this bus")
+    notes: str = Field("", description="Additional bus notes")
+
+
+class BusMap(BaseModel):
+    """Map of all communication buses."""
+    buses: List[BusDefinition] = Field(default_factory=list, description="List of communication buses")
+
+
+class Peripheral(BaseModel):
+    """External peripheral/component requiring driver."""
+    name: str = Field(..., description="Peripheral name/description")
+    part_number: str = Field("", description="Part number")
+    ref_des: str = Field("", description="Reference designator")
+    interface: str = Field("", description="Interface type (I2C, SPI, GPIO, etc.)")
+    driver_target: str = Field("", description="Suggested driver or library")
+    notes: str = Field("", description="Integration notes")
+
+
+class PeripheralList(BaseModel):
+    """List of peripherals requiring drivers."""
+    peripherals: List[Peripheral] = Field(default_factory=list, description="List of peripherals")
+
+
+class VoltageRail(BaseModel):
+    """Power rail information."""
+    rail_name: str = Field(..., description="Rail name (e.g., '3V3', 'VBAT', '1V8')")
+    voltage: str = Field(..., description="Nominal voltage")
+    source: str = Field("", description="Power source (LDO, buck converter, external, etc.)")
+    enable_signal: str = Field("", description="Enable signal net name")
+    power_good_signal: str = Field("", description="Power good/status signal")
+    loads: List[str] = Field(default_factory=list, description="Major loads on this rail")
+
+
+class PowerSequencing(BaseModel):
+    """Power and sequencing information."""
+    voltage_rails: List[VoltageRail] = Field(default_factory=list, description="Voltage rails")
+    sequencing_requirements: str = Field("", description="Power-up/down sequencing requirements")
+    notes: str = Field("", description="Additional power notes")
+
+
+class ConstraintsGotchas(BaseModel):
+    """Design constraints and gotchas."""
+    constraints: List[str] = Field(default_factory=list, description="Design constraints")
+    gotchas: List[str] = Field(default_factory=list, description="Gotchas, errata references, workarounds")
+    recommendations: List[str] = Field(default_factory=list, description="Design recommendations")
+
+
+class ConnectorPin(BaseModel):
+    """Single connector pin."""
+    pin_number: str = Field(..., description="Pin number on connector")
+    net_name: str = Field(..., description="Net name")
+    signal_name: str = Field("", description="Signal name/function")
+    direction: str = Field("", description="Signal direction")
+    notes: str = Field("", description="Pin notes")
+
+
+class ConnectorPinout(BaseModel):
+    """Connector pinout table."""
+    ref_des: str = Field(..., description="Connector reference designator")
+    connector_type: str = Field("", description="Connector type/part number")
+    description: str = Field("", description="Connector purpose")
+    pins: List[ConnectorPin] = Field(default_factory=list, description="Pin definitions")
+
+
+class ConnectorPinouts(BaseModel):
+    """All connector pinouts."""
+    connectors: List[ConnectorPinout] = Field(default_factory=list, description="List of connectors")

{mfcli-0.2.2 → mfcli-0.2.4}/mfcli/pipeline/analysis/generators/generator.py

@@ -19,6 +19,7 @@ from mfcli.pipeline.analysis.generators.functional_blocks.functional_blocks impo
 from mfcli.pipeline.analysis.generators.generator_base import GeneratorBase
 from mfcli.pipeline.analysis.generators.mcu.mcu import MCUCheatSheetGenerator
 from mfcli.pipeline.analysis.generators.mcu_errata.mcu_errata import ErrataCheatSheetGenerator
+from mfcli.pipeline.analysis.generators.schematic.schematic import SchematicCheatSheetGenerator
 from mfcli.pipeline.analysis.generators.summary.summary import SummaryCheatSheetGenerator
 from mfcli.pipeline.run_context import PipelineRunContext
 from mfcli.utils.directory_manager import app_dirs
@@ -29,7 +30,7 @@ logger = get_logger(__name__)
 FileSubtypeGeneratorMap: Dict[FileSubtypes, List[Type[GeneratorBase]]] = {
     FileSubtypes.ERRATA: [ErrataCheatSheetGenerator],
     FileSubtypes.MCU_DATASHEET: [MCUCheatSheetGenerator],
-    FileSubtypes.SCHEMATIC: [DSCheatSheetGenerator],
+    FileSubtypes.SCHEMATIC: [DSCheatSheetGenerator, SchematicCheatSheetGenerator],
     FileSubtypes.USER_GUIDE: [SummaryCheatSheetGenerator],
     FileSubtypes.REFERENCE_MANUAL: [SummaryCheatSheetGenerator]
 }
@@ -39,6 +40,7 @@ GeneratorNameMap: Dict[Any, str] = {
     ErrataCheatSheetGenerator: "mcu_errata",
     MCUCheatSheetGenerator: "mcu",
     DSCheatSheetGenerator: "debug_setup",
+    SchematicCheatSheetGenerator: "schematic",
     FBCheatSheetGenerator: "functional_blocks",
     SummaryCheatSheetGenerator: "summary"
 }

mfcli-0.2.4/mfcli/pipeline/analysis/generators/schematic/__init__.py

@@ -0,0 +1 @@
+# Schematic cheat sheet generator

mfcli-0.2.4/mfcli/pipeline/analysis/generators/schematic/instructions.py

@@ -0,0 +1,257 @@
+sch_system_instructions = (
+    """
+    You are the Schematic Cheat Sheet Generator agent. Your role is to analyze hardware schematics
+    to extract comprehensive design information for firmware developers and hardware engineers.
+    
+    Your goal is to provide:
+    - MCU configuration overview (clocking, reset, boot, programming)
+    - Pin mappings for meaningful/named nets
+    - Communication bus topology and device connections
+    - Peripheral list for driver development
+    - Power architecture and sequencing
+    - Design constraints and gotchas
+    - Connector pinout tables
+    
+    Focus on information relevant to firmware development and system bring-up.
+    Extract actual net names and reference designators from the schematic.
+    """
+)
+
+sch_mcu_summary_instructions = (
+    """
+    Extract MCU configuration information from the schematic:
+    
+    MCU SUMMARY:
+    - mcu_part: Identify the MCU part number from the schematic
+    - clock_sources: List all clock sources with details:
+      * name: Clock name (HSE, LSE, PLL, internal oscillator, etc.)
+      * frequency: Clock frequency if shown
+      * source_type: crystal, ceramic resonator, oscillator module, RC, external clock
+      * components: Associated components (Y1, C1, C2, etc.)
+    - reset_circuit: Describe the reset circuit:
+      * Reset supervisor IC (part number and ref des)
+      * RC reset network
+      * External reset button
+      * Brown-out detection
+    - boot_configuration: Boot mode configuration:
+      * Boot pins and their connections (BOOT0, BOOT1, etc.)
+      * Boot mode selection (flash, bootloader, etc.)
+    - programming_interface: Programming interface details:
+      * Interface type (SWD, JTAG, UART bootloader, etc.)
+      * Connector reference and pins
+    - notes: Any additional MCU configuration notes
+    
+    Be specific with reference designators and net names.
+    """
+)
+
+sch_pin_map_instructions = (
+    """
+    Extract pin mappings for MEANINGFUL/NAMED nets only from the schematic:
+    
+    PIN MAP (exclude generic power/ground):
+    - pins: List of pin mappings with:
+      * pin_number: MCU pin number or name (PA0, PB5, etc.)
+      * net_name: Net name from schematic
+      * function: Pin function/purpose
+      * direction: Input, Output, Bidirectional, Analog
+    - notes: Additional notes about pin assignments
+    
+    EXCLUDE:
+    - Generic power nets (VDD, VSS, GND, 3V3, etc.) unless they're special (VBAT, VDDA, etc.)
+    - Decoupling capacitor connections
+    - Generic ground connections
+    
+    INCLUDE:
+    - GPIO with specific functions (LED_STATUS, BUTTON_USER, etc.)
+    - Communication bus pins (I2C_SCL, SPI_MOSI, UART_TX, etc.)
+    - ADC inputs with meaningful names
+    - Control signals (ENABLE, RESET, IRQ, etc.)
+    - Special power pins (VBAT, VDDA, VREF, etc.)
+    
+    Focus on nets that firmware developers need to know about.
+    """
+)
+
+sch_bus_map_instructions = (
+    """
+    Extract communication bus information from the schematic:
+    
+    BUS MAP:
+    For each communication bus (I2C, SPI, UART, CAN, etc.), extract:
+    
+    - bus_type: I2C, SPI, UART, CAN, USB, etc.
+    - bus_name: Instance name (I2C1, SPI2, UART3, etc.)
+    - signal_nets: Map signal names to net names
+      * I2C: SCL, SDA
+      * SPI: MOSI, MISO, SCK, (CS for each device)
+      * UART: TX, RX, (CTS, RTS if used)
+      * CAN: CANH, CANL
+    - devices: List all devices connected to this bus:
+      * device_name: Device description (e.g., "Temperature Sensor", "EEPROM")
+      * ref_des: Reference designator (U5, U8, etc.)
+      * address: I2C address or SPI chip select net
+      * irq_pin: Interrupt pin net name if connected
+      * reset_pin: Reset pin net name if connected
+      * enable_pin: Enable/power-down pin net name if connected
+      * other_signals: Other control signals (ALERT, DRDY, etc.)
+    - notes: Additional bus information
+    
+    Identify devices by looking for:
+    - ICs connected to bus lines
+    - Pull-up resistors on I2C lines
+    - Chip select signals for SPI devices
+    - Communication transceivers
+    
+    Be thorough - include all devices on each bus.
+    """
+)
+
+sch_peripheral_list_instructions = (
+    """
+    Extract list of peripherals that require firmware drivers:
+    
+    PERIPHERAL LIST (driver targets):
+    For each peripheral/sensor/module, extract:
+    
+    - name: Peripheral description (e.g., "IMU Sensor", "OLED Display", "LoRa Module")
+    - part_number: IC part number if visible
+    - ref_des: Reference designator
+    - interface: Communication interface (I2C, SPI, UART, GPIO, Analog, etc.)
+    - driver_target: Suggested driver library or development approach
+    - notes: Integration notes, special considerations
+    
+    INCLUDE:
+    - Sensors (temperature, pressure, IMU, accelerometer, etc.)
+    - Displays (LCD, OLED, e-paper, etc.)
+    - Communication modules (WiFi, Bluetooth, LoRa, cellular, etc.)
+    - Memory devices (EEPROM, Flash, FRAM, etc.)
+    - Motor drivers and actuators
+    - RTC chips
+    - Power management ICs with I2C/SPI control
+    - ADCs, DACs
+    - GPIO expanders
+    - Any IC that requires firmware interaction
+    
+    EXCLUDE:
+    - Passive components (resistors, capacitors, inductors)
+    - Simple power regulators without control interface
+    - Connectors (these go in connector section)
+    - The MCU itself
+    
+    Focus on components that firmware developers will need to write drivers for.
+    """
+)
+
+sch_power_sequencing_instructions = (
+    """
+    Extract power architecture and sequencing information:
+    
+    POWER & SEQUENCING:
+    
+    voltage_rails: List all voltage rails:
+    - rail_name: Rail net name (3V3, 1V8, VBAT, VCCA, etc.)
+    - voltage: Nominal voltage
+    - source: Where it comes from:
+      * Input (battery, USB, external supply)
+      * LDO regulator (part number and ref des)
+      * Switching regulator (buck, boost, buck-boost)
+      * Charge pump
+    - enable_signal: Enable control net name if present
+    - power_good_signal: Power good/status net name if present
+    - loads: Major loads powered by this rail (MCU, sensors, display, etc.)
+    
+    sequencing_requirements: Describe power-up/down sequencing:
+    - Order of rail activation
+    - Delays required between rails
+    - Dependencies (e.g., "VCCA must be up before 3V3")
+    - Sequencing control (IC part number if using sequencer)
+    
+    notes: Additional power notes:
+    - Load switches and their control
+    - Power path management
+    - Battery charging
+    - Low power modes
+    - Brownout protection
+    
+    Analyze:
+    - Power regulators (LDOs, switching regulators)
+    - Load switches and enable signals
+    - Power monitoring/sequencing ICs
+    - Power good signals
+    - Enable control logic
+    """
+)
+
+sch_constraints_gotchas_instructions = (
+    """
+    Identify design constraints, gotchas, and recommendations:
+    
+    CONSTRAINTS / GOTCHAS:
+    
+    constraints: List design constraints:
+    - Pin limitations (e.g., "PA9/PA10 used for USB, cannot use for UART1")
+    - Resource conflicts (e.g., "Timer 2 used for PWM, unavailable for other functions")
+    - Hardware limitations (e.g., "Only 2 hardware I2C peripherals available")
+    - Voltage level constraints
+    - Current limitations
+    - Timing constraints
+    - External component requirements
+    
+    gotchas: List potential issues and workarounds:
+    - Errata references (e.g., "MCU errata: I2C clock stretching issue, use software I2C")
+    - Design quirks (e.g., "BOOT0 must be low at startup or device enters bootloader")
+    - Pin conflicts or shared resources
+    - Required pull-ups/pull-downs
+    - Signal integrity concerns
+    - Known bugs or workarounds
+    
+    recommendations: Design recommendations:
+    - Best practices for this design
+    - Suggested initialization order
+    - Debugging tips
+    - Optimization opportunities
+    - Future design improvements
+    
+    Look for:
+    - Comments or notes on schematic
+    - Unusual circuit topologies
+    - Shared pins (alternate functions)
+    - Critical timing or ordering requirements
+    - Reference to MCU errata documents
+    """
+)
+
+sch_connector_pinouts_instructions = (
+    """
+    Extract connector pinout information:
+    
+    CONNECTOR PINOUTS:
+    For each connector on the schematic, create a pinout table:
+    
+    - ref_des: Connector reference designator (J1, P2, CN3, etc.)
+    - connector_type: Connector type/part number
+      * Examples: "USB-C", "2.54mm header 10-pin", "JST-XH 4-pin", etc.
+    - description: Connector purpose
+      * Examples: "Debug connector", "External sensor interface", "Power input"
+    - pins: List of all pins with:
+      * pin_number: Pin number on connector
+      * net_name: Net name connected to this pin
+      * signal_name: Signal function/name
+      * direction: Input/Output/Power/Ground/Bidirectional
+      * notes: Pin-specific notes
+    
+    Include ALL connectors:
+    - Debug/programming connectors
+    - External sensor/module connectors
+    - Power input connectors
+    - Communication connectors (USB, Ethernet, etc.)
+    - Button/switch connectors
+    - Display connectors
+    - Expansion headers
+    - Test points (if grouped as connectors)
+    
+    For each pin, provide complete information.
+    Maintain pin order as shown in schematic.
+    """
+)