docs: Update to include troubleshooting and contact page.
This commit is contained in:
parent
145d9c1d84
commit
f681676e8d
13
docs/Contact.md
Normal file
13
docs/Contact.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
# Contact
|
||||||
|
|
||||||
|
There are several ways to contact people who can assist with issues. Discord is going to be the quickest response as
|
||||||
|
there will be more people in the chat who can help.
|
||||||
|
|
||||||
|
## GitHub Issues
|
||||||
|
You may submit a GitHub issue request for any problems you are having.
|
||||||
|
|
||||||
|
## Klipper Community Discord
|
||||||
|
|
||||||
|
The invite link: https://discord.klipper3d.org/
|
||||||
|
|
||||||
|
Look for the channel `#klipper-screen`
|
32
docs/Troubleshooting.md
Normal file
32
docs/Troubleshooting.md
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
# Troubleshooting
|
||||||
|
|
||||||
|
This page will have common problems and common solutions to those problems.
|
||||||
|
|
||||||
|
## First Steps
|
||||||
|
|
||||||
|
The first step to troubleshooting any problem is getting the cause of the error. KlipperScreen log output will occur
|
||||||
|
in two places. Check for the file `/tmp/KlipperScreen.log` and look at the contents by running
|
||||||
|
`cat /tmp/KlipperScreen.log` or grabbing the file over WinSCP or another scp program.
|
||||||
|
|
||||||
|
If that file is non-existent, there is a problem in KlipperScreen starting up. To get the error output in this case,
|
||||||
|
run `journalctl -xe -u KlipperScreen`.
|
||||||
|
|
||||||
|
|
||||||
|
## Common Errors
|
||||||
|
|
||||||
|
### Problems occuring before the log file appears
|
||||||
|
|
||||||
|
This section will detail problems that may happen before the log file has been created. Each section will start with a
|
||||||
|
relevant line from the journalctl output.
|
||||||
|
|
||||||
|
#### Cannot open virtual Console
|
||||||
|
```
|
||||||
|
xf86OpenConsole: Cannot open virtual console 2 (Permission denied)
|
||||||
|
```
|
||||||
|
|
||||||
|
* Check /etc/X11/Xwrapper.conf
|
||||||
|
This should have the line `allowed_users=anybody` in it
|
||||||
|
* Check /etc/group
|
||||||
|
Run the command `cat /etc/group | grep tty`. If you username is not listed under that line, you need to add it with the
|
||||||
|
following command (if you username is not 'pi' change 'pi' to your username):
|
||||||
|
`usermode -a -G tty pi`
|
@ -15,15 +15,6 @@ However, three resolutions are tested during development: 1024x600, 800x480, 480
|
|||||||
There are no recommended screens, but there are several screens that work with KlipperScreen. They include screens that
|
There are no recommended screens, but there are several screens that work with KlipperScreen. They include screens that
|
||||||
use HDMI/USB, Raspberry Pi GPIO, or the Rapsberry Pi DSI (ribbon cable) port.
|
use HDMI/USB, Raspberry Pi GPIO, or the Rapsberry Pi DSI (ribbon cable) port.
|
||||||
|
|
||||||
### Links
|
|
||||||
|
|
||||||
[Installation](Installation.md)
|
|
||||||
|
|
||||||
[Configuration](Configuration.md)
|
|
||||||
|
|
||||||
[Panels](panels.md)
|
|
||||||
|
|
||||||
|
|
||||||
### Sample Panels
|
### Sample Panels
|
||||||
|
|
||||||
Main Menu
|
Main Menu
|
||||||
|
@ -3,8 +3,10 @@ nav:
|
|||||||
- Hardware.md
|
- Hardware.md
|
||||||
- Installation.md
|
- Installation.md
|
||||||
- Configuration.md
|
- Configuration.md
|
||||||
|
- Troubleshooting.md
|
||||||
- changelog.md
|
- changelog.md
|
||||||
- panels.md
|
- panels.md
|
||||||
|
- Contact.md
|
||||||
theme: readthedocs
|
theme: readthedocs
|
||||||
repo_url: https://github.com/jordanruthe/KlipperScreen/
|
repo_url: https://github.com/jordanruthe/KlipperScreen/
|
||||||
plugins:
|
plugins:
|
||||||
|
Loading…
x
Reference in New Issue
Block a user