Skip to content

Commit a101b8d

Browse files
committed
Add Grandstream Home integration documentation
1 parent 4917a9d commit a101b8d

File tree

1 file changed

+207
-0
lines changed

1 file changed

+207
-0
lines changed
Lines changed: 207 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,207 @@
1+
---
2+
title: Grandstream Home
3+
description: Instructions on how to integrate Grandstream devices with Home Assistant.
4+
ha_category:
5+
- Sensor
6+
ha_release: 2026.5
7+
ha_iot_class: Local Push
8+
ha_config_flow: true
9+
ha_codeowners:
10+
- "@GrandstreamEngineering"
11+
ha_domain: grandstream_home
12+
ha_platforms:
13+
- sensor
14+
ha_integration_type: device
15+
ha_zeroconf: true
16+
---
17+
18+
The **Grandstream Home** {% term integration %} allows you to integrate Grandstream devices with Home Assistant for monitoring. This integration supports door access control systems (GDS, GSC) and network storage devices (GNS).
19+
20+
## Supported devices
21+
22+
This integration supports the following Grandstream device types:
23+
24+
### GDS/GSC Series - Door access control systems
25+
26+
Door access control devices with SIP calling capabilities.
27+
28+
- GDS372x series devices
29+
- GSC356X series devices
30+
31+
### GNS Series - Network storage
32+
33+
Network-attached storage (NAS) devices with monitoring capabilities.
34+
35+
- GNS5004E
36+
- GNS5004R
37+
38+
### Device Model Discovery
39+
40+
The integration automatically discovers device models via mDNS/Zeroconf:
41+
42+
| Device Type | mDNS Service | Model Field | Example Models |
43+
| ----------- | -------------------------- | -------------- | ---------------- |
44+
| GDS/GSC | `_https._tcp.local.` | `product` | GDS3725, GDS3727 |
45+
| GNS | `_device-info._tcp.local.` | `product_name` | GNS5004E |
46+
47+
## Prerequisites
48+
49+
- Grandstream device connected to your local network
50+
- Device administrator credentials
51+
- Device must be accessible from your Home Assistant instance
52+
53+
{% include integrations/config_flow.md %}
54+
55+
## Configuration
56+
57+
The integration can be configured through the UI:
58+
59+
1. Go to {% my integrations title="**Settings** > **Devices & services**" %}.
60+
2. Select **Add integration**.
61+
3. Search for "Grandstream Home".
62+
4. Follow the configuration steps:
63+
- Enter the device IP address or hostname
64+
- Enter administrator credentials
65+
- (Optional) Configure custom port (default: 443 for HTTPS, 80 for HTTP)
66+
- (Optional) Configure SSL certificate verification
67+
68+
### Automatic discovery
69+
70+
The integration supports automatic device discovery via Zeroconf/mDNS. Discovered devices will appear on the {% my integrations title="**Settings** > **Devices & services**" %} page with a notification to configure them.
71+
72+
## Supported functionality
73+
74+
### Sensors
75+
76+
The integration provides various sensors depending on your device type:
77+
78+
#### GDS/GSC Devices
79+
80+
- **Device status** - Overall device status
81+
- **SIP registration status** - Registration status for each SIP account (supports multiple accounts)
82+
83+
#### GNS Devices
84+
85+
**System monitoring:**
86+
87+
- CPU usage percentage
88+
- Memory used (GB)
89+
- Memory usage percentage
90+
- System temperature
91+
- CPU temperature
92+
- System uptime (running time)
93+
94+
**Network monitoring:**
95+
96+
- Network upload speed
97+
- Network download speed
98+
99+
**Storage monitoring:**
100+
101+
- Storage pool status (one per pool)
102+
- Storage pool usage percentage (one per pool)
103+
- Disk status (one per disk)
104+
- Disk temperature (one per disk)
105+
106+
**Hardware monitoring:**
107+
108+
- Fan mode (auto, silent, performance, standard)
109+
- Fan status (one per fan)
110+
111+
## Troubleshooting
112+
113+
### Cannot connect to device
114+
115+
**Symptoms:**
116+
117+
- Configuration fails with "Cannot connect" error
118+
- Device shows as unavailable
119+
120+
**Solutions:**
121+
122+
1. Verify the device is powered on and connected to the network
123+
2. Check the IP address is correct
124+
3. Ensure your Home Assistant instance can reach the device:
125+
```bash
126+
ping <device-ip>
127+
```
128+
4. Check firewall settings on both Home Assistant and the device
129+
5. Verify the credentials are correct
130+
6. Check if you're using the correct port (default: 443 for HTTPS)
131+
7. If using HTTPS, try disabling SSL verification in the configuration
132+
133+
### Device not discovered automatically
134+
135+
**Symptoms:**
136+
137+
- Failed to discover the device
138+
139+
**Solutions:**
140+
141+
1. Ensure the device and Home Assistant are on the same network
142+
2. Check mDNS/Zeroconf is not blocked by your network
143+
3. Verify multicast traffic is allowed
144+
4. Manually add the device using the IP address
145+
146+
### Sensors not updating
147+
148+
**Symptoms:**
149+
150+
- Sensor values are stale or not updating
151+
152+
**Solutions:**
153+
154+
1. Check device is online and accessible
155+
2. Verify device firmware is up to date
156+
3. Check Home Assistant logs for errors:
157+
- Go to **Settings** > **System** > **Logs**
158+
4. Try reloading the integration:
159+
- Go to {% my integrations title="**Settings** > **Devices & services**" %}
160+
- Find "Grandstream Home"
161+
- Select the three dots {% icon "mdi:dots-vertical" %} menu
162+
- Select **Reload**
163+
164+
### Authentication errors
165+
166+
**Symptoms:**
167+
168+
- "Invalid authentication" error during setup
169+
- Device becomes unavailable with authentication errors
170+
171+
**Solutions:**
172+
173+
1. Verify your credentials and ensure the account has administrator privileges
174+
2. Confirm that the account is not locked due to excessive failed login attempts
175+
3. Reset the device password if necessary
176+
4. For GDS/GSC devices, verify Home Assistant control is enabled in device settings
177+
178+
## Known limitations
179+
180+
- Some older device firmware versions may have limited functionality
181+
- Device discovery requires mDNS/Zeroconf to be enabled on your network
182+
- Maximum of 10 concurrent device connections (practical limitation)
183+
184+
## Security considerations
185+
186+
- The integration stores credentials locally in Home Assistant's encrypted storage
187+
- Communication with devices uses HTTPS by default
188+
- SSL certificate verification can be disabled for self-signed certificates (not recommended for production)
189+
- Administrator credentials are required for full functionality
190+
- Some features require specific permissions to be enabled on the device
191+
192+
## Removing the integration
193+
194+
This integration follows standard integration removal.
195+
196+
{% include integrations/remove_device_service.md %}
197+
198+
## Support
199+
200+
For issues and feature requests:
201+
202+
- [GitHub Issues](https://github.com/home-assistant/core/issues) (for core integration)
203+
- [Home Assistant Community Forum](https://community.home-assistant.io/)
204+
205+
## See also
206+
207+
- [Grandstream official website](https://www.grandstream.com/)

0 commit comments

Comments
 (0)