Skip to content

Settings

Jump to bottom
P0k3sm0t edited this page May 26, 2026 · 2 revisions

Settings

The Settings page controls Ray5 Pilot's local app configuration. It writes to config.json in the Ray5 Pilot folder.

Do not upload config.json to GitHub because it may contain private network details or camera URLs.

Open Settings

Use the top navigation:

Settings

Save changes with Save Config at the bottom of the page.

Settings cards

Ray5 Network

Use this for the Ray5 IP/host and connection settings.

Check this card when the Status card says the Ray5 is offline or HTTP is not reachable.

This card also includes WebSocket ping tuning:

  • WebSocket Ping Interval — automatic WebSocket ping interval in seconds. Use 0 to disable automatic pings.
  • WebSocket Ping Timeout — seconds to wait for a WebSocket ping response when pings are enabled.

The default ping interval is 0, which keeps automatic WebSocket pings disabled. This reduces extra traffic to the Ray5 ESP32 during long jobs.

Web UI

Controls the Ray5 Pilot web server host and port.

This card also includes Active Job Poll Interval, which controls how often Ray5 Pilot polls status while the machine is running, holding, jogging, or door-active. The default is 4.0 seconds.

Recommended local-only host:

127.0.0.1

Do not expose Ray5 Pilot to the internet. If you bind to 0.0.0.0, devices on your LAN may be able to reach the UI.

Camera

Set the camera URL used by the Dashboard video card, snapshots, overlay, and timelapse.

Use Camera Test on the Dashboard after changing this.

Camera Processing / Deskew

Controls processed snapshot output. This is used for overlay images like latest.jpg.

Useful settings include:

  • Deskew enabled
  • Deskew source points
  • Output width/height
  • Postprocess enabled
  • Final size
  • DPI
  • Overlay guides
  • Cross, border, and corner marks

Camera Overlay Alignment

Fine-tunes overlay alignment after the main camera calibration is close.

Use this when the overlay image is close but the actual burn lands slightly offset.

Imported Jobs

Controls local imported job storage and watched folder behavior.

Use this if files are not appearing in Imported Jobs or if the watched folder is not importing.

Framing

Controls generated frame behavior.

Frame settings affect how Ray5 Pilot moves around the job bounds for preview/framing. Keep workspace min/max correct so framing stays inside the usable bed.

Manual Controls

Controls jog step/feed defaults, preset move position, and manual control behavior.

SD Files

Controls SD file list behavior.

Common options include:

  • Auto-refresh
  • Refresh interval
  • Start actions
  • Download actions
  • Delete actions
  • Preview support if firmware supports it

Timelapse

Controls timelapse capture behavior.

Important options:

  • Enable timelapse
  • Snapshot interval
  • Final frame delay after job ends
  • Playback FPS
  • Image source: processed overlay or raw camera frame

When enabled, Upload + Run and SD Start can arm timelapse automatically. Run starts capture, Hold pauses, Run resumes, and Idle stops/saves.

Upload

Controls how files are uploaded to the Ray5 SD card.

Recommended default behavior is to preserve original file content unless troubleshooting.

Options include:

  • Preserve original file content
  • Sanitize filenames
  • Auto-shorten long Ray5 filenames
  • Optional screen-compatible rewrite
  • Optional M4 to M3 conversion
  • Force extension
  • Normalize line endings
  • G-code safety scanner

Job Control

Controls Pause/Resume/Stop behavior.

Default Stop behavior is intended to send laser off first, then abort with a soft reset when allowed.

Important options:

  • Stop mode
  • Allow soft reset stop
  • Send laser off before stop
  • Unlock after reset
  • Refresh status after stop

Status / Live Status

Controls WebSocket live status and related status behavior.

Known Ray5 live status settings normally include:

Port: 8849
Path: /
Subprotocol: arduino

Keep debug status logging off unless troubleshooting because it can create noisy logs.

For long-job stability, Ray5 Pilot can reduce background load by slowing active-job polling and disabling automatic WebSocket pings. The main user-facing controls for those values are in the Web UI and Ray5 Network cards.

Live Console

Controls whether the Dashboard console can send raw commands.

Options:

  • Enable raw console command sender
  • Confirm dangerous raw commands

Keep confirmation on if the command sender is enabled.

Safety

Controls low-power timed test fire.

Keep test fire disabled unless you are actively using it. Test fire still emits laser light.

Support / Update

Shows project links and update state.

Use GitHub Issues for bugs and feature requests. Use the update area to check and apply published releases.

Troubleshooting Settings

Problem Fix
Changes do not apply Click Save Config, then refresh Dashboard
App cannot reach Ray5 Check Ray5 Network IP/host
Camera does not work Check Camera URL, then run Test Camera
Live status not working Check Status / Live Status WebSocket settings
SD list is missing Check SD Files options and Ray5 connection
Test Fire button disabled Enable test fire in Safety settings
Console sender missing Enable raw console command sender
Update not offered Only tagged release ZIP assets with valid checksum are installed in-app

Clone this wiki locally