\n\n# Quick Links\n\n- [Installation / Usage](#installation)\n- [Shell Command Scripts](#shell-command-scripts)\n - [gridfinitybox](#gridfinitybox)\n - [gridfinitybase](#gridfinitybase)\n - [ruggedbox](#ruggedbox)\n- [Classes](#classes)\n - [GridfinityBaseplate](#gridfinitybaseplate)\n - [GridfinityBox](#gridfinitybox-1)\n - [GridfinityDrawerSpacer](#gridfinitydrawerspacer)\n - [GridfinityRuggedBox](#gridfinityruggedbox)\n - [GridfinityObject](#gridfinityobject)\n- [References](#references)\n\n## Installation\n\n**cq-gridfinity** has the following installation dependencies:\n- [CadQuery](https://github.com/CadQuery/cadquery)\n- [cq-kit](https://github.com/michaelgale/cq-kit)\n\nAssuming these dependencie are installed, you can install **cq-gridfinity** using a [PyPI package](https://pypi.org/project/cqgridfinity/) as follows:\n\n```bash\n$ pip install cqgridfinity\n```\n\nAlternatively, the **cq-gridfinity** package can be installed directly from the source code:\n\n```bash\n$ git clone https://github.com/michaelgale/cq-gridfinity.git\n$ cd cq-gridfinity\n$ pip install .\n```\n\n## Development with VS Code Dev Container\n\nThis project includes a development container configuration that provides a consistent development environment with all required dependencies pre-installed.\n\n### Prerequisites\n\n1. Install [Docker Desktop](https://www.docker.com/products/docker-desktop/)\n2. Install [Visual Studio Code](https://code.visualstudio.com/)\n3. Install the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) in VS Code\n\n### Getting Started\n\n1. Clone this repository:\n ```bash\n git clone https://github.com/michaelgale/cq-gridfinity.git\n cd cq-gridfinity\n ```\n\n2. Open the project in VS Code:\n ```bash\n code .\n ```\n\n3. When VS Code detects the dev container configuration, it will prompt you to \"Reopen in Container\". Click this prompt, or:\n - Press `F1` or `Ctrl+Shift+P` (Cmd+Shift+P on Mac)\n - Type \"Dev Containers: Reopen in Container\" and select it\n\n4. Wait for the container to build (this may take a few minutes the first time)\n\n### What's Included\n\nThe development container comes with:\n- Python 3.12\n- CadQuery 2.4\n- All required dependencies (pytest, black, flake8, etc.)\n- A pre-configured environment for CAD development\n\n### Troubleshooting\n\nIf you encounter issues:\n1. Ensure Docker is running\n2. Try rebuilding the container:\n - Press `F1` or `Ctrl+Shift+P`\n - Select \"Dev Containers: Rebuild Container\"\n\n## Basic Usage\n\nAfter installation, the package can imported:\n\n```shell\n$ python\n>>> import cqgridfinity\n>>> cqgridfinity.__version__\n```\n\nAn example of the package can be seen below:\n\n```python\nfrom cqgridfinity import *\n\n# make a simple box\nbox = GridfinityBox(3, 2, 5, holes=True, no_lip=False, scoops=True, labels=True)\nbox.save_stl_file()\n# Output a STL file of box:\n# gf_box_3x2x5_holes_scoops_labels.stl\n```\n\n# Shell Command Scripts\n\n- [gridfinitybox](#gridfinitybox)\n- [gridfinitybase](#gridfinitybase)\n- [ruggedbox](#ruggedbox)\n\nThis package can be used to make your own python scripts to generate Gridfinity objects. This gives the flexibility to customize the object and combine with other code to add custom cutouts, add text labels, etc.\n\nHowever, for simple generation of standard objects such as baseplates and boxes, console scripts can be used for quick command line usage. These console scripts are installed automatically into the path of your python environment and should be accessible from your terminal shell.\n\n## `gridfinitybox`\n\n
\n\nMake a customized/parameterized Gridfinity compatible box with many optional features.\n\n```\nusage: gridfinitybox [-h] [-m] [-u] [-n] [-s] [-l] [-e] [-d] [-r RATIO] [-ld LENGTHDIV] [-wd WIDTHDIV] [-wt WALL]\n [-f FORMAT] [-o OUTPUT]\n length width height\n\nMake a customized/parameterized Gridfinity compatible box with many optional features.\n\npositional arguments:\n length Box length in U (1U = 42 mm)\n width Box width in U (1U = 42 mm)\n height Box height in U (1U = 7 mm)\n\noptions:\n -h, --help show this help message and exit\n -m, --magnetholes Add bottom magnet/mounting holes\n -u, --unsupported Add bottom magnet holes with 3D printer friendly strips without support\n -n, --nolip Do not add mating lip to the top perimeter\n -s, --scoops Add finger scoops against each length-wise back wall\n -l, --labels Add label strips against each length-wise front wall\n -e, --ecolite Make economy / lite style box with no elevated floor\n -d, --solid Make solid (filled) box for customized storage\n -r RATIO, --ratio RATIO\n Solid box fill ratio 0.0 = minimum, 1.0 = full height\n -ld LENGTHDIV, --lengthdiv LENGTHDIV\n Split box length-wise with specified number of divider walls\n -wd WIDTHDIV, --widthdiv WIDTHDIV\n Split box width-wise with specified number of divider walls\n -wt WALL, --wall WALL\n Wall thickness (default=1 mm)\n -f FORMAT, --format FORMAT\n Output file format (STEP, STL, SVG) default=STEP\n -o OUTPUT, --output OUTPUT\n Output filename (inferred output file format with extension)\n\n```\n\nExamples:\n\n```shell\n# 2x3x5 box with magnet holes saved to STL file with default filename:\n$ gridfinitybox 2 3 5 -m -f stl\n# gf_box_2x3x5_holes.stl\n\n# 1x3x4 box with scoops, label strip, 3 internal partitions and specified name:\n$ gridfinitybox 1 3 4 -s -l -ld 3 -o MyBox.step\n# MyBox.step\n\n# Solid 3x3x3 box with 50% fill, unsupported magnet holes and no top lip:\n$ gridfinitybox 3 3 3 -d -r 0.5 -u -n\n# gf_box_3x3x3_basic_holes_solid.step\n\n# Lite style box 3x2x3 with label strip, partitions, output to default SVG file:\n$ gridfinitybox 3 2 3 -e -l -ld 2 -f svg\n# gf_box_lite_3x2x3_div2_labels.svg\n```\n\n## `gridfinitybase`\n\n
\n\nMake a customized/parameterized Gridfinity compatible simple baseplate.\n\n```\nusage: gridfinitybase [-h] [-f FORMAT] [-s] [-d DEPTH] [-hd HOLEDIAM] [-hc CSKDIAM] [-ca CSKANGLE] [-o OUTPUT]\n length width\n\nMake a customized/parameterized Gridfinity compatible simple baseplate.\n\npositional arguments:\n length Box length in U (1U = 42 mm)\n width Box width in U (1U = 42 mm)\n\noptions:\n -h, --help show this help message and exit\n -f FORMAT, --format FORMAT\n Output file format (STEP, STL, SVG) default=STEP\n -s, --screws Add screw mounting tabs to the corners (adds +5 mm to depth)\n -d DEPTH, --depth DEPTH\n Extrude extended depth under baseplate by this amount\n -hd HOLEDIAM, --holediam HOLEDIAM\n Corner mounting screw hole diameter (default=5)\n -hc CSKDIAM, --cskdiam CSKDIAM\n Corner mounting screw countersink diameter (default=10)\n -ca CSKANGLE, --cskangle CSKANGLE\n Corner mounting screw countersink angle (deg) (default=82)\n -o OUTPUT, --output OUTPUT\n Output filename (inferred output file format with extension)\n```\n\nExamples:\n\n```shell\n# 7 x 4 baseplate with screw corners to default STL file:\n$ gridfinitybase 7 4 -s -f stl\n# gf_baseplate_7x4x5.0_screwtabs.stl\n```\n\n## `ruggedbox`\n\n
\n\nMake a parameterized rugged storage box compatible with gridfinity. This box is based on the [superb design by Pred on Printables](https://www.printables.com/model/543553-gridfinity-storage-box-by-pred-now-parametric). This implementation makes a few improvements and additions to Pred's design in addition to making almost all of the box's features optional and tunable. Using either the `ruggedbox` console script or the `GridfinityRuggedBox` class, you can make vast variety of different boxes of various sizes and features. By default, almost all of the boxes features are enabled, but by using the desired command line options you can customize your desired feature set.\n\n```\nusage: ruggedbox [-h] [+l] [-l] [+p] [-p] [+w] [-w] [-wt WINDOWTHICKNESS] [+a] [-a] [+c] [-c] [+s] [-s] [+v] [-v]\n [+e] [-e] [+b] [-b] [-r] [+r] [-f FORMAT] [-o OUTPUT] [-gb] [-gl] [-ga] [-gh] [-ge] [-gn] [-gt]\n [-gw]\n length width height\n\nMake a customized/parameterized Gridfinity compatible rugged box enclosure.\nThe minimum box size is 3U x 3U x 4U.\n\npositional arguments:\n length Box length in U (1U = 42 mm)\n width Box width in U (1U = 42 mm)\n height Box height in U (1U = 7 mm)\n\noptions:\n -h, --help show this help message and exit\n +l, --label Add label window across the front wall\n -l, --nolabel Remove label window across the front wall\n +p, --lidbaseplate Add baseplate to top of the lid\n -p, --nolidbaseplate Smooth/plain lid\n +w, --lidwindow Add window slot to the lid\n -w, --nolidwindow Do not add window slot to the lid\n -wt WINDOWTHICKNESS, --windowthickness WINDOWTHICKNESS\n Thickness of lid windows (mm)\n +a, --handle Add front handle\n -a, --nohandle No front handle\n +c, --clasps Add clasps to the left and right side walls\n -c, --noclasps No clasps on the left and right side walls\n +s, --stackable Add stackable mating features to top and bottom\n -s, --notstackable Non-stackable box\n +v, --veegroove Add v-cut grooves to side walls\n -v, --noveegroove No v-cut grooves (plain) side walls\n +e, --sidehandle Add handles to side walls\n -e, --nosidehandle No handles on side walls\n +b, --backfeet Add standing feet to back wall\n -b, --nobackfeet No standing feet added to back wall\n -r, --normalstyle Make normal style box\n +r, --ribstyle Make rib style box with exposed vertical ribs\n -f FORMAT, --format FORMAT\n Output file format (STEP, STL, SVG) default=STEP\n -o OUTPUT, --output OUTPUT\n Output filename (inferred output file format with extension)\n -gb, --box Generate box\n -gl, --lid Generate lid\n -ga, --acc Generate accessory components\n -gh, --hinge Generate hinge element\n -ge, --genlabel Generate label panel insert\n -gn, --genhandle Generate front handle\n -gt, --genlatch Generate latch component\n -gw, --genwindow Generate lid window component\n\nexample usage:\n\n 5 x 4 x 6 rugged box shell and lid saved to STL files:\n $ ruggedbox 5 4 6 --box --lid -f stl\n```\nExamples:\n\n5 x 4 x 6 rugged box component saved to STL file:\n\n```shell\n$ ruggedbox 5 4 6 -gb -f stl\n ____ _ ____\n| _ \\ _ _ __ _ __ _ ___ __| | __ ) _____ __\n| |_) | | | |/ _` |/ _` |/ _ \\/ _` | _ \\ / _ \\ \\/ /\n| _ <| |_| | (_| | (_| | __/ (_| | |_) | (_) > <\n|_| \\_\\\\__,_|\\__, |\\__, |\\___|\\__,_|____/ \\___/_/\\_\\\n |___/ |___/\n\nVersion: 0.5.7\nGridfinity rugged box: 5U x 4U x 6U\n Exterior dim: 230.0 mm x 188.0 mm x 55.0 mm\n Interior dim: 210.0 mm x 168.0 mm x 45.8 mm\n Internal volume: 1.616 L\n Wall Vgrooves : Y\n Front Handle : Y\n Stackable : Y\n Side Clasps : Y\n Lid Baseplate : Y\n Inside Baseplate : Y\n Side Handles : Y\n Front Label : Y\n Back Feet : Y\n Rib Style : N\n Lid Window : N\nRendering box...\nComponent generated and saved as gf_ruggedbox_5x4x6_body_fr-hl_sd-hc_stack_lidbp.stl in STL format\n$\n```\n\n```shell\n# same 5 x 4 x 6 rugged box with the lid saved to STL file:\n$ ruggedbox 5 4 6 --lid -f stl\n# gf_ruggedbox_5x4x6_lid_fr-hl_sd-hc_stack_lidbp.stl\n\n# 5 x 5 x 9 rugged box, smooth lid, non-stackable, and no handle; full assembly saved to STEP file\n$ ruggedbox 5 5 9 --nohandle --nolidbaseplate --notstackable\n# gf_ruggedbox_5x5x9_fr-l_sd-hc.step\n\n# Render the box, lid, and hinge for a 5x4x6 rugged box all at once:\n$ ruggedbox 5 4 6 --box --lid --hinge\n# gf_ruggedbox_5x4x6_fr-hl_sd-hc_stack_lidbp.step\n# gf_ruggedbox_5x4x6_lid_fr-hl_sd-hc_stack_lidbp.step\n# gf_ruggedbox_5x4x6_hinge_fr-hl_sd-hc_stack_lidbp.step\n\n# Then render the latches and handle components for the same box:\n$ ruggedbox 5 4 6 --acc\n# gf_ruggedbox_5x4x6_acc_fr-hl_sd-hc_stack_lidbp.step\n\n# Or render individual components as STL files with your preferred name:\n$ ruggedbox 5 4 6 --genhandle --genlatch -o orange.stl\n# orange_handle.stl\n# orange_latch.stl\n```\n\n# Classes\n\n- [GridfinityBaseplate](#gridfinitybaseplate)\n- [GridfinityBox](#gridfinitybox-1)\n- [GridfinityDrawerSpacer](#gridfinitydrawerspacer)\n- [GridfinityRuggedBox](#gridfinityruggedbox)\n- [GridfinityObject](#gridfinityobject)\n \n\n## `GridfinityBaseplate`\n\nGridfinity baseplates can be made with the `GridfinityBaseplate` class. The baseplate style is the basic style initially proposed by Zach Freedman. Therefore, it does not have magnet or mounting holes. An example usage is as follows:\n\n```python\n# Create 4 x 3 baseplate\nbaseplate = GridfinityBaseplate(4, 3)\nbaseplate.save_step_file()\n# gf_baseplate_4x3.step\n```\n
\n\nBaseplates can be rendered with extra depth to make a taller overall baseplate using the `ext_depth` attribute. Furthermore, mounting screws corner tabs can be added to the baseplate with the `corner_screws` attribute. A baseplate with this feature is shown below.\n\n
\n\n### Optional Keyword Arguments\n\n```python\next_depth = 0 # extended depth to extrude below baseplate\nstraight_bottom = False # add/remove 0.8 mm chamfer on bottom of baseplate\ncorner_screws = False # add corner mounting screw tabs\ncorner_tab_size = 21 # size of screw mounting tab (mm)\ncsk_hole = 5.0 # hole diameter of countersink mounting screw (mm)\ncsk_diam = 10.0 # countersink diameter (mm)\ncsk_angle = 82 # countersink angle (deg)\n```\n\n## `GridfinityBox`\n\nGridfinity boxes with many optional features can be created with the `GridfinityBox` class. As a minimum, this class is initialized with basic 3D unit dimensions for length, width, and height. The length and width are multiples of 42 mm Gridfinity intervals and height represents multiples of 7 mm.\n\n### Simple Box\n\n```python\n# Create a simple 3 x 2 box, 5U high\nbox = GridfinityBox(3, 2, 5)\nbox.save_step_file()\n# Output a STEP file of box named:\n# gf_box_3x2x5.step\n``` \n
\n\n### Lite Style Box\n\n\"Lite\" style boxes are simplified for faster 3D printing with less material. They remove the continuous floor at 7.2 mm and the box becomes a homogenous 1 mm thick walled shell. \"lite\" style boxes can include labels and dividers; however, the number of dividers must correspond to the same bottom partition ridges, i.e. `length_div` must be `length_u - 1` and `width_div` must be `width_u - 1`. \"lite\" style cannot be combined with solid boxes, finger scoops, or magnet holes.\n\n```python\n# Create a \"lite\" style 3 x 2 box, 5U high\nbox = GridfinityBox(3, 2, 5, lite_style=True)\nbox.save_step_file()\n# Output a STEP file of box named:\n# gf_box_lite_3x2x5.step\n``` \n
\n\n### Magnet Holes\n\n```python\n# add magnet holes to the box\nbox = GridfinityBox(3, 2, 5, holes=True)\nbox.save_step_file()\n# gf_box_3x2x5_holes.step\n```\n
\n\nThe `unsupported_holes` attribute can specify either regular holes or modified/unsupported holes which are more suitable for 3D-printing. These modified holes include thin filler strips which allow the slicer to avoid using supports to render the underside holes.\n\n```python\n# add magnet holes to the box\nbox = GridfinityBox(1, 1, 5, holes=True, unsupported_holes=True)\nbox.save_step_file()\n# gf_box_1x1x5_holes.step\n```\n
\n\n### Simple Box with No Top Lip\n\n```python\n# remove top mounting lip\nbox = GridfinityBox(3, 2, 5, no_lip=True)\nbox.save_step_file()\n# gf_box_3x2x5_basic.step\n```\n
\n\n### Scoops and Labels\n\n```python\n# add finger scoops and label top flange\nbox = GridfinityBox(3, 2, 5, scoops=True, labels=True)\nbox.save_step_file()\n# gf_box_3x2x5_scoops_labels.step\n```\n
\n\n### Dividing Walls\n\n```python\n# add dividing walls\nbox = GridfinityBox(3, 2, 5, length_div=2, width_div=1, scoops=True, labels=True)\nbox.save_step_file()\n# gf_box_3x2x5_div2x1_scoops_labels.step\n```\n
\n\n### Solid Box\n\n```python\n# make a partially solid box\nbox = GridfinityBox(3, 2, 5, solid=True, solid_ratio=0.7)\nbox.save_step_file()\n# gf_box_3x2x5_solid.step\n```\n
\n\n### Optional Keyword Arguments\n\n```python\nlength_div=0 # add dividing walls along length\nwidth_div=0 # add dividing walls along width\nholes=False # add magnet holes to bottom\nunsupported_holes=False # 3D-printer friendly hole style requiring no supports\nno_lip=False # remove top mating lip feature\nscoops=False # add finger scoops\nscoop_rad=11 # radius of optional interior scoops\nlabels=False # add a label flange to the top\nlabel_width=12 # width of the label strip\nlabel_height=10 # thickness height of label overhang\nlabel_lip_height=0.8 # thickness of label vertical lip\nlite_style=False # make a \"lite\" version of box without elevated floor\nsolid=False # make a solid box\nsolid_ratio=1.0 # ratio of solid height range 0.0 to 1.0 (max height)\nwall_th=1.0 # wall thickness (0.5-2.5 mm)\nfillet_interior=True # enable/disable internal fillet edges\n```\n\n## `GridfinityDrawerSpacer`\n\nThe `GridfinityDrawerSpacer` class can be used to make spacer components to fit a drawer with any arbitrary dimensions. Initialize with specified width and depth of the drawer (in mm) and the best fit of integer gridfinity baseplate units is computed. Rarely, integer multiples of 42 mm gridfinity baseplates fit perfectly inside a drawer; therefore, spacers are required to secure the baseplate snuggly inside the drawer. Spacers consist of 4x identical corner sections, 2x spacers for the left and right sides and 2x spacers for the front and back edges.\n\nIf the computed spacer width falls below a configurable threshold (default 4 mm), then no spacer component is made in that dimension. The spacer components are made by default with interlocking \"jigsaw\" type features to assist with assembly and to secure the spacers within the drawer. Also, alignment arrows (default but optional) are placed on the components to indicate the installation orientation in the direction of the drawer movement.\n\n```python\n# make drawer spacers for Craftsman tool chest drawer 23\" wide x 19\" deep\nspacer = GridfinityDrawerSpacer(582, 481, verbose=True)\n# Best fit for 582.00 x 481.00 mm is 13U x 11U\n# with 18.00 mm margin each side and 9.50 mm margin front and back\n# Corner spacers : 4U wide x 3U deep\n# Front/back spacers : 5U wide x 9.25 mm +0.25 mm tolerance\n# Left/right spacers : 5U deep x 17.75 mm +0.25 mm tolerance\n```\n
\n\n\nA full set of components (optionally including a full baseplate) can be rendered with the `render_full_set()` method. This method is mostly used to verify the fit and placement of the spacers.\n\n
\n\n\nNormally, the `render_half_set()` method used to render half of the components compactly arranged conveniently for 3D printing. This set can be printed twice to make a full set for a single drawer.\n\n
\n\n### Optional Keyword Arguments\n\n```python\nthickness=GR_BASE_HEIGHT # thickness of spacers, default=5 mm\nchamf_rad=1.0 # chamfer radius of spacer top/bottom edges\nshow_arrows=True # show orientation arrows indicating drawer in/out direction\nalign_features=True # add \"jigsaw\" interlocking feautures\nalign_tol=0.15 # tolerance of the interlocking joint\nalign_min=8 # minimum spacer width for adding interlocking feature\nmin_margin=4 # minimum size to make a spacer, nothing is made for smaller gaps\ntolerance=GR_TOL # overall tolerance for spacer components, default=0.5 mm\n```\n### Example with IKEA ALEX narrow drawer\n\nAn example use case to make a set of spacer components for a typical IKEA narrow ALEX drawer is as follows:\n\n```python\nspacers = GridfinityDrawerSpacer(INCHES(11.5), INCHES(20.5), verbose=True)\nspacers.render_full_set(include_baseplate=True)\nspacers.save_step_file(\"ikea_alex_full_set.step\")\n# make a half set for 3D printing\nspacers.render_half_set()\nspacers.save_stl_file(\"ikea_alex_half_set.stl\")\n```\n\n
\n\n## `GridfinityRuggedBox`\n\n
\n\nThe desired box size and features are specified with keyword arguments/attributes such as the ones illustrated below:\n\n
\n\nA alternative \"rib style\" rugged box is also available. This adds vertical rib stiffeners around the perimeter of the box and it is recommended to disable the side handles to allow for ribs to be generated on all sides.\n\n
\n\nLastly, the lid baseplate can be substituted with a lid window which makes the contents of the box visible. The window consists of a seperately prepared 1 mm thick transparent acrylic sheet cut to the required dimensions. These dimensions can be queried with the `lid_window_size()` method or will be printed to the console when using the `ruggedbox` shell script.\n\n
\n\nAfter the lid has been printed the process to install the lid window is as follows:\n1. Cut the lid window to the required dimensions. It is recommended to chamfer or round off the leading edge corners with a file prior to insertion.\n2. Slide the window into the lid starting from the back and along the tapered window groove slot around the inside perimeter of the lid.\n3. The window should be inserted just past the retention slots for the hinges.\n4. Secure the lid with 3x M2 screws along the back of the lid. Carefully drill 2.5 mm clearance holes into the window in situ prior to installation of the screws. Alternatively, the lid can be secured with a few drops of super glue along the rear edge.\n5. Install the lid hinges. The hinges must be installed last since they act as a physical retainer along the back edge of the window.\n \nThe lid window should nominally be 1 mm thick; however if it necessary to use a different thickness material, the `window_th` attribute can be set. It recommended to keep the window thickness in the range of 0.8 to 1.6 mm.\n\nThe rugged box can be rendered either as a complete assembly or as individual components. This is useful for making individual asset files for 3D printing. The render methods include the `render_assembly()` method as shown above for the complete assembly, as well as individual render methods summarized below:\n\n`render()` - renders just the main box body shell:\n\n
\n\n`render_lid()` - renders the lid:\n\n
\n\n`render_accessories()` - renders the accessory component elements as a group in the quantities required for the desired box:\n\n
\n\nLastly, each individual component has an individual render method.\n\n- `render_hinge()`\n- `render_latch()`\n- `render_label()`\n- `render_handle()`\n \n### Optional Keyword Arguments\n\n```python\nlid_height = 10 # lid height (should be multiple of 10 mm for stacking)\nwall_vgrooves = True # enable horizontal v-grooves to body shell\nfront_handle = True # enable front handle\nstackable = True # add mating stackable features\nside_clasps = True # add extra side latching clasps\nlid_baseplate = True # enable top/lid baseplate\ninside_baseplate = True # enable interior baseplate\nside_handles = True # enable side handles to box\nfront_label = True # enable front label panel\nlabel_length = None # length of front label panel, None=auto size\nlabel_height = None # height of front label panel, None=auto size\nlabel_th = GR_LABEL_TH # thickness of label panel, default=0.5 mm\nback_feet = True # add rear back feet matching hinges to allow the stand box vertically\nhinge_width = GR_HINGE_SZ # Size of hinge, default=32 mm\nhinge_bolted = False # printed or bolted hinge construction\nbox_color = cq.Color(0.25, 0.25, 0.25) # colors for the assembly STEP file\nlid_color = cq.Color(0.25, 0.5, 0.75)\nhandle_color = cq.Color(0.75, 0.5, 0.25)\nlatch_color = cq.Color(0.75, 0.5, 0.25)\nhinge_color = cq.Color(0.75, 0.5, 0.25)\nlabel_color = cq.Color(0.7, 0.7, 0.7)\n```\n\n## `GridfinityObject`\n\nThe `GridfinityObject` is the base class for `GridfinityBox`, `GridfinityBaseplate`, etc. It has several useful methods and attributes including:\n\n### File export and naming\n\n`obj.filename(self, prefix=None, path=None)` returns a filename string with descriptive attributes such as the object size and enabled features.\n\n```python\nbox = GridfinityBox(3, 2, 5, holes=True)\nbox.filename()\n# gf_box_3x2x5_holes\nbox.filename(prefix=\"MyBox\")\n# MyBox_3x2x5_holes\nbox.filename(path=\"./outputfiles\")\n# ./outputfiles/gf_box_3x2x5_holes\nbox2 = GridfinityBox(4, 3, 3, holes=True, length_div=2, width_div=1)\nbox2.filename()\n# gf_box_4x3x3_holes_div2x1\n```\n\n```python\n# Export object to STEP, STL, or SVG file\nobj.save_step_file(filename=None, path=None, prefix=None)\nobj.save_stl_file(filename=None, path=None, prefix=None)\nobj.save_svg_file(filename=None, path=None, prefix=None)\n```\n\nThe automatic filename assignment is aware of the last object generated with a particular class's render method. Therefore, you can call any render method and then call any of the `save_step_file`, `save_stl_file`, `save_svg_file` methods and the filename will adapt to the last object rendered. For example:\n\n```python\nb1 = GridfinityRuggedBox(5, 4, 6)\nb1.render_accessories()\nb1.save_step_file()\n# saved as \"gf_ruggedbox_5x4x6_acc_fr-hl_sd-hc_stack_lidbp.step\"\nb1.render_handle()\nb1.save_stl_file()\n# saved as \"gf_ruggedbox_5x4x6_handle_fr-hl_sd-hc_stack_lidbp.stl\"\nb1.render_hinge()\nb1.save_svg_file(path=\"./mystuff\")\n# saved as \"./mystuff/gf_ruggedbox_5x4x6_hinge_fr-hl_sd-hc_stack_lidbp.svg\"\nb1.render_assembly()\nb1.save_step_file()\n# saved as \"gf_ruggedbox_5x4x6_assembly_fr-hl_sd-hc_stack_lidbp.step\"\n```\n\n### Useful properties\n\n```obj.cq_obj``` returns a rendered CadQuery Workplane object \n```obj.length``` returns length in mm \n```obj.width``` returns width in mm \n```obj.height``` returns height in mm \n```obj.top_ref_height``` returns the height of the top surface of a solid box or the floor height of an empty box. This can be useful for making custom boxes with cutouts since the reference height can be used to orient the cutting solid to the correct height.\n\n# To-do\n\n- add more example scripts\n- improve documentation\n\n# Releases\n\n- v.0.1.0 - First release on PyPI\n- v.0.1.1 - Fixed release\n- v.0.2.0 - Added new \"lite\" style box\n- v.0.2.1 - Added new unsupported magnet hole types\n- v.0.2.2 - Added SVG export and integrated STL exporter\n- v.0.2.3 - Updated to python build tools to make distribution\n- v.0.3.0 - Added console generator scripts: `gridfinitybox` and `gridfinitybase`\n- v.0.4.0 - Added `GridfinityRuggedBox` class and `ruggedbox` console script. Various other improvements.\n- v.0.4.1 - Fixed docstring in `__init__.py`\n- v.0.4.2 - Improved script automatic renaming\n- v.0.4.3 - Fixed regression bug with using multilevel extrusion functions from cq-kit\n- v.0.4.4 - IMPORTANT FIX: generated geometry breaks using CadQuery v.2.4+ due to changes in CadQuery's `extrude` method. This version should work with any CQ version since it detects which CQ extrusion implementation is used at runtime.\n- v.0.4.5 - IMPORTANT FIX: fixes error in v.0.4.4 for extrusion angle\n- v.0.5.0 - Improved rugged box to make viable boxes down to 3U x 3U x 4U\n- v.0.5.1 - Increased the resolution of the gridfinity extruded base profile\n- v.0.5.2 - Adjusted geometry of box/bin floor/lip heights to exactly 7.00 mm intervals\n- v.0.5.3 - Removed a potential namespace collision for computing the height of boxes\n- v.0.5.4 - Optimized the geometry of the baseplate top height\n- v.0.5.5 - Added underside bin clearance and variable wall thickness interior radiusing\n- v.0.5.6 - Added adjustable magnet hole diameter to box. Prevent drawer spacers being rendered which fall below minimum size\n- v.0.5.7 - Added scoops to lite-style boxes. Added new \"rib style\" rugged box. Added a lid window feature to the rugged box.\n\n# References\n\n- [Zach Freedman's YouTube Channel](https://www.youtube.com/c/ZackFreedman)\n- [The video that started it all!](https://youtu.be/ra_9zU-mnl8?si=EOT1LFV65VZfiepi)\n- [Gridfinity Documentation repo](https://github.com/Stu142/Gridfinity-Documentation)\n- [Gridfinity Unofficial wiki](https://gridfinity.xyz)\n- Catalogs\n - [gridfinity-catalog](https://github.com/jeffbarr/gridfinity-catalog)\n - [Master Collection on Printables](https://www.printables.com/model/242711-gridfinity-master-collection)\n- Software/Tools\n - [Online Gridfinity Creator](https://gridfinity.bouwens.co)\n - [Gridfinity rebuilt OpenSCAD library](https://github.com/kennetek/gridfinity-rebuilt-openscad)\n - [Gridfinity Fusion360 generator plugin](https://github.com/Le0Michine/FusionGridfinityGenerator)\n - [FreeCAD Gridfinity Parametric Files (on Printables)](https://www.printables.com/@Stu142_524934/collections/969910)\n - [Gridfinity eco (low-cost Gridfinity resources)](https://github.com/jrymk/gridfinity-eco)\n - [Another CadQuery based Gridfinity script](https://github.com/kmeisthax/gridfinity-cadquery)\n- Videos\n - [Zach Freedman's follow-up Jul 2022](https://youtu.be/Bd4NnHvTRAY?si=rvgb9geXnq83mhOv)\n - [Zach Freedman's follow-up Dec 2022](https://youtu.be/7FCwMq-rVsY?si=tdqAe8MthGjfWEbR)\n - [The Next Layer tips video](https://youtu.be/KtbKwAuwv9s?si=1hYPjOvqf8tb5NO9)\n\n## Authors\n\n**cq-gridfinity** was written by [Michael Gale](https://github.com/michaelgale)\n\n"
},
{
"path": "cqgridfinity/__init__.py",
"content": "\"\"\"cqgridfinity - A python library to make Gridfinity compatible objects with CadQuery.\"\"\"\n\nimport os\n\n# fmt: off\n__project__ = 'cqgridfinity'\n__version__ = '0.5.7'\n# fmt: on\n\nVERSION = __project__ + \"-\" + __version__\n\nscript_dir = os.path.dirname(__file__)\n\nfrom .constants import *\nfrom .gf_obj import GridfinityObject\nfrom .gf_baseplate import GridfinityBaseplate\nfrom .gf_box import GridfinityBox, GridfinitySolidBox\nfrom .gf_drawer import GridfinityDrawerSpacer\nfrom .gf_ruggedbox import GridfinityRuggedBox\n"
},
{
"path": "cqgridfinity/constants.py",
"content": "#! /usr/bin/env python3\n#\n# Copyright (C) 2023 Michael Gale\n# This file is part of the cq-gridfinity python module.\n# Permission is hereby granted, free of charge, to any person\n# obtaining a copy of this software and associated documentation\n# files (the \"Software\"), to deal in the Software without restriction,\n# including without limitation the rights to use, copy, modify, merge,\n# publish, distribute, sublicense, and/or sell copies of the Software,\n# and to permit persons to whom the Software is furnished to do so,\n# subject to the following conditions:\n#\n# The above copyright notice and this permission notice shall be\n# included in all copies or substantial portions of the Software.\n#\n# THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\n# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\n# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\n# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\n# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\n# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\n# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n#\n# Globally useful constants representing Gridfinity geometry\n\nfrom math import sqrt\n\nSQRT2 = sqrt(2)\nEPS = 1e-5\nM2_DIAM = 1.8\nM2_CLR_DIAM = 2.5\nM3_DIAM = 3\nM3_CLR_DIAM = 3.5\nM3_CB_DIAM = 5.5\nM3_CB_DEPTH = 3.5\n\nGRU = 42\nGRU2 = GRU / 2\nGRHU = 7\n\nGRU_CUT = 42.2 # base extrusion width\nGR_WALL = 1.0 # nominal exterior wall thickness\nGR_DIV_WALL = 1.2 # width of dividing walls\nGR_TOL = 0.5 # nominal tolerance\n\nGR_RAD = 4 # nominal exterior filleting radius\nGR_BASE_CLR = 0.25 # clearance above the nominal base height\nGR_BASE_HEIGHT = 4.75 # nominal base height\n\n# baseplate extrusion profile\nGR_BASE_CHAMF_H = 0.98994949 / SQRT2\nGR_STR_H = 1.8\nGR_BASE_TOP_CHAMF = GR_BASE_HEIGHT - GR_BASE_CHAMF_H - GR_STR_H\nGR_BASE_PROFILE = (\n (GR_BASE_TOP_CHAMF * SQRT2, 45),\n GR_STR_H,\n (GR_BASE_CHAMF_H * SQRT2, 45),\n)\nGR_STR_BASE_PROFILE = (\n (GR_BASE_TOP_CHAMF * SQRT2, 45),\n GR_STR_H + GR_BASE_CHAMF_H,\n)\n\nGR_BOT_H = 7 # bin nominal floor height\nGR_FILLET = 1.1 # inside filleting radius\nGR_FLOOR = GR_BOT_H - GR_BASE_HEIGHT # floor offset\n\n# box/bin extrusion profile\nGR_BOX_CHAMF_H = 1.1313708 / SQRT2\nGR_BOX_TOP_CHAMF = GR_BASE_HEIGHT - GR_BOX_CHAMF_H - GR_STR_H + GR_BASE_CLR\nGR_BOX_PROFILE = (\n (GR_BOX_TOP_CHAMF * SQRT2, 45),\n GR_STR_H,\n (GR_BOX_CHAMF_H * SQRT2, 45),\n)\n\n# bin mating lip extrusion profile\nGR_UNDER_H = 1.6\nGR_TOPSIDE_H = 1.2\nGR_LIP_PROFILE = (\n (GR_UNDER_H * SQRT2, 45),\n GR_TOPSIDE_H,\n (0.7 * SQRT2, -45),\n 1.8,\n (1.3 * SQRT2, -45),\n)\nGR_LIP_H = 0\nfor h in GR_LIP_PROFILE:\n if isinstance(h, tuple):\n GR_LIP_H += h[0] / SQRT2\n else:\n GR_LIP_H += h\nGR_NO_PROFILE = (GR_LIP_H,)\n\n# bottom hole nominal dimensions\nGR_HOLE_D = 6.5\nGR_HOLE_H = 2.4\nGR_BOLT_D = 3.0\nGR_BOLT_H = 3.6 + GR_HOLE_H\nGR_HOLE_DIST = 26 / 2\nGR_HOLE_SLICE = 0.25\n\n# Rugged Box constant parameters\nGR_RBOX_WALL = 2.5\nGR_RBOX_FLOOR = 1.2\nGR_RBOX_CWALL = 10.0\nGR_RBOX_CORNER_W = 56\nGR_RBOX_BACK_L = 66\nGR_RBOX_FRONT_L = 56\nGR_RBOX_RAD = 3.745\nGR_RBOX_CRAD = 14\n\nGR_RBOX_CHAN_W = 20\nGR_RBOX_CHAN_D = GR_RBOX_CWALL - GR_RBOX_WALL\nGR_RBOX_VCUT_D = 1\n\nGR_CLASP_SLIDE_D = 39\nGR_CLASP_SLIDE_W = 4\n\nGR_RIB_W = 2\nGR_RIB_L = 5\nGR_RIB_GAP = 1\nGR_RIB_H = 3.5\nGR_RIB_SEP = 4\nGR_RIB_CTR = 10\n\nGR_REG_L = 5\nGR_REG_W = 2.5\nGR_REG_H = 2.5\nGR_REG_R0 = 10.75\nGR_REG_R1 = 8.25\nGR_BREG_R0 = GR_REG_R0 + 0.25\nGR_BREG_R1 = GR_REG_R1 - 0.25\n\nGR_HANDLE_L1 = 12\nGR_HANDLE_L2 = 28\nGR_HANDLE_H = 7.5\nGR_HANDLE_W = 5\nGR_HANDLE_SEP = 12.5\nGR_HANDLE_OFS = 61.5\nGR_HANDLE_SZ = 30\nGR_HANDLE_TH = 7\nGR_HANDLE_RAD = 11\n\nGR_LID_HANDLE_W = 70\nGR_SIDE_HANDLE_W = 60\n\nGR_HINGE_SZ = 32\nGR_HINGE_D = 3\nGR_HINGE_W1 = 5.5\nGR_HINGE_H1 = 2.7\nGR_HINGE_W2 = 2.1\nGR_HINGE_H2 = 9\nGR_HINGE_CTR = 30.625\nGR_HINGE_W3 = 2\nGR_HINGE_SEP = 1\nGR_HINGE_OFFS = 2.65\nGR_HINGE_SKEW = 0.15\nGR_HINGE_RAD = 3.5\nGR_HINGE_TOL = 0.4\nGR_HEX_H = 3\nGR_HEX_W = 4\nGR_HEX_D = 1.3\nGR_LID_WINDOW_H = 6.5\n\nGR_LABEL_SLOT_TH = 2.5\nGR_LABEL_TH = 0.8\nGR_LABEL_H = 31\n\nGR_LATCH_L = 32.5\nGR_LATCH_W = 19.6\nGR_LATCH_H = 7\nGR_LATCH_IW = 14.75\nGR_LATCH_IL = 5.2\n"
},
{
"path": "cqgridfinity/gf_baseplate.py",
"content": "#! /usr/bin/env python3\n#\n# Copyright (C) 2023 Michael Gale\n# This file is part of the cq-gridfinity python module.\n# Permission is hereby granted, free of charge, to any person\n# obtaining a copy of this software and associated documentation\n# files (the \"Software\"), to deal in the Software without restriction,\n# including without limitation the rights to use, copy, modify, merge,\n# publish, distribute, sublicense, and/or sell copies of the Software,\n# and to permit persons to whom the Software is furnished to do so,\n# subject to the following conditions:\n#\n# The above copyright notice and this permission notice shall be\n# included in all copies or substantial portions of the Software.\n#\n# THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\n# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\n# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\n# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\n# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\n# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\n# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n#\n# Gridfinity Baseplates\n\nimport cadquery as cq\n\nfrom cqgridfinity import *\nfrom cqkit.cq_helpers import (\n rounded_rect_sketch,\n composite_from_pts,\n rotate_x,\n recentre,\n)\nfrom cqkit import VerticalEdgeSelector, HasZCoordinateSelector\n\n\nclass GridfinityBaseplate(GridfinityObject):\n \"\"\"Gridfinity Baseplate\n\n This class represents a basic Gridfinity baseplate object. This baseplate\n more or less conforms to the original simple baseplate released by\n Zach Freedman. As such, it does not include features such as mounting\n holes, magnet holes, weight slots, etc.\n length_u - length in U (42 mm / U)\n width_u - width in U (42 mm / U)\n ext_depth - extrude bottom face by an extra amount in mm\n straight_bottom - remove bottom chamfer and replace with straight side\n corner_screws - add countersink mounting screws to the inside corners\n corner_tab_size - size of mounting screw corner tabs\n csk_hole - mounting screw hole diameter\n csk_diam - mounting screw countersink diameter\n csk_angle - mounting screw countersink angle\n \"\"\"\n\n def __init__(self, length_u, width_u, **kwargs):\n super().__init__()\n self.length_u = length_u\n self.width_u = width_u\n self.ext_depth = 0\n self.straight_bottom = False\n self.corner_screws = False\n self.corner_tab_size = 21\n self.csk_hole = 5.0\n self.csk_diam = 10.0\n self.csk_angle = 82\n for k, v in kwargs.items():\n if k in self.__dict__ and v is not None:\n self.__dict__[k] = v\n if self.corner_screws:\n self.ext_depth = max(self.ext_depth, 5.0)\n\n def _corner_pts(self):\n oxy = self.corner_tab_size / 2\n return [\n (i * (self.length / 2 - oxy), j * (self.width / 2 - oxy), 0)\n for i in (-1, 1)\n for j in (-1, 1)\n ]\n\n def render(self):\n profile = GR_BASE_PROFILE if not self.straight_bottom else GR_STR_BASE_PROFILE\n if self.ext_depth > 0:\n profile = [*profile, self.ext_depth]\n rc = self.extrude_profile(\n rounded_rect_sketch(GRU_CUT, GRU_CUT, GR_RAD), profile\n )\n rc = rotate_x(rc, 180).translate((GRU2, GRU2, GR_BASE_HEIGHT + self.ext_depth))\n rc = recentre(composite_from_pts(rc, self.grid_centres), \"XY\")\n r = (\n cq.Workplane(\"XY\")\n .rect(self.length, self.width)\n .extrude(GR_BASE_HEIGHT + self.ext_depth)\n .edges(\"|Z\")\n .fillet(GR_RAD)\n .faces(\">Z\")\n .cut(rc)\n )\n if self.corner_screws:\n rs = cq.Sketch().rect(self.corner_tab_size, self.corner_tab_size)\n rs = cq.Workplane(\"XY\").placeSketch(rs).extrude(self.ext_depth)\n rs = rs.faces(\">Z\").cskHole(\n self.csk_hole, cskDiameter=self.csk_diam, cskAngle=self.csk_angle\n )\n r = r.union(recentre(composite_from_pts(rs, self._corner_pts()), \"XY\"))\n bs = VerticalEdgeSelector(self.ext_depth) & HasZCoordinateSelector(0)\n r = r.edges(bs).fillet(GR_RAD)\n return r\n"
},
{
"path": "cqgridfinity/gf_box.py",
"content": "#! /usr/bin/env python3\n#\n# Copyright (C) 2023 Michael Gale\n# This file is part of the cq-gridfinity python module.\n# Permission is hereby granted, free of charge, to any person\n# obtaining a copy of this software and associated documentation\n# files (the \"Software\"), to deal in the Software without restriction,\n# including without limitation the rights to use, copy, modify, merge,\n# publish, distribute, sublicense, and/or sell copies of the Software,\n# and to permit persons to whom the Software is furnished to do so,\n# subject to the following conditions:\n#\n# The above copyright notice and this permission notice shall be\n# included in all copies or substantial portions of the Software.\n#\n# THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\n# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\n# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\n# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\n# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\n# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\n# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n#\n# Gridfinity Boxes\n\nimport math\n\nimport cadquery as cq\nfrom cqkit import HasZCoordinateSelector, VerticalEdgeSelector, FlatEdgeSelector\nfrom cqkit.cq_helpers import rounded_rect_sketch, composite_from_pts\nfrom cqgridfinity import *\n\n\nclass GridfinityBox(GridfinityObject):\n \"\"\"Gridfinity Box\n\n This class represents a Gridfinity compatible box module. As a minimum,\n this class is initialized with basic 3D unit dimensions for length,\n width, and height. length and width are multiples of 42 mm Gridfinity\n intervals and height represents multiples of 7 mm.\n\n Many box features can be enabled with attributes provided either as\n keywords or direct dotted access. These attributes include:\n - solid : renders the box without an interior, i.e. a solid block. This\n is useful for making custom Gridfinity modules by subtracting\n out shapes from the solid interior. Normally, the box is\n rendered solid up to its maximum size; however, the\n solid_ratio attribute can specify a solid fill of between\n 0.0 to 1.0, i.e. 0 to 100% fill.\n - holes : adds bottom mounting holes for magnets or screws\n - scoops : adds a radiused bottom edge to the interior to help fetch\n parts from the box\n - labels : adds a flat flange along each compartment for adding a label\n - no_lip : removes the contoured lip on the top module used for stacking\n - length_div, width_div : subdivides the box into sub-compartments in\n length and/or width.\n - lite_style : render box as an economical shell without elevated floor\n - unsupported_holes : render bottom holes as 3D printer friendly versions\n which can be printed without supports\n - label_width : width of top label ledge face overhang\n - label_height : height of label ledge overhang\n - scoop_rad : radius of the bottom scoop feature\n - wall_th : wall thickness\n - hole_diam : magnet/counterbore bolt hole diameter\n\n \"\"\"\n\n def __init__(self, length_u, width_u, height_u, **kwargs):\n super().__init__()\n self.length_u = length_u\n self.width_u = width_u\n self.height_u = height_u\n self.length_div = 0\n self.width_div = 0\n self.scoops = False\n self.labels = False\n self.solid = False\n self.holes = False\n self.no_lip = False\n self.solid_ratio = 1.0\n self.lite_style = False\n self.unsupported_holes = False\n self.label_width = 12 # width of the label strip\n self.label_height = 10 # thickness of label overhang\n self.label_lip_height = 0.8 # thickness of label vertical lip\n self.scoop_rad = 14 # radius of optional interior scoops\n self.fillet_interior = True\n self.wall_th = GR_WALL\n self.hole_diam = GR_HOLE_D # magnet/bolt hole diameter\n for k, v in kwargs.items():\n if k in self.__dict__:\n self.__dict__[k] = v\n self._int_shell = None\n self._ext_shell = None\n\n def __str__(self):\n s = []\n s.append(\n \"Gridfinity Box %dU x %dU x %dU (%.2f x %.2f x %.2f mm)\"\n % (\n self.length_u,\n self.width_u,\n self.height_u,\n self.length - GR_TOL,\n self.width - GR_TOL,\n self.height,\n )\n )\n sl = \"no mating top lip\" if self.no_lip else \"with mating top lip\"\n ss = \"Lite style box \" if self.lite_style else \"\"\n s.append(\" %sWall thickness: %.2f mm %s\" % (ss, self.wall_th, sl))\n s.append(\n \" Floor height : %.2f mm Inside height: %.2f mm Top reference height: %.2f mm\"\n % (self.floor_h + GR_BASE_HEIGHT, self.int_height, self.top_ref_height)\n )\n if self.solid:\n s.append(\" Solid filled box with fill ratio %.2f\" % (self.solid_ratio))\n if self.holes:\n s.append(\" Bottom mounting holes with %.2f mm diameter\" % (self.hole_diam))\n if self.unsupported_holes:\n s.append(\" Holes are 3D printer friendly and can be unsupported\")\n if self.scoops:\n s.append(\" Lengthwise scoops with %.2f mm radius\" % (self.scoop_rad))\n if self.labels:\n s.append(\n \" Lengthwise label shelf %.2f mm wide with %.2f mm overhang\"\n % (self.label_width, self.label_height)\n )\n if self.length_div:\n xl = (self.inner_l - GR_DIV_WALL * (self.length_div)) / (\n self.length_div + 1\n )\n s.append(\n \" %dx lengthwise divisions for %.2f mm compartment lengths\"\n % (self.length_div, xl)\n )\n if self.width_div:\n yl = (self.inner_w - GR_DIV_WALL * (self.width_div)) / (self.width_div + 1)\n s.append(\n \" %dx widthwise divisions for %.2f mm compartment widths\"\n % (self.width_div, yl)\n )\n s.append(\" Auto filename: %s\" % (self.filename()))\n return \"\\n\".join(s)\n\n def render(self):\n \"\"\"Returns a CadQuery Workplane object representing this Gridfinity box.\"\"\"\n self._int_shell = None\n if self.lite_style:\n # just force the dividers to the desired quantity in both dimensions\n # rather than raise a exception\n if self.length_div:\n self.length_div = self.length_u - 1\n if self.width_div:\n self.width_div = self.width_u - 1\n if self.solid:\n raise ValueError(\n \"Cannot select both solid and lite box styles together\"\n )\n if self.holes:\n raise ValueError(\n \"Cannot select both holes and lite box styles together\"\n )\n if self.wall_th > 1.5:\n raise ValueError(\n \"Wall thickness cannot exceed 1.5 mm for lite box style\"\n )\n if self.wall_th > 2.5:\n raise ValueError(\"Wall thickness cannot exceed 2.5 mm\")\n if self.wall_th < 0.5:\n raise ValueError(\"Wall thickness must be at least 0.5 mm\")\n r = self.render_shell()\n rd = self.render_dividers()\n rs = self.render_scoops()\n rl = self.render_labels()\n for e in (rd, rl, rs):\n if e is not None:\n r = r.union(e)\n if not self.solid and self.fillet_interior:\n heights = [GR_FLOOR]\n if self.labels:\n heights.append(self.safe_label_height(backwall=True, from_bottom=True))\n heights.append(self.safe_label_height(backwall=False, from_bottom=True))\n bs = (\n HasZCoordinateSelector(heights, min_points=1, tolerance=0.5)\n + VerticalEdgeSelector(\">5\")\n - HasZCoordinateSelector(\"<%.2f\" % (self.floor_h))\n )\n if self.lite_style and self.scoops:\n bs = bs - HasZCoordinateSelector(\"<=%.2f\" % (self.floor_h))\n bs = bs - VerticalEdgeSelector()\n r = self.safe_fillet(r, bs, self.safe_fillet_rad)\n\n if self.lite_style and not self.has_dividers:\n bs = FlatEdgeSelector(self.floor_h)\n if self.wall_th < 1.2:\n r = self.safe_fillet(r, bs, 0.5)\n elif self.wall_th < 1.25:\n r = self.safe_fillet(r, bs, 0.25)\n\n if not self.labels and self.has_dividers:\n bs = VerticalEdgeSelector(\n GR_TOPSIDE_H, tolerance=0.05\n ) & HasZCoordinateSelector(GRHU * self.height_u - GR_BASE_HEIGHT)\n r = self.safe_fillet(r, bs, GR_TOPSIDE_H - EPS)\n\n if self.holes:\n r = self.render_holes(r)\n r = r.translate((-self.half_l, -self.half_w, GR_BASE_HEIGHT))\n if self.unsupported_holes:\n r = self.render_hole_fillers(r)\n return r\n\n @property\n def top_ref_height(self):\n \"\"\"The height of the top surface of a solid box or the floor\n height of an empty box.\"\"\"\n if self.solid:\n return self.max_height * self.solid_ratio + GR_BOT_H\n if self.lite_style:\n return self.floor_h\n return GR_BOT_H\n\n @property\n def bin_height(self):\n return self.height - GR_BASE_HEIGHT\n\n def safe_label_height(self, backwall=False, from_bottom=False):\n lw = self.label_width\n if backwall:\n lw += self.lip_width\n lh = self.label_height * (lw / self.label_width)\n yl = self.max_height - self.label_height + self.wall_th\n if backwall:\n yl -= self.lip_width\n if yl < 0:\n lh = self.max_height - 1.5 * GR_FILLET - 0.1\n elif yl < 1.5 * GR_FILLET:\n lh -= 1.5 * GR_FILLET - yl + 0.1\n if from_bottom:\n ws = math.sin(math.atan2(self.label_height, self.label_width))\n if backwall:\n lh = self.max_height + GR_FLOOR - lh + ws * self.wall_th\n else:\n lh = self.max_height + GR_FLOOR - lh + ws * GR_DIV_WALL\n return lh\n\n @property\n def has_dividers(self):\n return self.length_div > 0 or self.width_div > 0\n\n @property\n def interior_solid(self):\n if self._int_shell is not None:\n return self._int_shell\n self._int_shell = self.render_interior()\n return self._int_shell\n\n def render_interior(self, force_solid=False):\n \"\"\"Renders the interior cutting solid of the box.\"\"\"\n wall_u = self.wall_th - GR_WALL\n wall_h = self.int_height + wall_u\n under_h = ((GR_UNDER_H - wall_u) * SQRT2, 45)\n profile = GR_NO_PROFILE if self.no_lip else [under_h, *GR_LIP_PROFILE[1:]]\n profile = [wall_h, *profile]\n if self.int_height < 0:\n profile = [self.height - GR_BOT_H]\n rci = self.extrude_profile(\n rounded_rect_sketch(*self.inner_dim, self.inner_rad), profile\n )\n rci = rci.translate((*self.half_dim, self.floor_h))\n if self.solid or force_solid:\n hs = self.max_height * self.solid_ratio\n ri = rounded_rect_sketch(*self.inner_dim, self.inner_rad)\n rf = cq.Workplane(\"XY\").placeSketch(ri).extrude(hs)\n rf = rf.translate((*self.half_dim, self.floor_h))\n rci = rci.cut(rf)\n if self.scoops and not self.no_lip and not self.lite_style:\n rf = (\n cq.Workplane(\"XY\")\n .rect(self.inner_l, 2 * self.under_h)\n .extrude(self.max_height)\n .translate((self.half_l, -self.half_in, self.floor_h))\n )\n rci = rci.cut(rf)\n if self.lite_style:\n r = composite_from_pts(self.base_interior(), self.grid_centres)\n rci = rci.union(r)\n return rci\n\n def solid_shell(self):\n \"\"\"Returns a completely solid box object useful for intersecting with other solids.\"\"\"\n if self._ext_shell is not None:\n return self._ext_shell\n r = self.render_shell(as_solid=True)\n self._ext_shell = r.cut(self.render_interior(force_solid=True))\n return self._ext_shell\n\n def mask_with_obj(self, obj):\n \"\"\"Intersects a solid object with this box.\"\"\"\n return obj.intersect(self.solid_shell())\n\n def base_interior(self):\n profile = [GR_BASE_HEIGHT, *GR_BOX_PROFILE]\n zo = GR_BASE_HEIGHT + GR_BASE_CLR\n if self.int_height < 0:\n h = self.bin_height - GR_BASE_HEIGHT\n profile = [h, *profile]\n zo += h\n r = self.extrude_profile(\n rounded_rect_sketch(GRU - GR_TOL, GRU - GR_TOL, self.outer_rad),\n profile,\n )\n rx = r.faces(\"![](\"../../cqgridfinity/shims/baseplate.svg\") | \nParameters:
| \n
![](\"../../cqgridfinity/shims/box.svg\") | \nParameters:
| \n
![](\"../../cqgridfinity/shims/drawerspacer.svg\"){kind=spacer} | \nParameters:
| \n
![](\"../../cqgridfinity/shims/ruggedbox.svg\") | \nParameters:
| \n
\n\n*Generated by [PartCAD](https://partcad.org/)*\n" }, { "path": "cqgridfinity/shims/cqgi_gf_baseplate.py", "content": "import sys\nsys.path.append(\".\") # Relative to `partcad.yaml`\n\nfrom cqgridfinity.gf_baseplate import GridfinityBaseplate\n\nlength_u = 2\nwidth_u = 2\next_depth = 0.0\nstraight_bottom = False\ncorner_screws = False\ncorner_tab_size = 21\ncsk_hole = 5.0\ncsk_diam = 10.0\ncsk_angle = 82\n\nresult = GridfinityBaseplate(\n length_u=int(length_u),\n width_u=int(width_u),\n ext_depth=ext_depth,\n straight_bottom=straight_bottom,\n corner_screws=corner_screws,\n corner_tab_size=corner_tab_size,\n csk_hole=csk_hole,\n csk_diam=csk_diam,\n csk_angle=csk_angle,\n).render().val()\n\nshow_object(result)" }, { "path": "cqgridfinity/shims/cqgi_gf_box.py", "content": "import sys\nsys.path.append(\".\") # Relative to `partcad.yaml`\n\nfrom cqgridfinity.gf_box import GridfinityBox\n\nlength_u = 2\nwidth_u = 2\nheight_u = 2\nlength_div = 0.0\nwidth_div = 0.0\nscoops = False\nlabels = False\nsolid = False\nholes = False\nno_lip = False\nsolid_ratio = 1.0\nlite_style = False\nunsupported_holes = False\nlabel_width = 12.0 # width of the label strip\nlabel_height = 10.0 # thickness of label overhang\nlabel_lip_height = 0.8 # thickness of label vertical lip\nscoop_rad = 12.0 # radius of optional interior scoops\nfillet_interior = True\nwall_th = 1.0\n\nresult = GridfinityBox(\n length_u=int(length_u),\n width_u=int(width_u),\n height_u=int(height_u),\n length_div=length_div,\n width_div=width_div,\n scoops=scoops,\n labels=labels,\n solid=solid,\n holes=holes,\n no_lip=no_lip,\n solid_ratio=solid_ratio,\n lite_style=lite_style,\n unsupported_holes=unsupported_holes,\n label_width=label_width,\n label_height=label_height,\n label_lip_height=label_lip_height,\n scoop_rad=scoop_rad,\n fillet_interior=fillet_interior,\n wall_th=wall_th,\n).render().val()\n\nshow_object(result)" }, { "path": "cqgridfinity/shims/cqgi_gf_drawerspacer.py", "content": "import sys\nsys.path.append(\".\") # Relative to `partcad.yaml`\n\nfrom cqgridfinity.gf_drawer import GridfinityDrawerSpacer\n\nlength_u = 2\nwidth_u = 2\nlength_th = 10.0\nwidth_th = 10.0\nthickness = 5.0\nchamf_rad = 1.0\nshow_arrows = True\narrow_h = 0.8\nlength_fill = 0.0\nwidth_fill = 0.0\nalign_features = True\nalign_l = 16.0\nalign_tol = 0.15\nalign_min = 8.0\nmin_margin = 4.0\ntolerance = 0.5\n\nresult = GridfinityDrawerSpacer(\n length_u=int(length_u),\n width_u=int(width_u),\n length_th=length_th,\n width_th=width_th,\n thickness=thickness,\n chamf_rad=chamf_rad,\n show_arrows=show_arrows,\n arrow_h=arrow_h,\n length_fill=length_fill,\n width_fill=width_fill,\n align_features=align_features,\n align_l=align_l,\n align_tol=align_tol,\n align_min=align_min,\n min_margin=min_margin,\n tolerance=tolerance,\n).render().val()\n\nshow_object(result)" }, { "path": "cqgridfinity/shims/cqgi_gf_ruggedbox.py", "content": "import sys\nsys.path.append(\".\") # Relative to `partcad.yaml`\n\nfrom cqgridfinity.gf_ruggedbox import GridfinityRuggedBox\n\nlength_u = 4\nwidth_u = 4\nheight_u = 4\nlid_height = 10.0\nwall_vgrooves = True\nfront_handle = True\nstackable = True\nside_clasps = True\nlid_baseplate = True\ninside_baseplate = True\nside_handles = True\nfront_label = True\n# TODO(clairbee): uncomment the below when annotations are supported by CQGI\n# label_length: float = None\n# label_height: float = None\nlabel_length = 0.0\nlabel_height = 0.0\nif label_length == 0.0:\n label_length = None\nif label_height == 0.0:\n label_height = None\n\nlabel_th = 0.8\nback_feet = True\nhinge_width = 48.0\nhinge_bolted = False\nrib_style = False\n\nresult = GridfinityRuggedBox(\n length_u=int(length_u),\n width_u=int(width_u),\n height_u=int(height_u),\n lid_height=lid_height,\n wall_vgrooves=wall_vgrooves,\n front_handle=front_handle,\n stackable=stackable,\n side_clasps=side_clasps,\n lid_baseplate=lid_baseplate,\n inside_baseplate=inside_baseplate,\n side_handles=side_handles,\n front_label=front_label,\n label_length=label_length,\n label_height=label_height,\n label_th=label_th,\n back_feet=back_feet,\n hinge_width=hinge_width,\n hinge_bolted=hinge_bolted,\n rib_style=rib_style,\n).render().val()\n\nshow_object(result)" }, { "path": "examples/demo1.assy", "content": "# This is a demo of multiple gridfinity parts put together using PartCAD.\n# Use `pc show -a examples/demo1` to view it in OCP CAD Viewer or\n# use `pc render -t png -a examples/demo1` to render a PNG image of this assembly.\nlinks:\n - part: baseplate\n name: baseplate\n - part: box\n name: box\n location: [[100, 0, 0], [0, 0, 1], 0]\n - part: drawerspacer\n name: drawerspacerbox\n location: [[-200, 0, 0], [0, 0, 1], 0]\n" }, { "path": "partcad.yaml", "content": "partcad: \">=0.7.16\"\n\nname: /pub/storage/workspace/gridfinity\ndesc: Created by Zach Freedman as a versatile system of modular organization and storage modules.\ncover:\n part: ruggedbox\n\ndocs:\n intro: |\n This package defines the basic building blocks of the Gridfinity system.\n Make use of the parameters to customize the parts to your needs.\n footer: |\n ## Implementation notes\n\n This packages has a folder with PartCAD shims.\n This folder contains wrappers for cqgridfinity main Python files\n to make them compatible with CadQuery's CQGI interface that is used by PartCAD.\n This is a non-intrusive alternative to refactoring cqgridfinity main Python files.\n If cqgridfinity adopts CQGI, then these shims can be dropped.\n\nparts:\n baseplate:\n type: cadquery\n path: cqgridfinity/shims/cqgi_gf_baseplate.py\n parameters:\n length_u:\n type: int\n default: 2\n width_u:\n type: int\n default: 2\n ext_depth:\n type: float\n default: 0.0\n straight_bottom:\n type: bool\n default: False\n corner_screws:\n type: bool\n default: False\n corner_tab_size:\n type: float\n default: 21.0\n csk_hole:\n type: float\n default: 5.0\n csk_diam:\n type: float\n default: 10.0\n csk_angle:\n type: float\n default: 82.0\n ruggedbox:\n type: cadquery\n path: cqgridfinity/shims/cqgi_gf_ruggedbox.py\n parameters:\n length_u:\n type: int\n default: 4\n width_u:\n type: int\n default: 4\n height_u:\n type: int\n default: 4\n lid_height:\n type: float\n default: 10.0\n wall_vgrooves:\n type: bool\n default: True\n front_handle:\n type: bool\n default: True\n stackable:\n type: bool\n default: True\n side_clasps:\n type: bool\n default: True\n lid_baseplate:\n type: bool\n default: True\n inside_baseplate:\n type: bool\n default: True\n side_handles:\n type: bool\n default: True\n front_label:\n type: bool\n default: True\n label_length:\n type: float\n default: 0.0\n label_height:\n type: float\n default: 0.0\n label_th:\n type: float\n default: 0.8\n back_feet:\n type: bool\n default: True\n hinge_width:\n type: float\n default: 48.0\n hinge_bolted:\n type: bool\n default: False\n rib_style:\n type: bool\n default: False\n box:\n type: cadquery\n path: cqgridfinity/shims/cqgi_gf_box.py\n parameters:\n length_u:\n type: int\n default: 2\n width_u:\n type: int\n default: 2\n height_u:\n type: int\n default: 2\n length_div:\n type: float\n default: 0.0\n width_div:\n type: float\n default: 0.0\n scoops:\n type: bool\n default: False\n labels:\n type: bool\n default: False\n solid:\n type: bool\n default: False\n holes:\n type: bool\n default: False\n no_lip:\n type: bool\n default: False\n solid_ratio:\n type: float\n default: 1.0\n lite_style:\n type: bool\n default: False\n unsupported_holes:\n type: bool\n default: False\n label_width:\n type: float\n default: 12.0 # width of the label strip\n label_height:\n type: float\n default: 10.0 # thickness of label overhang\n label_lip_height:\n type: float\n default: 0.8 # thickness of label vertical lip\n scoop_rad:\n type: float\n default: 12.0 # radius of optional interior scoops\n fillet_interior:\n type: bool\n default: True\n wall_th:\n type: float\n default: 1.0\n drawerspacer:\n type: cadquery\n path: cqgridfinity/shims/cqgi_gf_drawerspacer.py\n parameters:\n length_u:\n type: int\n default: 2\n width_u:\n type: int\n default: 2\n length_th:\n type: float\n default: 10.0\n width_th:\n type: float\n default: 10.0\n thickness:\n type: float\n default: 5.0\n chamf_rad:\n type: float\n default: 1.0\n show_arrows:\n type: bool\n default: True\n arrow_h:\n type: float\n default: 0.8\n length_fill:\n type: float\n default: 0.0\n width_fill:\n type: float\n default: 0.0\n align_features:\n type: bool\n default: True\n align_l:\n type: float\n default: 16.0\n align_tol:\n type: float\n default: 0.15\n align_min:\n type: float\n default: 8.0\n min_margin:\n type: float\n default: 4.0\n tolerance:\n type: float\n default: 0.5\n\nassemblies:\n examples/demo1:\n type: assy\n\nrender:\n svg:\n prefix: cqgridfinity/shims\n exclude:\n - assemblies\n readme:\n path: cqgridfinity/shims/README.md\n exclude:\n - assemblies\n" }, { "path": "requirements.in", "content": "cadquery\ncqkit>=0.5.6\n" }, { "path": "requirements.txt", "content": "#\n# This file is autogenerated by pip-compile with Python 3.12\n# by the following command:\n#\n# pip-compile requirements.in\n#\ncadquery==2.4.0\n # via -r requirements.in\ncadquery-ocp==7.7.2\n # via cadquery\ncasadi==3.6.7\n # via cadquery\ncqkit==0.5.8\n # via -r requirements.in\nezdxf==1.3.4\n # via cadquery\nfonttools==4.55.2\n # via ezdxf\nmultimethod==1.9.1\n # via cadquery\nnlopt==2.9.0\n # via cadquery\nnptyping==2.0.1\n # via cadquery\nnumpy==2.1.3\n # via\n # casadi\n # ezdxf\n # nlopt\n # nptyping\npath==17.0.0\n # via cadquery\npyparsing==3.2.0\n # via ezdxf\ntyping-extensions==4.12.2\n # via ezdxf\ntypish==1.9.3\n # via cadquery\n" }, { "path": "setup.py", "content": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n\nimport os\nimport os.path\nfrom pathlib import Path\nimport sys\nimport setuptools\n\nPACKAGE_NAME = \"cqgridfinity\"\n\n\nrequired = [\"cadquery\", \"cqkit>=0.5.6\"]\ndependency_links = []\n\n\ndef read_package_variable(key, filename=\"__init__.py\"):\n \"\"\"Read the value of a variable from the package without importing.\"\"\"\n module_path = os.path.join(PACKAGE_NAME, filename)\n with open(module_path) as module:\n for line in module:\n parts = line.strip().split(\" \", 2)\n if parts[:-1] == [key, \"=\"]:\n return parts[-1].strip(\"'\")\n sys.exit(\"'{0}' not found in '{1}'\".format(key, module_path))\n\nthis_directory = Path(__file__).parent\nlong_description = (this_directory / \"README.md\").read_text()\n\nsetuptools.setup(\n name=read_package_variable(\"__project__\"),\n version=read_package_variable(\"__version__\"),\n description=\"A python library to make Gridfinity compatible objects with CadQuery.\",\n url=\"https://github.com/michaelgale/cq-gridfinity\",\n author=\"Michael Gale\",\n author_email=\"michael@fxbricks.com\",\n python_requires=\">=3.9\",\n packages=setuptools.find_packages(),\n long_description=long_description,\n long_description_content_type=\"text/markdown\",\n license=\"MIT\",\n classifiers=[\n \"Development Status :: 4 - Beta\",\n \"Natural Language :: English\",\n \"Operating System :: OS Independent\",\n \"Programming Language :: Python :: 3.9\",\n \"Intended Audience :: Developers\",\n \"License :: OSI Approved :: MIT License\",\n ],\n install_requires=required,\n dependency_links=dependency_links,\n entry_points={\n \"console_scripts\": [\n \"gridfinitybox=cqgridfinity.scripts.gridfinitybox:main\",\n \"gridfinitybase=cqgridfinity.scripts.gridfinitybase:main\",\n \"ruggedbox=cqgridfinity.scripts.ruggedbox:main\",\n ],\n }, \n)\n" }, { "path": "tests/common_test.py", "content": "import os\n\nEXPORT_STEP_FILE_PATH = \"./tests/testfiles\"\n\nenv = dict(os.environ)\nSKIP_TEST_BOX = \"SKIP_TEST_BOX\" in env\nSKIP_TEST_RBOX = \"SKIP_TEST_RBOX\" in env\nSKIP_TEST_SPACER = \"SKIP_TEST_SPACER\" in env\nSKIP_TEST_BASEPLATE = \"SKIP_TEST_BASEPLATE\" in env\n\n\ndef INCHES(x):\n return x * 25.4\n\n\ndef _faces_match(obj, face, n):\n nf = len(obj.faces(face).vals())\n return nf == n\n\n\ndef _edges_match(obj, face, n):\n nf = len(obj.faces(face).edges().vals())\n return abs(nf - n) < 3\n\n\ndef _almost_same(x, y, tol=1e-3):\n if isinstance(x, (list, tuple)):\n return all((abs(xe - ye) < tol for xe, ye in zip(x, y)))\n return abs(x - y) < tol\n\n\ndef _export_files(spec=\"all\"):\n if \"EXPORT_STEP_FILES\" in env:\n exp_var = env[\"EXPORT_STEP_FILES\"].lower()\n if exp_var == \"all\":\n return True\n elif exp_var == spec.lower():\n return True\n return False\n return False\n" }, { "path": "tests/test_baseplate.py", "content": "# Gridfinity tests\nimport pytest\n\n# my modules\nfrom cqgridfinity import *\nfrom cqkit import FlatEdgeSelector\nfrom cqkit.cq_helpers import size_3d\nfrom common_test import (\n EXPORT_STEP_FILE_PATH,\n _almost_same,\n _faces_match,\n _export_files,\n SKIP_TEST_BASEPLATE,\n)\n\n\n@pytest.mark.skipif(\n SKIP_TEST_BASEPLATE,\n reason=\"Skipped intentionally by test scope environment variable\",\n)\ndef test_make_baseplate():\n bp = GridfinityBaseplate(4, 3)\n r = bp.render()\n if _export_files(\"baseplate\"):\n bp.save_step_file(path=EXPORT_STEP_FILE_PATH)\n assert bp.filename() == \"gf_baseplate_4x3\"\n assert _almost_same(size_3d(r), (168, 126, 4.75))\n assert _faces_match(r, \">Z\", 16)\n assert _faces_match(r, \"