Recent Changes - Search:
Main /

File Locations

General

Most directories do not have files which are user editable on the system. Most are maintained via GitHub

https://github.com/RichColvin/REB

The directories which has files which the user can maintain are:

  • /home/cnc
  • /home/cnc/linuxcnc/configs/RoseEngineButlerLocal/REB_Axes
  • /home/cnc/linuxcnc/configs/RoseEngineButlerLocal/REB_Custom
  • /home/cnc/linuxcnc/nc_files

Rose Engine Butler Structure on LinuxCNC

---------------------------------------------------------------- ---- /home/cnc

This is a directory with files which are not typically user-edited.

/home/cnc

This directory gets created when LinuxCNC is installed. The files are put here by the REB_Install.sh Bash script.

Key files relative to LinuxCNC are:

  • .axisrc
    • Purpose: Used to define the way the AXIS GUI displays when LinuxCNC starts. Note that the first character in file’s name is a dot, thusly, this is a hidden file.
    • User Editable: Not recommended, but any of the text editing programs (e.g., Geany) could be used.
  • REB_Backup.sh
    • Purpose: This is a Bash script used by the user to backup their system's configuration.
    • User Editable: Not recommended, but any of the text editing programs (e.g., Geany) could be used.
  • REB_Restore.sh
    • Purpose: This is a Bash script used by the user to restore their system's configuration.
    • User Editable: Not recommended, but any of the text editing programs (e.g., Geany) could be used.
  • REB_Upgrade.sh
    • Purpose: This is a Bash script used by the user to upgrade their system's configuration. It performs:
      • Git Pull to get the latest program files
      • sudo apt update
      • sudo apt upgrade /Y
    • User Editable: Not recommended, but any of the text editing programs (e.g., Geany) could be used.

---------------------------------------------------------------- ---- /home/cnc/linuxcnc/configs

This is not a directory with user-editable files.

/home/cnc/linuxcnc/configs

This directory gets created when LinuxCNC is installed.

  • (no key files in this directory)

---------------------------------------------------------------- ---- /home/cnc/linuxcnc/configs/RoseEngineButler

This is not a directory with user-editable files.

/home/cnc/linuxcnc/configs/RoseEngineButler

This directory gets created by GitHub when the Rose Engine Butler configurations are installed. Key files relative to LinuxCNC are:

  • REB.hal
    • Purpose: This file outlines the hardware abstraction layer (HAL) used by LinuxCNC.
    • User Editable: Not recommended, but any of the text editing programs (e.g., Geany) could be used.
  • REB.ini
    • Purpose: This file outlines the configuration settings for the Rose Engine Butler configuration.
    • User Editable: Not recommended, but any of the text editing programs (e.g., Geany) could be used.
  • REBStartupImage.gif
    • Purpose: This is the image displayed before the full LinuxCNC system is displayed.
    • User Editable: Not recommended, but a graphics program like GIMP could be used.

---------------------------------------------------------------- ---- /home/cnc/linuxcnc/configs/RoseEngineButler/REB_Axes

This is not a directory with user-editable files.

/home/cnc/linuxcnc/configs/RoseEngineButler/REB_Axes

This directory gets created by GitHub when the Rose Engine Butler configurations are installed. The contents of this directory are not used by LinuxCNC per se; rather, during installation, these are the master copies which are copied to

/home/cnc/linuxcnc/configs/RoseEngineButlerLocal/REB_Axes

and that directory's files get used when LinuxCNC is run.

Key files relative to LinuxCNC are:

  • REB_AxisB.inc
    • Purpose: This is an incude file which gets incorporated with REB.ini when LinuxCNC starts. It defines the axis settings for the B axis.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REB_AxisU.inc
    • Purpose: This is an incude file which gets incorporated with REB.ini when LinuxCNC starts. It defines the axis settings for the U axis.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REB_AxisV.inc
    • Purpose: This is an incude file which gets incorporated with REB.ini when LinuxCNC starts. It defines the axis settings for the V axis.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REB_AxisX.inc
    • Purpose: This is an incude file which gets incorporated with REB.ini when LinuxCNC starts. It defines the axis settings for the X axis.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REB_AxisY.inc
    • Purpose: This is an incude file which gets incorporated with REB.ini when LinuxCNC starts. It defines the axis settings for the Y axis.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REB_AxisZ.inc
    • Purpose: This is an incude file which gets incorporated with REB.ini when LinuxCNC starts. It defines the axis settings for the Z axis.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REB_Spindle0.inc
    • Purpose: This is an incude file which gets incorporated with REB.ini when LinuxCNC starts. It defines the axis settings for the spindle.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REB_Spindle1.inc
    • Purpose: This is an incude file which gets incorporated with REB.ini when LinuxCNC starts. It defines the axis settings for the rosette phaser/multiplier.
    • User Editable: No. Editing this file will cause the Git pull process to fail.

