Fix docs spelling issues
This commit is contained in:
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Welcome to mslicer!
|
Welcome to mslicer!
|
||||||
|
|
||||||
Currently, mslicer can only output `.goo` files, which is a format spsific to [ELEGOO](https://www.elegoo.com) resin printers. In the future I plan to add support for other formats, but in the meantime you can use [UVTools](https://github.com/sn4k3/UVtools) to convert between formats.
|
Currently, mslicer can only output `.goo` files, which is a format specific to [ELEGOO](https://www.elegoo.com) resin printers. In the future I plan to add support for other formats, but in the meantime you can use [UVTools](https://github.com/sn4k3/UVtools) to convert between formats.
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
@@ -10,14 +10,14 @@ In order for the sliced output to be loadable by your printer, you will first ne
|
|||||||
|
|
||||||
## Models
|
## Models
|
||||||
|
|
||||||
mslicer can load `.stl` and `.obj` models. Add one by going to File Import Model or drag and drop a model file into the workspace. For now you can load the built in test model (it's the [Utah Teapot](https://en.wikipedia.org/wiki/Utah_teapot)) by pressing `Ctrl+T`.
|
mslicer can load `.stl` and `.obj` models. Add one by going to File Import Model or drag and drop a model file into the workspace. For now, you can load the built-in test model (it's the [Utah Teapot](https://en.wikipedia.org/wiki/Utah_teapot)) by pressing `Ctrl+T`.
|
||||||
|
|
||||||
You can move around the viewport by scrolling on it to move towards or away from the target point, dragging with left click to orbit the target point, and dragging with right click to move the target point.
|
You can move around the viewport by scrolling on it to move towards or away from the target point, dragging with left click to orbit the target point, and dragging with right click to move the target point.
|
||||||
|
|
||||||
Each model in your project is listed in the `Models` panel. By clicking the arrow button next to a model, you can access all it's properties, including size, position, rotation as well as run actions like deleting the model, or aligning it to the bed.
|
Each model in your project is listed in the `Models` panel. By clicking the arrow button next to a model, you can access all its properties, including size, position, and rotation, as well as run actions like deleting the model or aligning it to the bed.
|
||||||
|
|
||||||
If you're unfamiliar with normals, they are vectors at each vertex of a model that are perpendicular to the surface and point outward. Normals are crucial for the slicer to determine whether it is entering or exiting a model, especially when models intersect themselves or other models. Incorrect normals from imported `.stl` or `.obj` files can result in artifacts in the output. For this reason, under the `Normals` action you can either flip or recalculate the normals of a model.
|
If you're unfamiliar with normals, they are vectors at each vertex of a model that are perpendicular to the surface and point outward. Normals are crucial for the slicer to determine whether it is entering or exiting a model, especially when models intersect themselves or other models. Incorrect normals from imported `.stl` or `.obj` files can result in artifacts in the output. For this reason, under the `Normals` action, you can either flip or recalculate the normals of a model.
|
||||||
|
|
||||||
## Slicing
|
## Slicing
|
||||||
|
|
||||||
After starting a slice operation, a new panel will open showing the operation progress. It shouldnt be open for long though because (as far as I know) mslicer is the fastest MSLA slicer currently available. :p You will then be presented with a slice preview, you can drag to pan, scroll to zoom, and scrub through the the slider on the left to look through each layer.
|
After starting a slice operation, a new panel will open showing the operation progress. It shouldn't be open for long though because (as far as I know) mslicer is the fastest MSLA slicer currently available (:p). You will then be presented with a slice preview; you can drag to pan, scroll to zoom, and scrub through the slider on the left to look through each layer.
|
||||||
|
@@ -4,13 +4,13 @@ This document covers a variety of topics that don't fit into any other category.
|
|||||||
|
|
||||||
## Remote Print HTTP Status Proxy
|
## Remote Print HTTP Status Proxy
|
||||||
|
|
||||||
Part of the process to upload a model to a printer with remote print is to serve the .goo file on a http server, then send the download link to the printer over MQTT. Because remote print already has to run a HTTP server, this option exposes an API at `0.0.0.0:<http_port>/status`. Each time remote print starts, all server port are randomized and printed to the log (check the console or the Log panel).
|
Part of the process to upload a model to a printer with remote print is to serve the .goo file on an HTTP server, then send the download link to the printer over MQTT. Because remote print already has to run an HTTP server, this option exposes an API at `0.0.0.0:<http_port>/status`. Each time remote print starts, all server ports are randomized and printed to the log (check the console or the Log panel).
|
||||||
|
|
||||||
### Scriptable Widget
|
### Scriptable Widget
|
||||||
|
|
||||||
Before I explain how the API works, here is a cool thing you can use it for (if you have an iPhone). There is an app called [Scriptable](https://scriptable.app) the lets you write scripts for your phone in JavaScript. I have already written one that shows a widget with the status of the current print job. It needs to access the API server so if you want to access it outside your home network you will need to use some proxy service like ngrok.
|
Before I explain how the API works, here is a cool thing you can use it for (if you have an iPhone). There is an app called [Scriptable](https://scriptable.app) that lets you write scripts for your phone in JavaScript. I have already written one that shows a widget with the status of the current print job. It needs to access the API server, so if you want to access it outside your home network, you will need to use some proxy service like ngrok.
|
||||||
|
|
||||||
Anyway you can download the code for the widget from GitHub [here](https://gist.github.com/connorslade/5ee51da075fb0d7295f7a85cc774a5e0). Just make a new script in the app, paste the code in, then you can make a Scriptable widget, edit it, and choose the script you made.
|
Anyway, you can download the code for the widget from GitHub [here](https://gist.github.com/connorslade/5ee51da075fb0d7295f7a85cc774a5e0). Just make a new script in the app, paste the code in, and then you can make a Scriptable widget, edit it, and choose the script you made.
|
||||||
|
|
||||||
### The API
|
### The API
|
||||||
|
|
||||||
@@ -25,7 +25,7 @@ struct Printer {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The `Attributes` structure is passed directly from the printer's innitial handshake message. I'm honestly not sure what all the fields are for.
|
The `Attributes` structure is passed directly from the printer's initial handshake message. I'm honestly not sure what all the fields are for.
|
||||||
|
|
||||||
```
|
```
|
||||||
struct Attributes {
|
struct Attributes {
|
||||||
|
Reference in New Issue
Block a user