docs: Update Quicktips #518

prcutler · 2022-01-06T21:37:23Z

I've reviewed all the pages in Quicktips and updated them for readability, spelling, grammar and consistency. The only page I haven't done yet is the Slicer page.

Please review and let me know if I missed anything or have any errors.

Thanks!

Signed-off-by Paul Cutler [email protected]

lixxbox · 2022-01-07T10:28:39Z

docs/data-privacy.md


-The following table applies to Mainsail when installed locallaly, or accessed via [my.mainsail.xyz](http://my.mainsail.xyz).
+The following table applies to Mainsail when installed locallly or accessed remotely at [my.mainsail.xyz](http://my.mainsail.xyz).


docs/data-privacy.md

lixxbox · 2022-01-07T10:44:39Z

docs/quicktips/multi-cam.md


-Run `ls /dev/v4l/by-id`, copy your camera id and paste it into the editor in mainsail. For example:
+In a termina, run the comman `ls /dev/v4l/by-id`, copy your camera id and paste it into the editor in Mainsail. For example:


lixxbox · 2022-01-07T10:48:47Z

docs/quicktips/multi-cam.md


-Set `camera="usb"` at the top, and the `camera_usb_options` line to indicate the device:
+Add `camera="usb"` at the beginning of the file and then add a line with  `camera_usb_options` to indicate the device:


Is "add" the right term? these options are already in the file, but commented out:

https://github.com/mainsail-crew/MainsailOS/blob/f622e1ce6ebd3e6c69d632ebce4ce709669571bd/src/modules/mjpgstreamer/filesystem/home/pi/klipper_config/webcam.txt#L16
https://github.com/mainsail-crew/MainsailOS/blob/f622e1ce6ebd3e6c69d632ebce4ce709669571bd/src/modules/mjpgstreamer/filesystem/home/pi/klipper_config/webcam.txt#L24

Not sure about this one to be honest. :D

lixxbox · 2022-01-07T10:50:09Z

docs/quicktips/multi-cam.md


 `camera_usb_options="-r 640x480 -f 10 -d /dev/v4l/by-id/<device long id>"`

 __Note__  
-Using a Raspberry Pi camera? Set camera="raspi" at the top of the file, and you can ignore referencing the cameras by device ID.
+If you are using a Raspberry Pi branded camera, seet camera="raspi" at the top of the file and you do not have to reference the cameras by device ID.


seet -> set

lixxbox · 2022-01-07T10:51:23Z

docs/quicktips/multi-cam.md


-As above again, set camera="usb" and set camera_usb_options but this time using the ID for the second camera:
+Edit `/home/pi/klipper_config/webcam2.txt` as described above andd add:


andd -> and

same about "add" as above.

lixxbox · 2022-01-07T10:54:05Z

docs/quicktips/multi-cam.md


-Adjust the port, by editing camera_http_options:
+Adjust the port by editing `camera_http_options`:


just as refererence ("add"), this option is also included and commented out in the file:
https://github.com/mainsail-crew/MainsailOS/blob/f622e1ce6ebd3e6c69d632ebce4ce709669571bd/src/modules/mjpgstreamer/filesystem/home/pi/klipper_config/webcam.txt#L72

lixxbox · 2022-01-07T10:55:31Z

docs/quicktips/multi-cam.md

-If you need more than four webcams, hop onto our [Discord](https://discord.gg/skWTwTD){:target="_blank"} and we will help you.
+MainsailOS comes setup with four nginx reverse proxies for port 8080 through 8083, so you can configure 4 webcams with this guide. 
+For more webcams you will need to edit the nginx configuration, which is not recommended.  It can be easy to make a mistake when editing nginx, which will also  cause Mainsail to stop working.  
+If you need more than four webcams,visit us on [Discord](https://discord.gg/skWTwTD){:target="_blank"} and we will help you.


",visit" -> add space ", visit"

lixxbox · 2022-01-07T11:07:41Z

docs/quicktips/remote-access.md


-To be able to reach your home network even with a non-static IP address, you should use a dynamic DNS service. This will forward a domain directly to your IP address. Often, these DynDNS services can also be set up directly in the router, so that the IP address gets automatically updated on a change.
+If your router does not support this, you can also set up your own VPN, for example, using your Raspberry Pi.  
+[OpenVPN](https://openvpn.net/), [WireGuard](https://www.wireguard.com/) or [PiVPN](https://www.pivpn.io/)are all options that could work.


add a space between the PiVPN link and "are"

lixxbox · 2022-01-07T11:09:35Z

docs/quicktips/remote-access.md


 __Notice__  
-The devices that dial in via the VPN tunnel are assigned to a different address range. This address range must be configured in moonraker under _trusted_clients_ and _cors_domains_. [https://moonraker.readthedocs.io/en/latest/configuration/#authorization](https://moonraker.readthedocs.io/en/latest/configuration/#authorization)  <br/><br/>
+The devices that you use to access VPN tunnel are assigned to a different address range. This address range must be configured in Moonraker under _trusted_clients_ and _cors_domains_.See also [https://moonraker.readthedocs.io/en/latest/configuration/#authorization](https://moonraker.readthedocs.io/en/latest/configuration/#authorization)  <br/><br/>


space in front of "See also".

lixxbox · 2022-01-07T11:12:44Z

docs/quicktips/slicer-upload.md


 ```
 [octoprint_compat]
 ```


-### PrusaSlicer/SuperSlicer (prior to v2.3.0)
+### PrusaSlicer / SuperSlicer (Mainsail v2.3.0 and up)


Nope, not Mainsail. It's about the slicers. They changed at some point how to connect to the printers.

lixxbox · 2022-01-07T11:13:19Z

docs/quicktips/slicer-upload.md


-If not already been done, switch to advanced or expert mode and set the options under `Printer Settings / General` as shown in the screenshot below.
+### PrusaSlicer / SuperSlicer (prior to Mainsail v2.3.0)


Same as above.

lixxbox · 2022-01-07T11:18:16Z

docs/quicktips/update-manager.md

@@ -13,7 +13,7 @@ description: >-

 ## Moonraker.conf

-Add the following section to your printers moonraker.conf:
+To enable updates in Moonraker's web interface, add the following section to your printer's `moonraker.conf`:


*Mainsail's web interface

lixxbox

I have added a few minor change requests.

The changes in console-shortcuts.md can be done for the moment, but the page needs a complete overhaul, because the functionality of the console has changed a bit. we can discuss this in the discord. :)

Signed-off-by Paul Cutler [email protected]

…in Klipper Signed-off-by Paul Cutler [email protected]

Signed-off-by Paul Cutler [email protected]

docs/quicktips/update-manager.md

Signed-off-by Paul Cutler [email protected]

prcutler added 6 commits January 6, 2022 12:35

Update "gcode" with proper spelling of "G-Code"

e44c2a7

Signed-off-by Paul Cutler [email protected]

Update Data Privacy page for readability, grammar, and spelling

c56c990

Signed-off-by Paul Cutler [email protected]

Update Credits for readability and grammar

2ddb98f

Signed-off-by Paul Cutler [email protected]

Update Quick Tips for grammar and readability.

c0ebcaf

Signed-off-by Paul Cutler [email protected]

Update Slicer and Update Manager for readability and grammar

74a3528

Signed-off-by Paul Cutler [email protected]

Review pages and fix / edit errors

172f12d

Signed-off-by Paul Cutler [email protected]

prcutler changed the title ~~:docs Update Quicktips~~ docs: Update Quicktips Jan 6, 2022

Fix extra space in Patreon

8ecff7e

Signed-off-by Paul Cutler [email protected]

lixxbox reviewed Jan 7, 2022

View reviewed changes

docs/data-privacy.md Outdated Show resolved Hide resolved

lixxbox reviewed Jan 7, 2022

View reviewed changes

lixxbox suggested changes Jan 7, 2022

View reviewed changes

lixxbox added the Is: Docs Anything referencing documentation label Jan 7, 2022

prcutler added 5 commits January 7, 2022 06:31

Update data privacy and multi-cam with review feedback

61e9f29

Signed-off-by Paul Cutler [email protected]

Update Remote Access with review feedback

1295c18

Signed-off-by Paul Cutler [email protected]

Update Slicer Upload with review feedback

ce0b123

Signed-off-by Paul Cutler [email protected]

Update the Update Manager page with review feedback

81b0a95

Signed-off-by Paul Cutler [email protected]

Update Sensors with feedback from Discord. Link to supported sensors …

27de984

…in Klipper Signed-off-by Paul Cutler [email protected]

prcutler requested a review from lixxbox January 7, 2022 12:47

Fix spelling of remotely caught in review

fad550b

Signed-off-by Paul Cutler [email protected]

lixxbox reviewed Jan 10, 2022

View reviewed changes

docs/quicktips/update-manager.md Outdated Show resolved Hide resolved

prcutler added 2 commits January 10, 2022 05:47

Fix typo of Mainsail requested by review

f2136cb

Signed-off-by Paul Cutler [email protected]

Rewrite second section for configuring a specific camera

71c5983

Signed-off-by Paul Cutler [email protected]

lixxbox approved these changes Jan 18, 2022

View reviewed changes

lixxbox merged commit be2efac into mainsail-crew:develop Jan 18, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Update Quicktips #518

docs: Update Quicktips #518

prcutler commented Jan 6, 2022

lixxbox Jan 7, 2022

lixxbox Jan 7, 2022

lixxbox Jan 7, 2022

lixxbox Jan 7, 2022

lixxbox Jan 7, 2022

lixxbox Jan 7, 2022

lixxbox Jan 7, 2022

lixxbox Jan 7, 2022

lixxbox Jan 7, 2022

lixxbox Jan 7, 2022

lixxbox Jan 7, 2022

lixxbox Jan 7, 2022

lixxbox Jan 7, 2022

lixxbox left a comment


		The following table applies to Mainsail when installed locallaly, or accessed via [my.mainsail.xyz](http://my.mainsail.xyz).
		The following table applies to Mainsail when installed locallly or accessed remotely at [my.mainsail.xyz](http://my.mainsail.xyz).


		Run `ls /dev/v4l/by-id`, copy your camera id and paste it into the editor in mainsail. For example:
		In a termina, run the comman `ls /dev/v4l/by-id`, copy your camera id and paste it into the editor in Mainsail. For example:


		Set `camera="usb"` at the top, and the `camera_usb_options` line to indicate the device:
		Add `camera="usb"` at the beginning of the file and then add a line with `camera_usb_options` to indicate the device:


		As above again, set camera="usb" and set camera_usb_options but this time using the ID for the second camera:
		Edit `/home/pi/klipper_config/webcam2.txt` as described above andd add:


		Adjust the port, by editing camera_http_options:
		Adjust the port by editing `camera_http_options`:


		If not already been done, switch to advanced or expert mode and set the options under `Printer Settings / General` as shown in the screenshot below.
		### PrusaSlicer / SuperSlicer (prior to Mainsail v2.3.0)

docs: Update Quicktips #518

docs: Update Quicktips #518

Conversation

prcutler commented Jan 6, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lixxbox left a comment

Choose a reason for hiding this comment