ervanalb · charely6 · Oct 12, 2023 · Oct 12, 2023 · Oct 13, 2023 · Oct 13, 2023
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+
+*.stl
diff --git a/Makefile b/Makefile
@@ -1,7 +1,15 @@
 # Makefile for keygen
 
 # Executables
-POLY = PYTHONPATH=/usr/share/inkscape/extensions bin/paths2openscad.py
+ifdef OS
+	POLY = python3 bin/paths2openscad.py
+	RM = del /Q
+	FixPath = $(subst /,\,$1)
+else
+	RM = -rm -f
+	POLY = PYTHONPATH=/usr/share/inkscape/extensions python3 bin/paths2openscad.py
+    FixPath = $1
+endif
 
 SCAD_DIR = scad
 SVG_DIR = resources
@@ -17,6 +25,7 @@ SCAD_SRC  = $(SCAD_DIR)/schlage_classic.scad \
             $(SCAD_DIR)/medeco_classic.scad \
             $(SCAD_DIR)/medeco_biaxial.scad \
             $(SCAD_DIR)/master.scad \
+            $(SCAD_DIR)/X103-KW12.scad \
 
 # Generated polygon files
 POLY_OBJ = $(patsubst $(SVG_DIR)/%.svg,$(POLY_DIR)/%.gen.scad,$(SVG_SRC))
@@ -30,10 +39,10 @@ POLYFLAGS  =
 all: $(JSON_DIR)/keys.json poly
 poly: $(POLY_OBJ)
 $(JSON_DIR)/%.json: $(SCAD_DIR)/%.scad
-	bin/parse.py $< $@
+	python3 bin/parse.py $< $@
 $(POLY_DIR)/%.gen.scad: $(SVG_DIR)/%.svg
 	$(POLY) $(POLYFLAGS) --fname $@ $<
 $(JSON_DIR)/keys.json: $(JSON_OBJ)
-	bin/json_merge.py $^ >$(JSON_DIR)/keys.json
+	python3 bin/json_merge.py $^ >$(JSON_DIR)/keys.json
 clean:
