project_add_part
Add an orderable part to a user project and link its documents from the central store; project sync then copies those files into the project folder and returns the part with its documents.
Instructions
Add a part to the user project, with the documents that the store links to it. Then project_sync copies the documents into the project folder. Gives the part and its documents.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mpn | Yes | The concrete orderable MPN that the design (the BOM) uses, with its package, voltage or grade, for example TLV75533PDBVR. A base part MPN only for a short time, when the BOM has no concrete one yet: the result then gives a note. | |
| base | No | The base part of the datasheet, for example TLV755P. The concrete part gets the documents of the base part. | |
| path | No | A folder of the user project (default: the working folder of the server). The project file datasheet-lens.toml is in it or in a parent folder. | |
| role | No | The role of the document: datasheet, manual, errata, appnote or other. | datasheet |
| category | No | The function of the part, for example ADC, LDO, MCU, flash, sensor. The layout of the project folder can use it as a folder name: use the values that the project has already (project_status). | |
| document | No | A document to link first: its reference from project_status, list_documents or add_document. The link is in the central store (to the base part, if base is given), and other projects with this part get the document too. | |
| manufacturer | No | The manufacturer. Use the spelling of list_parts (for example Texas Instruments, not TI when the store has it so): the layout of the project folder can use it as a folder name. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |