Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions en/studio/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ You can login using the following methods:

## Driver Installation

When you first start SpacemiT Studio, the home page displays a **Service not started** message if the driver is not installed:
When you first start SpacemiT Studio, if the driver is not installed, the home page displays a **Service not started** message and the driver installation wizard opens automatically:

![Home page with no driver or device](./static/initial.png)

Click the message to open the SpacemiT Studio driver installation wizard, which provides the following options:
If the wizard does not open automatically, click the **Service not started** message to open it manually. The wizard provides the following options:

<img src="./static/driver_00.png" alt="Driver installation wizard" width="400">

Expand Down Expand Up @@ -120,7 +120,7 @@ After submission, the page displays a **Submitted Successfully** message.

> If submission fails, check your network connection and try again.

![Feedback dialog](./static/feedback.png)
<img src="./static/feedback.png" alt="Feedback dialog" width="400">

## Connect a Device

Expand Down
Binary file added en/studio/static/app_store.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/studio/static/app_store_00.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/studio/static/app_store_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified en/studio/static/device_00.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified en/studio/static/device_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified en/studio/static/device_03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified en/studio/static/driver_00.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified en/studio/static/driver_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified en/studio/static/home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/studio/static/key_write_00.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/studio/static/key_write_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/studio/static/key_write_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/studio/static/key_write_03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified en/studio/static/systool_preconfig_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
55 changes: 52 additions & 3 deletions en/studio/user_guide/app_store.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,57 @@ sidebar_position: 7

# App Center

> Note: This feature is under development.

## Overview

App Center provides browsing, installation, and management of applications and tools for the SpacemiT platform.
App Center supports the browsing, installation, and management of applications and tools for the SpacemiT platform. It is organized into the **Online Store** and **Installed Apps** pages.

![App Center](../static/app_store.png)

## Online Store

The Online Store displays all available applications in the ecosystem.

A search box in the upper-right corner enables apps to be located by name.

Each app card displays the following information:

- App name and version
- Publisher
- Summary
- Installation status, such as **Installed** or **Running**

Selecting an app card displays its details in the panel on the right, including:

![Online Store](../static/app_store_00.png)

- App icon, name, and current status, such as **Running**
- Version, publisher, and package size
- Action buttons: **Open** / **Uninstall** for installed apps, or **Install to device** for apps that are not installed
- Complete feature description
- Supported systems and architectures

## Installed Apps

The Installed Apps page lists and manages all applications currently installed on the device.

![Installed Apps](../static/app_store_01.png)

Select **Refresh** to retrieve the latest status for each app.

The list contains the following columns:

- **App**: App name and summary
- **Version**: Currently installed version
- **Architecture**: Runtime architecture
- **Status**: Runtime status, such as **Running**, **Installed**
- **Port / Access**: Service listening port or access point
- **Actions**: Actions available for the app

The available actions for each app depend on its running status:

- **Stop**: Stop a running app
- **Open**: Access the app in a browser or window
- **Config**: Modify the app configuration
- **Default**: Restore the default configuration
- **Uninstall**: Remove the app from the device
s
58 changes: 57 additions & 1 deletion en/studio/user_guide/dev_tools/flash.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ Writes a system image to an SD card, allowing the device to boot from the card.

![Select SD card](../../static/sdcard_1.png)

> If the list is empty, confirm the SD card is inserted and click the refresh button to re-detect.
> If the list is empty, confirm the SD card is inserted and click the refresh button to re-detect.

3. **Flash Boot Card** is selected by default under **Select Operation**.

