# WyreStorm NetworkHD Python Client
[](https://badge.fury.io/py/wyrestorm-networkhd)
[](https://pypi.org/project/wyrestorm-networkhd/)
[](https://github.com/Matt-Hadley/wyrestorm-networkhd-py/actions)
[](https://opensource.org/licenses/MIT)
[](https://github.com/psf/black)
A Python client library for WyreStorm NetworkHD devices, providing a high-level interface for device control and
monitoring. Features **strongly typed APIs**, **async/await support**, **multiple connection types** (SSH and RS232),
**comprehensive API coverage**, **robust error handling**, and **real-time notifications**.
📖 **[View Documentation](https://matt-hadley.github.io/wyrestorm-networkhd-py/)** | 🚀 **[Quick Start](#quick-start)**
| 💻 **[API Reference](https://matt-hadley.github.io/wyrestorm-networkhd-py/reference/core/)** | 🔧
**[Troubleshooting](https://matt-hadley.github.io/wyrestorm-networkhd-py/troubleshooting/)**
## Installation
```bash
pip install wyrestorm-networkhd
# For RS232 support (optional)
pip install wyrestorm-networkhd[rs232]
```
## Quick Start
```python
import asyncio
from wyrestorm_networkhd import NetworkHDClientSSH, NHDAPI
async def main():
# Create SSH client
client = NetworkHDClientSSH(
host="192.168.1.100",
port=10022,
username="wyrestorm",
password="networkhd",
ssh_host_key_policy="warn"
)
# Register notification callbacks for real-time updates
def on_device_status(notification):
print(f"Device {notification.device} is {'online' if notification.online else 'offline'}")
def on_cec_data(notification):
print(f"CEC data from {notification.device}: {notification.cec_data}")
client.register_notification_callback("endpoint", on_device_status)
client.register_notification_callback("cecinfo", on_cec_data)
# Use async context manager for automatic connection handling
async with client:
# Create API wrapper for organized command access
api = NHDAPI(client)
# Execute commands and get typed responses
device_list = await api.api_query.config_get_devicelist()
matrix_info = await api.api_query.matrix_get()
# Query device information with typed responses
devices = await api.api_query.config_get_device_info()
for device in devices:
print(f"Device {device.aliasname} ({device.name}) - IP: {device.ip4addr}")
# Query device status with typed responses
status_list = await api.api_query.config_get_device_status()
for status in status_list:
print(f"Device {status.aliasname} - HDMI out: {status.hdmi_out_active}")
await api.video_wall.scene_active("office", "splitmode")
# Real-time notifications are automatically handled in the background
# Run the async function
asyncio.run(main())
```
## 📚 Documentation
**🌐 [Complete Documentation](https://matt-hadley.github.io/wyrestorm-networkhd-py/)**
- **[Getting Started](https://matt-hadley.github.io/wyrestorm-networkhd-py/)**: Installation, configuration, and usage
examples
- **[API Reference](https://matt-hadley.github.io/wyrestorm-networkhd-py/reference/core/)**: Complete API documentation
with type hints
- **[Core Components](https://matt-hadley.github.io/wyrestorm-networkhd-py/reference/core/)**: Client classes and
connection management
- **[Commands](https://matt-hadley.github.io/wyrestorm-networkhd-py/reference/commands/)**: All command modules and
methods
- **[Models](https://matt-hadley.github.io/wyrestorm-networkhd-py/reference/models/)**: Data models and response
structures
- **[Resources](https://matt-hadley.github.io/wyrestorm-networkhd-py/resources/)**: NetworkHD raw API documentation
- **[Troubleshooting](https://matt-hadley.github.io/wyrestorm-networkhd-py/troubleshooting/)**: Common issues and
solutions
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "wyrestorm-networkhd",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "wyrestorm, networkhd, api, matrix, switching, video, wall, multiview, hdmi, av, control",
"author": null,
"author_email": "Matt-Hadley <81762940+Matt-Hadley@users.noreply.github.com>",
"download_url": null,
"platform": null,
"description": "# WyreStorm NetworkHD Python Client\n\n[](https://badge.fury.io/py/wyrestorm-networkhd)\n[](https://pypi.org/project/wyrestorm-networkhd/)\n[](https://github.com/Matt-Hadley/wyrestorm-networkhd-py/actions)\n[](https://opensource.org/licenses/MIT)\n[](https://github.com/psf/black)\n\nA Python client library for WyreStorm NetworkHD devices, providing a high-level interface for device control and\nmonitoring. Features **strongly typed APIs**, **async/await support**, **multiple connection types** (SSH and RS232),\n**comprehensive API coverage**, **robust error handling**, and **real-time notifications**.\n\n\ud83d\udcd6 **[View Documentation](https://matt-hadley.github.io/wyrestorm-networkhd-py/)** | \ud83d\ude80 **[Quick Start](#quick-start)**\n| \ud83d\udcbb **[API Reference](https://matt-hadley.github.io/wyrestorm-networkhd-py/reference/core/)** | \ud83d\udd27\n**[Troubleshooting](https://matt-hadley.github.io/wyrestorm-networkhd-py/troubleshooting/)**\n\n## Installation\n\n```bash\npip install wyrestorm-networkhd\n\n# For RS232 support (optional)\npip install wyrestorm-networkhd[rs232]\n```\n\n## Quick Start\n\n```python\nimport asyncio\nfrom wyrestorm_networkhd import NetworkHDClientSSH, NHDAPI\n\nasync def main():\n # Create SSH client\n client = NetworkHDClientSSH(\n host=\"192.168.1.100\",\n port=10022,\n username=\"wyrestorm\",\n password=\"networkhd\",\n ssh_host_key_policy=\"warn\"\n )\n\n # Register notification callbacks for real-time updates\n def on_device_status(notification):\n print(f\"Device {notification.device} is {'online' if notification.online else 'offline'}\")\n\n def on_cec_data(notification):\n print(f\"CEC data from {notification.device}: {notification.cec_data}\")\n\n client.register_notification_callback(\"endpoint\", on_device_status)\n client.register_notification_callback(\"cecinfo\", on_cec_data)\n\n # Use async context manager for automatic connection handling\n async with client:\n # Create API wrapper for organized command access\n api = NHDAPI(client)\n\n # Execute commands and get typed responses\n device_list = await api.api_query.config_get_devicelist()\n matrix_info = await api.api_query.matrix_get()\n\n # Query device information with typed responses\n devices = await api.api_query.config_get_device_info()\n for device in devices:\n print(f\"Device {device.aliasname} ({device.name}) - IP: {device.ip4addr}\")\n\n # Query device status with typed responses\n status_list = await api.api_query.config_get_device_status()\n for status in status_list:\n print(f\"Device {status.aliasname} - HDMI out: {status.hdmi_out_active}\")\n await api.video_wall.scene_active(\"office\", \"splitmode\")\n\n # Real-time notifications are automatically handled in the background\n\n# Run the async function\nasyncio.run(main())\n```\n\n## \ud83d\udcda Documentation\n\n**\ud83c\udf10 [Complete Documentation](https://matt-hadley.github.io/wyrestorm-networkhd-py/)**\n\n- **[Getting Started](https://matt-hadley.github.io/wyrestorm-networkhd-py/)**: Installation, configuration, and usage\n examples\n- **[API Reference](https://matt-hadley.github.io/wyrestorm-networkhd-py/reference/core/)**: Complete API documentation\n with type hints\n- **[Core Components](https://matt-hadley.github.io/wyrestorm-networkhd-py/reference/core/)**: Client classes and\n connection management\n- **[Commands](https://matt-hadley.github.io/wyrestorm-networkhd-py/reference/commands/)**: All command modules and\n methods\n- **[Models](https://matt-hadley.github.io/wyrestorm-networkhd-py/reference/models/)**: Data models and response\n structures\n- **[Resources](https://matt-hadley.github.io/wyrestorm-networkhd-py/resources/)**: NetworkHD raw API documentation\n- **[Troubleshooting](https://matt-hadley.github.io/wyrestorm-networkhd-py/troubleshooting/)**: Common issues and\n solutions\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n",
"bugtrack_url": null,
"license": null,
"summary": "Python client library for WyreStorm NetworkHD API operations - matrix switching, device control, video walls, and multiview.",
"version": "2.0.1",
"project_urls": {
"Changelog": "https://matt-hadley.github.io/wyrestorm-networkhd-py/changelog/",
"Documentation": "https://matt-hadley.github.io/wyrestorm-networkhd-py/",
"Homepage": "https://github.com/Matt-Hadley/wyrestorm-networkhd-py",
"Issues": "https://github.com/Matt-Hadley/wyrestorm-networkhd-py/issues",
"Repository": "https://github.com/Matt-Hadley/wyrestorm-networkhd-py.git"
},
"split_keywords": [
"wyrestorm",
" networkhd",
" api",
" matrix",
" switching",
" video",
" wall",
" multiview",
" hdmi",
" av",
" control"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1eaa1a89955197e85e6df75f5c44f459b21a1c53ca38ddc4f7500d2e7e07b787",
"md5": "aeee13808a8836307241e844c4d2774e",
"sha256": "ca9def822b0f57da3c3c9e1724bf50474072689c6b8b1b4ba5ee429836ede99d"
},
"downloads": -1,
"filename": "wyrestorm_networkhd-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aeee13808a8836307241e844c4d2774e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 63041,
"upload_time": "2025-08-29T16:25:20",
"upload_time_iso_8601": "2025-08-29T16:25:20.183732Z",
"url": "https://files.pythonhosted.org/packages/1e/aa/1a89955197e85e6df75f5c44f459b21a1c53ca38ddc4f7500d2e7e07b787/wyrestorm_networkhd-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-29 16:25:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Matt-Hadley",
"github_project": "wyrestorm-networkhd-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "wyrestorm-networkhd"
}
JSON
