Skip to content
Open
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
2 changes: 1 addition & 1 deletion .cursor/mcp.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"mcpServers": {
"esp-pilot": {
"type": "http",
"url": "https://mcp.esp-pilot.espressif.tools/mcp"
"url": "https://mcp.esp-pilot.espressif.com/mcp"
}
}
}
22 changes: 18 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,24 @@ jobs:
target: ${{ matrix.target }}
path: ci/test_app
command: |
pip install -q esp-bmgr-assist
if [ -n "${{ matrix.component_manager }}" ]; then
python -m pip install -q --upgrade "${{ matrix.component_manager }}"
fi
python -m pip install -q --upgrade esp-bmgr-assist
python -m pip show esp-bmgr-assist esp-bmgr-py idf-component-manager || true
python ../scripts/pin_bmgr_version.py "${{ matrix.bmgr }}"
idf.py bmgr -b "${{ matrix.board }}"
idf.py build
idf.py bmgr -l
if python ../scripts/check_bmgr_catalog.py --chip "${{ matrix.target }}"; then
idf.py bmgr -b "${{ matrix.board }}"
idf.py build
else
status=$?
if [ "${status}" -eq 10 ]; then
echo "::notice title=Unsupported board/IDF combination::${{ matrix.board }} (${{ matrix.target }}) is not supported by Board Manager ${{ matrix.bmgr }} with this ESP-IDF version."
exit 0
fi
exit "${status}"
fi

upload:
needs: test
Expand All @@ -55,7 +69,7 @@ jobs:
fi
python3 -m pip install -q idf-component-manager
compote component upload \
--namespace "${{ github.repository_owner }}" \
--namespace "LiuCodee" \
--name "${{ github.event.repository.name }}" \
--allow-existing \
--dry-run
9 changes: 9 additions & 0 deletions 1/2/example_board2/board_devices.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
devices:
- name: power_control
type: gpio_ctrl
version: default
config:
active_level: 1
default_level: 0
peripherals:
- gpio_name: gpio_power
5 changes: 5 additions & 0 deletions 1/2/example_board2/board_info.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
board: example_board2
chip: esp32s31
version: "1.0.0"
description: "Placeholder board. Replace this directory with a real board."
manufacturer: "CHANGE_ME"
8 changes: 8 additions & 0 deletions 1/2/example_board2/board_peripherals.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
peripherals:
- name: gpio_power
type: gpio
role: io
config:
pin: 4
mode: GPIO_MODE_OUTPUT
default_level: 0
9 changes: 9 additions & 0 deletions 1/example_board1/board_devices.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
devices:
- name: power_control
type: gpio_ctrl
version: default
config:
active_level: 1
default_level: 0
peripherals:
- gpio_name: gpio_power
5 changes: 5 additions & 0 deletions 1/example_board1/board_info.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
board: example_board1
chip: esp32
version: "1.0.0"
description: "Placeholder board. Replace this directory with a real board."
manufacturer: "CHANGE_ME"
8 changes: 8 additions & 0 deletions 1/example_board1/board_peripherals.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
peripherals:
- name: gpio_power
type: gpio
role: io
config:
pin: 4
mode: GPIO_MODE_OUTPUT
default_level: 0
90 changes: 0 additions & 90 deletions GETTING_STARTED.md

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2026 CHANGE_ME
Copyright 2026 My_boards

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
63 changes: 39 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,54 @@
# ESP Board Manager 厂家板组件模板
# My_boards ESP Board Manager Board Pack

[中文](README_CN.md)

