forked from project-chip/connectedhomeip
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Pull request project-chip#151: UIC-2478: Refactored documentation
Merge in WMN_TOOLS/matter from feature/UIC-2478-integrating-the-bridge-documentation-into-the-silabs-github-docs-build-guide to silabs Squashed commit of the following: commit b3b55278b471bb5d9bb7cf1cb0fd1c5d4d7797fd Author: Thomas Bowley <thomas.bowley@silabs.com> Date: Wed Oct 5 17:29:53 2022 +0200 UIC-2478+UIC-2479: Refactored documentation for Unify Matter Bridge
- Loading branch information
1 parent
0a991d6
commit f784dea
Showing
6 changed files
with
257 additions
and
170 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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,43 @@ | ||
# Unify Matter Bridge Overview | ||
|
||
_[The Unify Host SDK](https://github.com/SiliconLabs/UnifySDK) provides the fastest path for bridging Matter and other protocols as well as a development environment for connecting to ecosystems such as Google Home._ - [https://www.silabs.com/wireless/matter] | ||
|
||
"_The Unify Framework provides software source code and binary packages for Raspberry Pi 4 to help build an IoT gateway product. | ||
The Unify Framework enables an IoT service to control and manage end nodes in several wireless PHY radios (e.g., Z-Wave, Zigbee, and so on) supported by Silicon Labs. | ||
The Unify Framework uses the Unify Controller Language (UCL) as an internal abstraction layer to seamlessly control various end nodes that are enabled with multiple wireless PHY radios. | ||
The detailed architecture of the Unify Framework is described in the Unify Framework Specification._...<br> | ||
... | ||
_A Unify gateway consists of a Message Queuing Telemetry Transport (MQTT) broker and a number of MQTT clients. The Unify Framework uses the Mosquitto MQTT broker."_ - [https://siliconlabs.github.io/UnifySDK/doc/UnifySDK.html]. | ||
|
||
## Matter Bridge as an IoT Service | ||
|
||
The Unify Matter Bridge is an Unify IoT Service that allows for control of Unify devices from a Matter fabric. | ||
It translates Matter cluster commands and attributes accesses into the corresponding Unify MQTT publish messages. | ||
Unify node attributes are readable from the Matter Fabric, eg. in your Google Home App, as the Unify Matter Bridge also caches the state of those attributes. | ||
|
||
The Unify data model is largely based on the same data model as Matter, making the job of the Unify Matter Bridge relatively simple. | ||
There is almost a 1-1 relationship between the Matter commands and attributes and the Unify command and attributes. | ||
|
||
> **Note:** Currently there is no control going the other way, that is, the Unify Matter Bridge can not '_see_' what else is on the Matter Fabric, let alone control end devices in the Matter Fabric. | ||
See the [release notes for the Unify Matter Bridge](release_notes.md) for details on feature additions, bug fixes and known issues. | ||
|
||
## Supported Clusters/Devices | ||
|
||
The Unify Matter bridge currently supports the mapping of the following clusters/device types. | ||
|
||
| Cluster | | ||
|---------------------| | ||
| Bridged Device Info | | ||
| Group | | ||
| Identify | | ||
| Level | | ||
| OnOff | | ||
|
||
## Further Reading | ||
|
||
- [Unify Host SDK Documentation](https://siliconlabs.github.io/UnifySDK/doc/UnifySDK.html) | ||
- [Building the Matter Bridge](./readme_building.md) | ||
- [Getting Started](./readme_user.md#running-the-matter-bridge) | ||
- [Control a Z-Wave OnOff device](./readme_user.md#toggle-an-onoff-device) | ||
- [Toggle a group of OnOff devices](./readme_user.md#toggle-a-group-of-onoff-devices) |
Oops, something went wrong.