JLC2KiCadLib 1.1.0__tar.gz

jlc2kicadlib-1.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help me improve
+title: ''
+labels: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. LCSC part # that caused the issue
+2. Arguments used for the execution
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

jlc2kicadlib-1.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

jlc2kicadlib-1.1.0/.gitignore

@@ -0,0 +1,20 @@
+.vscode/
+KiCad
+test.py
+__pycache__
+.gitignore 
+JLCPCB SMT Parts Library(*).csv 
+TestJLC2KiCad.py
+*.log
+*test*
+failedComponents
+build
+JLCPCBsources
+JLC2KiCadLib.egg-info
+JLC2KiCad_lib/
+dist/
+TEST/
+.venv
+gen_lib.py
+kicad-library-utils
+

jlc2kicadlib-1.1.0/JLC2KiCadLib/JLC2KiCadLib.py

@@ -0,0 +1,216 @@
+import argparse
+import json
+import logging
+from importlib.metadata import version as pkg_version
+
+import requests
+
+from . import helper
+
+__version__ = pkg_version("JLC2KiCadLib")
+
+from .footprint.footprint import create_footprint, get_footprint_info
+from .symbol.symbol import create_symbol
+
+
+def add_component(component_id, args):
+    logging.info(f"creating library for component {component_id}")
+    data = json.loads(
+        requests.get(
+            f"https://easyeda.com/api/products/{component_id}/svgs"
+        ).content.decode()
+    )
+
+    if not data["success"]:
+        logging.error(
+            f"failed to get component uuid for {component_id}\n"
+            "The component # is probably wrong. Check a possible typo and that the "
+            "component exists on easyEDA"
+        )
+        return ()
+
+    footprint_component_uuid = data["result"][-1]["component_uuid"]
+    symbol_component_uuid = [i["component_uuid"] for i in data["result"][:-1]]
+
+    if args.footprint_creation:
+        footprint_name, datasheet_link = create_footprint(
+            footprint_component_uuid=footprint_component_uuid,
+            component_id=component_id,
+            footprint_lib=args.footprint_lib,
+            output_dir=args.output_dir,
+            model_base_variable=args.model_base_variable,
+            model_dir=args.model_dir,
+            skip_existing=args.skip_existing,
+            models=args.models,
+        )
+    else:
+        _, datasheet_link, _, _ = get_footprint_info(footprint_component_uuid)
+        footprint_name = ""
+
+    if args.symbol_creation:
+        create_symbol(
+            symbol_component_uuid=symbol_component_uuid,
+            footprint_name=footprint_name.replace(
+                ".pretty", ""
+            ),  # see https://github.com/TousstNicolas/JLC2KiCad_lib/issues/47
+            datasheet_link=datasheet_link,
+            library_name=args.symbol_lib,
+            symbol_path=args.symbol_lib_dir,
+            output_dir=args.output_dir,
+            component_id=component_id,
+            skip_existing=args.skip_existing,
+        )
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description=(
+            "take a JLCPCB part # and create the according component'skicad's library"
+        ),
+        epilog=(
+            "example use : \n"
+            "     JLC2KiCadLib C1337258 C24112 -dir My_lib "
+            "-symbol_lib My_Symbol_lib --no_footprint"
+        ),
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+
+    parser.add_argument(
+        "components",
+        metavar="JLCPCB_part_#",
+        type=str,
+        nargs="+",
+        help="List of JLCPCB part # from the components you want to create",
+    )
+
+    parser.add_argument(
+        "-dir",
+        dest="output_dir",
+        type=str,
+        default="JLC2KiCad_lib",
+        help="Base directory for output library files",
+    )
+
+    parser.add_argument(
+        "--no_footprint",
+        dest="footprint_creation",
+        action="store_false",
+        help="Use --no_footprint if you do not want to create the footprint",
+    )
+
+    parser.add_argument(
+        "--no_symbol",
+        dest="symbol_creation",
+        action="store_false",
+        help="Use --no_symbol if you do not want to create the symbol",
+    )
+
+    parser.add_argument(
+        "-symbol_lib",
+        dest="symbol_lib",
+        type=str,
+        default=None,
+        help='Set symbol library name, default is "default_lib"',
+    )
+
+    parser.add_argument(
+        "-symbol_lib_dir",
+        dest="symbol_lib_dir",
+        type=str,
+        default="symbol",
+        help='Set symbol library path, default is "symbol" (relative to OUTPUT_DIR)',
+    )
+
+    parser.add_argument(
+        "-footprint_lib",
+        dest="footprint_lib",
+        type=str,
+        default="footprint",
+        help='Set footprint library name,  default is "footprint"',
+    )
+
+    parser.add_argument(
+        "-models",
+        dest="models",
+        nargs="*",
+        choices=["STEP", "WRL"],
+        type=str,
+        default="STEP",
+        help=(
+            "Select the 3D model you want to use. Default is STEP. "
+            "If both are selected, only the STEP model will be added to the footprint "
+            "(the WRL model will still be generated alongside the STEP model). "
+            "If you do not want any model to be generated, use the --models "
+            "without arguments"
+        ),
+    )
+
+    parser.add_argument(
+        "-model_dir",
+        dest="model_dir",
+        type=str,
+        default="packages3d",
+        help=(
+            'Set directory for storing 3d models, default is "packages3d" '
+            "(relative to FOOTPRINT_LIB)"
+        ),
+    )
+
+    parser.add_argument(  # argument to skip already existing files and symbols
+        "--skip_existing",
+        dest="skip_existing",
+        action="store_true",
+        help=(
+            "Use --skip_existing if you want do not want to replace already existing "
+            "footprints and symbols"
+        ),
+    )
+
+    parser.add_argument(
+        "-model_base_variable",
+        dest="model_base_variable",
+        type=str,
+        default="",
+        help=(
+            "Use -model_base_variable if you want to specify the base path of the 3D "
+            "model using a path variable. If the specified variable starts with '$' it "
+            "is used 'as-is', otherwise it is encapsulated: $(MODEL_BASE_VARIABLE)"
+        ),
+    )
+
+    parser.add_argument(
+        "-logging_level",
+        dest="logging_level",
+        type=str,
+        default="INFO",
+        choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
+        help=(
+            "Set logging level. If DEBUG is used, the debug logs are only written in "
+            "the log file if the option  --log_file is set "
+        ),
+    )
+
+    parser.add_argument(
+        "--log_file",
+        dest="log_file",
+        action="store_true",
+        help="Use --log_file if you want logs to be written in a file",
+    )
+
+    parser.add_argument(
+        "--version",
+        action="version",
+        version=f"%(prog)s {__version__}",
+        help="Print versin number and exit",
+    )
+
+    args = parser.parse_args()
+
+    helper.set_logging(args.logging_level, args.log_file)
+
+    for component in args.components:
+        add_component(component, args)
+
+
+if __name__ == "__main__":
+    main()

