Set ngb for most library assemblies.

its parts into it parent's global BOM column.

docs/usage.md

@@ -172,7 +172,7 @@ This is achieved by having a pair of modules: -
     //! Place inserts in the bottom of the posts and push them home with a soldering iron with a conical bit heated to 200°C.
     //
     module handle_assembly() pose([225, 0, 150], [0, 0, 14]) //! Printed part with inserts in place
-    assembly("handle") {
+    assembly("handle", ngb = true) {
         translate_z(handle_height())
             stl_colour(pp1_colour) vflip() handle_stl();
 
@@ -201,6 +201,9 @@ When the parent assembly is shown exploded the handle's screws will be exploded
 Note also the `pose([225, 0, 150], [0, 0, 14])` call before the `assembly()` call. This allows the sub-assembly to be posed differently in its build step but doesn't
 affect its orientation in the parent assembly. The pose parameters are the rotation and the translation taken from the GUI.
 
+Setting `ngb = true` in the `assembly()` prevents the handle assembly appearing as a columun in the top level BOM in the build instructions.
+Instead its parts are merged into the parent BOM so the correct quantites are listed.
+
 ### Exploded diagrams
 
 A lot of vitamins explode themselves when `$explode=1`. This is done with module `explode()` that can be passed a Z offset, or a 3D vector that gives the displacement

examples/MainsBreakOutBox/bom/bom.json

@@ -2,6 +2,7 @@
     {
         "name": "base_assembly",
         "big": null,
+        "ngb": false,
         "count": 1,
         "assemblies": {},
         "vitamins": {
@@ -20,6 +21,7 @@
     {
         "name": "feet_assembly",
         "big": null,
+        "ngb": false,
         "count": 1,
         "assemblies": {
             "base_assembly": 1
@@ -46,6 +48,7 @@
     {
         "name": "mains_in_assembly",
         "big": null,
+        "ngb": false,
         "count": 1,
         "assemblies": {
             "feet_assembly": 1
@@ -82,6 +85,7 @@
     {
         "name": "main_assembly",
         "big": null,
+        "ngb": false,
         "count": 1,
         "assemblies": {
             "mains_in_assembly": 1

examples/MainsBreakOutBox/readme.md

@@ -15,6 +15,7 @@ Earth leakage can be measured Canadian CSA style by disconnected the neutral lin
 
 ![Main Assembly](assemblies/main_assembled.png)
 
+<span></span>
 
 ---
 ## Table of Contents
@@ -24,6 +25,7 @@ Earth leakage can be measured Canadian CSA style by disconnected the neutral lin
 1. [Mains In Assembly](#mains_in_assembly)
 1. [Main Assembly](#main_assembly)
 
+<span></span>
 [Top](#TOP)
 
 ---
@@ -54,6 +56,7 @@ Earth leakage can be measured Canadian CSA style by disconnected the neutral lin
 | &nbsp;&nbsp;1&nbsp; | &nbsp;&nbsp;.&nbsp; | &nbsp;&nbsp;.&nbsp; | &nbsp;&nbsp;.&nbsp; |  &nbsp;&nbsp;1&nbsp; | &nbsp;&nbsp;socket_box.stl |
 | &nbsp;&nbsp;1&nbsp; | &nbsp;&nbsp;4&nbsp; | &nbsp;&nbsp;.&nbsp; | &nbsp;&nbsp;.&nbsp; | &nbsp;&nbsp;5&nbsp; | &nbsp;&nbsp;Total 3D printed parts count |
 
+<span></span>
 [Top](#TOP)
 
 ---
@@ -81,6 +84,7 @@ Earth leakage can be measured Canadian CSA style by disconnected the neutral lin
 
 ![base_assembled](assemblies/base_assembled.png)
 
+<span></span>
 [Top](#TOP)
 
 ---
@@ -117,6 +121,7 @@ Earth leakage can be measured Canadian CSA style by disconnected the neutral lin
 
 ![feet_assembled](assemblies/feet_assembled.png)
 
+<span></span>
 [Top](#TOP)
 
 ---
@@ -156,6 +161,7 @@ Earth leakage can be measured Canadian CSA style by disconnected the neutral lin
 
 ![mains_in_assembled](assemblies/mains_in_assembled.png)
 
+<span></span>
 [Top](#TOP)
 
 ---
@@ -199,4 +205,5 @@ Earth leakage can be measured Canadian CSA style by disconnected the neutral lin
 
 ![main_assembled](assemblies/main_assembled.png)
 
+<span></span>
 [Top](#TOP)

printed/camera_housing.scad

@@ -284,7 +284,7 @@ module camera_bracket(cam) { //! Make the STL for the camera bracket
 }
 
 module camera_assembly(cam, angle = 0) //! Camera case assembly
-assembly(str("camera_", cam[0])) {
+assembly(str("camera_", cam[0]), ngb = true) {
     front = cam_front_size(cam);
     screw = pcb_screw(camera_pcb(cam));
     nut = screw_nut(screw);

printed/corner_block.scad

@@ -117,7 +117,7 @@ module corner_block(screw = def_screw, name = false) { //! Generate the STL for
 }
 
 module corner_block_assembly(screw = def_screw, name = false) //! The printed block with inserts
-assembly(str("corner_block_M", 20 * screw_radius(screw))) {
+assembly(str("corner_block_M", 20 * screw_radius(screw)), ngb = true) {
     insert = screw_insert(screw);
 
     stl_colour(name ? pp2_colour : pp1_colour)

printed/drag_chain.scad

@@ -311,7 +311,7 @@ module _drag_chain_assembly(type, pos = 0, render = false) {
 //! 1. Remove the support material from the links with side cutters.
 //! 1. Clip the links together with the special ones at the ends.
 module drag_chain_assembly(type, pos = 0, render = false)  //! Drag chain assembly
-    assembly(str(drag_chain_name(type), "_drag_chain"), big = true)
+    assembly(str(drag_chain_name(type), "_drag_chain"), big = true, ngb = true)
         if($children == 2)
             _drag_chain_assembly(type, pos, render) {
                 children(0);

printed/fixing_block.scad

@@ -106,7 +106,7 @@ module fixing_block(screw = def_screw) { //! Generate the STL
 }
 
 module fixing_block_assembly(screw = def_screw) pose([55, 180, 25], [0, 4.8, 4.8]) //! Printed part with the inserts inserted
-assembly(str("fixing_block_M", 20 * screw_radius(screw))) {
+assembly(str("fixing_block_M", 20 * screw_radius(screw)), ngb = true) {
     translate_z(fixing_block_height(screw))
         rotate([0, 180, 0])
             stl_colour(pp1_colour) render() fixing_block(screw);

printed/flat_hinge.scad

@@ -129,7 +129,7 @@ module hinge_both(type) { //! Both parts together for printing
 }
 
 module hinge_assembly(type, angle = 0)
-assembly(str("hinge_", type[0])) { //! Assembled hinge
+assembly(str("hinge_", type[0]), ngb = true) { //! Assembled hinge
     kr = hinge_knuckle_dia(type) / 2;
     hr = hinge_pin_dia(type) / 2;
     w = hinge_width(type);

printed/foot.scad

@@ -132,7 +132,7 @@ module insert_foot(type = insert_foot) { //! Generate STL for foot with insert
 //! Place the insert in the bottom of the foot and push home with a soldering iron with a conical bit heated to 200°C.
 //
 module insert_foot_assembly(type = insert_foot) //! Printed part with insert in place
-assembly("insert_foot") {
+assembly("insert_foot", ngb = true) {
     screw = foot_screw(type);
     insert = screw_insert(screw);
 

printed/handle.scad

@@ -81,7 +81,7 @@ module handle_stl() { //! generate the STL
 //! Place inserts in the bottom of the posts and push them home with a soldering iron with a conical bit heated to 200°C.
 //
 module handle_assembly() pose([225, 0, 150], [0, 0, 14]) //! Printed part with inserts in place
-assembly("handle") {
+assembly("handle", ngb = true) {
     translate_z(handle_height())
         stl_colour(pp1_colour) vflip() handle_stl();
 

printed/printed_pulleys.scad

@@ -180,7 +180,7 @@ module printed_pulley(type) { //! Draw a printable pulley
 }
 
 module printed_pulley_assembly(type, colour = pp1_colour) //! Draw a printed pulley with its grub screws in place
-assembly(str("printed_pulley_", type[0])) {
+assembly(str("printed_pulley_", type[0]), ngb = true) {
     translate_z(pulley_offset(type)) {
         stl_colour(colour)
             if(printed_pulley_inverted(type))

printed/psu_shroud.scad

@@ -143,7 +143,7 @@ module psu_shroud(type, cable_d, name, cables = 1) { //! Generate the STL file f
  }
 
 module psu_shroud_assembly(type, cable_d, name, cables = 1) //! The printed parts with inserts fitted
-assembly(str("PSU_shroud_", name)) {
+assembly(str("PSU_shroud_", name), ngb = true) {
 
     translate_z(psu_shroud_height(type))
         vflip()

printed/ribbon_clamp.scad

@@ -82,7 +82,7 @@ module ribbon_clamp(ways, screw = screw) { //! Generate STL for given number of
 }
 
 module ribbon_clamp_assembly(ways, screw = screw) pose([55, 180, 25])  //! Printed part with inserts in place
-    assembly(let(screw_d = screw_radius(screw) * 2)str("ribbon_clamp_", ways, screw_d != 3 ? str("_", screw_d) : "")) {
+    assembly(let(screw_d = screw_radius(screw) * 2)str("ribbon_clamp_", ways, screw_d != 3 ? str("_", screw_d) : ""), ngb = true) {
     h = ribbon_clamp_height(screw);
     insert = screw_insert(screw);
 

printed/screw_knob.scad

@@ -59,7 +59,7 @@ module screw_knob(screw) { //! Generate the STL for a knob to fit the specified
 
 //! Place the screw through the printed part
 module screw_knob_assembly(screw, length) //! Assembly with the screw in place
-assembly(str("screw_knob_M", 20 * screw_radius(screw), "_", length)) {
+assembly(str("screw_knob_M", 20 * screw_radius(screw), "_", length), ngb = true) {
     translate_z(knob_height)
         vflip()
             stl_colour(pp1_colour) screw_knob(screw);

printed/ssr_shroud.scad

@@ -107,7 +107,7 @@ module ssr_shroud(type, cable_d, name) {    //! Generate the STL file for a spec
 }
 
 module ssr_shroud_assembly(type, cable_d, name) //! The printed parts with inserts fitted
-assembly(str("SSR_shroud_", name)) {
+assembly(str("SSR_shroud_", name), ngb = true) {
 
     translate_z(ssr_shroud_height(type))
         vflip()

printed/strap_handle.scad

@@ -162,7 +162,7 @@ module strap_end(type = strap) { //! Generate the STL for end piece
 //! * Place the insert into the hole and push home with a soldering iron with a tapered bit heated to 200°C.
 //
 module strap_end_assembly(type = strap)
-assembly("strap_end") {
+assembly("strap_end", ngb = true) {
     stl_colour(pp1_colour)
         strap_end(type);
 

readme.md

@@ -1750,7 +1750,11 @@ UK 13A sockets at the moment.
 ---
 <a name="Microswitches"></a>
 ## Microswitches
-Used for limit switches.
+Used for limit switches. Currently only the button type is supported as the lever and roller types are less accurate.
+
+The switch is drawn with the button at the nominal operation point. This can be plus or minus `microswitch_op_tol(type)`.
+
+When the button is released it comes out by a maximum of `microswitch_fp_max(type)` from the nominal operating point.
 
 [vitamins/microswitches.scad](vitamins/microswitches.scad) Object definitions.
 
@@ -1763,14 +1767,16 @@ Used for limit switches.
 |:--- |:--- |
 | `microswitch_body_clr(type)` | Body colour |
 | `microswitch_button_clr(type)` | Button colour |
-| `microswitch_button_pos(type)` | Button position |
+| `microswitch_button_pos(type)` | Button position at operating point |
 | `microswitch_button_t(type)` | Button thickness |
 | `microswitch_button_w(type)` | Button width |
+| `microswitch_fp_max(type)` | Free position maximum |
 | `microswitch_hole_d(type)` | Screw hole diameter |
 | `microswitch_holes(type)` | Hole positions |
 | `microswitch_leg(type)` | Leg types |
 | `microswitch_legs(type)` | Leg positions |
 | `microswitch_length(type)` | Body length |
+| `microswitch_op_tol(type)` | Operating position +/- tolerance |
 | `microswitch_radius(type)` | Body corner radius |
 | `microswitch_thickness(type)` | Body thickness |
 | `microswitch_width(type)` | Body width |
@@ -2612,8 +2618,8 @@ Timing belt pulleys, both toothed and plain with internal bearings for idlers.
 ### Modules
 | Module | Description |
 |:--- |:--- |
-| `pulley(type)` | Draw a pulley |
-| `pulley_assembly(type)` | Draw a pulley with its grub screws in place |
+| `pulley(type, colour = silver)` | Draw a pulley |
+| `pulley_assembly(type, colour = silver)` | Draw a pulley with its grub screws in place |
 
 ![pulleys](tests/png/pulleys.png)
 
@@ -2948,6 +2954,7 @@ For an explanation of `screw_polysink()` see <https://hydraraptor.blogspot.com/2
 |   1 | `screw(M4_pan_screw, 30)` |  Screw M4 pan x 30mm |
 |   1 | `screw(M5_cap_screw, 30)` |  Screw M5 cap x 30mm |
 |   1 | `screw(M5_cs_cap_screw, 30)` |  Screw M5 cs cap x 30mm |
+|   1 | `screw(M5_dome_screw, 30)` |  Screw M5 dome x 30mm |
 |   1 | `screw(M5_hex_screw, 30)` |  Screw M5 hex x 30mm |
 |   1 | `screw(M5_pan_screw, 30)` |  Screw M5 pan x 30mm |
 |   1 | `screw(M6_cap_screw, 30)` |  Screw M6 cap x 30mm |
@@ -3802,7 +3809,7 @@ Veroboard with mounting holes, track breaks, removed tracks, solder points and c
 | `vero_mounting_hole_positions(type)` | Positions children at the mounting holes |
 | `vero_mounting_holes(type, h = 100)` | Drill mounting holes in a panel |
 | `veroboard(type)` | Draw specified veroboard with missing tracks and track breaks |
-| `veroboard_assembly(type, height, thickness, flip = false)` | Draw the assembly with components and fasteners in place |
+| `veroboard_assembly(type, height, thickness, flip = false, ngb = false)` | Draw the assembly with components and fasteners in place |
 
 ![veroboard](tests/png/veroboard.png)
 
@@ -5996,6 +6003,9 @@ Assembly views shown in the instructions can be large or small and this is deduc
 parts are used.
 This heuristic isn't always correct, so the default can be overridden by setting the `big` parameter of `assembly` to `true` or `false`.
 
+Setting the `ngb` parameter of `assembly` to `true` removes its column from the global BOM and merges it parts into its parent assembly column of the global BOM.
+This is to prevent the global BOM page becoming too wide in large projects by having it include just the major assemblies.
+
 The example below shows how to define a vitamin and incorporate it into an assembly with sub-assemblies and make an exploded view.
 The resulting flat BOM is shown but heirachical BOMs are also generated for real projects.
 
@@ -6015,7 +6025,7 @@ The resulting flat BOM is shown but heirachical BOMs are also generated for real
 ### Modules
 | Module | Description |
 |:--- |:--- |
-| `assembly(name, big = undef)` | Name an assembly that will appear on the BOM, there needs to a module named `<name>_assembly` to make it. `big` can force big or small assembly diagrams. |
+| `assembly(name, big = undef, ngb = false)` | Name an assembly that will appear on the BOM, there needs to a module named `<name>_assembly` to make it. `big` can force big or small assembly diagrams. |
 | `dxf(name)` | Name a dxf that will appear on the BOM, there needs to a module named `<name>_dxf` to make it |
 | `explode(d, explode_children = false, offset = [0,0,0])` | Explode children by specified Z distance or vector `d`, option to explode grand children |
 | `hidden()` | Make item invisible, except on the BOM |

scripts/bom.py

@@ -60,6 +60,7 @@ class BOM:
     def __init__(self, name):
         self.name = name
         self.big = None
+        self.ngb = False
         self.count = 1
         self.vitamins = {}
         self.printed = {}
@@ -73,6 +74,7 @@ class BOM:
         return {
              "name"       : self.name,
              "big"        : self.big,
+             "ngb"        : self.ngb,
              "count"      : self.count,
              "assemblies" : assemblies,
              "vitamins"   : {v : self.vitamins[v].data() for v in self.vitamins},

scripts/views.py

@@ -36,6 +36,7 @@ import blurb
 import bom
 import shutil
 import re
+import copy
 from colorama import Fore
 
 def is_assembly(s):
@@ -74,19 +75,17 @@ def bom_to_assemblies(bom_dir, bounds_map):
     # Remove the main assembly if it is a shell
     #
     if flat_bom:
-        ass =  flat_bom[-1]
+        ass = flat_bom[-1]
         if len(ass["assemblies"]) < 2 and not ass["vitamins"] and not ass["printed"] and not ass["routed"]:
             flat_bom = flat_bom[:-1]
     return [assembly["name"] for  assembly in flat_bom]
 
-def eop(print_mode, doc_file, last = False, first = False):
-    if print_mode:
-         print('\n<div style="page-break-after: always;"></div>', file = doc_file)
-    else:
-        if not first:
-            print('[Top](#TOP)',   file = doc_file)
-        if not last:
-            print("\n---", file = doc_file)
+def eop(doc_file, last = False, first = False):
+    print('<span></span>', file = doc_file)     # An invisable marker for page breaks because markdown takes much longer if the document contains a div
+    if not first:
+        print('[Top](#TOP)', file = doc_file)
+    if not last:
+        print("\n---", file = doc_file)
 
 def pad(s, before, after = 0):
     return '&nbsp;' * before + str(s) + '&nbsp;' * after
@@ -103,6 +102,27 @@ def usage():
     print("\nusage:\n\t views [target_config] [<name1>_assembly] ... [<nameN>_assembly] - Create assembly images and readme.")
     sys.exit(1)
 
+types = ["vitamins", "printed", "routed"]
+
+def merged(bom):
+    bom = copy.deepcopy(bom)
+    for aname in bom["assemblies"]:
+        count = bom["assemblies"][aname]
+        for ass in flat_bom:
+            if ass['name'] == aname and ass['ngb']:
+                merged_assembly = merged(ass)
+                total = ass['count']
+                for t in types:
+                    for thing in merged_assembly[t]:
+                        items = merged_assembly[t][thing]['count'] * count // total
+                        if thing in bom[t]:
+                            bom[t][thing]['count'] += items
+                        else:
+                            bom[t][thing] = merged_assembly[t][thing]
+                            bom[t][thing]['count'] = items
+                break
+    return bom
+
 def views(target, do_assemblies = None):
     done_assemblies = []
     #
@@ -202,193 +222,217 @@ def views(target, do_assemblies = None):
                                     if module == 'main_assembly':
                                         main_blurb = blurb.scrape_module_blurb(lines[:line_no])
                         line_no += 1
-    times.print_times()
     #
     # Build the document
     #
-    for print_mode in [True, False]:
-        doc_name = top_dir + "readme.md"
-        with open(doc_name, "wt") as doc_file:
-            #
-            # Title, description and picture
-            #
-            project = ' '.join(word[0].upper() + word[1:] for word in os.path.basename(os.getcwd()).split('_'))
-            print('<a name="TOP"></a>\n# %s' % project, file = doc_file)
-            main_file = bom.find_scad_file('main_assembly')
-            if not main_file:
-                raise Exception("can't find source for main_assembly")
-            text = blurb.scrape_blurb(source_dir + '/' + main_file)
-            blurbs = blurb.split_blurb(text)
-            if len(text):
-                print(blurbs[0], file = doc_file)
-            else:
-                if print_mode:
-                    print(Fore.MAGENTA + "Missing project description" + Fore.WHITE)
-            #
-            # Only add the image if the first blurb section doesn't contain one.
-            #
-            if not re.search(r'\!\[.*\]\(.*\)', blurbs[0], re.MULTILINE):
-                print('![Main Assembly](assemblies/%s.png)\n' % flat_bom[-1]["name"].replace('_assembly', '_assembled'), file = doc_file)
-            eop(print_mode, doc_file, first = True)
-            #
-            # Build TOC
-            #
-            print('## Table of Contents', file = doc_file)
-            print('1. [Parts list](#Parts_list)', file = doc_file)
-            for ass in flat_bom:
-                name =  ass["name"]
-                cap_name = titalise(name)
-                print('1. [%s](#%s)' % (cap_name, name), file = doc_file)
-            print(file = doc_file)
-            if len(blurbs) > 1:
-                print(blurbs[1], file = doc_file)
-            eop(print_mode, doc_file)
-            #
-            # Global BOM
-            #
-            print('<a name="Parts_list"></a>\n## Parts list', file = doc_file)
-            types = ["vitamins", "printed", "routed"]
-            headings = {"vitamins" : "vitamins", "printed" : "3D printed parts", "routed" : "CNC routed parts"}
-            things = {}
+    doc_name = top_dir + "readme.md"
+    with open(doc_name, "wt") as doc_file:
+        #
+        # Title, description and picture
+        #
+        project = ' '.join(word[0].upper() + word[1:] for word in os.path.basename(os.getcwd()).split('_'))
+        print('<a name="TOP"></a>', file = doc_file)
+        print('# %s' % project, file = doc_file)
+        main_file = bom.find_scad_file('main_assembly')
+        if not main_file:
+            raise Exception("can't find source for main_assembly")
+        text = blurb.scrape_blurb(source_dir + '/' + main_file)
+        blurbs = blurb.split_blurb(text)
+        if len(text):
+            print(blurbs[0], file = doc_file)
+        else:
+            print(Fore.MAGENTA + "Missing project description" + Fore.WHITE)
+        #
+        # Only add the image if the first blurb section doesn't contain one.
+        #
+        if not re.search(r'\!\[.*\]\(.*\)', blurbs[0], re.MULTILINE):
+            print('![Main Assembly](assemblies/%s.png)\n' % flat_bom[-1]["name"].replace('_assembly', '_assembled'), file = doc_file)
+        eop(doc_file, first = True)
+        #
+        # Build TOC
+        #
+        print('## Table of Contents', file = doc_file)
+        print('1. [Parts list](#Parts_list)', file = doc_file)
+        for ass in flat_bom:
+            name =  ass["name"]
+            cap_name = titalise(name)
+            print('1. [%s](#%s)' % (cap_name, name), file = doc_file)
+        print(file = doc_file)
+        if len(blurbs) > 1:
+            print(blurbs[1], file = doc_file)
+        eop(doc_file)
+        #
+        # Global BOM
+        #
+        global_bom = [merged(ass) for ass in flat_bom if not ass['ngb']]
+        print('<a name="Parts_list"></a>\n## Parts list', file = doc_file)
+        headings = {"vitamins" : "vitamins", "printed" : "3D printed parts", "routed" : "CNC routed parts"}
+        things = {}
+        for t in types:
+            things[t] = {}
+        for ass in flat_bom:
             for t in types:
-                things[t] = {}
-            for ass in flat_bom:
-                for t in types:
-                    for thing in ass[t]:
-                        if thing in things[t]:
-                            things[t][thing] += ass[t][thing]["count"]
-                        else:
-                            things[t][thing] = ass[t][thing]["count"]
-            for ass in flat_bom:
-                name = titalise(ass["name"][:-9]).replace(' ','&nbsp;')
-                print('| <span style="writing-mode: vertical-rl; text-orientation: mixed;">%s</span> ' % name, file = doc_file, end = '')
-            print('| <span style="writing-mode: vertical-rl; text-orientation: mixed;">TOTALS</span> |  |', file = doc_file)
+                for thing in ass[t]:
+                    if thing in things[t]:
+                        things[t][thing] += ass[t][thing]["count"]
+                    else:
+                        things[t][thing] = ass[t][thing]["count"]
+        for ass in global_bom:
+            name = titalise(ass["name"][:-9]).replace(' ','&nbsp;')
+            if ass["count"] > 1:
+                name = "%d x %s" % (ass["count"], name)
+            print('| <span style="writing-mode: vertical-rl; text-orientation: mixed;">%s</span> ' % name, file = doc_file, end = '')
+        print('| <span style="writing-mode: vertical-rl; text-orientation: mixed;">TOTALS</span> |  |', file = doc_file)
+        print(('|---:' * len(global_bom) + '|---:|:---|'), file = doc_file)
 
-            print(('|---:' * len(flat_bom) + '|---:|:---|'), file = doc_file)
-
-            for t in types:
-                if things[t]:
-                    totals = {}
-                    heading = headings[t][0:1].upper() + headings[t][1:]
-                    print(('|  ' * len(flat_bom) + '| | **%s** |') % heading, file = doc_file)
-                    for thing in sorted(things[t], key = lambda s: s.split(":")[-1]):
-                        for ass in flat_bom:
-                            count = ass[t][thing]["count"] if thing in ass[t] else 0
-                            print('| %s ' % pad(count if count else '.', 2, 1), file = doc_file, end = '')
-                            name = ass["name"]
-                            if name in totals:
-                                totals[name] += count
-                            else:
-                                totals[name] = count
-                        print('|  %s | %s |' % (pad(things[t][thing], 2, 1), pad(thing.split(":")[-1], 2)), file = doc_file)
-
-                    grand_total = 0
-                    for ass in flat_bom:
+        for t in types:
+            if things[t]:
+                totals = {}
+                grand_total2 = 0
+                heading = headings[t][0].upper() + headings[t][1:]
+                print(('|  ' * len(global_bom) + '| | **%s** |') % heading, file = doc_file)
+                for thing in sorted(things[t], key = lambda s: s.split(":")[-1]):
+                    for ass in global_bom:
+                        count = ass[t][thing]["count"] if thing in ass[t] else 0
+                        print('| %s ' % pad(count if count else '.', 2, 1), file = doc_file, end = '')
                         name = ass["name"]
-                        total = totals[name] if name in totals else 0
-                        print('| %s ' % pad(total if total else '.', 2, 1), file = doc_file, end = '')
-                        grand_total += total
-                    print("| %s | %s |" % (pad(grand_total, 2, 1), pad('Total %s count' % headings[t], 2)), file = doc_file)
+                        if name in totals:
+                            totals[name] += count
+                        else:
+                            totals[name] = count
+                        grand_total2 += count
+                    print('|  %s | %s |' % (pad(things[t][thing], 2, 1), pad(thing.split(":")[-1], 2)), file = doc_file)
 
-            print(file = doc_file)
-            if len(blurbs) > 2:
-                print(blurbs[2], file = doc_file)
-            eop(print_mode, doc_file)
-            #
-            # Assembly instructions
-            #
-            for ass in flat_bom:
-                name = ass["name"]
-                cap_name = titalise(name)
-
-                if ass["count"] > 1:
-                    print('<a name="%s"></a>\n## %d x %s' % (name, ass["count"], cap_name), file = doc_file)
-                else:
-                    print('<a name="%s"></a>\n## %s' % (name, cap_name), file = doc_file)
-                vitamins = ass["vitamins"]
-                if vitamins:
-                    print("### Vitamins",         file = doc_file)
-                    print("|Qty|Description|",    file = doc_file)
-                    print("|---:|:----------|",    file = doc_file)
-                    for v in sorted(vitamins, key = lambda s: s.split(":")[-1]):
-                        print("|%d|%s|" % (vitamins[v]["count"], v.split(":")[1]),     file = doc_file)
-                    print("\n", file = doc_file)
-
-                printed = ass["printed"]
-                if printed:
-                    print('### 3D Printed parts', file = doc_file)
-                    keys = sorted(list(printed.keys()))
-                    for i, p in enumerate(keys):
-                        print('%s %d x %s |' % ('\n|' if not (i % 3) else '', printed[p]["count"], p), file = doc_file, end = '')
-                        if (i % 3) == 2 or i == len(printed) - 1:
-                            n = (i % 3) + 1
-                            print('\n|%s' % ('---|' * n), file =  doc_file)
-                            for j in range(n):
-                                part = keys[i - n + j + 1]
-                                print('| ![%s](stls/%s) %s' % (part, part.replace('.stl','.png'), '|\n' if j == j - 1 else ''), end = '', file = doc_file)
-                            print('\n', file = doc_file)
-                    print('\n', file  = doc_file)
-
-                routed = ass["routed"]
-                if routed:
-                    print("### CNC Routed parts", file = doc_file)
-                    keys = sorted(list(routed.keys()))
-                    for i, r in enumerate(keys):
-                        print('%s %d x %s |' % ('\n|' if not (i % 3) else '', routed[r]["count"], r), file = doc_file, end = '')
-                        if (i % 3) == 2 or i == len(routed) - 1:
-                            n = (i % 3) + 1
-                            print('\n|%s' % ('---|' * n), file =  doc_file)
-                            for j in range(n):
-                                part = keys[i - n + j + 1]
-                                print('| ![%s](dxfs/%s) %s' % (part, part.replace('.dxf','.png'), '|\n' if j == j - 1 else ''), end = '', file = doc_file)
-                            print('\n', file = doc_file)
-                    print('\n', file  = doc_file)
-
-                sub_assemblies = ass["assemblies"]
-                if sub_assemblies:
-                    print("### Sub-assemblies", file = doc_file)
-                    keys = sorted(list(sub_assemblies.keys()))
-                    for i, a in enumerate(keys):
-                        print('%s %d x %s |' % ('\n|' if not (i % 3) else '', sub_assemblies[a], a), file = doc_file, end = '')
-                        if (i % 3) == 2 or i == len(keys) - 1:
-                            n = (i % 3) + 1
-                            print('\n|%s' % ('---|' * n), file =  doc_file)
-                            for j in range(n):
-                                a = keys[i - n + j + 1].replace('_assembly', '_assembled')
-                                print('| ![%s](assemblies/%s) %s' % (a, a + '_tn.png', '|\n' if j == j - 1 else ''), end = '', file = doc_file)
-                            print('\n', file = doc_file)
-                    print('\n', file  = doc_file)
-
-                small = not ass["big"]
-                suffix = '_tn.png' if small else '.png'
-                print('### Assembly instructions', file = doc_file)
-                print('![%s](assemblies/%s)\n' % (name, name + suffix), file = doc_file)
-
-                if "blurb" in ass and ass["blurb"]:
-                    print(ass["blurb"], file = doc_file)
-                else:
-                    if print_mode:
-                        print(Fore.MAGENTA + "Missing instructions for %s" % name, Fore.WHITE)
-
-                name = name.replace('_assembly', '_assembled')
-                print('![%s](assemblies/%s)\n' % (name, name + suffix), file = doc_file)
-                eop(print_mode, doc_file, last = ass == flat_bom[-1] and not main_blurb)
-            #
-            # If main module is suppressed print any blurb here
-            #
-            if main_blurb:
-                print(main_blurb, file = doc_file)
-                eop(print_mode, doc_file, last = True)
+                grand_total = 0
+                for ass in global_bom:
+                    name = ass["name"]
+                    total = totals[name] if name in totals else 0
+                    print('| %s ' % pad(total if total else '.', 2, 1), file = doc_file, end = '')
+                    grand_total += total
+                print("| %s | %s |" % (pad(grand_total, 2, 1), pad('Total %s count' % headings[t], 2)), file = doc_file)
+                assert grand_total == grand_total2
+        print(file = doc_file)
+        if len(blurbs) > 2:
+            print(blurbs[2], file = doc_file)
+        eop(doc_file)
         #
-        # Convert to HTML
+        # Assembly instructions
         #
-        html_name = "printme.html" if print_mode else "readme.html"
-        with open(top_dir + html_name, "wt") as html_file:
-            do_cmd(("python -m markdown -x tables -x sane_lists " + doc_name).split(), html_file)
+        for ass in flat_bom:
+            name = ass["name"]
+            cap_name = titalise(name)
+
+            print('<a name="%s"></a>' % name, file = doc_file)
+            if ass["count"] > 1:
+                print('## %d x %s' % (ass["count"], cap_name), file = doc_file)
+            else:
+                print('## %s' % cap_name, file = doc_file)
+            vitamins = ass["vitamins"]
+            if vitamins:
+                print("### Vitamins",         file = doc_file)
+                print("|Qty|Description|",    file = doc_file)
+                print("|---:|:----------|",    file = doc_file)
+                for v in sorted(vitamins, key = lambda s: s.split(":")[-1]):
+                    print("|%d|%s|" % (vitamins[v]["count"], v.split(":")[1]),     file = doc_file)
+                print("\n", file = doc_file)
+
+            printed = ass["printed"]
+            if printed:
+                print('### 3D Printed parts', file = doc_file)
+                keys = sorted(list(printed.keys()))
+                for i, p in enumerate(keys):
+                    print('%s %d x %s |' % ('\n|' if not (i % 3) else '', printed[p]["count"], p), file = doc_file, end = '')
+                    if (i % 3) == 2 or i == len(printed) - 1:
+                        n = (i % 3) + 1
+                        print('\n|%s' % ('---|' * n), file =  doc_file)
+                        for j in range(n):
+                            part = keys[i - n + j + 1]
+                            print('| ![%s](stls/%s) %s' % (part, part.replace('.stl','.png'), '|\n' if j == j - 1 else ''), end = '', file = doc_file)
+                        print('\n', file = doc_file)
+                print('\n', file  = doc_file)
+
+            routed = ass["routed"]
+            if routed:
+                print("### CNC Routed parts", file = doc_file)
+                keys = sorted(list(routed.keys()))
+                for i, r in enumerate(keys):
+                    print('%s %d x %s |' % ('\n|' if not (i % 3) else '', routed[r]["count"], r), file = doc_file, end = '')
+                    if (i % 3) == 2 or i == len(routed) - 1:
+                        n = (i % 3) + 1
+                        print('\n|%s' % ('---|' * n), file =  doc_file)
+                        for j in range(n):
+                            part = keys[i - n + j + 1]
+                            print('| ![%s](dxfs/%s) %s' % (part, part.replace('.dxf','.png'), '|\n' if j == j - 1 else ''), end = '', file = doc_file)
+                        print('\n', file = doc_file)
+                print('\n', file  = doc_file)
+
+            sub_assemblies = ass["assemblies"]
+            if sub_assemblies:
+                print("### Sub-assemblies", file = doc_file)
+                keys = sorted(list(sub_assemblies.keys()))
+                for i, a in enumerate(keys):
+                    print('%s %d x %s |' % ('\n|' if not (i % 3) else '', sub_assemblies[a], a), file = doc_file, end = '')
+                    if (i % 3) == 2 or i == len(keys) - 1:
+                        n = (i % 3) + 1
+                        print('\n|%s' % ('---|' * n), file =  doc_file)
+                        for j in range(n):
+                            a = keys[i - n + j + 1].replace('_assembly', '_assembled')
+                            print('| ![%s](assemblies/%s) %s' % (a, a + '_tn.png', '|\n' if j == j - 1 else ''), end = '', file = doc_file)
+                        print('\n', file = doc_file)
+                print('\n', file  = doc_file)
+
+            small = not ass["big"]
+            suffix = '_tn.png' if small else '.png'
+            print('### Assembly instructions', file = doc_file)
+            print('![%s](assemblies/%s)\n' % (name, name + suffix), file = doc_file)
+
+            if "blurb" in ass and ass["blurb"]:
+                print(ass["blurb"], file = doc_file)
+            else:
+                print(Fore.MAGENTA + "Missing instructions for %s" % name, Fore.WHITE)
+
+            name = name.replace('_assembly', '_assembled')
+            print('![%s](assemblies/%s)\n' % (name, name + suffix), file = doc_file)
+            eop(doc_file, last = ass == flat_bom[-1] and not main_blurb)
+        #
+        # If main module is suppressed print any blurb here
+        #
+        if main_blurb:
+            print(main_blurb, file = doc_file)
+            eop(doc_file, last = True)
+    #
+    # Convert to HTML
+    #
+    html_name = 'readme.html'
+    t = time.time()
+    with open(top_dir + html_name, "wt") as html_file:
+        do_cmd(("python -m markdown -x tables -x sane_lists " + doc_name).split(), html_file)
+    times.add_time(top_dir + html_name, t)
+    times.print_times()
+    #
+    # Make the printme.html by replacing empty spans that invisbly mark the page breaks by page break divs.
+    #
+    with open(top_dir + 'readme.html', 'rt') as src:
+        lines = src.readlines()
+
+    i = 0
+    with open(top_dir + 'printme.html', 'wt') as dst:
+        while i < len(lines):
+            line = lines[i]
+            if line.startswith('<p><span></span>'):                # Empty span used to mark page breaks
+                i += 1
+                if lines[i].startswith('<a href="#TOP">Top</a>'):  # The first page break won't have one
+                    i += 1
+                if i < len(lines) and lines[i] == '<hr />\n':      # The last page break doesn't have one
+                    dst.write('<div style="page-break-after: always;"></div>\n')
+                    i += 1
+            else:
+                dst.write(line)
+                i += 1
     #
     # Spell check
     #
-    do_cmd('codespell -L od readme.md'.split())
+    do_cmd(('codespell -L od ' + top_dir + 'readme.md').split())
     #
     # List the ones we didn't find
     #

utils/core/bom.scad

@@ -25,6 +25,9 @@
 //! parts are used.
 //! This heuristic isn't always correct, so the default can be overridden by setting the `big` parameter of `assembly` to `true` or `false`.
 //!
+//! Setting the `ngb` parameter of `assembly` to `true` removes its column from the global BOM and merges it parts into its parent assembly column of the global BOM.
+//! This is to prevent the global BOM page becoming too wide in large projects by having it include just the major assemblies.
+//!
 //! The example below shows how to define a vitamin and incorporate it into an assembly with sub-assemblies and make an exploded view.
 //! The resulting flat BOM is shown but heirachical BOMs are also generated for real projects.
 //
@@ -84,9 +87,9 @@ module pose_vflip(exploded = undef)       //! Pose an STL or assembly for render
                 children();
 
 
-module assembly(name, big = undef) {    //! Name an assembly that will appear on the BOM, there needs to a module named `<name>_assembly` to make it. `big` can force big or small assembly diagrams.
+module assembly(name, big = undef, ngb = false) {    //! Name an assembly that will appear on the BOM, there needs to a module named `<name>_assembly` to make it. `big` can force big or small assembly diagrams.
     if(bom_mode()) {
-        args = is_undef(big) ? "" : str("(big=", big, ")");
+        args = is_undef(big) && !ngb ? "" : str("(big=", big, ", ngb=", ngb, ")");
         echo(str("~", name, "_assembly", args, "{"));
     }
     no_pose()

vitamins/microswitch.scad

@@ -18,7 +18,11 @@
 //
 
 //
-//! Used for limit switches.
+//! Used for limit switches. Currently only the button type is supported as the lever and roller types are less accurate.
+//!
+//! The switch is drawn with the button at the nominal operation point. This can be plus or minus `microswitch_op_tol(type)`.
+//!
+//! When the button is released it comes out by a maximum of `microswitch_fp_max(type)` from the nominal operating point.
 //
 include <../utils/core/core.scad>
 
@@ -32,11 +36,13 @@ function microswitch_hole_d(type)    = type[6];     //! Screw hole diameter
 function microswitch_holes(type)     = type[7];     //! Hole positions
 function microswitch_button_w(type)  = type[8];     //! Button width
 function microswitch_button_t(type)  = type[9];     //! Button thickness
-function microswitch_button_pos(type)= type[10];    //! Button position
-function microswitch_legs(type)      = type[11];    //! Leg positions
-function microswitch_leg(type)       = type[12];    //! Leg types
-function microswitch_body_clr(type)  = type[13];    //! Body colour
-function microswitch_button_clr(type)= type[14];    //! Button colour
+function microswitch_button_pos(type)= type[10];    //! Button position at operating point
+function microswitch_op_tol(type)    = type[11];    //! Operating position +/- tolerance
+function microswitch_fp_max(type)    = type[12];    //! Free position maximum
+function microswitch_legs(type)      = type[13];    //! Leg positions
+function microswitch_leg(type)       = type[14];    //! Leg types
+function microswitch_body_clr(type)  = type[15];    //! Body colour
+function microswitch_button_clr(type)= type[16];    //! Button colour
 
 function microswitch_lower_extent(type) = let(leg = microswitch_leg(type)) min([for(pos = microswitch_legs(type)) pos.y - leg.y / 2]); //! How far legs extend downwards
 function microswitch_right_extent(type) = let(leg = microswitch_leg(type)) max([microswitch_length(type) / 2, for(pos = microswitch_legs(type)) pos.x + leg.x / 2]); //! How far legs extend right

vitamins/microswitches.scad

@@ -23,10 +23,19 @@
 small_leg  = [0.9,  3.3, 0.4, 0];
 medium_leg = [0.5,  3.9, 3.2, 1.6, [0, -0.5]];
 large_leg  = [11.4, 0.8, 6.3, 1.8, [1.7, 0]];
-
-small_microswitch  = ["small_microswitch", "DM1-00P-110-3",      5.8, 6.5,  12.8, 0, 2,    [[-3.25, -1.65], [3.25, -1.65]], 2.9, 1.2, [-1.95, 3.75], [[-5.08, -4.95], [0,    -4.9],  [5.08, -4.9]  ], small_leg,  grey(20), "white"  ];
-medium_microswitch = ["medium_microswitch","SS-01 or SS-5GL",    6.4, 10.2, 19.8, 1, 2.35, [[-4.8,  -2.6 ], [4.7,  -2.6 ]], 3.2, 2,   [-2.8,  5.8 ], [[-8.05, -7.05], [0.75, -7.05], [8.05, -7.05] ], medium_leg, grey(20), "burlywood" ];
-large_microswitch  = ["large_microswitch", "Saia G3 low force", 10.4, 15.9, 28.0, 2, 3.1,  [[-11.1, -5.15], [11.2,  5.15]], 4,   2.75,[-9.1,  9.55], [[19.7,   2.19], [19.7, -3.45],  [8.3, -10.45] ], large_leg,  "ivory", "white" ];
+//                                                               t    w     l     r  h     h                               b     b    b             o     f     l                                                l           b         b
+//                                                               h    i     e     a  o     o                               u     u    u             p     p     e                                                e           o         u
+//                                                               i    d     n     d  l     l                               t     t    t                         g                                                g           d         t
+//                                                               c    t     g     i  e     e                               t     t    t             t     m                                                                  y         t
+//                                                               k    h     t     u                                        o     o    o             o     a     p                                                t                     o
+//                                                               n          h     s  d     p                               n     n    n             l     x     o                                                y           c         n
+//                                                               e                   i     o                                                                    s                                                p           l
+//                                                               s                   a     s                               w     t    p                         n                                                e           r         c
+//                                                               n                         n                                          o                         s                                                                      l
+//                                                                                         s                                          s                                                                                                r
+small_microswitch  = ["small_microswitch", "DM1-00P-110-3",      5.8, 6.5,  12.8, 0, 2,    [[-3.25, -1.65], [3.25, -1.65]], 2.9, 1.2, [-1.95, 3.75], 0.2, 0.55, [[-5.08, -4.95], [0,    -4.9],  [5.08, -4.9]  ], small_leg,  grey(20), "white"  ];
+medium_microswitch = ["medium_microswitch","SS-01 or SS-5GL",    6.4, 10.2, 19.8, 1, 2.35, [[-4.8,  -2.6 ], [4.7,  -2.6 ]], 3.2, 2,   [-2.8,  5.8 ], 0.5, 1.00, [[-8.05, -7.05], [0.75, -7.05], [8.05, -7.05] ], medium_leg, grey(20), "burlywood" ];
+large_microswitch  = ["large_microswitch", "Saia G3 low force", 10.4, 15.9, 28.0, 2, 3.1,  [[-11.1, -5.15], [11.2,  5.15]], 4,   2.75,[-9.1,  9.55], 0.3, 1.2,  [[19.7,   2.19], [19.7, -3.45], [8.3, -10.45] ], large_leg,  "ivory",  "white" ]; //G3M1T1PUL
 
 microswitches = [small_microswitch, medium_microswitch, large_microswitch];
 

vitamins/pulley.scad

@@ -53,7 +53,7 @@ function pulley_extent(type) = max(pulley_flange_dia(type), pulley_hub_dia(type)
 T_angle = 40;
 GT_r = 0.555;
 
-module pulley(type) { //! Draw a pulley
+module pulley(type, colour = silver) { //! Draw a pulley
     teeth = pulley_teeth(type);
     od = pulley_od(type);
 
@@ -117,7 +117,7 @@ module pulley(type) { //! Draw a pulley
                 rotate([-90, 0, i * -90])
                     cylinder(r = screw_radius(pulley_screw(type)), h = 100);
 
-    color(silver) {
+    color(colour) {
         if(screw_z && screw_z < hl)
             render()
                 difference() {
@@ -140,9 +140,9 @@ module pulley(type) { //! Draw a pulley
     }
 }
 
-module pulley_assembly(type) { //! Draw a pulley with its grub screws in place
+module pulley_assembly(type, colour = silver) { //! Draw a pulley with its grub screws in place
     translate_z(pulley_offset(type)) {
-        pulley(type);
+        pulley(type, colour);
 
         if(pulley_screws(type))
             translate_z(pulley_screw_z(type))

vitamins/screws.scad

@@ -83,6 +83,7 @@ M5_cs_cap_screw  = ["M5_cs_cap","M5 cs cap",    hs_cs_cap,5,10.0, 0,    3.00,3.0
 M2_dome_screw    = ["M2_dome", "M2 dome",       hs_dome,  2, 3.5, 1.3,  0.6, 1.3, 16,  M2_washer, M2_nut,   M2_tap_radius,    M2_clearance_radius];
 M3_dome_screw    = ["M3_dome", "M3 dome",       hs_dome,  3, 5.7, 1.65, 1.04,2.0, 18,  M3_washer, M3_nut,   M3_tap_radius,    M3_clearance_radius];
 M4_dome_screw    = ["M4_dome", "M4 dome",       hs_dome,  4, 7.6, 2.2,  1.3, 2.5, 20,  M4_washer, M4_nut,   M4_tap_radius,    M4_clearance_radius];
+M5_dome_screw    = ["M5_dome", "M5 dome",       hs_dome,  5, 9.5, 2.75, 1.56,3.0, 22,  M5_washer, M5_nut,   M5_tap_radius,    M5_clearance_radius];
 
 M2p5_pan_screw   = ["M2p5_pan", "M2.5 pan",     hs_pan, 2.5, 4.7, 1.7,    0,   0, 0, M2p5_washer, M2p5_nut, M2p5_tap_radius,  M2p5_clearance_radius];
 M3_pan_screw     = ["M3_pan", "M3 pan",         hs_pan,   3, 5.4, 2.0,    0,   0, 0,   M3_washer, M3_nut,   M3_tap_radius,    M3_clearance_radius];
@@ -111,7 +112,7 @@ screw_lists = [
 [ M2_cap_screw,    M2p5_cap_screw, M3_cap_screw,    M4_cap_screw,    M5_cap_screw, M6_cap_screw, M8_cap_screw],
 [ 0,               0,              M3_low_cap_screw],
 [ M2_cs_cap_screw, 0,              M3_cs_cap_screw, M4_cs_cap_screw, M5_cs_cap_screw],
-[ M2_dome_screw,   0,              M3_dome_screw,   M4_dome_screw],
+[ M2_dome_screw,   0,              M3_dome_screw,   M4_dome_screw,   M5_dome_screw],
 [ 0,               0,              M3_hex_screw,    M4_hex_screw,    M5_hex_screw, M6_hex_screw, M8_hex_screw],
 [ 0,               M2p5_pan_screw, M3_pan_screw,    M4_pan_screw,    M5_pan_screw, M6_pan_screw, No632_pan_screw],
 [ No2_screw,       0,              No4_screw,       No6_screw,       No6_cs_screw],

vitamins/veroboard.scad

@@ -143,8 +143,8 @@ module vero_components(type, cutouts = false, angle = undef)
 
 module vero_cutouts(type, angle = undef) vero_components(type, true, angle); //! Make cutouts to clear components
 
-module veroboard_assembly(type, height, thickness, flip = false) //! Draw the assembly with components and fasteners in place
-assembly(vero_assembly(type)) {
+module veroboard_assembly(type, height, thickness, flip = false, ngb = false) //! Draw the assembly with components and fasteners in place
+assembly(vero_assembly(type), ngb = ngb) {
     screw = vero_screw(type);
     nut = screw_nut(screw);
     screw_length = screw_length(screw, height + thickness + vero_thickness(type), 2, nyloc = true);