> For the complete documentation index, see [llms.txt](https://docs.protoboard.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.protoboard.xyz/start-here/glossary.md). # Glossary Key terms used throughout Protoboard documentation. {% hint style="info" %} Terms are listed alphabetically. If you encounter a word in the docs that is not here, let us know. {% endhint %} *** ## Adapter A suggested component or configuration that bridges two parts that are close to compatible but not quite. For example, a voltage level shifter between a 3.3V sensor and a 5V controller. Protoboard suggests adapters automatically when it detects a near-match during validation. ## Annotation A text comment or note placed directly on the canvas. Use annotations to label sections of your design, leave reminders, or add context for teammates reviewing your board. ## Board The top-level document and workspace for a hardware system design. A board contains parts, harnesses, annotations, and all associated validation state. Think of it as your project file. ## BOM (Bill of Materials) A list of every part in your design along with cost estimates and supplier information. The BOM panel (cart icon in the left activity bar) lets you review, filter, and export this list as CSV or PDF. It is your order-ready checklist. ## Canvas The infinite 2D workspace where you assemble your design. The canvas features a dot grid, snap-to-grid alignment, a minimap for navigation, and zoom controls. Parts, harnesses, and annotations all live on the canvas. ## Compatibility Whether two parts can connect through a given interface. Compatibility requires the same interface intent, matching attributes (voltage, current, timing, physical fit), and a valid resource assignment. When intent matches but attributes do not, Protoboard suggests adapters. ## Domain A functional category that describes what kind of system a part or interface belongs to. Protoboard supports multiple domains: **electrical**, **mechanical**, **thermal**, **pneumatic**, **hydraulic**, and **network**. Parts and interfaces can span multiple domains. ## DRC (Design Rule Check) The automated validation engine that checks every connection on your board for compatibility and correctness. Run it from the Board Review panel (shield icon). The DRC inspects interface links, resource allocations, and cross-domain constraints, then reports issues by severity. ## DRC States The status assigned to each interface link after a DRC run: * **CONFIGURED** (green): All functions are mapped and compatible. Ready to ship. * **PARTIALLY\_CONFIGURED** (amber): Some functions are mapped but others still need attention. * **NOT\_CONFIGURED** (red): The interface link exists but no functions have been mapped. * **INCOMPATIBLE** (red): The two interfaces cannot connect. A different approach or an adapter is needed. ## Energy (Wh) The usage currency for AI operations in Protoboard. When you use ProtoBot, each action consumes energy. This is a themed credit unit for metering AI usage, not a literal measure of electrical power. ## Function An atomic signal or capability within an interface or resource. Examples include individual I2C signals (SCL, SDA), power rails (VCC, GND), or UART lines (TX, RX). Functions are the lowest level of connection detail in Protoboard. ## Function Link A wire-level connection between two functions, one from each side of an interface link. For example, the SCL function on an Arduino's I2C interface linked to the SCL function on a BME280's I2C interface. Function links live inside interface links. ## Harness A logical connection between two parts on the canvas. A harness carries one or more **interface links** and represents the physical wiring, cabling, or coupling between components. Create a harness by dragging from one part's connection handle to another part. ## Inspector The right sidebar panel that shows detailed properties of whatever is selected on the canvas. Select a part to see its interfaces, resources, and metadata. Select a harness to see its interface links and function mappings. The Inspector is where you configure and fine-tune connections. ## Interface A standardized connection method defined by a protocol type and role. Examples include I2C, UART, USB, SPI, power, and pneumatic coupling. Each interface declares what kind of connection it provides or requires, and Protoboard uses this to match compatible parts. ## Interface Link A pairing of two compatible interfaces, one from each part, within a harness. For example, an I2C interface on an Arduino paired with an I2C interface on a sensor. Each interface link contains one or more **function links** that map individual signals. ## Part / ProtoPart A component on your board that represents a physical hardware device. Every part in Protoboard is defined by a structured schema that describes its interfaces, resources, and attributes. Parts can come from the built-in library or be created from scratch. ## Parts Library / Parts Bin The searchable catalog of ProtoPart definitions available in Protoboard. Open it from the cuboid icon in the left activity bar. You can search by name, type, or interface, then drag parts directly onto the canvas. ## Board Identity Board-level metadata that captures your project's requirements, tasks, tags, and concept images. Access Board Identity from the left activity bar (notebook icon). It helps you organize what you are building before and during the design process. Previously called the **Plan** tab; renamed in v4.4 so the word "Plan" could be reserved for ProtoBot's Plan complexity mode (see [ProtoBot](/protobot/overview.md)). ## ProtoBot Protoboard's built-in AI assistant, available from the left activity bar. ProtoBot has over 100 specialized tools for searching parts, placing components, validating connections, organizing the board with groups and annotations, planning designs, generating BOMs, and more. It can automate repetitive tasks and help you resolve validation issues quickly. ## Resource A physical capability on a part, such as a pin, port, sensor channel, mounting hole, or any other connectable element. Resources are what interfaces bind to. During validation, Protoboard checks that resources are correctly allocated to the functions required by each interface link. ## Resource Allocation The intra-part mapping from a resource (like a specific GPIO pin) to an interface function (like the SCL line of I2C). Resource allocation is how Protoboard knows which physical pin or port on a part is being used for which signal. This can be done manually in the Inspector or automatically by ProtoBot. ## Severity The classification of a DRC issue. **Errors** are blocking; they must be resolved before your design can ship. **Warnings** are non-blocking; they flag things you should review but may choose to accept. Always resolve errors first. ## Template A project-local editable wrapper around a ProtoPart definition. Templates let you customize a library part for your specific use case without modifying the original definition. Changes to a template only affect the current board. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.protoboard.xyz/start-here/glossary.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.