mirror/Part-DB.Part-DB-server
1
0
Fork 1
mirror of https://github.com/Part-DB/Part-DB-server.git synced 2025-06-21 09:35:49 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add various info from the Part-DB database to the KICAD parts

Browse source
This commit is contained in:
Jan Böhmer 2023-11-29 21:28:06 +01:00
parent ee69f9e576
commit 2ec1a10623
2 changed files with 111 additions and 49 deletions
Download patch file Download diff file Expand all files Collapse all files

33
src/Controller/KiCADAPIController.php
View file

@ -74,37 +74,8 @@ class KiCADAPIController extends AbstractController
#[Route('/parts/{part}.json', name: 'kicad_api_part')]
public function partDetails(Part $part): Response
{
return $this->json($this->partToKiCADPart($part));
}
$this->denyAccessUnlessGranted('read', $part);
private function partToKiCADPart(Part $part): array
{
$result = [
'id' => (string) $part->getId(),
'name' => $part->getName(),
"symbolIdStr" => "Device:R",
"exclude_from_bom" => "False",
"exclude_from_board" => "False",
"exclude_from_sim" => "True",
"fields" => []
];
//Add misc fields
$result["fields"]["description"] = $this->createValue($part->getDescription());
$result["fields"]["value"] = $this->createValue($part->getName(), true);
$result["fields"]["keywords"] = $this->createValue($part->getTags());
if ($part->getManufacturer()) {
$result["fields"]["manufacturer"] = $this->createValue($part->getManufacturer()->getName());
}
return $result;
}
private function createValue(string|int|float $value, bool $visible = false): array
{
return [
'value' => (string) $value,
'visible' => $visible ? 'True' : 'False',
];
return $this->json($this->kiCADHelper->getKiCADPart($part));
}
}

103
src/Services/EDAIntegration/KiCADHelper.php
View file

@ -25,12 +25,13 @@ namespace App\Services\EDAIntegration;
use App\Entity\Parts\Category;
use App\Entity\Parts\Part;
use App\EntityListeners\TreeCacheInvalidationListener;
use App\Services\Cache\ElementCacheTagGenerator;
use App\Services\Trees\NodesListBuilder;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use Symfony\Contracts\Cache\ItemInterface;
use Symfony\Contracts\Cache\TagAwareCacheInterface;
use Symfony\Contracts\Translation\TranslatorInterface;
class KiCADHelper
{
@ -40,9 +41,9 @@ class KiCADHelper
private readonly TagAwareCacheInterface $kicadCache,
private readonly EntityManagerInterface $em,
private readonly ElementCacheTagGenerator $tagGenerator,
)
{
private readonly UrlGeneratorInterface $urlGenerator,
private readonly TranslatorInterface $translator,
) {
}
/**
@ -88,8 +89,12 @@ class KiCADHelper
*/
public function getCategoryParts(Category $category): array
{
return $this->kicadCache->get('kicad_category_parts_' . $category->getID(), function (ItemInterface $item) use ($category) {
$item->tag([$this->tagGenerator->getElementTypeCacheTag(Category::class), $this->tagGenerator->getElementTypeCacheTag(Part::class)]);
return $this->kicadCache->get('kicad_category_parts_'.$category->getID(),
function (ItemInterface $item) use ($category) {
$item->tag([
$this->tagGenerator->getElementTypeCacheTag(Category::class),
$this->tagGenerator->getElementTypeCacheTag(Part::class)
]);
$category_repo = $this->em->getRepository(Category::class);
$parts = $category_repo->getParts($category);
@ -106,4 +111,90 @@ class KiCADHelper
return $result;
});
}
public function getKiCADPart(Part $part): array
{
$result = [
'id' => (string)$part->getId(),
'name' => $part->getName(),
"symbolIdStr" => "Device:R",
"exclude_from_bom" => $this->boolToKicadBool(false),
"exclude_from_board" => $this->boolToKicadBool(false),
"exclude_from_sim" => $this->boolToKicadBool(true),
"fields" => []
];
$result["fields"]["value"] = $this->createField($part->getName(), true);
$result["fields"]["keywords"] = $this->createField($part->getTags());
//Use the part info page as datasheet link. It must be an absolute URL.
$result["fields"]["datasheet"] = $this->createField(
$this->urlGenerator->generate(
'part_info',
['id' => $part->getId()],
UrlGeneratorInterface::ABSOLUTE_URL)
);
//Add basic fields
$result["fields"]["description"] = $this->createField($part->getDescription());
if ($part->getCategory()) {
$result["fields"]["Category"] = $this->createField($part->getCategory()->getFullPath('/'));
}
if ($part->getManufacturer()) {
$result["fields"]["Manufacturer"] = $this->createField($part->getManufacturer()->getName());
}
if ($part->getManufacturerProductNumber() !== "") {
$result['fields']["MPN"] = $this->createField($part->getManufacturerProductNumber());
}
if ($part->getManufacturingStatus()) {
$result["fields"]["Manufacturing Status"] = $this->createField(
//Always use the english translation
$this->translator->trans($part->getManufacturingStatus()->toTranslationKey(), locale: 'en')
);
}
if ($part->getFootprint()) {
$result["fields"]["Part-DB Footprint"] = $this->createField($part->getFootprint()->getName());
}
if ($part->getPartUnit()) {
$unit = $part->getPartUnit()->getName();
if ($part->getPartUnit()->getUnit() !== "") {
$unit .= ' (' . $part->getPartUnit()->getUnit() . ')';
}
$result["fields"]["Part-DB Unit"] = $this->createField($unit);
}
if ($part->getMass()) {
$result["fields"]["Mass"] = $this->createField($part->getMass());
}
$result["fields"]["Part-DB ID"] = $this->createField($part->getId());
if (!empty($part->getIpn())) {
$result["fields"]["Part-DB IPN"] = $this->createField($part->getIpn());
}
return $result;
}
/**
* Converts a boolean value to the format required by KiCAD.
* @param bool $value
* @return string
*/
private function boolToKicadBool(bool $value): string
{
return $value ? 'True' : 'False';
}
/**
* Creates a field array for KiCAD
* @param string|int|float $value
* @param bool $visible
* @return array
*/
private function createField(string|int|float $value, bool $visible = false): array
{
return [
'value' => (string)$value,
'visible' => $this->boolToKicadBool($visible),
];
}
}