rfm - RepRapFirmware FileManager [duetbackup successor]

[oliof]

It would be nice to have rfm support RRF3 with SBC for consistency's sake though (-:

[tristanryerparke]

@oliof I second this

[lael]

I was just directed to RFM for backing up our Duet. Thank you to @wilriker it's amazing!

However, getting it started was a little slower than it needed to be. If you are on Windows and looking for a way to backup your Duet, here is a quickstart guide / manual that might help speed things up for you. (The guide may help if you aren't on Windows, but you'll need to adapt file paths etc as appropriate).

Download and unzip to C:\Users\YourUserName and name the folder 'DuetBackupRFM'
  
Open Command prompt (Start - cmd - enter) which will open at c:\Users\YourUserName

Chang the cmd prompt folder to the one you just unzipped to: 
Type: cd DuetBackupRFM 		; and hit enter

Now you are ready to use RFM to backup your Duet. Read below. 


RFM Duet Backup Commands: 

**note: must use program name, command name, then can use options and parameters/arguments.  
**ONCE a device has been specified (a device profile is created on first use), you can refer to the device without networking options by using the device name. 


RFM Command Syntax Explanation: 

Valid Example command: 
	rfm backup -device YourPrinterName sys 0:/sys

Explanation: 
	rfm 		backup 		-device 	YourPrinterName 	sys 			0:/sys
	program name	command name	option name	parameter for option	local comp. folder to save to	Duet folder to do command to


Things you likely want to do: 

STEP 1. connect to the Duet (creates a config for the Duet as the -device name) and list The Duet's root directory: 
	rfm ls -domain 192.168.1.12 -port 80 -password YourDuetPassword -device YourPrinterName

STEP 2. Backup the sys folder on your duet (already created in step 1 in RFM) into a folder on your computer called 'sys' (which will be located in the same folder RFM.exe is located). 
Note: RFM will create the folder on your computer if it does not exist. RFM will also use UNC / absolute paths if preferred (so you can redirect outside of the RFM folder - see examples at end). 
 
	rfm backup -device YourPrinterName sys 0:/sys

STEP 3. Backup the macros folder for your duet (already created in RFM) to a local 'macros' folder: 
	rfm backup -device YourPrinterName macros 0:/macros

