405
edits
Changes
New page: Home Assistant
<languages/>
<translate>
The '''Larnitech''' integration connects the Larnitech controller with [https://www.home-assistant.io/ Home Assistant] over the local [[API2]] (WebSocket, port 2041). No cloud and no MQTT broker are needed, and changes reach both sides instantly.
* All items of the project appear in Home Assistant, grouped by Larnitech rooms (areas).
* Home Assistant devices selected in the integration options become Larnitech items: they appear in the Larnitech app and can be used in scripts and Blockly.
* Connection over the internet through <code>SERIAL.in.larnitech.com:8443</code> is also possible.
== Supported controllers ==
DE-MG, DE-MG.plus, DE-MG.knx, DE-MG.dali, Metaforsa, MF-14 (LT Setup 4.527 or newer).
== What Home Assistant gets ==
Lights, dimmers, RGB and tunable white; relays and water valves; blinds and gates; climate controllers (modes, heating and cooling setpoints, automations as presets), air conditioners, fancoils, heating valves, ventilation; temperature, humidity, illumination and CO₂ sensors; motion, door and leak sensors; light schemes; scripts; wall switches, remotes and IR receivers (as events for automations). Service items are not passed on.
== Connection ==
<ol>
<li>In LT Setup open '''Plugins → Home Assistant'''. If '''API access''' is off, press '''Enable API access'''. The page shows the controller address (local and over the internet), the port and the API key.</li>
<li>Install [https://hacs.xyz/ HACS] in Home Assistant if it is not installed yet.</li>
<li>In HACS find '''Larnitech''', install it and restart Home Assistant.<br>If it is not found, open ⋮ → ''Custom repositories'', add <code><nowiki>https://github.com/larnitech/larnitech-ha</nowiki></code> with type ''Integration'', install '''Larnitech''' and restart Home Assistant.</li>
<li>Press '''Add to Home Assistant''' on the plugin page, or open ''Settings → Devices & services → Add integration → Larnitech''.</li>
<li>Enter the address, port <code>2041</code> and the API key from step 1.</li>
</ol>
== Integration options ==
* '''Home Assistant devices in Larnitech''': Home Assistant entities (lights, switches, covers, climate, locks, fans, sensors) that are registered on the controller as Larnitech items. Commands from Larnitech control them in Home Assistant.
* '''Hide element types''': Larnitech item types that are not added to Home Assistant.
== Services and events ==
* <code>larnitech_official.set_status</code>: sends any status to an item, for example <code>addr: "585:17"</code>, <code>status: {"state": "on", "level": 50}</code>.
* <code>larnitech_official.reload_devices</code>: reloads the item list after the project was changed in LT Setup.
* Wall switches, remotes and IR receivers fire the <code>larnitech_official_event</code> event and appear as event entities.
== Updating from version 1.1.x ==
Version 1.2.0 changed the integration domain from <code>larnitech</code> to <code>larnitech_official</code>.
<ol>
<li>Remove the old Larnitech integration in ''Settings → Devices & services''.</li>
<li>Update to 1.2.0 in HACS and restart Home Assistant. Delete the <code>custom_components/larnitech</code> folder if it remains.</li>
<li>Add the integration again.</li>
<li>In automations and scripts replace the services with <code>larnitech_official.*</code> and the event with <code>larnitech_official_event</code>.</li>
</ol>
</translate>
<translate>
The '''Larnitech''' integration connects the Larnitech controller with [https://www.home-assistant.io/ Home Assistant] over the local [[API2]] (WebSocket, port 2041). No cloud and no MQTT broker are needed, and changes reach both sides instantly.
* All items of the project appear in Home Assistant, grouped by Larnitech rooms (areas).
* Home Assistant devices selected in the integration options become Larnitech items: they appear in the Larnitech app and can be used in scripts and Blockly.
* Connection over the internet through <code>SERIAL.in.larnitech.com:8443</code> is also possible.
== Supported controllers ==
DE-MG, DE-MG.plus, DE-MG.knx, DE-MG.dali, Metaforsa, MF-14 (LT Setup 4.527 or newer).
== What Home Assistant gets ==
Lights, dimmers, RGB and tunable white; relays and water valves; blinds and gates; climate controllers (modes, heating and cooling setpoints, automations as presets), air conditioners, fancoils, heating valves, ventilation; temperature, humidity, illumination and CO₂ sensors; motion, door and leak sensors; light schemes; scripts; wall switches, remotes and IR receivers (as events for automations). Service items are not passed on.
== Connection ==
<ol>
<li>In LT Setup open '''Plugins → Home Assistant'''. If '''API access''' is off, press '''Enable API access'''. The page shows the controller address (local and over the internet), the port and the API key.</li>
<li>Install [https://hacs.xyz/ HACS] in Home Assistant if it is not installed yet.</li>
<li>In HACS find '''Larnitech''', install it and restart Home Assistant.<br>If it is not found, open ⋮ → ''Custom repositories'', add <code><nowiki>https://github.com/larnitech/larnitech-ha</nowiki></code> with type ''Integration'', install '''Larnitech''' and restart Home Assistant.</li>
<li>Press '''Add to Home Assistant''' on the plugin page, or open ''Settings → Devices & services → Add integration → Larnitech''.</li>
<li>Enter the address, port <code>2041</code> and the API key from step 1.</li>
</ol>
== Integration options ==
* '''Home Assistant devices in Larnitech''': Home Assistant entities (lights, switches, covers, climate, locks, fans, sensors) that are registered on the controller as Larnitech items. Commands from Larnitech control them in Home Assistant.
* '''Hide element types''': Larnitech item types that are not added to Home Assistant.
== Services and events ==
* <code>larnitech_official.set_status</code>: sends any status to an item, for example <code>addr: "585:17"</code>, <code>status: {"state": "on", "level": 50}</code>.
* <code>larnitech_official.reload_devices</code>: reloads the item list after the project was changed in LT Setup.
* Wall switches, remotes and IR receivers fire the <code>larnitech_official_event</code> event and appear as event entities.
== Updating from version 1.1.x ==
Version 1.2.0 changed the integration domain from <code>larnitech</code> to <code>larnitech_official</code>.
<ol>
<li>Remove the old Larnitech integration in ''Settings → Devices & services''.</li>
<li>Update to 1.2.0 in HACS and restart Home Assistant. Delete the <code>custom_components/larnitech</code> folder if it remains.</li>
<li>Add the integration again.</li>
<li>In automations and scripts replace the services with <code>larnitech_official.*</code> and the event with <code>larnitech_official_event</code>.</li>
</ol>
</translate>