Skip to content

Commit

Permalink
Add documentation from xml into IDL files (#25909)
Browse files Browse the repository at this point in the history
* Add documentation from xml into IDL files

* Remove an extra newline
  • Loading branch information
andy31415 authored and pull[bot] committed Apr 17, 2024
1 parent 4139624 commit ecb65ee
Show file tree
Hide file tree
Showing 52 changed files with 2,528 additions and 4 deletions.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

45 changes: 45 additions & 0 deletions examples/bridge-app/bridge-common/bridge-app.matter
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// This IDL was generated automatically by ZAP.
// It is for view/code review purposes only.

/** Attributes and commands for putting a device into Identification mode (e.g. flashing a light). */
server cluster Identify = 3 {
enum IdentifyEffectIdentifier : ENUM8 {
kBlink = 0;
Expand Down Expand Up @@ -46,6 +47,7 @@ server cluster Identify = 3 {
command access(invoke: manage) TriggerEffect(TriggerEffectRequest): DefaultSuccess = 64;
}

/** Attributes and commands for switching devices between 'On' and 'Off' states. */
server cluster OnOff = 6 {
enum OnOffDelayedAllOffEffectVariant : ENUM8 {
kFadeToOffIn0p8Seconds = 0;
Expand Down Expand Up @@ -89,6 +91,7 @@ server cluster OnOff = 6 {
command Toggle(): DefaultSuccess = 2;
}

/** Attributes and commands for controlling devices that can be set to a level between fully 'On' and fully 'Off.' */
server cluster LevelControl = 8 {
enum MoveMode : ENUM8 {
kUp = 0;
Expand Down Expand Up @@ -196,6 +199,7 @@ server cluster LevelControl = 8 {
command StopWithOnOff(StopWithOnOffRequest): DefaultSuccess = 7;
}

/** The Descriptor Cluster is meant to replace the support from the Zigbee Device Object (ZDO) for describing a node, its endpoints and clusters. */
server cluster Descriptor = 29 {
struct DeviceTypeStruct {
devtype_id deviceType = 0;
Expand All @@ -214,6 +218,7 @@ server cluster Descriptor = 29 {
readonly attribute int16u clusterRevision = 65533;
}

/** The Binding Cluster is meant to replace the support from the Zigbee Device Object (ZDO) for supporting the binding table. */
client cluster Binding = 30 {
fabric_scoped struct TargetStruct {
optional node_id node = 1;
Expand All @@ -232,6 +237,10 @@ client cluster Binding = 30 {
readonly attribute int16u clusterRevision = 65533;
}

/** The Access Control Cluster exposes a data model view of a
Node's Access Control List (ACL), which codifies the rules used to manage
and enforce Access Control for the Node's endpoints and their associated
cluster instances. */
client cluster AccessControl = 31 {
enum AccessControlEntryAuthModeEnum : ENUM8 {
kPase = 1;
Expand Down Expand Up @@ -301,6 +310,10 @@ client cluster AccessControl = 31 {
readonly attribute int16u clusterRevision = 65533;
}

/** The Access Control Cluster exposes a data model view of a
Node's Access Control List (ACL), which codifies the rules used to manage
and enforce Access Control for the Node's endpoints and their associated
cluster instances. */
server cluster AccessControl = 31 {
enum AccessControlEntryAuthModeEnum : ENUM8 {
kPase = 1;
Expand Down Expand Up @@ -370,6 +383,7 @@ server cluster AccessControl = 31 {
readonly attribute int16u clusterRevision = 65533;
}

/** This cluster provides a standardized way for a Node (typically a Bridge, but could be any Node) to expose action information. */
server cluster Actions = 37 {
enum ActionErrorEnum : ENUM8 {
kUnknown = 0;
Expand Down Expand Up @@ -461,6 +475,9 @@ server cluster Actions = 37 {
command InstantAction(InstantActionRequest): DefaultSuccess = 0;
}

/** This cluster provides attributes and events for determining basic information about Nodes, which supports both
Commissioning and operational determination of Node characteristics, such as Vendor ID, Product ID and serial number,
which apply to the whole Node. Also allows setting user device information such as location. */
server cluster BasicInformation = 40 {
struct CapabilityMinimaStruct {
int16u caseSessionsPerFabric = 0;
Expand Down Expand Up @@ -510,6 +527,10 @@ server cluster BasicInformation = 40 {
readonly attribute int16u clusterRevision = 65533;
}

/** Nodes should be expected to be deployed to any and all regions of the world. These global regions
may have differing common languages, units of measurements, and numerical formatting
standards. As such, Nodes that visually or audibly convey information need a mechanism by which
they can be configured to use a user’s preferred language, units, etc */
server cluster LocalizationConfiguration = 43 {
attribute char_string<35> activeLocale = 0;
readonly attribute CHAR_STRING supportedLocales[] = 1;
Expand All @@ -521,6 +542,10 @@ server cluster LocalizationConfiguration = 43 {
readonly attribute int16u clusterRevision = 65533;
}

/** Nodes should be expected to be deployed to any and all regions of the world. These global regions
may have differing preferences for how dates and times are conveyed. As such, Nodes that visually
or audibly convey time information need a mechanism by which they can be configured to use a
user’s preferred format. */
server cluster TimeFormatLocalization = 44 {
enum CalendarTypeEnum : ENUM8 {
kBuddhist = 0;
Expand Down Expand Up @@ -553,6 +578,10 @@ server cluster TimeFormatLocalization = 44 {
readonly attribute int16u clusterRevision = 65533;
}

/** Nodes should be expected to be deployed to any and all regions of the world. These global regions
may have differing preferences for the units in which values are conveyed in communication to a
user. As such, Nodes that visually or audibly convey measurable values to the user need a
mechanism by which they can be configured to use a user’s preferred unit. */
server cluster UnitLocalization = 45 {
enum TempUnitEnum : ENUM8 {
kFahrenheit = 0;
Expand All @@ -573,6 +602,7 @@ server cluster UnitLocalization = 45 {
readonly attribute int16u clusterRevision = 65533;
}

/** This cluster is used to manage global aspects of the Commissioning flow. */
server cluster GeneralCommissioning = 48 {
enum CommissioningError : ENUM8 {
kOk = 0;
Expand Down Expand Up @@ -636,6 +666,7 @@ server cluster GeneralCommissioning = 48 {
fabric command access(invoke: administer) CommissioningComplete(): CommissioningCompleteResponse = 4;
}

/** Functionality to configure, enable, disable network credentials and access on a Matter device. */
server cluster NetworkCommissioning = 49 {
enum NetworkCommissioningStatus : ENUM8 {
kSuccess = 0;
Expand Down Expand Up @@ -774,6 +805,7 @@ server cluster NetworkCommissioning = 49 {
command access(invoke: administer) ReorderNetwork(ReorderNetworkRequest): NetworkConfigResponse = 8;
}

/** The cluster provides commands for retrieving unstructured diagnostic logs from a Node that may be used to aid in diagnostics. */
server cluster DiagnosticLogs = 50 {
enum IntentEnum : ENUM8 {
kEndUserSupport = 0;
Expand Down Expand Up @@ -810,6 +842,7 @@ server cluster DiagnosticLogs = 50 {
command RetrieveLogsRequest(RetrieveLogsRequestRequest): RetrieveLogsResponse = 0;
}

/** The General Diagnostics Cluster, along with other diagnostics clusters, provide a means to acquire standardized diagnostics metrics that MAY be used by a Node to assist a user or Administrative Node in diagnosing potential problems. */
server cluster GeneralDiagnostics = 51 {
enum BootReasonEnum : ENUM8 {
kUnspecified = 0;
Expand Down Expand Up @@ -914,6 +947,7 @@ server cluster GeneralDiagnostics = 51 {
command access(invoke: manage) TestEventTrigger(TestEventTriggerRequest): DefaultSuccess = 0;
}

/** The Software Diagnostics Cluster provides a means to acquire standardized diagnostics metrics that MAY be used by a Node to assist a user or Administrative Node in diagnosing potential problems. */
server cluster SoftwareDiagnostics = 52 {
bitmap SoftwareDiagnosticsFeature : BITMAP32 {
kWaterMarks = 0x1;
Expand Down Expand Up @@ -945,6 +979,7 @@ server cluster SoftwareDiagnostics = 52 {
readonly attribute int16u clusterRevision = 65533;
}

/** The Thread Network Diagnostics Cluster provides a means to acquire standardized diagnostics metrics that MAY be used by a Node to assist a user or Administrative Node in diagnosing potential problems */
server cluster ThreadNetworkDiagnostics = 53 {
enum ConnectionStatusEnum : ENUM8 {
kConnected = 0;
Expand Down Expand Up @@ -1105,6 +1140,7 @@ server cluster ThreadNetworkDiagnostics = 53 {
readonly attribute int16u clusterRevision = 65533;
}

/** The Wi-Fi Network Diagnostics Cluster provides a means to acquire standardized diagnostics metrics that MAY be used by a Node to assist a user or Administrative Node in diagnosing potential problems. */
server cluster WiFiNetworkDiagnostics = 54 {
enum AssociationFailureCauseEnum : ENUM8 {
kUnknown = 0;
Expand Down Expand Up @@ -1175,6 +1211,7 @@ server cluster WiFiNetworkDiagnostics = 54 {
readonly attribute int16u clusterRevision = 65533;
}

/** The Ethernet Network Diagnostics Cluster provides a means to acquire standardized diagnostics metrics that MAY be used by a Node to assist a user or Administrative Node in diagnosing potential problems. */
server cluster EthernetNetworkDiagnostics = 55 {
enum PHYRateEnum : ENUM8 {
kRate10M = 0;
Expand Down Expand Up @@ -1213,6 +1250,9 @@ server cluster EthernetNetworkDiagnostics = 55 {
command ResetCounts(): DefaultSuccess = 0;
}

/** This cluster exposes interactions with a switch device, for the purpose of using those interactions by other devices.
Two types of switch devices are supported: latching switch (e.g. rocker switch) and momentary switch (e.g. push button), distinguished with their feature flags.
Interactions with the switch device are exposed as attributes (for the latching switch) and as events (for both types of switches). An interested party MAY subscribe to these attributes/events and thus be informed of the interactions, and can perform actions based on this, for example by sending commands to perform an action such as controlling a light or a window shade. */
server cluster Switch = 59 {
bitmap SwitchFeature : BITMAP32 {
kLatchingSwitch = 0x1;
Expand Down Expand Up @@ -1263,6 +1303,7 @@ server cluster Switch = 59 {
readonly attribute int16u clusterRevision = 65533;
}

/** Commands to trigger a Node to allow a new Administrator to commission it. */
server cluster AdministratorCommissioning = 60 {
enum CommissioningWindowStatusEnum : ENUM8 {
kWindowNotOpen = 0;
Expand Down Expand Up @@ -1303,6 +1344,7 @@ server cluster AdministratorCommissioning = 60 {
timed command access(invoke: administer) RevokeCommissioning(): DefaultSuccess = 2;
}

/** This cluster is used to add or remove Operational Credentials on a Commissionee or Node, as well as manage the associated Fabrics. */
server cluster OperationalCredentials = 62 {
enum CertificateChainTypeEnum : ENUM8 {
kDACCertificate = 1;
Expand Down Expand Up @@ -1418,6 +1460,7 @@ server cluster OperationalCredentials = 62 {
command access(invoke: administer) AddTrustedRootCertificate(AddTrustedRootCertificateRequest): DefaultSuccess = 11;
}

/** The Group Key Management Cluster is the mechanism by which group keys are managed. */
server cluster GroupKeyManagement = 63 {
enum GroupKeySecurityPolicyEnum : ENUM8 {
kTrustFirst = 0;
Expand Down Expand Up @@ -1489,6 +1532,7 @@ server cluster GroupKeyManagement = 63 {
fabric command access(invoke: administer) KeySetReadAllIndices(KeySetReadAllIndicesRequest): KeySetReadAllIndicesResponse = 4;
}

/** The User Label Cluster provides a feature to tag an endpoint with zero or more labels. */
server cluster UserLabel = 65 {
struct LabelStruct {
char_string<16> label = 0;
Expand All @@ -1504,6 +1548,7 @@ server cluster UserLabel = 65 {
readonly attribute int16u clusterRevision = 65533;
}

/** Attributes and commands for configuring the measurement of temperature, and reporting temperature measurements. */
server cluster TemperatureMeasurement = 1026 {
readonly attribute nullable int16s measuredValue = 0;
readonly attribute nullable int16s minMeasuredValue = 1;
Expand Down
Loading

0 comments on commit ecb65ee

Please sign in to comment.