STEP 4. Backup the filaments folder for your duet ((already created in RFM) to a local 'filaments' folder: 
	rfm backup -device YourPrinterName filaments 0:/filaments

STEP 5. Backup the gcode files on your duet (already created in RFM) to a local 'macros' folder: 
	rfm backup -device YourPrinterName gcodes 0:/gcodes


- - Some other Examples: - - 
List all the files in the folders in the root of your duet: 
	rfm backup -device YourPrinterName

List all the files in the sys folder on your duet: 
	rfm backup -device YourPrinterName 0:/sys

List all the files in a folder on duet with spaces in its name: 
	rfm ls -device YourPrinterName "0:/macros/calibration/bed leveling"

If you are using spaces in your RFM backup path or on duet - enclose in quotation marks: 
	rfm backup -device YourPrinterName "C:users/yourusername/DUET BACKUP RFM"  "0:/macros/calibration/bed leveling"

[demonlibra]

Write script for bash (GNU/Linux) to backup all files.

#!/bin/bash

# ---------------------------------- Parameters -------------------------------------
temp="temp"											# Temp folder for backup
output="backup_rrf_$(date +%F_%H-%M-%S).tgz"		# Archive name for backup

# -----------------------------------------------------------------------------------
mkdir -p $temp										# Create temp folder

./rfm ls | while read line							# Parse list of files and folders
	do
		if [[ `echo "$line" | grep "\[f\]"` ]]		# Processing files
			then
				filename=`echo ${line##*	}`
				./rfm download "$filename" "$temp/$filename"
				echo "$filename - File downloaded"

		elif [[ `echo "$line" | grep "\[d\]"` ]]	# Processing folders
			then
				foldername=`echo ${line##*	}`
				./rfm backup -exclude overlays "$temp/$foldername" "$foldername"
				echo -e "\n"

		else echo "$line - Strange line"
		fi
	done
		
tar czPf "$output" "$temp"							# Create archive
rm -rf "$temp"										# Delete temp folder

[jens55]

I am trying out rfm. I go into the folder that has rfm in it and do:
./rfm backup -domain 192.168.1.163
this backs up the /sys folder on the duet card that is at 192.168.1.163.
If I want to back up the macro folder on that Duet, what should the command look like? Based on the help section of rfm, I was trying ./rfm backup /macros -domain 192.168.1.163 but I get 'directory not found'.

[Nightowl]

Hi @wilriker

This is a great project and I would like to implement it on my system, but I (generally) manage the system remotely.

Specifically, I have a Mac (in the house) and use the Microsoft Remote Desktop (RD) app to connect to my Surface Pro (in the shed), via a wired network, which is hard-wired to the Duet3 MB6HC control board running my CNC machine (I don't run the CNC machine remotely, before anyone asks!)

The first question I have is, should I install rfm on the Mac and run it from there, or install it on the Surface Pro and run rfm from the Mac (via RD), and the second question is, which version should I use if it's installed on the Mac?

I'm running RRF version 3.4.4

Thank you

[wilriker]

@jens55 said in rfm - RepRapFirmware FileManager [duetbackup successor]:

If I want to back up the macro folder on that Duet, what should the command look like? Based on the help section of rfm, I was trying ./rfm backup /macros -domain 192.168.1.163 but I get 'directory not found'.

You need to switch the order of parameters:

rfm backup -domain 192.168.1.163 <local-path> 0:/macros

Note that local-path is mandatory if you specify a remote path.

[wilriker]

@Nightowl said in rfm - RepRapFirmware FileManager [duetbackup successor]:

The first question I have is, should I install rfm on the Mac and run it from there, or install it on the Surface Pro and run rfm from the Mac (via RD), and the second question is, which version should I use if it's installed on the Mac?

Actually this just depends on what is more convenient for you. As long as rfm is able to connect to RRF via network this does not matter.

I personally would probably install it on the Surface Pro just because it is closer. But again, it just boils down to what is more convenient for you. Mine is installed on a Raspberry Pi that is lingering around somewhere in the house and runs a background task that periodically checks if it can backup anything or not.

If you want to install it an the Mac use darwin binary. Although this will not work on a M1 MacBook. When I compiled rfm the last time there were not M1's around AFAIR.

[Nightowl]

Thank you, @wilriker

Mine's an i5, so that would be OK - but logic, and your comments, tell me I should install it on the PC!

Thank you

[jens55]

@wilriker, thank you!

[Nightowl]

@wilriker
Further to my last post, I'm a bit of a biff with these newfangled things, so I need a couple of simple steps to follow - at least I think I do.

I understand the file has to be run from the command line, but where would be the best folder to locate rfm? I appreciate it can be accessed wherever it is, but I would like to pre-configure everything, so it would be a simple process of 'clicking a shortcut' for the card to be 'backed up'.

I'm assuming all the folders (firmware, gcodes, macros, sys and www) should be backed up, but does rfm process them all (if the correct parameters are set, clearly) or do I need to run rfm for each folder?

This is what I think...

rfm backup Weeble O:/ //Libraries/CNC Files/Backups

...where Weeble is the device name, O:/the root of the SD card and afp://SynologyHome._afpovertcp._tcp.local/Libraries/CNC Files/Backups where the files are to be backed up to?

BTW, I haven't tested this yet!

Thank you.

EDIT: Is there a naming protocol for the backup files, or will they be overwritten every time they're backed up? P

[Garth_42]

@wilriker I am getting the following error when I run the RFM tool. I have attempted on mac and PC, and have tried multiple variants of the command, too. My duet is a Duet3MB6HC in SBC mode running RRF 3.4.5.

Here is a screenshot of the output from terminal:

Best,
Garth

[wilriker]

@Garth_42 rfm is intended to be used with boards in standalone-mode. AFAIR SBC builds do not support the full HTTP interface for file management plus any SBC has much more powerful means to interact with files than I could ever implement.

[wilriker]

@Nightowl Sorry for the very late reply. First of all rfm has an extensive help page, accessible via rfm help as well as rfm help <command> to get more details on specific commands.

rfm backup Weeble 0:/ //Libraries/CNC Files/Backups

looks somehow wrong to me. Most likely you missed -device in front of "Weeble". Also beyond that you have further three parameters where rfm only expects two, namely the local path (to write the backup to) and the remote path a.k.a. path on the Duet (specifically in this order). So your command rather likely should look like

rfm backup -device Weeble //Libraries/CNC 0:/

but where would be the best folder to locate rfm?

As you said you put it on your PC (so I assume Windows), to have it most easily working you need to add the directory you store rfm in into your PATH (I haven't used Windows in a decade so please bear with me if I cannot tell you how to do that on recent editions). On Windows there is (or at least was) no standard way of puting custom binaries anywhere so again this is left to you where to actually put the binary (sorry).

I'm assuming all the folders should be backed up, but does rfm process them all

rfm will simply backup everything recursively under the given remote path. In your case 0:/ will simply back yup every single file it can find on the SD card.

Is there a naming protocol for the backup files, or will they be overwritten every time they're backed up?

They will be overwritten continuously with each run. It will leave remotely removed files locally though unless you also pass the parameter -removeLocal.

[Nightowl]

Awesome, thank you @wilriker

You are completely forgiven.

The backup folder will actually be on a NAS (hopefully), but you've given me plenty to get on with.

Thanks again

[Garth_42]

@wilriker haha, thanks for the reply. This is good to know, I was creating an rclone script to do backup on the SBC. I saw this and my interest was piqued.

[Nightowl]

@wilriker
Sorry to have to keep asking silly questions, but i've tried to run RFM from the folder it's installed in, from the command line in Windows, and I get the error:

-domain is mandatory

I've used both the IP address and domain name of the control board, i.e.:

rfm backup -device Weeble //Libraries/CNC File O:/

and

rfm backup -device 192.168.1.121 //Libraries/CNC File O:/

With the same result.

Have I missed something (else!) please?

Thank you

[wilriker]

@Nightowl rfm uses two sources to get the parameters to connect to a device. For convenience means it will save connection settings (-domain as well as -port and -password) in a config file. By default it uses a device called default for that.

You have to provide this information (only -domain is actually necessary, the other two can use the default value in 99% of the times) once and after that you can omit these because they are saved in the config file. So you need to call

rfm backup -domain <network address of your duet> -device Weeble ...

once to init the config file. After that you can omit -domain ... and just use -device Weeble - or unless you want to address multiple devices you can also omit the -device Weeble part and from the start and use the default device.

After that it should work.

[k3lag]

I just discovered rfm, nice job.

I am using it on a Mac running Ventura. I am finding that it won't resolve the host name of my railcore.

If I use the IP address it works fine but if I use the name railcore.local it doesn't find it. railcore.local does work for a ping from the command line and from a browser.

[wilriker]

I just released rmf v1.2.0 yesterday.

It contains a bug fix for the backup command when the amount of files in a directory on the SD card exceed the amount that can be returned by RRF in one single response - rfm used to go into an endless loop then.

Besides that it is not possible to abort any operation by sending an interrupt signal (pressing CTRL+C on the console). I recommend everyone to update to the latest version.