homebridge-tasmota-control
Version:
Homebridge plugin to control Tasmota flashed devices.
151 lines (134 loc) • 9.44 kB
Markdown
<p align="center">
<a href="https://github.com/grzegorz914/homebridge-tasmota-control"><img src="https://raw.githubusercontent.com/grzegorz914/homebridge-tasmota-control/main/graphics/homebridge-tasmota-control.png" width="640"></a>
</p>
<span align="center">
# Homebridge Tasmota Control
[](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
[](https://www.npmjs.com/package/homebridge-tasmota-control)
[](https://www.npmjs.com/package/homebridge-tasmota-control)
[](https://www.npmjs.com/package/homebridge-tasmota-control)
[](https://github.com/grzegorz914/homebridge-tasmota-control/pulls)
[](https://github.com/grzegorz914/homebridge-tasmota-control/issues)
Homebridge plugin for Tasmota flashed devices.
</span>
## Package Requirements
| Package | Installation | Role | Required |
| --- | --- | --- | --- |
| [Homebridge](https://github.com/homebridge/homebridge) | [Homebridge Wiki](https://github.com/homebridge/homebridge/wiki) | HomeKit Bridge | Required |
| [Config UI X](https://github.com/homebridge/homebridge-config-ui-x) | [Config UI X Wiki](https://github.com/homebridge/homebridge-config-ui-x/wiki) | Homebridge Web User Interface | Recommended |
| [Tasmota Control](https://www.npmjs.com/package/homebridge-tasmota-control) | [Plug-In Wiki](https://github.com/grzegorz914/homebridge-tasmota-control/wiki) | Homebridge Plug-In | Required |
## About The Plugin
* Plugin work with Tasmota v6.0.0 and abowe.
* Support Mitsubishi HVAC:
* Precompiled ESP firmware for `MiElHVAC` are in `firmware` folder.
* If You need firmware for specific `ESP` please go to [Firmware for MiElHVAC](https://github.com/grzegorz914/homebridge-tasmota-control/issues/18) and meke request.
* Heater Cooler:
* Power `ON/OFF`.
* Operating mode `AUTO/HEAT/COOL`.
* Temperature `HEATING/COOLING/AUTO`.
* Fan speed `OFF/QUIET/1/2/3/4/AUTO`.
* Swing mode `AUTO/SWING`.
* Physical lock controls `LOCK/UNLOCK`.
* Temperature display unit `°F/°C`.
* Buttons:
* For direct device control.
* Power `ON/OFF`.
* Operating mode `HEAT/DRY/COOL/FAN/AUTO`.
* Fan speed `OFF/QUIET/1/2/3/4/AUTO`.
* Vane H `LEFT/LEFT MIDDLE/CENTER/RIGHT MIDDLE/RIGHT/SPLIT/SWING`.
* Vane V `AUTO/UP/UP MIDDLE/CENTER/DOWN MIDDLE/DOWN/SWING`.
* Air direction `INDIRECT/DIRECT/EVEN`.
* Prohibit `POWER/MODE/TEMPERATURE/ALL`.
* Physical lock controls `LOCK/UNLOCK`.
* Presets `SET/UNSET`.
* Sensors:
* For automation and notifications.
* State sensors:
* Power `ON/OFF`.
* Operating mode `HEAT/DRY/COOL/FAN/AUTO`.
* Fan speed `OFF/QUIET/1/2/3/4/AUTO`.
* Vane H `AUTO/1/2/3/4/5/SPLIT/SWING`.
* Vane V `AUTO/1/2/3/4/5/SWING`.
* Air direction `INDIRECT/DIRECT/EVEN`.
* Physical lock controls `LOCK/UNLOCK`.
* Presets `ACTIV/UNACTIV`.
* Operation stage `NORMAL/DEFROST/PREHEAT/STANDBY`.
* Fan stage `OFF/QUIET/1/2/3/4/5`.
* Mode stage `AUTO OFF/AUTO FAN/AUTO HEAT/AUTO COOL`.
* Remote temperature.
* Temperature sensors:
* Room temperature.
* Outdoor temperature.
* Functions:
* Frost protect
* Supported relay devices:
* Light - `Power ON/OFF`, `Dimmer`, `Color Temperature`, `Hue`, `Saturation`
* Outlet - `Power ON/OFF`
* Switch - `Power ON/OFF`
* Supported Sensors:
* Temperature - `Temperature`, `Dew Point`, `Reference`, `Obj`, `Amb`
* Humidity
* Carbon Dioxyde
* Ambient Light
* Motion
### Configuration
* Run this plugin as a [Child Bridge](https://github.com/homebridge/homebridge/wiki/Child-Bridges) (Highly Recommended), this prevent crash Homebridge if plugin crashes.
* Install and use [Homebridge Config UI X](https://github.com/homebridge/homebridge-config-ui-x/wiki) to configure this plugin (Highly Recommended).
* The `sample-config.json` can be used as an alternative, make a backup copy before making any changes.
<p align="center">
<a href="https://github.com/grzegorz914/homebridge-tasmota-control"><img src="https://raw.githubusercontent.com/grzegorz914/homebridge-tasmota-control/master/graphics/ustawienia.png" width="840"></a>
</p>
| Key | Description |
| --- | --- |
| `name` | Here set the accessory *Name* to be displayed in *Homebridge/HomeKit*. |
| `host` | Here set the *Hsostname or Address IP* of the Device.|
| `auth` | If enabled, authorizatins credentials will be used for login. |
| `user` | Here set the authorization *Username*. |
| `passwd` | Here set the authorization *Password*. |
| `disableAccessory` | If enabled, the accessory will be disabled. |
| `miElHvac.heatDryFanMode` | Here select the operatiing mode for `Heat`, only for Mitsubishio AC. |
| `miElHvac.coolDryFanMode` | Here select the operatiing mode for `Cool`, only for Mitsubishio AC. |
| `miElHvac.autoDryFanMode` | Here select the operatiing mode for `Auto`, only for Mitsubishio AC. |
| `miElHvac.temperatureSensor` | This enable extra `Room` temperature sensor to use with automations in HomeKit app. |
| `miElHvac.temperatureSensorOutdoor` | This enable extra `Outdoor` temperature sensor to use with automations in HomeKit app. |
| `miElHvac.remoteTemperatureSensor` | Object of remote temperature sensor. |
| `miElHvac.remoteTemperatureSensor.enable` | This activate the function. |
| `miElHvac.remoteTemperatureSensor.path` | Here set the path to the temperature sensor, the request need to return value. |
| `miElHvac.remoteTemperatureSensor.refreshInterval` | Here set remote sensor refresh interval. |
| `miElHvac.remoteTemperatureSensor.auth` | If enabled, authorizatins credentials will be used for remote sensor. |
| `miElHvac.remoteTemperatureSensor.user` | Here set the authorization *Username*. |
| `miElHvac.remoteTemperatureSensor.passwd` | Here set the authorization *Password*. |
| `miElHvac.presets` | Array of presets sensors. |
| `miElHvac.presets.name` | Here You can schange the `Preset Name` which is exposed to the `Homebridge/HomeKit`. |
| `miElHvac.presets.mode` | Here set the operation mode. |
| `miElHvac.presets.setTemp` | Here set the target temperature. |
| `miElHvac.presets.fanSpeed` | Here set the fan speed. |
| `miElHvac.presets.swingV` | Here set the vane vertical direction. |
| `miElHvac.presets.swingH` | Here set the vane horizontal direction. |
| `miElHvac.presets.displayType` | Here select display type in HomeKit, `0 - None/Disabled`, `1 - Outlet`, `2 - Switch`, `3 - Motion Sensor`, `4 - Occupancy Sensor`, `5 - Contact Sensor`. |
| `miElHvac.buttons` | Array of buttons sensors. |
| `miElHvac.buttons.name` | Here set `Button Name` which You want expose to the `Homebridge/HomeKit`. |
| `miElHvac.buttons.mode` | Here select button function mode. |
| `miElHvac.buttons.displayType` | Here select display type in HomeKit, `0 - None/Disabled`, `1 - Outlet`, `2 - Switch`, `3 - Motion Sensor`. |
| `miElHvac.buttons.namePrefix` | Here enable/disable the accessory name as a prefix for button name. |
| `miElHvac.sensors` | Array of sensors sensors. |
| `miElHvac.sensors.name` | Here set `Sensor Name` which You want expose to the `Homebridge/HomeKit`. |
| `miElHvac.sensors.mode` | Here select sensor function mode. |
| `miElHvac.sensors.displayType` | Here select display type in HomeKit, `0 - None/Disabled`, `1 - Motion Sensor`, `2 - Occupancy Sensor`, `3 - Contact Sensor`. |
| `miElHvac.sensors.namePrefix` | Here enable/disable the accessory name as a prefix for sensor name. |
| `miElHvac.frostProtect` | Object of frost protect function. |
| `miElHvac.frostProtect.enable` | This activate frost protect function. |
| `miElHvac.frostProtect.lowTemp` | Here set the low temperature at which device start to frost protect. |
| `miElHvac.frostProtect.highTemp` | Here set the high temperature at which device start to frost protect. |
| `relaysNamePrefix` | Here enable/disable the accessory name as a prefix for relays name. |
| `relaysDisplayType` | Here select characteristic display type for relays which are exposed in the HomeKit app. |
| `lightsNamePrefix` | Here enable/disable the accessory name as a prefix for lights name. |
| `sensorsNamePrefix` | Here enable/disable the accessory name as a prefix for sensors name. |
| `loadNameFromDevice` | If enabled, the accessory name will be loaded direct from device. |
| `refreshInterval` | Here set the data refresh time in (sec). |
| `disableLogDeviceInfo` | If enabled, add ability to disable log device info by every connections device to the network. |
| `disableLogInfo` | If enabled, disable log info, all values and state will not be displayed in Homebridge log console. |
| `disableLogSuccess` | If enabled, disable logging device success. |
| `disableLogWarn` | If enabled, disable logging device warnings. |
| `disableLogError` | If enabled, disable logging device error. |
| `enableDebugMode` | If enabled, deep log will be present in homebridge console. |