KiCadのプロジェクト名を変えるスクリプトを作ってみた

背景

KiCadとは、プリント基板を設計できるCADソフトです。
既にあるプロジェクトの回路を利用して新しいプロジェクトを作りたい時があるのですが、KiCadには「プロジェクト名を変更して保存」する機能が見当たらないので、既存回路の利用は簡単にはできません。

しかし、「ファイル名」と「各ファイルに含まれている文字列」に含まれる「プロジェクト名」を「新しいプロジェクト名」に変更すれば、プロジェクト名を変更できます。

上記のプロジェクト名の変更を手作業で行う方法と、自分が作ったスクリプトで行う方法（無保証）を共有します。

使ったもの

bashが動くPC

Ubuntu18.04で動作確認しました。
確認してはいませんが、Macでも多分動くと思います。
自分が作ったスクリプトのWindows版（batファイル）を書いてくれる方が居れば、共有してもらえるととても嬉しいです。

KiCad5で作ったプロジェクト

この記事ではtest_projectというプロジェクトからsample_pcbというプロジェクトを作る方法を例にして、スクリプトの使い方を紹介します。

git

バージョン管理プログラムです。
自分が作ったスクリプトをPCへダウンロードするのに利用します。

Ubuntuの場合は下記のコマンドでインストールできます。

sudo apt install git

Macの場合は、デフォルトでインストールされていると思います。

スクリプトをダウンロード

この記事では ~/gitproject ディレクトリを作り、その中にスクリプトを含むプロジェクトをダウンロードして、その中のスクリプトを利用します。
ディレクトリの作成とプログラムのダウンロードは、下記のようなコマンドでできます。

mkdir -p ~/gitprojects
cd ~/gitprojects
git clone https://github.com/asukiaaa/useful-scripts.git

スクリプトに関する注意

プロジェクト名が回路やフッチプリントの部品名や、KiCadのファイル内で使われている文字列と一致する場合、置き換えては行けない文字も置き換えてしまい、部品の割り当てが壊れたり、プロジェクトが壊れるて開けなくなる可能性があります。
上記の可能性を低くするために、部品名やシステムの変数などと被らないようなプロジェクト名を使い、このスクリプトを実行してください。

紹介するスクリプトはファイルを書き換えるので、実行する前に対象となるディレクトリをコピーしておくなど、バックアップをとってください。

KiCadのプロジェクトをコピーしつつ、名前を変更

スクリプトダウンロードしたら、変更したいプロジェクトのディレクトリの中でスクリプトを実行することで、プロジェクト名を変更できます。
例として~/kicad_projects にあるtest_projectというプロジェクトをコピーしつつsample_pcbという名前のプロジェクトを作ってみます。

まず、元のプロジェクトを新しいプロジェクト名のディレクトリとしてコピーします

cd [変更したいプロジェクトのディレクトリがあるディレクトリ]cp -r [変更したいプロジェクトのディレクトリ] [新しいプロジェクト名]

具体例に割り当てるとこうです。

cd ~/kicad_projects
cp -r test_project sample_pcb

 注意: 先ほども言及しましたが、このスクリプトはファイルを書き換えるので、実行する場所を間違えるとファイルを破壊して困る場合があります。 上記のコマンドのようにディレクトリごとコピーするなどのバックアップをしてから実行してください。

プロジェクトのディレクトリをコピーしたら、コピーして出来たディレクトリの中にあるファイルやファイル内の文字列をスクリプトで書き換えます。

cd [新しいプロジェクト名のディレクトリ]
~/gitprojects/useful-scripts/kicad/rename-project.sh [新しいプロジェクト名]

 具体例に割り当てるとこうです。

cd ~/kicad_projects/sample_pcb
~/gitprojects/useful-scripts/kicad/rename-project.sh sample_pcb

KiCadで確認してみます。

test_projectの内容をコピーして名前を変更したsample_pcbというプロジェクトができました。

まとめ

KiCadのプロジェクト名を変更できました。

何かの参考になれば嬉しいです。

更新履歴

 2019.03.29
プロジェクト名が「test-project」と「sample-pcb」になっていた部分があったので、「test_project」と「sample_pcb」に修正しました。