Project files and backups¶
The block project, the executed program, and the data on the device have different tasks. For further editing, save the editable project; for a complete recovery of the application as well as its own libraries and data files.
What is which file¶
| File or Link | What it contains and what it is for |
|---|---|
.blk, .xml |
Editable block project. It contains blocks, settings of the processor and used add-ons, Graphic Designer scenes and configuration of dashboards in blocks. Save it via Project → Save to PC. |
.blk.gz |
A compressed form of the block project. Manual save to device uses /BLK folder; the automatic backup is named /backup.blk.gz. To open, use the IDE functions for the project on the device or the last backup. |
.py |
The text of a Python program or library. Back up your own text files separately. Python itself does not restore the original blocks and their layout. |
idecode |
Program recorded by action Run code. It is not a backup of an editable block project. |
/gfx/scene.dat |
Prepared static scene backgrounds when the store scene data in file option is enabled. It is not a design intended to be opened in the designer. |
/gfx/*.mfnt |
Device-required fonts for dynamically changing designer text. The editable scene and its used font backgrounds are also saved in the block project. |
dashboard.json |
Configuration of dashboards stored in the device for stand-alone HMIs. Occurs when uploading a project if Save for standalone HMI is on. Does not contain a program. |
.espdash.json |
Export configuration of one dashboard: points, elements, properties and layout. It does not contain the entire block project or measurement history. |
| Shared Link / Code | Content sent by action Share project or Share file. Block sharing transfers both the project and the processor selection; in text mode, the active file is shared. It is not a continuous synchronization of other edits. |
The project is not a copy of the entire file system
File .blk does not back up all files stored on the board. Also hide your own Python modules, settings, measurements, images or other data stored separately on the device. The same applies to custom files in the simulator virtual file system.
Simple backup of an application in progress¶
- Save the block project to the computer. Use Project → Save to PC and an understandable name, for example with the date or version designation.
- Save custom text files. In text mode, the save action works with the active tab, not automatically with all open files. So go through all the custom files you want to keep.
- Download the necessary files from the device. Via Device → File Manager save your own libraries, configurations and data that are not part of the block design. Opening the manager stops the program.
- Note the connection and the environment used. Board type, firmware, necessary libraries and pins will make it easier for you to restore on another device.
- Keep multiple named versions if you want to rollback. One automatic backup does not solve this.
You can attach the shared link for convenient opening of the project, but keep your own file on your computer. Opening a link or another project may replace the contents of the workspace.
What autosave is backing up¶
The Settings → Save Backup option saves the block project when uploading it as /backup.blk.gz to the target device. In the simulator, this is its own file system.
| Choice | When will the backup occur |
|---|---|
| Never | It is not automatically created at startup. |
| USB only | Only when uploading a block program via USB. This is the default setting with no saved preference. |
| Always | When uploading a block program also via other supported transmissions and into the simulator. |
The same file will be overwritten during the next backup. This is not a version history, a backup of all text tabs, or a copy of all device data.
To return, use Project → Open last backup. The IDE stops the program and loads the blocks. You can then save the restored project to your computer under your own name.
Details can be found in backup settings and Project menu.
Project transfer to another board¶
- Open the saved
.blkor shared link. Save any work in progress in the editor beforehand. - Check processor and wiring. The project keeps the processor selection, but the new board may need a different one. Also verify the pins of the individual blocks and the initialization of the display or other components.
- Prepare the corresponding firmware and libraries. Follow install firmware and libraries. Just opening the project will not change the firmware of the board.
- Upload custom files that the application uses outside of the block project. Preserve necessary roads; the library searched for in
/libis not resolved by simply saving it to another location. - Start the current block project from the IDE. This creates the program and uploads its generated materials: necessary scene data and dynamic fonts, possibly enabled HMI configuration.
- Verify the listing in the terminal, the behavior of the components and connected panels. For automatic start of the board, also check the option Start automatically after start and upload the project again.
Different processor or wiring may require block modifications; the file transfer itself does not perform such modification.
When you port only Python¶
Transfer also the files that belong to it. A program with file scenes needs the corresponding /gfx/scene.dat dynamic text of its .mfnt fonts and their library modules used. The old scene file may not agree with the newly generated Python.
The automatic compilation and upload of these documents is linked to the launch of the block project. Simply copying Python into a text tab does not replace them.
What is often missing from recovery¶
| I only have… | What of it I will not restore |
|---|---|
Python or idecode |
Original block design. You need .blk, backup or shared block project. |
scene.dat |
Editable Graphic Designer objects and their bindings. Those are in the project. |
| Export dashboard | The entire program and linking of new points with variables in another project. |
| Last automatic backup | Older versions of the project, all text files and individual device data. |
More detailed instructions: graphic scene files and dashboard and HMI export.