Merge pull request #13 from scottyphillips/asynchonet

Version 2.0.13 promoted to master.

Author: scottyphillips

CHANGES.txt

@@ -12,3 +12,5 @@ v0.2, 07 June 2019 -- Fixed bug when setting fan modes 'medium-low' and 'medium-
 v0.2.1, 18 August 2019 -- Changed mode 'dehumidify' to 'dry' for HA compatibility
 v0.2.2, 24 Feb 2020 -- Minor update to stop HA crashing if no response is received.
 v0.3, 2 March 2020 -- Added in function to measure outdoor temperature
+v2.0.9, 5 Sep 2021 -- fixed up factory method and pushed updates
+v2.0.13, 13 Sep 2021 -- Bug Fixes, better doco, promote to master

LICENCE.txt

@@ -0,0 +1,33 @@
+The MIT License
+
+Copyright (c) 2018 Scott Phillips
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+- - -
+
+ECHONET Lite Device Emulator
+
+Copyright 2020 Kanagawa Institute of Technology
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

LICENSE.txt

@@ -18,6 +18,9 @@ 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 libray was rebuilt to use asyncio for better compatability with home assistant.
+
+
 It is designed to work with Python 3.9.5+
 
 ## Instructions
@@ -29,39 +32,63 @@ pip install pychonet
 ```
 
 ## Basic usage
-### Discover a list of ECHONETlite instances using:
+
+### Create the ECHONETLite listener service on port 3610:
+```python
+from aioudp 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, loop=loop)
+```
+
+### Discover a list of ECHONETlite instances on a particular server:
+```python
+await server.discover('192.168.1.6')
+```
+
+
+### Populate the propertymap for a particular ECHONETLite instance:
 ```python
-import pychonet as echonet
-echonet_instances = echonet.discover()
-print(echonet_instances)
-[{'netaddr': '192.168.1.6', 'eojgc': 1, 'eojcc': 48, 'eojci': 1, 'group': 'Air conditioner-related device group', 'code': 'Home air conditioner'}]
+await server.getAllPropertyMaps('192.168.1.6', 1, 48, 1)
 ```
+### Create a ECHONETLite device using the Factory:
 
-### Create a HVAC ECHONETlite instance
+Paramaters include the port listener, and EOJGC, EOJCC, and EOJCI codes.
 ```python
-aircon = echonet.HomeAirConditioner("192.168.1.6")
+aircon = Factory("192.168.1.6",server, 1, 48, 1)
+```
+
+### OR, create a specific ECHONETLite instance using built in objects:
+```python
+aircon = HomeAirConditioner("192.168.1.6", server)
+```
 
 ### Turn HVAC on or off:
 ```python
-aircon.on()
-aircon.off()
-aircon.getOperationalStatus()
+await aircon.on()
+await aircon.off()
+await aircon.getOperationalStatus()
 {'status': 'off'}
 ```
 
-### Set or Get a HVACs target temperature
+### Set or Get a HVACs target temperature:
 ```python
-aircon.setOperationalTemperature(25)
-aircon.getOperationalTemperature()
+await aircon.setOperationalTemperature(25)
+await aircon.getOperationalTemperature()
 {'set_temperature': 25}
 ```
 
 ### Set or Get a HVACs mode of operation:
 ```python
 supported modes =  'auto', 'cool', 'heat', 'dry', 'fan_only', 'other'
 
-aircon.setMode('cool')
-aircon.getMode()
+await aircon.setMode('cool')
+await aircon.getMode()
 {'mode': 'cool'}
 ```
 ### Set or Get a HVACs fan speed:
@@ -70,15 +97,21 @@ Note - your HVAC may not support all fan speeds.
 ```python
 supported modes = 'auto', 'minimum', 'low', 'medium-Low', 'medium', 'medium-high', 'high', 'very high', 'max'
 
-aircon.setFanSpeed('medium-high')
-aircon.getFanSpeed()
+await aircon.setFanSpeed('medium-high')
+await aircon.getFanSpeed()
 {'fan_speed': 'medium-high'}
 ```
-### Get HVAC attributes at once:
+### Get HVAC attributes at once (Note, the property map must be populated):
 ```python
-aircon.update()
+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):
+```python
+await aircon.update(0x80)
+```
+
 ## 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:

README.md

@@ -0,0 +1,14 @@
+from aioudp 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,loop=loop)
+await server.discover('192.168.1.6')
+await server.getAllPropertyMaps('192.168.1.6',1,48,1)
+device = Factory("192.168.1.6",server, 1,48,1)
+await device.update([0x80])

bin/commands

@@ -0,0 +1,44 @@
+import asyncio
+
+from aioudp import UDPServer
+from pychonet import ECHONETAPIClient as api
+
+# This example will list the properties for all discovered instances on a given host
+
+async def main():
+    udp = UDPServer()
+    loop = asyncio.get_event_loop()
+    udp.run("0.0.0.0", 3610, loop=loop)
+    server = api(server=udp, loop=loop)
+
+    host = '192.168.1.6'
+    await server.discover(host)
+
+    # Timeout after 3 seconds
+    for x in range(0, 300):
+        await asyncio.sleep(0.01)
+        if 'discovered' in list(server._state[host]):
+             print("ECHONET Node Discovery Successful!")
+             break
+
+    instance_list = []
+    state = server._state[host]
+    for eojgc in list(state['instances'].keys()):
+        for eojcc in list(state['instances'][eojgc].keys()):
+            for instance in list(state['instances'][eojgc][eojcc].keys()):
+                  print(f"instance is {instance}")
+                  await server.getAllPropertyMaps(host, eojgc, eojcc, instance)
+                  print(f"{host} - ECHONET Instance {eojgc}-{eojcc}-{instance} map attributes discovered!")
+                  getmap = state['instances'][eojgc][eojcc][instance][ENL_GETMAP]
+                  setmap = state['instances'][eojgc][eojcc][instance][ENL_SETMAP]
+
+                  await server.getIdentificationInformation(host, eojgc, eojcc, instance)
+                  uid = state['instances'][eojgc][eojcc][instance][ENL_UID]
+                  manufacturer = state['instances'][eojgc][eojcc][instance][ENL_MANUFACTURER]
+                  print(f"{host} - ECHONET Instance {eojgc}-{eojcc}-{instance} Identification number discovered!")
+                  instance_list.append({"host":host,"eojgc":eojgc,"eojcc":eojcc,"eojci":instance,"getmap":getmap,"setmap":setmap,"uid":uid,"manufacturer":manufacturer})
+
+        print(instance_list)
+
+if __name__ == "__main__":
+    asyncio.run(main())