bluer-sbc 8.233.1__py3-none-any.whl → 9.31.1__py3-none-any.whl

bluer_sbc/parts/classes/db.py

@@ -0,0 +1,208 @@
+from typing import Dict, List, Iterator, Tuple
+import copy
+import os
+import numpy as np
+import cv2
+from functools import reduce
+from tqdm import tqdm
+
+from blueness import module
+from bluer_options.logger import log_list
+from bluer_objects import file
+from bluer_objects import README
+from bluer_objects.README.consts import assets_path, assets_url
+
+from bluer_sbc import NAME
+from bluer_sbc.parts.classes.part import Part
+from bluer_sbc.logger import logger
+
+NAME = module.name(__file__, NAME)
+
+
+class PartDB:
+    def __init__(self):
+        self._db: Dict[str, Part] = {}
+
+        suffix = "bluer-sbc/parts"
+        self.url_prefix = assets_url(
+            suffix=suffix,
+            volume=2,
+        )
+        self.path = assets_path(
+            suffix=suffix,
+            volume=2,
+        )
+
+    def __iter__(self):
+        return iter(self._db.values())
+
+    def __setitem__(
+        self,
+        name: str,
+        part: Part,
+    ):
+        assert isinstance(part, Part)
+
+        self._db[name] = copy.deepcopy(part)
+        self._db[name].name = name
+
+    def __getitem__(self, name: str) -> Part:
+        return self._db[name]
+
+    def items(self) -> Iterator[Tuple[str, Part]]:
+        return self._db.items()
+
+    @property
+    def README(self) -> List[str]:
+        return sorted(
+            [
+                "- [{}](./{}.md).".format(
+                    part.info[0],
+                    part.name,
+                )
+                for part in self
+            ]
+        )
+
+    def adjust(
+        self,
+        dryrun: bool = True,
+        verbose: bool = False,
+    ) -> bool:
+        logger.info(
+            "{}.adjust{}".format(
+                NAME,
+                " [dryrun]" if dryrun else "",
+            )
+        )
+
+        list_of_filenames = reduce(
+            lambda x, y: x + y,
+            [
+                [part.images[0]]
+                for part_name, part in self._db.items()
+                if part_name != "template" and part.images
+            ],
+            [],
+        )
+        log_list(logger, "adjusting", list_of_filenames, "images")
+
+        max_width = 0
+        max_height = 0
+        for filename in tqdm(list_of_filenames):
+            success, image = file.load_image(
+                os.path.join(self.path, filename),
+                log=verbose,
+            )
+            if not success:
+                return success
+
+            max_height = max(max_height, image.shape[0])
+            max_width = max(max_width, image.shape[1])
+
+        logger.info(f"size: {max_height} x {max_width}")
+
+        for filename in tqdm(list_of_filenames):
+            success, image = file.load_image(
+                os.path.join(self.path, filename),
+                log=verbose,
+            )
+            if not success:
+                return success
+
+            if image.shape[0] == max_height and image.shape[1] == max_width:
+                logger.info("✅")
+                continue
+
+            image = image[:, :, :3]
+
+            scale = min(
+                max_height / image.shape[0],
+                max_width / image.shape[1],
+            )
+            image = cv2.resize(
+                image,
+                dsize=(
+                    int(scale * image.shape[1]),
+                    int(scale * image.shape[0]),
+                ),
+                interpolation=cv2.INTER_LINEAR,
+            )
+
+            padded_image = (
+                np.ones(
+                    (max_height, max_width, 3),
+                    dtype=np.uint8,
+                )
+                * 255
+            )
+
+            y_offset = (max_height - image.shape[0]) // 2
+            x_offset = (max_width - image.shape[1]) // 2
+
+            padded_image[
+                y_offset : y_offset + image.shape[0],
+                x_offset : x_offset + image.shape[1],
+            ] = image
+
+            if not dryrun:
+                if not file.save_image(
+                    os.path.join(self.path, filename),
+                    padded_image,
+                    log=verbose,
+                ):
+                    return False
+
+        return True
+
+    def as_images(
+        self,
+        dict_of_parts: Dict[str, str],
+        reference: str = "../../parts",
+    ) -> List[str]:
+        return README.Items(
+            [
+                {
+                    "name": self._db[part_name].info[0],
+                    "marquee": self._db[part_name].image_url(
+                        url_prefix=self.url_prefix
+                    ),
+                    "description": description,
+                    "url": f"{reference}/{part_name}.md",
+                }
+                for part_name, description in dict_of_parts.items()
+            ],
+            sort=True,
+        )
+
+    def as_list(
+        self,
+        dict_of_parts: Dict[str, str],
+        reference: str = "../../parts",
+        log: bool = True,
+    ) -> List[str]:
+        if log:
+            logger.info(
+                "{}.as_list: {}".format(
+                    self.__class__.__name__,
+                    ", ".join(dict_of_parts.keys()),
+                )
+            )
+
+        for part_name in dict_of_parts:
+            if part_name not in self._db:
+                logger.error(f"{part_name}: part not found.")
+                assert False
+
+        return sorted(
+            [
+                (
+                    "1. [{}{}]({}).".format(
+                        self._db[part_name].info[0],
+                        ": {}".format(description) if description else "",
+                        f"{reference}/{part_name}.md",
+                    )
+                )
+                for part_name, description in dict_of_parts.items()
+            ]
+        )

