ha-mycloud

Home Assistant integration for Western Digital My Cloud NAS devices.

This integration is powered by the wdnas-client Python library, which handles all communication with the NAS.

---

Features

• System Status: Monitor CPU and memory usage of your My Cloud device.
• Device Information: See key details like serial number, name, and firmware version.
• Disk Information: See key details about disks, including their health status.
• Volume Information: View all volumes size, encryption status and more.

---

Installation

HACS (Recommended)

1. Add this repository in HACS.
2. Search for "WD My Cloud" and install the integration.
3. Restart Home Assistant.

Manual

1. Copy the custom_components/mycloud folder into your Home Assistant custom_components directory.
2. Restart Home Assistant.

---

Configuration

Important

The Admin account can only be active in one place at a time (either the NAS Web UI or this integration).

1. Go to Settings > Devices & Services.
2. Click Add Integration and search for "WD My Cloud".
3. Enter your device's IP address or hostname (e.g., 192.168.1.10 or wdmycloud). Do not include http:// or https://.
4. Enter your username and password (Must be an admin account)
5. Select NAS software version (Currently 2 or 5 are supported)

---

Supported Devices & Contributing

This integration currently supports V2 and V5 firmware. You can see a list of tested models in the client library's documentation:

• View Known Supported Models

Want to add your device?

If your model isn't on the list, or if you have a different firmware version, I'd love to add support for it. Please open a GitHub Issue and we can work together to get it added.

---

Example

---

Entities

This integration provides the following entities. [disk_name] and [volume_name] will be replaced by the actual names found on your device.

Sensors

• CPU Usage: sensor.wd_my_cloud_cpu_usage
• Memory Usage: sensor.wd_my_cloud_memory_usage
• Total Storage: sensor.wd_my_cloud_total_storage
• Used Storage: sensor.wd_my_cloud_used_storage
• Unused Storage: sensor.wd_my_cloud_unused_storage
• Disk Temperature: sensor.wd_my_cloud_disk_[disk_name]_temperature
• Disk Size: sensor.wd_my_cloud_disk_[disk_name]_size
• Volume Size: sensor.wd_my_cloud_volume_[volume_name]_size

Binary Sensors

• Disk Healthy: binary_sensor.wd_my_cloud_disk_[disk_name]_healthy
• Disk Sleeping: binary_sensor.wd_my_cloud_disk_[disk_name]_sleeping
• Disk Failed: binary_sensor.wd_my_cloud_disk_[disk_name]_failed
• Disk Over Temperature: binary_sensor.wd_my_cloud_disk_[disk_name]_over_temperature
• Volume Mounted: binary_sensor.wd_my_cloud_volume_[volume_name]_mounted
• Volume Unlocked: binary_sensor.wd_my_cloud_volume_[volume_name]_unlocked
• Volume Encrypted: binary_sensor.wd_my_cloud_volume_[volume_name]_encrypted