ECHONETLite Platform Custom Component for Home Assistant

(日本語)

A Home Assistant custom component for use with ECHONETLite compatible devices. This custom component makes use of the 'pychonet' Python3 library also maintained by this author. (https://github.com/scottyphillips/pychonet)

This component will set up the climate, fan, sensor, select and switch platforms.

Current working systems:

Based upon feedback this custom component works with the following compatible ECHONETLite Devices:

Manufacturer	Device	ECHONETLite Object Class	Home Assistant Entities	Notes
Mitsubishi Electric	MAC-568IF-E	HomeAirConditioner	Climate, Sensor, Select	WiFi Adaptor connected to various HVAC ducted and split systems. See list below.
Mitsubishi Electric	MAC-578IF2-E	HomeAirConditioner	Climate, Sensor, Select	WiFi Adaptor connected to various HVAC ducted and split systems. See list below.
Mitsubishi Electric	MAC-588IF-E	HomeAirConditioner	Climate, Sensor, Select	WiFi Adaptor connected to various HVAC ducted and split systems. See list below.
Mitsubishi Electric	MAC-600IF	HomeAirConditioner	Climate, Sensor, Select
Mitsubishi Electric	HM-W002-AC	HomeAirConditioner	Climate, Sensor, Select	WiFi Adaptor connected to various HVAC ducted and split systems. See list below.
Mitsubishi Electric	Eco-Cute SRT-S466A + RMCB-H6SE-T	ElectricWaterHeater	Sensor, Select, Switch
Mitsubishi Electric	REF-WLAN001	Refrigerator	Sensor
Sharp	AY-J22H Air Conditioner	HomeAirConditioner	Climate, Sensor, Select
Sharp	AY-L40P Air Conditioner	HomeAirConditioner	Climate, Sensor, Select
Sharp	KI-HS70 Air Purifier	HomeAirCleaner	Fan, Sensor, Select
Panasonic	CS-221DJ Air Conditioner	HomeAirConditioner	Climate, Sensor, Select
Panasonic	CS-362DJ2 Air Conditioner	HomeAirConditioner	Climate, Sensor, Select
Panasonic	HF-JA2-W		Sensor	IP/JEM-A conversion adapter.
Panasonic	Link Plus WTY2001	GeneralLighting, Lighting system	Light, Select	Lighting system is selector of preset scene.
Panasonic	Smart Cosmo Type LAN	DistributionPanelMeter	Sensor
Rinnai	Hot water systems (ECHONETLite enabled models)		Sensor, Switch, Input	Input entity to configure Hot Water Timers can be configured by using a template and a Service Call.
Koizumi	Lighting system AE50264E bridge	LightingSystem	Light, Sensor	https://www.koizumi-lt.co.jp/product/jyutaku/tree/
Daikin	ECHONETLite enabled HVAC models.	HomeAirConditioner	Climate, Sensor, Select
OMRON	Home Solar Power Generation		Switch, Sensor	Full support for Home Assistant Energy Dashboard including solar production and grid consumption.
JDM Electric Meters	Low voltage smart meter (B route service)		Sensor	Require Wi-SUN <-> Ethernet/Wifi bridge. nao-pon/python-echonet-lite
Noritz	Bathtub and floor heating system	HotWaterGenerator	Sensor, Switch
KDK	ECHONETLite enabled Ceiling Fans	CeilingFan, GeneralLighting	Fan, Light, Sensor	Rebranded Panasonic Ceiling Fan.
Sony	'MoekadenRoom' ECHONETLite Simulator		Climate, Select, Switch, Sensor	https://github.com/SonyCSL/MoekadenRoom.

Mitsubishi MAC-568IF-E WiFi Adaptor connected to the following systems:
- GE Series
  - MSZ-GE42VAD
  - MSZ-GE24VAD
  - MSZ-GL71VGD
  - MSZ-GL50VGD
  - MSZ-GL35VGD
  - MSZ-GL25VGD
- AP Series
  - MSZ-AP22VGD
  - MSZ-AP25VGD
  - MSZ-AP50VGD
- LN Series
  - MSZ-LN25VG2
  - MSZ-LN35VG2
  - MSZ-LN50VG2
- Ducted
  - PEA-M100GAA
  - PEA-M100HAA
  - PEA-RP140GAA
- Bulkhead
  - SEZ-M71DA
Mitsubishi MAC-578IF2-E WiFi Adaptor connected to the following systems:
- AP Series
  - MSZ-AP22VGD
  - MSZ-AP35VGD
  - MSZ-AP50VGD
- Ducted
  - PEAD-RP71
Mitsubishi MAC-588IF-E WiFi Adaptor connected to the following systems:
- Ducted
  - PEA-M200LAA
Mitsubishi MAC-600IF WiFi Adaptor connected to the following systems:
- Z Series
  - MSZ-ZW4022S
Mitsubishi HM-W002-AC WiFi Adaptor connected to the following systems:
- JXV Series
  - MSZ-JXV4018S
Mitsubishi REF-WLAN001 WiFi Adaptor connected to the following systems:
- Refrigerator
  - MR-WZ55H

Installation - Enable ECHONET protocol

This Custom Component was originally designed for the Mitsubishi MAC-568IF-E WiFi Adaptor, a basic guide for enabling ECHONETlite is provided below.

From the official Mitsubishi AU/NZ Wifi App, you will need to enable the 'ECHONET lite' protocol under the 'edit unit' settings.

Note that the proprietary Mitsubishi app (MELCloud/MELView/Kumo Cloud) controls some models in single ˚F or half ˚C, but ECHONET works in whole ˚C.

Many other products will work using this custom-component, but they must correctly support the 'ECHONET lite' protocol. The author cannot assist with enabling ECHONET Lite for other vendor products.

Home Network

If you have a firewall, ensure port 3610 is unblocked

(EchoNet Specifications)

Installation

Install using HACS

Look up 'ECHONETLite Platform' in integrations
Click 'Download', leave the version be and click 'Download' again.
Restart Home Assistant

Install manually

Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
If you do not have a custom_components directory (folder) there, you need to create it.
In the custom_components directory (folder) create a new folder called echonetlite.
Download all the files from the custom_components/echonetlite/ directory (folder) in this repository.
Place the files you downloaded in the new directory (folder) you created.
Restart Home Assistant and clear your browser cache

Setup

In Home Assistant, go to Settings -> Devices & Services -> ADD INTEGRATION.
Select the 'ECHONET Lite' integration. Enter the IP address of the HVAC unit in the host field, and give the platform a name.
Platform will automatically configure any supported platforms e.g. climate, sensor, switch, fan, select.
If you have additional devices to configure then repeat step 1.

Configuring Options for Fan and swing mode settings for supported HVAC and Air Purifiers.

Once you have added the integration, you can go back to configuration -> integrations.

Under your ECHONETLite device click 'configure'.

Fine tune your required fan and swing mode settings. The integration will be able to determine what settings are supported for your system in question.

NOTE: Selecting which specific options are suitable is a 'trial and error' process as ECHONETLite does not provide a means of returning permittted values for these settings.

As soon as you configure your options and save, the settings will take effect.

Hall of Fame

Thanks Naoki Sawada for creating the switch entity, creating the custom service call framework, and a ton of other improvements. Most importantly of all he contributed the translation into 日本語.

Thanks to scumbug, lordCONAN, and xen2 for contributing some very interesting devices.

Thanks to Jason Nader for all the quality of life updates to the codebase and doco.

Thanks to khcnz (Karl Chaffey) and gvs for helping refector the old code and contributing to testing.

Thanks to Dick Swart, Masaki Tagawa, Paul, khcnz, Kolodnerd, and Alfie Gerner for each contributing code updates to to the original 'mitsubishi_hass' and therefore this custom component.

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)

Thanks to Futomi Hatano for open sourcing a high quality and well documented ECHONET Lite library in Node JS that formed the basis of the 'Pychonet' library. (https://github.com/futomi/node-echonet-lite)

Thanks to all other contributers who I might have missed for raising PRs and issues which has made this little weekend project into something useful for many people.

License

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

scottyphillips/echonetlite_homeassistant