OpenValence Download

Troubleshooting

The messages Phosphor shows, quoted from the app, and what to do about each. Search this page for the one you see.

Finding and joining a machine

Scan and connect

Set up and pairing

When Home pulses a red border, the machine needs homing before it will move.

Pauses, stutter and lag

Open Log, then the Health tab. It has three cards, Link, This device and Machine, and a list of incidents kept on this device. The same line also appears in the top strip's status slot. Each line is a measurement, followed by the one thing to try.

The Health tab of the Log page showing the link readings, with the This device section below.
The Health tab of the Log page.
  1. The Health tab.
  2. Status reads Good when nothing is wrong.
  3. Round trip gives the typical and the slowest time.
  4. "Not reported by this machine" means it does not send that number.
  5. Updates per second, from the machine and to it.
  6. This device starts below Link.

This device

Machine

Some Machine lines read "not reported by this machine". The machine has to declare those readings first WIP.

Send a report

On an incident, Send report opens a review of every field in the report. Hold the button for 1.5 s to send. That opens a prefilled GitHub issue under your own account; Phosphor sends nothing itself. Save report writes the same data to a file without an account. The report holds numbers and version strings, and no script name, machine name, address or log text.

The log

The Log page has tabs for Log, Anomalies, Safety, Session, Changes and Health. The Log tab filters by Errors, Warnings, Info and Debug, and by source, and it searches. Plugin errors appear there tagged plugin:<name>.

The Log tab with its search field, severity filters, source filter and the Pause, Clear and Copy buttons.
The Log tab and its filters.
  1. Search, with F3 as the shortcut.
  2. Severity filters: Errors, Warnings, Info and Debug.
  3. The source filter.
  4. Pause freezes the list so new lines stop scrolling in.
  5. Clear empties the list.
  6. Copy puts the shown lines on the clipboard.

Phosphor also writes Phosphor.log to disk, at Info level, in release builds too. It is never uploaded. The privacy page lists the app's data folders on each platform, and for the Flatpak the folder is ~/.var/app/org.openvalence.Phosphor.

Platform notes

Linux with an NVIDIA driver

NVIDIA's proprietary driver cannot back WebKitGTK's DMABUF renderer. Without a workaround the window stays blank on X11, and the Wayland connection dies with protocol error 71. Phosphor sets WEBKIT_DISABLE_DMABUF_RENDERER=1 by itself when /proc/driver/nvidia exists, and a value you set yourself wins. If the window is still blank, start Phosphor with that variable set.

Linux Flatpak

The Flatpak keeps its data in ~/.var/app/org.openvalence.Phosphor/data/com.phosphor.app/, and a .deb install's folder is not visible to it. If you forced GDK_BACKEND=x11 on a Wayland session, GTK fails to start unless the run adds --socket=x11.

macOS

CI builds are ad-hoc signed and not notarized. After you copy Phosphor out of the .dmg, either run xattr -dr com.apple.quarantine /Applications/Phosphor.app or use System Settings, Privacy & Security, Open Anyway after the first refused launch. macOS then asks for two permissions, Local Network (to find machines) and Bluetooth (to set them up). Without Local Network, scans fail without an error, so allow both.

Windows

Phosphor needs Microsoft's WebView2, which comes with Windows 11 and current Windows 10. Windows 10 LTSC and IoT lack it: the installer downloads it during setup, or install the WebView2 Runtime (x64 offline installer). Windows asks about the firewall the first time you turn on Settings, Open to LAN. Phosphor never edits firewall rules.

Open to LAN

<port> unavailable or Not open: … means the port could not be used. A port below 1024 needs privileges on Linux and macOS. Phosphor falls back to a port the system picks and advertises that one.

Buttplug server

If the server will not start, the Buttplug pane shows the latest error, for example that the port is taken. The default port is 12345. Change it in the pane's Settings tab. The port and the device types can only change while the server is stopped.

Android

Android requires the location permission before any app can scan for Bluetooth devices. Phosphor asks for it for that reason only.