proofread new docs

This commit is contained in:
bakedpotatolord 2025-06-10 21:11:08 -06:00
commit b7a9350456
4 changed files with 108 additions and 117 deletions

View file

@ -1,12 +1,12 @@
--- ---
description: machine setup for CAM machines description: Machine setup for CAM machines
--- ---
# Machine Setup # 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. 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: You can access it from the top-right menu:
![](/img/CAM/machinesTab.png) ![](/img/CAM/machinesTab.png)
@ -20,13 +20,13 @@ These values define your machine’s cutting envelope. Use your *actual usable*
- **Y (depth)** — Maximum front-to-back travel - **Y (depth)** — Maximum front-to-back travel
- **Z (height)** — Maximum vertical travel (top to bottom) - **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). The units of these values are based on the units set in your global preferences (defaults to mm).
--- ---
## Firmware Settings ## 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. - **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.
--- ---
@ -36,30 +36,33 @@ Customize how your G-code is formatted for your controller or post-processor:
- **Strip Comments** — Removes all G-code comments for cleaner, smaller files - **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`) - **Token Spacer** — Inserts a space between G-code tokens (e.g., `G1 X1 Y1` vs `G1X1Y1`)
- **Enable Laser** — enables [Laser](ops#Laser-Mode-Only) operations (typically uses `M3/M5`, adjusts movement strategy) - **Enable Laser** — Enables [Laser](ops#Laser-Mode-Only) operations (typically uses `M3/M5`; adjusts movement strategy)
- **File Extension** — Optional override for exported file type (e.g., `.nc`, `.ngc`,`.cnc`,`.cam`, `.gcode`, `.txt`) - **File Extension** — Optional override for exported file type (e.g., `.nc`, `.ngc`, `.cnc`, `.cam`, `.gcode`, `.txt`)
--- ---
## Gcode Macros ## G-code Macros
Macros insert custom G-code at key stages of toolpath generation. Each tab corresponds to a different context: 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 [G-code macros](../gcode-macros). Not all macros are available in all contexts, so be careful!
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) - **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) - **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. - **Tool** — Called when changing tools. Automatic tool changes and tool measurement can be put here.
- **Dwell** — Code for pausing movement/spindle at specified positions - **Dwell** — Code for pausing movement/spindle at specified positions
- **Spindle** — Code to set spindle RPM - **Spindle** — Code to set spindle RPM
---
## RML dialect ## 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. 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 extension 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 ## Contribute a Machine Profile
We love to add new machines to the Kiri Moto library. If you have a tested 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). We love to add new machines to the Kiri:Moto library. If you have a tested 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](https://forum.grid.space).
If you want to submit a PR, you can find instructions for how to do so [here](https://github.com/GridSpace/grid-apps/blob/master/contributing.md#how-to-add-a-new-machine). If you want to submit a PR, you can find instructions for how to do so [here](https://github.com/GridSpace/grid-apps/blob/master/contributing.md#how-to-add-a-new-machine).

View file

@ -2,22 +2,21 @@
description: Keyboard Shortcuts and Mouse Controls description: Keyboard Shortcuts and Mouse Controls
label: ops label: ops
--- ---
import {ImageCarousel} from '@site/docs/src/components/carousel.js' import { ImageCarousel } from '@site/docs/src/components/carousel.js'
# Operations # Operations
ops, not to be confused with [opps](https://knowyourmeme.com/memes/opp-opps) are the 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 tab also contains meta operations applied to a model to remove material. The Operations tab also contains meta-operations
that represent parts of the manufacturing process, but do not nessecarity generate toolpaths. that represent parts of the manufacturing process but do not necessarily generate toolpaths.
Each operation has parameters which can be hovered on to reveal their description. Each operation has parameters which can be hovered over to reveal their description.
![](/img/CAM/paramDetails.png) ![](/img/CAM/paramDetails.png)
When an operation's settings are changed, they update the defaults for that operation, When an operation's settings are changed, they update the defaults for that operation
when it is made in the future. when it is created in the future.
These operations include:
These operation include:
- Toolpath Operations - Toolpath Operations
- Global - Global
@ -34,22 +33,19 @@ These operation include:
- Laser Operations - Laser Operations
- Indexed Operations - Indexed Operations
## Global Operations ## Global Operations
Operations that apply to all objects in the workspace. Operations that apply to all objects in the workspace.
### Outline ### Outline
<ImageCarousel base="/img/CAM/example/outline/" images="outline" /> <ImageCarousel base="/img/CAM/example/outline/" images="outline" />
The Outline op generates a toolpath surrounding the edges of a part. It is highly configurable and can select both internal or external edges specifically. The Outline operation is great for: The Outline op generates a toolpath surrounding the edges of a part. It is highly configurable and can select both internal or external edges specifically. The Outline operation is great for:
- Cutting out many objects at once - Cutting out many objects at once
- Generating a rough/finishing pass on an object - Generating a rough/finishing pass on an object
- Easily avoiding spefic features like pockets or holes - Easily avoiding specific features like pockets or holes
### Level ### Level
@ -57,106 +53,102 @@ The Outline op generates a toolpath surrounding the edges of a part. It is highl
The Level op creates a flat-surface clearing toolpath across a selected area. It is designed to remove material to a consistent depth, making it useful for preparing stock, flattening uneven surfaces, or cleaning up residual material. The Level operation is great for: The Level op creates a flat-surface clearing toolpath across a selected area. It is designed to remove material to a consistent depth, making it useful for preparing stock, flattening uneven surfaces, or cleaning up residual material. The Level operation is great for:
- Surfacing raw stock before detail cuts - Surfacing raw stock before detail cuts
- Creating uniform faces on complex objects - Creating uniform faces on complex objects
- Clearing large areas with consistent depth quickly - Clearing large areas with consistent depth quickly
### Rough ### Rough
<ImageCarousel base="/img/CAM/example/rough/" images="rough" /> <ImageCarousel base="/img/CAM/example/rough/" images="rough" />
The Rough op removes large volumes of material quickly using a stepped-down toolpath. It is typically the first pass in a multi-step workflow, clearing space for finishing tools without concern for fine detail. The Rough operation is great for: The Rough op removes large volumes of material quickly using a stepped-down toolpath. It is typically the first pass in a multi-step workflow, clearing space for finishing tools without concern for fine detail. The Rough operation is great for:
- Rapid bulk material removal - Rapid bulk material removal
- Preparing many parts for finishing simeltaneously. - Preparing many parts for finishing simultaneously
- Clearing voids or flat faces for many objects at once - Clearing voids or flat faces for many objects at once
- Preparing a part for finish machining - Preparing a part for finish machining
- Preserving tool life by reducing cutting load in later passes - Preserving tool life by reducing cutting load in later passes
### Contour ### Contour
<ImageCarousel base="/img/CAM/example/contour/" images="contour" /> <ImageCarousel base="/img/CAM/example/contour/" images="contour" />
The Contour op generates detailed toolpaths for complex organic surface geometries. The Contour op generates detailed toolpaths for complex organic surface geometries.
It can trace along the x or y axis and has configurable precision. It is useful for: It can trace along the X or Y axis and has configurable precision. It is useful for:
- Carving 3D shapes with organic or curved profiles
- Finishing complex wall geometries
- cleaning up a part after [roughing](#rough)
- Carving 3D shapes with organic or curved profiles
- Finishing complex wall geometries
- Cleaning up a part after [roughing](#rough)
### Register ### Register
<ImageCarousel base="/img/CAM/example/register/" images="register" /> <ImageCarousel base="/img/CAM/example/register/" images="register" />
The register operation drills holes in the sides of a part, The Register operation drills holes in the sides of a part,
helping keep a part in the same place when it is flipped onto it's opposite face. helping keep the part in the same place when it is flipped onto its opposite face.
The operation has options to drill on different sides, and can even generate a puzzle piece-like pattern for registration. The operation has options to drill on different sides and can even generate a puzzle-piece-like pattern for registration.
## Specific Operations ## Specific Operations
Specific operations require spelection of individual part features to apply operations to. Specific operations require selection of individual part features to apply operations to.
These may have some overlap with Global operations, but are generally more configurable. These may overlap with Global operations but are generally more configurable.
### Drill ### Drill
<ImageCarousel base="/img/CAM/example/drill/" images="drill" /> <ImageCarousel base="/img/CAM/example/drill/" images="drill" />
The Dril op creates pecking toolpaths for a drill tool to follow. The Drill op creates pecking toolpaths for a drill tool to follow.
It can also drill holes of other diameters, and even mark holes instead of drilling. It can also drill holes of other diameters and even mark holes instead of drilling.
it is useful for: It is useful for:
- Generating a toolpath for a drill tool - Generating a toolpath for a drill tool
- Selecting specific holes to remove material from - Selecting specific holes to remove material from
- Marking holes to be drilled manually - Marking holes to be drilled manually
### Trace ### Trace
<ImageCarousel base="/img/CAM/example/trace/" images="trace" /> <ImageCarousel base="/img/CAM/example/trace/" images="trace" />
The trace operation is likely the most configurable, allowing for generation of toolpaths following loops or lines. The Trace operation is likely the most configurable, allowing for generation of toolpaths following loops or lines.
it can trace on, inside, or outside a line, and can take multiple passes to step down to the desired position. It can trace on, inside, or outside a line and can take multiple passes to step down to the desired position.
when the type parameter is set to clear, it can even act like a [pocket](#Pocket), When the type parameter is set to "clear," it can even act like a [Pocket](#pocket),
clearing the area above the shape created by the selected lines/loop. clearing the area above the shape created by the selected lines or loop.
While the trace op can do a lot, some specific use cases include: While the Trace op can do a lot, some specific use cases include:
- Engraving lettering or other text - Engraving lettering or other text
- Drilling out a hole helically - Drilling out a hole helically
- Outlining a part with a nonstandard offset - Outlining a part with a nonstandard offset
- Outlining only one part on the workspace - Outlining only one part on the workspace
### Pocket ### Pocket
<ImageCarousel base="/img/CAM/example/pocket/" images="pocket" /> <ImageCarousel base="/img/CAM/example/pocket/" images="pocket" />
The pocket operation takes a selection of polygon faces, and generates a pocket toolpath that cuts down to them. The Pocket operation takes a selection of polygon faces and generates a pocket toolpath that cuts down to them.
The operation has options to expand and smooth the pocket selection, and the contour option even allows The operation has options to expand and smooth the pocket selection, and the contour option even allows
for an approximation a v-bit carve. some use cases specific to the pocket op include: for an approximation of a v-bit carve. Some use cases specific to the Pocket op include:
- Creating one pocket in a part with multiple - Creating one pocket in a part with multiple
- attempting a v-carve - Attempting a v-carve
- clearing a specific area of a part - Clearing a specific area of a part
### Gcode ### Gcode
<ImageCarousel base="/img/CAM/example/gcode/" images="gcode" /> <ImageCarousel base="/img/CAM/example/gcode/" images="gcode" />
The Gcode operation does not generate a toolpath, but instead adds a line or lines of gcode to the output The Gcode operation does not generate a toolpath but instead adds a line or lines of G-code to the output
of the file. The Gcode operation is different from [Gcode Macros](/kiri-moto/gcode-macros), of the file. The Gcode operation is different from [Gcode Macros](/kiri-moto/gcode-macros),
as it is not tied to any event, as it is not tied to any event
but is output in the order it is included in the operations array. but is output in the order it is included in the operations array.
## Laser Operations ## Laser Operations
Laser operations become available when "enable laser" is selected in the [machine](/machine) tab. Laser operations become available when "Enable Laser" is selected in the [Machine](/machine) tab.
These operations are specific to certain machines like the makera carvera, and can be safely igonored for other machines. These operations are specific to certain machines, like the Makera Carvera, and can be safely ignored for other machines.
## Indexed Operations
## Indexed operations Indexed operations become available when "Indexed" is selected in the [Process Ops](/processOpts) tab.
Indexed operations become available when "Indexed" is selected in the [process ops](/processOpts) tab.
These operations are specific to indexed stock, and allow a user to create operations on different faces of a part.
These operations are specific to indexed stock and allow a user to create operations on different faces of a part.

View file

@ -1,19 +1,18 @@
--- ---
description: process options for the CAM mode description: Process options for the CAM mode
--- ---
import {ImageCarousel} from '@site/docs/src/components/carousel.js' import { ImageCarousel } from '@site/docs/src/components/carousel.js'
# Process Options # Process Options
The Process Options (on the left side of the screen) are a set of parameters which control the behavior of the CAM engine. The Process Options (on the left side of the screen) are a set of parameters that control the behavior of the CAM engine.
Process options can be saved in a profile, so they don't need to be reset each time a material is changed. Process options can be saved in a profile, so they don't need to be reset each time a material is changed.
[Operation](./ops) defaults are stored in a profile as well, but are modified with that operation. [Operation](./ops) defaults are stored in a profile as well but are modified within that operation.
![](/img/CAM/process/profiles.png) ![](/img/CAM/process/profiles.png)
Each operation has parameters which can be hovered on to reveal their description. Each operation has parameters that can be hovered over to reveal their description.
![](/img/CAM/process/hover.png) ![](/img/CAM/process/hover.png)
@ -21,40 +20,39 @@ Each operation has parameters which can be hovered on to reveal their descriptio
<ImageCarousel base="/img/CAM/process/tabs" images="tabs" /> <ImageCarousel base="/img/CAM/process/tabs" images="tabs" />
Tabs can be added with the plus button, finalized with the checkmark, and removed with the trash button. Tabs can be added with the plus button, finalized with the checkmark, and removed with the trash button.
their size is configurable. Their size is configurable.
## Stock ## Stock
The stock defines the material that surrounds the part. as of V4.1, only rectangular stock is supported. The stock defines the material that surrounds the part. As of V4.1, only rectangular stock is supported.
setting witdth, depth, and height to zero will make the stock the same size as the part's boundign box. Setting width, depth, and height to zero will make the stock the same size as the part's bounding box.
The stock size defaults to absolute size, but can be made to offset from the part's bounding box by setting the stock offset option to true. If the stock is smaller than the part, the part will not slice. The stock size defaults to absolute dimensions but can be made to offset from the part's bounding box by setting the stock offset option to true.
If the stock is smaller than the part, the part will not slice.
the "clip to" option will delete any toolpaths that go outside the stock. The "Clip To" option will delete any toolpaths that go outside the stock.
using indexed stock is supported (barely). if you are using a rotary indexer, you can check the indexed option, and use [indexed operations](./ops#indexed-operations) to create operations on different faces of the part. Using indexed stock is supported (barely). If you are using a rotary indexer, you can check the Indexed option and use [Indexed Operations](./ops#indexed-operations) to create operations on different faces of the part.
## Limits ## Limits
The limits has options for setting the maximum feed rates, as well as the z-zero, and defaults for top and bottom offsets for operations. The Limits tab has options for setting the maximum feed rates, the Z-zero, and defaults for top and bottom offsets for operations.
Some operations have overrides for these values. Some operations have overrides for these values.
## Output ## Output
The Output tab configures how lines generated by the CAM ops are processed before being exported. The Output tab configures how lines generated by the CAM ops are processed before being exported.
these mainly effect what to do before and after each operation, and which way to traverse the toolpath (climb or conventional). These mainly affect what to do before and after each operation, and which direction to traverse the toolpath (climb or conventional).
The **First Z Max** and **Force Z Max** are safety features that move to a safe Z The **First Z Max** and **Force Z Max** are safety features that move to a safe Z
before the job and before pockets respectively. They are not checked by default for legacy compatibility. before the job and before pockets, respectively. They are not checked by default for legacy compatibility.
## Origin ## Origin
The origin tab controls the origin of the part, and allows configuration in the form of XYZ offsets. The Origin tab controls the origin of the part and allows configuration in the form of XYZ offsets.
## Expert ## Expert
The expert tab controls advanced options for the CAM mode, which can speed up slicing, but may generate tool crashes. The Expert tab controls advanced options for CAM mode, which can speed up slicing but may generate tool crashes.
use with caution. Use with caution.

View file

@ -1,22 +1,20 @@
--- ---
description: tool options for the CAM mode description: Tool options for the CAM mode
--- ---
# Tools # Tools
The Tool menu can be accessed from the top right corner dropdown. The Tool menu can be accessed from the top-right corner dropdown.
![](/img/CAM/toolsTab.png) ![](/img/CAM/toolsTab.png)
Once selected, the Tool menu provides options to create, copy, edit, and delete tools.
Once selected, the tool menu contains options to create, copy, edit, and delete tools. Additionally, tools can be imported and exported as `.km` files. The file format is binary-encoded and not human-readable, so don't try to edit it with a text editor.
Additionally, tools can be imported and exported as a `.km` file. The file format is binary encoded and not human-readable, so don't try to edit it with a text editor.
![](/img/CAM/toolMenu.png) ![](/img/CAM/toolMenu.png)
Kiri:Moto currently supports 4 types of tools: Kiri:Moto currently supports four types of tools:
- End Mills - End Mills
- Ball Mills - Ball Mills
- Taper Mills - Taper Mills
- Drills - Drills