Skip to main content
Yanked

This release has been yanked by its maintainers, and will be ignored by installers, except when explicitly specified.
Consider using release 2.8.2 instead.
Reason given by maintainers: not suitable for prod

Pychonet

GitHub Release License Project Maintenance

A library for interfacing with the ECHONETlite protocol as commonly used in Japan. Useful for interfacing to many interesting devices such as HVACs, light systems, electric car chargers, rice cookers (not joking), and solar systems that support ECHONETLite.

The current functionality is limited to a few ECHONETLite classes, notably HVAC but it can easily be extended to any ECHONETlite classes required.

The basic boilerplate EchoNetInstance class can be used to provide raw connectivity to any compatible device but it is up to the developer to create useful classes. Any ECHONETlite class additions to the library are welcome.

Version 2.0.0 of this library was rebuilt to use asyncio for better compatability with home assistant.

It is designed to work with Python 3.9.5+

Instructions

Simplest way to install is to use pip:

pip install pychonet

Basic usage

Create the ECHONETLite listener service on port 3610:

from pychonet.lib.udpserver import UDPServer
from pychonet import Factory
from pychonet import ECHONETAPIClient as api
from pychonet import HomeAirConditioner
from pychonet import EchonetInstance
udp = UDPServer()
loop = asyncio.get_event_loop()
udp.run("0.0.0.0", 3610, loop=loop)
server = api(server=udp)

Discover a list of ECHONETlite instances on a particular server:

await server.discover('192.168.1.6')

Populate the propertymap for a particular ECHONETLite instance:

await server.getAllPropertyMaps('192.168.1.6', 1, 48, 1)

Create a ECHONETLite device using the Factory:

Paramaters include the port listener, and EOJGC, EOJCC, and EOJCI codes.

aircon = Factory("192.168.1.6",server, 1, 48, 1)

OR, create a specific ECHONETLite instance using built in objects:

aircon = HomeAirConditioner("192.168.1.6", server)

Turn HVAC on or off:

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

Set or Get a HVACs target temperature:

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

Set or Get a HVACs mode of operation:

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

await aircon.setMode('cool')
await 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'

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

Get HVAC attributes at once (Note, the property map must be populated):

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

OR grab a specific attribute at once (Note, the property map must be populated):

await aircon.update(0x80)

Using this library with Home Assistant

NOTE: For Home Assistant users there is a dedicated repo that can be installed via HACS that can provide custom components for discovered ECHONETlite devices such as Mitsubishi airconditioners: (https://github.com/scottyphillips/echonetlite_homeassistant)

'example_async.py' gives you a boilerplate asyncio program that will discover your ECHONETLite instance and return information about supported services.

Hall of Fame

Big Thanks to Naoki Sawada for many excellent updates to enable push notifications via multicast. どうもありがとうございます !

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, Leonunix, and Alfie Gerner for each contributing code updates to this library.

Thanks to Jeffro Carr who inspired me to write my own native Python ECHONET library for Home Assistant.

Thanks to Futomi Hatano for open sourcing a well-documented ECHONET Lite library in Node JS. (https://github.com/futomi/node-echonet-lite)

References for ECHONET specifications

License

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

Portions of 'ECHONET Lite Device Emulator' (Copyright 2020 Kanagawa Institute of Technology) have been used in this application. This code was licensed under the MIT licence.

The UDP code is based on 'aio-udp-server' (Copyright 2021 Dmitriy Bashkirtsev) This code is licenced under the GPL licence. (https://github.com/bashkirtsevich-llc/aioudp)

Слава Україні! 🇺🇦


Metadata

Release files for pychonet 2.7.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pychonet 2.7.7
File Size Uploaded
pychonet-2.7.7.tar.gz 129.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pychonet 2.7.7
File Interpreter ABI Platform
pychonet-2.7.7-py3-none-any.whl Python 3 none any Details

Total release size: 254.0 kB

Release files / pychonet-2.7.7.tar.gz

Download URL pychonet-2.7.7.tar.gz
Size 129.3 kB
Tags Source
SHA-256 checksum
How to use checksums
6cdb231903faf736f60f730a7f4f164cd036b23f14b3e9763769200919c28d6a
BLAKE2b-256 checksum
How to use checksums
047b0350d8861d819d95916f56d8a26932a2b79a9f60f17428163902d27b12e1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.5

Release files / pychonet-2.7.7-py3-none-any.whl

Download URL pychonet-2.7.7-py3-none-any.whl
Size 124.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fcdd12b596e60380e0fdced7bf7c2a9dd96701ace7a954adc4ea020dc15cd8e2
BLAKE2b-256 checksum
How to use checksums
b90f18de3ee2b9a68f0ed51721a726c1efad2e915c1d54dc042c90f57f0b85bb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.5

Release history Release notifications | RSS feed

2.8.2

1 release file

2.8.1

2 release files

2.8.0

2 release files

2.7.14

2 release files

2.7.13

2 release files

2.7.12

2 release files

2.7.11

2 release files

2.7.10

2 release files

2.7.9

2 release files

2.7.8

2 release files

This release

2.7.7 This release

2 release files

2.7.6

2 release files

2.7.5

2 release files

2.7.4

2 release files

2.7.3

2 release files

2.7.2

2 release files

2.7.1

2 release files

2.7.0

1 release file

2.6.17

2 release files

2.6.16

2 release files

2.6.15

2 release files

2.6.12

2 release files

2.6.11

2 release files

2.6.9

2 release files

2.6.8

2 release files

2.6.7

2 release files

2.6.6

2 release files

2.6.5

2 release files

2.6.4

2 release files

2.6.3

2 release files

2.6.2

2 release files

2.6.1

2 release files

2.6.0

2 release files

2.5.2

2 release files

2.5.1

2 release files

2.5.0

2 release files

2.4.2

2 release files

2.4.1

2 release files

2.4.0

2 release files

2.3.18

2 release files

2.3.13

2 release files

2.3.10

2 release files

2.3.9

2 release files

2.3.8

2 release files

2.3.7

2 release files

2.3.6

2 release files

2.3.5

2 release files

2.3.4

2 release files

2.3.3

2 release files

2.3.2

2 release files

2.3.1

2 release files

2.3.0

2 release files

2.2.3

2 release files

2.2.2

2 release files

2.2.1

2 release files

2.2.0

2 release files

2.1.7

2 release files

2.1.6

2 release files

2.1.5

2 release files

2.1.4

2 release files

2.1.3

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.23

2 release files

2.0.20

2 release files

2.0.19

2 release files

2.0.18

2 release files

2.0.17

2 release files

2.0.16

2 release files

2.0.15

2 release files

2.0.14

2 release files

2.0.13

2 release files

2.0.9

2 release files

2.0.8

2 release files

2.0.7

2 release files

2.0.6

2 release files

1.2.3

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.10

2 release files

1.0.9

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0

3 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page