Skip to content

Remove unused commands from the custom hardware configuration documentation #2343

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.

Sign up for GitHub

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

Merged
crschardt merged 4 commits into from
Jan 30, 2026
Merged

Remove unused commands from the custom hardware configuration documentation #2343

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
deb116b
Remove hardware-specific commands that are no longer used
crschardt Jan 30, 2026
56d1d22
Fix typo in comment
crschardt Jan 30, 2026
22245e5
fix another typo
crschardt Jan 30, 2026
e8bb1f8
Update docs/source/docs/hardware/customhardware.md
crschardt Jan 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 4 additions & 16 deletions docs/source/docs/hardware/customhardware.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,27 +73,21 @@ If you were using custom LED commands from 2025 or earlier and still need custom

## Hardware Interaction Commands

For Non-Raspberry-Pi hardware, users must provide valid hardware-specific commands for some parts of the UI interaction (including performance metrics, and executing system restarts).
For Non-Linux hardware, users must provide the hardware-specific command for executing system restarts.

Leaving a command blank will disable the associated functionality.
Leaving this command blank will disable the restart functionality.

```{eval-rst}
.. tab-set-code::
.. code-block:: json

{
"cpuTempCommand" : "",
"cpuMemoryCommand" : "",
"cpuUtilCommand" : "",
"gpuMemoryCommand" : "",
"gpuTempCommand" : "",
"ramUtilCommand" : "",
"restartHardwareCommand" : "",
}
```

:::{note}
These settings have no effect if PhotonVision detects it is running on a Raspberry Pi. See [the MetricsBase class](https://github.com/PhotonVision/photonvision/blob/dbd631da61b7c86b70fa6574c2565ad57d80a91a/photon-core/src/main/java/org/photonvision/common/hardware/metrics/MetricsBase.java) for the commands utilized.
This setting has no effect if PhotonVision detects it is running on Linux. On Linux, the restart is accomplished by executing `reboot now` in a shell.
:::

## Known Camera FOV
Expand Down Expand Up @@ -150,13 +144,7 @@ Here is a complete example `hardwareConfig.json`:
"setGPIOCommand" : "setGPIO {p} {s}",
"setPWMCommand" : "setPWM {p} {v}",
"setPWMFrequencyCommand" : "setPWMFrequency {p} {f}",
"releaseGPIOCommand" : "releseGPIO {p}",
"cpuTempCommand" : "",
"cpuMemoryCommand" : "",
"cpuUtilCommand" : "",
"gpuMemoryCommand" : "",
"gpuTempCommand" : "",
"ramUtilCommand" : "",
"releaseGPIOCommand" : "releaseGPIO {p}",
"restartHardwareCommand" : "",
"vendorFOV" : 72.5
}
Expand Down
2 changes: 1 addition & 1 deletion photon-core/src/main/java/org/photonvision/common/configuration/SqlConfigProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ private <T> T loadConfigOrDefault(
} else {
logger.debug("No " + ref.getSimpleName() + " in database");
}
// either the config entry is empty or Jackson threw and exception
// either the config entry is empty or Jackson threw an exception
try {
configObj = factory.get();
logger.info("Loaded default " + ref.getSimpleName());
Expand Down
Loading