Skip to content

Commit

Permalink
magicBox manual
Browse files Browse the repository at this point in the history
  • Loading branch information
SHLcy committed Mar 29, 2024
1 parent d72723c commit 4634989
Show file tree
Hide file tree
Showing 10 changed files with 54 additions and 34 deletions.
2 changes: 1 addition & 1 deletion docs/esp-tool.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ If you're unable to update the firmware using Chrome/Edge due to compatibility i
### Driver Installation

1. For macOS, you can directly proceed without installing any drivers.
2. If your Windows system doesn't have built-in serial port drivers, you'll need to install the appropriate drivers. You can download the drivers from [here](https://www.wch.cn/downloads/category/67.html?feature=USB%E8%BD%AC%E4%B8%B2%E5%8F%A3&product_name=CH340).
2. If your Windows system doesn't have built-in serial port drivers, you'll need to install the appropriate drivers. You can download the drivers from [here](https://github.com/FoloToy/folotoy-doc/issues/52).

### Updating Firmware using Python3

Expand Down
2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ In the default configuration of folotoy-server-self-hosting docker-compose.yml,
**Please ensure that the toy is powered on. Flashing can only be done when the device is powered on. Connecting the USB cable to the standalone circuit board alone will not work.**

1. Make sure your computer has the latest version of Chrome/Edge browser installed.
2. If you are a Windows user, make sure you have installed the [driver](https://www.wch.cn/downloads/category/67.html?feature=USB%E8%BD%AC%E4%B8%B2%E5%8F%A3&product_name=CH340).
2. If you are a Windows user, make sure you have installed the [driver](https://github.com/FoloToy/folotoy-doc/issues/52).
3. Ensure that you are using the data cable provided with the toy or any other data transfer-capable cable (some cables are for charging only).
4. Ensure that the data cable is properly connected. When selecting the device for flashing, observe if the device frequently disconnects and reconnects.
5. If the browser still cannot detect the device after ensuring the above steps are correct, you can view the system's serial port devices using the following methods:
Expand Down
22 changes: 19 additions & 3 deletions docs/installation/serverFile.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,20 @@
---
title: 服务器主要配置文件说明
sidebar_label: 服务器主要配置文件说明
---
title: Server Configuration File Explanation
sidebar_label: Server Configuration File Explanation
---

1. [docker.compose.yml](../configuration/environment_variables).This file is used to configure global parameters, such as:`TTS(Text-to-Speech)`, `LLM(Large Language Model)`, `STT(Speech-to-Text)`,`Server address` and `Port`.

:::caution

Make sure all used ports are open, including `1883/tcp`,`8082/tcp`,`18083/tcp`,`8083/tcp`,`8085/udp`, `8085` port is a `UDP`. For some VPS, you may need to open the ports in the security group. **Please make sure it is opened successfully**.
:::


2. [roles.json](../configuration/roles_config).This file is used to configure the parameters for each role, such as::`start text`, `prompt`, each role's own `TTS (Text-to-Speech)`, `LLM (Large Language Model)` and `STT (Speech-to-Text)`. **If TTS, LLM, STT are not defined in `roles.json`, the system will use the ones defined in `docker.compose.yml`**

:::caution

The configuration in `roles.json` will override the configuration in `docker-compose.yml`, thus achieving role-level configuration. If `TTS`, `LLM`, `STT` are defined in `roles.json`, the system will automatically use the ones defined in `roles.json`. Please carefully read the Role Detailed Settings in the documentation about the configuration of `TTS`, `LLM`, `STT`.

:::
2 changes: 1 addition & 1 deletion docs/web-tool.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This [ web ](https://tool.folotoy.com/index) is designed to facilitate three key

- Dialogue: This feature enables you to view and manage conversation content associated with your devices.

*** For windows users, you may need to install a [ driver ](https://www.wch.cn/downloads/category/67.html?feature=USB%E8%BD%AC%E4%B8%B2%E5%8F%A3&product_name=CH340) so that your device can connect to your PC. ***
*** For windows users, you may need to install a [ driver ](https://github.com/FoloToy/folotoy-doc/issues/52) so that your device can connect to your PC. ***

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ module.exports = {
{
docs: {
// routeBasePath: "", // Docs-only
sidebarCollapsible: false,
sidebarCollapsible: true,
sidebarPath: require.resolve("./sidebars.js"),
editUrl:
"https://github.com/FoloToy/folotoy-doc/edit/main/",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar_label: 固件升级(使用esptool)
### 驱动安装

1. MacOS 下可以直接使用,不需要安装驱动
2. 如果 Windows 系统没有自带串口驱动,需要安装好串口驱动,[驱动下载](https://www.wch.cn/downloads/category/67.html?feature=USB%E8%BD%AC%E4%B8%B2%E5%8F%A3&product_name=CH340)
2. 如果 Windows 系统没有自带串口驱动,需要安装好串口驱动,[驱动下载](https://github.com/FoloToy/folotoy-doc/issues/52)

### 使用 Python3 更新固件

Expand Down
2 changes: 1 addition & 1 deletion i18n/zh/docusaurus-plugin-content-docs/current/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ folotoy-server-self-hosting 默认的配置 docker-compose.yml 中,使用了 1
**请确认玩具是否已经开机,刷机需要在通电开机状态下进行,单独的电路板连接 USB 线是不行的**

1. 确保您的计算机已安装最新版本的 Chrome/Edge 浏览器。
2. 如果是 Windows 用户,请确保安装了[驱动](https://www.wch.cn/downloads/category/67.html?feature=USB%E8%BD%AC%E4%B8%B2%E5%8F%A3&product_name=CH340)
2. 如果是 Windows 用户,请确保安装了[驱动](https://github.com/FoloToy/folotoy-doc/issues/52)
3. 确保您使用的是玩具配套的数据线或者其他可以传输数据的数据线(有些数据线仅用于充电)。
4. 确保数据线连接良好,您可以在刷机选择设备的时候,停留一阵子观察设备是否会经常断开重连。
5. 在确保上述的操作正确后,浏览器仍然无法查看设备的话,可以通过以下方式查看系统的串口设备:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ sidebar_label: 服务器主要配置文件说明

`roles.json` 中的配置会覆盖 `docker-compose.yml` 中的配置,从而达到角色级别的配置。如果在 `role.json`中定义了 TTS, LLM, STT, 则系统会自动使用 `roles.json` 中所定义的。请仔细查阅文档中`角色详细设置`关于 TTS, LLM, STT 的配置。

:::
:::
4 changes: 2 additions & 2 deletions i18n/zh/docusaurus-plugin-content-docs/current/web-tool.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar_label: 固件升级和问题诊断
## 驱动安装

* MacOS 下可以直接使用 Chrome (v89以上,需要支持 Web Serial 接口)刷机,不需要安装驱动
* 如果系统没有自带串口驱动,需要安装好串口驱动,[驱动下载](https://www.wch.cn/downloads/category/67.html?feature=USB%E8%BD%AC%E4%B8%B2%E5%8F%A3&product_name=CH340)
* 如果系统没有自带串口驱动,需要安装好串口驱动,[驱动下载](https://github.com/FoloToy/folotoy-doc/issues/52)


<img src="https://user-images.githubusercontent.com/41461127/281996998-de76550b-5701-40dd-a115-38988f78a1c8.png" />
Expand All @@ -18,7 +18,7 @@ sidebar_label: 固件升级和问题诊断
- 日志:使用此功能查看设备的实时日志,有助于有效地调试和故障排除。
- 对话:此功能使您可以查看和管理与设备相关的对话内容。

*** Windows 用户可能需要安装[ 驱动 ](https://www.wch.cn/downloads/category/67.html?feature=USB%E8%BD%AC%E4%B8%B2%E5%8F%A3&product_name=CH340)后,设备才能连接上电脑。 ***
*** Windows 用户可能需要安装[ 驱动 ](https://github.com/FoloToy/folotoy-doc/issues/52)后,设备才能连接上电脑。 ***

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
Expand Down
48 changes: 26 additions & 22 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,14 @@ module.exports = {
{
type: "category",
label: "Server Installation",
collapsible: true,
collapsed: true,
items: [
{
type: "category",
label: "Server Installation File",
collapsible: true,
collapsed: false,
items: [
"installation/serverFile",
"configuration/environment_variables",
Expand All @@ -20,29 +24,29 @@ module.exports = {
]
},

{
type: "category",
label: "Server Installation Method",
items: [
"installation/docker",
"installation/1panel",
"installation/synology-nas",
"installation/flyio",
"installation/windows-wsl2",
]
}
],
},
{
type: "category",
label: "Toy PCB Replacement",
items: [
"toy-pcb-replacement/video-tutorial",
"toy-pcb-replacement/alilo-g6",
"toy-pcb-replacement/alilo-f6",
"toy-pcb-replacement/mitu-c1",
{
type: "category",
label: "Server Installation Method",
items: [
"installation/docker",
"installation/1panel",
"installation/synology-nas",
"installation/flyio",
"installation/windows-wsl2",
]
}
],
},
}
],
},
{
type: "category",
label: "Toy PCB Replacement",
items: [
"toy-pcb-replacement/video-tutorial",
"toy-pcb-replacement/alilo-g6",
"toy-pcb-replacement/alilo-f6",
"toy-pcb-replacement/mitu-c1",
],
},
{
Expand Down

0 comments on commit 4634989

Please sign in to comment.