Skip to main content

A library for interfacing with Mitsubishi HVAC via the Echonet lite protocol.

Project description

Mitsubishi Echonet

GitHub Release License Project Maintenance BuyMeCoffee

A library for interfacing with Mitsubishi HVAC with the ECHONET-lite protocol over WiFi adaptors such as the MAC-568IF-E.

It is specifically designed for use with Home Assistant, and its functionality is limited to HVAC systems, but it could be potentially extended for other ECHONET-lite applications and become a more general purpose library.

Similar implementations seem to be Node JS middleware running on Docker containers to interface into the MQTT API however this is designed to be used as a straight up library, no middleware, Node JS or Docker containers needed!

It is designed to work with Python 3.7 out of the box as that was the environment I was working on.

Instructions

Simplest way to install is to use pip:

pip install mitsubishi_echonet

Basic usage

Discover a list of HVAC using:

aircons = mit.discover('Home air conditioner')
aircon = aircons[0]

Turn HVAC on or off:

aircon.on()
aircon.off()
aircon.getOperationalStatus()
{'status': 'off'}

Set or Get a HVACs target temperature

aircon.setOperationalTemperature(25)
aircon.getOperationalTemperature()
{'set_temperature': 25}

Set or Get a HVACs mode of operation:

supported modes =  'auto', 'cool', 'heat', 'dry', 'fan_only', 'other'

aircon.setMode('cool')
aircon.getMode()
{'mode': 'cool'}

Set or Get a HVACs fan speed:

Note - your HVAC may not support all fan speeds.

supported modes = 'auto', 'minimum', 'low', 'medium-Low', 'medium', 'medium-high', 'high', 'very high', 'max'

aircon.setFanSpeed('medium-high')
aircon.getFanSpeed()
{'fan_speed': 'medium-high'}

Get HVAC attributes at once:

aircon.update()
{'status': 'On', 'set_temperature': 25, 'fan_speed': 'medium-high', 'room_temperature': 25, 'mode': 'cooling'}

Using this library with Home Assistant

NOTE: For Home Assistant users there is now a dedicated repo for the related Home Assistant 'Mitsubishi' custom component that makes use of this Python library: (https://github.com/scottyphillips/mitsubishi_hass)

The custom component examples in the /bin directory will be removed from this repo at a later release and this repo will focus solely on the Python library.

'example.py' in the /bin directory gives you an idea how to drive the HVAC directly from Python using this library.

Thanks

Thanks to Jeffro Carr who inspired me to write my own native Python ECHONET library for Home Assistant. I could not get his Node JS Docker container to work properly on Hass.io :-) Some ideas in his own repo got implemented in my own code. (https://github.com/jethrocarr/echonetlite-hvac-mqtt-service.git)

Also big thanks to Futomi Hatano for open sourcing a high quality and extremely well documented ECHONET Lite library in Node JS that formed the basis of my reverse engineering efforts. (https://github.com/futomi/node-echonet-lite)

License

This application is licensed under an MIT license, refer to LICENSE for details.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mitsubishi-echonet, version 0.3.1
Filename, size File type Python version Upload date Hashes
Filename, size mitsubishi_echonet-0.3.1-py2-none-any.whl (22.3 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size mitsubishi_echonet-0.3.1.tar.gz (23.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page