refactor: rename JackeryHome component directory and update references

- Renamed the `custom_components/jackery_home/` directory to `custom_components/JackeryHome/` for consistency with naming conventions.
- Updated all relevant documentation and scripts to reflect the new directory name.
- Removed obsolete files related to the previous directory structure.
This commit is contained in:
不求圣剑
2025-11-18 15:45:27 +08:00
parent 1adcbf3222
commit ad4105af5e
11 changed files with 12 additions and 12 deletions

View File

@@ -2,7 +2,7 @@
## Project Structure & Module Organization
- Energy simulator lives at `main.py`; MQTT examples under `data_transmission_example.py`.
- Home Assistant integration is in `custom_components/jackery_home/` with `__init__.py`, `sensor.py`, `config_flow.py`, translations, and docs.
- Home Assistant integration is in `custom_components/JackeryHome/` with `__init__.py`, `sensor.py`, `config_flow.py`, translations, and docs.
- Branding assets sit in `brands/`; release helpers and docs (e.g., `prepare_release.sh`, `README.md`, `energy_flow_card_config.yaml`) are at the repo root.
- Tests currently consist of targeted scripts such as `test_mqtt.py`; add new suites beside related modules.

View File

@@ -90,11 +90,11 @@ jackery_home/
```
3. **更新版本号**
编辑 `custom_components/jackery_home/manifest.json` 中的版本号
编辑 `custom_components/JackeryHome/manifest.json` 中的版本号
4. **提交版本更新**
```bash
git add custom_components/jackery_home/manifest.json
git add custom_components/JackeryHome/manifest.json
git commit -m "版本更新至 v1.0.0"
```

View File

@@ -18,7 +18,7 @@
本项目包含两个主要部分:
1. **MQTT 模拟器** (`main.py`) - 模拟发送能源监控数据到 MQTT broker
2. **Home Assistant 自定义集成** (`custom_components/jackery_home/`) - 接收 MQTT 数据并创建传感器实体
2. **Home Assistant 自定义集成** (`custom_components/JackeryHome/`) - 接收 MQTT 数据并创建传感器实体
## 传感器列表
@@ -57,7 +57,7 @@
### 方式二:手动安装
1. 下载最新的 [Release](https://github.com/suyulin/jackery_home/releases)
2.`custom_components/jackery_home` 文件夹复制到你的 Home Assistant 配置目录的 `custom_components/` 文件夹中
2.`custom_components/JackeryHome` 文件夹复制到你的 Home Assistant 配置目录的 `custom_components/` 文件夹中
3. 重启 Home Assistant
4. 按照上述"配置集成"步骤进行配置
@@ -161,7 +161,7 @@ entities:
### 核心文件
- `main.py`: MQTT 传感器模拟器主程序
- `custom_components/jackery_home/`: Home Assistant 自定义集成
- `custom_components/JackeryHome/`: Home Assistant 自定义集成
- `__init__.py`: 集成入口
- `manifest.json`: 集成元数据
- `sensor.py`: 传感器平台实现
@@ -199,7 +199,7 @@ entities:
## 文档
- [**HACS 发布指南**](HACS_PUBLISHING_GUIDE.md) - 如何发布到 HACS
- [自定义集成 README](custom_components/jackery_home/README.md) - 集成技术文档
- [自定义集成 README](custom_components/JackeryHome/README.md) - 集成技术文档
## 开发者
@@ -213,7 +213,7 @@ entities:
或手动发布:
1. 更新 `custom_components/jackery_home/manifest.json` 中的版本号
1. 更新 `custom_components/JackeryHome/manifest.json` 中的版本号
2. 提交更改并推送到 GitHub
3. 创建新的 Git tag如 `v1.0.1`
4. 在 GitHub 创建 Release

View File

@@ -35,7 +35,7 @@ if ! git diff-index --quiet HEAD --; then
fi
# 获取当前版本
CURRENT_VERSION=$(grep -o '"version": "[^"]*"' custom_components/jackery_home/manifest.json | cut -d'"' -f4)
CURRENT_VERSION=$(grep -o '"version": "[^"]*"' custom_components/JackeryHome/manifest.json | cut -d'"' -f4)
echo "📦 当前版本: $CURRENT_VERSION"
echo ""
@@ -50,9 +50,9 @@ fi
# 更新 manifest.json 中的版本号
if [ "$NEW_VERSION" != "$CURRENT_VERSION" ]; then
echo "📝 更新 manifest.json 中的版本号..."
sed -i.bak "s/\"version\": \"$CURRENT_VERSION\"/\"version\": \"$NEW_VERSION\"/" custom_components/jackery_home/manifest.json
rm custom_components/jackery_home/manifest.json.bak
git add custom_components/jackery_home/manifest.json
sed -i.bak "s/\"version\": \"$CURRENT_VERSION\"/\"version\": \"$NEW_VERSION\"/" custom_components/JackeryHome/manifest.json
rm custom_components/JackeryHome/manifest.json.bak
git add custom_components/JackeryHome/manifest.json
git commit -m "版本更新至 v$NEW_VERSION"
echo "✅ 版本号已更新"
fi