designguard 0.1.0

KiCad schematic and PCB validation library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

# DesignGuard

[![Crates.io](https://img.shields.io/crates/v/designguard.svg)](https://crates.io/crates/designguard)
[![Documentation](https://docs.rs/designguard/badge.svg)](https://docs.rs/designguard)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

KiCad schematic and PCB validation library for Rust.

Catches common design mistakes before manufacturing:

- Missing decoupling capacitors
- Incorrect pull-up/pull-down resistors
- Trace width violations (IPC-2221)
- Component datasheet compliance
- Power integrity issues
- EMI/EMC concerns

## Installation

Add to your `Cargo.toml`:

```toml
[dependencies]
designguard = "0.1"
```

## Quick Start

```rust
use designguard::prelude::*;
use std::path::Path;

fn main() -> Result<(), DesignGuardError> {
    let options = ValidationOptions::default();

    let result = DesignGuardCore::validate_schematic(
        Path::new("design.kicad_sch"),
        options,
    )?;

    for issue in &result.issues {
        println!("{:?}: {}", issue.severity, issue.message);
    }

    if result.has_critical() {
        eprintln!("Critical issues found!");
        std::process::exit(1);
    }

    Ok(())
}
```

## Features

### Schematic validation

- **Decoupling capacitors**: 100nF bypass caps near IC power pins
- **I2C pull-ups**: 2.2k–10k on SDA/SCL nets
- **Crystal load caps**: 10–33pF paired capacitors
- **Power integrity**: GND symbols and IC power connections
- **ESD protection**: TVS diodes on USB/Ethernet
- **Datasheet checks**: Built-in component library (STM32, ESP32, RP2040, etc.)

### PCB validation

- **Trace width**: IPC-2221 current capacity
- **EMI checks**: Plane gaps, via placement, crosstalk
- **Custom rules**: JSON rule engine

## Examples

See the [`examples/`](examples/) directory:

- [`simple_validation.rs`](examples/simple_validation.rs) – basic usage
- [`custom_rules.rs`](examples/custom_rules.rs) – using `RulesEngine` with default rules

## CLI and GUI

- **CLI**: [`designguard-cli`](https://github.com/ltwmori/designGuardDesktopApp) (same repo, workspace member)
- **GUI**: [DesignGuard desktop app](https://design-guard-git-main-ltwmoris-projects.vercel.app/)

## Documentation

Full API: [docs.rs/designguard](https://docs.rs/designguard)

## License

MIT – see [LICENSE](../LICENSE) in the repository root.