Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
en:sw:05-tools:balenaetcher [2023/08/11 11:46] avsetula created |
en:sw:05-tools:balenaetcher [2023/08/11 13:39] (current) avsetula |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== BalenaEtcher (flash OS) ====== | + | ====== BalenaEtcher (flashing the OS) ====== |
<WRAP group> | <WRAP group> | ||
Line 12: | Line 12: | ||
</WRAP> | </WRAP> | ||
<WRAP half column 100%> | <WRAP half column 100%> | ||
- | The OS image can be written to an SD card /*or USB flash drive*/ using the open-source BalenaEtcher tool (for Windows OS) and then run on Unipi devices. | + | The OS image can be written to an SD card /*or USB flash drive*/ using the open-source BalenaEtcher tool (for **Windows OS**) and then run on Unipi devices. |
You can download BalenaEtcher from [[https://www.balena.io/etcher/|official web pages]]. | You can download BalenaEtcher from [[https://www.balena.io/etcher/|official web pages]]. | ||
</WRAP> | </WRAP> | ||
+ | </WRAP> | ||
+ | |||
+ | <WRAP center round info 90%> | ||
+ | **Note:** \\ Operating system images are available in the [[en:files:software:os-images:00-start|OS Images]] section. | ||
</WRAP> | </WRAP> | ||
Line 28: | Line 32: | ||
</WRAP> | </WRAP> | ||
- | ===== Flashing OS image from a file ===== | + | {{page>balenaetcher-flash-from-file-hidden}} |
- | When running BalenaEtcher, there are three options in the main menu, selecting the first **Flash from file** will bring up a file explorer to select a disk image. This disk image can either be directly in ***.img** format, or it can be packaged in a ZIP archive, as available [[en:files:software:os-images:00-start?tns|in our Knowledge Base]]. | + | {{page>balenaetcher-flash-from-url-hidden}} |
- | {{ :en:sw:03-3rd-party:balena-etcher:balena_documentation_01_main_window.png?direct |}} | + | {{page>balenaetcher-cloning-hidden}} |
- | After successful selection of the OS image, the next option **Select target** is possible to select a suitable storage. When selecting, please note the caution [[#flashing_os_from_a_windows_pc| in the introduction of the article]]. | + | {{page>balenaetcher-running-on-unipi-hidden}} |
- | + | ||
- | {{ :en:sw:03-3rd-party:balena-etcher:balena_documentation_02_select_target.png?direct |}} | + | |
- | + | ||
- | Flashing the OS image to storage will start after clicking on **Flash!** | + | |
- | + | ||
- | {{ :en:sw:03-3rd-party:balena-etcher:balena_documentation_03_flash.png?direct |}} | + | |
- | + | ||
- | + | ||
- | ===== Flashing OS image from an URL ===== | + | |
- | + | ||
- | BalenaEtcher also allows you to upload an OS image directly from a URL link to an **.img** or **.zip** file (with an OS image). In the main menu there is a choice of **Flash from URL**. | + | |
- | + | ||
- | {{ :en:sw:03-3rd-party:balena-etcher:balena_documentation_04_from_url.png?direct |}} | + | |
- | + | ||
- | The field labeled **Enter a valid URL** (under the heading **Use Image URL**) is used to enter the address of the OS image. | + | |
- | + | ||
- | OS image URL can be obtained by right click on "Download" button in [[en:files:software:os-images:00-start|OS Image section]] and selecting **Copy Link** from context menu. | + | |
- | + | ||
- | {{ :en:sw:03-3rd-party:balena-etcher:balena_documentation_16_copy_url.png?direct |}} | + | |
- | + | ||
- | If the image source requires a login credentials, a username and password can be entered in the **Authentication** section. | + | |
- | + | ||
- | {{ :en:sw:03-3rd-party:balena-etcher:balena_documentation_05_url_setup.png?direct |}} | + | |
- | + | ||
- | The selection of the suitable storage to which the OS image is to be written is possible by checking the checkbox. When selecting, please note the caution [[#nahrani_os_z_windows_pc| in the introduction of the article]]. | + | |
- | + | ||
- | {{ :en:sw:03-3rd-party:balena-etcher:balena_documentation_06_url_setup.png?direct |}} | + | |
- | + | ||
- | Flashing the OS image to storage will start after clicking on **Flash!** | + | |
- | + | ||
- | {{ :en:sw:03-3rd-party:balena-etcher:balena_documentation_07_url_flash.png?direct |}} | + | |
- | + | ||
- | + | ||
- | ===== Cloning a disk with an OS image ===== | + | |
- | + | ||
- | The last option in BalenaEtcher is to clone the storage. Cloning is especially useful for creating a backup before the final placement of the Unipi device and start of operation. In the main menu, this is the third option **Clone drive**. | + | |
- | + | ||
- | {{ :en:sw:03-3rd-party:balena-etcher:balena_documentation_08_cloning_start.png?direct |}} | + | |
- | + | ||
- | The selection of source storage will appear. When selecting, please note the caution [[#nahrani_os_z_windows_pc| in the introduction of the article]]. | + | |
- | + | ||
- | {{ :en:sw:03-3rd-party:balena-etcher:balena_documentation_09_cloning_source.png?direct |}} | + | |
- | + | ||
- | To select a target storage (or multiple storages), click **Select target**. When selecting, please note the caution [[#nahrani_os_z_windows_pc| in the introduction of the article]]. | + | |
- | + | ||
- | {{ :en:sw:03-3rd-party:balena-etcher:balena_documentation_10_cloning_target.png?direct |}} | + | |
- | + | ||
- | Flashing the OS image to storage will start after clicking on **Flash!** | + | |
- | + | ||
- | {{ :en:sw:03-3rd-party:balena-etcher:balena_documentation_11_cloning_flash.png?direct |}} | + | |
- | + | ||
- | + | ||
- | ===== Before running the OS on a Unipi device===== | + | |
- | + | ||
- | After finishing the flash, or after the storage drive is reinserted into the PC, Windows OS may detect it as a new storage device that it cannot recognize and may request formatting. Close the formatting prompt by clicking on **Cancel**. | + | |
- | + | ||
- | {{ :en:sw:03-3rd-party:balena-etcher:balena_documentation_12_win_warning.png?direct |}} | + | |
- | + | ||
- | The Windows OS may also display notification that the storage is unavailable. This message can be ignored. | + | |
- | + | ||
- | <WRAP center round box> | + | |
- | If the OS image has been successfully flashed, the storage will be identified with the name **boot** when re-inserted into the PC. | + | |
- | + | ||
- | {{ :files:img_breakline_2.png?nolink |}} | + | |
- | + | ||
- | If the Mervis OS has been flashed on the storage, there is one last step possible: enabling SSH. The easiest way to do this is to create a file called **ssh.txt**, or just **ssh** without the suffix, in the main **boot** directory of the storage. Alternatively, SSH can be activated directly in the Mervis IDE by changing the RunTime configuration, see section [[en:sw:01-mervis:updating-a-runtime-configuration-hidden#unipi_specific|Uploading a RunTime configuration (RT) - unipi specific]]. For non-Mervis OS, the SSH connection is enabled by default and does not need to be enabled in this way. | + | |
- | + | ||
- | After SSH is enabled, you can connect with, for example, [[en:files:software:tools:putty-hidden|Putty]]. | + | |
- | </WRAP> | + | |
- | + | ||
- | <WRAP center round alert 90%> | + | |
- | If SSH is enabled, **[[en:automation:securing-os-ssh-hidden|the operating system must be secured]]**, otherwise unauthorized interference may occur! | + | |
- | </WRAP> | + | |
- | + | ||
- | + | ||
- | ===== Running the OS on a Unipi device ===== | + | |
- | + | ||
- | At this moment, the OS is ready on a storage (with SSH enabled). After removing it from the computer, the storage can be inserted into the Unipi device. | + | |
- | + | ||
- | <WRAP center round important 90%> | + | |
- | Disk storage can **ONLY** be inserted when the device power supply is unplugged! | + | |
- | </WRAP> | + | |
- | + | ||
- | {{ :en:sw:03-3rd-party:balena-etcher:balena_documentation_13_deploying_sd_card.png?direct |}} | + | |
- | + | ||
- | <WRAP center round important 90%> | + | |
- | Insert the SD card back side up into the slot (i.e. the gold connectors towards the technician). Plug the power supply in. | + | |
- | </WRAP> | + | |
- | + | ||
- | + | ||
- | <WRAP center round info 90%> | + | |
- | Booting the device with the newly flashed OS will take a little longer - about 2 minutes. This is due to the necessary configuration of the OS. | + | |
- | </WRAP> | + | |
- | + |