Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New actively maintained integration! Collaborators welcome! Details inside. #185

Open
dotvezz opened this issue Mar 14, 2023 · 8 comments
Open

Comments

@dotvezz
Copy link

dotvezz commented Mar 14, 2023

What Happened?

I've created a new Github organization, The libdyson Working Group and published updated versions of libdyson, ha-dyson, and ha-dyson-cloud. The new forks are actively maintained, and I would be excited to talk with any contributors about joining the organization.

I'm currently working on merging all the commits from Pull Requests, then I'll address all the Issues. There are a few conflicts in the Pull Requests regarding newer devices (Formaldehyde fans/heaters, Humidifiers, and refreshes like the HP07 refresh of the HP04). For the time being, Formaldehyde models are the next on my list of things to tackle.

How can I help?

Anyone interested in helping, even if it's just reviewing and merging Pull Requests, please let me know here in this thread, or via email (ben+libdyson@vez.email)!

Why Fork?

I'm really grateful to @shenxn for their dedication to the project over the years. Sadly, they've been pretty quiet for the past 4~5 months and the integration has started breaking for some people, especially people using new unsupported devices. Eventually, it seemed appropriate to talk about making a community fork to keep things moving.

I especially want to make sure there's at least two people who can merge Pull Requests. This isn't the biggest repo in the world, but it is used by people and gives us some really nice features that are otherwise impossible to access. So I want to make sure all of us continue to have that.

What are the goals?

Primarily, just to keep this working and maintained. I'd personally like to make the integrations and library easier to use, and I'm open to any kind of improvements that the community might have - PR's welcome! Other than that, my short term goals over the next few days are:

  1. Finish merging all the PR's from the past few months to add support for new devices, features for vacuums. This is partially complete right now.
  2. Done Get Formaldehyde, Humidifier, and other new models working and reporting the correct information.
    • There are some PRs, but Dyson is being weird and giving different models the same Device ID's which confuses the logic of libdyson right now.
  3. Done: Work with Github support to remove the Fork status so that the new repos can have their own dedicated Issues tracker.
  4. Get some more members on the working group to ensure PRs get merged quickly and updates happen.
  5. Try my best to help people get migrated if they need to.

How do I switch from @shenxn's repos to the new repos?

Experimental no-reconfiguration swap

I haven't tested this method very much, but in my experiments it seems possible to switch over with zero impact to your current integration configuration, entities/devices, or dashboards. I don't know what side-effects it may have though (leftover old config data might start causing issues or something - no guarantees).

  1. Remove the ha-dyson and ha-dyson-cloud custom repositories from HACS
    • Without removing the integrations themselves.
  2. Add the new ha-dyson and ha-dyson-cloud custom repositories
    • The ha-dyson-cloud repository is only necessary if you already use it, or are intending to use its features. It is not required, but currently, it makes setting up new devices like HP07 (527K) much simpler.
  3. Update the ha-dyson and ha-dyson-cloud repositories using the HACS updater

Proven some-reconfiguration swap

This is proven to work without any side effects. If you used the default IDs for the entities and devices, then you'll just need to re-configure the devices but your dashboards will not need updating.

  1. Remove the Dyson Local and Dyson Cloud integrations from your /config/integrations page.
  2. Remove the Dyson Local and Dyson Cloud integrations from your /hacs/integrations page.
  3. Remove the dyson-ha and dyson-ha-cloud custom repositories from HACS
  4. Add the new dyson-ha and dyson-ha-cloud custom repositories
    • The libdyson-ha-cloud repository is only necessary if you already use it, or are intending to use its features. It is not required, but currently, it makes setting up new devices like HP07 (527K) much simpler.
  5. Update the dyson-ha and dyson-ha-cloud repositories

That should be it! But if you have any issues doing this, please share: https://github.com/libdyson-wg/ha-dyson/issues

@M-Stege
Copy link

M-Stege commented Mar 21, 2023

what do i have to enter in the "credential" field

@niemtec
Copy link

niemtec commented Apr 8, 2023

Really great news to see this getting some attention!

@dotvezz
Copy link
Author

dotvezz commented May 1, 2023

If anyone's curious: Formaldehyde devices and the weird login issues have both been addressed in the fork!

@codyc1515
Copy link

Hi @dotvezz. Thank you for the taking the initative on this - it is great to see some action! I am interested to support you with merging PRs, etc., if required. Let me know.

@dotvezz
Copy link
Author

dotvezz commented Jul 6, 2023

@codyc1515 hey, sorry somehow I didn't get notified of your comment! Your support would be more than welcome! Feel free to get in touch with me directly via email (ben+libdyson@vez.email) or just start threads on any of the projects in https://github.com/libdyson-wg.

If you'd like to join the organization so I can finally have someone to review my pull requests, that'd be awesome too!

@dotvezz dotvezz closed this as completed Jul 6, 2023
@dotvezz dotvezz reopened this Jul 6, 2023
@Paul-McNeice
Copy link

Hi @dotvezz, I'm VERY new to HA (I installed it for the first time yesterday!) but I worked at Dyson on the DysonLink app (now MyDyson) for 5 years as an Android developer, so I'm very familiar with the Dyson cloud and how these machines work and communicate.

I know nothing about making HA add ons, but I'd be happy to help if you have questions about how the machines work - especially the robots!

@dotvezz
Copy link
Author

dotvezz commented Aug 3, 2023

@Paul-McNeice nice to meet you, this is an awesome opportunity to improve our functionality. Please do send me an email (ben+libdyson@vez.email), I have lots of little nagging questions I'd like your input on!

@bleugray
Copy link

bleugray commented Aug 6, 2023

just wanted to say thanks so much for all taking this on and also merging of the local and cloud!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants