# HoneyGUI

**Repository Path**: realmcu/HoneyGUI

## Basic Information

- **Project Name**: HoneyGUI
- **Description**: HoneyGUI 是由 Realtek 自主研发的图形显示框架，它是一款专为资源受限的微控制器和嵌入式系统设计的开源嵌入式图形用户界面（GUI）库
- **Primary Language**: C
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 45
- **Forks**: 17
- **Created**: 2023-11-12
- **Last Updated**: 2025-11-03

## Categories & Tags

**Categories**: desktop-ui

**Tags**: None

## README

# **欢迎来到 HoneyGUI !**

[EN](README.md)   |  [中文](README_zh.md)

详细内容可参考 [HoneyGUI 在线文档](https://docs.realmcu.com/gui/cn/latest/index.html)。

## 示例
<table>
  <tr>
    <td align="center"><img src="https://foruda.gitee.com/images/1699931734086261442/f0690691_10641540.png"width = "200" height = "250"/><br><sub><b>动态表盘</b></sub>
    <td align="center"><img src="https://foruda.gitee.com/images/1723621216978994553/76b62adc_10737458.gif"width = "200" height = "250"/><br><sub><b>水果忍者</b></sub>
    <td align="center"><img src="https://docs.realmcu.com/HoneyGUI/image/sample/Calculator/calculator.gif"width = "200" height = "250"/><br><sub><b>计算器</b></sub>
  </tr>
  <tr>
    <td align="center"><img src="https://docs.realmcu.com/HoneyGUI/image/sample/watchface.gif" width = "200" height = "250"/><br><sub><b>表盘</b></sub>
    <td align="center"><img src="https://foruda.gitee.com/images/1734073855265837536/f8a3808e_13408154.gif"width = "200" height = "250"/><br><sub><b>计时器</b></sub>
    <td align="center"><img src="https://docs.realmcu.com/HoneyGUI/image/sample/musicPlayer.gif"width = "200" height = "250"/><br><sub><b>音乐播放器</b></sub>
  </tr>
  <tr>
    <td align="center"><img src="https://foruda.gitee.com/images/1725848489900237181/97911fc4_13408154.gif"width = "200" height = "250"/><br><sub><b>矢量图形</b></sub>
    <td align="center"><img src="https://foruda.gitee.com/images/1734070660330786955/61e4ff9d_13408154.gif"width = "200" height = "250"/><br><sub><b>3D蝴蝶</b></sub>
    <td align="center"><img src="https://docs.realmcu.com/HoneyGUI/image/widgets/soccer.gif"width = "200" height = "250"/><br><sub><b>2.5D足球</b></sub>
    
  </tr>
  
</table>


## 介绍

HoneyGUI 是由 Realtek 自主研发的图形显示框架，它是一款专为资源受限的微控制器和嵌入式系统设计的开源嵌入式图形用户界面（GUI）库。HoneyGUI 具备轻量级、功能丰富和高度可定制性的特点，广泛应用于消费电子、家电、医疗设备和智能手表等领域。

作为一套综合显示框架，HoneyGUI 不仅包含 Realtek 自主研发的显示引擎，还支持直接调用如 LVGL、ARM2D 等外部 API 进行应用程序的开发。此外，HoneyGUI 提供基于 PC 的仿真环境，使开发者能够快速进行应用开发和调试，而无需依赖嵌入式硬件平台。同时，HoneyGUI 还可以与 Realtek 自研的前端设计工具 `RVD` 配合使用，实现可视化编程。

以下是几种常见的 APP 开发方式：

- 基于 RealGUI 显示引擎，调用 C/C++ API 开发应用程序。
- 直接调用 [LVGL](https://lvgl.io/) 的 API 开发应用程序。
- 直接调用 [ARM-2D](https://github.com/ARM-software/Arm-2D) 的 API 开发应用程序。
- 前端开发方式，包含 JavaScript 和 XML。推荐使用 ```RVisualDesigner``` 作为 PC 设计器进行低代码开发。

GUI框架具有很强的可移植性，可以在多种芯片和 OS 上运行。此次提供了 PC Windows 版本。

## 软件架构


<div align=center><img width= "600" src ="https://foruda.gitee.com/images/1720700131929539160/ec0dbbb9_1860080.png"/></div><br/>


## 安装在Windows操作系统上

### 安装编译器
下载 MinGW-w64 工具链，解压到 C 盘，并将其添加到系统环境变量 ``Path`` 中。

1.  [Mingw64 下载](https://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win64/Personal%20Builds/mingw-builds/8.1.0/threads-posix/sjlj/x86_64-8.1.0-release-posix-sjlj-rt_v6-rev0.7z)
2.  解压并复制到目录：`C:/mingw64`
3.  添加一个环境变量：`C:/mingw64/bin`
    - 打开开始菜单，搜索 ``高级系统设置``。
    - 显示 ``系统属性``，然后转到 ``高级`` 选项卡。
    - 点击 ``环境变量`` 按钮。
    - 在 ``用户变量`` 部分，找到并选择 ``Path`` 变量，然后点击 ``编辑``。
    - 点击 ``新建`` 并添加 ``C:\mingw64\bin``。
    - 点击 ``确定`` 关闭所有对话框。


### 安装 Python

测试过 Python 3.9.7 版本。

### 安装scons
打开一个 CMD 窗口，并执行以下命令来安装 Python 的 scons 库：
```
> pip install scons==4.4.0
```

安装 `mingw-w64` 工具链和 `scons` 库后，可以通过两种方式启动应用程序：通过 CMD 启动或通过 GUI 启动。

### 通过CMD启动
在 `HoneyGUI` 或 `gui` 文件夹中打开一个 CMD 窗口，然后运行以下命令启动应用程序。


```shell
> cd win32_sim
> scons
> cd ..
> .\win32_sim\gui.exe
```
`scons` 命令执行构建过程，然后执行 `gui.exe` 来运行应用程序。


<div align=center><img width= "600"  src ="https://foruda.gitee.com/images/1718704649306452668/282ac763_13408154.png"/></div><br/>


### 通过VSCode启动

#### 安装VSCode
   - [```下载VSCode```](https://code.visualstudio.com/)
   - [```安装C/C++插件```](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools)

#### 打开项目
   - 单击 ```HoneyGUI.code-workspace``` 文件

#### 运行项目
进入 VSCode 界面后，可以选择 `Run and Debug` 选项，然后点击 `Run` 按钮。


<div align=center><img width="300" src ="https://foruda.gitee.com/images/1699582639386992543/b2078d27_13671125.png"/></div><br/>


## 显示
### 手表工程
窗口中显示出表盘，您可以通过滑动和点击与其进行交互。


<div style="text-align: center"><img width="400" src ="https://docs.realmcu.com/HoneyGUI/image/gui_watch.gif"/></div><br/>

### 仪表盘工程
窗口中显示仪表盘。


<div style="text-align: center"><img width="400" src ="https://foruda.gitee.com/images/1731649605724335535/042f1dcf_10088396.png"/></div><br/>