bluer_sbc/parts/classes/part.py

@@ -0,0 +1,96 @@
+from typing import List, Union
+import copy
+
+from bluer_objects import markdown
+from bluer_objects import file
+
+
+class Part:
+    def __init__(
+        self,
+        info: Union[List[str], str] = [],
+        name: str = "",
+        images: List[str] = [],
+    ):
+        self.name = name
+
+        self.info = (
+            copy.deepcopy(info)
+            if isinstance(
+                info,
+                list,
+            )
+            else [info]
+        )
+
+        self.images = (
+            copy.deepcopy(images)
+            if isinstance(
+                images,
+                list,
+            )
+            else [images]
+        )
+
+    def filename(
+        self,
+        create: bool = False,
+    ) -> str:
+        reference = file.path(__file__)
+        filename = file.absolute(
+            f"../../docs/parts/{self.name}.md",
+            reference,
+        )
+
+        if not create or file.exists(filename):
+            return filename
+
+        template_filename = file.absolute(
+            "../../docs/parts/template-template.md",
+            reference,
+        )
+        assert file.copy(
+            template_filename,
+            file.add_suffix(filename, "template"),
+            log=True,
+        ), template_filename
+
+        return filename
+
+    def image_url(
+        self,
+        url_prefix: str,
+        filename: str = "",
+    ) -> str:
+
+        return (
+            "{}/{}?raw=true".format(
+                url_prefix,
+                filename if filename else self.images[0],
+            )
+            if self.images
+            else ""
+        )
+
+    def README(
+        self,
+        url_prefix: str,
+    ) -> List[str]:
+        return [f"- {info}" for info in self.info] + (
+            [""]
+            + markdown.generate_table(
+                [
+                    "![image]({})".format(
+                        self.image_url(
+                            url_prefix,
+                            filename,
+                        )
+                    )
+                    for filename in self.images
+                ],
+                cols=3,
+                log=False,
+            )
+            if self.images
+            else []
+        )

bluer_sbc/parts/db.py

