-
Notifications
You must be signed in to change notification settings - Fork 236
Add basic linux troubleshooting tips #1885
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
samfreund
wants to merge
20
commits into
PhotonVision:main
Choose a base branch
from
samfreund:add-troubleshooting-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
ec38eb7
Update website.yml
samfreund c1c7e7c
Update website.yml
samfreund 64b4203
Update website.yml
samfreund 6a2e69e
Update website.yml
samfreund 14178a1
Update website.yml
samfreund e675ca5
Update website.yml
samfreund 0ca0a34
Update website.yml
samfreund e923788
Update website.yml
samfreund df3f435
Merge branch 'main' of github.com:samfreund/photonvision
samfreund 207f097
add unix-troubleshooting to docs
samfreund 233c4db
Merge branch 'main' into add-troubleshooting-docs
samfreund f86fdaf
update to test this is accurate
samfreund 3224c48
Merge branch 'add-troubleshooting-docs' of github.com:samfreund/photo…
samfreund 84c7f24
updated format
samfreund 6b4a0e5
fix links
samfreund b447a81
add code formatting
samfreund 810e4c0
Merge branch 'main' into add-troubleshooting-docs
samfreund d044c77
Update docs/source/docs/troubleshooting/unix-commands.md
samfreund a460326
Merge branch 'main' into add-troubleshooting-docs
samfreund 8f9c3ee
Merge branch 'main' into add-troubleshooting-docs
samfreund File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,4 +7,5 @@ common-errors | |
logging | ||
camera-troubleshooting | ||
networking-troubleshooting | ||
unix-commands | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
Useful Unix Commands | ||
==================== | ||
|
||
SSH | ||
--- | ||
|
||
[SSH (Secure Shell)](https://www.mankier.com/1/ssh) is used to securely connect from a local to a remote system (ex. from a laptop to a coprocessor). Unlike other commands on this page, ssh is not Unix specific and can be done on Windows and MacOS from their respective terminals. | ||
|
||
:::{note} | ||
You may see a warning similar to `The authenticity of host 'xxx' can't be established...` or `WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED!`, in most cases this can be safely ignored if you have confirmed that you are connecting to the correct host over a secure connection, and the fingerprint will change when your operating system is reinstalled or PhotonVision's coprocessor image is re-flashed. You can read more about it [here](https://superuser.com/questions/421997/what-is-a-ssh-key-fingerprint-and-how-is-it-generated) | ||
::: | ||
|
||
Example: | ||
|
||
:::{code-block} | ||
ssh username@hostname | ||
::: | ||
|
||
ip | ||
-- | ||
|
||
Run [ip address](https://www.mankier.com/8/ip) with your coprocessor connected to a monitor in order to see its IP address and other network configuration information. | ||
|
||
|
||
SCP | ||
--- | ||
|
||
[SCP (Secure Copy)](https://www.mankier.com/1/scp) is used to securely transfer files between local and remote systems. | ||
|
||
Example: | ||
|
||
:::{code-block} | ||
scp [file] username@hostname:/path/to/destination | ||
::: | ||
|
||
v4l2-ctl | ||
-------- | ||
|
||
[v4l2-ctl](https://www.mankier.com/1/v4l2-ctl) is a command-line tool for controlling video devices. | ||
|
||
List available video devices (used to verify the device recognized a connected camera): | ||
|
||
:::{code-block} | ||
v4l2-ctl --list-devices | ||
::: | ||
|
||
List supported formats and resolutions for a specific video device: | ||
|
||
:::{code-block} | ||
v4l2-ctl --list-formats-ext --device /path/to/video_device | ||
::: | ||
|
||
List all video device's controls and their values: | ||
|
||
:::{code-block} | ||
v4l2-ctl --list-ctrls --device path/to/video_device | ||
::: | ||
|
||
:::{note} | ||
This command is especially useful in helping to debug when certain camera controls, like exposure, aren't behaving as expected. If you see an error in the logs similar to `WARNING 30: failed to set property [property name] (UsbCameraImpl.cpp:646)`, that means that PhotonVision is trying to use a control that doesn't exist or has a different name on your hardware. If you encounter this issue, please [file an issue](https://github.com/PhotonVision/photonvision/issues) with the necessary logs and output of the `v4l2-ctl --list-ctrls` command. | ||
::: |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sftp is another option.