Skip to content

Tom-Bom-badil/home-assistant_ugreen-nas

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

401 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

UGreen NAS Monitoring

Home Assistant Custom integration HACS Listing Maintenance HA Analytics

* HA Analytics: It is estimated that less than ¼ of all HA users have opted in to HA Analytics, so the actual number of installations is likely significantly higher.


🚀 Quick Overview

👉 This integration enables Home Assistant to monitor settings and operational data of a UGOS-based UGreen NAS - without modifying its operating system in any way. No extra tools/scripts are installed in UGOS, no ssh access with cryptic shell commands is needed, no difficult container setup is required - we simply use what UGOS already provides.

img1


The integration automatically retrieves access tokens from the NAS, and frequently queries operational data from the UGOS-builtin API by using those tokens (the same API that the UGOS Web GUI and the UGOS Apps are using).

A pre-made copy/paste example dashboard dynamically adapts to your specific NAS setup, giving you a ready-to-use overview within minutes.

⚙️ Setup Instructions

👉 Click here for a step-by-step installation guide on the project Wiki. In case of problems during installation, we have prepared a troubleshooting guide for you on the discussions section.

⏱️ Total setup time: ~5..10 minutes

👉 Here you can find a step-by-step guide on how to get a dashboard as shown in the screenshot. After initial installation, there is another document on the Wiki explaining how to fine-tune the premade dashboard, or how to even make your own one.

⏱️ Total dashboard copy/paste time: also ~5..10 minutes, plus some time for optional fine tuning


📝 Notes & Feedback

👉 This integration was developed using a UGreen DXP 4800+ and a UGreen DXP 480T. Other models and advanced configurations (like GPU usage in the larger models) might not fully be covered yet. If you want to help us further developing the integration towards your specific setup, please contribute to the project by posting the API response of your NAS in the Model Collection.

Contributions welcome!

💬 Start a discussion if you run into issues.
✅ If it works for you, please let us know - it's great to hear success stories.
📬 Pull requests and improvements are always appreciated!

😊 Thanks for using this integration, and for your feedback! 😊