The setup procedure shown in this repository enables Home Assistant to read data from a UGOS-based UGreen NAS. It keeps UGOS completely untouched - no additional tools will be installed on the NAS; we will just use what is already there.
The process involves two steps:
1) Obtain an individual token for authentication (the rather complicated part).
2) Configure Home Assistant for frequent data polling by utilizing the standard HA REST integration (simple).
For step 1, a dedicated shell script will take care of the complicated token generation process. You only need to input some general parameters like NAS IP or user name.
click to show/hide
When I switched from my old QNAP to the new UGreen DXP, I ran into a couple of challenges.
The first issue was migrating my VMs. After nearly 10 years of using that QNAP, I had built up a collection of virtual machines, including my entire Home Automation System with databases spanning the past decade. Initially, I couldn’t get these VMs to a functional state on the new system. After some trial-and-error (and a deeper dive into what was going wrong), I found a relatively simple solution. You can check out the details in this pinned post on the UGreen Discord.
The next hurdle was UGOS itself — it’s not exactly chatty when it comes to providing operational data like CPU utilization, memory usage etc. As QNAP has its own HA integration, I was used to views like this one:
Searching the Web for a ready-made HA solution or integration didn't get me any positives (but a lot of useful background information). So, I had to start digging myself. The outcome can be found in this GitHub Repository. It is not what I would expect of a 'professional' one-click end user solution; it isn't even nice code. But it's working, and a valid proof-of-concept.
Click here to open the detailed step-by-step instructions. Make sure to check on Known problems and limitations in the discussions section before proceeding with installation.
Everything on this Repository is still under development. My current focus is the DXP 4800 Plus. Different models will require adjustments to volumes/disk readings. Also, unit conversions + rounding are not done properly yet, some data are displayed in weird formats. I will solve all this step-by-step, e.g. by adjusting the current templates, or by adding new template sensors (your pull requests are appreciated!).
If you come across any problems, you are welcome to open a thread in the discussions section.
If you succeed, please also report back. It's always good to know if things are working as intended.
