Skip to content

Commit

Permalink
docs: jupiter burn sdcard use etcher
Browse files Browse the repository at this point in the history
  • Loading branch information
carbonfix committed Sep 5, 2024
1 parent c7279d0 commit 03b90f3
Show file tree
Hide file tree
Showing 20 changed files with 73 additions and 140 deletions.
105 changes: 36 additions & 69 deletions docs/jupiter/getting-started/boot.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,68 +19,41 @@ Currently, Jupiter's image package formats mainly have the following two formats

- The system image package with the suffix `.img.zip` is a dedicated image package for SD cards.

- The SD card must be inserted into the PC through a card reader for burning.

- Supports burning using the Spacemit official burning tool `titanflasher` (need to be unzipped to a `.img` file before burning).
- Supports burning with tools such as `balenaEtcher`, `Rufus`, `Win32DiskImager`, etc. In Linux, you can use the `dd` command to burn. Some of these tools support burning zip packages directly, while some need to be decompressed into `.img` files before burning. Please try it yourself.

- It also supports burning with tools such as `balenaEtcher`, `Rufus`, `Win32DiskImager`, etc. In Linux, you can use the `dd` command to burn. Some of these tools support burning zip packages directly, while some need to be decompressed into `.img` files before burning. Please try it yourself. For the method of burning with `balenaEtcher`, please refer to the section at the end of the page.
- The SD card must be inserted into the PC through a card reader for burning.

- The system image package with the suffix `.zip` can be burned to SSD, eMMC or SD card.
- The system image package with the suffix `.zip` can be burned to SSD or eMMC.

- Must use Spacemit official flashing tool `titanflasher` to flash.
- It is recommended to use Spacemit official flashing tool `titanflasher` to flash.

- When burning to SSD or eMMC, you must connect to the PC via a Type-C cable for burning.

- When burning to an SD card, the SD card must be inserted into the PC through a card reader for burning.

The following uses the Spacemit `titanflasher` tool as an example to introduce the methods of burning to SD card, SSD, and eMMC respectively.

## Download and install the `titanflasher` tool

`titanflasher` currently provides versions for both X86(X64) and Linux platforms.

Sorry, the Linux version does not support English interface yet.

