registry-search

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Registry Search

注册表搜索

Find prepared registry content before designing a circuit or choosing a new part by hand.
Use this when working on a board, subsystem, or spec and you need a reusable schematic module, reference design, primitive component package, concrete MPN, symbol, footprint, datasheet, or sourcing signal.
在手动设计电路或选择新部件之前,先查找预制的注册表内容。
当您在设计电路板、子系统或规格,且需要可复用的原理图模块、参考设计、基础元件包、具体MPN、符号、footprint、datasheet或货源信息时,可使用此功能。

Search Modes

搜索模式

  • registry:modules
    — reusable Zener packages and
    .zen
    entrypoints. This is the primary search mode for schematic reuse.
  • registry:components
    — registry symbols/parts with MPN, manufacturer, footprint, datasheet, availability, and
    moduleUrl
    . Use this for concrete part discovery and to find the package behind a symbol.
Do not create, import, or patch component packages in this workflow. If the registry does not contain a suitable result, or the closest result needs even a small package/API/circuit tweak, produce a librarian request.
  • registry:modules
    — 可复用的Zener包和
    .zen
    入口文件。这是原理图复用的主要搜索模式。
  • registry:components
    — 包含MPN、制造商、footprint、datasheet、供货情况和
    moduleUrl
    的注册表符号/部件。用于查找具体部件以及符号对应的包。
在此工作流中,请勿创建、导入或修补元件包。如果注册表中没有合适的结果,或最接近的结果需要对包/API/电路进行细微调整,请提交库管员请求。

Search Workflow

搜索工作流

Start with reusable schematic content:
bash
pcb search -m registry:modules <query> -f json
Use functional queries when the board need is functional:
"usb c source"
,
"3.3v ldo"
,
"128mb spi flash"
,
"automotive high side switch"
.
Search symbols/parts when you need a concrete MPN, footprint, availability, or the package behind a primitive:
bash
pcb search -m registry:components <query> -f json
Use MPN/manufacturer queries when the user named a part:
TPS70933
,
Texas Instruments TPSM336
,
USB4105
.
Then inspect the candidate API before instantiating it:
bash
pcb doc --package <module-url>@<version>
If docs are incomplete or fail, read the package source from the dependency cache, registry checkout, or sandbox checkout instead of guessing the IO/config interface.
从可复用的原理图内容开始:
bash
pcb search -m registry:modules <query> -f json
当电路板需求为功能性需求时,使用功能性查询:
"usb c source"
,
"3.3v ldo"
,
"128mb spi flash"
,
"automotive high side switch"
当您需要具体MPN、footprint、供货情况或基础部件对应的包时,搜索符号/部件:
bash
pcb search -m registry:components <query> -f json
当用户指定部件时,使用MPN/制造商查询:
TPS70933
,
Texas Instruments TPSM336
,
USB4105
然后在实例化之前检查候选API:
bash
pcb doc --package <module-url>@<version>
如果文档不完整或无法打开,请从依赖缓存、注册表检出或沙箱检出中读取包源代码,而非猜测IO/配置接口。

Choosing Results

结果选择

Prefer the most reusable correct abstraction:
  1. A higher-level module or reference design that already implements the needed schematic circuit.
  2. A component package with included support circuitry when that is exactly the intended use.
  3. A primitive component package when the board genuinely needs only the raw part.
Use
registry:components
results to compare physical package, pinout, MPN, stock, price, datasheet, and
moduleUrl
. Use
registry:modules
results to compare entrypoints, dependencies, dependents, and package descriptions.
Ask only when tradeoffs are real: package size, cost, stock, electrical margin, automotive/industrial grade, interface differences, or user-visible feature choices.
优先选择最具复用性的正确抽象:
  1. 已实现所需原理图电路的更高层级模块或参考设计。
  2. 包含配套支持电路的元件包(当这完全符合预期用途时)。
  3. 当电路板确实只需要原始部件时,选择基础元件包。
使用
registry:components
结果比较物理封装、引脚排列、MPN、库存、价格、datasheet和
moduleUrl
。使用
registry:modules
结果比较入口文件、依赖项、依赖它的项目以及包描述。
仅在存在实际权衡时才询问:包尺寸、成本、库存、电气余量、汽车/工业等级、接口差异或用户可见的功能选择。

Using Results In A Board

在电路板中使用结果

Instantiate the
.zen
entrypoint from the chosen
registry:modules
result directly in the consuming
.zen
file.
python
PartModule = Module("github.com/diodeinc/registry/components/<Manufacturer>/<NAME>/<NAME>.zen")
Do not manually edit
pcb.toml
to add the dependency. On the next
pcb build
, the tool will detect the registry import and add the dependency to the package manifest automatically.
Use
pcb doc --package
or source inspection for exact IO and configs. Do not infer pin names from search snippets.
After adding the package to a board or module, verify the consuming design:
bash
pcb build <board-or-module-path>
pcb bom <board-or-module-path> -f json
从选定的
registry:modules
结果中直接将
.zen
入口文件实例化到消费端的
.zen
文件中。
python
PartModule = Module("github.com/diodeinc/registry/components/<Manufacturer>/<NAME>/<NAME>.zen")
请勿手动编辑
pcb.toml
来添加依赖。在下一次执行
pcb build
时,工具将检测到注册表导入并自动将依赖项添加到包清单中。
使用
pcb doc --package
或源代码检查来获取准确的IO和配置信息。请勿从搜索片段中推断引脚名称。
将包添加到电路板或模块后,验证消费端设计:
bash
pcb build <board-or-module-path>
pcb bom <board-or-module-path> -f json

Librarian Requests

库管员请求

When no suitable registry content exists, or a close match needs to be changed before it is safe to use, stop the registry search workflow and prepare a librarian request instead of authoring or patching the package inline.
A good request includes:
  • board/subsystem context and why the package is needed
  • required function and fundamental schematic topology, if known
  • electrical requirements: rails, current, speed, accuracy, protection, temperature, qualification
  • physical constraints: package/footprint, height, connector style, pinout constraints, assembly limits
  • preferred or user-specified MPNs, manufacturers, and acceptable alternates
  • sourcing constraints: region, stock, lifecycle, target cost, approved distributors
  • searches tried, candidates rejected, and why they failed
  • close registry matches that need tweaks, with the exact missing API, circuit, symbol, footprint, sourcing, or documentation change
  • needed deliverable: primitive component, reference-design module, connector module, family selector, or patch to an existing package
Keep the board moving with a placeholder only if the user accepts the risk and the unresolved librarian request is recorded in the spec or TODOs.
当没有合适的注册表内容,或需要修改某个接近匹配的内容才能安全使用时,请停止注册表搜索工作流,提交库管员请求,而非在线编写或修补包。
一份优质请求应包含:
  • 电路板/子系统背景以及需要该包的原因
  • 所需功能和基本原理图拓扑(如果已知)
  • 电气要求:电源轨、电流、速度、精度、保护、温度、认证
  • 物理约束:footprint、高度、连接器类型、引脚排列约束、装配限制
  • 首选或用户指定的MPN、制造商以及可接受的替代方案
  • 货源约束:地区、库存、生命周期、目标成本、认可的分销商
  • 已尝试的搜索、被拒绝的候选以及拒绝原因
  • 需要调整的接近匹配的注册表内容,以及具体缺失的API、电路、符号、footprint、货源或文档变更
  • 所需交付物:基础元件、参考设计模块、连接器模块、系列选择器或对现有包的补丁
仅当用户接受风险且未解决的库管员请求已记录在规格或待办事项中时,才使用占位符继续电路板设计。