homebridge-washingmachine-pow

Homebridge plugin for Sonoff POW, customized for washingmachines


Keywords
washingmachine, homebridge-plugin, mqtt, sonoff, pow, eve, energy
License
MIT
Install
npm install homebridge-washingmachine-pow@2.1.3

Documentation

homebridge-washingmachine-pow

npm npm GitHub last commit verified-by-homebridge Discord Donate

Creating and maintaining Homebridge plugins consume a lot of time and effort, if you would like to share your appreciation, feel free to "Star" or donate.

Click here to review more of my plugins.

Info

HomeKit Overview

This is a dynamic platform plugin for Homebridge to control the state of your washingmachine(s) used with Sonoff POW (R2) with Telegram notification Support

This Plugin creates a Outlet Accessory with FakeGato functionality to check the power, which will be triggered when the current power is greater or equal than "startValue" defined in config.json

You can also set up the notifier to get a Telegram notification with customized messages and markdown capability when the current running program starts and/or finishes!

Installation instructions

After Homebridge has been installed:

  • sudo npm i -g homebridge-washingmachine-pow@latest

Basic configuration

{
 "bridge": {
   ...
 },
 "accessories": [
   ...
 ],
 "platforms": [
   {
     "platform": "WMPow",
     "debug": true,
     "devices":[
       {
         "name": "Washingmachine",
         "ip": "192.168.178.134",
         "port": 1883,
         "username": "test",
         "password": "test",
         "manufacturer": "ITEAD",
         "model": "Sonoff Pow",
         "serialNumber": "12345",
         "topics": {
           "energyGet": "tele/sonoffpow/SENSOR",
           "stateGet": "tele/sonoffpow/STATE",
           "statusGet": "stat/sonoffpow/POWER",
           "statusSet": "cmnd/sonoffpow/power",
           "resetSet": [
             "cmnd/sonoffpow/EnergyReset1",
             "cmnd/sonoffpow/EnergyReset2",
             "cmnd/sonoffpow/EnergyReset3"
           ]
         },
         "onValue": "ON",
         "offValue": "OFF",
         "startValue": 3
       }
     ],
     "telegram":{
       "active": true,
       "token": "TelegramToken",
       "chatID": "TelegramChatID",
       "messages": {
         "started": "*Washingmachine:* started!",
         "finished": "*Washingmachine:* finished!"
       }
     }
   }
 ]
}

See Example Config for more details.

Options

Attributes Required Usage
platform Yes Must be WMPow
debug No Enables additional output in the log.
devices.name Yes Name of the device/accessory (Must be unique!)
devices.ip Yes Address of your MQTT broker
devices.port No Port of your MQTT Service (Default: 1883)
devices.username No Username for the MQTT Service (If no username setted up, just leave blank)
devices.password No Password for the MQTT Service (If no password setted up, just leave blank)
devices.manufacturer No Manufacturer name for display in the Home app.
devices.model No Model name for display in the Home app.
devices.serialNumber No Serialnumber for display in the Home app.
topics.energyGet Yes Topic for energy telemetry information.
topics.stateGet Yes Topic for cyclic telemetry information.
topics.statusGet Yes Status of switch.
topics.statusSet Yes Command topic to set switch.
topics.resetSet Yes Command topic(s) to reset energy information.
devices.onValue No Client ON message for switch.
devices.offValue No Client OFF message for switch.
devices.startValue No Current Power Consumption when device is active
telegram.active No Activate/Deactivate notifier (Default: false)
telegram.token No Telegram Bot Token
telegram.chatID No Telegram Chat ID
telegram.messages.started No Own message when motion sensor triggers on (if you dont want to get this notification, just remove from config)
telegram.messages.finished No Own message when motion sensor triggers off (if you dont want to get this notification, just remove from config)

Power Report

The plugin works with the latest version of Tasmota (at the time of writing v9.3.1). If you want to have a more precise output of the power consumption, you can write the following command via the Tasmote page of the device under "Console" and confirm it with "Enter".

PowerDelta 1

1 stands for the percentage change in power consumption. This means that a change of 1% will send a message via MQTT, which the plugin will then process and show to you via EVE.

Supported clients

This plugin has been verified to work with the following apps on iOS 12.2 and iOS 12.3 Beta:

  • iOS 14+
  • Apple Home
  • All 3rd party apps like Elgato Eve etc.
  • Homebridge v1.1.6+

Contributing

You can contribute to this homebridge plugin in following ways:

  • Report issues and help verify fixes as they are checked in.
  • Review the source code changes.
  • Contribute bug fixes.
  • Contribute changes to extend the capabilities

Pull requests are accepted.

Troubleshooting

If you have any issues with the plugin then you can run this plugin in debug mode, which will provide some additional information. This might be useful for debugging issues. Just enable debug in your config and restart homebridge.