---------------------------------------------------------------- ---- /home/cnc/linuxcnc/configs/RoseEngineButler/REB_Custom

This is not a directory with user-editable files.

/home/cnc/linuxcnc/configs/RoseEngineButler/REB_Custom

This directory gets created by GitHub when the Rose Engine Butler configurations are installed. The contents of this directory are not used by LinuxCNC per se; rather, during installation, these are the master copies which are copied to

/home/cnc/linuxcnc/configs/RoseEngineButlerLocal/REB_Custom

and that directory's files get used when LinuxCNC is run.

Key files relative to LinuxCNC are:

  • REB_Custom.hal
    • Purpose: Will be used by the user for whatever customized configuration is desired. The idea is to have the user not modify the REB.HAL mistakenly.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REB_Shutdown.hal
    • Purpose: Will be used by the user for whatever customized configuration is desired.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REB_Tool.tbl
    • Purpose: Will be used by the user for whatever customized configuration is desired.
    • User Editable: No. Editing this file will cause the Git pull process to fail.

---------------------------------------------------------------- ---- /home/cnc/linuxcnc/configs/RoseEngineButler/REB_Display

This is not a directory with user-editable files.

/home/cnc/linuxcnc/configs/RoseEngineButler/REB_Display

This directory gets created by GitHub when the Rose Engine Butler configurations are installed. Key files relative to LinuxCNC are:

  • hitconter.py
    • Purpose: This python program handles the commands needed for the buttons pressed by the user using the Glade panels (the .ui files).
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REB_Panel_v1.ui
    • Purpose: The panel displayed to the right.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REB_PostGUI.hal
    • Purpose: This hal file is used to define the pins needed for the Glade displays.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REB_Tab_Help_v1.ui
    • Purpose: The tab for the user which outlines where to get help. This should be the right-most tab in the display.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REB_Tab_Linear_v1.ui
    • Purpose: The tab used for linear axis movement.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REB_Tab_Rotary_v1.ui
    • Purpose: The tab used for rotary axes movement.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REB_Tab_Sync_v1.ui
    • Purpose: The tab used for synchronizing the spindle(s) with the Z axis.
    • User Editable: No. Editing this file will cause the Git pull process to fail.

---------------------------------------------------------------- ---- /home/cnc/linuxcnc/configs/RoseEngineButler/REB_Display/Images

This is not a directory with user-editable files.

/home/cnc/linuxcnc/configs/RoseEngineButler/REB_Display/Images

This directory gets created by GitHub when the Rose Engine Butler configurations are installed. Key files relative to LinuxCNC are:

  • AxesSm.png
    • Purpose: Used with Glade displays to show a graphic of the axis descriptions.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REB-Gcode.png
    • Purpose: Image of the Gcode Manual from the bookshelf. Used by REB_Tab_Help_v1.ui.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REB-UserManual.png
    • Purpose: Image of the User Manual from the bookshelf. Used by REB_Tab_Help_v1.ui.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REBLogo-Sm-Panel.png
    • Purpose: This is a smaller version of the Reuben logo. It is used by a all the REB display files (.ui).
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REBLogo-Sm.png
    • Purpose: This is a small Reuben logo. It is used by a all the REB_Panel_v1.ui display file.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • Reuben.png
    • Purpose: This is the Reuben logo.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • RunDown.png
    • Purpose: Used by a number of the REB display files (.ui).
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • RunCCW.png
    • Purpose: Used by a number of the REB display files (.ui).
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • RunCW.png
    • Purpose: Used by a number of the REB display files (.ui).
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • RunDown.png
    • Purpose: Used by a number of the REB display files (.ui).
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • RunFwd.png
    • Purpose: Used by a number of the REB display files (.ui).
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • RunLft.png
    • Purpose: Used by a number of the REB display files (.ui).
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • RunRev.png
    • Purpose: Used by a number of the REB display files (.ui).
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • RunRt.png
    • Purpose: Used by a number of the REB display files (.ui).
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • RunUp.png
    • Purpose: Used by a number of the REB display files (.ui).
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • Stop.png
    • Purpose: Used by a number of the REB display files (.ui).
    • User Editable: No. Editing this file will cause the Git pull process to fail.

