Skip to main content

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

Project description

# mitsubishi_echonet
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 potentally extended for other
Echonet 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

# Using the library
There are two files under /bin
'example.py' is an executable Python3 script that will discover your
Mitsubishi HVAC and play with some settings.

'mitsubishi.py' is for use with Home Assistant.
Copy it into your 'custom_components'

In configuration.yaml add the following lines:

climate:
- platform: mitsubishi
ip_address: 1.2.3.4

# Help! Home Assistant could not run the module?

When I was playing around with this I had difficulty getting hass.io to install
the library from pip. No idea why, but eventually I found the correct
combination to get it to work as it is supposed to.

However, there is a workaround:

1. Clone the repo
2. Copy the 'mitsubishi_echonet' subfolder directly out of the repo and
into the 'custom_components' directory.
3. Flip the comments on the following lines in mitsubishi.py:

from mitsubishi_echonet import lib_mitsubishi as mit
# from custom_components.mitsubishi_echonet import lib_mitsubishi as mit

Make sure you enable the ECHONET Lite service in the official Mitsubishi App.

Comments and suggestions are welcome!

# Thanks
Thanks to Jeffro Carr who inspired me to write my own native Python ECHONET library for
Home Assistant. 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

# Licence
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.

Source Distribution

mitsubishi_echonet-0.1.2.tar.gz (20.1 kB view details)

Uploaded Source

File details

Details for the file mitsubishi_echonet-0.1.2.tar.gz.

File metadata

  • Download URL: mitsubishi_echonet-0.1.2.tar.gz
  • Upload date:
  • Size: 20.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.10.0 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/2.7.10

File hashes

Hashes for mitsubishi_echonet-0.1.2.tar.gz
Algorithm Hash digest
SHA256 5dc87b0109cf4b29f5c5c68c9866b2d135bfb3269e41ba071dfc53e71208db62
MD5 43339f8d42bcad59b1148e06c8aa5bb0
BLAKE2b-256 824cac276147291bc16bda27dd65f08ff8b37ad52750699efa3ee09e9228b4e7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page