@@ -0,0 +1,381 @@
+from bluer_sbc.parts.classes.part import Part
+from bluer_sbc.parts.classes.db import PartDB
+
+db_of_parts: PartDB = PartDB()
+
+db_of_parts["resistor"] = Part(
+    info=[
+        "Resistor, 1/4 watt, 5% tolerance",
+    ],
+    images=["resistor.png"],
+)
+
+db_of_parts["4-ch-transceiver"] = Part(
+    info=[
+        "4-channel transmitter and receiver",
+        "source: [digikala](https://www.digikala.com/product/dkp-11037586/%DA%AF%DB%8C%D8%B1%D9%86%D8%AF%D9%87-%D9%88-%D9%81%D8%B1%D8%B3%D8%AA%D9%86%D8%AF%D9%87-%D9%85%D8%A7%D8%B4%DB%8C%D9%86-%DA%A9%D9%86%D8%AA%D8%B1%D9%84%DB%8C-%D9%85%D8%AF%D9%84-4ch-led/)",
+        "voltages: receiver 6 VDC,  transmitter 3 VDC",
+    ],
+    images="4-channel-remote-control.png",
+)
+
+db_of_parts["470-mF"] = Part(
+    info=[
+        "capacitor, 470 μF to 1000 μF, 16 V or 25 V, Electrolytic, 105 °C rated if possible."
+    ],
+    images=["capacitor.png"],
+)
+
+db_of_parts["BTS7960"] = Part(
+    info=[
+        "43 A, H-Bridge Motor Driver",
+        "specs: [BTS7960](https://www.handsontec.com/dataspecs/module/BTS7960%20Motor%20Driver.pdf)",
+    ],
+    images="bts7960.jpg",
+)
+
+db_of_parts["dc-motor-12-VDC-45W"] = Part(
+    info=[
+        "12 VDC motor, 20-45 W",
+        "type 1: 9,000 RPM, output ~60 RPM",
+        "type 2: 10,000 RPM, output 72 RPM",
+        "https://parsbike.com/product/%D9%85%D9%88%D8%AA%D9%88%D8%B1-%DA%AF%DB%8C%D8%B1%D8%A8%DA%A9%D8%B3-%D9%85%D8%A7%D8%B4%DB%8C%D9%86-%D8%B4%D8%A7%D8%B1%DA%98%DB%8C-%D9%88-%D9%85%D9%88%D8%AA%D9%88%D8%B1-%D8%B4%D8%A7%D8%B1%DA%98%DB%8C/",
+    ],
+    images=[
+        "gearbox1.jpg",
+        "gearbox2.jpg",
+        "gearbox3.jpg",
+        "gearbox4.jpg",
+        "gearbox5.jpg",
+        "gearbox6.jpg",
+        "gearbox7.jpg",
+        "gearbox8.jpg",
+    ],
+)
+
+db_of_parts["LED"] = Part(
+    info=[
+        "LED, ~2 V forward voltage, 10-20 mA",
+    ],
+    images=["led.png"],
+)
+
+db_of_parts["Polyfuse"] = Part(
+    info=[
+        "Polyfuse, 1.1 A hold, 2.2 A trip, 16 V, resettable, through-hole, e.g., MF-R110",
+    ],
+    images=["polyfuse.png"],
+)
+
+db_of_parts["rpi3bp"] = Part(
+    info=[
+        "Raspberry Pi 3B+",
+    ],
+    images=[
+        "rpi3bplus.png",
+        "gpio-pinout.png",
+    ],
+)
+
+db_of_parts["SLA-Battery"] = Part(
+    info=[
+        "Rechargeable sealed lead acid battery, 12 V, 7 Ah",
+    ],
+    images=[
+        "battery.png",
+    ],
+)
+
+db_of_parts["TVS-diode"] = Part(
+    info=[
+        "TVS diode, unidirectional, 600 W, 6.8 V clamp, e.g. P6KE6.8A, DO-15 package",
+    ],
+    images=[
+        "TVSdiode.png",
+    ],
+)
+
+db_of_parts["XL4015"] = Part(
+    info=[
+        "XL4015: 12 VDC -> 5 VDC, 4A",
+        "specs: [XL4015](https://www.handsontec.com/dataspecs/module/XL4015-5A-PS.pdf)",
+    ],
+    images=[
+        "XL4015.png",
+    ],
+)
+
+db_of_parts["rpi-camera"] = Part(
+    info=[
+        "Raspberry Pi Camera, V1.3"
+        "https://www.raspberrypi.com/documentation/accessories/camera.html",
+    ],
+    images=[
+        "rpi-camera.jpg",
+    ],
+)
+
+db_of_parts["DC-gearboxed-motor-12V-120RPM"] = Part(
+    info=[
+        "Gearboxed DC Motor, 12 V (3-24 V), 3A, 120 RPM, 1:91, 15 Kg cm",
+        "[GM6558](https://www.landaelectronic.com/product/%d9%85%d9%88%d8%aa%d9%88%d8%b1-dc-%da%af%db%8c%d8%b1%d8%a8%da%a9%d8%b3-%d8%ad%d9%84%d8%b2%d9%88%d9%86%db%8c-gm6558/)",
+    ],
+    images=[
+        "GM6558/01.jpg",
+        "GM6558/02.jpg",
+        "GM6558/03.jpg",
+        "GM6558/04.jpg",
+        "GM6558/measurements.jpg",
+        "GM6558/specs.png",
+    ],
+)
+
+db_of_parts["2xAA-battery-holder"] = Part(
+    info=[
+        "2 x AA battery holder",
+    ],
+    images=[
+        "2xAA-battery-holder.jpg",
+    ],
+)
+
+db_of_parts["4xAA-battery-holder"] = Part(
+    info=[
+        "4 x AA battery holder",
+    ],
+    images=[
+        "4xAA-battery-holder.jpg",
+    ],
+)
+
+db_of_parts["PCB-double-9x7"] = Part(
+    info=[
+        "double-sided PCB, 9 cm x 7 cm",
+    ],
+    images=[
+        "PCB-double-9x7.jpeg",
+    ],
+)
+
+db_of_parts["PCB-single-14x9_5"] = Part(
+    info=[
+        "single-sided PCB, 14 cm x 9.5 cm",
+    ],
+    images=[
+        "pcb-14x9_5cm.jpg",
+    ],
+)
+
+db_of_parts["pushbutton"] = Part(
+    info=[
+        "push button",
+    ],
+    images=[
+        "pushbutton.png",
+    ],
+)
+
+db_of_parts["yellow-gearbox-dc-motor"] = Part(
+    info=[
+        "gearboxed DC motor, 6V DC",
+    ],
+    images=[
+        "yellow-gearbox-dc-motor.png",
+    ],
+)
+
+db_of_parts["yellow-wheels"] = Part(
+    info=[
+        "wheels for gearboxed DC motor",
+    ],
+    images=[
+        "yellow-wheels.jpg",
+    ],
+)
+
+db_of_parts["36v-hub-motor"] = Part(
+    info=[
+        "36V DC hub motor, 350 W, front, no gearbox",
+        "[source](https://samamotor.ir/%D9%87%D8%A7%D8%A8-%D9%85%D9%88%D8%AA%D9%88%D8%B1/5105-%D9%87%D8%A7%D8%A8-%D9%85%D9%88%D8%AA%D9%88%D8%B1-350-%D9%88%D8%A7%D8%AA-36-%D9%88%D9%84%D8%AA-%D8%A8%D8%AF%D9%88%D9%86-%DA%AF%DB%8C%D8%B1%D8%A8%DA%A9%D8%B3-%D8%AF%D9%88%DA%86%D8%B1%D8%AE%D9%87-%D9%85%D8%AE%D8%B5%D9%88%D8%B5-%DA%86%D8%B1%D8%AE-%D8%AC%D9%84%D9%88-.html)",
+    ],
+    images=[
+        "36v-hub-motor.jpg",
+    ],
+)
+
+db_of_parts["brushless-350w-drive"] = Part(
+    info=[
+        "brushless drive, 36 - 48 V DC, 350 W, sine wave, silent",
+        "[source](https://samamotor.ir/%D8%AF%D8%B1%D8%A7%DB%8C%D9%88%D8%B1-%D9%85%D9%88%D8%AA%D9%88%D8%B1-%D8%A8%D8%B1%D8%A7%D8%B4%D9%84%D8%B3-bldc/4821-%D8%AF%D8%B1%D8%A7%DB%8C%D9%88%D8%B1-%D8%A8%D8%B1%D8%A7%D8%B4%D9%84%D8%B3-36-48-%D9%88%D9%84%D8%AA-350-%D9%88%D8%A7%D8%AA-sine-wave-silent.html)",
+    ],
+    images=[
+        "brushless-350w-drive.jpg",
+    ],
+)
+
+db_of_parts["LJ-6V-battery"] = Part(
+    info=[
+        "6V DC (4 cell) NICD battery",
+        "https://www.digikala.com/product/dkp-3213588/%C3%98/",
+    ],
+    images=[
+        "LJ-6V-battery.jpg",
+    ],
+)
+
+
+db_of_parts["USB-charger-NICD-6V"] = Part(
+    info=[
+        "6V DC charger for NICD batteries",
+        "https://www.digikala.com/product/dkp-5977954/%D8%B4%D8%A7%D8%B1%DA%98%D8%B1-%D8%A8%D8%A7%D8%AA%D8%B1%DB%8C-%D9%85%D8%A7%D8%B4%DB%8C%D9%86-%DA%A9%D9%86%D8%AA%D8%B1%D9%84%DB%8C-%D9%85%D8%AF%D9%84-6-%D9%88%D9%84%D8%AA-%DA%A9%D8%AF-6v-usb-sm-%D8%A8%D9%87-%D9%87%D9%85%D8%B1%D8%A7%D9%87-%D8%B3%D9%88%DA%A9%D8%AA-sm-%D8%AF%D9%88-%D9%BE%DB%8C%D9%86/",
+    ],
+    images=[
+        "USB-charger-NICD-6V-1.jpg",
+        "USB-charger-NICD-6V-2.jpg",
+    ],
+)
+
+db_of_parts["L-1x2"] = Part(
+    info=[
+        "L 1x2",
+        "https://robotexiran.com/product/%d8%a8%d8%b3%d8%aa-21-l/",
+    ],
+    images=[
+        "L-1x2-1.jpg",
+        "L-1x2-2.jpg",
+    ],
+)
+
+db_of_parts["shaft-10cm"] = Part(
+    info=[
+        "shaft, 10 cm",
+        "https://robotexiran.com/product/%d9%85%d8%ad%d9%88%d8%b1-10cm/",
+    ],
+    images=[
+        "shaft-10cm.jpg",
+    ],
+)
+
+db_of_parts["M3"] = Part(
+    info=[
+        "M3 nuts and bolts",
+    ],
+    images=[
+        "M3.jpg",
+    ],
+)
+
+db_of_parts["front-connector"] = Part(
+    info=[
+        "front connector",
+    ],
+    images=[
+        "front-connector.jpg",
+    ],
+)
+
+db_of_parts["front-wheels"] = Part(
+    info=[
+        "front wheels",
+    ],
+    images=[
+        "front-wheels.jpg",
+    ],
+)
+
+db_of_parts["wheel"] = Part(
+    info=[
+        "power wheel wheels",
+        "https://sarobatic.ir/product/%DA%86%D8%B1%D8%AE-%D8%A8%D8%B2%D8%B1%DA%AF-%D8%B9%D9%82%D8%A8-%D9%85%D8%A7%D8%B4%DB%8C%D9%86-%D8%B4%D8%A7%D8%B1%DA%98%DB%8C-%D8%A7%D8%B3%D8%AA%D9%88%DA%A9/",
+        "https://toys-repair.ir/product/2768/",
+    ],
+    images=[
+        "wheel1.jpg",
+        "wheel4.jpg",
+        "wheel3.jpg",
+    ],
+)
+
+db_of_parts["ultrasonic-sensor"] = Part(
+    info=[
+        "HC-SR04: ultrasonic-sensor",
+        "[datasheet](https://cdn.sparkfun.com/datasheets/Sensors/Proximity/HCSR04.pdf)",
+        "1m ~= 6ms",
+        "fov = 15 - 30 deg",
+    ],
+    images=[
+        "HC-SR04.jpg",
+    ],
+)
+
+db_of_parts["connector"] = Part(
+    info=[
+        "auto power connectors",
+    ],
+    images=[
+        "connector.jpg",
+    ],
+)
+
+db_of_parts["1N4148"] = Part(
+    info=[
+        "1N4148 diode",
+    ],
+    images=[
+        "TVSdiode.png",
+    ],
+)
+
+db_of_parts["40-inch-TV"] = Part(
+    info=[
+        "40 inch TV",
+    ],
+    images=[
+        "40-inch-TV.jpg",
+    ],
+)
+
+db_of_parts["power-station"] = Part(
+    info=[
+        "power station.",
+    ],
+    images=[
+        "power-station.jpeg",
+    ],
+)
+
+db_of_parts["TV-bracket"] = Part(
+    info=[
+        "TV bracket",
+    ],
+    images=[
+        "tv-bracket.jpeg",
+    ],
+)
+
+db_of_parts["on-off-switch"] = Part(
+    info=[
+        "on/off switch",
+    ],
+    images=[
+        "on-off-switch.png",
+    ],
+)
+
+db_of_parts["charging-port"] = Part(
+    info=[
+        "charging port",
+    ],
+    images=[
+        "charging-port.jpg",
+    ],
+)
+
+db_of_parts["template"] = Part(
+    info=[
+        "template",
+    ],
+    images=[
+        "template.jpg",
+    ],
+)