{ "info": { "author": "Scott Phillips", "author_email": "jrh@example.com", "bugtrack_url": null, "classifiers": [], "description": "# Mitsubishi Echonet\n\nA library for interfacing with Mitsubishi HVAC with the ECHONET-lite protocol\nover WiFi adaptors such as the MAC-568IF-E.\n\nIt is specifically designed for use with Home Assistant, and its functionality\nis limited to HVAC systems, but it could be potentially extended for other\nECHONET-lite applications and become a more general purpose library.\n\nSimilar implementations seem to be Node JS middleware running on Docker\ncontainers to interface into the MQTT API however this is designed to be used\nas a straight up library, no middleware, Node JS or Docker containers needed!\n\nIt is designed to work with Python 3.7 out of the box as\nthat was the environment I was working on.\n\n## Instructions\n\nSimplest way to install is to use pip:\n\n```\npip install mitsubishi_echonet\n```\n\n## Basic usage\n### Discover a list of HVAC using:\n```python\naircons = mit.discover('Home air conditioner')\naircon = aircons[0]\n```\n\n### Turn HVAC on or off:\n```python\naircon.on()\naircon.off()\naircon.getOperationalStatus()\n{'status': 'Off'}\n```\n\n### Set or Get a HVACs target temperature\n```python\naircon.setOperationalTemperature(25)\naircon.getOperationalTemperature()\n{'set_temperature': 25}\n```\n\n### Set or Get a HVACs mode of operation:\n```python\nsupported modes = 'auto', 'cool', 'heat', 'dehumidify', 'fan_only', 'other'\n\naircon.setMode('cool')\naircon.getMode()\n{'mode': 'cool'}\n```\n### Set or Get a HVACs fan speed:\n\nNote - your HVAC may not support all fan speeds.\n```python\nsupported modes = 'auto', 'minimum', 'low', 'medium-Low', 'medium', 'medium-high', 'high', 'very high', 'max'\n\naircon.setFanSpeed('medium-high')\naircon.getFanSpeed()\n{'fan_speed': 'medium-high'}\n```\n### Get HVAC attributes at once:\n```python\naircon.update()\n{'status': 'On', 'set_temperature': 25, 'fan_speed': 'Medium-High', 'room_temperature': 25, 'mode': 'Cooling'}\n```\n## Using the library with Home Assistant\n\nThere are two files under /bin\n'example.py' is an executable Python3 script that will discover your\nMitsubishi HVAC and play with some settings.\n\n'/custom_components/mitsubishi/climate.py' is for use with Home Assistant (v0.89+)\nCopy the '/mitsubishi/climate.py' (including folder) into your 'custom_components'\n\nIn configuration.yaml add the following lines:\n```yaml\nclimate:\n - platform: mitsubishi\n ip_address: 1.2.3.4\n```\n## Fine tuning fan settings.\nOptionally, you can also specify what fan settings work with your specific\nHVAC system. If no fan speeds are configured, the system will default to 'low'\nand 'medium-high'. Just delete the ones you dont need.\nNote: if you are on HA 0.95 or lower use ```fan_list``` not ```fan_modes```\n\n```yaml\nclimate:\n - platform: mitsubishi\n ip_address: 192.168.1.6\n name: \"mitsubishi_ducted\"\n fan_modes:\n - 'minimum'\n - 'low'\n - 'medium-low'\n - 'medium'\n - 'medium-high'\n - 'high'\n - 'very-high'\n - 'max'\n```\n\n## Help! Home Assistant could not run the module?\n\nWhen I was playing around with this I had difficulty getting hass.io to install\nthe library from pip. No idea why, but eventually I found the correct\ncombination to get it to work as it is supposed to.\n\nHowever, there is a workaround:\n\n1. Clone the repo\n2. Copy the 'mitsubishi_echonet' subfolder directly out of the repo and\ninto the 'custom_components' directory.\n3. Flip the comments on the following lines in climate.py:\n```\nimport mitsubishi_echonet as mit\n# import custom_components.mitsubishi_echonet as mit\n```\nMake sure you enable the ECHONET Lite service in the official Mitsubishi App.\n\nComments and suggestions are welcome!\n\n\nBuy me a coffee!\n\n## Thanks\n\nThanks to Jeffro Carr who inspired me to write my own native Python ECHONET\nlibrary for Home Assistant. I could not get his Node JS Docker container\nto work properly on Hass.io :-)\nSome ideas in his own repo got implemented in my own code.\n(https://github.com/jethrocarr/echonetlite-hvac-mqtt-service.git)\n\nAlso big thanks to Futomi Hatano for open sourcing a high quality and\nextremely well documented ECHONET Lite library in Node JS that formed\nthe basis of my reverse engineering efforts.\n(https://github.com/futomi/node-echonet-lite)\n\n## License\n\nThis application is licensed under an MIT license, refer to LICENSE for details.\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://pypi.python.org/pypi/mitsubishi_echonet/", "keywords": "", "license": "LICENSE.txt", "maintainer": "", "maintainer_email": "", "name": "mitsubishi-echonet", "package_url": "https://pypi.org/project/mitsubishi-echonet/", "platform": "", "project_url": "https://pypi.org/project/mitsubishi-echonet/", "project_urls": { "Homepage": "http://pypi.python.org/pypi/mitsubishi_echonet/" }, "release_url": "https://pypi.org/project/mitsubishi-echonet/0.2.1/", "requires_dist": null, "requires_python": "", "summary": "A library for interfacing with Mitsubishi HVAC via the Echonet lite protocol.", "version": "0.2.1" }, "last_serial": 5693312, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "349318780e7efac26802c705856cf09f", "sha256": "08ba2d978d7d8790b300902c28c6f0647768daba9e6f79e0eaa3f7ba9a6a2e8b" }, "downloads": -1, "filename": "mitsubishi_echonet-0.1.1.tar.gz", "has_sig": false, "md5_digest": "349318780e7efac26802c705856cf09f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19037, "upload_time": "2018-11-27T06:13:52", "url": "https://files.pythonhosted.org/packages/1c/35/681036e91bb818efdf36f180543a2c72ba489911ee95534362c4642990f2/mitsubishi_echonet-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "43339f8d42bcad59b1148e06c8aa5bb0", "sha256": "5dc87b0109cf4b29f5c5c68c9866b2d135bfb3269e41ba071dfc53e71208db62" }, "downloads": -1, "filename": "mitsubishi_echonet-0.1.2.tar.gz", "has_sig": false, "md5_digest": "43339f8d42bcad59b1148e06c8aa5bb0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20150, "upload_time": "2018-11-27T09:15:42", "url": "https://files.pythonhosted.org/packages/82/4c/ac276147291bc16bda27dd65f08ff8b37ad52750699efa3ee09e9228b4e7/mitsubishi_echonet-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "f58216c6e8fda298fdad9fda724b8dcf", "sha256": "ee1bf1c47abe21a273e25ee71948e534004810edb23b1f056e62961ee168c407" }, "downloads": -1, "filename": "mitsubishi_echonet-0.1.3.tar.gz", "has_sig": false, "md5_digest": "f58216c6e8fda298fdad9fda724b8dcf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19608, "upload_time": "2018-11-30T11:51:57", "url": "https://files.pythonhosted.org/packages/29/e0/92a4987c7cfa7b5f146712eb298b8ade31932bc2a34cb28e41cd5aee1394/mitsubishi_echonet-0.1.3.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "af575940281ef72af8ca1d916ffb7ce1", "sha256": "f076ca5864d7df55293ca4d1fb5e036e4225390c3ee4569cb435d3dee020a603" }, "downloads": -1, "filename": "mitsubishi_echonet-0.1.6.tar.gz", "has_sig": false, "md5_digest": "af575940281ef72af8ca1d916ffb7ce1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22502, "upload_time": "2018-12-06T22:16:14", "url": "https://files.pythonhosted.org/packages/b6/ce/89b8b104428d6699ddc2aaa5d333908fa66d996776cc6360a1e46ca34d04/mitsubishi_echonet-0.1.6.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "7283dc160d1270b07adc23edb8fee44b", "sha256": "87a3d1b9f8407bcbe9032e4f0452f83e9a579aff57c7984660cd9dbe18c17733" }, "downloads": -1, "filename": "mitsubishi_echonet-0.1.7.tar.gz", "has_sig": false, "md5_digest": "7283dc160d1270b07adc23edb8fee44b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22734, "upload_time": "2018-12-07T12:19:18", "url": "https://files.pythonhosted.org/packages/5a/de/9fe4eb95e753fed69def24207ce0c6bf3ad63207b8844e25a69fca21d8d9/mitsubishi_echonet-0.1.7.tar.gz" } ], "0.1.8": [ { "comment_text": "", "digests": { "md5": "ef10fb1bd9a3f704871b96b398e3b4ee", "sha256": "d1e3bf8b927eccc8011b4efed7a74bf7006898de41651c507332ac5a2e2de6ba" }, "downloads": -1, "filename": "mitsubishi_echonet-0.1.8.tar.gz", "has_sig": false, "md5_digest": "ef10fb1bd9a3f704871b96b398e3b4ee", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22827, "upload_time": "2018-12-08T11:03:10", "url": "https://files.pythonhosted.org/packages/f1/81/e8d3f64aecacf444d0f76a58d605f793eb2e4949caa1526c48f6cdbfec0e/mitsubishi_echonet-0.1.8.tar.gz" } ], "0.1.8.1": [ { "comment_text": "", "digests": { "md5": "26f46be24459d68070f18a6193f4e55a", "sha256": "3a1bcec0cf35d488974ccc4824913aaf2deb595ae845771ced38cf8a27d8cff1" }, "downloads": -1, "filename": "mitsubishi_echonet-0.1.8.1.tar.gz", "has_sig": false, "md5_digest": "26f46be24459d68070f18a6193f4e55a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22845, "upload_time": "2018-12-08T11:54:47", "url": "https://files.pythonhosted.org/packages/12/64/0f79f1f939d6f6a891061c703b4ee81800405f02aec3d42893f22b264d01/mitsubishi_echonet-0.1.8.1.tar.gz" } ], "0.1.9": [ { "comment_text": "", "digests": { "md5": "4ecdddce5a38fc07ae4963bc1f3bb332", "sha256": "962501f7257a0136fc0ba352752f2be25e4229591f835a6d99104485891f6e0a" }, "downloads": -1, "filename": "mitsubishi_echonet-0.1.9.tar.gz", "has_sig": false, "md5_digest": "4ecdddce5a38fc07ae4963bc1f3bb332", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 23010, "upload_time": "2018-12-20T04:45:39", "url": "https://files.pythonhosted.org/packages/79/ef/91731830a8efe5bb7499ea8a8c19b9a4210718b5b90395412484a4ec2c93/mitsubishi_echonet-0.1.9.tar.gz" } ], "0.1.9.1": [ { "comment_text": "", "digests": { "md5": "5d6984384aef46a7b74746c54b744940", "sha256": "dc275233a603ed1f49b29f08261e47893b71bd809214d461b15bf13b7a11f410" }, "downloads": -1, "filename": "mitsubishi_echonet-0.1.9.1.tar.gz", "has_sig": false, "md5_digest": "5d6984384aef46a7b74746c54b744940", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 23017, "upload_time": "2018-12-20T06:24:01", "url": "https://files.pythonhosted.org/packages/f5/3c/f27bfd9cc3b1d50f472b0001f7ffc0ae4152a414bf6be32ec7b0d4218a32/mitsubishi_echonet-0.1.9.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "c04bc0e045d5545c89368452c602220b", "sha256": "663228ef19f32119d333204628ee4242f229bf1c491842db8da386794df566dc" }, "downloads": -1, "filename": "mitsubishi_echonet-0.2-py2-none-any.whl", "has_sig": false, "md5_digest": "c04bc0e045d5545c89368452c602220b", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 22347, "upload_time": "2019-06-07T11:43:19", "url": "https://files.pythonhosted.org/packages/d4/c9/d2dceb7107e20c1b51159c7f2a329e54aa98b342628993b48d877eb3e09a/mitsubishi_echonet-0.2-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "53a09e2ed31487d1fa1c26d40fc4a479", "sha256": "9d63b4d5f53abe33a257efdd10c0b1f0142f2c626769849a4d755f7aa40535c3" }, "downloads": -1, "filename": "mitsubishi_echonet-0.2.tar.gz", "has_sig": false, "md5_digest": "53a09e2ed31487d1fa1c26d40fc4a479", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 23524, "upload_time": "2019-06-07T11:46:48", "url": "https://files.pythonhosted.org/packages/84/e7/ddfe1c8de7f3b7a5889feb05f87fe8fb6deacd970afeef460a6e56e07f39/mitsubishi_echonet-0.2.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "14908feb345aaeade640867682a13d12", "sha256": "8ddf2a6d0a9c82efe8d76a50b8f6c8a15f1e0a08715dc6436b7a172b10c7016f" }, "downloads": -1, "filename": "mitsubishi_echonet-0.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "14908feb345aaeade640867682a13d12", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 22439, "upload_time": "2019-08-18T03:27:05", "url": "https://files.pythonhosted.org/packages/a4/47/3f4b60586a00e587e768b3a5d91e1c9b2e4db63ed92f5078c02a67b143d2/mitsubishi_echonet-0.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "17d45b8744032ec5c953cef7d2da8151", "sha256": "9546c30775e5c3689a9b85fcbe2a4f379d75b272ed6fdf87bd213a76f7c28391" }, "downloads": -1, "filename": "mitsubishi_echonet-0.2.1.tar.gz", "has_sig": false, "md5_digest": "17d45b8744032ec5c953cef7d2da8151", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 23503, "upload_time": "2019-08-18T03:27:13", "url": "https://files.pythonhosted.org/packages/55/a3/2754ffd4938fa985ccd78f15bba30b76c7876a8be33481a4916cd9057c09/mitsubishi_echonet-0.2.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "14908feb345aaeade640867682a13d12", "sha256": "8ddf2a6d0a9c82efe8d76a50b8f6c8a15f1e0a08715dc6436b7a172b10c7016f" }, "downloads": -1, "filename": "mitsubishi_echonet-0.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "14908feb345aaeade640867682a13d12", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 22439, "upload_time": "2019-08-18T03:27:05", "url": "https://files.pythonhosted.org/packages/a4/47/3f4b60586a00e587e768b3a5d91e1c9b2e4db63ed92f5078c02a67b143d2/mitsubishi_echonet-0.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "17d45b8744032ec5c953cef7d2da8151", "sha256": "9546c30775e5c3689a9b85fcbe2a4f379d75b272ed6fdf87bd213a76f7c28391" }, "downloads": -1, "filename": "mitsubishi_echonet-0.2.1.tar.gz", "has_sig": false, "md5_digest": "17d45b8744032ec5c953cef7d2da8151", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 23503, "upload_time": "2019-08-18T03:27:13", "url": "https://files.pythonhosted.org/packages/55/a3/2754ffd4938fa985ccd78f15bba30b76c7876a8be33481a4916cd9057c09/mitsubishi_echonet-0.2.1.tar.gz" } ] }