fritzkit 0.0.0-stage → 0.1.1

package/tools/fzp-checker/vendor/scripts/checks/checkcopies.py

@@ -0,0 +1,104 @@
+import getopt
+import sys
+import os
+
+def usage():
+    print("""
+usage:
+    checkcopies.py -d <directory> 
+    
+    <directory> is a folder containing svg files.  
+    looks for files that have the same content but different names
+    
+    Part of CI tests
+    """)
+
+
+def run_fast_scandir(scan_dir, ext):    # scan_dir: str, ext: list
+    subfolders, files = [], []
+
+    for f in os.scandir(scan_dir):
+        if f.is_dir():
+            subfolders.append(f.path)
+        if f.is_file():
+            if os.path.splitext(f.name)[1].lower() in ext:
+                files.append(f.path)
+
+    for d in list(subfolders):
+        sf, f = run_fast_scandir(d, ext)
+        subfolders.extend(sf)
+        files.extend(f)
+    return subfolders, files
+
+
+def main():
+    try:
+        opts, args = getopt.getopt(sys.argv[1:], "hd:", ["help", "directory"])
+    except getopt.GetoptError as err:
+        # print help information and exit:
+        print(str(err))  # will print something like "option -a not recognized"
+        usage()
+        return
+
+    outputDir = None
+    gotnot = 0
+
+    for o, a in opts:
+        # print o
+        # print a
+        if o in ("-d", "--directory"):
+            outputDir = a
+        elif o in ("-h", "--help"):
+            usage()
+            return
+        else:
+            assert False, "unhandled option"
+
+    if not outputDir:
+        print("missing -d {directory} parameter")
+        usage()
+        return
+
+    subfolders, files = run_fast_scandir(outputDir, [".svg"])
+    print("Checking %d files for duplicates" % len(files))
+    files.sort(key=lambda f: os.stat(f).st_size, reverse=True)
+    matches = []
+    for i in range(0, len(files)-1):
+        f1 = files[i]
+        s = os.stat(f1).st_size
+        # print("Check candidate %s , %d" % (files[i], s))
+        j = i + 1
+        while s == os.stat(files[j]).st_size:            
+            f2 = files[j]
+            # print("          other %s , %d" % (files[j], s))
+            j += 1
+            txt1 = None
+            try:
+                infile = open(f1, "r")
+                txt1 = infile.read()
+                infile.close()
+            except IOError:
+                print("failure", f1)
+            if txt1 is None:
+                continue
+
+            txt2 = None
+            try:
+                infile = open(f2, "r")
+                txt2 = infile.read()
+                infile.close()
+            except IOError:
+                print("failure", f2)
+                continue
+            if txt2 is None:
+                continue
+
+            if txt1 == txt2:
+                matches.append(
+                    "<map package='{0}' to='{1}' />".format(f1, f2))
+
+    print("%d duplicate pairs found" % len(matches))
+
+
+if __name__ == "__main__":
+    main()

package/tools/fzp-checker/vendor/scripts/checks/connector_numbering.py

@@ -0,0 +1,79 @@
+from .fzp_checkers import FZPChecker
+import re
+
+class FZPConnectorNumberingChecker(FZPChecker):
+    def check(self):
+        pattern = r'(\d+)'
+        numberFinder = re.compile(pattern, re.IGNORECASE)
+
+        connectors = self.fzp_doc.xpath("//connector")
+
+        # Check if any connector has an integer name
+        gotInt = False
+        for connector in connectors:
+            try:
+                int(connector.get("name"))
+                gotInt = True
+                break
+            except (ValueError, TypeError):
+                continue
+
+        if not gotInt:
+            return self.get_result()
+
+        # Check if id or name starts from zero
+        idZero = False
+        for connector in connectors:
+            try:
+                connector_id = connector.get("id")
+                match = numberFinder.search(connector_id)
+                if match and match.group(1) == '0':
+                    idZero = True
+                    break
+            except:
+                continue
+
+        nameZero = False
+        for connector in connectors:
+            if connector.get("name") == "0":
+                nameZero = True
+                break
+
+        # Check for mismatches
+        for connector in connectors:
+            idInt = 0
+            nameInt = 0
+            try:
+                connector_id = connector.get("id")
+                match = numberFinder.search(connector_id)
+                if match is None:
+                    continue
+
+                idInt = int(match.group(1))
+                nameInt = int(connector.get("name"))
+
+            except (ValueError, TypeError):
+                continue
+
+            mismatch = False
+            if nameZero and idZero:
+                mismatch = (idInt != nameInt)
+            elif nameZero:
+                mismatch = (idInt != nameInt + 1)
+            elif idZero:
+                mismatch = (idInt + 1 != nameInt)
+            else:
+                mismatch = (idInt != nameInt)
+
+            if mismatch:
+                self.add_warning(f"Connector mismatch: id={connector_id}, name={connector.get('name')}")
+
+        return self.get_result()
+
+    @staticmethod
+    def get_name():
+        return "connector_numbering"
+
+    @staticmethod
+    def get_description():
+        return "Check that connectors with integer names are correctly mapped to connector numbers"

