-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Add Grandstream Home integration documentation #44819
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
Open
wtxu-gs
wants to merge
25
commits into
home-assistant:next
Choose a base branch
from
wtxu-gs:feat/grandstream_home
base: next
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 20 commits
Commits
Show all changes
25 commits
Select commit
Hold shift + click to select a range
b8ffe57
Add Grandstream Home integration documentation
wtxu-gs f1f3af2
Update source/_integrations/grandstream_home.markdown
wtxu-gs 563279c
Update source/_integrations/grandstream_home.markdown
wtxu-gs 6d70e58
Update source/_integrations/grandstream_home.markdown
wtxu-gs 08a3b08
Update source/_integrations/grandstream_home.markdown
wtxu-gs ac31912
Update source/_integrations/grandstream_home.markdown
wtxu-gs eb5c248
Apply review feedback: add periods to troubleshooting steps and bold …
wtxu-gs a923d46
Update source/_integrations/grandstream_home.markdown
wtxu-gs cf929bb
Update source/_integrations/grandstream_home.markdown
wtxu-gs 91bc1f3
Update source/_integrations/grandstream_home.markdown
wtxu-gs 03f4b8f
Update source/_integrations/grandstream_home.markdown
wtxu-gs 986ca6c
Update source/_integrations/grandstream_home.markdown
wtxu-gs d8cd94c
Update source/_integrations/grandstream_home.markdown
wtxu-gs a3db53e
Update source/_integrations/grandstream_home.markdown
wtxu-gs 4b8ff32
Update source/_integrations/grandstream_home.markdown
wtxu-gs 5a51ecd
Update source/_integrations/grandstream_home.markdown
wtxu-gs f996b67
Update source/_integrations/grandstream_home.markdown
wtxu-gs b42d0cb
Update source/_integrations/grandstream_home.markdown
wtxu-gs a0a0dd7
Update source/_integrations/grandstream_home.markdown
wtxu-gs 4e75ced
Fix documentation style: convert bold labels to subheadings and updat…
wtxu-gs 1f1358a
Update source/_integrations/grandstream_home.markdown
wtxu-gs 3076e2c
Update source/_integrations/grandstream_home.markdown
wtxu-gs 05940b7
Update source/_integrations/grandstream_home.markdown
wtxu-gs 0b08ba8
Update source/_integrations/grandstream_home.markdown
wtxu-gs 8eb15c4
Update source/_integrations/grandstream_home.markdown
wtxu-gs File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,173 @@ | ||
| --- | ||
| title: Grandstream Home | ||
| description: Instructions on how to integrate Grandstream devices with Home Assistant. | ||
| ha_category: | ||
| - Sensor | ||
| ha_release: 2026.5 | ||
| ha_iot_class: Local Push | ||
| ha_config_flow: true | ||
| ha_codeowners: | ||
| - "@wtxu-gs" | ||
| ha_domain: grandstream_home | ||
| ha_platforms: | ||
| - sensor | ||
| ha_integration_type: device | ||
| ha_zeroconf: true | ||
| --- | ||
|
|
||
| The **Grandstream Home** {% term integration %} allows you to integrate Grandstream devices with Home Assistant for monitoring. This integration supports door access control systems (GDS372X, GSC356X). | ||
|
wtxu-gs marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## Supported devices | ||
|
|
||
| This integration supports the following Grandstream device types: | ||
|
|
||
| ### GDS/GSC series - door access control systems | ||
|
|
||
| Door access control devices with SIP calling capabilities. | ||
|
|
||
| - GDS372x series devices | ||
| - GSC356X series devices | ||
|
|
||
| ### Device model discovery | ||
|
|
||
| The integration automatically discovers device models via mDNS/Zeroconf: | ||
|
|
||
| - GDS | ||
| - mDNS service: `_https._tcp.local.` | ||
| - Example name: `gds_001122334455` | ||
| - GSC | ||
| - mDNS service: `_https._tcp.local.` | ||
| - Example name: `gsc_001122334455` | ||
|
|
||
| Device names follow the format: `{device_type}_{mac_address}`. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Grandstream device connected to your local network | ||
| - Device administrator credentials for the `gdsha` account | ||
| - Device must be accessible from your Home Assistant instance | ||
| - Home Assistant control must be enabled on the device (for GDS/GSC devices) | ||
|
wtxu-gs marked this conversation as resolved.
wtxu-gs marked this conversation as resolved.
|
||
|
|
||
|
wtxu-gs marked this conversation as resolved.
Outdated
|
||
| {% include integrations/config_flow.md %} | ||
|
|
||
| ## Configuration | ||
|
|
||
| The integration can be configured through the UI: | ||
|
|
||
| 1. Go to {% my integrations title="**Settings** > **Devices & services**" %}. | ||
| 2. Select **Add integration**. | ||
| 3. Search for **Grandstream Home**. | ||
| 4. Follow the configuration steps: | ||
| - Enter the device IP address or hostname | ||
| - Enter the device name | ||
| 5. On the authentication screen: | ||
| - Enter administrator password (username is fixed to `gdsha`) | ||
| - (Optional) Configure custom port (default: 443 for HTTPS) | ||
|
wtxu-gs marked this conversation as resolved.
Outdated
|
||
| - (Optional) Disable SSL certificate verification (for self-signed certificates) | ||
|
wtxu-gs marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### Automatic discovery | ||
|
|
||
| The integration supports automatic device discovery via mDNS/Zeroconf. Discovered devices will appear on the {% my integrations title="**Settings** > **Devices & services**" %} page with a notification to configure them. | ||
|
|
||
| ## Supported functionality | ||
|
|
||
| ### Sensors | ||
|
|
||
| The integration provides the following sensor entity: | ||
|
|
||
| #### GDS/GSC devices | ||
|
|
||
| - **Device status** - Overall device status showing: | ||
| - `online` - Device is connected and responding | ||
| - `offline` - Device is not reachable | ||
| - `account_locked` - User account is temporarily locked | ||
| - `auth_failed` - Authentication failed | ||
| - `ha_control_disabled` - Home Assistant control is disabled on device | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### Cannot connect to device | ||
|
|
||
| #### Symptom: "Cannot connect" error during setup | ||
|
|
||
| When you set up the integration, configuration fails with a "Cannot connect" error, or the device shows as unavailable. | ||
|
|
||
| ##### Resolution | ||
|
|
||
| 1. Verify that the device is powered on and connected to the network. | ||
| 2. Check that the IP address is correct. | ||
| 3. Confirm that your Home Assistant instance can reach the device: | ||
|
|
||
| ```bash | ||
| ping <device-ip> | ||
|
wtxu-gs marked this conversation as resolved.
wtxu-gs marked this conversation as resolved.
|
||
|
|
||
| ### Sensors not updating | ||
|
|
||
| #### Symptom: Sensor values are stale or not updating | ||
|
|
||
| ##### Resolution | ||
|
|
||
| 1. Check device is online and accessible. | ||
| 2. Verify device firmware is up to date. | ||
| 3. Check Home Assistant logs for errors: | ||
| - Go to **Settings** > **System** > **Logs**. | ||
| 4. Try reloading the integration: | ||
| - Go to {% my integrations title="**Settings** > **Devices & services**" %}. | ||
| - Find **Grandstream Home**. | ||
| - Select the three dots {% icon "mdi:dots-vertical" %} menu. | ||
| - Select **Reload**. | ||
|
|
||
| ### Authentication errors | ||
|
|
||
| #### Symptom: "Invalid authentication" error during setup | ||
|
|
||
| When you set up the integration or during normal operation, the device becomes unavailable with authentication errors. | ||
|
|
||
| ##### Resolution | ||
|
|
||
| 1. Verify the password is correct (default username: `gdsha`). | ||
| 2. Confirm that the account is not locked due to excessive failed login attempts. | ||
| 3. Reset the device password if necessary. | ||
| 4. Verify Home Assistant control is enabled in device web interface settings. | ||
|
|
||
| ### Home Assistant control disabled | ||
|
|
||
| #### Symptom: "Home Assistant control is disabled" error | ||
|
|
||
| ##### Resolution | ||
|
|
||
| 1. Log in to the device web interface. | ||
| 2. Navigate to the settings page. | ||
| 3. Enable "Home Assistant control" or "Third-party integration" option. | ||
|
wtxu-gs marked this conversation as resolved.
Outdated
|
||
| 4. Save settings and retry the integration setup. | ||
|
|
||
| ## Known limitations | ||
|
|
||
| - Only sensors are supported in the initial release. | ||
| - Device discovery requires mDNS/Zeroconf to be enabled on your network. | ||
| - Some older device firmware versions may have limited functionality. | ||
|
|
||
|
wtxu-gs marked this conversation as resolved.
|
||
| ## Security considerations | ||
|
|
||
| - The integration stores credentials locally in Home Assistant's configuration storage. Make sure you protect your backups, and limit access to your Home Assistant system. | ||
| - Communication with devices uses HTTPS by default (port 443). | ||
| - Keep SSL certificate verification enabled whenever possible. If your device uses a self-signed certificate, you can disable verification, but this reduces security and should only be used if you understand the risk. | ||
| - Administrator password is required for full functionality. | ||
| - Home Assistant control must be explicitly enabled on the device. | ||
|
|
||
| ## Removing the integration | ||
|
|
||
| This integration follows standard integration removal. | ||
|
|
||
| {% include integrations/remove_device_service.md %} | ||
|
|
||
| ## Support | ||
|
|
||
| For issues and feature requests: | ||
|
|
||
| - [GitHub Issues](https://github.com/home-assistant/core/issues) (for core integration) | ||
| - [Home Assistant Community Forum](https://community.home-assistant.io/) | ||
|
|
||
| ## See also | ||
|
|
||
| - [Grandstream official website](https://www.grandstream.com/) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.