This repository is an ESP Board Manager **board pack**: YAML board definitions that applications can download from the [ESP Component Registry](https://components.espressif.com).
This component provides ESP Board Manager YAML definitions for My_boards
development boards. Applications can install it from the
[ESP Component Registry](https://components.espressif.com) and select a board.

## Use in an application
> Template note: Replace `My_boards` and update the following table with
> the supported boards before publishing.

1. Install the helper once in your ESP-IDF Python environment:
## Supported Boards

```bash
pip install esp-bmgr-assist
```
Run `python scripts/update_supported_boards_table.py` to update the board and
chip columns. Maintainers fill in the device capability columns.

2. Add this board pack to the project (replace the namespace and name with your GitHub user name and this repository name):
<!-- BEGIN SUPPORTED_BOARDS -->
| Board | Chip | Audio | SD Card | LCD | LCD Touch | Camera | Buttons | LED Strip | Knob |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| `example_board` | ESP32-S3 | | | | | | | | |
| `example_board2` | ESP32-S31 | | | | | | | | |
| `example_board1` | ESP32 | | | | | | | | |
<!-- END SUPPORTED_BOARDS -->

```bash
idf.py add-dependency "YOUR_GITHUB_USERNAME/YOUR_REPO_NAME"
```
## Use This Pack in an Application

The pack already depends on `espressif/esp_board_manager` (`>=0.7.0`). You do not need to add Board Manager again unless you want a tighter pin.
Install the helper once in the active ESP-IDF Python environment:

3. List and select a board:
```bash
python -m pip install --upgrade esp-bmgr-assist
```

```bash
idf.py bmgr -l
idf.py bmgr -b <board_name>
idf.py build
```
Add the released component, then select a board:

## Supported boards
```bash
idf.py add-dependency "LiuCodee/demo_boards"
idf.py bmgr -l
idf.py bmgr -b <board_name>
idf.py build
```

| Board | Chip | Notes |
|---|---|---|
| `example_board` | ESP32-S3 | Placeholder. Replace it with a real board before publishing. |
The board pack already declares `espressif/esp_board_manager`; applications do
not need to add it again unless they need a tighter version constraint.

## Create or publish this pack
## Vendor Maintenance Guide

Vendors starting from this GitHub template should follow [GETTING_STARTED.md](GETTING_STARTED.md).
For creating a repository from this template, migrating an existing BSP,
configuring CI, and publishing the component, see
[VENDOR_GUIDE.md](VENDOR_GUIDE.md).

## License

This component uses Apache-2.0. Preserve and comply with existing copyright
notices and licenses when migrating a BSP or adding third-party content.
55 changes: 31 additions & 24 deletions README_CN.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,46 @@
# ESP Board Manager 厂家板组件模板
# My_boards ESP Board Manager 板组件

[English](README.md)

本仓库是一份 ESP Board Manager **板组件**:用 YAML 描述开发板,应用可以从 [ESP 组件注册库](https://components.espressif.com) 下载后选板。
本组件提供 My_boards 开发板的 ESP Board Manager YAML 定义,可从 [ESP 组件注册库](https://components.espressif.com) 下载并在应用工程中选择。

## 在应用工程中使用
> 模板提示:发布前替换 `My_boards`,并将下表更新为实际支持的开发板。

1. 在已激活的 ESP-IDF Python 环境中安装一次辅助工具:
## 支持的开发板

```bash
pip install esp-bmgr-assist
```
运行 `python scripts/update_supported_boards_table.py` 可更新板名和芯片列;设备能力列由维护者填写。

2. 将本板组件加入工程(把命名空间和组件名换成您的 GitHub 用户名和本仓库名):
<!-- BEGIN SUPPORTED_BOARDS -->
| 开发板名称 | 芯片 | 音频 | SD 卡 | LCD | LCD 触摸 | 摄像头 | 按键 | LED 灯带 | 旋钮 |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| `example_board` | ESP32-S3 | | | | | | | | |
| `example_board2` | ESP32-S31 | | | | | | | | |
| `example_board1` | ESP32 | | | | | | | | |
<!-- END SUPPORTED_BOARDS -->

```bash
idf.py add-dependency "YOUR_GITHUB_USERNAME/YOUR_REPO_NAME"
```
## 在应用工程中使用本组件

本组件已经依赖 `espressif/esp_board_manager`(`>=0.7.0`)。除非您要收紧版本,否则不必再单独添加 Board Manager。
在已激活的 ESP-IDF Python 环境中安装一次辅助工具:

3. 列出并选择开发板:
```bash
python -m pip install --upgrade esp-bmgr-assist
```

```bash
idf.py bmgr -l
idf.py bmgr -b <board_name>
idf.py build
```
添加已发布的组件后,选择开发板:

## 支持的开发板
```bash
idf.py add-dependency "LiuCodee/demo_boards"
idf.py bmgr -l
idf.py bmgr -b <board_name>
idf.py build
```

本板组件已声明 `espressif/esp_board_manager` 依赖。除非应用需要更严格的版本限制,否则不必再次添加。

## 厂家维护指南

| 开发板 | 芯片 | 说明 |
|---|---|---|
| `example_board` | ESP32-S3 | 占位示例。正式发布前请替换为真实开发板。 |
从本模板创建仓库、迁移现有 BSP、配置 CI 和发布组件,请参见 [VENDOR_GUIDE_CN.md](VENDOR_GUIDE_CN.md)。

## 创建或发布本组件
## 许可证

从本 GitHub 模板新建仓库的厂家,请按 [GETTING_STARTED.md](GETTING_STARTED.md) 操作。
本组件采用 Apache-2.0。迁移 BSP 或引入第三方内容时,请保留并遵守其原有版权声明和许可证。
Loading
Loading