| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230 |
- // This IDL was generated automatically by ZAP.
- // It is for view/code review purposes only.
- struct ModeTagStruct {
- optional vendor_id mfgCode = 0;
- enum16 value = 1;
- }
- struct ModeOptionStruct {
- char_string<64> label = 0;
- int8u mode = 1;
- ModeTagStruct modeTags[] = 2;
- }
- struct ApplicationStruct {
- int16u catalogVendorID = 0;
- char_string applicationID = 1;
- }
- struct ErrorStateStruct {
- enum8 errorStateID = 0;
- optional char_string<64> errorStateLabel = 1;
- optional char_string<64> errorStateDetails = 2;
- }
- struct LabelStruct {
- char_string<16> label = 0;
- char_string<16> value = 1;
- }
- struct OperationalStateStruct {
- enum8 operationalStateID = 0;
- optional char_string<64> operationalStateLabel = 1;
- }
- /** Attributes and commands for putting a device into Identification mode (e.g. flashing a light). */
- server cluster Identify = 3 {
- enum EffectIdentifierEnum : ENUM8 {
- kBlink = 0;
- kBreathe = 1;
- kOkay = 2;
- kChannelChange = 11;
- kFinishEffect = 254;
- kStopEffect = 255;
- }
- enum EffectVariantEnum : ENUM8 {
- kDefault = 0;
- }
- enum IdentifyTypeEnum : ENUM8 {
- kNone = 0;
- kLightOutput = 1;
- kVisibleIndicator = 2;
- kAudibleBeep = 3;
- kDisplay = 4;
- kActuator = 5;
- }
- attribute int16u identifyTime = 0;
- readonly attribute IdentifyTypeEnum identifyType = 1;
- readonly attribute command_id generatedCommandList[] = 65528;
- readonly attribute command_id acceptedCommandList[] = 65529;
- readonly attribute event_id eventList[] = 65530;
- readonly attribute attrib_id attributeList[] = 65531;
- readonly attribute bitmap32 featureMap = 65532;
- readonly attribute int16u clusterRevision = 65533;
- request struct IdentifyRequest {
- INT16U identifyTime = 0;
- }
- request struct TriggerEffectRequest {
- EffectIdentifierEnum effectIdentifier = 0;
- EffectVariantEnum effectVariant = 1;
- }
- command access(invoke: manage) Identify(IdentifyRequest): DefaultSuccess = 0;
- command access(invoke: manage) TriggerEffect(TriggerEffectRequest): DefaultSuccess = 64;
- }
- /** Attributes and commands for switching devices between 'On' and 'Off' states. */
- server cluster OnOff = 6 {
- enum DelayedAllOffEffectVariantEnum : ENUM8 {
- kDelayedOffFastFade = 0;
- kNoFade = 1;
- kDelayedOffSlowFade = 2;
- }
- enum DyingLightEffectVariantEnum : ENUM8 {
- kDyingLightFadeOff = 0;
- }
- enum EffectIdentifierEnum : ENUM8 {
- kDelayedAllOff = 0;
- kDyingLight = 1;
- }
- enum StartUpOnOffEnum : ENUM8 {
- kOff = 0;
- kOn = 1;
- kToggle = 2;
- }
- bitmap Feature : BITMAP32 {
- kLighting = 0x1;
- kDeadFrontBehavior = 0x2;
- }
- bitmap OnOffControlBitmap : BITMAP8 {
- kAcceptOnlyWhenOn = 0x1;
- }
- readonly nosubscribe attribute boolean onOff = 0;
- readonly attribute command_id generatedCommandList[] = 65528;
- readonly attribute command_id acceptedCommandList[] = 65529;
- readonly attribute event_id eventList[] = 65530;
- readonly attribute attrib_id attributeList[] = 65531;
- readonly attribute bitmap32 featureMap = 65532;
- readonly attribute int16u clusterRevision = 65533;
- command Off(): DefaultSuccess = 0;
- command On(): DefaultSuccess = 1;
- command Toggle(): DefaultSuccess = 2;
- }
- /** 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 {
- bitmap Feature : BITMAP32 {
- kTagList = 0x1;
- }
- struct DeviceTypeStruct {
- devtype_id deviceType = 0;
- int16u revision = 1;
- }
- struct SemanticTagStruct {
- nullable vendor_id mfgCode = 0;
- enum8 namespaceID = 1;
- enum8 tag = 2;
- optional nullable char_string label = 3;
- }
- readonly attribute DeviceTypeStruct deviceTypeList[] = 0;
- readonly attribute CLUSTER_ID serverList[] = 1;
- readonly attribute CLUSTER_ID clientList[] = 2;
- readonly attribute ENDPOINT_NO partsList[] = 3;
- readonly attribute command_id generatedCommandList[] = 65528;
- readonly attribute command_id acceptedCommandList[] = 65529;
- readonly attribute event_id eventList[] = 65530;
- readonly attribute attrib_id attributeList[] = 65531;
- readonly attribute bitmap32 featureMap = 65532;
- 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;
- kCASE = 2;
- kGroup = 3;
- }
- enum AccessControlEntryPrivilegeEnum : ENUM8 {
- kView = 1;
- kProxyView = 2;
- kOperate = 3;
- kManage = 4;
- kAdminister = 5;
- }
- enum ChangeTypeEnum : ENUM8 {
- kChanged = 0;
- kAdded = 1;
- kRemoved = 2;
- }
- struct AccessControlTargetStruct {
- nullable cluster_id cluster = 0;
- nullable endpoint_no endpoint = 1;
- nullable devtype_id deviceType = 2;
- }
- fabric_scoped struct AccessControlEntryStruct {
- fabric_sensitive AccessControlEntryPrivilegeEnum privilege = 1;
- fabric_sensitive AccessControlEntryAuthModeEnum authMode = 2;
- nullable fabric_sensitive int64u subjects[] = 3;
- nullable fabric_sensitive AccessControlTargetStruct targets[] = 4;
- fabric_idx fabricIndex = 254;
- }
- fabric_scoped struct AccessControlExtensionStruct {
- fabric_sensitive octet_string<128> data = 1;
- fabric_idx fabricIndex = 254;
- }
- fabric_sensitive info event access(read: administer) AccessControlEntryChanged = 0 {
- nullable node_id adminNodeID = 1;
- nullable INT16U adminPasscodeID = 2;
- ChangeTypeEnum changeType = 3;
- nullable AccessControlEntryStruct latestValue = 4;
- fabric_idx fabricIndex = 254;
- }
- fabric_sensitive info event access(read: administer) AccessControlExtensionChanged = 1 {
- nullable node_id adminNodeID = 1;
- nullable INT16U adminPasscodeID = 2;
- ChangeTypeEnum changeType = 3;
- nullable AccessControlExtensionStruct latestValue = 4;
- fabric_idx fabricIndex = 254;
- }
- attribute access(read: administer, write: administer) AccessControlEntryStruct acl[] = 0;
- attribute access(read: administer, write: administer) AccessControlExtensionStruct extension[] = 1;
- readonly attribute int16u subjectsPerAccessControlEntry = 2;
- readonly attribute int16u targetsPerAccessControlEntry = 3;
- readonly attribute int16u accessControlEntriesPerFabric = 4;
- readonly attribute command_id generatedCommandList[] = 65528;
- readonly attribute command_id acceptedCommandList[] = 65529;
- readonly attribute event_id eventList[] = 65530;
- readonly attribute attrib_id attributeList[] = 65531;
- readonly attribute bitmap32 featureMap = 65532;
- readonly attribute int16u clusterRevision = 65533;
- }
- /** 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 {
- enum ColorEnum : ENUM8 {
- kBlack = 0;
- kNavy = 1;
- kGreen = 2;
- kTeal = 3;
- kMaroon = 4;
- kPurple = 5;
- kOlive = 6;
- kGray = 7;
- kBlue = 8;
- kLime = 9;
- kAqua = 10;
- kRed = 11;
- kFuchsia = 12;
- kYellow = 13;
- kWhite = 14;
- kNickel = 15;
- kChrome = 16;
- kBrass = 17;
- kCopper = 18;
- kSilver = 19;
- kGold = 20;
- }
- enum ProductFinishEnum : ENUM8 {
- kOther = 0;
- kMatte = 1;
- kSatin = 2;
- kPolished = 3;
- kRugged = 4;
- kFabric = 5;
- }
- struct CapabilityMinimaStruct {
- int16u caseSessionsPerFabric = 0;
- int16u subscriptionsPerFabric = 1;
- }
- struct ProductAppearanceStruct {
- ProductFinishEnum finish = 0;
- nullable ColorEnum primaryColor = 1;
- }
- critical event StartUp = 0 {
- INT32U softwareVersion = 0;
- }
- critical event ShutDown = 1 {
- }
- info event Leave = 2 {
- fabric_idx fabricIndex = 0;
- }
- info event ReachableChanged = 3 {
- boolean reachableNewValue = 0;
- }
- readonly attribute int16u dataModelRevision = 0;
- readonly attribute char_string<32> vendorName = 1;
- readonly attribute vendor_id vendorID = 2;
- readonly attribute char_string<32> productName = 3;
- readonly attribute int16u productID = 4;
- attribute access(write: manage) char_string<32> nodeLabel = 5;
- attribute access(write: administer) char_string<2> location = 6;
- readonly attribute int16u hardwareVersion = 7;
- readonly attribute char_string<64> hardwareVersionString = 8;
- readonly attribute int32u softwareVersion = 9;
- readonly attribute char_string<64> softwareVersionString = 10;
- readonly attribute CapabilityMinimaStruct capabilityMinima = 19;
- readonly attribute command_id generatedCommandList[] = 65528;
- readonly attribute command_id acceptedCommandList[] = 65529;
- readonly attribute event_id eventList[] = 65530;
- readonly attribute attrib_id attributeList[] = 65531;
- readonly attribute bitmap32 featureMap = 65532;
- 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;
- readonly attribute command_id generatedCommandList[] = 65528;
- readonly attribute command_id acceptedCommandList[] = 65529;
- readonly attribute event_id eventList[] = 65530;
- readonly attribute attrib_id attributeList[] = 65531;
- readonly attribute bitmap32 featureMap = 65532;
- 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;
- kChinese = 1;
- kCoptic = 2;
- kEthiopian = 3;
- kGregorian = 4;
- kHebrew = 5;
- kIndian = 6;
- kIslamic = 7;
- kJapanese = 8;
- kKorean = 9;
- kPersian = 10;
- kTaiwanese = 11;
- }
- enum HourFormatEnum : ENUM8 {
- k12hr = 0;
- k24hr = 1;
- }
- bitmap Feature : BITMAP32 {
- kCalendarFormat = 0x1;
- }
- attribute HourFormatEnum hourFormat = 0;
- readonly attribute command_id generatedCommandList[] = 65528;
- readonly attribute command_id acceptedCommandList[] = 65529;
- readonly attribute event_id eventList[] = 65530;
- readonly attribute attrib_id attributeList[] = 65531;
- readonly attribute bitmap32 featureMap = 65532;
- 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;
- kCelsius = 1;
- kKelvin = 2;
- }
- bitmap Feature : BITMAP32 {
- kTemperatureUnit = 0x1;
- }
- readonly attribute command_id generatedCommandList[] = 65528;
- readonly attribute command_id acceptedCommandList[] = 65529;
- readonly attribute event_id eventList[] = 65530;
- readonly attribute attrib_id attributeList[] = 65531;
- readonly attribute bitmap32 featureMap = 65532;
- readonly attribute int16u clusterRevision = 65533;
- }
- /** This cluster is used to manage global aspects of the Commissioning flow. */
- server cluster GeneralCommissioning = 48 {
- enum CommissioningErrorEnum : ENUM8 {
- kOK = 0;
- kValueOutsideRange = 1;
- kInvalidAuthentication = 2;
- kNoFailSafe = 3;
- kBusyWithOtherAdmin = 4;
- }
- enum RegulatoryLocationTypeEnum : ENUM8 {
- kIndoor = 0;
- kOutdoor = 1;
- kIndoorOutdoor = 2;
- }
- struct BasicCommissioningInfo {
- int16u failSafeExpiryLengthSeconds = 0;
- int16u maxCumulativeFailsafeSeconds = 1;
- }
- attribute access(write: administer) int64u breadcrumb = 0;
- readonly attribute BasicCommissioningInfo basicCommissioningInfo = 1;
- readonly attribute RegulatoryLocationTypeEnum regulatoryConfig = 2;
- readonly attribute RegulatoryLocationTypeEnum locationCapability = 3;
- readonly attribute boolean supportsConcurrentConnection = 4;
- readonly attribute command_id generatedCommandList[] = 65528;
- readonly attribute command_id acceptedCommandList[] = 65529;
- readonly attribute event_id eventList[] = 65530;
- readonly attribute attrib_id attributeList[] = 65531;
- readonly attribute bitmap32 featureMap = 65532;
- readonly attribute int16u clusterRevision = 65533;
- request struct ArmFailSafeRequest {
- INT16U expiryLengthSeconds = 0;
- INT64U breadcrumb = 1;
- }
- request struct SetRegulatoryConfigRequest {
- RegulatoryLocationTypeEnum newRegulatoryConfig = 0;
- CHAR_STRING countryCode = 1;
- INT64U breadcrumb = 2;
- }
- response struct ArmFailSafeResponse = 1 {
- CommissioningErrorEnum errorCode = 0;
- CHAR_STRING debugText = 1;
- }
- response struct SetRegulatoryConfigResponse = 3 {
- CommissioningErrorEnum errorCode = 0;
- CHAR_STRING debugText = 1;
- }
- response struct CommissioningCompleteResponse = 5 {
- CommissioningErrorEnum errorCode = 0;
- CHAR_STRING debugText = 1;
- }
- command access(invoke: administer) ArmFailSafe(ArmFailSafeRequest): ArmFailSafeResponse = 0;
- command access(invoke: administer) SetRegulatoryConfig(SetRegulatoryConfigRequest): SetRegulatoryConfigResponse = 2;
- 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 NetworkCommissioningStatusEnum : ENUM8 {
- kSuccess = 0;
- kOutOfRange = 1;
- kBoundsExceeded = 2;
- kNetworkIDNotFound = 3;
- kDuplicateNetworkID = 4;
- kNetworkNotFound = 5;
- kRegulatoryError = 6;
- kAuthFailure = 7;
- kUnsupportedSecurity = 8;
- kOtherConnectionFailure = 9;
- kIPV6Failed = 10;
- kIPBindFailed = 11;
- kUnknownError = 12;
- }
- enum WiFiBandEnum : ENUM8 {
- k2G4 = 0;
- k3G65 = 1;
- k5G = 2;
- k6G = 3;
- k60G = 4;
- k1G = 5;
- }
- bitmap Feature : BITMAP32 {
- kWiFiNetworkInterface = 0x1;
- kThreadNetworkInterface = 0x2;
- kEthernetNetworkInterface = 0x4;
- }
- bitmap WiFiSecurityBitmap : BITMAP8 {
- kUnencrypted = 0x1;
- kWEP = 0x2;
- kWPAPersonal = 0x4;
- kWPA2Personal = 0x8;
- kWPA3Personal = 0x10;
- }
- struct NetworkInfoStruct {
- octet_string<32> networkID = 0;
- boolean connected = 1;
- }
- struct ThreadInterfaceScanResultStruct {
- int16u panId = 0;
- int64u extendedPanId = 1;
- char_string<16> networkName = 2;
- int16u channel = 3;
- int8u version = 4;
- octet_string<8> extendedAddress = 5;
- int8s rssi = 6;
- int8u lqi = 7;
- }
- struct WiFiInterfaceScanResultStruct {
- WiFiSecurityBitmap security = 0;
- octet_string<32> ssid = 1;
- octet_string<6> bssid = 2;
- int16u channel = 3;
- WiFiBandEnum wiFiBand = 4;
- int8s rssi = 5;
- }
- readonly attribute access(read: administer) int8u maxNetworks = 0;
- readonly attribute access(read: administer) NetworkInfoStruct networks[] = 1;
- readonly attribute int8u scanMaxTimeSeconds = 2;
- readonly attribute int8u connectMaxTimeSeconds = 3;
- attribute access(write: administer) boolean interfaceEnabled = 4;
- readonly attribute access(read: administer) nullable NetworkCommissioningStatusEnum lastNetworkingStatus = 5;
- readonly attribute access(read: administer) nullable octet_string<32> lastNetworkID = 6;
- readonly attribute access(read: administer) nullable int32s lastConnectErrorValue = 7;
- readonly attribute command_id generatedCommandList[] = 65528;
- readonly attribute command_id acceptedCommandList[] = 65529;
- readonly attribute event_id eventList[] = 65530;
- readonly attribute attrib_id attributeList[] = 65531;
- readonly attribute bitmap32 featureMap = 65532;
- readonly attribute int16u clusterRevision = 65533;
- request struct ScanNetworksRequest {
- optional nullable OCTET_STRING<32> ssid = 0;
- optional INT64U breadcrumb = 1;
- }
- request struct AddOrUpdateWiFiNetworkRequest {
- OCTET_STRING<32> ssid = 0;
- OCTET_STRING<64> credentials = 1;
- optional INT64U breadcrumb = 2;
- }
- request struct AddOrUpdateThreadNetworkRequest {
- OCTET_STRING<254> operationalDataset = 0;
- optional INT64U breadcrumb = 1;
- }
- request struct RemoveNetworkRequest {
- OCTET_STRING<32> networkID = 0;
- optional INT64U breadcrumb = 1;
- }
- request struct ConnectNetworkRequest {
- OCTET_STRING<32> networkID = 0;
- optional INT64U breadcrumb = 1;
- }
- request struct ReorderNetworkRequest {
- OCTET_STRING<32> networkID = 0;
- INT8U networkIndex = 1;
- optional INT64U breadcrumb = 2;
- }
- response struct ScanNetworksResponse = 1 {
- NetworkCommissioningStatusEnum networkingStatus = 0;
- optional CHAR_STRING debugText = 1;
- optional WiFiInterfaceScanResultStruct wiFiScanResults[] = 2;
- optional ThreadInterfaceScanResultStruct threadScanResults[] = 3;
- }
- response struct NetworkConfigResponse = 5 {
- NetworkCommissioningStatusEnum networkingStatus = 0;
- optional CHAR_STRING<512> debugText = 1;
- optional INT8U networkIndex = 2;
- }
- response struct ConnectNetworkResponse = 7 {
- NetworkCommissioningStatusEnum networkingStatus = 0;
- optional CHAR_STRING debugText = 1;
- nullable INT32S errorValue = 2;
- }
- command access(invoke: administer) ScanNetworks(ScanNetworksRequest): ScanNetworksResponse = 0;
- command access(invoke: administer) AddOrUpdateWiFiNetwork(AddOrUpdateWiFiNetworkRequest): NetworkConfigResponse = 2;
- command access(invoke: administer) AddOrUpdateThreadNetwork(AddOrUpdateThreadNetworkRequest): NetworkConfigResponse = 3;
- command access(invoke: administer) RemoveNetwork(RemoveNetworkRequest): NetworkConfigResponse = 4;
- command access(invoke: administer) ConnectNetwork(ConnectNetworkRequest): ConnectNetworkResponse = 6;
- command access(invoke: administer) ReorderNetwork(ReorderNetworkRequest): NetworkConfigResponse = 8;
- }
- /** 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;
- kPowerOnReboot = 1;
- kBrownOutReset = 2;
- kSoftwareWatchdogReset = 3;
- kHardwareWatchdogReset = 4;
- kSoftwareUpdateCompleted = 5;
- kSoftwareReset = 6;
- }
- enum HardwareFaultEnum : ENUM8 {
- kUnspecified = 0;
- kRadio = 1;
- kSensor = 2;
- kResettableOverTemp = 3;
- kNonResettableOverTemp = 4;
- kPowerSource = 5;
- kVisualDisplayFault = 6;
- kAudioOutputFault = 7;
- kUserInterfaceFault = 8;
- kNonVolatileMemoryError = 9;
- kTamperDetected = 10;
- }
- enum InterfaceTypeEnum : ENUM8 {
- kUnspecified = 0;
- kWiFi = 1;
- kEthernet = 2;
- kCellular = 3;
- kThread = 4;
- }
- enum NetworkFaultEnum : ENUM8 {
- kUnspecified = 0;
- kHardwareFailure = 1;
- kNetworkJammed = 2;
- kConnectionFailed = 3;
- }
- enum RadioFaultEnum : ENUM8 {
- kUnspecified = 0;
- kWiFiFault = 1;
- kCellularFault = 2;
- kThreadFault = 3;
- kNFCFault = 4;
- kBLEFault = 5;
- kEthernetFault = 6;
- }
- struct NetworkInterface {
- char_string<32> name = 0;
- boolean isOperational = 1;
- nullable boolean offPremiseServicesReachableIPv4 = 2;
- nullable boolean offPremiseServicesReachableIPv6 = 3;
- octet_string<8> hardwareAddress = 4;
- octet_string IPv4Addresses[] = 5;
- octet_string IPv6Addresses[] = 6;
- InterfaceTypeEnum type = 7;
- }
- critical event HardwareFaultChange = 0 {
- HardwareFaultEnum current[] = 0;
- HardwareFaultEnum previous[] = 1;
- }
- critical event RadioFaultChange = 1 {
- RadioFaultEnum current[] = 0;
- RadioFaultEnum previous[] = 1;
- }
- critical event NetworkFaultChange = 2 {
- NetworkFaultEnum current[] = 0;
- NetworkFaultEnum previous[] = 1;
- }
- critical event BootReason = 3 {
- BootReasonEnum bootReason = 0;
- }
- readonly attribute NetworkInterface networkInterfaces[] = 0;
- readonly attribute int16u rebootCount = 1;
- readonly attribute boolean testEventTriggersEnabled = 8;
- readonly attribute command_id generatedCommandList[] = 65528;
- readonly attribute command_id acceptedCommandList[] = 65529;
- readonly attribute event_id eventList[] = 65530;
- readonly attribute attrib_id attributeList[] = 65531;
- readonly attribute bitmap32 featureMap = 65532;
- readonly attribute int16u clusterRevision = 65533;
- request struct TestEventTriggerRequest {
- OCTET_STRING<16> enableKey = 0;
- INT64U eventTrigger = 1;
- }
- command access(invoke: manage) TestEventTrigger(TestEventTriggerRequest): DefaultSuccess = 0;
- }
- /** Commands to trigger a Node to allow a new Administrator to commission it. */
- server cluster AdministratorCommissioning = 60 {
- enum CommissioningWindowStatusEnum : ENUM8 {
- kWindowNotOpen = 0;
- kEnhancedWindowOpen = 1;
- kBasicWindowOpen = 2;
- }
- enum StatusCode : ENUM8 {
- kBusy = 2;
- kPAKEParameterError = 3;
- kWindowNotOpen = 4;
- }
- readonly attribute CommissioningWindowStatusEnum windowStatus = 0;
- readonly attribute nullable fabric_idx adminFabricIndex = 1;
- readonly attribute nullable int16u adminVendorId = 2;
- readonly attribute command_id generatedCommandList[] = 65528;
- readonly attribute command_id acceptedCommandList[] = 65529;
- readonly attribute event_id eventList[] = 65530;
- readonly attribute attrib_id attributeList[] = 65531;
- readonly attribute bitmap32 featureMap = 65532;
- readonly attribute int16u clusterRevision = 65533;
- request struct OpenCommissioningWindowRequest {
- INT16U commissioningTimeout = 0;
- OCTET_STRING PAKEPasscodeVerifier = 1;
- INT16U discriminator = 2;
- INT32U iterations = 3;
- OCTET_STRING salt = 4;
- }
- request struct OpenBasicCommissioningWindowRequest {
- INT16U commissioningTimeout = 0;
- }
- timed command access(invoke: administer) OpenCommissioningWindow(OpenCommissioningWindowRequest): DefaultSuccess = 0;
- timed command access(invoke: administer) OpenBasicCommissioningWindow(OpenBasicCommissioningWindowRequest): DefaultSuccess = 1;
- 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;
- kPAICertificate = 2;
- }
- enum NodeOperationalCertStatusEnum : ENUM8 {
- kOK = 0;
- kInvalidPublicKey = 1;
- kInvalidNodeOpId = 2;
- kInvalidNOC = 3;
- kMissingCsr = 4;
- kTableFull = 5;
- kInvalidAdminSubject = 6;
- kFabricConflict = 9;
- kLabelConflict = 10;
- kInvalidFabricIndex = 11;
- }
- fabric_scoped struct FabricDescriptorStruct {
- octet_string<65> rootPublicKey = 1;
- vendor_id vendorID = 2;
- fabric_id fabricID = 3;
- node_id nodeID = 4;
- char_string<32> label = 5;
- fabric_idx fabricIndex = 254;
- }
- fabric_scoped struct NOCStruct {
- fabric_sensitive octet_string noc = 1;
- nullable fabric_sensitive octet_string icac = 2;
- fabric_idx fabricIndex = 254;
- }
- readonly attribute access(read: administer) NOCStruct NOCs[] = 0;
- readonly attribute FabricDescriptorStruct fabrics[] = 1;
- readonly attribute int8u supportedFabrics = 2;
- readonly attribute int8u commissionedFabrics = 3;
- readonly attribute OCTET_STRING trustedRootCertificates[] = 4;
- readonly attribute int8u currentFabricIndex = 5;
- readonly attribute command_id generatedCommandList[] = 65528;
- readonly attribute command_id acceptedCommandList[] = 65529;
- readonly attribute event_id eventList[] = 65530;
- readonly attribute attrib_id attributeList[] = 65531;
- readonly attribute bitmap32 featureMap = 65532;
- readonly attribute int16u clusterRevision = 65533;
- request struct AttestationRequestRequest {
- OCTET_STRING attestationNonce = 0;
- }
- request struct CertificateChainRequestRequest {
- CertificateChainTypeEnum certificateType = 0;
- }
- request struct CSRRequestRequest {
- OCTET_STRING CSRNonce = 0;
- optional boolean isForUpdateNOC = 1;
- }
- request struct AddNOCRequest {
- OCTET_STRING NOCValue = 0;
- optional OCTET_STRING ICACValue = 1;
- OCTET_STRING IPKValue = 2;
- Int64u caseAdminSubject = 3;
- VENDOR_ID adminVendorId = 4;
- }
- request struct UpdateNOCRequest {
- OCTET_STRING NOCValue = 0;
- optional OCTET_STRING ICACValue = 1;
- }
- request struct UpdateFabricLabelRequest {
- CHAR_STRING<32> label = 0;
- }
- request struct RemoveFabricRequest {
- fabric_idx fabricIndex = 0;
- }
- request struct AddTrustedRootCertificateRequest {
- OCTET_STRING rootCACertificate = 0;
- }
- response struct AttestationResponse = 1 {
- OCTET_STRING attestationElements = 0;
- OCTET_STRING attestationSignature = 1;
- }
- response struct CertificateChainResponse = 3 {
- OCTET_STRING certificate = 0;
- }
- response struct CSRResponse = 5 {
- OCTET_STRING NOCSRElements = 0;
- OCTET_STRING attestationSignature = 1;
- }
- response struct NOCResponse = 8 {
- NodeOperationalCertStatusEnum statusCode = 0;
- optional fabric_idx fabricIndex = 1;
- optional CHAR_STRING debugText = 2;
- }
- command access(invoke: administer) AttestationRequest(AttestationRequestRequest): AttestationResponse = 0;
- command access(invoke: administer) CertificateChainRequest(CertificateChainRequestRequest): CertificateChainResponse = 2;
- command access(invoke: administer) CSRRequest(CSRRequestRequest): CSRResponse = 4;
- command access(invoke: administer) AddNOC(AddNOCRequest): NOCResponse = 6;
- fabric command access(invoke: administer) UpdateNOC(UpdateNOCRequest): NOCResponse = 7;
- fabric command access(invoke: administer) UpdateFabricLabel(UpdateFabricLabelRequest): NOCResponse = 9;
- command access(invoke: administer) RemoveFabric(RemoveFabricRequest): NOCResponse = 10;
- 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;
- kCacheAndSync = 1;
- }
- bitmap Feature : BITMAP32 {
- kCacheAndSync = 0x1;
- }
- fabric_scoped struct GroupInfoMapStruct {
- group_id groupId = 1;
- endpoint_no endpoints[] = 2;
- optional char_string<16> groupName = 3;
- fabric_idx fabricIndex = 254;
- }
- fabric_scoped struct GroupKeyMapStruct {
- group_id groupId = 1;
- int16u groupKeySetID = 2;
- fabric_idx fabricIndex = 254;
- }
- struct GroupKeySetStruct {
- int16u groupKeySetID = 0;
- GroupKeySecurityPolicyEnum groupKeySecurityPolicy = 1;
- nullable octet_string<16> epochKey0 = 2;
- nullable epoch_us epochStartTime0 = 3;
- nullable octet_string<16> epochKey1 = 4;
- nullable epoch_us epochStartTime1 = 5;
- nullable octet_string<16> epochKey2 = 6;
- nullable epoch_us epochStartTime2 = 7;
- }
- attribute access(write: manage) GroupKeyMapStruct groupKeyMap[] = 0;
- readonly attribute GroupInfoMapStruct groupTable[] = 1;
- readonly attribute int16u maxGroupsPerFabric = 2;
- readonly attribute int16u maxGroupKeysPerFabric = 3;
- readonly attribute command_id generatedCommandList[] = 65528;
- readonly attribute command_id acceptedCommandList[] = 65529;
- readonly attribute event_id eventList[] = 65530;
- readonly attribute attrib_id attributeList[] = 65531;
- readonly attribute bitmap32 featureMap = 65532;
- readonly attribute int16u clusterRevision = 65533;
- request struct KeySetWriteRequest {
- GroupKeySetStruct groupKeySet = 0;
- }
- request struct KeySetReadRequest {
- INT16U groupKeySetID = 0;
- }
- request struct KeySetRemoveRequest {
- INT16U groupKeySetID = 0;
- }
- response struct KeySetReadResponse = 2 {
- GroupKeySetStruct groupKeySet = 0;
- }
- response struct KeySetReadAllIndicesResponse = 5 {
- INT16U groupKeySetIDs[] = 0;
- }
- fabric command access(invoke: administer) KeySetWrite(KeySetWriteRequest): DefaultSuccess = 0;
- fabric command access(invoke: administer) KeySetRead(KeySetReadRequest): KeySetReadResponse = 1;
- fabric command access(invoke: administer) KeySetRemove(KeySetRemoveRequest): DefaultSuccess = 3;
- fabric command access(invoke: administer) KeySetReadAllIndices(): KeySetReadAllIndicesResponse = 4;
- }
- /** An interface for configuring and controlling pumps. */
- server cluster PumpConfigurationAndControl = 512 {
- enum ControlModeEnum : ENUM8 {
- kConstantSpeed = 0;
- kConstantPressure = 1;
- kProportionalPressure = 2;
- kConstantFlow = 3;
- kConstantTemperature = 5;
- kAutomatic = 7;
- }
- enum OperationModeEnum : ENUM8 {
- kNormal = 0;
- kMinimum = 1;
- kMaximum = 2;
- kLocal = 3;
- }
- bitmap Feature : BITMAP32 {
- kConstantPressure = 0x1;
- kCompensatedPressure = 0x2;
- kConstantFlow = 0x4;
- kConstantSpeed = 0x8;
- kConstantTemperature = 0x10;
- kAutomatic = 0x20;
- kLocalOperation = 0x40;
- }
- bitmap PumpStatusBitmap : BITMAP16 {
- kDeviceFault = 0x1;
- kSupplyfault = 0x2;
- kSpeedLow = 0x4;
- kSpeedHigh = 0x8;
- kLocalOverride = 0x10;
- kRunning = 0x20;
- kRemotePressure = 0x40;
- kRemoteFlow = 0x80;
- kRemoteTemperature = 0x100;
- }
- info event SupplyVoltageLow = 0 {
- }
- info event SupplyVoltageHigh = 1 {
- }
- info event PowerMissingPhase = 2 {
- }
- info event SystemPressureLow = 3 {
- }
- info event SystemPressureHigh = 4 {
- }
- critical event DryRunning = 5 {
- }
- info event MotorTemperatureHigh = 6 {
- }
- critical event PumpMotorFatalFailure = 7 {
- }
- info event ElectronicTemperatureHigh = 8 {
- }
- critical event PumpBlocked = 9 {
- }
- info event SensorFailure = 10 {
- }
- info event ElectronicNonFatalFailure = 11 {
- }
- critical event ElectronicFatalFailure = 12 {
- }
- info event GeneralFault = 13 {
- }
- info event Leakage = 14 {
- }
- info event AirDetection = 15 {
- }
- info event TurbineOperation = 16 {
- }
- readonly attribute nullable int16s maxPressure = 0;
- readonly attribute nullable int16u maxSpeed = 1;
- readonly attribute nullable int16u maxFlow = 2;
- readonly attribute OperationModeEnum effectiveOperationMode = 17;
- readonly attribute ControlModeEnum effectiveControlMode = 18;
- readonly nosubscribe attribute nullable int16s capacity = 19;
- attribute access(write: manage) OperationModeEnum operationMode = 32;
- readonly attribute command_id generatedCommandList[] = 65528;
- readonly attribute command_id acceptedCommandList[] = 65529;
- readonly attribute event_id eventList[] = 65530;
- readonly attribute attrib_id attributeList[] = 65531;
- readonly attribute bitmap32 featureMap = 65532;
- readonly attribute int16u clusterRevision = 65533;
- }
- endpoint 0 {
- device type ma_rootdevice = 22, version 1;
- server cluster Descriptor {
- callback attribute deviceTypeList;
- callback attribute serverList;
- callback attribute clientList;
- callback attribute partsList;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- callback attribute clusterRevision default = 2;
- }
- server cluster AccessControl {
- callback attribute acl;
- callback attribute extension;
- callback attribute subjectsPerAccessControlEntry;
- callback attribute targetsPerAccessControlEntry;
- callback attribute accessControlEntriesPerFabric;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- server cluster BasicInformation {
- callback attribute dataModelRevision default = 17;
- callback attribute vendorName;
- callback attribute vendorID;
- callback attribute productName;
- callback attribute productID;
- persist attribute nodeLabel;
- callback attribute location default = "XX";
- callback attribute hardwareVersion default = 0;
- callback attribute hardwareVersionString;
- callback attribute softwareVersion default = 0;
- callback attribute softwareVersionString;
- callback attribute capabilityMinima;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 2;
- }
- server cluster LocalizationConfiguration {
- ram attribute activeLocale;
- callback attribute supportedLocales;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- server cluster TimeFormatLocalization {
- persist attribute hourFormat default = 0;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- server cluster UnitLocalization {
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- server cluster GeneralCommissioning {
- ram attribute breadcrumb default = 0x0000000000000000;
- callback attribute basicCommissioningInfo;
- callback attribute regulatoryConfig default = 0;
- callback attribute locationCapability default = 0;
- callback attribute supportsConcurrentConnection default = 1;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- server cluster NetworkCommissioning {
- ram attribute maxNetworks;
- callback attribute networks;
- ram attribute scanMaxTimeSeconds;
- ram attribute connectMaxTimeSeconds;
- ram attribute interfaceEnabled;
- ram attribute lastNetworkingStatus;
- ram attribute lastNetworkID;
- ram attribute lastConnectErrorValue;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute attributeList;
- ram attribute featureMap default = 1;
- ram attribute clusterRevision default = 1;
- }
- server cluster GeneralDiagnostics {
- callback attribute networkInterfaces;
- callback attribute rebootCount default = 0x0000;
- callback attribute testEventTriggersEnabled default = false;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- server cluster AdministratorCommissioning {
- callback attribute windowStatus default = 0;
- callback attribute adminFabricIndex default = 1;
- callback attribute adminVendorId default = 0;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- server cluster OperationalCredentials {
- callback attribute NOCs;
- callback attribute fabrics;
- callback attribute supportedFabrics;
- callback attribute commissionedFabrics;
- callback attribute trustedRootCertificates;
- callback attribute currentFabricIndex;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- server cluster GroupKeyManagement {
- callback attribute groupKeyMap;
- callback attribute groupTable;
- callback attribute maxGroupsPerFabric;
- callback attribute maxGroupKeysPerFabric;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- }
- endpoint 1 {
- device type ma_pump = 771, version 1;
- server cluster Identify {
- ram attribute identifyTime default = 0x0;
- ram attribute identifyType default = 0x0;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 4;
- }
- server cluster OnOff {
- ram attribute onOff default = 0;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 5;
- }
- server cluster Descriptor {
- callback attribute deviceTypeList;
- callback attribute serverList;
- callback attribute clientList;
- callback attribute partsList;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 2;
- }
- server cluster PumpConfigurationAndControl {
- ram attribute maxPressure;
- ram attribute maxSpeed;
- ram attribute maxFlow;
- ram attribute effectiveOperationMode;
- ram attribute effectiveControlMode;
- ram attribute capacity;
- ram attribute operationMode default = 0x00;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 4;
- }
- }
|