Esphome esp8266: NodeMCU ESP8266 — ESPHome
|Содержание
Использование ESPHome в связке с Home Assistant
ESPHome. Вникаем. Пользуемся.
Часть I. Вводная.
Небольшое вступление
Полная и достаточно внятная поддержка ESPHome в Home Assistant пришла к нам с обновлением 0.85.
Что же такое ESPHome?
Если коротко, то это инструмент, который позволяет интегрировать в Home Assistant устройства, созданные на базе ESP8266 / ESP32.
Конечно, есть масса других проектов для подобных задач, таких как Tasmota, ESPEasy, WifiIot, ESPUrna, но основное их отличие от ESPHome заключается в том, что все они, для интеграции с любыми системами, используют MQTT, а вот ESPHome разрабатывался специально для Home Assistant и для интеграции используется Native API.
Я ни в коем случае не призываю отказываться от MQTT, но в связке ESPHome Home Assistant он просто не нужен.
Так же, нужно добавить, что еще одним преимуществом является то, что здесь мы имеем для всех задач, в том числе и создании внутренних автоматизаций, всего лишь один конфиг-файл, который использует YAML.
P.S. И в завершение краткого описания хочу сказать, если честно, проникся я этой системой, зацепила она меня. Вот уж действительно, в ней всё по-настоящему «Easy».
P.P.S. Статья будет большая, дабы не упустить важные моменты и показать максимум возможностей на старте.
Итак, в данной статье мы рассмотрим следующее:
- Установка ESPHome
- Создание файла конфигурации
- Прошивка платы
- Запуск
- Добавление датчиков
Приступим.
1. Установка ESPHome
Что использовал я?
У меня после переезда Home Assistant на Raspberry 3B остался не у дел Orange Pi LIte с 512 Мб и установленной DietPi на борту.
На этой плате и будем работать с ESPHome.
Следует заметить, что ESPHome может быть установлена на одном устройстве с Home Assistant. Но в моем случае обе системы находятся на разных устройствах.
Так же есть возможность работы системы в случае использования Hass. io .
Для работы системы понадобится предустановленный Python 2.7 ибо система использует platformio.
Итак, установка:
pip install esphome
Надеюсь во время установки ошибок не возникло. Переходим к следующему этапу.
2. Создание файла конфигурации
В ESPHome есть 2 варианта создания основного файла конфигурации:
Создание файла в консолиСоздание файла в Dashboard
Я расскажу про оба эти варианта.
Вариант первый. Создаем файл в консоли командой:
esphome test.yaml wizard
Где, test.yaml, это имя файла вашего проекта
Далее отвечаем на вопросы дружественного мастера установки:
Придумываем и указываем имя нашего проекта.Например, Test. Пишем с маленькой буквы.
Теперь нужно выбрать и ввести тип нашей платформы. Я буду использовать ESP-01 с объемом памяти 1 Мб, по этому выбираю ESP8266.
Далее выбираем тип платы. У меня esp01_1m.
Теперь вводим имя нашей точки доступа, к которой будет подключаться наша плата. Обратите внимание: и плата которую мы конфигурируем и сервер на котором сейчас создаем файл конфигурации должны находиться в одной сети.
Вводим пароль для указанной выше точки доступа.
Вводим пароль для последующего обновления прошивки по воздуху.
Итак, мы создали файл основной конфигурации.Теперь нужно его залить в плату.Сделаем это.
3. ПРОШИВКА ПЛАТЫ
Перед прошивкой подключаем TTL-конвертер к серверу, а плату к конвертеру.
Не забываем перевести плату в режим прошивки — замыкаем GPIO-0 на землю и подаем питание.
Прошивка устройства осуществляется командой:
esphome test.yaml run
После запуска скачиваются недостающие библиотеки и компилируется проект. Это займет какое-то время.
Потом система пытается залить скомпилированный файл в нашу плату.
Далее нам нужно выбрать, через что мы будем шить нашу плату: через TTL-конвертер или через ОТА.Первая прошивка должна заливаться только через TTL-конвертер.
Вот так выглядит заливка конфигурационного файла.
Далее, перезагружаем плату и по идее мы должны увидеть лог старта нашей платы.
На этом месте я прервусь, дабы перейти ко второму варианту создания конфигурационного файла.
Вариант второй. Создаем файл в Dashboard.
Для работы в Dashboard нам сначала нужно ее установить.
Сделаем это командой:
pip2 install tornado esptool
И запустим командой:
esphome config/ dashboard
После этого в браузере перейдем по адресу:
localhost:6052
Где, «localhost», это адрес сервера, на котором мы работаем с ESPHome
В браузере нас встречает вот такая форма:
Нажимаем на » » что бы создать конфиг-файл.
Вводим имя проекта
Выбираем тип нашей платы
Вводим логин и пароль WiFi
В завершение видим сообщение, что у нас всё хорошо и мы готовы к прошивке устройства.
В выпадающем списке справа выбираем, через что будем шиться. Для первого раза выбираем TTL-конвертер
Итак, мы готовы шиться.
Но перед этим пару слов о кнопочках проекта:
UPLOAD — запускает процесс прошивки по выбранному интерфейсуEDIT — позволяет редактировать конфиг-файлSHOW LOGS — показывает лог работающего устройстваVALIDATE — проверяет на ошибки конфиг-файл после изменения.
Переводим плату в режим прошивки — замыкаем GPIO-0 на землю и подаем питание.
Жмем VALIDATE и если ошибок нет, жмем UPLOAD.
Все, что происходит далее, ничем не отличается от прошивки через консоль.
4. Запуск
После прошивки видим, что наш проект онлайн — это значит, что дальше мы можем прошивать устройство по ОТА.
Можем нажать SHOW LOGS и посмотреть, что там пишет наше устройство
После успешного старта проекта, пусть даже с пустой конфигурацией предлагаю заглянуть в Home Assistant.
Заходим в Настройки/Интеграции/Создать новую интеграцию и напротив строки ESPHome нажимаем НАСТРОИТЬ.
Вводим адрес платы. Можно посмотреть в логе
Вводим пароль, который мы указывали при создании конфиг-файла
Видим пока что, вот такую картину. А чего мы хотели, мы же еще не добавили ни одного датчика…
5. Добавление датчиков
Теперь откроем конфиг-файл и добавим веб-сервер и какие-нибудь внутренние датчики.
В Dashboard нажмем на EDIT.
Добавляем веб-сервер:
web_server: port: 80
Добавляем датчик, который будет нам показывать статус подключения нашего устройства к сети
binary_sensor: — platform: status name: «Test»
Добавляем датчик, который будет нам показывать время работы устройства в сети.
sensor: — platform: uptime name: Test Uptime Sensor
Целиком конфиг-файл выглядит следующим образом:
esphome: name: test platform: ESP8266 board: esp01_1m wifi: ssid: ‘**********’ password: ‘********’ # Enable logging logger: # Enable Home Assistant API api: password: ‘*******’ ota: password: ‘*******’ web_server: port: 80 binary_sensor: — platform: status name: «Test» sensor: — platform: uptime name: Test Uptime Sensor
Сохраняем и нажимаем VALIDATE
Если ошибок нет, жмем UPLOAD для загрузки проекта в устройство.
После загрузки, система пытается подключиться к устройству и если подключение есть, то сразу же выводится в лог всевозможная информация, в том числе и статус подключения к Home Assistant.
Проверим, что там у нас в Home Assistant.
Ага. Отлично.
Теперь посмотрим на веб-сервер.
Для этого в браузере перейдем по адресу, который получило наше устройство.
Ну, неплохо же!
Теперь можно добавлять в конфиг-файл различные сенсоры, бинарные сенсоры, Light-компоненты, свитчи, автоматизации и прочие фишечки…
Вот собственно и всё, что я хотел рассказать в первой части. Этого пожалуй достаточно для старта.
Во второй части я планирую рассказать уже о более конкретной задаче, которую я хочу реализовать на устройстве Sonoff Basic.
Ну и в завершение.
Хочу добавить.
Если вдруг вы хотите перейти с уже существующего устройства в котором залита Tasmota
или ESPEasy или ESPurna, то создаете конфиг-файл, как описано выше, только не жмете UPLOAD, а нажимаете на три точки, справа от имени проекта. Затем на кнопку COMPILE.
После того, как скомпилируется ваш конфиг-файл вы можете скачать его и подсунуть для обновления прошивки вашего устройства в настройках той системы, которая сейчас установлена.
Ну и в завершение 2.
Если у вас возникли проблемы еще на первом этапе заливки основного конфиг-файла в устройство и проблемы эти связаны с Linux-системами, то можно скомпилировать файл и залить его из Windows программой esphomeflasher
В программе выбираете com-порт, к которому подключен TTL-конвертер, выбираете скомпилированный файл и жмете кнопку FLASH ESP
После удачной прошивки, устройство видится в Dashboard и с ним можно уже работать по ОТА.
Ну и в завершение 3. Бонус
Для автоматического запуска Dashboard, можно создать сервис в SystemD, например:
[Unit] Description=Dashboard After=network-online.target [Service] Type=simple User=%i ExecStart=/root/config esphome dashboard [Install] WantedBy=multi-user.target
Или добавить строку в rc.local
/usr/local/bin/esphome /root/config/ dashboard
Важный момент — обращайте внимание на пути, указанные в коде. Вы должны указать свои пути расположения ESPHome.
Вот теперь точно — всё!
Всем спасибо, кто осилил текст и дочитал до конца!
P.S. Статья обновлена 8.04.19 по причине критичных изменений в самом проекте ESPHome.
Изменения коснулись смены имени проекта. Раньше было ESPHomeLib, а теперь просто ESPHome.
Соответственно изменились основные команды и пути расположения файлов.
ESPhome — kvvhost
Перейти к контенту
ESPHome покорила меня, и остальных ее поклонников, своей простотой и лёгкостью в освоении ещё за долго до появления в ней api для Home Assistant. Теперь же это топовая прошивка №1 для esp8266. Всячески ее рекомендую.
Posted on DIY ESP8266 ESPhome Home Assistant Блог
Пришло время подключить NodeMCU на базе esp8266 к моему Electrolux EACS/I-07HAT/N3.
Posted on ESP8266 ESPhome Home Assistant Блог
Процесс перепрошивки и конфиг для ESPHome.
Posted on ESP8266 ESPhome Home Assistant Блог Датчики
Подключение датчика жестов APDS9960 к esp8266 или esp32 с прошивкой ESPHome и интеграция в Home Assistant.
Posted on ESP8266 ESPhome Home Assistant Блог Датчики
Подключение датчика освещенности TSL2561 к esp8266 или esp32 с прошивкой ESPHome.
Posted on ESPhome Home Assistant Блог Обзор
Обзор автоматической кормушки для животных Petoneer Nutri Smart Pet Feeder, а так же перепрошивка ESPHome и интеграция в Home Assistant.
Posted on ESP8266 ESPhome Home Assistant Блог Обзор
Попали мне в руки два модуля с esp8266, поделюсь конфигами для ESPHome
Posted on ESP8266 ESPhome Home Assistant Блог Обзор
Как обычно — прошьем ESPHome для управления из Home Assistant.
Posted on ESP8266 ESPhome Home Assistant Блог Обзор
Очень интересный вариант удлинителя — с esp8266, возможностью контролировать каждую розетку и usb порты зарядки. Прошьем ESPHome и подключим к Home Assistant
Posted on ESP8266 ESPhome Home Assistant Блог Обзор
Разберем и перепрошьем ESPHome, подключим к Home Assistant
Posted on ESP8266 ESPhome Home Assistant Блог Датчики
Схема подключения BME280 к ESP8266 или ESP32
Платформа
ESP8266 — ESPHome
Этот компонент содержит специфичные для платформы параметры для платформы ESP8266.
# Пример записи конфигурации esp8266: доска: nodemcuv2 рамки: версия: рекомендуется
Переменные конфигурации:
board ( Required , string): идентификатор платы PlatformIO, который должен
использоваться. Выберите подходящую доску из
этот список (значок рядом с
имя можно использовать для копирования идентификатора платы). Это влияет только на псевдонимы контактов, размер флэш-памяти и некоторые внутренние настройки , если вы не уверены
выберите универсальную плату от Espressif, напримерesp01_1m
.framework ( Необязательный ): параметры базовой платформы, используемой ESPHome.
версия ( Необязательный , строка): Номер версии базовой платформы, начиная с
релизы Arduino esp8266. По умолчаниюрекомендуется
. Дополнительные значенияdev
: Используйте последнюю фиксацию с https://github.com/esp8266/Arduino, обратите внимание, что это может сломаться в любое времяпоследний
: Используйте последнюю версию с https://github.com/esp8266/Arduino/releases, даже если она еще не рекомендована.рекомендуется
: Используйте рекомендуемую версию платформы.
источник ( Необязательный , строка): пакет или репозиторий PlatformIO, который будет использоваться для платформы. Это можно использовать для использования пользовательской или исправленной версии фреймворка.
platform_version ( Необязательный , строка): Используемая версия пакета platformio/espressif8266.
restore_from_flash ( Необязательный , логическое значение): следует ли сохранять некоторые постоянные настройки во флэш-памяти. По умолчанию
false
.board_flash_mode ( Опционально , строка): режим SPI микросхемы флэш-памяти. Один из
QIO
,qout
,dio
иdout
. По умолчаниюили
для совместимости со всеми чипами. Примечание: при следующем обновлении OTA фактический режим прошивки автоматически определяется и изменяется на соответствующий.Early_pin_init ( Необязательный , логическое значение): указывает, следует ли как можно раньше инициализировать выводы известными значениями. Рекомендуемое значение —
false
, если задействованы переключатели, поскольку они будут переключаться при обновлении прошивки или при перезапуске устройства. По умолчаниюверно
.
Нумерация контактов GPIO
Многие платы имеют нумерацию открытых контактов, которая отличается от внутренней.
те. ESPHome пытается сопоставить номера контактов шелкографии с внутренними номерами контактов с помощью нескольких
платы, но для общих плат ESP8266 часто требуется просто использовать внутренние номера контактов.
Для этого просто добавьте ко всем контактам префикс GPIO
, например GPIO0
для контакта с внутренним контактом.
число 0.
Некоторые примечания по контактам:
часто уже используются внутренними
флэш-интерфейс и определение режима загрузки. Так что лучше не использовать эти булавки.
GPIO17
дополнительно подключен АЦП. См. аналого-цифровой датчик
считывать напряжения (в диапазоне от 0 до 1,0 В) на этом выводе.
# Пример записи конфигурации эсфома: название: гостиная esp8266: доска: nodemcuv2 бинарный_сенсор: - платформа: gpio имя: "Контакт GPIO17" вывод: GPIO17
Специальные штифты
| Управление режимом загрузки |
| Контакт UART TX |
| Управление режимом загрузки |
| Контакт UART RX |
| Разъем SDIO/Flash CLK |
| SDIO/Flash Data 0 контакт |
| SDIO/Flash Data 1 контакт |
| SDIO/Flash Data 2 контакта (только qio/qout) |
| SDIO/Flash Data 3-контактный (только qio/qout) |
| Разъем SDIO/Flash CMD |
| Подключен к аппаратному контроллеру SPI MISO |
| Подключен к аппаратному контроллеру SPI MOSI |
| Подключен к аппаратному контроллеру SPI CLK |
| Управляет режимом загрузки; Подключен к аппаратному SPI |
| Специальный контакт, доступный из RTC, 9 для пробуждения в глубоком сне. 0164 |
TOUT, также известный как | Вывод АЦП для измерения напряжения, может быть только |
Это означает, что в качестве GPIO общего назначения можно эффективно использовать только следующие контакты:
Штифт | Ограничения | Состояние после сброса |
| Если высокий уровень при загрузке | Слабое подтягивание |
| Если высокий уровень при загрузке | Слабое подтягивание |
| Высокий импеданс | |
| Высокий импеданс | |
| Слабое подтягивание | |
| Слабое подтягивание | |
| Слабое подтягивание | |
| Слабое подтягивание | |
| Если низкий уровень при загрузке | Слабое подтягивание |
| Имеет опускающийся (но не подтягивающий) | Слабая тяга вниз |
Режимы загрузки
При каждой загрузке ESP8266 будет проверять три контакта, чтобы определить, в какой режим загрузки следует войти.
Есть три режима загрузки:
Режим | | | | |
Загрузка с флэш-памяти (обычная) | ВЫСОКИЙ | ВЫСОКИЙ | НИЗКИЙ | 3 |
Код загрузки с UART | НИЗКИЙ | ВЫСОКИЙ | НИЗКИЙ | 1 |
Загрузка с SD-карты | ЛЮБОЙ | ЛЮБОЙ | ВЫСОКИЙ | 4-7 |
Вы можете определить их при загрузке, посмотрев на вывод UART, первый номер
в режиме загрузки : строка
сообщает какой режим был выбран
ets 8 января 2013, первая причина: 4, режим загрузки: (3,6)
Первые строки при просмотре журналов UART могут содержать нераспознанные символы. Это
потому что эффективная скорость загрузчика ESP8266 составляет 74800, тогда как программа использует 115200.
Причины сброса
Кроме того, первая строка также содержит причину сброса .
Эти причины сброса задокументированы:
0 | Не определено |
1 | Перезагрузка при включении |
2 | Внешний сброс или пробуждение из глубокого сна |
4 | Аппаратный сброс WDT |
После программного сброса причина сброса не изменится.
Электрические характеристики
Параметр | Мин. | Типовой | Макс. | Блок |
Рабочая температура | -40 | 125 | °С | |
Рабочее напряжение | 2,5 | 3,3 | 3,6 | В |
| -0,3 | 0,25*V_IO | В | |
| 0,75*V_IO | 3,6 | В | |
| 0,1*V_IO | В | ||
| 0,8*V_IO | В | ||
| 12 | мА | ||
Энергопотребление в режиме глубокого сна | 20 | мкА | ||
Энергопотребление в активном режиме | 120 | мА |
Источник: спецификация ESP8266EX
Внутренние подтягивающие вверх/вниз резисторы имеют значения от 30 кОм до 100 кОм.
(источник).
См. также
Основная конфигурация ESPHome
Редактировать эту страницу на GitHub
типов конфигурации — ESPHome
Файлы конфигурации ESPHome имеют несколько типов конфигурации. Этот
страница описывает их.
ID
Весьма важным аспектом ESPHome являются «ID». Они привыкли
соединять компоненты из разных доменов. Например, вы определяете
выходной компонент вместе с идентификатором, а затем указать тот же идентификатор
в легкой составляющей. Идентификаторы всегда должны быть уникальными в
конфигурации и ESPHome предупредит вас, если вы попытаетесь использовать тот же
удостоверение личности дважды.
Поскольку ESPHome преобразует вашу конфигурацию в код C++, а
Идентификаторы на самом деле являются просто именами переменных C++, они также должны соответствовать
Соглашения об именах C++. С++ переменная
имена
…
… должен начинаться с буквы и может заканчиваться цифрами.
… в имени не должно быть пробела.
… не может содержать специальные символы, кроме нижнего подчеркивания («_»).
… не должно быть ключевым словом.
Пин
ESPHome всегда использует внутренние номера GPIO чипа . Эти
внутренние номера всегда являются целыми числами, такими как 16
, и могут иметь префикс
GPIO
. Например, чтобы использовать контакт с внутренним GPIO номер 16,
вы можете ввести GPIO16
или просто 16
.
Однако большинство досок имеют псевдонимы для определенных контактов. Например, NodeMCU.
ESP8266 использует имена контактов с D0
по D8
в качестве псевдонимов для внутреннего GPIO.
номера пинов. Каждая доска (определена в разделе ESPHome)
имеет свои собственные псевдонимы, поэтому пока не все из них поддерживаются. Например,
для D0
(как напечатано на шелкографии печатной платы) вывод на NodeMCU ESP8266
имеет внутреннее имя GPIO GPIO16
, но также имеет псевдоним D0
. Итак, используя
любое из этих имен в вашей конфигурации приведет к тому же результату.
некоторая_конфигурация_опция: вывод: GPIO16 some_config_option: # псевдоним на NodeMCU ESP8266: вывод: D0
Схема контактов
В некоторых местах ESPHome также поддерживает более продвинутую «схему контактов».
некоторая_конфигурация_опция: # Базовый: вывод: D0 # Передовой: штырь: номер: Д0 перевернуто: правда Режим: ввод: правда подтягивание: правда
Переменные конфигурации:
номер ( Требуется , пин): номер пин-кода.
инвертированный ( Необязательный , логическое значение): Если все считанные и записанные значения
следует рассматривать как перевернутую. По умолчаниюfalse
.режим ( Необязательный , строка или сопоставление): настраивает вывод на различные
режимы, такие как ввод или вывод. Значение по умолчанию зависит от контекста.
Принимает либо сокращенную строку, либо сопоставление, где каждая функция может быть индивидуально
включено/выключено:вход ( Необязательный , логическое значение): если true, настройте контакт как вход.
вывод ( Необязательный , логическое значение): если true, настройте контакт как выход.
pullup ( Опционально , логическое значение): Активируйте внутренние подтягивающие резисторы на выводе.
pulldown ( Дополнительно , логическое значение): активируйте внутренние резисторы pulldown на контакте.
open_drain ( Необязательный , логическое значение): Установите вывод на открытый сток (в отличие от двухтактного).
Затем активное состояние вывода приведет к состоянию высокого импеданса.
Для совместимости также могут использоваться некоторые сокращенные режимы.
ВХОД
ВЫХОД
OUTPUT_OPEN_DRAIN
АНАЛОГОВЫЙ
INPUT_PULLUP
INPUT_PULLDOWN
Дополнительные параметры:
drive_strength ( Необязательный , строка): На ESP32 с платформой esp-idf сила привода колодки,
т.е. максимальное значение тока может быть дополнительно установлено. По умолчанию20 мА
.
Возможные варианты:5 мА
,10 мА
,20 мА
,40 мА
.
Время
Во многих местах в ESPHome вам нужно определить периоды времени.
Есть несколько способов сделать это. См. примеры ниже, чтобы увидеть, как вы можете указать периоды времени:
некоторая_конфигурация_опция: some_time_option: 1000us # 1000 микросекунд = 1 мс some_time_option: 1000 мс # 1000 миллисекунд some_time_option: 1. 5s # 1.5 секунды some_time_option: 0.5min # полминуты some_time_option: 2h # 2 часа # Убедитесь, что вы заключили их в кавычки some_time_option: '2:01' # 2 часа 1 минута some_time_option: '2:01:30' # 2 часа 1 минута 30 секунд # 10 мс + 30 с + 25 мин + 3 ч some_time_option: миллисекунды: 10 секунды: 30 минут: 25 часов: 3 дней: 0 # для всех опций 'update_interval' также update_interval: никогда # никогда не обновлять update_interval: 0ms # обновление в каждой итерации цикла()
Замены
Начиная с версии 1.10.0, в ESPHome появился новый мощный способ уменьшить количество повторений в файлах конфигурации:
Замены. С помощью замен вы можете иметь один общий исходный файл для всех узлов одного типа и
подставить выражения в.
замены: имя устройства: гостиная upper_devicename: Гостиная эсфома: имя: $ имя_устройства # ... датчик: - платформа: ДХТ # ... температура: имя: ${upper_devicename} Температура влажность: имя: ${upper_devicename} Влажность
В разделе верхнего уровня замен
вы можете поместить столько пар ключ-значение, сколько хотите. До
подтвердив вашу конфигурацию, ESPHome автоматически заменит все вхождения замен
по их стоимости. Синтаксис замены основан на bash и чувствителен к регистру: $substitution_key
или
${substitution_key}
(то же самое).
Выполняются два прохода замены, позволяющие заменять составные части.
замены: фу: желтый bar_yellow_value: !секрет yellow_secret bar_green_value: !секрет green_secret что-нибудь: тест: ${bar_${foo}_value}
Оператор вставки YAML
Кроме того, вы можете использовать синтаксис оператора вставки YAML <<
для создания одного файла YAML, из которого
узлов наследует:
# Общий.yaml эсфома: имя: $ имя_устройства # ... датчик: - платформа: ДХТ # ... температура: имя: ${upper_devicename} Температура влажность: имя: ${upper_devicename} Влажность
# В файле nodemcu1.yaml замены: имя устройства: nodemcu1 upper_devicename: NodeMCU 1 <<: !include common. yaml
Подсказка
Чтобы скрыть эти базовые файлы с панели управления, вы можете
Заменить переменные !include
ESPHome !include
принимает список переменных, которые можно заменить во включаемом файле.
двоичный_сенсор: - платформа: gpio идентификатор: кнопка1 вывод: GPIO16 on_multi_click: !include { file: on-multi-click.yaml, vars: { id: 1 } } # встроенный синтаксис - платформа: gpio идентификатор: кнопка2 вывод: GPIO4 on_multi_click: !include # многострочный синтаксис файл: on-multi-click.yaml вары: идентификатор: 2
on-multi-click.yaml
:
— время: !include click-single.yaml тогда: - mqtt.publish: тема: ${device_name}/button${id}/status полезная нагрузка: одиночная - время: !include click-double.yaml тогда: - mqtt.publish: тема: ${device_name}/button${id}/status полезная нагрузка: двойная
Замены командной строки
Вы можете определить или переопределить замены из командной строки, добавив, например, -s КЛЮЧ ЗНАЧЕНИЕ
который отменяет подстановку KEY и присваивает ей значение VALUE. Это может быть выпущено несколько раз,
так например со следующими пример.yaml
файл:
замены: имя: по умолчанию платформа: ESP8266 эсфома: имя: $имя платформа: $платформа доска: $board
и следующую команду:
esphome -s name device01 -s board esp01_1m example.yaml config
Вы получите что-то вроде следующего вывода (обратите внимание на неизменную платформу
,
добавлено доска
и переопределено имя
замен):
замены: имя: устройство01 платформа: ESP8266 плата: esp01_1m эсфома: имя: устройство01 платформа: ESP8266 плата: esp01_1m включает: [] библиотеки: [] esp8266_restore_from_flash: ложь путь_сборки: устройство01 Platformio_options: {} arduino_version: [электронная почта защищена]
Здесь мы можем заметить, что подстановки в командной строке имеют приоритет над подстановками в
ваш конфигурационный файл. Это можно использовать для создания общей конфигурации «шаблона».
файлы (например, example.yaml
выше), которые можно использовать для нескольких устройств,
используя замены, которые предоставляются в командной строке.
Пакеты
Еще один способ модульности и повторного использования конфигурации — использование пакетов. Эта функция позволяет
вам поместить общие части конфигурации в отдельные файлы и оставить только уникальные части вашего
config в основном файле yaml. Все определения из пакетов будут объединены с вашим основным
config неразрушающим образом, чтобы вы всегда могли переопределить некоторые биты и части пакета
конфигурация.
Словари объединяются по ключу. Списки компонентов объединены по компонентам
ID, если указан. Другие списки объединяются конкатенацией. Все остальные конфиги
значения заменяются более поздним значением.
Локальные пакеты
Рассмотрим следующий пример, в котором автор поместил общие элементы конфигурации, такие как Wi-Fi и
I²C в базовые файлы и расширяет его некоторыми специфическими для устройства конфигурациями в основной конфигурации.
Обратите внимание, как часть конфигурации, описывающая компонент API
в device_base.yaml
получает
объединены с определениями служб из основного файла конфигурации.
# В config.yaml замены: node_name: мое устройство device_verbose_name: "Мое устройство" пакеты: Wi-Fi: !include common/wifi.yaml device_base: !include common/device_base.yaml API: Сервисы: - сервис: start_laundry тогда: - switch.turn_on: реле - задержка: 3 часа - switch.turn_off: реле датчик: - платформа: mhz19 со2: название: "СО2" температура: Название: "Температура" update_interval: 60 сек. автоматическая_базовая_калибровка: ложь
# В wifi.yaml Wi-Fi: ssid: !секрет wifi_ssid пароль: !secret wifi_password домен: .yourdomain.lan fast_connect: правда
# В device_base.yaml эсфома: имя: ${имя_узла} платформа: ESP32 доска: wemos_d1_mini32 build_path: ./build/${node_name} # Шина I²C i2c: СДА: GPIO21 СЦЛ: GPIO22 сканирование: правда частота: 100 кГц # Включить ведение журнала регистратор: уровень: ${log_level} API: шифрование: ключ: !secret api_encryption_key reboot_timeout: 1 час датчик: - <<: !include common/sensor/uptime. config.yaml - <<: !include common/sensor/wifi_signal.config.yaml бинарный_сенсор: - <<: !include common/binary_sensor/connection_status.config.yaml выключатель: - <<: !include common/switch/restart_switch.config.yaml
Пакеты Remote/git
Пакеты также можно загружать из репозитория git, используя правильный синтаксис конфигурации.
Замены могут использоваться внутри удаленных пакетов, что позволяет пользователям переопределять
их локально с их собственным значением замены.
Примечание
Удаленные пакеты не могут содержать секретных
поисковых запросов. Вместо этого они должны использовать замены с
необязательное значение по умолчанию в упакованном YAML, которое YAML локального устройства может установить, используя значения из локальных секретов.
упаковки:
# Примеры Git-репозитория
удаленный_пакет:
URL-адрес: https://github.com/esphome/non-existant-repo
ссылка: основной # необязательный
файлы: [file1.yml, file2.