ftp_backup.tc¶
ftp_backup.tc — copies the data of the SML programs to an FTP server
// @name: FTP-Backup
// @info: https://ottelo9.github.io/tasmota-sml-script/sml/#ftp
// @order: 31
// ftp_backup.tc — copies the data of the SML programs to an FTP server
// (FRITZ!NAS, Synology, ...) every night at 00:10 and on the Backup button.
// Runs in its own slot next to the SML program, so devices without a backup
// pay no RAM for it. Docs: https://ottelo9.github.io/tasmota-sml-script/sml/#ftp
//
// Sends every *.pvs, *.cfg and *.def from the file system (not its own .pvs,
// ftp.cfg with the FTP password only with ALL=1; tinyc.cfg = slots and
// autostart, mi-hol #100) to <folder>/<NAME or MQTT topic>/<1..7>/ (weekday of
// the run, Monday = 1), so a week of copies is kept; the Backup button uses 0.
// /ftp.cfg: HOST=, USER=, PW=, DIR=, optional NAME=, ALL= each on a line of
// its own, // comments allowed (mi-hol, PR #92). Without HOST= the backup
// fails with -11.
char sml_vers[] = "02.11.2026 12:05"; // build.html: version in the .tcb header and index.json
// Kept in ftp_backup.pvs by name: renaming one loses its value.
persist int bk_res; // 0 never, 1 ok, 2 failed
persist int bk_code; // last error
persist int bk_d; // last backup day
persist int bk_m; // last backup month
persist int bk_y; // last backup year
persist int bk_hm; // last backup hhmm
int bk_button; // Backup button
int bk_start; // start at the next tick
int bk_running; // worker running
int bk_last_night; // day of the last nightly run
int bk_manual; // 1 = started by the button
int bk_show_secs; // seconds the button still shows the result
int bk_save_all; // ALL=1: ftp.cfg is saved too
// Value of "KEY=" at a line start, up to the line end, spaces trimmed.
// text = the whole file, pos = strFind of the key in it; anywhere else than
// a line start it does not count.
void bkGetValue(byte value[], byte text[], int pos, int max) {
value[0] = 0;
if (pos < 0) return;
if (pos > 0 && text[pos - 1] != '\n') return;
while (text[pos] != '=') pos = pos + 1;
pos = pos + 1;
while (text[pos] == ' ') pos = pos + 1;
int len = 0;
while (text[pos] != 0 && text[pos] != '\n' && text[pos] != '\r' && len < max - 1) {
value[len] = text[pos];
len = len + 1;
pos = pos + 1;
}
while (len > 0 && value[len - 1] == ' ') len = len - 1;
value[len] = 0;
}
// NAME= as one folder every FTP server takes: umlauts (UTF-8 or Latin-1)
// become ae/oe/ue/ss, "/" and other non-ASCII bytes "_".
void bkFolderName(byte folder[], byte name[]) {
int in_pos = 0;
int out_len = 0;
while (name[in_pos] != 0 && out_len < 37) {
int ch = name[in_pos] & 255;
in_pos = in_pos + 1;
if (ch == 0xC3 && (name[in_pos] & 255) >= 0x80) { // UTF-8 C3 xx = Latin-1 C0..FF
ch = (name[in_pos] & 255) + 0x40;
in_pos = in_pos + 1;
}
int first = 0;
int second = 'e';
if (ch == 0xE4) first = 'a';
else if (ch == 0xF6) first = 'o';
else if (ch == 0xFC) first = 'u';
else if (ch == 0xC4) first = 'A';
else if (ch == 0xD6) first = 'O';
else if (ch == 0xDC) first = 'U';
else if (ch == 0xDF) { first = 's'; second = 's'; }
if (first != 0) {
folder[out_len] = first;
folder[out_len + 1] = second;
out_len = out_len + 2;
} else {
if (ch == '/' || ch >= 0x80) ch = '_';
folder[out_len] = ch;
out_len = out_len + 1;
}
}
folder[out_len] = 0;
}
int bkWantFile(byte file_name[]) {
if (strcmp(file_name, "ftp_backup.pvs") == 0) return 0;
if (strcmp(file_name, "ftp.cfg") == 0) return bk_save_all;
if (strFind(file_name, ".pvs") > 0) return 1;
if (strFind(file_name, ".def") > 0) return 1;
if (strFind(file_name, ".cfg") > 0) return 1;
return 0;
}
// spawnTask worker: FTP blocks, and here the VM lets go meanwhile. Its own
// VM needs the firmware fix that lets a worker use arrays > 16 elements
// (tasmota-sml-images, 12.10.2026) - without it this dies with BOUNDS.
void bkWorker() {
byte cfg_text[512]; byte host[40]; byte user[40]; byte password[40];
byte remote_dir[128]; byte device_folder[40];
byte text[48]; // scratch: NAME/ALL value, weekday, file name
byte local_path[52]; byte remote_path[180];
int result = -11;
int files_sent = 0;
int cfg_file = fileOpen("/ftp.cfg", 0);
if (cfg_file >= 0) {
int bytes_read = fileRead(cfg_file, cfg_text, 511);
fileClose(cfg_file);
if (bytes_read < 0) bytes_read = 0;
cfg_text[bytes_read] = 0;
bkGetValue(host, cfg_text, strFind(cfg_text, "HOST="), 40);
bkGetValue(user, cfg_text, strFind(cfg_text, "USER="), 40);
bkGetValue(password, cfg_text, strFind(cfg_text, "PW="), 40);
bkGetValue(remote_dir, cfg_text, strFind(cfg_text, "DIR="), 100);
int pos = strFind(host, "://"); // "ftp://ip" or "http://ip/" written by mistake
if (pos >= 0) {
strSub(text, host, pos + 3, 39);
strcpy(host, text);
}
pos = strlen(host) - 1;
if (pos > 0 && host[pos] == '/') host[pos] = 0;
pos = strlen(remote_dir) - 1;
if (pos > 0 && remote_dir[pos] == '/') remote_dir[pos] = 0;
bkGetValue(text, cfg_text, strFind(cfg_text, "NAME="), 40);
bkFolderName(device_folder, text);
bkGetValue(text, cfg_text, strFind(cfg_text, "ALL="), 8);
bk_save_all = 0;
if (text[0] == '1') bk_save_all = 1;
}
if (host[0] == 0) cfg_file = -1; // no HOST=: as if there were no file
if (cfg_file >= 0) {
if (device_folder[0] == 0) tasmInfo(0, device_folder); // MQTT topic
result = ftpOpen(host, user, password);
if (result == 0) {
ftpMkdir(remote_dir); // refused if it exists - fine
strcat(remote_dir, "/");
strcat(remote_dir, device_folder);
ftpMkdir(remote_dir);
int weekday = tasm_wday - 1; // Tasmota: 1 = Sunday
if (weekday < 1) weekday = 7;
if (bk_manual == 1) weekday = 0;
sprintf(text, "/%d", weekday);
strcat(remote_dir, text);
ftpMkdir(remote_dir);
int dir_handle = fileOpenDir("/");
if (dir_handle >= 0) {
while (result >= 0 && fileReadDir(dir_handle, text)) {
if (bkWantFile(text)) {
sprintf(local_path, "/%s", text);
sprintf(remote_path, "%s/%s", remote_dir, text);
result = ftpPut(remote_path, local_path, 0);
if (result >= 0) files_sent = files_sent + 1;
}
}
fileClose(dir_handle);
}
ftpClose();
}
}
bk_d = tasm_day; bk_m = tasm_month; bk_y = tasm_year;
bk_hm = tasm_hour * 100 + tasm_minute;
if (result >= 0) {
bk_res = 1;
addLog("ftpbk: %d files", files_sent);
} else {
bk_res = 2;
bk_code = result;
addLog("ftpbk: err %d", result);
}
if (bk_manual == 1) bk_show_secs = 5;
bk_running = 0;
}
void EverySecond() {
if (bk_show_secs > 0) bk_show_secs = bk_show_secs - 1;
if (bk_running) {
// The worker ends with bk_running = 0. Gone without it = it crashed.
if (taskRunning("bkWorker") == 0) {
bk_running = 0;
bk_res = 2;
bk_code = -13;
bk_d = tasm_day; bk_m = tasm_month; bk_y = tasm_year;
bk_hm = tasm_hour * 100 + tasm_minute;
if (bk_manual == 1) bk_show_secs = 5;
}
return;
}
// 00:10: the SML programs write their files at midnight.
if (tasm_hour == 0 && tasm_minute == 10 && bk_last_night != tasm_day && tasm_year > 2020) {
bk_last_night = tasm_day;
bk_start = 1;
bk_manual = 0;
}
if (bk_start == 0) return;
bk_start = 0;
bk_running = 1;
if (spawnTask("bkWorker", 8) < 0) {
bk_running = 0;
bk_res = 2;
bk_code = -12;
}
}
void WebCall() {
byte color[24];
// Handled while drawing: left to the next tick, the answer would still
// show the button pressed and the next click would send 0.
if (bk_button == 1) {
bk_button = 0;
if (bk_running == 0) { bk_start = 1; bk_manual = 1; }
}
if (bk_running == 1 || bk_start == 1) strcpy(color, "#fa0");
else if (bk_res == 1) strcpy(color, "#0c0");
else if (bk_res == 2) strcpy(color, "#e00");
else strcpy(color, "#888");
byte row[260];
if (bk_res == 0) {
sprintf(row, "{s}<span style='color:%s'>●</span> -", color);
} else {
sprintf(row, "{s}<span style='color:%s'>●</span> <span style='font-weight:normal;font-size:.85em'>🕒 %02d.%02d.%04d - %02d:%02d</span>", color, bk_d, bk_m, bk_y, bk_hm / 100, bk_hm % 100);
}
if (bk_res == 2) {
byte code_text[16];
sprintf(code_text, " (%d)", bk_code);
strcat(row, code_text);
}
strcat(row, "{m}<a href='/ufse?file=/ftp.cfg'>ftp.cfg</a>{e}");
webSend(row);
// The click itself only flashes a tick; the label shows the run and its
// result for a few seconds, so a press is visible.
byte label[24];
if (bk_running == 1 || bk_start == 1) strcpy(label, "⏳ Backup");
else if (bk_show_secs > 0 && bk_res == 1) strcpy(label, "✅ Backup");
else if (bk_show_secs > 0) strcpy(label, "❌ Backup");
else strcpy(label, "Backup");
webButtonV(bk_button, label);
}
int main() {
addLog("ftpbk: start %s", sml_vers);
return 0;
}