Expand Down Expand Up @@ -176,3 +176,59 @@ The procedure is the same as [SD Card Boot](#sd-card-boot), with the following d
| System storage location | SD card | Device onboard storage |
| Behavior after SD card removal | Cannot boot | Operates normally |
| Typical use case | Debugging, evaluation | Mass production |

## Writing Tool

Writes factory configuration information, such as serial numbers and MAC addresses, to a device. Use it for production-line configuration or to verify information on an individual device.

### Writing Tool Procedure

1. Go to **Development Tools → Key Writing Tool**.

![Writing Tool entry](../../static/key_write_00.png)

2. Select the target device.

In the **Select Device** drop-down list, select the device to configure.

![Select Device](../../static/key_write_01.png)

> If the list is empty, confirm that the device is connected and in flashing mode, then click the refresh button ⟳ on the right to scan again.

3. (Optional) Configure fields.

To customize the fields displayed in the table, click **Configure Fields** to open the field configuration panel. In the panel, you can:

![Configure Fields](../../static/key_write_03.png)

- Use the **Enabled** switch to control whether a field is shown in the table.
- Click the edit icon **✎** to change a field's description or storage medium.
- Click the delete icon **🗑** icon to remove a field.
- Click **Add Field** to add a custom field.
- Click **Restore Default** to restore the default field list.

Click **Save** to apply the changes, or **Cancel** to discard them.

4. Read the current device configuration.

Click **Start Reading**. The tool reads all configuration fields from the device and fills the table.

![读号](../../static/key_write_02.png)

After the read operation completes, the table displays the following columns:

- **Property**: Technical identifier for the field, such as `product_name` or `serial#`.
- **Description**: Readable description of the field.
- **Storage Medium**: Storage location; `eeprom` is the default.
- **Value**: Current value stored on the device.
- **Status**: Result of the read operation, showing success (✓) or failure (✗).

Common fields include the hardware board model, device serial number, MAC address, and manufacturing date. The refresh button ⟳ beside each field reads that field again.

5. Edit and write configuration.

Edit the required values in the **Value** column, select the check box for each field to write, then click **Start Writing**.

After the write operation completes, the **Status** column shows the result for each field.

> After writing, click **Start Reading** again to verify that the configuration was written correctly.
1 change: 1 addition & 0 deletions en/studio/user_guide/dev_tools/system_tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ A headless initialization tool that presets system parameters before the device'
- **Hostname**: A custom device name. If left blank, the hostname is generated automatically.
- **Language / Timezone**: The system display language and timezone. The timezone defaults to UTC.
- **WiFi**: Optional. Enter the SSID and password (WPA/WPA2-PSK supported) to connect automatically on first boot.
- **Logo Configuration**: Upload a logo image to display during device boot. Only BMP format is supported, with 8/24/32-bit color depth and a maximum size of 1MB.

3. Click **Push and Run**. The configuration is written to the connected device and applied automatically on first boot.

Expand Down
9 changes: 6 additions & 3 deletions en/studio/user_guide/devices.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ After a device is connected successfully, the home page displays detailed inform
After a device is connected successfully, the following information is available:

- Device series and serial number
- Device IP address (for remote access)
- Currently installed operating system, such as Bianbu
- Device connection method, such as ADB
- Online/offline status
Expand All @@ -63,7 +64,7 @@ The bottom of the device panel provides shortcut buttons for common operations:
- **[Terminal](./terminal.md#terminal-sessions)**: Opens a terminal session for the device
- **[Files](./terminal.md#file-management)**: Opens device file management
- **[Serial Connection](./dev_tools/system_tools.md#serial-connection)**: Communicates with the device over a serial connection for low-level debugging and log viewing
- **Remote Desktop**: Accesses the device graphical interface through VNC/RDP
- **Desktop**: Accesses the device graphical interface through VNC/RDP
![](../static/remote.png)
- **IDE**: Opens the device integrated development environment in Studio
![IDE](../static/ide.png)
Expand All @@ -77,11 +78,13 @@ Connected devices can be assigned custom names to distinguish them when managing

### New Device

To add a device, click **+ New Device** and follow the steps in the **Connect Your Device** dialog to connect a local device.
At the bottom of the dialog, select either USB or SSH as the connection method.
To add a device, click **+ New Device** and follow the instructions in the **Connect Your Device** dialog to complete the connection.
At the bottom of the dialog, select a connection method: Cloud, SSH, or USB.

![New device](../static/device_03.png)

Newly added devices appear in the **Device** list.

## Activity

The Activity page consolidates two types of information:
Expand Down
6 changes: 3 additions & 3 deletions zh/studio/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ sidebar_position: 2

## 安装驱动

首次启动 SpacemiT Studio 时,如果尚未安装驱动,首页显示 **服务未启动** 提示:
首次启动 SpacemiT Studio 时,如果尚未安装驱动,首页将显示 **服务未启动** 提示:

![首页 - 无驱动无设备](./static/initial.png)

点击提示后,将弹出 SpacemiT Studio 的驱动安装引导窗口,提供以下三个操作
同时,驱动安装引导窗口会自动弹出。若该窗口未自动弹出,可点击 **服务未启动** 提示手动打开。驱动安装引导提供以下三种操作方式

<img src="./static/driver_00.png" alt="驱动安装引导" width="400">

Expand Down Expand Up @@ -121,7 +121,7 @@ sidebar_position: 2

> 如果提交失败,请检查网络状况后重试。

![](./static/feedback.png)
<img src="./static/feedback.png" alt="意见反馈" width="400">

## 连接设备

Expand Down
Binary file added zh/studio/static/app_store.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added zh/studio/static/app_store_00.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added zh/studio/static/app_store_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified zh/studio/static/device_00.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified zh/studio/static/device_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified zh/studio/static/device_03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified zh/studio/static/driver_00.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified zh/studio/static/driver_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified zh/studio/static/home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added zh/studio/static/key_write_00.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added zh/studio/static/key_write_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added zh/studio/static/key_write_02.png
Binary file added zh/studio/static/key_write_03.png
Binary file modified zh/studio/static/systool_preconfig_01.png
54 changes: 51 additions & 3 deletions zh/studio/user_guide/app_store.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,56 @@ sidebar_position: 7

# 应用中心

> 注:持续开发中...

## 概述

应用中心提供适配 SpacemiT 平台的应用和工具的浏览、安装与管理功能。
应用中心提供适配 SpacemiT 平台的应用和工具的浏览、安装与管理功能,分为 **在线商店** 和 **已安装应用** 两个页面。

![应用中心](../static/app_store.png)

## 在线商店

在线商店展示所有可用的生态应用。

界面右上角提供搜索框,可按应用名称快速定位。

每个应用卡片显示以下信息:

- 应用名称与版本
- 发布者
- 简介摘要
- 安装状态(如 **已安装**、**运行中**)

点击应用卡片后,右侧面板显示该应用的详情,包括:

![在线商店](../static/app_store_00.png)

- 应用图标、名称、当前运行状态(如 **运行中**)
- 版本、发布者、包大小
- 操作按钮:**打开** / **卸载**(已安装应用)或 **安装到设备**(未安装应用)
- 完整功能描述
- 支持的系统和系统

## 已安装应用

已安装应用页面以列表形式管理当前设备上的所有已安装应用。

![在线商店](../static/app_store_01.png)

点击 **⟳ 刷新** 可重新获取各应用的最新状态。

列表包含以下列:

- **应用**:应用名称与简介
- **版本**:当前安装版本
- **架构**:运行架构
- **状态**:运行状态(如 **运行中**,**已安装**)
- **端口 / 访问**:服务监听端口或访问入口
- **操作**:可对该应用执行的操作

每个应用的可用操作视运行状态而定:

- **停止**:停止正在运行的应用
- **打开**:在浏览器或窗口中访问应用
- **配置**:修改应用配置
- **默认配置**:恢复默认配置
- **卸载**:从设备卸载该应用
60 changes: 59 additions & 1 deletion zh/studio/user_guide/dev_tools/flash.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ sidebar_position: 1

![选择 SD 卡设备](../../static/sdcard_1.png)

> 若列表为空,请确认 SD 卡已插入读卡器,并点击右侧刷新按钮重新检测
> 若列表为空,请确认 SD 卡已插入读卡器,并点击右侧刷新按钮 ⟳ 重新检测

3. 在 **选择操作** 中已默认选择 **烧录启动卡**

Expand Down Expand Up @@ -176,3 +176,61 @@ sidebar_position: 1
| 系统运行位置 | SD 卡 | 设备内置存储 |
| 拔卡后 | 无法启动 | 正常运行 |
| 适用场景 | 调试、试用 | 批量生产 |

## 写号工具

向设备写入序列号、MAC 地址等出厂配置信息,适用于产线批量配置或单台设备信息校验。

### 写号工具 — 操作步骤

1. 进入 **开发工具 → 写号工具**

![写号工具入口](../../static/key_write_00.png)

2. 选择目标设备

在 **选择设备** 下拉菜单中选择需要配置的设备。

![选择设备](../../static/key_write_01.png)

> 若列表为空,请确认设备已连接并切换至刷机模式,然后点击右侧刷新按钮 ⟳ 重新检测。

3. (可选)配置字段

如需自定义表格中显示的属性字段,点击 **配置字段** 进入字段配置面板。

![配置字段](../../static/key_write_03.png)

在配置面板中可以:

- 通过 **启用** 开关控制各属性是否在表格中显示
- 点击每行右侧的编辑图标 **✎** 修改属性的描述或存储介质
- 点击删除图标 **🗑** 移除该字段
- 点击 **新增字段** 添加自定义属性
- 点击 **恢复默认** 将字段列表恢复为系统默认配置

配置完成后点击 **保存**,或点击 **取消** 放弃修改。

4. 读取设备当前配置

点击 **开始读号**,工具将从设备读取所有配置字段并填充到表格中。

![读号](../../static/key_write_02.png)

读取完成后,表格显示以下五列信息:

- **属性**:字段的技术标识符(如 `product_name`、`serial#`)
- **描述**:字段的说明(如"硬件板型号""设备序列号")
- **存储介质**:存储位置,默认为 `eeprom`
- **值**:设备中当前存储的值
- **状态**:读取结果,显示成功(✓)或失败(✗)

常见属性包括硬件板型号、设备序列号、网卡物理地址、生产日期等出厂信息。每个属性右侧提供单独的刷新按钮 ⟳,可单独重新读取该字段的值。

5. 编辑并写入配置

在表格的 **值** 列中编辑需要修改的属性值,勾选对应行的复选框,然后点击 **开始写号**。

写入完成后,**状态** 列会显示各字段的写入结果。

> 建议写入完成后再次点击 **开始读号** 进行校验,确认配置已正确写入设备。
1 change: 1 addition & 0 deletions zh/studio/user_guide/dev_tools/system_tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ sidebar_position: 2
- **主机名**:自定义设备名称,留空则自动生成。
- **语言 / 时区**:系统显示语言与时区,时区默认为 UTC。
- **WiFi**:可选,填写 SSID 和密码(支持 WPA/WPA2-PSK),设备首次启动时自动连接。
- **LOGO 配置**:上传设备启动时显示的 LOGO 图片,仅支持 BMP 格式,色深为 8/24/32 位,大小不超过 1MB。

3. 点击 **推送并执行**,配置将写入已连接的设备,首次启动时自动应用

Expand Down
7 changes: 5 additions & 2 deletions zh/studio/user_guide/devices.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ sidebar_position: 1
连接成功后可查看以下信息:

- 设备系列与序列号
- 设备 IP 地址(用于远程访问)
- 当前已安装的系统(如 Bianbu)
- 设备连接方式(如 ADB)
- 在线 / 离线状态
Expand Down Expand Up @@ -77,11 +78,13 @@ sidebar_position: 1

### 新设备

如需增加新设备,可点击 **+新设备** 按键,在弹出的"连接您的设备"窗口中按步骤完成本地设备连接
窗口底部切换可选择连接方式 USB 或 SSH
如需增加新设备,可点击 **+新设备** 按键,在弹出的 **连接您的设备** 窗口中按步骤完成设备连接
窗口底部可切换连接方式:Cloud、SSH 或 USB

![新设备](../static/device_03.png)

新增的设备会显示在 **当前设备** 列表中。

## 动态

动态页面汇总两类信息:
Expand Down
Loading