package/tools/fzp-checker/vendor/scripts/checks/connectors_misnumbered.py

@@ -0,0 +1,228 @@
+import getopt
+import sys
+import os
+import os.path
+import re
+import xml.dom.minidom
+import xml.dom
+
+# Part of CI tests
+
+def usage():
+    print("""
+usage:
+    connectors_misnumbered.py -d [fzp folder]
+    checks that connectors with integer names are correctly mapped to connector numbers
+""")
+
+
+def skip(filename):
+    skip_files = [
+        "./core/AlphaNumericDisplay-v13.fzp",
+        "./core/Arduino_Esplora.fzp",
+        "./core/arduinoXbeere.fzp",
+        "./core/ArduPilotMega_v15.fzp",
+        "./core/Bean_revE.fzp",
+        "./core/CAR_RELE_NVF4-2.fzp",
+        "./core/din-5_midi_connector.fzp",
+        "./core/electromechanical-battery-2-aaa.fzp",
+        "./core/electromechanical-battery-2-aa.fzp",
+        "./core/ESP8266-Thing-Dev.fzp",
+        "./core/grove_beginner_kit.fzp",
+        "./core/HiFive1.fzp",
+        "./core/jlpcb-089.fzp",
+        "./obsolete/kameleon.fzp",
+        "./core/LilyPad-XBee-v15.fzp",
+        "./core/ludusProtoShieldWireless.fzp",
+        "./core/monacor_ltr_110_linetransformer.fzp",
+        "./core/MyoWare_Proto_Shield.fzp",
+        "./core/pinoccio-proto.fzp",
+        "./core/Power Screwshield 1.0a.fzp",
+        "./core/ProtoShield-Mini-v12.fzp",
+        "./core/RN41-v14.fzp",
+        "./core/Rotoshield-1.0a.fzp",
+        "./core/SMD_BC847.fzp",
+        "./core/SMD_BC857.fzp",
+        "./core/Sony_Spresense_ext_board_1.fzp",
+        "./core/SonySpresenseExtension_CXD5602PWBEXT1.fzp",
+        "./core/sparkfun-connectors-db25-hp.fzp",
+        "./core/sparkfun-connectors-db25-vp.fzp",
+        "./core/sparkfun-connectors-db9-female.fzp",
+        "./core/sparkfun-connectors-db9-male.fzp",
+        "./core/sparkfun-connectors-din7-.fzp",
+        "./core/sparkfun-connectors-f25-hp.fzp",
+        "./core/sparkfun-connectors-f25-vp.fzp",
+        "./core/sparkfun-connectors-ftdi_basic-pth.fzp",
+        "./core/sparkfun-connectors-m02-4ucon-15767.fzp",
+        "./core/sparkfun-connectors-m02--jst-2mm-smt.fzp",
+        "./core/sparkfun-connectors-m02-rocker.fzp",
+        "./core/sparkfun-connectors-m03-.fzp",
+        "./core/sparkfun-connectors-m03-smd.fzp",
+        "./core/sparkfun-connectors-m04-smd2.fzp",
+        "./core/sparkfun-connectors-m05-smd2.fzp",
+        "./core/sparkfun-connectors-m05-smd.fzp",
+        "./core/sparkfun-connectors-m06-em406.fzp",
+        "./core/sparkfun-connectors-m06-smdf.fzp",
+        "./core/sparkfun-connectors-m06-smd-straight-combo.fzp",
+        "./core/sparkfun-connectors-m08-smd-combo.fzp",
+        "./core/sparkfun-displays-7-segment-4digit-for_pogobed_only.fzp",
+        "./core/sparkfun-displays-7-segment-4digit-pth.fzp",
+        "./core/sparkfun-electromechanical-ayz0202-.fzp",
+        "./core/sparkfun-electromechanical-relay-2-g5q.fzp",
+        "./core/sparkfun-electromechanical-switch-dpdt-eg2211.fzp",
+        "./core/sparkfun-electromechanical-switch-dpdt-es.fzp",
+        "./core/sparkfun-electromechanical-switch-dpdt-gpi.fzp",
+        "./core/sparkfun-electromechanical-switch-dpdt-pth.fzp",
+        "./core/sparkfun-electromechanical-switch-momentary-2-12mm.fzp",
+        "./core/sparkfun-electromechanical-switch-momentary-2-.fzp",
+        "./core/sparkfun-electromechanical-switch-momentary-2-pth.fzp",
+        "./core/sparkfun-electromechanical-switch-momentary-2-smd-2.fzp",
+        "./core/sparkfun-electromechanical-switch-momentary-2-smd.fzp",
+        "./core/sparkfun-electromechanical-switch-sp3t-.fzp",
+        "./core/sparkfun-freqctrl-crystal-5x3.fzp",
+        "./core/sparkfun-freqctrl-crystal-epsonmc146.fzp",
+        "./core/sparkfun-freqctrl-resonator_nocap-.fzp",
+        "./core/sparkfun-led-led_ring-.fzp",
+        "./core/SparkFun Load Sensor Combinator.fzp",
+        "./core/sparkfun-passives-cap_adj-smd.fzp",
+        "./core/sparkfun-passives-fuse-x20mm.fzp",
+        "./core/sparkfun-passives-inductor-sru5028.fzp",
+        "./core/sparkfun-poweric-transformer-smd.fzp",
+        "./core/sparkfun-rf-mirf-.fzp",
+        "./core/sx1509-breakout.fzp",
+        "./core/Wireless_SD_v3.fzp",
+        "./obsolete/sparkfun-electromechanical-battery-2-aaa.fzp",
+        "./obsolete/sparkfun-electromechanical-battery-2-aa.fzp",
+    ]
+    for i, item in enumerate(skip_files):
+        skip_files[i] = os.path.normpath(item)
+    return os.path.normpath(filename) in skip_files
+
+def main():
+    try:
+        opts, args = getopt.getopt(sys.argv[1:], "hd:", ["help", "directory"])
+    except getopt.GetoptError as err:
+        # print help information and exit:
+        print(str(err))  # will print something like "option -a not recognized"
+        usage()
+        return -1
+
+    dir = None
+
+    for o, a in opts:
+        # print o
+        # print a
+        if o in ("-d", "--directory"):
+            dir = a
+        elif o in ("-h", "--help"):
+            usage()
+            return 0
+        else:
+            assert False, "unhandled option"
+
+    if(not(dir)):
+        usage()
+        return -1
+
+    pattern = r'(\d+)'
+    numberFinder = re.compile(pattern, re.IGNORECASE)
+
+    ret = 0
+    count = 0
+    for root, dirs, files in os.walk(dir, topdown=False):
+        for filename in files:
+            if not filename.endswith(".fzp"):
+                continue
+
+            fzpFilename = os.path.join(root, filename)
+            if skip(fzpFilename):
+                continue
+
+            count += 1
+
+            try:
+                dom = xml.dom.minidom.parse(fzpFilename)
+            except xml.parsers.expat.ExpatError as err:
+                print(str(err), fzpFilename)
+                continue
+
+            fzp = dom.documentElement
+            connectors = fzp.getElementsByTagName("connector")
+            gotInt = False
+            for connector in connectors:
+                try:
+                    intname = int(connector.getAttribute("name"))
+                    gotInt = True
+                except:
+                    continue
+
+            if not gotInt:
+                continue
+
+            idZero = False
+            for connector in connectors:
+                try:
+                    id = connector.getAttribute("id")
+                    match = numberFinder.search(id)
+                    if match == None:
+                        continue
+
+                    if match.group(1) == '0':
+                        idZero = True
+                        break
+                except:
+                    continue
+
+            nameZero = False
+            for connector in connectors:
+                if connector.getAttribute("name") == "0":
+                    nameZero = True
+                    break
+
+            mismatches = []
+            for connector in connectors:
+                idInt = 0
+                nameInt = 0
+                try:
+                    id = connector.getAttribute("id")
+                    match = numberFinder.search(id)
+                    if match == None:
+                        continue
+
+                    idInt = int(match.group(1))
+                    nameInt = int(connector.getAttribute("name"))
+
+                except:
+                    continue
+
+                mismatch = False
+                if nameZero and idZero:
+                    mismatch = (idInt != nameInt)
+                elif nameZero:
+                    mismatch = (idInt != nameInt + 1)
+                elif idZero:
+                    mismatch = (idInt + 1 != nameInt)
+                else:
+                    mismatch = (idInt != nameInt)
+                if mismatch:
+                    mismatches.append(connector)
+
+            if len(mismatches) > 0:
+                ret = -1
+                print(fzpFilename, nameZero, idZero)
+                for connector in mismatches:
+                    strings = connector.toxml().split("\n")
+                    print(strings[0])
+                print()
+
+    if count == 0:
+        print("No files checked in ", dir)
+        ret = -2
+    else:
+        print("%s files checked" % count)
+
+    return ret
+
+
+if __name__ == "__main__":
+    sys.exit(main())

