feat!: Full async networking #90

cmroche · 2024-06-30T20:40:19Z

Replaced the old send then receive approach to networking with asyncio.DatagramProtocol based classes

This removed a lot of duplicate network code as discovery was already using this approach, and allows handling on device responses when they are received as opposed to waiting on them explicitly.

BREAKING CHANGE:
While interfaces are unchanged, you can no longer expect a device response is already received when push_state_update or bind have returned.

Responses will come through their appropriate handlers once they have been received.

There may still be valid interfaces/devices that we should return

Removing old sync approach, and replacing with event driven. Should be no behavioural changes.

Broadcast is not reliably supported across OS on lo, and would fail in many cases. Unicast will still effectively exercise nearly all code, even where broadcast was expected.

Also cleaned out a duplicated test in network.py

It's going to be handled in the next update_state request.

- Bind OK - State Updates - Command Response

engrbm87 · 2024-07-02T05:25:25Z

Hell @cmroche , I have been working on making this library fully type hinted. I was about to make a PR for your review then I saw these changes. Can you let me know if this PR is ready to be merged so I can rebase and update my work.
Also we need to add support for new Gree Wifi modules running firmware 1.2.1. These use GCM encoding and I think we can incorporate this into the library in the encrypt/decrypt methods (also a new key is used). So my plan was to work on the same only after finishing the type hints.

engrbm87 · 2024-07-02T06:51:58Z

greeclimate/network.py

+        # It could be either a v1 or v2 key
+        key = GENERIC_KEY[0] if obj.get("i") == 1 else self._key


Sorry to interrupt your coding flow, but I can see that you incorporating the new KEY and encoding for new models with firmware 1.2.1. Would you mind if I through in a few suggestions. I have a new Gree AC and I would like to be able to control it using HA.

The plan is to add the GCM encryption support following this change, it's not actually implemented yet though.

To be pedantic. V1.2.1 sounds like you're referring to the hardware revision, my device reports 1.2.1 and uses the older encryption technique. We won't be able to select based on that version reported in the scan result.

V1.2.1 is the firmware version showing on Gree app.
The best approach is to try the GCM if the current encryption causes a timeout.
If both make a timeout then we raise a timeout.

Interesting... they have a weird concept of versions, but yes. Timeout approach is what I was thinking too.

That said, could you share responses from the scan and bind commands from your 1.2.1 devices please? Maybe there is something in there, I can compare with examples I have on hand.

Here is the response from the scan

{"t": "pack", "i": 1, "uid": 0, "cid": "", "tcid": "", "pack": {"t": "dev", "cid": "9424b8bb14bc", "bc": "00000000000000000000000000000000", "brand": "gree", "catalog": "gree", "mac": "9424b8bb14bc", "mid": "10001", "model": "gree", "name": "", "lock": 0, "series": "gree", "vender": "1", "ver": "V2.0.0", "ModelType": "32772", "hid": "362001065279+U-WB05RT13V1.21.bin"}}

hid is showing V1.21
When trying to bind it just timesout.

We log an exception, raising doesn't result in callers being able to do anything about it

cmroche · 2024-07-02T17:28:40Z

Hell @cmroche , I have been working on making this library fully type hinted. I was about to make a PR for your review then I saw these changes. Can you let me know if this PR is ready to be merged so I can rebase and update my work. Also we need to add support for new Gree Wifi modules running firmware 1.2.1. These use GCM encoding and I think we can incorporate this into the library in the encrypt/decrypt methods (also a new key is used). So my plan was to work on the same only after finishing the type hints.

Awesome. Been working slowly to add typehints, so will be greatly appreciated.

codecov · 2024-07-02T17:42:26Z

Codecov Report

Attention: Patch coverage is 92.89100% with 15 lines in your changes missing coverage. Please review.

Project coverage is 94.93%. Comparing base (20bd108) to head (70a6de9).

Files	Patch %	Lines
greeclimate/network.py	93.06%	7 Missing ⚠️
greeclimate/device.py	89.65%	6 Missing ⚠️
greeclimate/deviceinfo.py	94.11%	1 Missing ⚠️
greeclimate/taskable.py	95.65%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master      #90      +/-   ##
==========================================
+ Coverage   92.27%   94.93%   +2.65%     
==========================================
  Files           5        7       +2     
  Lines         686      651      -35     
==========================================
- Hits          633      618      -15     
+ Misses         53       33      -20

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

BREAKING CHANGE: API calls no longer block waiting for device response, use the add handler to listen for updates from the device.

# [2.0.0](v1.4.6...v2.0.0) (2024-07-02) ### Features * Full async networking ([#90](#90)) ([4587984](4587984)) ### BREAKING CHANGES * API calls no longer block waiting for device response, use the add handler to listen for updates from the device.

