2
0
mirror of https://github.com/inventree/inventree-website.git synced 2025-04-27 21:16:45 +00:00

Add section on configuration file

This commit is contained in:
Oliver Walters 2023-09-26 22:54:37 +10:00
parent 6f6ab2962a
commit af443c46c9

View File

@ -23,6 +23,26 @@ The same author who implemented the HTTP library support in KiCad has also relea
What does this mean? Simply put, it means that you can now use your InvenTree database as a native KiCad library, and pull your InvenTree data directly in to your KiCad schematic.
### Configuration File
Once the plugin is installed, a simple configuration file on the local computer is all that is required to connect to the InvenTree database. All that is required is the URL to the remote server (with the correct plugin extension) and an API token for authentication:
```
{
"meta": {
"version": 1.0
},
"name": "InvenTree",
"description": "InvenTree Library",
"source": {
"type": "REST_API",
"api_version": "v1",
"root_url": "http://my.inventree.server/plugin/kicad-library-plugin",
"token": "usertokendatastring"
}
}
```
### Categories as Libraries
InvenTree *categories* can be used as separate *libraries* in the KiCad application. The InvenTree plugin allows the user to select which part categories are exposed to KiCad.