Menú
Документация и переводы интеграции Voyah — обновление README.md (двуязычный: русский + английский), strings.json и translations/en.json, ru.json. Использовать при добавлении сущностей, изменении config flow или возможностей интеграции.
Instalar con Codex o Claude Copia este prompt, pégalo en Codex, Claude u otro asistente, y deja que revise la página de la skill y la instale por ti.
Basado en la clasificación ocupacional SOC
| name | ha-docs |
| description | Документация и переводы интеграции Voyah — обновление README.md (двуязычный: русский + английский), strings.json и translations/en.json, ru.json. Использовать при добавлении сущностей, изменении config flow или возможностей интеграции. |
| Файл | Роль |
|---|---|
custom_components/voyah/strings.json | источник истины (английский) |
custom_components/voyah/translations/en.json | точная копия strings.json |
custom_components/voyah/translations/ru.json | русский перевод той же структуры |
Любое изменение строк UI вносится во все три файла. Структура:
{
"config": {
"step": { "<step_id>": { "title", "description", "data", "data_description" } },
"error": { "<ключ>": "..." }, // ключи из errors["base"] в config_flow.py
"abort": { "<ключ>": "..." }
},
"entity": {
"sensor": { "<translation_key>": { "name": "..." } },
"binary_sensor": { "<translation_key>": { "name": "..." } },
"button": { "<translation_key>": { "name": "..." } },
"device_tracker":{ "<translation_key>": { "name": "..." } }
}
}
Проверка после правок: python -m json.tool <файл> на каждом из трёх файлов —
тесты битый JSON не поймают (сущности в них конструируются напрямую,
переводы не загружаются).
Структура: русская версия сверху, затем якорь <a id="english"></a> со
следующим за ним заголовком # English и полная английская копия.
Каждое содержательное изменение вносится в обе секции.
Что где документируется:
Скриншоты и графики лежат в docs/ (например docs/ha-screenshot.png).
бэктиках.Правила уровней Bronze/Silver/Gold, на которые целимся (подробнее):
docs-high-level-description — вводный абзац: что это и какой сервис подключает ✅docs-installation-instructions — пошаговая установка (HACS + ручная) ✅docs-configuration-parameters — описать все параметры (интервал опроса и т.д.)docs-supported-functions — таблицы сущностей ✅docs-data-update — как и как часто обновляются данные (опрос, интервалы, 12 ч для SOH)docs-known-limitations — ограничения (зависимость от облака Voyah Assist, нет push)docs-troubleshooting — типовые проблемы: истёкшие токены → reauth, нет машин в аккаунтеdocs-examples — примеры автоматизаций (уведомление о заряде, открытые двери)При добавлении новых разделов README сверяйся с этим списком — он же чек-лист для повышения уровня качества интеграции.
Написание и изменение кода интеграции Voyah для Home Assistant — добавление сенсоров, бинарных сенсоров, кнопок, платформ, работа с API-клиентом, координаторами и config flow. Использовать при любых изменениях в custom_components/voyah/.
Написание и запуск тестов интеграции Voyah — юнит-тесты сущностей, координаторов, API-клиента и config flow на pytest-homeassistant-custom-component. Использовать при добавлении/изменении тестов в tests/ или когда новый код требует покрытия.