Rose Engine Butler's Key Programs
Rose Engine Butler’s Key Programs: Overview · REB_Launch.sh · REB_Settings.sh · REB_Backup.sh · REB_Update.sh · REB_Change_Network.sh · REB_Install_Debian_13_Trixie.sh
The REB_x.sh scripts are how the operator - and support - start every part of Rose Engine Butler. Each one is short; most of them only start a Python program, which does the real work. All of them live in /home/reuben/linuxcnc/configs/RoseEngineButler (the installer is in its REB_Setup folder).
| Script | Started from | What it does | Main program |
| REB_Launch.sh | Rose Engine Butler icon | Builds this machine's configuration, then starts LinuxCNC. | REB_Generate_Local_Ini.py, linuxcnc |
| REB_Settings.sh | REB Settings icon | Changes this machine's setup and tuning (LinuxCNC closed). | REB_Settings.py |
| REB_Backup.sh | Back Up to USB icon | Copies settings, G-code, tool table and custom HAL to a USB stick. | REB_Backup.py |
| REB_Update.sh | Update Rose Engine Butler icon | Latest files from GitHub, new settings, system updates. | git, REB_Update_Settings.py, apt |
| REB_Change_Network.sh | Terminal (support) | Sets up the Mesa cards' addresses and the Pi's wired network; check shows which cards answer. | mesaflash, nmcli |
| REB_Install_Debian_13_Trixie.sh | Terminal, once (new machine) | Network, Mesa card, key files, extra programs, folder shortcuts and serial number. | nmcli, REB_Change_Network.sh, apt |
Running any of them from a terminal
The desktop icons hide everything the programs print. When something doesn't work, run the same script in a terminal window and read the messages:
|
cd /home/reuben/linuxcnc/configs/RoseEngineButler |
"Permission denied" means the script isn't marked as runnable (a script can lose it when it is copied by hand): run it as bash ./REB_Launch.sh, or restore the permission with chmod +x REB_*.sh.
Rules they share
- One at a time. REB Settings and the network script refuse to run while LinuxCNC is running; close LinuxCNC before an update too.
- Settings live in one file: /home/reuben/Documents/REBset_v1.ini. REB Settings writes it, LinuxCNC saves live values into it at shutdown, the update adds new settings to it, and Back Up to USB copies it. REB_Launch.sh only reads it.
- Changes apply at the next launch. Nothing changed in REB Settings, by an update or by the network script reaches a running LinuxCNC.
- Don't edit the scripts. An update replaces them, and changes to them aren't supported. Machine-specific HAL additions belong in REB_Custom/REB_Custom.hal.
Other programs support may meet
These are started by the scripts above or by LinuxCNC, not by the operator:
- REB_Setup/REB_Generate_Local_Ini.py - builds REB.local.ini and the .local HAL files at every launch (see REB_Launch.sh).
- REB_Setup/REB_Update_Settings.py - adds new settings during an update (see REB_Update.sh).
- REB_Display/REB_main.py - the AXIS side panel (Indexing, Sync Move, Threading).
- REB_Display/REB_Settings_Restore.py - puts the saved scale, PID and limits onto the HAL pins as LinuxCNC starts.
- REB_Display/REB_Scale_Persist.py - saves the live values to REBset_v1.ini at shutdown (run by REB_Shutdown.hal).
- REB_Display/reb_settings_io.py - shared code that reads and writes REBset_v1.ini for all of the above.
- REB_Display/REB_Backup.py - the Back Up to USB window (see REB_Backup.sh).
- REB_Display/REB_Program_Estimate.py - started by the side panel when a G-code program starts, to work out the progress bar's percentages.
- REB_Setup/REB_Add_Shortcuts.sh - adds the RoseEngineButler and Gcode folder shortcuts, once (installer, then updates).
- REB_Setup/REB_Set_Serial_Number.sh - asks for and records this machine's serial number in ~/.config/REB/serial (installer, then updates until one is given).
- REB_Setup/REB_Report_Version.py - sends the version report at every update (see REB_Update.sh).
Related pages
|
eMail comments to |