YAML Configuration¶

Complete reference for YAML configuration files.

Basic Structure¶

title: "Diagram Title"
board: "raspberry_pi_5"  # or "raspberry_pi_zero_2w"
devices:
  - type: "device_type"
    name: "Device Name"
connections:
  - board_pin: 1
    device: "Device Name"
    device_pin: "Pin Name"
show_legend: true

Supported Boards¶

raspberry_pi_5 (aliases: rpi5, rpi) - Raspberry Pi 5 with 40-pin GPIO header
raspberry_pi_zero_2w (aliases: raspberry_pi_zero, pizero, zero2w, zero, rpizero) - Raspberry Pi Zero / Zero 2 W with 40-pin GPIO header

Built-in Device Types¶

PinViz includes several pre-configured device templates that you can use in your YAML files.

Sensors¶

bh1750 - BH1750 I2C ambient light sensor 📖 Datasheet

devices:
  - type: "bh1750"
    name: "BH1750"

ds18b20 - DS18B20 waterproof 1-Wire temperature sensor 📖 Datasheet

devices:
  - type: "ds18b20"
    name: "DS18B20"

LEDs¶

led - Simple LED with anode/cathode pins 📖 Raspberry Pi GPIO Documentation

devices:
  - type: "led"
    name: "Red LED"

ir_led_ring - IR LED ring module with control pin 📖 Product Page

devices:
  - type: "ir_led_ring"
    name: "IR LED Ring"

I/O¶

button - Push button or switch with pull-up/pull-down configuration 📖 Raspberry Pi GPIO Documentation

devices:
  - type: "button"
    name: "Button"

Generic¶

i2c_device - Generic I2C device with standard pinout 📖 Raspberry Pi I2C Documentation

devices:
  - type: "i2c_device"
    name: "My I2C Device"

spi_device - Generic SPI device with standard pinout 📖 Raspberry Pi SPI Documentation

devices:
  - type: "spi_device"
    name: "My SPI Device"

Listing Available Devices¶

To see all available device types with their documentation links, run:

pinviz list

Configuration Options¶

See the Quick Start Guide for detailed examples.

Full documentation coming soon.