# 1. Summary The Bill of Materials tool creates a BOM which lists all of the components in the design. The tool uses an external script to generate a BOM in the desired output format. Choosing a different script changes how the BOM is formatted. Generating a BOM is described in more detail in the Schematic Editor manual. # 2. Usage Select a generator script in the **BOM generator scripts** list. Details for the selected generator are shown on the right of the dialog. Clicking the **Generate** button creates a BOM file with the selected generator. The default settings present several generator script options, although some additional scripts are installed with KiCad and can be added to the list with the **+** button. **Note:** On Windows, there is an additional option **Show console window**. When this option is unchecked, BOM generators run in a hidden console window and any output is redirected and printed in the dialog. When this option is checked, BOM generators run in a visisble console window. # 3. Custom generators and command lines Internally, KiCad creates an intermediate netlist file in XML format that contains information about all of the components in the design. A BOM generator script converts the intermediate netlist file to the desired output format. KiCad runs the BOM generator scripts according to the command line entered at the bottom of the BOM dialog. The command line format accepts parameters for filenames. Each formatting parameter is replaced with a project-specific path or filename. The supported formatting parameters are: * `%I`: absolute path and filename of the intermediate netlist file, which is the input to the BOM generator * `%O`: absolute path and filename of the output BOM file (without file extension) * `%B`: base filename of the output BOM file (without file extension) * `%P`: absolute path of the project directory, without trailing slash **Note:** the `%O` output file parameter does not include a file extension. KiCad will attempt to add an appropriate extension to the command line automatically, but an extension may need to be added by hand. Python is the recommended tool for BOM generator scripts, but other tools can also be used. ## Example command lines for Python scripts The command line format for a Python script is of the form: ``` python <script file name> <input filename> <output filename> ``` On Windows, if the desired generator script for a CSV BOM is `C:\Users\username\kicad\my_python_script.py`, the command line would be: ``` python.exe C:\Users\username\kicad\my_python_script.py "%I" "%O.csv" ``` On Linux, if the desired generator script for a CSV BOM is `/home/username/kicad/my_python_script.py`, the command line would be: ``` python /home/username/kicad/my_python_script.py "%I" "%O.csv" ``` Double quotes (`"`) around the arguments are recommended in case filenames contain spaces or special characters.
Malzeme Listesi aracı, tasarımdaki tüm bileşenleri listeleyen bir ürün reçetesi oluşturur. Araç, istenen çıktı biçiminde bir ürün reçetesi oluşturmak için harici bir komut dosyası kullanır. Farklı bir komut dosyası seçmek, Ürün reçetesinin nasıl biçimlendirileceğini değiştirir. Bir Ürün Reçetesi oluşturmak, Şematik Düzenleyici kılavuzunda daha ayrıntılı olarak açıklanmıştır. # 2. Kullanım **MALZEME Listesi oluşturucu komut dosyaları** listesinden bir oluşturucu komut dosyası seçin. Seçilen jeneratör için ayrıntılar iletişim kutusunun sağında gösterilir. ** Üret ** düğmesine tıklamak, seçilen üreteci içeren bir ürün reçetesi dosyası oluşturur. Varsayılan ayarlar birkaç jeneratör komut dosyası seçeneği sunar, ancak bazı ek komut dosyaları KiCad ile yüklenir ve listeye **+** düğmesiyle eklenebilir. ** Not: ** Windows'ta ek bir seçenek vardır ** Konsol penceresini göster **. Bu seçenek işaretlenmediğinde, ürün reçetesi oluşturucuları gizli bir konsol penceresinde çalışır ve tüm çıktılar yeniden yönlendirilir ve iletişim kutusuna yazdırılır. Bu seçenek işaretlendiğinde, ÜRÜN reçetesi oluşturucuları görünür bir konsol penceresinde çalışır. # 3. Özel jeneratörler ve komut satırları Dahili olarak KiCad, tasarımdaki tüm bileşenler hakkında bilgi içeren XML biçiminde bir ara netlist dosyası oluşturur. Ürün reçetesi oluşturucu komut dosyası, ara netlist dosyasını istenen çıktı biçimine dönüştürür. KiCad, ÜRÜN reçetesi oluşturucu komut dosyalarını ÜRÜN REÇETESİ iletişim kutusunun altına girilen komut satırına göre çalıştırır. Komut satırı biçimi, dosya adları için parametreleri kabul eder. Her biçimlendirme parametresi, projeye özgü bir yol veya dosya adıyla değiştirilir. Desteklenen biçimlendirme parametreleri şunlardır: * '%İ': Ürün reçetesi oluşturucunun girdisi olan ara netlist dosyasının mutlak yolu ve dosya adı * '%O': çıktı MALZEME listesi dosyasının mutlak yolu ve dosya adı (dosya uzantısı olmadan) * '%B': çıktı MALZEME listesi dosyasının temel dosya adı (dosya uzantısı olmadan) * '%P': eğik çizgi izlemeden proje dizininin mutlak yolu ** Not: ** `%O' çıktı dosyası parametresi bir dosya uzantısı içermez. KiCad, komut satırına otomatik olarak uygun bir uzantı eklemeye çalışacaktır, ancak bir uzantının elle eklenmesi gerekebilir. Python, BOM oluşturucu komut dosyaları için önerilen araçtır, ancak başka araçlar da kullanılabilir. ## Python betikleri için örnek komut satırları Bir Python betiğinin komut satırı biçimi şu şekildedir: python <komut dosyası adı> <girdi dosya adı> <çıktı dosya adı> Windows'ta, bir CSV BOM için istenen oluşturucu komut dosyası `C:\Users\username\kicad\my_python_script.py ', komut satırı şöyle olurdu: piton.exe C:\Users\username\kicad\my_python_script.py "%I" "%O.csv" Linux'ta, bir CSV BOM için istenen jeneratör betiği `/home/username/kicad/my_python_script.py ', komut satırı şöyle olurdu: python /home/username/kicad/my_python_script.py "%I" "%O.csv" Dosya adlarının boşluk veya özel karakterler içermesi durumunda bağımsız değişkenlerin etrafında çift tırnak işareti (`"`) kullanılması önerilir.
None
The Bill of Materials tool creates a BOM which lists all of the components in the design.
The tool uses an external script to generate a BOM in the desired output format. Choosing a different script changes how the BOM is formatted.
Generating a BOM is described in more detail in the Schematic Editor manual.
# 2. Usage
Select a generator script in the **BOM generator scripts** list. Details for the selected generator are shown on the right of the dialog.
Clicking the **Generate** button creates a BOM file with the selected generator.
The default settings present several generator script options, although some additional scripts are installed with KiCad and can be added to the list with the **+** button.
**Note:** On Windows, there is an additional option **Show console window**. When this option is unchecked, BOM generators run in a hidden console window and any output is redirected and printed in the dialog. When this option is checked, BOM generators run in a visisble console window.
# 3. Custom generators and command lines
Internally, KiCad creates an intermediate netlist file in XML format that contains information about all of the components in the design. A BOM generator script converts the intermediate netlist file to the desired output format. KiCad runs the BOM generator scripts according to the command line entered at the bottom of the BOM dialog.
The command line format accepts parameters for filenames. Each formatting parameter is replaced with a project-specific path or filename. The supported formatting parameters are:
* `%I`: absolute path and filename of the intermediate netlist file, which is the input to the BOM generator
* `%O`: absolute path and filename of the output BOM file (without file extension)
* `%B`: base filename of the output BOM file (without file extension)
* `%P`: absolute path of the project directory, without trailing slash
**Note:** the `%O` output file parameter does not include a file extension. KiCad will attempt to add an appropriate extension to the command line automatically, but an extension may need to be added by hand.
Python is the recommended tool for BOM generator scripts, but other tools can also be used.
## Example command lines for Python scripts
The command line format for a Python script is of the form:
```
python <script file name> <input filename> <output filename>
```
On Windows, if the desired generator script for a CSV BOM is `C:\Users\username\kicad\my_python_script.py`, the command line would be:
```
python.exe C:\Users\username\kicad\my_python_script.py "%I" "%O.csv"
```
On Linux, if the desired generator script for a CSV BOM is `/home/username/kicad/my_python_script.py`, the command line would be:
```
python /home/username/kicad/my_python_script.py "%I" "%O.csv"
```
Double quotes (`"`) around the arguments are recommended in case filenames contain spaces or special characters.
Araç, istenen çıktı biçiminde bir ürün reçetesi oluşturmak için harici bir komut dosyası kullanır. Farklı bir komut dosyası seçmek, Ürün reçetesinin nasıl biçimlendirileceğini değiştirir.
Bir Ürün Reçetesi oluşturmak, Şematik Düzenleyici kılavuzunda daha ayrıntılı olarak açıklanmıştır.
# 2. Kullanım
**MALZEME Listesi oluşturucu komut dosyaları** listesinden bir oluşturucu komut dosyası seçin. Seçilen jeneratör için ayrıntılar iletişim kutusunun sağında gösterilir.
** Üret ** düğmesine tıklamak, seçilen üreteci içeren bir ürün reçetesi dosyası oluşturur.
Varsayılan ayarlar birkaç jeneratör komut dosyası seçeneği sunar, ancak bazı ek komut dosyaları KiCad ile yüklenir ve listeye **+** düğmesiyle eklenebilir.
** Not: ** Windows'ta ek bir seçenek vardır ** Konsol penceresini göster **. Bu seçenek işaretlenmediğinde, ürün reçetesi oluşturucuları gizli bir konsol penceresinde çalışır ve tüm çıktılar yeniden yönlendirilir ve iletişim kutusuna yazdırılır. Bu seçenek işaretlendiğinde, ÜRÜN reçetesi oluşturucuları görünür bir konsol penceresinde çalışır.
# 3. Özel jeneratörler ve komut satırları
Dahili olarak KiCad, tasarımdaki tüm bileşenler hakkında bilgi içeren XML biçiminde bir ara netlist dosyası oluşturur. Ürün reçetesi oluşturucu komut dosyası, ara netlist dosyasını istenen çıktı biçimine dönüştürür. KiCad, ÜRÜN reçetesi oluşturucu komut dosyalarını ÜRÜN REÇETESİ iletişim kutusunun altına girilen komut satırına göre çalıştırır.
Komut satırı biçimi, dosya adları için parametreleri kabul eder. Her biçimlendirme parametresi, projeye özgü bir yol veya dosya adıyla değiştirilir. Desteklenen biçimlendirme parametreleri şunlardır:
* '%İ': Ürün reçetesi oluşturucunun girdisi olan ara netlist dosyasının mutlak yolu ve dosya adı
* '%O': çıktı MALZEME listesi dosyasının mutlak yolu ve dosya adı (dosya uzantısı olmadan)
* '%B': çıktı MALZEME listesi dosyasının temel dosya adı (dosya uzantısı olmadan)
* '%P': eğik çizgi izlemeden proje dizininin mutlak yolu
** Not: ** `%O' çıktı dosyası parametresi bir dosya uzantısı içermez. KiCad, komut satırına otomatik olarak uygun bir uzantı eklemeye çalışacaktır, ancak bir uzantının elle eklenmesi gerekebilir.
Python, BOM oluşturucu komut dosyaları için önerilen araçtır, ancak başka araçlar da kullanılabilir.
## Python betikleri için örnek komut satırları
Bir Python betiğinin komut satırı biçimi şu şekildedir:
python <komut dosyası adı> <girdi dosya adı> <çıktı dosya adı>
Windows'ta, bir CSV BOM için istenen oluşturucu komut dosyası `C:\Users\username\kicad\my_python_script.py ', komut satırı şöyle olurdu:
piton.exe C:\Users\username\kicad\my_python_script.py "%I" "%O.csv"
Linux'ta, bir CSV BOM için istenen jeneratör betiği `/home/username/kicad/my_python_script.py ', komut satırı şöyle olurdu:
python /home/username/kicad/my_python_script.py "%I" "%O.csv"
Dosya adlarının boşluk veya özel karakterler içermesi durumunda bağımsız değişkenlerin etrafında çift tırnak işareti (`"`) kullanılması önerilir.