klipper icon indicating copy to clipboard operation
klipper copied to clipboard

Amend octoprint install instructions with `klippy.serial`

Open mlewis-everley opened this issue 1 year ago • 1 comments

The OctoPrint install instructions say 'add ~/printer_data/comms/klippy.sock' but it actually appears to be ~/printer_data/comms/klippy.serial, so I have updated this.

I also seemed to have issues connecting without /tmp/printer in additional ports, so added more information on this.

mlewis-everley avatar Sep 02 '24 14:09 mlewis-everley

Ah yes, this would be my cock up :) i did indeed put the sock and not the serial.

Please can you sign off your PR, and i will review and accept it as per point 3 in https://github.com/Klipper3d/klipper/blob/master/docs/CONTRIBUTING.md#what-to-expect-in-a-review

Thanks James

JamesH1978 avatar Sep 03 '24 09:09 JamesH1978

Thank you for your contribution to Klipper. Unfortunately, a reviewer has not assigned themselves to this GitHub Pull Request. All Pull Requests are reviewed before merging, and a reviewer will need to volunteer. Further information is available at: https://www.klipper3d.org/CONTRIBUTING.html

There are some steps that you can take now:

  1. Perform a self-review of your Pull Request by following the steps at: https://www.klipper3d.org/CONTRIBUTING.html#what-to-expect-in-a-review If you have completed a self-review, be sure to state the results of that self-review explicitly in the Pull Request comments. A reviewer is more likely to participate if the bulk of a review has already been completed.
  2. Consider opening a topic on the Klipper Discourse server to discuss this work. The Discourse server is a good place to discuss development ideas and to engage users interested in testing. Reviewers are more likely to prioritize Pull Requests with an active community of users.
  3. Consider helping out reviewers by reviewing other Klipper Pull Requests. Taking the time to perform a careful and detailed review of others work is appreciated. Regular contributors are more likely to prioritize the contributions of other regular contributors.

Unfortunately, if a reviewer does not assign themselves to this GitHub Pull Request then it will be automatically closed. If this happens, then it is a good idea to move further discussion to the Klipper Discourse server. Reviewers can reach out on that forum to let you know if they are interested and when they are available.

Best regards, ~ Your friendly GitIssueBot

PS: I'm just an automated script, not a human being.

github-actions[bot] avatar Sep 17 '24 12:09 github-actions[bot]

I have an issue with ~/printer_data/comms/klippy.serial ~/printer_data/comms/klippy.serial is not an existing link. It should be linked to what user try to open that link. I didn't find a way to discover what user it is. Then in my case I have to specify the full path: /home/pi/printer_data/comms/klippy.serial

On my system in /etc/systemd/system/octoprint.service, I have:

User=pi
ExecStart=/home/pi/OctoPrint/venv/bin/octoprint serve

rongith avatar Oct 03 '24 14:10 rongith

fixed by https://github.com/Klipper3d/klipper/pull/6716

JamesH1978 avatar Oct 22 '24 14:10 JamesH1978

@rongith are you saying that octoprint itself does not recognize ~ as a placeholder for /home//

If so, i will make some amendments.

Thanks, and sorry for missing your reply

James

JamesH1978 avatar Oct 22 '24 15:10 JamesH1978

@JamesH1978. No worries for the delay because I found a solution. It just took time (I wasn't efficient) to find it because first I was on a quite old version of klipper with the /tmp/printer and I goggled my issue instead of having a look at the documentation and dig a bit. I thought it was a user issue but you are probably right that the tilde expansion is not recognize in Octoprint. But I can't find any reference about that. Here the consequence of the declaration of the path to the serial: Screenshot 2024-10-22 174743 Screenshot 2024-10-22 174919 Screenshot 2024-10-22 174942 Screenshot 2024-10-22 175015

Here defaults fields for other paths in Octoprint: Screenshot 2024-10-22 175538

I find strange to be alone to complain. @mlewis-everley, is it working for you ~/printer_data/comms/klippy.serial ?

rongith avatar Oct 22 '24 16:10 rongith

If the tilde expansion is not supported, one cause may be that Octoprint is OS agnostic.

rongith avatar Oct 22 '24 16:10 rongith

i will do some testing and confirm if the tilde is supported or not, and then make a change accordingly, maybe just state /home/<your user>/printer_data , it shouldnt matter for older /tmp/printer

Thanks James

JamesH1978 avatar Oct 22 '24 17:10 JamesH1978

The tilde expansion works in Octoprint for Folders and for plugins like Octoklipper. But not for me for the serial ports. :thinking: image image Moreover the Octoprint Folders section replace automatically ~ by /home/username when you save. There should be some tricks under the hood here.

rongith avatar Oct 23 '24 10:10 rongith

This ticket is being closed because the underlying issue is now thought to be resolved.

Best regards, ~ Your friendly GitIssueBot

PS: I'm just an automated script, not a human being.

github-actions[bot] avatar Oct 30 '24 12:10 github-actions[bot]