-	-rm -f $(POLY_DIR)/*.gen.scad $(JSON_DIR)/*.json
+	$(RM) $(call FixPath, $(POLY_DIR)/*.gen.scad $(JSON_DIR)/*.json)
diff --git a/bin/keygen.py b/bin/keygen.py
@@ -15,6 +15,8 @@
                     help="Key blank outline")
 parser.add_argument("-w", "--warding", dest='warding',
                     help="Key warding")
+parser.add_argument("-s", "--series_name", dest='series_name',
+                    help="Key series_name")
 parser.add_argument("-o", "--output", dest='output', default="a.stl",
                     help="Output file (defaults to a.stl)")
 
@@ -32,6 +34,7 @@ def escape(s):
     opts += ["-D", 'outline="{}"'.format(escape(args.outline))]
 if args.warding is not None:
     opts += ["-D", 'warding="{}"'.format(escape(args.warding))]
-
+if args.series_name is not None:
+    opts += ["-D", 'series_name="{}"'.format(escape(args.series_name))]
 r = subprocess.call([scad, args.filename, "-o", args.output] + opts + remaining)
 sys.exit(r)
diff --git a/bin/paths2openscad.py b/bin/paths2openscad.py
@@ -450,8 +450,8 @@ def convertPath( self, node ):
 
         # Determine which polys contain which
 
-        contains     = [ [] for i in xrange( len( path ) ) ]
-        contained_by = [ [] for i in xrange( len( path ) ) ]
+        contains     = [ [] for i in range( len( path ) ) ]
+        contained_by = [ [] for i in range( len( path ) ) ]
 
         for i in range( 0, len( path ) ):
             for j in range( i + 1, len( path ) ):
@@ -876,7 +876,9 @@ def effect( self ):
             self.f.write( '\n' )
             for call in self.call_list:
                 self.f.write( call )
-
+            self.f.close()
+
+
         except IOError:
             inkex.errormsg( 'Unable to open the file ' + self.options.fname )
 

diff --git a/doc/how_to_model_keys.md b/doc/how_to_model_keys.md
@@ -11,15 +11,19 @@ from the manufacturer](https://www.imlss.com/images/pdf/KBD12.pdf).
 2. Using Inkscape, trace the key outline, warding, and engraving.
 If you got your image from a PDF, your job is much easier,
 and you only need to clean up the paths.
-3. Select a path and press `Control-Shift-O`. Give it a useful name, such as "outline" or "warding".
+3. Select a path and press `Control-Shift-O`. Give it a useful name, such as "outline" or "warding". (I recommend using outline, warding, and engrave)
 4. Save the result as a SVG in the `resources` folder. Run `make` to generate OpenSCAD polygons from your paths.
 5. Look up online the various parameters of your key, such as plug diameter,
 cut depths and locations.
+	Many are now included by Charely6 in the referenceMaterials folder 
 5. Use the provided OpenSCAD functions `key_code_to_heights`,
 `key_blank` and `key_bitting` to generate a 3D model of your key.
 Use the provided OpenSCAD files as a template.
+Note you will want to set the offset to the point at the bottom key shoulder, If you don't know which one that is I used the commented out polygons at the bottom of the gen.scad file and randomly changing values and seeing which point moves and noting which one is that spot. The points will go in one direction around the shape so you can work your way around.   
+Also if you want to do double sided keys look at `X103-KW12.scad` there is a comment noting it.
 6. To add your key to the database,
 edit the `Makefile` to include your `.scad` file in the `SCAD_SRC` variable.
+To add to the Makefile be sure to set name in your module and make variables named outlines_k and wardings_k like the ones in the original `.scad` files
 
 For this to work, your final file must look like this:
 

diff --git a/referenceMaterial/029a-reference-guide.pdf b/referenceMaterial/029a-reference-guide.pdf
diff --git a/referenceMaterial/ASSA-Twin-Series-New-Style.pdf b/referenceMaterial/ASSA-Twin-Series-New-Style.pdf
diff --git a/referenceMaterial/Abus-Vitess.pdf b/referenceMaterial/Abus-Vitess.pdf
diff --git a/referenceMaterial/Auto depth & Space.pdf b/referenceMaterial/Auto depth & Space.pdf
diff --git a/referenceMaterial/B07oBBQ_d.webp b/referenceMaterial/B07oBBQ_d.webp
diff --git a/referenceMaterial/Blue-Dog-Keys-Catalog.pdf b/referenceMaterial/Blue-Dog-Keys-Catalog.pdf
diff --git a/referenceMaterial/Corbin-Emhart-High-Security-Z-and-DH-Class-System-70.pdf b/referenceMaterial/Corbin-Emhart-High-Security-Z-and-DH-Class-System-70.pdf
diff --git a/referenceMaterial/Corbin-Keyways.pdf b/referenceMaterial/Corbin-Keyways.pdf
diff --git a/referenceMaterial/Corbin-Russwin-Access-3-AP.pdf b/referenceMaterial/Corbin-Russwin-Access-3-AP.pdf
diff --git a/referenceMaterial/Corbin-Russwin-Access-3-AS-AHS.pdf b/referenceMaterial/Corbin-Russwin-Access-3-AS-AHS.pdf
diff --git a/referenceMaterial/Corbin-Russwin-Pyramid.pdf b/referenceMaterial/Corbin-Russwin-Pyramid.pdf
diff --git a/referenceMaterial/Decoding-Keys.pdf b/referenceMaterial/Decoding-Keys.pdf
diff --git a/referenceMaterial/FAS0ycj_d.webp b/referenceMaterial/FAS0ycj_d.webp
diff --git a/referenceMaterial/Framon_key_depth_guide_v8.pdf b/referenceMaterial/Framon_key_depth_guide_v8.pdf
diff --git a/referenceMaterial/ILCO_automotive_sec_1.pdf b/referenceMaterial/ILCO_automotive_sec_1.pdf
diff --git a/referenceMaterial/ILCO_noa_cyl_sec_2.pdf b/referenceMaterial/ILCO_noa_cyl_sec_2.pdf
diff --git a/referenceMaterial/ITL_spacesortver209r2.pdf b/referenceMaterial/ITL_spacesortver209r2.pdf
diff --git a/referenceMaterial/Kaba-Peaks-140-Family-A2.pdf b/referenceMaterial/Kaba-Peaks-140-Family-A2.pdf
diff --git a/referenceMaterial/Kaba-Peaks-140-Family-A4.pdf b/referenceMaterial/Kaba-Peaks-140-Family-A4.pdf
diff --git a/referenceMaterial/Kaba-Peaks-150-Family-A2.pdf b/referenceMaterial/Kaba-Peaks-150-Family-A2.pdf
diff --git a/referenceMaterial/Kaba-Peaks-150-Family-A4.pdf b/referenceMaterial/Kaba-Peaks-150-Family-A4.pdf
diff --git a/referenceMaterial/Locksmith-Ledger-Spacings-and-Depths-1979.pdf b/referenceMaterial/Locksmith-Ledger-Spacings-and-Depths-1979.pdf
diff --git a/referenceMaterial/Medeco-Biaxial.pdf b/referenceMaterial/Medeco-Biaxial.pdf
diff --git a/referenceMaterial/Medeco-Original-75-Series.pdf b/referenceMaterial/Medeco-Original-75-Series.pdf
diff --git a/referenceMaterial/Medeco-Original-Full-Step.pdf b/referenceMaterial/Medeco-Original-Full-Step.pdf
diff --git a/referenceMaterial/Medeco-Original-Half-Step.pdf b/referenceMaterial/Medeco-Original-Half-Step.pdf
diff --git a/referenceMaterial/Medeco-X4.pdf b/referenceMaterial/Medeco-X4.pdf
diff --git a/referenceMaterial/Medeco3-M3.pdf b/referenceMaterial/Medeco3-M3.pdf
diff --git a/referenceMaterial/Mul-T-Lock-Classic-and-Interactive.pdf b/referenceMaterial/Mul-T-Lock-Classic-and-Interactive.pdf
diff --git a/referenceMaterial/Residential & Comerical Depth and Space.pdf b/referenceMaterial/Residential & Comerical Depth and Space.pdf
diff --git a/referenceMaterial/SCHLAGE_KeySpecs.pdf b/referenceMaterial/SCHLAGE_KeySpecs.pdf
diff --git a/referenceMaterial/Sargent-Degree-DG1.pdf b/referenceMaterial/Sargent-Degree-DG1.pdf
diff --git a/referenceMaterial/Sargent-Degree-DG2-DG3.pdf b/referenceMaterial/Sargent-Degree-DG2-DG3.pdf
diff --git a/referenceMaterial/Sargent-Signature.pdf b/referenceMaterial/Sargent-Signature.pdf
diff --git a/referenceMaterial/Schlage-Primus-Primus-XP-Everest-Primus.pdf b/referenceMaterial/Schlage-Primus-Primus-XP-Everest-Primus.pdf
diff --git a/referenceMaterial/Schlage-SL29-Primus-Primus-XP-Everest-Primus.pdf b/referenceMaterial/Schlage-SL29-Primus-Primus-XP-Everest-Primus.pdf
diff --git a/referenceMaterial/Sidewinder-Key-Bitting-Reference-Guide-2014.pdf b/referenceMaterial/Sidewinder-Key-Bitting-Reference-Guide-2014.pdf
diff --git a/referenceMaterial/Spacing-Block-Chart.pdf b/referenceMaterial/Spacing-Block-Chart.pdf
diff --git a/referenceMaterial/Yale-KeyMark.pdf b/referenceMaterial/Yale-KeyMark.pdf
diff --git a/referenceMaterial/dwn-auto-truck-key-blank-reference-2022.pdf b/referenceMaterial/dwn-auto-truck-key-blank-reference-2022.pdf
diff --git a/referenceMaterial/dwn-construction-equipment-key-blank-reference.pdf b/referenceMaterial/dwn-construction-equipment-key-blank-reference.pdf
diff --git a/referenceMaterial/dwn-key-blank-directory---full.pdf b/referenceMaterial/dwn-key-blank-directory---full.pdf
diff --git a/referenceMaterial/dwn-motorcycle-guide-2022.pdf b/referenceMaterial/dwn-motorcycle-guide-2022.pdf
diff --git a/referenceMaterial/keymachinecutterguide.835150910.pdf b/referenceMaterial/keymachinecutterguide.835150910.pdf
diff --git a/referenceMaterial/motorcycle_guide.pdf b/referenceMaterial/motorcycle_guide.pdf
diff --git a/referenceMaterial/s-l1200.webp b/referenceMaterial/s-l1200.webp
diff --git a/referenceMaterial/sortedbydsdno.pdf b/referenceMaterial/sortedbydsdno.pdf
diff --git a/referenceMaterial/universal-manual.pdf b/referenceMaterial/universal-manual.pdf
diff --git a/referenceMaterial/usuAEsy_d.webp b/referenceMaterial/usuAEsy_d.webp
diff --git a/resources/X103-KW12.svg b/resources/X103-KW12.svg