167 lines
6.4 KiB
Markdown
167 lines
6.4 KiB
Markdown
# KiCad User Library
|
||
|
||
Пользовательская библиотека KiCad: символы, футпринты, DB Library, рабочие
|
||
листы, шрифты и ссылки на внешние PDF/3D-ресурсы.
|
||
|
||
PDF-документация и 3D-модели хранятся вне этого репозитория. KiCad должен
|
||
получать к ним доступ через переменные путей, заданные в `Configure Paths`.
|
||
|
||
## Как проект KiCad
|
||
|
||
Репозиторий можно открывать напрямую как проект:
|
||
|
||
```text
|
||
Lib.kicad_pro
|
||
```
|
||
|
||
Этот проект нужен как оболочка для Project Manager и штатной Git-интеграции
|
||
KiCad: KiCad открывает `Lib.kicad_pro`, видит `.git` в корне репозитория и
|
||
может показывать изменения, stage/commit/push.
|
||
|
||
Проект не заменяет глобальную настройку библиотек и не задаёт библиотечные
|
||
пути. Символы, футпринты, DB Library, PDF и 3D-модели подключаются через
|
||
`Configure Paths` и глобальные таблицы KiCad.
|
||
|
||
Пустая схема или плата для этого не нужны: проект хранит только сам факт
|
||
проектной сущности, а библиотечные файлы остаются обычными файлами репозитория.
|
||
|
||
## Настройка
|
||
|
||
Склонируйте библиотеку в удобную папку и запустите настройку:
|
||
|
||
```bash
|
||
./scripts/setup_kicad_user_library.py --pdf-dir "<путь-к-папке-PDF>"
|
||
```
|
||
|
||
Если используется отдельная папка 3D-моделей:
|
||
|
||
```bash
|
||
./scripts/setup_kicad_user_library.py \
|
||
--pdf-dir "<путь-к-папке-PDF>" \
|
||
--3d-dir "<путь-к-папке-3D-моделей>"
|
||
```
|
||
|
||
Скрипт:
|
||
|
||
- прописывает переменные путей в `Configure Paths`;
|
||
- добавляет подключение DB Library;
|
||
- подключает таблицы символов и футпринтов из этого репозитория;
|
||
- проверяет и при необходимости предлагает установить PostgreSQL ODBC-драйвер
|
||
для DB Library (`psqlodbc` на Arch/CachyOS, `odbc-postgresql` на Ubuntu/Debian);
|
||
- создаёт резервные копии изменяемых файлов настроек KiCad.
|
||
|
||
Для полностью неинтерактивного запуска с установкой/регистрацией ODBC-драйвера:
|
||
|
||
```bash
|
||
./scripts/setup_kicad_user_library.py \
|
||
--pdf-dir "<путь-к-папке-PDF>" \
|
||
--non-interactive \
|
||
--install-odbc-driver \
|
||
--strict-odbc-check
|
||
```
|
||
|
||
## Переменные KiCad
|
||
|
||
| Переменная | Назначение |
|
||
| --- | --- |
|
||
| `KICAD_LIB_DIR_USER` | корень этого репозитория |
|
||
| `KICAD_PDF_DIR_USER` | папка с PDF-документацией компонентов |
|
||
| `KICAD_3D_PARTY_USER` | папка с пользовательскими 3D-моделями |
|
||
|
||
`KICAD_PDF_DIR_USER` должна совпадать по смыслу с настройкой сервера
|
||
eda-core `kicad.pdf_dir_var`: сервер передаёт KiCad путь Datasheet в виде
|
||
`${KICAD_PDF_DIR_USER}/имя_файла.pdf`.
|
||
|
||
## Подключения в KiCad
|
||
|
||
После настройки в менеджере библиотек должны быть такие записи.
|
||
|
||
### Symbol Libraries
|
||
|
||
| Имя | Путь | Тип |
|
||
| --- | --- | --- |
|
||
| `eda-core` | `${KICAD_LIB_DIR_USER}/eda-core.kicad_dbl` | `Database` |
|
||
| `sym-lib-table` | `${KICAD_LIB_DIR_USER}/sym-lib-table` | `Table` |
|
||
|
||
### Footprint Libraries
|
||
|
||
| Имя | Путь | Тип |
|
||
| --- | --- | --- |
|
||
| `fp-lib-table` | `${KICAD_LIB_DIR_USER}/fp-lib-table` | `Table` |
|
||
|
||
## Символы и футпринты
|
||
|
||
Таблицы из репозитория уже содержат подключения к библиотекам:
|
||
|
||
```text
|
||
${KICAD_LIB_DIR_USER}/Connectors/Ki-Connectors.kicad_sym
|
||
${KICAD_LIB_DIR_USER}/Resistors/Ki-Resistors.kicad_sym
|
||
${KICAD_LIB_DIR_USER}/Capacitors/Ki-Capacitors.kicad_sym
|
||
```
|
||
|
||
И аналогичные записи для остальных разделов библиотеки.
|
||
|
||
## 3D-модели
|
||
|
||
Футпринты должны ссылаться на 3D-модели через переменную
|
||
`KICAD_3D_PARTY_USER`.
|
||
|
||
Пример:
|
||
|
||
```text
|
||
${KICAD_3D_PARTY_USER}/Connectors/Molex-20pin-0039281203.stp
|
||
```
|
||
|
||
## PDF-документация
|
||
|
||
В базе компонента хранится только имя PDF-файла. Полный путь для KiCad
|
||
собирает сервер eda-core:
|
||
|
||
```text
|
||
${KICAD_PDF_DIR_USER}/имя_файла.pdf
|
||
```
|
||
|
||
## Плагин генератора разъёмов
|
||
|
||
В библиотеке есть KiCad-плагин для генерации однотипных символов разъёмов.
|
||
Установка:
|
||
|
||
```bash
|
||
./scripts/install_connector_generator_plugin.sh
|
||
```
|
||
|
||
Скрипт создаёт symlink из пользовательской папки плагинов KiCad на плагин
|
||
внутри этого репозитория. После установки перезапустите KiCad и откройте:
|
||
|
||
```text
|
||
PCB Editor -> Tools -> External Plugins -> Generate Connector Symbols
|
||
```
|
||
|
||
Плагин сам находит корень библиотеки рядом с собой и по умолчанию работает с:
|
||
|
||
```text
|
||
${KICAD_LIB_DIR_USER}/Connectors/Ki-Connectors.kicad_sym
|
||
```
|
||
|
||
## Рабочие листы и шрифты
|
||
|
||
Рабочий лист:
|
||
|
||
```text
|
||
${KICAD_LIB_DIR_USER}/gost_landscape.kicad_wks
|
||
```
|
||
|
||
Шрифты:
|
||
|
||
```text
|
||
${KICAD_LIB_DIR_USER}/Fonts
|
||
```
|
||
|
||
## Проверка
|
||
|
||
1. В `Configure Paths` заданы `KICAD_LIB_DIR_USER`, `KICAD_PDF_DIR_USER` и при необходимости `KICAD_3D_PARTY_USER`.
|
||
2. В Symbol Libraries видны `eda-core` и `sym-lib-table`.
|
||
3. В Footprint Libraries видна `fp-lib-table`.
|
||
4. Компоненты из DB Library добавляются на схему.
|
||
5. Datasheet открывается по пути `${KICAD_PDF_DIR_USER}/...`.
|
||
6. 3D-модели открываются по пути `${KICAD_3D_PARTY_USER}/...`.
|