-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the Ray5 Pilot Wiki.
This wiki contains setup guides, feature notes, troubleshooting help, and workflow instructions for using Ray5 Pilot with a Longer Ray5 laser engraver.
Ray5 Pilot is a local web controller for the Longer Ray5 using the ESP3D-style HTTP/WebSocket interface. It includes dashboard controls, camera overlay tools, live video pop-out support, timelapse support, SD file management, firmware settings, launcher options, update tools, and workflow helpers for compatible laser software.
Ray5 Pilot v1.1.2 adds several safety and reliability improvements that are documented throughout this wiki:
- communication-loss safety lockout for active or recently started jobs
- SD Card Files auto-refresh pause during active/busy machine states and communication-loss lockout
- non-blocking job-mode timelapse stop/save/build handling
- configurable Timelapse final frame delay after normal job completion
- improved live camera stream lifecycle handling
- corrected Pause/Resume handling for GRBL real-time commands
- stale/deleted timelapse playback cleanup
Start with the Status, Safety, SD Card Files, Timelapse, Manual Controls, and Troubleshooting guides for the most important v1.1.2 behavior changes.
Start here if you are setting up Ray5 Pilot for the first time.
This guide covers:
- Installing requirements
- Starting Ray5 Pilot
- First-time Settings configuration
- Ray5 network setup
- Camera setup
- Dashboard overview
- Manual Controls
- Imported Jobs
- SD Card Files
- Timelapse
- Camera Overlay
- Firmware Settings
- Live Console
- Basic troubleshooting
Open the Setup and Usage Guide
Use this guide to understand the different ways to start Ray5 Pilot.
This guide covers:
- Manual
python app.pylaunch - BAT launcher files
- Optional
Ray5 Pilot.exelauncher - Desktop shortcut setup
- What the EXE launcher does and does not do
- GitHub
.gitignorenotes for tracking the launcher EXE - Troubleshooting launcher problems
Open the Launcher Options Guide
Use this guide to understand every card and setting on the Settings / Setup page.
This guide covers:
- Ray5 Network
- Web UI
- Camera
- Camera Processing / Deskew
- Camera Overlay Alignment
- Imported Jobs
- Framing
- Manual Controls
- SD Files
- Timelapse
- Upload
- Job Control
- Status / Live Status
- Live Console
- Safety
- Support
Use this guide to understand the Dashboard Status card and System Check section.
This guide covers:
- Ray5 state
- PAGEID
- X/Y position
- WCO
- Feed and laser values
- Alarm and job state
- Connection status
- Status source and coordinate source
- Ray5 Pilot version display
- Startup update status display
- System Check items
- Status troubleshooting
Use this guide to understand the Dashboard Video / Camera card.
This guide covers:
- Live camera feed
- Enable/Disable Video behavior
- Disabled-video placeholder
- Pop Out Video
- Dashboard placeholder while live video is popped out
- Dashboard live video restore when the pop-out closes
- Timelapse playback in the Video / Camera card
- Keeping completed timelapse playback visible
- Snapshot and overlay relationship
- Camera/video troubleshooting
Open the Video / Camera Card Guide
Use this guide to understand the Dashboard Manual Controls card.
This guide covers:
- Jog step and feedrate
- X/Y jog movement
- Diagonal moves
- Center button
- Home button
- Go To Preset
- Unlock / Clear Alarm
- Air On / Air Off
- Pause / Resume / Stop Job
- Test Fire safety
- Manual movement troubleshooting
Open the Manual Controls Guide
Use this guide to understand the Imported Jobs workflow and watched-folder auto-import.
This guide covers:
- What Imported Jobs are
- Manual import workflow
- Watched folder auto-import workflow
- Saving directly from laser software to the watched folder
- Frame, Upload, and Upload + Run
- Filename length notes for the Ray5 screen
- Rejected file behavior
- Best practices for job staging and cleanup
Open the Imported Jobs and Watched Folder Guide
Use this guide to manage files stored on the Ray5 SD card from the Dashboard.
This guide covers:
- Refreshing the SD file list
- Uploading files to SD
- Starting files from SD
- Deleting SD files
- SD Files settings
- Filename length notes
- Timelapse behavior with SD Start
- Troubleshooting SD file list, upload, start, and delete problems
Use this guide to understand upload behavior and Ray5 filename compatibility.
This guide covers:
- Imported Jobs upload
- Upload + Run
- Direct SD upload
- Supported file extensions
- Preserving original file content
- Sanitizing uploaded filenames
- Ray5 screen filename length limits
- Auto-shortening long filenames
- Optional upload rewrite settings
- G-code safety scanner behavior
Open the Upload and Filename Compatibility Guide
Use this guide to set up and adjust the Ray5 Pilot camera overlay system.
This guide covers:
- Setting up a camera feed
- Taking overlay snapshots
- Understanding raw vs processed overlay images
- Calibrating the overlay
- Adjusting X and Y source offsets
- Using scale to fine-tune the overlay view
- Testing alignment with a grid
- Using the processed overlay image as a reference in laser software
Open the Camera Overlay Configuration and Setup Guide
Use this guide to understand the Dashboard Timelapse card and timelapse capture behavior.
This guide covers:
- Manual timelapse start/stop
- Job-based timelapse behavior
- Timelapse file list usage
- Playing saved timelapses
- Deleting timelapse files
- Timelapse output/session folders
- MP4 creation with ffmpeg
- Troubleshooting timelapse capture and playback
Use this guide before reading, backing up, or changing Ray5/GRBL controller firmware settings.
This guide covers:
- Opening the Firmware Settings page
- Reading settings with
$$ - Downloading a backup
- Understanding the settings table
- Editing one setting at a time
- Saving changed settings
- Restoring a previous value
- Common GRBL settings
- Firmware Settings safety warnings
Open the Firmware Settings Usage Guide
Use this guide to understand what can and cannot be sent from the Dashboard Live Console.
This guide covers:
- Safe diagnostic commands
- Motion commands
- Laser-off commands
- Alarm and reset commands
- Laser-on command warnings
- Commands to avoid
- Safer UI alternatives
- Troubleshooting console responses
- Good console habits
Use this guide before using Test Fire or changing safety-related settings.
This guide covers:
- General laser safety notes
- Enable Test Fire
- Test Fire S-value
- Test Fire duration
- What Test Fire sends
- Stop Job safety
- Unlock / Clear Alarm safety
- G-code safety scanner
- Live Console safety
- Firmware Settings safety
- Emergency behavior
Open the Safety and Test Fire Guide
Use this guide to update Ray5 Pilot using either the built-in update workflow or manual source ZIP workflow.
This guide covers:
- Check for Updates
- Download Latest Source
- Update Ray5 Pilot
- Built-in updater flow
- Preserved files and folders
- Allowlisted update files
- Update backups and logs
- Manual update workflow
- Testing update detection
- Troubleshooting update failures
Use this guide to understand how Ray5 Pilot fits with different laser design and G-code workflows.
This guide covers:
- General laser software workflow
- Exporting compatible G-code
- Work area and origin considerations
- Using LightBurn or similar laser software
- Using LaserGRBL-style workflows
- SVG/DXF design software plus G-code export
- Using Ray5 Pilot camera overlay images in other laser software
- Framing jobs before running
- Timelapse workflow with laser software jobs
Open the Laser Software Workflows Guide
Use this guide when something does not connect, load, move, upload, update, or behave as expected.
This guide covers:
- Ray5 connection issues
- WebSocket / PAGEID problems
- SD Card Files problems
- Imported Jobs problems
- File rejection
- Camera feed issues
- Camera overlay alignment
- Timelapse troubleshooting
- Firmware Settings troubleshooting
- Manual Controls troubleshooting
- Update troubleshooting
- Config and browser cache problems
- Safe recovery steps
Open the Troubleshooting Guide
Use this page for quick answers to common Ray5 Pilot questions.
This page covers:
- General Ray5 Pilot questions
- Setup questions
- Dashboard questions
- Imported Jobs questions
- SD Card Files questions
- Upload and filename questions
- Camera and overlay questions
- Timelapse questions
- Manual Controls questions
- Firmware Settings questions
- Live Console questions
- Update questions
- Safety questions
If you are new to Ray5 Pilot, start here:
- Setup and Usage Guide
- Launcher Options Guide
- Settings Page Guide
- Status Card Guide
- Video / Camera Card Guide
- Manual Controls Guide
- Imported Jobs and Watched Folder Guide
- SD Card Files Guide
- Upload and Filename Compatibility Guide
- Camera Overlay Configuration and Setup Guide
- Timelapse Card Guide
- Firmware Settings Usage Guide
- Live Console Guide
- Safety and Test Fire Guide
- Update Guide
- Using Ray5 Pilot With Different Laser Software Workflows
- Troubleshooting Guide
- FAQ
Ray5 Pilot controls a laser engraver. Always supervise laser operation, use proper eye protection, keep fire safety equipment nearby, and verify all settings and files before running a job.
Changing firmware settings can affect motion limits, homing, acceleration, travel, and laser behavior. Back up your settings first and change only values you understand.
Do not expose Ray5 Pilot to the internet. The default local address is intended for local use.