Backup, restore e cancellazione del firmware di un Sonoff (e simili)

SCOPI DELLA GUIDA:
  • Eseguire un backup, un restore e/o una cancellazione del firmware presente su un Sonoff (o su dispositivi equivalenti comunque basati su SOC ESP8266)
  • Livello di difficoltà: basso
CONCETTI AFFRONTATI:
  • interfacciamento firmware
Componenti software utilizzate:
Dispositivi fisici utilizzati:
GUIDA MAGGIORMENTE INDICATA PER:

Tutti gli ambienti

Note e disclaimer
  • qualsiasi modifica all'impianto elettrico dev'essere effettuata da personale qualificato
  • qualsiasi modifica attuata in proprio è a propria responsabilità personale nonché a proprio rischio e pericolo (la presente guida ha puro scopo didattico)
  • qualsiasi modifica attuata in proprio a un dispositivo ne fa decadere la garanzia.
Revisione guida: 1.2

Abstract

– Com’è noto gli attuatori/sensori della famiglia ITEAD “Sonoff Smart Home” sono tra i componenti domotici più in voga, complice il basso costo, la grande versatilità e, ultima ma non certo meno importante (anzi), l’alto grado di integrabilità domotica.

Quest’ultimo aspetto è direttamente legato alla possibilità di modificare il firmare in uso dal loro processore, il SOC ESP8266, sostituendo quello di fabbrica con uno alternativo, quali Sonoff-Tasmota, ESPurna ed altri.

Questa guida è satellite di quelle dedicate, su inDomus, alla riprogrammazione di tale firmware:

Dato che può rendersi necessario effettuare un backup del firmware (specialmente quello originale di fabbrica) per provvedere magari, in un secondo momento, al ripristino, questa guida illustra l’utilizzo del tool gratuito “esptool” (utilizzabile su Windows, Mac, Linux) a tale scopo.

Si assume che:

Si parte

Connessione

Per effettuare backup, restore o cancellazione della flash memoria del componente in questione è necessario collegarvisi tramite l’adattatore USB/TTL (FTDI) alla board del Sonoff (o del modulo in questione).

Un adattatore USB/TTL (FTDI) è un semplice dispositivo che ci permette di mettere in comunicazione il nostro computer e il cuore del modulo basato su ESP8266. Per far ciò, innanzitutto è necessario “denudare” il Sonoff rimuovendo la conchiglia di plastica bianca che lo protegge.  L’adattatore, che può variare nella forma e nei colori, di base presenta una porta USB e quattro contatti, i quali vanno messi a contatto con quelli presenti sulla board del Sonoff utilizzando dei cavetti di connessione Dupont.

I contatti VCC e Ground dell’USB/TTL (FTDI) vanno collegati agli stessi punti di contatto della board, mentre TX e RX vanno collegati incrociati (TX con RX e RX con TX).

ATTENZIONE: se l’adattatore presenta una possibilità di scelta tra le tensioni 5v e 3.3v, scegliere sempre 3.3v. Un adattatore che eroghi solo 5v, non è adatto.

Solitamente si usa saldare sulla board del Sonoff dei pin in modo da rendere agevole la connessione verso l’FTDI, ma è sufficiente posizionare dei pin a semplice contatto per ottenere lo stesso risultato – vedi immagine sopra.

ATTENZIONE! NON COLLEGARE CONTEMPORANEAMENTE IL SONOFF ALL’ADATTATORE USB/TTL E ALLA CORRENTE DI RETE 220V!
RICORDARSI DI SCOLLEGARE LA CORRENTE DI RETE DAL DISPOSITIVO!!!

Un’ulteriore, ultima alternativa senza saldature è quella del “fresco bucato”, disponibile qui.
Altre tecniche di connessione possono essere lette qui.

Flash mode

Una volta effettuata la connessione è possibile collegare l’adattatore al computer, ma nel fare questo è necessario, contemporaneamente, collegare il pin presente sulla board denominato “GPIO0” al pin “Ground” e, dopo aver effettuato la connessione USB, disconnettere tale “corto” tra i due pin. Questo fa sì che il modulo entri in una modalità detta “flash mode“, la quale dà libero accesso al firmware del modulo.

Per fare questo, ad esempio, su un Sonoff Basic come su altri modelli (TH-16, POW…), è sufficiente (a monte di effettuare la connessione USB) premere il pulsante presente sulla board (per poi rilasciarlo dopo l’avvenuta connessione USB); in altri casi è invece necessario utilizzare un ulteriore cavetto di connessione Dupont (maschio-maschio) per mettere in contatto i due pin specifici. La cosa varia da modello a modello, basta far riferimento alla guida specifica di riprogrammazione del firmware del dispositivo per capire come fare.

Sequenza corretta:

  • attesto i quattro contatti VCC, Ground, TX e RX;
  • premo il pulsante o metto in contatto GPIO0-Ground con un cavetto Dupont (scelta fatta in base al tipo di modulo)
  • collego l’USB;
  • aspetto un secondo, dopodiché rilascio il pulsante o rimuovo il cavetto Dupont.

In questo modo il modulo entrerà in “flash mode”.

Porta COM

Dopo aver effettuato la connessione, recarsi presso il pannello di controllo del proprio computer (in base al proprio sistema operativo) e, presso l’elenco delle USB, capire quale porta si stata assegnata all’USB/TTL.

Su Windows solitamente queste porte sono chiamate “COM1”, “COM2” eccetera, mentre su linu sono chiamate “/dev/ttyUSB0”, “/dev/ttyUSB1” ecc.

NOTA per gli utenti Apple: Atom, su macOS, potrebbe identificare una porta diversa dalla classica COMx. Per capire come configurare la porta in questa casistica, far riferimento a questo thread. Al di lì di quanto espresso nel link, si ricordi sempre di installare il corretto driver per Mac del proprio adattatore USB/TLL.

BACKUP

Siamo finalmente pronti ad effettuare il backup del modulo, il quale è connesso al computer in “flash mode”, conosco la porta e posso quindi eseguire, da terminale/prompt del comandi, il seguente comando:

esptool.py --port COMx read_flash 0x00000 0x100000 sonoff.bin

dove ovviamente COMx è la porta di comunicazione e sonoff.bin il nome del file che conterrà il firmware salvato.

Se tutto andrà bene, l’output sarà analogo al seguente:

esptool - backup

Al termine sarà stato creato un file nominato come da comando (nel caso dell’immagine, “test.bin“).

RESTORE

Avendo già a disposizione un precedente backup, il comando di “restore”, ovvero di ripristino (da eseguire sempre dopo aver collegato il modulo in “flash mode”), sarà il seguente:

esptool.py --port COMx write_flash -fs 1MB -fm dout 0x0 sonoff.bin

dove “sonoff.bin” sarà il nome del file di backup precedentemente realizzato.
L’output sarà simile al seguente:

esptool - restore

ERASE

Infine potrebbe essere utile “pulire” la flash memory del modulo. Per effettuare una cancellazione totale, eseguire il seguente comando:

esptool.py --port COMx erase_flash

Il quale produrrà un output di questo tipo:

esptool - erase


ITEAD Sonoff BasicATTENZIONE: ricorda che sul nostro community FORUM c'è una sezione ad hoc dedica ai Sonoff, per qualsiasi dubbio, domanda, informazione nel merito specifico di queste componenti.