---------------------------------------------------------------- ---- /home/cnc/linuxcnc/configs/RoseEngineButler/REB_Setup

This is not a directory with user-editable files.

/home/cnc/linuxcnc/configs/REB_Setup

This directory gets created by GitHub when the Rose Engine Butler configurations are installed. Key files relative to LinuxCNC are:

  • axisrc
    • Purpose: This file gets copied into /home/cnc where it will be used. There is no "." as the 1st character in the file name. This is because that would fail with GitHub. The "." is added by the REB_Install.sh Bash script.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • lightdm.conf
    • Purpose: Used for the initial installation of the system.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REB_Backup.sh
    • Purpose: This file gets copied into /home/cnc where it will be used.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REB_Install.sh
    • Purpose: Used for the initial installation of the system; puts files where they need to go.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REB_Restore.sh
    • Purpose: This file gets copied into /home/cnc where it will be used.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REB_Update.sh
    • Purpose: This file gets copied into /home/cnc where it will be used.
    • User Editable: No. Editing this file will cause the Git pull process to fail.

---------------------------------------------------------------- ---- /home/cnc/linuxcnc/configs/RoseEngineButler/REB_Setup/Images

This is not a directory with user-editable files.

/home/cnc/linuxcnc/configs/REB_Setup/Images

This directory gets created by GitHub when the Rose Engine Butler configurations are installed. Key files relative to LinuxCNC are:

  • REBStartupImage.gif
    • Purpose: Displayed when LinuxCNC starts up before the main panel is displayed.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • REBWallpaper.png
    • Purpose: Desktop wallpaper for Debian.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • Reuben.gif
    • Purpose: Reuben logo image.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • Reuben.png
    • Purpose: Reuben logo image.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • ReubenHead.png
    • Purpose: Reuben's head. Used as the icon for the application launcher.
    • User Editable: No. Editing this file will cause the Git pull process to fail.

---------------------------------------------------------------- ---- /home/cnc/linuxcnc/configs/RoseEngineButler/REB_Setup/MesaCard

This is not a directory with user-editable files.

/home/cnc/linuxcnc/configs/REB_Setup/MesaCard

This directory gets created by GitHub when the Rose Engine Butler configurations are installed. Key files relative to LinuxCNC are:

  • 7i92t_REB.bin
    • Purpose: Used to setup the Mesa card.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • 7i92t_REB.pin
    • Purpose: Used to setup the Mesa card.
    • User Editable: No. Editing this file will cause the Git pull process to fail.
  • PIN_REB_34.vhd
    • Purpose: Used to setup the Mesa card.
    • User Editable: No. Editing this file will cause the Git pull process to fail.

---------------------------------------------------------------- ---- /home/cnc/linuxcnc/configs/RoseEngineButlerLocal/REB_Axes

This is the directory with user-editable files.

/home/cnc/linuxcnc/configs/RoseEngineButlerLocal/REB_Axes

This directory gets created by the Bash file, Install.sh (in /home/cnc/linuxcnc/configs/RoseEngineButler/REB_Setup), when the Rose Engine Butler configurations are installed.

The files in this directory were copied from:

/home/cnc/linuxcnc/configs/RoseEngineButler/REB_Axes

These files can be edited using any of the text editing programs (e.g., Geany).

---------------------------------------------------------------- ---- /home/cnc/linuxcnc/configs/RoseEngineButlerLocal/REB_Custom

This is the directory with user-editable files.

/home/cnc/linuxcnc/configs/RoseEngineButlerLocal/REB_Custom

This directory gets created by the Bash file, Install.sh (in /home/cnc/linuxcnc/configs/RoseEngineButler/REB_Setup), when the Rose Engine Butler configurations are installed.

The files in this directory were copied from:

/home/cnc/linuxcnc/configs/RoseEngineButler/REB_Custom

These files can be edited using any of the text editing programs (e.g., Geany).

---------------------------------------------------------------- ---- /home/cnc/linuxcnc/nc_files

This is the directory with user-editable files.

/home/cnc/linuxcnc/nc_files

This directory gets created when LinuxCNC is installed. This is where users will store any Gcode program files.

  • (no key files in this directory)