Main /
File Locations
All Rose Engine Butler files are kept in the Git repository on GitHub (↗ web site), and installed at
/home/reuben/linuxcnc/configs/RoseEngineButler
Update Rose Engine Butler (REB_Update.sh) pulls the latest versions of these files from GitHub - see Updating Rose Engine Butler. The only per-machine settings file lives outside the repository, in /home/reuben/Documents.
Per-machine files (not in the repository)
| File | Purpose |
| /home/reuben/Documents/REBset_v1.ini | This machine's settings: axis/channel assignments (channels 00 - 09), whether the expansion box is connected, scale, backlash, PID, max velocity/acceleration, jog speeds, measurement system, device names, limit jacks, E-stop button, signal tower. Written by the Settings program and by REB_Scale_Persist.py at LinuxCNC shutdown. A JSON file, despite the .ini name. Back this up. |
| /home/reuben/.axisrc | AXIS window size/position; copied from REB_Setup/axisrc at install. |
| /home/reuben/ClamAv/ | Virus scan log and quarantined files. |
| /home/reuben/linuxcnc/configs/RoseEngineButler/REB.local.ini, REB.local.hal, REB_Display/REB_PostGUI_v1.local.hal | Generated at every launch from REB.ini / REB.hal / REB_PostGUI_v1.hal and REBset_v1.ini - these are what LinuxCNC actually loads. Never edit them - they are overwritten at the next start. See Launching Rose Engine Butler. |
| /home/reuben/linuxcnc/configs/RoseEngineButler/gcode/ | Operator's G-code programs (not in the repository). |
| /home/reuben/linuxcnc/configs/RoseEngineButler/sim.var, linuxcnc.var | LinuxCNC parameter files (runtime). |
/home/reuben/linuxcnc/configs/RoseEngineButler
| File | Purpose | Edit? |
| REB_Launch.sh | What the desktop icon runs: generates the .local files, then starts LinuxCNC on REB.local.ini. | No |
| REB_Settings.sh | Starts the Rose Engine Butler Settings program. | No |
| REB_Change_Network.sh | Sets up the Mesa cards' addresses (base 10.10.10.10, expansion 10.10.10.11) and the Raspberry Pi's wired connection (10.10.10.100); check shows which cards answer. See Mesa 7i92. | No |
| REB_Backup.sh | What the Backup Rose Engine Butler icon runs. | No |
| REB_Update.sh | Pulls updates from GitHub, then runs apt update / upgrade. | No |
| REB.ini | Master LinuxCNC configuration template (all axis tuning defaults live in its [JOINT_n] / [SPINDLE_n] sections). | No |
| REB.hal | Realtime HAL template: Mesa card(s), stepgens, PID loops, E-stop latch. Its loadrt hm2_eth line is rewritten at every launch for one or both cards. | No |
| REB_Shutdown.hal | Runs REB_Scale_Persist.py at shutdown to save live values. | No |
| REBStartupImage.gif | Splash image shown while LinuxCNC starts. | No |
| .axisrc | Copy of the AXIS window settings. | No |
REB_Custom/
| File | Purpose | Edit? |
| REB_Custom.hal | The place for machine-specific HAL additions (loaded after REB.hal). | Yes* |
| REB_Tool.tbl | LinuxCNC tool table. | Yes* |
* These are tracked in Git, so Update Rose Engine Butler stashes local changes to them - see Updating Rose Engine Butler.
REB_Display/
| File | Purpose |
| REB_main.py | Python handler for the side panel and the Help / License tabs (see GladeVCP). |
| REB_Panel_v1.ui | The main side panel (Indexing, Sync Move, Threading). |
| REB_Tab_Help_v1.ui, REB_Tab_TsCs_v1.ui | The ℛ Help and ℛ License tabs. |
| REB_PostGUI_v1.hal | HAL wiring for the panel's ENA buttons and status (template for the .local copy). |
| REB_Settings.py, REB_Settings_v1.ui | The standalone Rose Engine Butler Settings program. |
| reb_settings_io.py | Shared reader/writer for REBset_v1.ini. |
| REB_Settings_Restore.py | Applies saved scale / PID / velocity values to the HAL pins at startup. |
| REB_Scale_Persist.py | Saves the live values back to REBset_v1.ini at shutdown. |
| REB_Splash.ngc | The G-code file opened at startup. |
| Images/ | Panel images. |
REB_Setup/
| File | Purpose |
| REB_Generate_Local_Ini.py | Builds REB.local.ini and the .local.hal files at each launch (see Launching Rose Engine Butler). |
| REB_Install_Debian_13_Trixie.sh | Installer for new systems (Installation and Setup for Debian 13 Trixie); sets up the base card with REB_Change_Network.sh. |
| REB_Update_Settings.py | Run by REB_Update.sh: adds new settings to this machine's REBset_v1.ini (see Updating Rose Engine Butler). |
| REB_Install_Debian_12_Bookworm.sh | Installer for older Debian 12 systems. |
| REBset_v1.ini | Starting settings copied to /home/reuben/Documents at install. |
| axisrc, lightdm.conf | Copied into place at install. |
| MesaCard/ | 7i92 firmware (7i92t_REB.bin, used on both the base and expansion cards), pin file, and VHDL source (PIN_REB_34.vhd). |
| Images/ | Desktop icons, wallpaper, and logo. |
REB_Subroutines/
| File | Purpose |
| reb_thread.ngc, reb_thread_return.ngc | G-code subroutines used by the Threading tab. |
docs/
Design notes for developers (e.g., settings_file.md describes REBset_v1.ini in detail).
|
eMail comments to |