github-actions · 2024-07-02T17:53:48Z

🎉 This PR is included in version 2.0.0 🎉

The release is available on:

v2.0.0
GitHub release

Your semantic-release bot 📦🚀

cmroche · 2024-07-03T00:06:56Z

Hell @cmroche , I have been working on making this library fully type hinted. I was about to make a PR for your review then I saw these changes. Can you let me know if this PR is ready to be merged so I can rebase and update my work. Also we need to add support for new Gree Wifi modules running firmware 1.2.1. These use GCM encoding and I think we can incorporate this into the library in the encrypt/decrypt methods (also a new key is used). So my plan was to work on the same only after finishing the type hints.

I am done with the big rework. Next I will look at the GCM encryption this week but changes will be much smaller if you want to still work on the type hinting, perhaps I could get you to test it for me once it's ready as I do not have one of these devices.

cmroche added 18 commits June 29, 2024 10:08

fix: Do not propagate exceptions when scanning

7e82fb1

There may still be valid interfaces/devices that we should return

Refactor networking layer

53413e5

Removing old sync approach, and replacing with event driven. Should be no behavioural changes.

Refactor networking layer

6d8f5a5

Removing old sync approach, and replacing with event driven. Should be no behavioural changes.

Refactor networking layer

f99a005

Removing old sync approach, and replacing with event driven. Should be no behavioural changes.

Refactor networking layer

0d333d8

Removing old sync approach, and replacing with event driven. Should be no behavioural changes.

fix: Switch all tests to unicast addresses

116c3fd

Broadcast is not reliably supported across OS on lo, and would fail in many cases. Unicast will still effectively exercise nearly all code, even where broadcast was expected.

Replace all references to network.update_state

86db7ed

Replace all references to network.push_state_update

d6a7b40

Remove remainders of old network code

14a0774

Also cleaned out a duplicated test in network.py

Adding tests for message generators

60646d3

Do not auto call request_version on bind

470b42b

It's going to be handled in the next update_state request.

Bug fixes and test improvements

d6cae44

Add and remove callbacks for updates from Device

301cbf3

- Bind OK - State Updates - Command Response

fix failed test for unknown packet

6139d7c

Improvements to event callback parameters and tests

ad0ee9f

Improvements to event callback parameters and tests

4c7d6bd

Add equality for device state, and tests

f8dc08a

Adding log data for firmware and temp offset selection

4f7c2f1

engrbm87 reviewed Jul 2, 2024

View reviewed changes

cmroche added 2 commits July 2, 2024 13:18

Don't raise on connection_error

b737883

We log an exception, raising doesn't result in callers being able to do anything about it

Fix pylint error in CI

432001e

Fix py38 support

70a6de9

cmroche merged commit cfeb542 into master Jul 2, 2024
8 checks passed

cmroche deleted the persistent_datagram_streams branch July 2, 2024 17:43

cmroche added a commit that referenced this pull request Jul 2, 2024

feat: Full async networking (#90)

4587984

BREAKING CHANGE: API calls no longer block waiting for device response, use the add handler to listen for updates from the device.

github-actions bot added the released label Jul 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: Full async networking #90

feat!: Full async networking #90

cmroche commented Jun 30, 2024

engrbm87 commented Jul 2, 2024

engrbm87 Jul 2, 2024

cmroche Jul 2, 2024

engrbm87 Jul 2, 2024

cmroche Jul 3, 2024

engrbm87 Jul 3, 2024 •

edited

Loading

cmroche commented Jul 2, 2024

codecov bot commented Jul 2, 2024

github-actions bot commented Jul 2, 2024

cmroche commented Jul 3, 2024 •

edited

Loading

		# It could be either a v1 or v2 key
		key = GENERIC_KEY[0] if obj.get("i") == 1 else self._key

feat!: Full async networking #90

feat!: Full async networking #90

Conversation

cmroche commented Jun 30, 2024

engrbm87 commented Jul 2, 2024

engrbm87 Jul 2, 2024

Choose a reason for hiding this comment

cmroche Jul 2, 2024

Choose a reason for hiding this comment

engrbm87 Jul 2, 2024

Choose a reason for hiding this comment

cmroche Jul 3, 2024

Choose a reason for hiding this comment

engrbm87 Jul 3, 2024 • edited Loading

Choose a reason for hiding this comment

cmroche commented Jul 2, 2024

codecov bot commented Jul 2, 2024

Codecov Report

github-actions bot commented Jul 2, 2024

cmroche commented Jul 3, 2024 • edited Loading

engrbm87 Jul 3, 2024 •

edited

Loading

cmroche commented Jul 3, 2024 •

edited

Loading