# keil_tools

**Repository Path**: NOP404_admin/keil_tools

## Basic Information

- **Project Name**: keil_tools
- **Description**: 使用rust编写的keil工具：
1、升级固件格式化
2、keil编译信息打印
3、升级固件打包拼接
- **Primary Language**: Rust
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2024-01-30
- **Last Updated**: 2024-01-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# keil-build-tools v1.0

## [English](./README_EN.md)

![演示界面](images/main.png)

## 1 介绍
这是一个 keil 的编译信息展示增强工具，支持芯片存储器的可视化展示，轻量且无任何依赖。具备以下功能：
1.  解析参与编译的每个文件对 RAM 和 flash 的占用情况
    - 自动忽略不被包含进编译的文件
    - 自动检索被 keil 改名的文件
    - **支持双击打开文件**
    - 支持关闭该信息的展示
    - 支持仅显示文件名

2.  分析芯片的 RAM 和 flash 的使用情况，使用进度条可视化展示
    - `X` 表示实际占用的区域
    -  `O`  表示 zero initialize 的区域
    - `_` 表示未被使用的区域

3.  二次编译后新增与减少的数据量展示
    - 通过对比上次的编译结果，**显示本次编译新增或减少的数据量大小，单位是 byte**
    - 若是新增的文件，则会显示 `[NEW]`

4.  自动搜索本级目录的 keil 工程，因此可无参调用
    - 默认选择搜索到的最后一个 keil 工程
    - 支持输入绝对路径指定 keil 工程
    - 支持仅输入文件名指定 keil 工程（必须是同级目录，可不带文件扩展名）
    - **若路径或工程名有空格，则使用 `""` 括起来**

5.  支持输入参数修改选项
    - 如第 4 功能所描述的，指定 keil 工程
    - `-bin`     根据axf文件生成bin文件，生成的bin文件默认存放在工程目录下的bin文件中（默认）
    - `-p  <boot_info_path>`   指定升级固件配置文件地址，未指定默认会在bin目录下生成
    - `-boot`    根据 boot_info_path 配置文件生成自定义升级固件 .mcu文件
    - `-nopath`  仅显示每个文件的文件名

    - `*********后续增加功能**********`
    - `-iap_app_hex`  把bootloade的bin文件（默认路径: ./bin/iap_boot.bin）和 当前工程的bin文件进行合并后生成 hex文件。
    - `-iap_app_bin`  把iap_app_hex 生成的hex转换成bin文件 
    - **以上命令区分大小写**


> **说明：** 本工具的所有参数可不按顺序输入，为空时表示选择默认值，但参数与参数之间需用**空格**隔开

> **双击打开对应文件动画演示**
![双击打开文件](images/open_file.gif)

## 2 在 keil 中使用
1.  在 keil 中调用方式很简单， 把keil-build-info.exe 文件所在的目录加入到系统环境变量中，则可填写：<br>
    ```
    keil-build-info.exe -bin
    ```

2.  在 cmd 或 powershell 中使用同理，仅需添加前缀 `.\` 即可。如：<br>
    ```
    keil-build-info.exe
    ```
![keil配置](images/user_command.png)


## 3 我想自己编译这个工具
**本代码仅支持 windows 系统**


## 4 问题解答
1.  出现 `[ERROR] NO keil project found` 之类的提示
    > 确认 `keil-build-info.exe` 放在了你需要查看的 keil uvproj(x) 工程同级目录

2.  出现 `[ERROR] listing path is empty` 之类的提示
    > 在 keil 中选择你要放置的 listing 相关文件的文件夹
    ![选择listing文件夹](images/select_listing_folder.png)

3.  出现 `[ERROR] generate map file is not checked` 或 `[ERROR] Check if a map file exists` 之类的提示
    > 确认 keil 已经勾选了下图这些选项
    ![创建map](images/create_map.png)



## 重要说明
> **1. 目前仅支持 keil MDK。**
>
> **2. 不支持解析通过 RTE 添加的文件**


## 修改记录
| 版本  |     日期    |修改者        |修改内容                                            |
|:-----:|:----------:|--------------|---------------------------------------------------|
| v1.0  | 2023-11-10 | xiaozh         | 初版发布                                           | 


## 参与贡献
1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request