// ******************************************************
// * Copyright (c) 2026 RayzerLink. Licensed under MIT. *
// *                        website: www.rayzerlink.com *
// *               slack/email: tide.yin@rayzerlink.com *
// *                           linkedin/wechat: tideyin *
// ******************************************************

# Awakeno Quick Bring-up Guide (English)

| Field | Value |
| --- | --- |
| Author | RayzerLink / tide.yin |
| Status | Draft |
| Version | V1.0.0 |
| Date | 2026-09-29 |
| Hardware / firmware | Awakeno (GD32E103RBT6) |
| Related docs | `Materials.zip` · Awakener schematic, on-board component handbooks, and GPIO definitions |

This guide helps you set up the Awakeno build environment, compile and flash firmware, and verify basic peripherals within a few minutes.

---

## 1. Manual and AI-assisted project setup

1. Create an Awakeno working directory.
2. Download the source code from GitHub or Gitee:
   - [GitHub: tideyin/awakeno](https://github.com/tideyin/awakeno/tree/main/)
   - [Gitee: tideyin/awakeno](https://gitee.com/tideyin/awakeno/tree/main/)
3. Download `Materials.zip` from [www.rayzerlink.com](https://www.rayzerlink.com/) and extract it into the Awakeno directory.
4. Create the firmware build output directory `out`.
5. Open the Awakeno working directory with an AI assistant.
6. AI prompt: Help me set up a GigaDevice GD32E103 build environment, and place build outputs in the `out` directory.
7. AI prompt: Analyze this project’s source tree and directory layout (`platform` and `project` directories), and become familiar with the reference manuals and other materials under the `Materials` directory.
8. AI prompt: Help me build the Awakeno project.

---

## 2. Firmware download tool

1. Open [www.rayzerlink.com](https://www.rayzerlink.com/).
2. Go to **Design & Development** and download the software tool (Test Kit Firmware Download Tool).
3. For detailed usage, see the **GD Firmware Download Tool User Manual**.  
   Enter download mode: hold the small button at the bottom-right of the board, then plug in USB.

---

## 3. Hardware preparation

1. Awakeno development board.
2. USB Type-C cable.
3. XH2.54 4-pin cable (use the green / white / black wires).
4. USB-to-serial adapter, configured for **3.3 V**.
5. Connect the XH2.54 4-pin cable to the red XH2.54 header; wire the three leads to the USB-serial adapter as follows:
   - **Green → USB-serial RX**
   - **White → USB-serial TX**
   - **Black → GND**
   - **Red → leave unconnected**

This serial port is the on-board **DBG UART** (USART0, PA9/PA10), **921600** baud, 8N1.

---

## 4. Audio file programming

`hello_ttlab.bin` contains WAV data with trailing EOF marker `FA05A55A` (see generation notes under `Util/Src` in the project). Maximum programmed size is about **75 KB**.

1. Send the following AT command over the **USB CDC** serial port (line ending `\r\n`):

   ```text
   AT+AUDTST=F
   ```

2. After the firmware enters the waiting state, send the binary file `hello_ttlab.bin` over **DBG UART (921600)** (do not use text mode).
3. When the transfer finishes, the firmware ends on EOF recognition; you may try playback with `AT+AUDTST=A` / `B` / `C` (see `HELP?`).

---

## 5. Expected normal behavior

1. At power-up, the OLED logo page shows multilingual greetings (see `show_logo_state()`):
   - English: `Hello World!`
   - Chinese (GBK): 你好世界!
   - Hebrew and Arabic greeting lines
2. The USB CDC port is active and accepts AT commands (line ending: `\r\n`):
   - `AT?`: simplest connectivity check; expect `OK`
   - `HELP?`: list all supported commands

---

## 6. Support

- Website: [www.rayzerlink.com](https://www.rayzerlink.com)
- Email / Slack: tide.yin@rayzerlink.com
- LinkedIn / WeChat: tideyin