jlc2kicadlib-1.1.0/JLC2KiCadLib/footprint/footprint.py

@@ -0,0 +1,181 @@
+import json
+import logging
+import os
+from dataclasses import dataclass
+
+import requests
+from KicadModTree import Footprint, KicadFileHandler, Pad, Text, Translation
+
+from .footprint_handlers import handlers, mil2mm
+
+
+@dataclass
+class FootprintInfo:
+    max_X: float = -10000
+    max_Y: float = -10000
+    min_X: float = 10000
+    min_Y: float = 10000
+    footprint_name: str = ""
+    output_dir: str = ""
+    footprint_lib: str = ""
+    model_base_variable: str = ""
+    model_dir: str = ""
+    origin: tuple = (0, 0)
+    models: str = ""
+
+
+def create_footprint(
+    footprint_component_uuid,
+    component_id,
+    footprint_lib,
+    output_dir,
+    model_base_variable,
+    model_dir,
+    skip_existing,
+    models,
+):
+    logging.info("Creating footprint ...")
+
+    (
+        footprint_name,
+        datasheet_link,
+        footprint_shape,
+        translation,
+    ) = get_footprint_info(footprint_component_uuid)
+
+    if skip_existing and os.path.isfile(
+        os.path.join(output_dir, footprint_lib, footprint_name + ".kicad_mod")
+    ):
+        logging.info(f"Footprint {footprint_name} already exists, skipping.")
+        return f"{footprint_lib}:{footprint_name}", datasheet_link
+
+    # init kicad footprint
+    kicad_mod = Footprint(f'"{footprint_name}"')
+    kicad_mod.setDescription(f"{footprint_name} footprint")  # TODO Set real description
+    kicad_mod.setTags(f"{footprint_name} footprint {component_id}")
+
+    footprint_info = FootprintInfo(
+        footprint_name=footprint_name,
+        output_dir=output_dir,
+        footprint_lib=footprint_lib,
+        model_base_variable=model_base_variable,
+        model_dir=model_dir,
+        origin=translation,
+        models=models,
+    )
+
+    # for each line in data : use the appropriate handler
+    for line in footprint_shape:
+        args = [
+            i for i in line.split("~") if i
+        ]  # split and remove empty string in list
+        model = args[0]
+        logging.debug(args)
+        if model not in handlers:
+            logging.warning(f"footprint : model not in handler :  {model}")
+        else:
+            handlers.get(model)(args[1:], kicad_mod, footprint_info)
+
+    if any(
+        isinstance(child, Pad) and child.type == Pad.TYPE_THT
+        for child in kicad_mod.getAllChilds()
+    ):
+        kicad_mod.setAttribute("through_hole")
+    else:
+        kicad_mod.setAttribute("smd")
+
+    kicad_mod.insert(Translation(-mil2mm(translation[0]), -mil2mm(translation[1])))
+
+    # Translate the footprint max and min values to the origin
+    footprint_info.max_X -= mil2mm(translation[0])
+    footprint_info.max_Y -= mil2mm(translation[1])
+    footprint_info.min_X -= mil2mm(translation[0])
+    footprint_info.min_Y -= mil2mm(translation[1])
+
+    # set general values
+    kicad_mod.append(
+        Text(
+            type="reference",
+            text="REF**",
+            at=[
+                (footprint_info.min_X + footprint_info.max_X) / 2,
+                footprint_info.min_Y - 2,
+            ],
+            layer="F.SilkS",
+        )
+    )
+    kicad_mod.append(
+        Text(
+            type="user",
+            text="${REFERENCE}",
+            at=[
+                (footprint_info.min_X + footprint_info.max_X) / 2,
+                (footprint_info.min_Y + footprint_info.max_Y) / 2,
+            ],
+            layer="F.Fab",
+        )
+    )
+    kicad_mod.append(
+        Text(
+            type="value",
+            text=footprint_name,
+            at=[
+                (footprint_info.min_X + footprint_info.max_X) / 2,
+                footprint_info.max_Y + 2,
+            ],
+            layer="F.Fab",
+        )
+    )
+
+    if not os.path.exists(f"{output_dir}/{footprint_lib}"):
+        os.makedirs(f"{output_dir}/{footprint_lib}")
+
+    # output kicad model
+    file_handler = KicadFileHandler(kicad_mod)
+    file_handler.writeFile(f"{output_dir}/{footprint_lib}/{footprint_name}.kicad_mod")
+    logging.info(f"Created '{output_dir}/{footprint_lib}/{footprint_name}.kicad_mod'")
+
+    # return the datasheet link and footprint name to be linked with the symbol
+    return (f"{footprint_lib}:{footprint_name}", datasheet_link)
+
+
+def get_footprint_info(footprint_component_uuid):
+    # fetch the component data from easyeda library
+    response = requests.get(
+        f"https://easyeda.com/api/components/{footprint_component_uuid}"
+    )
+
+    if response.status_code == requests.codes.ok:
+        data = json.loads(response.content.decode())
+    else:
+        logging.error(
+            "create_footprint error. Requests returned with error code "
+            f"{response.status_code}"
+        )
+        return ("", None, "", (0, 0))
+
+    footprint_shape = data["result"]["dataStr"]["shape"]
+    x = data["result"]["dataStr"]["head"]["x"]
+    y = data["result"]["dataStr"]["head"]["y"]
+    try:
+        datasheet_link = data["result"]["dataStr"]["head"]["c_para"]["link"]
+    except KeyError:
+        datasheet_link = ""
+        logging.warning("Could not retrieve datasheet link from EASYEDA")
+
+    footprint_name = (
+        data["result"]["title"]
+        .replace(" ", "_")
+        .replace("/", "_")
+        .replace("(", "_")
+        .replace(")", "_")
+    )
+
+    if not footprint_name:
+        footprint_name = "NoName"
+        logging.warning(
+            "Could not retrieve components information from EASYEDA, default name "
+            "'NoName'."
+        )
+
+    return (footprint_name, datasheet_link, footprint_shape, (x, y))