download link: [https://github.com/milkv-jupiter/jupiter-tools/releases/tag/titanflasher](https://github.com/milkv-jupiter/jupiter-tools/releases/tag/titanflasher)
The following describes the methods for burning to SD card, SSD and eMMC respectively.

If prompted during Windows installation, select `Install this driver software anyway`.
<Image src='/docs/jupiter/titanflasher-20-en.webp' maxWidth='100%' align='left' />
## Install OS to the SD card

:::tip
When using the `titanflasher` tool to flash the firmware, the firmware will be unzipped to its workspace. Please check `Auto Clean` in `Settings`, or manually delete unused files in the workspace directory to avoid cache files taking up too much system space after multiple flashes.
The SD card OS has the highest startup priority. All boot programs required for startup, including u-boot, kernel, and system, are stored in the SD card.
:::
<Image src='/docs/jupiter/titanflasher-35-en.webp' maxWidth='100%' align='left' />

## Install OS to the SD card

The SD card OS has the highest startup priority. All boot programs required for startup, including u-boot, kernel, and system, are stored in the SD card.
Taking the `balenaEtcher` tool as an example, the burning method is as follows.

First, go to the resource download page to download the system image package for the SD card (the suffix is ​​`.img.zip`):[Resource Download Summary](https://milkv.io/docs/jupiter/getting-started/resources)

After downloading, unzip it into a `.img` file.
After downloading, you can decompress it into a `.img` file and then burn it. You can also use it without unzipping, `balenaEtcher` supports loading zip packages.

Insert the SD card into the PC through the card reader. Installing the system to the SD card will clear the original data in the SD card, so **note to back up important files in the card in advance**.

1. Run the `titanflasher` tool and select "Dev Tools".
<Image src='/docs/jupiter/titanflasher-01-en.webp' maxWidth='100%' align='left' />
2. Select "SDcard Boot Disk".
<Image src='/docs/jupiter/titanflasher-02-en.webp' maxWidth='100%' align='left' />
3. Click "Select Storage" to select the target SD card.
<Image src='/docs/jupiter/titanflasher-03-en.webp' maxWidth='100%' align='left' />
4. Click "Select File".
<Image src='/docs/jupiter/titanflasher-04-en.webp' maxWidth='100%' align='left' />
5. Click "Local File" and select the unzipped `.img` SD card image.
<Image src='/docs/jupiter/titanflasher-05-en.webp' maxWidth='100%' align='left' />
6. Select "Boot Card".
<Image src='/docs/jupiter/titanflasher-06-en.webp' maxWidth='100%' align='left' />
7. Click "Start".
<Image src='/docs/jupiter/titanflasher-07-en.webp' maxWidth='100%' align='left' />
8. Click "OK".
<Image src='/docs/jupiter/titanflasher-08-en.webp' maxWidth='100%' align='left' />
9. Start burning.
<Image src='/docs/jupiter/titanflasher-09-en.webp' maxWidth='100%' align='left' />

When the burning progress bar shows 100%, the burning is complete. Insert the SD card with the burned system into the SD card slot of Jupiter, power on, and if the Desktop version of the system is installed, the display connected via HDMI will display the startup LOGO, and the system will enter the desktop after startup.
1. Download the image burning tool [balenaEtcher](https://etcher.balena.io/) and install it.
2. Click `Flash from file` and select the downloaded SD card image.
<Image src='/docs/common/etcher-step1.webp' maxWidth='100%' align='left' />
3. Click `Select target` to select the SD card.
<Image src='/docs/common/etcher-step2.webp' maxWidth='100%' align='left' />
4. Click `Flash!` to start flashing.
<Image src='/docs/common/etcher-step3.webp' maxWidth='100%' align='left' />

After the burning is complete, insert the SD card into the Jupiter board and start the system. The SD card system currently does not have the function of automatically expanding the capacity after startup. After the first startup, please expand the system partition according to the method in the previous section.

### System partition expansion

Expand Down Expand Up @@ -130,10 +103,26 @@ The priority of burning is the same as the priority of booting. If both SSD and

First, go to the resource download page to download the system image package with the suffix `.zip` (not `.img.zip`): [Resource Download Summary](https://milkv.io/docs/jupiter/getting-started/resources)。

### Use titanflasher flash tool

Note that you do not need to unzip the zip package after downloading it.

### Download and install the `titanflasher` tool

To burn the system to SSD or eMMC, it is recommended to use the official tool `titanflasher` from Titan. Currently, versions for both X86 (X64) and Linux platforms are provided.

Sorry, the Linux version does not support English interface yet.

download link: [https://github.com/milkv-jupiter/jupiter-tools/releases/tag/titanflasher](https://github.com/milkv-jupiter/jupiter-tools/releases/tag/titanflasher)

If prompted during Windows installation, select `Install this driver software anyway`.
<Image src='/docs/jupiter/titanflasher-20-en.webp' maxWidth='100%' align='left' />
:::tip
When using the `titanflasher` tool to flash the firmware, the firmware will be unzipped to its workspace. Please check `Auto Clean` in `Settings`, or manually delete unused files in the workspace directory to avoid cache files taking up too much system space after multiple flashes.
:::
<Image src='/docs/jupiter/titanflasher-35-en.webp' maxWidth='100%' align='left' />
### Use titanflasher flash tool
1. Use a Type-C cable to connect the Type-C port of Jupiter to the PC.
<Image src='/docs/common/usba2typec.webp' maxWidth='50%' align='left' />
Expand Down Expand Up @@ -182,25 +171,3 @@ fastboot flash rootfs rootfs.ext4
sleep 2
fastboot reboot
```
## Others
### Use 3rd tools to burn SD card images
SD card system image can be burned using tools such as balenaEtcher, Rufus, Win32DiskImager, etc. Taking `balenaEtcher` as an example, the burning method is as follows.
First, insert the SD card into the PC through the card reader. Installing the system to the SD card will clear the original data in the SD card, so **note to back up important files in the card in advance**.
Go to the resource download page to download the system image package for the SD card (suffix is ​​`.img.zip`): [Resource download summary](https://milkv.io/docs/jupiter/getting-started/resources)。
You don't need to decompress the file after downloading. `balenaEtcher` supports loading zip packages.
1. Download the image burning tool [balenaEtcher](https://etcher.balena.io/) and install it.
2. Click `Flash from file` and select the downloaded SD card image.
<Image src='/docs/common/etcher-step1.webp' maxWidth='100%' align='left' />
3. Click `Select target` to select the SD card.
<Image src='/docs/common/etcher-step2.webp' maxWidth='100%' align='left' />
4. Click `Flash!` to start flashing.
<Image src='/docs/common/etcher-step3.webp' maxWidth='100%' align='left' />
After the burning is complete, insert the SD card into the Jupiter board and start the system. The SD card system currently does not have the function of automatically expanding the capacity after startup. After the first startup, please expand the system partition according to the method in the previous section.
Original file line number Diff line number Diff line change
Expand Up @@ -19,67 +19,41 @@ Jupiter 主板支持从 SD 卡,eMMC,SSD(M.2 NVMe)三种介质启动系

- 后缀为 `.img.zip` 的系统镜像包,为 SD 卡专用镜像包。

- 必须将 SD 卡通过读卡器插到 PC 上进行烧录。

- 支持使用进迭官方烧录工具 `titanflasher` 烧录(需解压为 `.img` 文件后烧录)。
- 支持通过 `balenaEtcher``Rufus``Win32DiskImager` 等工具烧录,Linux 下可使用 `dd` 命令烧录,这类工具有些支持直接烧录 zip 包,有些需要解压为 `.img` 文件后再烧录,请自行尝试。

- 也支持通过 `balenaEtcher``Rufus``Win32DiskImager` 等工具烧录,Linux 下可使用 `dd` 命令烧录,这类工具有些支持直接烧录 zip 包,有些需要解压为 `.img` 文件后再烧录,请自行尝试。使用 `balenaEtcher` 烧录的方法请参考文末章节
- 必须将 SD 卡通过读卡器插到 PC 上进行烧录

- 后缀为 `.zip` 的系统镜像包,可烧录到 SSD,eMMCSD 卡中
- 后缀为 `.zip` 的系统镜像包,可烧录到 SSD 或 eMMC

- 必须使用进迭官方烧录工具 `titanflasher` 烧录。
- 推荐使用进迭官方烧录工具 `titanflasher` 烧录。

- 烧录到 SSD 或 eMMC 时,必须通过 Type-C 线连接到 PC 上进行烧录。

- 烧录到 SD 卡时,必须将 SD 卡通过读卡器插到 PC 上进行烧录。

以下分别介绍烧录到 SD 卡,SSD 和 eMMC 中的方法。

以下以使用进迭 `titanflasher` 工具为分例,分别介绍烧录到 SD 卡,SSD,和 eMMC 中的方法。

## 进迭 `titanflasher` 工具的下载和安装
## 安装系统到 SD 卡

`titanflasher` 目前提供 X86(X64) 和 Linux 两种平台下的版本。
:::tip
SD 卡系统的启动优先级最高,启动所需要的所有引导程序,u-boot,kernel,system 均存储在 SD 卡中。
:::

下载地址:[https://github.com/milkv-jupiter/jupiter-tools/releases/tag/titanflasher](https://github.com/milkv-jupiter/jupiter-tools/releases/tag/titanflasher)
以使用 `balenaEtcher` 工具为例,烧录方法如下。

Windows 版本安装中如有提示,请选择 `始终安装此驱动软件`
<Image src='/docs/jupiter/titanflasher-20.webp' maxWidth='100%' align='left' />
首先将 SD 卡通过读卡器插到 PC 上。安装系统到 SD 中会清除 SD 卡中原有数据,**注意提前备份卡中的重要文件**

:::tip
在使用 `titanflasher` 工具刷机过程中,会将固件解压到其工作区,请在 `设置` 中勾选 `自动清理`,或者到工作空间目录手动删除不使用的文件,避免多次刷机后,缓存文件占用太多的系统空间。
:::
<Image src='/docs/jupiter/titanflasher-35.webp' maxWidth='100%' align='left' />
到资源下载页面下载 SD 卡对应的系统镜像包(后缀为 `.img.zip`):[资源下载汇总](https://milkv.io/zh/docs/jupiter/getting-started/resources)

## 安装系统到 SD 卡
下载后可以解压为 `.img`文件后烧录,可以不解压,`balenaEtcher` 支持加载 zip 包。

SD 卡系统的启动优先级最高,启动所需要的所有引导程序,u-boot,kernel,system 均存储在 SD 卡中。
1. 下载镜像烧录工具 [balenaEtcher](https://etcher.balena.io/),并安装。
2. 点击 `Flash from file` 选择下载好的 SD 卡镜像。
<Image src='/docs/common/etcher-step1.webp' maxWidth='100%' align='left' />
3. 点击 `Select target` 选择 SD 卡。
<Image src='/docs/common/etcher-step2.webp' maxWidth='100%' align='left' />
4. 点击 `Flash!` 开始烧录。
<Image src='/docs/common/etcher-step3.webp' maxWidth='100%' align='left' />

首先到资源下载页面下载 SD 卡对应的系统镜像包(后缀为 `.img.zip`):[资源下载汇总](https://milkv.io/zh/docs/jupiter/getting-started/resources)

下载后解压为 `.img` 文件。

将 SD 卡通过读卡器插到 PC 上。安装系统到 SD 中会清除 SD 卡中原有数据,**注意提前备份卡中的重要文件**

1. 运行 `titanflasher` 工具,选择"研发工具"。
<Image src='/docs/jupiter/titanflasher-01.webp' maxWidth='100%' align='left' />
2. 选择 "卡启动"。
<Image src='/docs/jupiter/titanflasher-02.webp' maxWidth='100%' align='left' />
3. 点击 "选择SD卡",选择目标 SD 卡。
<Image src='/docs/jupiter/titanflasher-03.webp' maxWidth='100%' align='left' />
4. 点击 "选择刷机包"。
<Image src='/docs/jupiter/titanflasher-04.webp' maxWidth='100%' align='left' />
5. 点击 "本地镜像",选择上面解压好的 `.img` SD 卡镜像。
<Image src='/docs/jupiter/titanflasher-05.webp' maxWidth='100%' align='left' />
6. 选择"烧录启动卡"。
<Image src='/docs/jupiter/titanflasher-06.webp' maxWidth='100%' align='left' />
7. 点击 "执行"。
<Image src='/docs/jupiter/titanflasher-07.webp' maxWidth='100%' align='left' />
8. 点击 "确定"。
<Image src='/docs/jupiter/titanflasher-08.webp' maxWidth='100%' align='left' />
9. 开始烧录。
<Image src='/docs/jupiter/titanflasher-09.webp' maxWidth='100%' align='left' />

当烧录进度条显示为 100% 时烧录完成。将烧录好系统的 SD 卡插入 Jupiter 的 SD 卡槽中,上电开机,如果安装的是 Desktop 版本的系统,通过 HDMI 连接的显示器会显示开机 LOGO,系统启动完后会进入桌面。
烧录完成后,将 SD 卡插到 Jupiter 主板上开机。SD 卡系统目前没有开机后自动扩容功能,首次开机后,请按前面章节中的方法对系统分区进行扩容。

### 系统分区扩容

Expand Down Expand Up @@ -129,10 +103,24 @@ SD 卡系统目前没有开机后自动扩容功能,请在开机后首先手

首先到资源下载页面下载后缀为 `.zip`(非 `.img.zip`) 的系统镜像包:[资源下载汇总](https://milkv.io/zh/docs/jupiter/getting-started/resources)。

### 使用进迭 titanflasher 刷机工具

注意,`zip` 包下载后不需要解压。

### 进迭 `titanflasher` 工具的下载和安装

烧录系统到 SSD 或 eMMC,推荐使用进迭官方工具 `titanflasher`,目前提供 X86(X64) 和 Linux 两种平台下的版本。

下载地址:[https://github.com/milkv-jupiter/jupiter-tools/releases/tag/titanflasher](https://github.com/milkv-jupiter/jupiter-tools/releases/tag/titanflasher)

Windows 版本安装中如有提示,请选择 `始终安装此驱动软件`
<Image src='/docs/jupiter/titanflasher-20.webp' maxWidth='100%' align='left' />

:::tip
在使用 `titanflasher` 工具刷机过程中,会将固件解压到其工作区,请在 `设置` 中勾选 `自动清理`,或者到工作空间目录手动删除不使用的文件,避免多次刷机后,缓存文件占用太多的系统空间。
:::
<Image src='/docs/jupiter/titanflasher-35.webp' maxWidth='100%' align='left' />

### 使用进迭 titanflasher 刷机

1. 用 Type-C 线将 Jupiter 的 Type-C 口连接到 PC 端。
<Image src='/docs/common/usba2typec.webp' maxWidth='50%' align='left' />

Expand Down Expand Up @@ -181,25 +169,3 @@ fastboot flash rootfs rootfs.ext4
sleep 2
fastboot reboot
```

## 其他

### 使用第三方工具烧录 SD 卡镜像

SD 卡系统镜像支持使用 balenaEtcher,Rufus,Win32DiskImager 等工具烧录,以 `balenaEtcher` 为例,烧录方法如下。

首先将 SD 卡通过读卡器插到 PC 上。安装系统到 SD 中会清除 SD 卡中原有数据,**注意提前备份卡中的重要文件**

到资源下载页面下载 SD 卡对应的系统镜像包(后缀为 `.img.zip`):[资源下载汇总](https://milkv.io/zh/docs/jupiter/getting-started/resources)。

下载后可以不解压,`balenaEtcher` 支持加载 zip 包。

1. 下载镜像烧录工具 [balenaEtcher](https://etcher.balena.io/),并安装。
2. 点击 `Flash from file` 选择下载好的 SD 卡镜像。
<Image src='/docs/common/etcher-step1.webp' maxWidth='100%' align='left' />
3. 点击 `Select target` 选择 SD 卡。
<Image src='/docs/common/etcher-step2.webp' maxWidth='100%' align='left' />
4. 点击 `Flash!` 开始烧录。
<Image src='/docs/common/etcher-step3.webp' maxWidth='100%' align='left' />

烧录完成后,将 SD 卡插到 Jupiter 主板上开机。SD 卡系统目前没有开机后自动扩容功能,首次开机后,请按前面章节中的方法对系统分区进行扩容。
Binary file removed static/docs/jupiter/titanflasher-01-en.webp
Binary file not shown.
Binary file removed static/docs/jupiter/titanflasher-01.webp
Binary file not shown.
Binary file removed static/docs/jupiter/titanflasher-02-en.webp
Binary file not shown.
Binary file removed static/docs/jupiter/titanflasher-02.webp
Binary file not shown.
Binary file removed static/docs/jupiter/titanflasher-03-en.webp
Binary file not shown.
Binary file removed static/docs/jupiter/titanflasher-03.webp
Binary file not shown.
Binary file removed static/docs/jupiter/titanflasher-04-en.webp
Binary file not shown.
Binary file removed static/docs/jupiter/titanflasher-04.webp
Binary file not shown.
Binary file removed static/docs/jupiter/titanflasher-05-en.webp
Binary file not shown.
Binary file removed static/docs/jupiter/titanflasher-05.webp
Binary file not shown.
Binary file removed static/docs/jupiter/titanflasher-06-en.webp
Binary file not shown.
Binary file removed static/docs/jupiter/titanflasher-06.webp
Binary file not shown.
Binary file removed static/docs/jupiter/titanflasher-07-en.webp
Binary file not shown.
Binary file removed static/docs/jupiter/titanflasher-07.webp
Binary file not shown.
Binary file removed static/docs/jupiter/titanflasher-08-en.webp
Binary file not shown.
Binary file removed static/docs/jupiter/titanflasher-08.webp
Binary file not shown.
Binary file removed static/docs/jupiter/titanflasher-09-en.webp
Binary file not shown.
Binary file removed static/docs/jupiter/titanflasher-09.webp
Binary file not shown.

0 comments on commit 03b90f3

Please sign in to comment.