Custom/Configuration: различия между версиями

Текущая версия от 12:25, 5 сентября 2024

HOMEd > Custom > Конфигурация

Файл конфигурации

Конфигурация HOMEd Custom хранится в файле /etc/homed/homed-custom.conf. Пример файла конфигурации:

[log]
enabled=false
timestamps=true
file=/var/log/homed.log

[mqtt]
host=localhost
port=1883
username=custom
password=secret
prefix=homed
names=false

[homeassistant]
enabled=false
prefix=homeassistant
status=homeassistant/status

[device]
database=/opt/homed-custom/database.json
properties=/opt/homed-custom/properties.json
expose=/usr/share/homed-common/expose.json

При изменении содержимого файла конфигурации сервис автоматически перезапускается.

Параметры

`[log]`

параметр	описание
enabled	включение/выключение записи логов в файл
timestamps	включение/выключение меток времени при выводе лога в `stdout`
file	путь к файлу лога

`[mqtt]`

параметр	описание
host	адрес брокера
port	порт брокера
username	имя пользователя для авторизации на брокере (может быть пустым)
password	пароль для авторизации на брокере (может быть пустым)
prefix	корневой топик
names	использование имен устройств вместо адресов в MQTT-топиках

`[homeassistant]`

параметр	описание
enabled	включение/выключение функции Home Assistant MQTT Discovery
prefix	корневой топик для Home Assistant MQTT Discovery
status	топик для отслеживания состояния Home Assistant

`[device]`

параметр	описание
database	путь к файлу базы данных
properties	путь к файлу, в котором будут храниться акткуальные (последние известные) состояния устройств
expose	путь к файлу с опциями типовых способностей устройств

Что дальше?

После настройки HOMEd Custom можно приступать к добавлению устройств, при помощи веб-интерфейса или вручную.

@@ Строка 13: / Строка 13: @@
 host=localhost
 port=1883
-username=
+username=custom
-password=
+password=secret
 prefix=homed
 names=false
@@ Строка 20: / Строка 20: @@
 [homeassistant]
 enabled=false
-legacy=false
 prefix=homeassistant
 status=homeassistant/status
@@ Строка 66: / Строка 65: @@
   |'''prefix'''
   |корневой топик
+|-
+ |'''names'''
+ |использование имен устройств вместо адресов в MQTT-топиках
+|}
+=== <code>[homeassistant]</code> ===
+{|class="wikitable" style="width: 100%"
+ !style="width: 15%"|параметр
+ !style="width: 85%"|описание
+|-
+ |'''enabled'''
+ |включение/выключение функции [https://www.home-assistant.io/integrations/mqtt/#mqtt-discovery Home Assistant MQTT Discovery]
+|-
+ |'''prefix'''
+ |корневой топик для [https://www.home-assistant.io/integrations/mqtt/#mqtt-discovery Home Assistant MQTT Discovery]
+|-
+ |'''status'''
+ |топик для отслеживания [https://www.home-assistant.io/integrations/mqtt/#birth-and-last-will-messages состояния Home Assistant]
 |}
-=== <code>[server]</code> ===
+=== <code>[device]</code> ===
 {|class="wikitable" style="width: 100%;"
   !style="width: 15%"|параметр
   !style="width: 85%"|описание
-|-
- |'''port'''
- |порт сервера
 |-
   |'''database'''
   |путь к файлу базы данных
 |-
-  |'''frontend'''
+  |'''properties'''
-  |путь к файлам веб-интерфейса
+  |путь к файлу, в котором будут храниться акткуальные (последние известные) состояния устройств
-|-
- |'''username'''
- |имя пользователя для авторизации в веб-интерфейсе (может быть пустым)
 |-
-  |'''password'''
+  |'''expose'''
-  |пароль для авторизации в веб-интерфейсе (может быть пустым)
+  |путь к файлу с [[Common/Options|опциями]] типовых [[Common/Exposes|способностей]] устройств
 |}
-{{Warning|В случае, если в файле конфигурации отсутствует параметр <code>username</code> или параметр <code>password</code>, а так же в случае, если значение одного из этих параметров является пустым, авторизация в веб-интерфейсе будет отключена.}}
+== Что дальше? ==
+После настройки {{Service|Custom}} можно приступать к добавлению устройств, при помощи [[Web|веб-интерфейса]] или [[Custom/Topics|вручную]].
-[[Category:Web]]
+[[Category:Custom]]