Release 0.5

Enhancements ============ * RMS thread Fixes ===== * __THREADLIB_VERSION corrected Improvements ============ * docs
adrianschlatter · Apr 2, 2023 · 1ce399d · 1ce399d
2 parents f86d848 + bad6cbe
commit 1ce399d
Show file tree

Hide file tree

Showing 20 changed files with 70 additions and 34 deletions.
diff --git a/.gitignore b/.gitignore
@@ -7,14 +7,3 @@
 
 # Build
 design/THREAD_TABLE.csv
-
-# Files not intended for repository
-*.xcf
-*.xlsx
-*.stl
-renderall*.scad
-ASME*.pdf
-docs/*.png
-design/UIS.py
-*.afdesign
-experimental/
diff --git a/Makefile b/Makefile
@@ -5,6 +5,7 @@ design: clean
 	cat design/metric_thread.csv | awk -f design/metric_thread.awk >> design/THREAD_TABLE.csv
 	cat design/PCO_thread.csv | awk -f design/PCO_thread.awk >> design/THREAD_TABLE.csv
 	cat design/UIS_thread.csv | awk -f design/UIS_thread.awk >> design/THREAD_TABLE.csv
+	cat design/microscope_thread.csv | awk -f design/microscope_thread.awk >> design/THREAD_TABLE.csv
 	cat design/THREAD_TABLE.csv | awk -f design/autogenerate.awk > THREAD_TABLE.scad
 
 .PHONY: test
@@ -15,4 +16,8 @@ test:
 clean:
 	rm -f THREAD_TABLE.scad
 	rm -f design/THREAD_TABLE.csv
+	rm -f docs/img_prep/*.png
 
+.PHONY: img_prep
+img_prep:
+	@$(MAKE) -C docs/img_prep
diff --git a/THREAD_TABLE.scad b/THREAD_TABLE.scad
@@ -1899,4 +1899,6 @@ THREAD_TABLE = [["G1/16-ext", [0.907, 3.1631, 6.3625, [[0, -0.4252], [0, 0.4252]
 ["32-UN-3/4-int", [0.79375, -9.5551, 19.1033, [[0, 0.3473], [0, -0.3473], [0.4296, -0.0992], [0.4296, 0.0992]]]],
 ["32-UN-13/16-ext", [0.79375, 9.8517, 19.7103, [[0, -0.2977], [0, 0.2977], [0.4296, 0.0496], [0.4296, -0.0496]]]],
 ["32-UN-13/16-int", [0.79375, -10.3492, 20.6914, [[0, 0.3473], [0, -0.3473], [0.4296, -0.0992], [0.4296, 0.0992]]]],
+["RMS-ext", [0.7056, 9.5829, 19.1859, [[0.0, -0.3274], [0.0, 0.3273], [0.4932, 0.0706], [0.4932, -0.0706]]]],
+["RMS-int", [0.7055, -10.3042, 20.5085, [[0.0, 0.2630], [0.0, -0.2630], [0.4808, -0.0127], [0.4808, 0.0127]]]],
 ];
diff --git a/design/microscope_thread.awk b/design/microscope_thread.awk
@@ -0,0 +1,3 @@
+/^[^#]/ {
+	print $0;
+}
diff --git a/design/microscope_thread.csv b/design/microscope_thread.csv
@@ -0,0 +1,3 @@
+# Designator,Pitch,Rrot,Dsupport,r0,z0,r1,z1,r2,z2,r3,z3
+RMS-ext,0.7056,9.5829,19.1859,0.0,-0.3274,0.0,0.3273,0.4932,0.0706,0.4932,-0.0706
+RMS-int,0.7055,-10.3042,20.5085,0.0,0.2630,0.0,-0.2630,0.4808,-0.0127,0.4808,0.0127
diff --git a/CONTRIBUTING.md → docs/CONTRIBUTING.md b/CONTRIBUTING.md → docs/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-# How to contribute to threadlib
+# How to contribute
 
 Thank for considering a contribution to threadlib! Any help is greatly
 appreciated.
@@ -50,13 +50,15 @@ That's what we need the most! This is how to do it:
 
 * Convert these specs for use in threadlib:
 
-  * Find help on this topic in [Design of threadlib](docs/DesignOfThreadlib.md)
-    and [Creating Thread Specs](docs/CreatingThreadSpecs.md)
+  * Find help on this topic in [Design of threadlib](DesignOfThreadlib.md)
+    and [Creating Thread Specs](CreatingThreadSpecs.md)
 
-  * Use existing threads as examples. You find them beneath design/
+  * Use existing threads as examples. You find them in design/
+
+* Add a [unit test](UnitTests.md)
 
 * When done, proceed with a pull request (see "Did you write a patch?" above)
-  
+
 
 ## Final remarks
 

diff --git a/README.rst → docs/README.rst b/README.rst → docs/README.rst
@@ -1,4 +1,4 @@
-.. image:: docs/imgs/logo.png
+.. image:: imgs/logo.png
         :alt: bolt-in-nut logo
 
 threadlib is a library of standard threads for `OpenSCAD <https://www.openscad.org>`__.
@@ -21,7 +21,7 @@ Creating a thread is as simple as
         use <threadlib/threadlib.scad>
         thread("G1/2-ext", turns=10);
 
-.. image:: docs/imgs/thread-G1o2-ext-10turns.png
+.. image:: imgs/thread-G1o2-ext-10turns.png
         :alt: bolt-in-nut logo
 
 to create a British Standard Pipe parallel external thread. 
@@ -83,7 +83,7 @@ To create a bolt (without head) with 5 turns of M4 thread:
 
         bolt("M4", turns=5, higbee_arc=30);
 
-.. image:: docs/imgs/bolt-M4.png
+.. image:: imgs/bolt-M4.png
         :alt: Bolt with M4 thread
 
 See these nice lead-in / lead-out tapers? Try a nut (this time using the default
@@ -93,7 +93,7 @@ argument for higbee_arc):
 
         nut("M12x0.5", turns=10, Douter=16);
 
-.. image:: docs/imgs/nut-M12x0.5.png
+.. image:: imgs/nut-M12x0.5.png
         :alt: M12x0.5 nut
 
 Note that for a nut you also have to specify an outer diameter. The inner
@@ -108,7 +108,7 @@ threadlib's solution is to provide the tap module:
 
         tap("G1/2", turns=5);
 
-.. image:: docs/imgs/tap-G1o2.png
+.. image:: imgs/tap-G1o2.png
         :alt: G1/2 tap
 
 The tap shown above *is* intended for use like this and has accounted for the
@@ -131,7 +131,7 @@ If you only need the threads alone:
 
         thread("G1/2-ext", turns=5);
 
-.. image:: docs/imgs/thread-G1o2-ext.png
+.. image:: imgs/thread-G1o2-ext.png
         :alt: G1/2 external thread
 
 (Note: You need to specify whether you want internal ("-int") or external
@@ -147,7 +147,7 @@ case, a cylinder (which is what nut(...) uses):
         translate([0, 0, -P / 2])
             cylinder(h=H, d=Dsupport, $fn=120);
 
-.. image:: docs/imgs/flexible.png
+.. image:: imgs/flexible.png
         :alt: G1/2 bolt
 
 Here, we have used the function thread_specs(...) to look up the threads
@@ -167,7 +167,9 @@ Currently, threadlib knows these threads:
   G1/16 to G6. All threads are class A threads.
 - `PCO-1881
   <https://www.bevtech.org/assets/Committees/Packaging-Technology/20/3784253-20.pdf>`__
+  and `PCO-1810 <https://www.isbt.com/assets/Threadspecs/pco1810.pdf>`__
   (PET-bottle thread)
+- Royal Microscopical Society's Thread (RMS)
 
 
 Extensibility
@@ -188,11 +190,9 @@ add your own:
         thread("special", turns=15, table=MY_THREAD_TABLE);
 
 Care to share? Safe others from repeating the valuable work you have already
-accomplished and get the fame you deserve: Send in your tried and tested threads
-for addition to threadlib! See `Design of Threadlib <./docs/DesignOfThreadlib.md>`_
-for help on how to hack your own thread as shown above and
-`Creating Thread Specs <./docs/CreatingThreadSpecs.md>`_ for an introduction on how
-to contribute entire thread classes to threadlib.
+accomplished and get the fame you deserve: Send in your tried and tested
+threads for addition to threadlib! See `How to contribute <./CONTRIBUTING.md>`_
+for help on how to become a contributor.
 
 
 Still reading?
@@ -206,6 +206,7 @@ button is at the top of this website.)
 Change Log
 ===========================
 
+- 0.5: Royal Microscopical Society's thread (RMS)
 - 0.4: `PCO-1810 <https://www.isbt.com/assets/Threadspecs/pco1810.pdf>`__.
   tap module. Fixes bug with $fn in straight_thread(). Lists metric
   threads under short designator and full designator.

diff --git a/docs/Release.md b/docs/Release.md
@@ -0,0 +1,9 @@
+# Release
+
+* Update Changelog README.rst
+* Update Supported Threads in README.rst
+* Update __THREADLIB_VERSION() in threadlib.scad
+* Merge into master (--noff)
+* Tag commit (0.4)
+* Push
+* Create release on GitHub
diff --git a/docs/Makefile → docs/img_prep/Makefile b/docs/Makefile → docs/img_prep/Makefile
diff --git a/docs/bolt.scad → docs/img_prep/bolt.scad b/docs/bolt.scad → docs/img_prep/bolt.scad
diff --git a/docs/flexible.scad → docs/img_prep/flexible.scad b/docs/flexible.scad → docs/img_prep/flexible.scad
diff --git a/docs/nut.scad → docs/img_prep/nut.scad b/docs/nut.scad → docs/img_prep/nut.scad
diff --git a/docs/nutNbolt.scad → docs/img_prep/nutNbolt.scad b/docs/nutNbolt.scad → docs/img_prep/nutNbolt.scad
diff --git a/docs/tap.scad → docs/img_prep/tap.scad b/docs/tap.scad → docs/img_prep/tap.scad
diff --git a/docs/thread.scad → docs/img_prep/thread.scad b/docs/thread.scad → docs/img_prep/thread.scad
diff --git a/docs/imgs/logo_socialmedia.png b/docs/imgs/logo_socialmedia.png
diff --git a/docs/imgs/logo_socialmedia.psd b/docs/imgs/logo_socialmedia.psd
diff --git a/docs/marketing.md b/docs/marketing.md
@@ -0,0 +1,22 @@
+# What Others do with threadlib
+
+* [Naminukas](https://naminukas.kikaitachi.com), the indoor robot
+* [Vacuum Pen](https://www.prusaprinters.org/prints/30983-vacuum-pen-for-manual-smd-assembly) for manual SMD assembly
+* [Selector front-plate](https://www.prusaprinters.org/prints/77175-mmu2-selector-front-plate-with-direct-pc4m10) for a 3D-printer add-on
+* [Marking Mandrel](https://www.prusaprinters.org/prints/59885-ktmhqv-450500-marking-mandrel-pt-78129032000): Helpful tool to
+  re-assemble Husqvarna motor
+* [Handle knobs](https://www.thingiverse.com/thing:4582241) for doors
+* [Airbrush adapter](https://www.thingiverse.com/thing:4138696)
+* [Cookie stamps](https://www.thingiverse.com/thing:4752743)
+* [RC boat outboard motor](https://www.thingiverse.com/thing:4961385)
+* [Tool holder for Proxxon / Dremel drill press](https://www.thingiverse.com/thing:4484931)
+* [Mason jar blow-off lid](https://www.thingiverse.com/thing:4831014) for
+  beer fermenting
+* [Declination lock knob](https://www.thingiverse.com/thing:4236155) for
+      Meade telescopes
+
+
+# In the News
+
+* [Hackaday Podcast 076](https://hackaday.com/2020/07/17/hackaday-podcast-076-grinding-compression-screws-scratching-pcbs-and-melting-foam/#comments): They like about threadlib exactly what I made it for -
+  its simplicity.
diff --git a/tests/test_table.awk b/tests/test_table.awk
@@ -107,8 +107,8 @@ BEGIN	{
 	NR_OF_TESTS += 2;
 }
 
-/G.+-ext/ { 
-	# ext M threads have +/-62.5 deg slopes, horizontal crest / valley
+/(G.+-ext)|(RMS-ext)/ { 
+	# ext G- and RMS threads have +/-62.5 deg slopes, horizontal crest / valley
 	parse();
 	m1 = slope(v0, v3) / deg;
 	m2 = slope(v2, v1) / deg;
@@ -122,8 +122,8 @@ BEGIN	{
 	NR_OF_TESTS += 2;
 }
 
-/G.+-int/ { 
-	# int G threads have +/-62.5 deg slopes, horizontal crest / valley
+/(G.+-int)|(RMS-int)/ { 
+	# int G- and RMS threads have +/-62.5 deg slopes, horizontal crest / valley
 	parse();
 	m1 = slope(v3, v0) / deg;
 	m2 = slope(v1, v2) / deg;

diff --git a/threadlib.scad b/threadlib.scad
@@ -5,11 +5,11 @@ threadlib
 Create threads easily.
 
 :Author: Adrian Schlatter and contributors
-:Date: 2019-11-11
+:Date: 2023-04-02
 :License: 3-Clause BSD. See LICENSE.
 */
 
-function __THREADLIB_VERSION() = 0.3;
+function __THREADLIB_VERSION() = 0.5;
 
 use <thread_profile.scad>
 include <THREAD_TABLE.scad>