diff --git a/README.md b/README.md index d0e4fe7..75a86a2 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,42 @@ # KiCad Library for Visaton electronic parts - This KiCad library contains the electronics components to build crossovers for Speakerboxes of the german vendor Visaton. It includes the symbols. footprints and 3D models. + This KiCad library contains the electronic components to build crossovers for speaker boxes of the German vendor Visaton. It includes the symbols, footprints and 3D models. + +It covers the complete crossover parts list Visaton ships with [Boxsim](https://www.visaton.de/), 95 parts across 11 series: MOX and ceramic resistors, Elko, MKT-A and MKP capacitors, and FC, LR, KN and SP inductors. On top of those it provides an `Amplifier` and a `Speaker` symbol for the terminals, and the radial `MKT 22μF` capacitor, which Visaton sells but does not offer in Boxsim's parts picker. + +## Requirements + +KiCad 10 or newer. Symbols and footprints are stored in the current file format, which older KiCad versions cannot read. ## Installation ### Clone the repository -Clone this repository to a preferred place on your harddisk and import the symbols and footprints using the library managers. +```bash +git clone ssh://git@src.bundespruefstelle.ch:2022/magdev/kicad-visaton-lib.git +``` + +Clone it to a preferred place on your harddisk and import the symbols and footprints using the library managers. ### Download as ZIP -Download the package as ZIP-File and install it using the KiCad AddOn Manager. +Download the package as ZIP file and install it using the KiCad AddOn Manager. + +## Generating a crossover from a Boxsim project + +[boxsim](https://src.bundespruefstelle.ch/magdev/boxsim-fileformat-rev) reads a Boxsim project file and generates a KiCad project whose schematic mirrors the crossover, with every part bound to a symbol and footprint from this library: + +```bash +export BOXSIM_KICAD_LIB=/path/to/kicad-visaton-lib +boxsim build project.bpj out/ +``` ## Known issues * The positions of the footprints of the inductors might not really fit the original positions. I couldn't find reliable geometrics. -* The geometry of some symbols, especially the capacitors, are a little to huge. +* The geometry of some symbols, especially the capacitors, is a little too large. +## Licence + +CC-BY-SA-4.0. diff --git a/metadata.json b/metadata.json index 09d244a..ef4fb11 100644 --- a/metadata.json +++ b/metadata.json @@ -3,7 +3,7 @@ "name": "Visaton Kicad Library", "description": "Visaton electronic parts", "description_full": "This package contains symbols, footprints and 3D model for the electronic parts of Visaton speaker manufacturer.", - "identifier": "com.github.magdev/visaton-kicad-library", + "identifier": "ch.bundespruefstelle.src.magdev.visaton-kicad-library", "type": "library", "author": { "name": "Marco Grätsch (magdev)", @@ -13,7 +13,7 @@ }, "license": "CC-BY-SA-4.0", "resources": { - "Github": "https://github.com/magdev/visaton-kicad-library" + "Repository": "https://src.bundespruefstelle.ch/magdev/kicad-visaton-lib" }, "tags": [ "footprint", @@ -24,7 +24,7 @@ { "version": "1.0", "status": "development", - "kicad_version": "6.0" + "kicad_version": "10.0" } ] }