package/tools/fzp-checker/vendor/scripts/checks/explain_errors.md

@@ -0,0 +1,95 @@
+## Common errors the CI reports on parts and their fixes
+
+### Missing viewBox attribute
+This error will appear if the SVG has no viewBox attribute. If there is no viewBox, Fritzing will apply some heuristic to
+guess the DPI and therefore the physical size of the graphic. This can easily go wrong.
+*Fix*
+Add all three, viewBox, width, and height attributes. Specify the width and height in mm or inch.
+
+### Invisible connector
+This error appears if a connector does not have renderable objects in the SVG. This often works, because Fritzing
+modifies connector graphics by setting a color and a stroke. This is error prone: Sometimes, adding a stroke
+is not enough, and some tools and SVG parsers remove non-visible elements. And since the element is not rendered by
+regular SVG editors, there is also a risk to overlook misplaced connectors.
+*Fix*
+It depends. Often there is another visible element that represents the connector and should be used instead.
+Sometimes this is a true error in the SVG, e.g. from mixed up connector IDs. Or, if you want to omit a connector entirely in a view,
+you can mark it as 'hybrid' connector in the FZP file.
+
+### Duplicate id attribute
+IDs in SVGs must be unique; some programs can not deal with duplicates. This often happens in the PCB view, when
+the same ID is used for connectors in different layers. In these cases Fritzing usually is able to refer the correct
+element via the layer id. However, this is very easy to mess up, since it is also confusing during editing the part.
+There is no verification that Fritzing does this as intended in each and every place.
+*Fix*
+Carefully check how the duplicate was introduced, maybe it is just numbered wrong. Or de-duplicate, by attaching
+underscore and number. For the PCB view, you can also nest the copper0 group within the copper1 group, and use the
+ same connector for both to have it in both layers.
+
+### Invisible or missing terminal
+This is one of the most common errors in Fritzing parts. If this error shows, Fritzing will use the center of the connector as 
+terminal.
+*Fix* 
+Fritzing 1.0.3 will automatically set the terminal, unless a terminal explicitly specified in the FZP. Therefore, 
+the fix is almost always, to remove the terminal definition from the FZP and the SVG. If you still want to manually set
+the exact terminal point, please make sure the terminal is visible. Avoid zero width and zero height.
+ 
+### Unknown style attribute
+SVG elements can have XML attributes, as well as CSS styles. Only a very small subset of CSS styles is supported by
+Fritzing. If in doubt, it is usually better to use XML attributes.
+
+Fritzing has some workarounds for the following styles:
+```
+	fixStyleAttribute(element, style, "stroke-width");
+	fixStyleAttribute(element, style, "stroke");
+	fixStyleAttribute(element, style, "fill");
+	fixStyleAttribute(element, style, "fill-opacity");
+	fixStyleAttribute(element, style, "stroke-opacity");
+	fixStyleAttribute(element, style, "font-size");
+	fixStyleAttribute(element, style, "stroke-dasharray");
+```
+These are automatically transformed into XML attributes. 
+Remaining styles are passed on to Qt renderer, which officially does not support them.
+
+
+### Style conflict
+
+In some cases, CSS styles and XML attributes may be conflicting. The rendered result is hard to predict,
+since XML does not specify a strict ordering for attributes. Please resolve the conflict manually, by
+only using a XML attribute.
+
+### Property has an empty value
+You can check the inspector how the properties are applied.
+
+Example:
+```
+Error: Property 'part number' has an empty value.
+Error: Property 'layer' has an empty value.
+Error: Property 'hole size' has an empty value.
+Error: Property 'mn' has an empty value.
+Error: Property 'mpn' has an empty value.
+```
+Custom parts currently can't configure the hole size. So you might as well remove it.
+Without a value, listing properties in the part will often have no effect.
+If you provide a default value, it should actually show as a default in the inspector.
+
+![inspector_fc51.png](inspector_fc51.png)
+
+
+### Layer ID 'icon' from iconView not found in SVG file
+This usually happens if you use the breadboard image as icon. 
+This is often not the best solution, because the breadboard image
+is difficult to recognize at icon size. 
+It is better to have a separate icon file,
+showing some characteristic region of interest,
+like a cropped version of the breadboard image.
+
+### Process completed with exit code 255
+This is just the CI telling us that some error has happened before.
+
+## Error not listed here, or still unclear?
+
+ If you think that an error is a false alert, or unsure what the error means or how to fix it, please open an issue at
+ github.com/fritzing/fritzing-parts . If possible provide a link to your CI run, the pull request, and the part file, 
+ along with a copy of the error message, and a description of what you already tried.
+