first pass at docs

This commit is contained in:
bakedpotatolord 2025-05-24 15:29:16 -06:00
commit ad2192d830
11 changed files with 172 additions and 0 deletions

View file

@ -0,0 +1,74 @@
---
description: Overview of cam mode
---
# CAM Mode Overview
Kiri:Moto's CAM mode is designed for subtractive manufacturing processes, primarily [CNC](https://en.wikipedia.org/wiki/Computer_numerical_control) milling. This mode provides a streamlined, browser-based workflow for generating toolpaths from 3D models and exporting G-code for a wide range of machines.
This page provides a high-level overview of the CAM workflow. There are subpages for specific parts of the workflow.
---
## Arrange
Begin by importing your model(s) into the workspace. The **Arrange** stage allows you to:
- Translate and rotate parts on the base platform
- Align multiple objects relative to each other
- Snap objects flat to the bed
- Apply other [transformations](<https://en.wikipedia.org/wiki/Transformation_(function)>) like scaling and mirroring
- Set your [profile options](processOpts)
- set your [machine](machines) settings
- set your [tool library](tools)
- set your [CAM operations](ops)
You can set profile options, and machine and tool settings in any part of the workflow, but doing so will not automatically update other parts of the workflow. You will need to re-slice after making changes.
---
## Slice
The Slice stage generates toolpaths based on user-defined [CAM operations](ops). The software makes use of [worker threads](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers) to slice the model without blocking the UI.
When working with complex models, you can toggle specific layers of the slice by toggling them at the botom of the page
![](/img/CAM/sliceToggle.png)
The bottom of the page also has a progress bar that is draggable and shows the order of operations.
---
## Preview
The Preview tab is quite similar to the Slice tab, but has a few key differences:
- Shows tool speeds
- Shows tool movement types (rapid move/ milling move)
- Visually shows tool offsets and tool changes
- Allows inspection of toolpath order and direction
- Helps detect gouges, collisions, or inefficient moves
![](/img/CAM/preview.png)
Overall, the Preview tab gives a more in-depth view of the toolpaths that will be generated.
---
## Animate
Animate is a useful tool to get a sense of how the tool will move through the stock without the risk of actually cutting anything.
Animate can show if your gode will collide with the stock, cut too deep, or cut in a place you don't expect.
![](/img/CAM/animate.gif)
---
## Export
Once you're confident in your setup, use the Export menu to generate machine-ready [G-code](https://en.wikipedia.org/wiki/G-code).
![](/img/CAM/exportMenu.png)
Most of the configuration for this step is done in the [Machine](kiri-moto/CAM/machines) settings, so be sure to have that configured before exporting.
The tab will give you a time estimate for the job (excluding tool changes), and an option to export G-code to a single file, or as a zipped archive of the sepate operation for each tool.

View file

@ -0,0 +1,69 @@
---
description: machine setup for CAM machines
---
# Machine Setup
The Machine Setup tab defines the physical capabilities of your CNC machine, its firmware behavior, and how G-code should be generated. A properly configured machine profile ensures your output matches your hardware's constraints and expectations.
you can access it from the top right menu:
![](/img/CAM/machinesTab.png)
---
## 🔧 Workspace Dimensions
These values define your machines cutting envelope. Use your *actual usable* dimensions here, not the marketing ones.
- **X (width)** — Maximum horizontal travel (left to right)
- **Y (depth)** — Maximum front-to-back travel
- **Z (height)** — Maximum vertical travel (top to bottom)
The units of these values are set based off the units set in your global preferences (defaults to mm).
---
## ⚙️ Firmware Settings
- **Max Spindle** — The highest RPM your spindle supports. This limits the `feed` speeds set in your [cam operations](/kiri-moto/CAM/ops) to generate proper and safe `S` values in G-code.
---
## 📤 Output Options
Customize how your G-code is formatted for your controller or post-processor:
- **Strip Comments** — Removes all G-code comments for cleaner, smaller files
- **Token Spacer** — Inserts a space between G-code tokens (e.g., `G1 X1 Y1` vs `G1X1Y1`)
- **Enable Laser** — Activates laser-compatible G-code (typically uses `M3/M5`, adjusts movement strategy)
- **File Extension** — Optional override for exported file type (e.g., `.nc`, `.ngc`,`.cnc`,`.cam`, `.gcode`, `.txt`)
> 💡 Leave the extension blank to default to `.gcode`.
---
## 🧱 G-code Macros
Macros insert custom G-code at key stages of toolpath generation. Each tab corresponds to a different context:
in these boxes, you have access to [gcode macros](../gcode-macros). Not all macros are available in all contexts, so be careful!
- **Header** — Runs once at the beginning of the job (e.g., mode override, move to safe Z)
- **Footer** — Runs at the end of the job (e.g., spindle stop, move to safe Z)
- **Tool** — Called when changing tools. automatic tool changes and tool measument can be put here.
- **Dwell** — Code for pausing movement/spindle at specified positions
- **Spindle** — Code to set spindle RPM
## RML dialect
Kiri Moto supports the [RML](https://downloadcenter.rolanddg.com/contents/manuals/PNC-3200_USE2_E_R5.pdf) dialect of G-code.
When a machine's file extention is set to `.rml`, Kiri Moto will use the RML dialect, using `PU` for non-cut moves, and `Z` for cut moves. RML commands can be used in the `Header`, `Footer`, `Tool`, `Dwell`, and `Spindle` sections of the Machine Setup tab in the same way that G-code commands are used.
## Contribute a Machine Profile
We love to add new machines to the Kiri Moto library. If you have a machine that you'd like to add, you can export your workspace as a `.kmz` file, and share it on the [discord](https://discord.gg/suyCCgr) or [forums](htps://forum.grid.space)
Please [submit a pull request](https://github.com/kiri-moto/kiri-moto/pulls) to add it to the Kiri Moto library!

10
docs/kiri-moto/CAM/ops.md Normal file
View file

@ -0,0 +1,10 @@
---
description: Keyboard Shortcuts and Mouse Controls
label: ops
---
# Operations
ops, not to be confused with [opps](https://knowyourmeme.com/memes/opp-opps) are the operations applied to a model to remove material. the operations supported by Kiri:Moto include:
- []

View file

@ -0,0 +1,5 @@
---
description: process options for the CAM mode
---
# Process Options

View file

View file

@ -28,6 +28,20 @@ const sidebars = {
"kiri-moto/localization", "kiri-moto/localization",
"kiri-moto/octoprint", "kiri-moto/octoprint",
"kiri-moto/faq", "kiri-moto/faq",
{
type: "category",
label: "CAM Mode",
link:{
type: 'doc',
id: 'kiri-moto/CAM/index',
},
items:[
"kiri-moto/CAM/processOpts",
"kiri-moto/CAM/machines",
"kiri-moto/CAM/tools",
"kiri-moto/CAM/ops",
],
}
], ],
}, },
{ {

BIN
docs/static/img/CAM/animate.gif vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.3 MiB

BIN
docs/static/img/CAM/exportMenu.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

BIN
docs/static/img/CAM/machinesTab.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.1 KiB

BIN
docs/static/img/CAM/preview.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 152 KiB

BIN
docs/static/img/CAM/sliceToggle.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.5 KiB