| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748 |
- // 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 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 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 char_string<16> manufacturingDate = 11;
- readonly attribute char_string<32> partNumber = 12;
- readonly attribute long_char_string<256> productURL = 13;
- readonly attribute char_string<64> productLabel = 14;
- readonly attribute char_string<32> serialNumber = 15;
- attribute access(write: manage) boolean localConfigDisabled = 16;
- readonly attribute char_string<32> uniqueID = 18;
- 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;
- }
- /** Provides an interface for providing OTA software updates */
- client cluster OtaSoftwareUpdateProvider = 41 {
- enum OTAApplyUpdateAction : ENUM8 {
- kProceed = 0;
- kAwaitNextAction = 1;
- kDiscontinue = 2;
- }
- enum OTADownloadProtocol : ENUM8 {
- kBDXSynchronous = 0;
- kBDXAsynchronous = 1;
- kHTTPS = 2;
- kVendorSpecific = 3;
- }
- enum OTAQueryStatus : ENUM8 {
- kUpdateAvailable = 0;
- kBusy = 1;
- kNotAvailable = 2;
- kDownloadProtocolNotSupported = 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 QueryImageRequest {
- vendor_id vendorID = 0;
- INT16U productID = 1;
- INT32U softwareVersion = 2;
- OTADownloadProtocol protocolsSupported[] = 3;
- optional INT16U hardwareVersion = 4;
- optional CHAR_STRING<2> location = 5;
- optional BOOLEAN requestorCanConsent = 6;
- optional OCTET_STRING<512> metadataForProvider = 7;
- }
- response struct QueryImageResponse = 1 {
- OTAQueryStatus status = 0;
- optional INT32U delayedActionTime = 1;
- optional CHAR_STRING<256> imageURI = 2;
- optional INT32U softwareVersion = 3;
- optional CHAR_STRING<64> softwareVersionString = 4;
- optional OCTET_STRING<32> updateToken = 5;
- optional BOOLEAN userConsentNeeded = 6;
- optional OCTET_STRING<512> metadataForRequestor = 7;
- }
- request struct ApplyUpdateRequestRequest {
- OCTET_STRING<32> updateToken = 0;
- INT32U newVersion = 1;
- }
- response struct ApplyUpdateResponse = 3 {
- OTAApplyUpdateAction action = 0;
- INT32U delayedActionTime = 1;
- }
- request struct NotifyUpdateAppliedRequest {
- OCTET_STRING<32> updateToken = 0;
- INT32U softwareVersion = 1;
- }
- /** Determine availability of a new Software Image */
- command QueryImage(QueryImageRequest): QueryImageResponse = 0;
- /** Determine next action to take for a downloaded Software Image */
- command ApplyUpdateRequest(ApplyUpdateRequestRequest): ApplyUpdateResponse = 2;
- /** Notify OTA Provider that an update was applied */
- command NotifyUpdateApplied(NotifyUpdateAppliedRequest): DefaultSuccess = 4;
- }
- /** Provides an interface for downloading and applying OTA software updates */
- server cluster OtaSoftwareUpdateRequestor = 42 {
- enum OTAAnnouncementReason : ENUM8 {
- kSimpleAnnouncement = 0;
- kUpdateAvailable = 1;
- kUrgentUpdateAvailable = 2;
- }
- enum OTAChangeReasonEnum : ENUM8 {
- kUnknown = 0;
- kSuccess = 1;
- kFailure = 2;
- kTimeOut = 3;
- kDelayByProvider = 4;
- }
- enum OTAUpdateStateEnum : ENUM8 {
- kUnknown = 0;
- kIdle = 1;
- kQuerying = 2;
- kDelayedOnQuery = 3;
- kDownloading = 4;
- kApplying = 5;
- kDelayedOnApply = 6;
- kRollingBack = 7;
- kDelayedOnUserConsent = 8;
- }
- fabric_scoped struct ProviderLocation {
- node_id providerNodeID = 1;
- endpoint_no endpoint = 2;
- fabric_idx fabricIndex = 254;
- }
- info event StateTransition = 0 {
- OTAUpdateStateEnum previousState = 0;
- OTAUpdateStateEnum newState = 1;
- OTAChangeReasonEnum reason = 2;
- nullable INT32U targetSoftwareVersion = 3;
- }
- critical event VersionApplied = 1 {
- INT32U softwareVersion = 0;
- INT16U productID = 1;
- }
- info event DownloadError = 2 {
- INT32U softwareVersion = 0;
- INT64U bytesDownloaded = 1;
- nullable INT8U progressPercent = 2;
- nullable INT64S platformCode = 3;
- }
- attribute ProviderLocation defaultOTAProviders[] = 0;
- readonly attribute boolean updatePossible = 1;
- readonly attribute OTAUpdateStateEnum updateState = 2;
- readonly attribute nullable int8u updateStateProgress = 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 AnnounceOTAProviderRequest {
- node_id providerNodeID = 0;
- vendor_id vendorID = 1;
- OTAAnnouncementReason announcementReason = 2;
- optional OCTET_STRING<512> metadataForNode = 3;
- endpoint_no endpoint = 4;
- }
- command AnnounceOTAProvider(AnnounceOTAProviderRequest): DefaultSuccess = 0;
- }
- /** 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;
- attribute CalendarTypeEnum activeCalendarType = 1;
- readonly attribute CalendarTypeEnum supportedCalendarTypes[] = 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;
- }
- /** 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 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;
- kNetworkDiag = 1;
- kCrashLogs = 2;
- }
- enum StatusEnum : ENUM8 {
- kSuccess = 0;
- kExhausted = 1;
- kNoLogs = 2;
- kBusy = 3;
- kDenied = 4;
- }
- enum TransferProtocolEnum : ENUM8 {
- kResponsePayload = 0;
- kBDX = 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 RetrieveLogsRequestRequest {
- IntentEnum intent = 0;
- TransferProtocolEnum requestedProtocol = 1;
- optional CHAR_STRING<32> transferFileDesignator = 2;
- }
- 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;
- 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 int64u upTime = 2;
- readonly attribute int32u totalOperationalHours = 3;
- readonly attribute BootReasonEnum bootReason = 4;
- readonly attribute HardwareFaultEnum activeHardwareFaults[] = 5;
- readonly attribute RadioFaultEnum activeRadioFaults[] = 6;
- readonly attribute NetworkFaultEnum activeNetworkFaults[] = 7;
- 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;
- }
- /** 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 Feature : BITMAP32 {
- kWaterMarks = 0x1;
- }
- struct ThreadMetricsStruct {
- int64u id = 0;
- optional char_string<8> name = 1;
- optional int32u stackFreeCurrent = 2;
- optional int32u stackFreeMinimum = 3;
- optional int32u stackSize = 4;
- }
- info event SoftwareFault = 0 {
- INT64U id = 0;
- optional CHAR_STRING name = 1;
- optional OCTET_STRING faultRecording = 2;
- }
- readonly attribute ThreadMetricsStruct threadMetrics[] = 0;
- readonly attribute int64u currentHeapFree = 1;
- readonly attribute int64u currentHeapUsed = 2;
- readonly attribute int64u currentHeapHighWatermark = 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;
- command ResetWatermarks(): 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;
- }
- /** The Fixed Label Cluster provides a feature for the device to tag an endpoint with zero or more read only
- labels. */
- server cluster FixedLabel = 64 {
- struct LabelStruct {
- char_string<16> label = 0;
- char_string<16> value = 1;
- }
- readonly attribute LabelStruct labelList[] = 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;
- }
- /** This cluster provides an interface for managing low power mode on a device that supports the Wake On LAN protocol. */
- server cluster WakeOnLan = 1283 {
- 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 an interface for controlling the current Channel on a device. */
- server cluster Channel = 1284 {
- enum ChannelStatusEnum : ENUM8 {
- kSuccess = 0;
- kMultipleMatches = 1;
- kNoMatches = 2;
- }
- enum LineupInfoTypeEnum : ENUM8 {
- kMSO = 0;
- }
- bitmap Feature : BITMAP32 {
- kChannelList = 0x1;
- kLineupInfo = 0x2;
- }
- struct ChannelInfoStruct {
- int16u majorNumber = 0;
- int16u minorNumber = 1;
- optional char_string name = 2;
- optional char_string callSign = 3;
- optional char_string affiliateCallSign = 4;
- }
- struct LineupInfoStruct {
- char_string operatorName = 0;
- optional char_string lineupName = 1;
- optional char_string postalCode = 2;
- LineupInfoTypeEnum lineupInfoType = 3;
- }
- readonly attribute ChannelInfoStruct channelList[] = 0;
- readonly attribute nullable LineupInfoStruct lineup = 1;
- readonly attribute nullable ChannelInfoStruct currentChannel = 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 ChangeChannelRequest {
- CHAR_STRING match = 0;
- }
- request struct ChangeChannelByNumberRequest {
- INT16U majorNumber = 0;
- INT16U minorNumber = 1;
- }
- request struct SkipChannelRequest {
- INT16S count = 0;
- }
- response struct ChangeChannelResponse = 1 {
- ChannelStatusEnum status = 0;
- optional CHAR_STRING data = 1;
- }
- command ChangeChannel(ChangeChannelRequest): ChangeChannelResponse = 0;
- command ChangeChannelByNumber(ChangeChannelByNumberRequest): DefaultSuccess = 2;
- command SkipChannel(SkipChannelRequest): DefaultSuccess = 3;
- }
- /** This cluster provides an interface for UX navigation within a set of targets on a device or endpoint. */
- server cluster TargetNavigator = 1285 {
- enum TargetNavigatorStatusEnum : ENUM8 {
- kSuccess = 0;
- kTargetNotFound = 1;
- kNotAllowed = 2;
- }
- struct TargetInfoStruct {
- int8u identifier = 0;
- char_string<32> name = 1;
- }
- readonly attribute TargetInfoStruct targetList[] = 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;
- request struct NavigateTargetRequest {
- INT8U target = 0;
- optional CHAR_STRING data = 1;
- }
- response struct NavigateTargetResponse = 1 {
- TargetNavigatorStatusEnum status = 0;
- optional CHAR_STRING data = 1;
- }
- command NavigateTarget(NavigateTargetRequest): NavigateTargetResponse = 0;
- }
- /** This cluster provides an interface for controlling Media Playback (PLAY, PAUSE, etc) on a media device such as a TV or Speaker. */
- server cluster MediaPlayback = 1286 {
- enum MediaPlaybackStatusEnum : ENUM8 {
- kSuccess = 0;
- kInvalidStateForCommand = 1;
- kNotAllowed = 2;
- kNotActive = 3;
- kSpeedOutOfRange = 4;
- kSeekOutOfRange = 5;
- }
- enum PlaybackStateEnum : ENUM8 {
- kPlaying = 0;
- kPaused = 1;
- kNotPlaying = 2;
- kBuffering = 3;
- }
- bitmap Feature : BITMAP32 {
- kAdvancedSeek = 0x1;
- kVariableSpeed = 0x2;
- }
- struct PlaybackPositionStruct {
- epoch_us updatedAt = 0;
- nullable int64u position = 1;
- }
- readonly attribute PlaybackStateEnum currentState = 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;
- response struct PlaybackResponse = 10 {
- MediaPlaybackStatusEnum status = 0;
- optional CHAR_STRING data = 1;
- }
- command Play(): PlaybackResponse = 0;
- command Pause(): PlaybackResponse = 1;
- command Stop(): PlaybackResponse = 2;
- }
- /** This cluster provides an interface for controlling the Input Selector on a media device such as a TV. */
- server cluster MediaInput = 1287 {
- enum InputTypeEnum : ENUM8 {
- kInternal = 0;
- kAux = 1;
- kCoax = 2;
- kComposite = 3;
- kHDMI = 4;
- kInput = 5;
- kLine = 6;
- kOptical = 7;
- kVideo = 8;
- kSCART = 9;
- kUSB = 10;
- kOther = 11;
- }
- bitmap Feature : BITMAP32 {
- kNameUpdates = 0x1;
- }
- struct InputInfoStruct {
- int8u index = 0;
- InputTypeEnum inputType = 1;
- char_string<32> name = 2;
- char_string<32> description = 3;
- }
- readonly attribute InputInfoStruct inputList[] = 0;
- readonly attribute int8u currentInput = 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 SelectInputRequest {
- INT8U index = 0;
- }
- command SelectInput(SelectInputRequest): DefaultSuccess = 0;
- command ShowInputStatus(): DefaultSuccess = 1;
- command HideInputStatus(): DefaultSuccess = 2;
- }
- /** This cluster provides an interface for managing low power mode on a device. */
- server cluster LowPower = 1288 {
- 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 Sleep(): DefaultSuccess = 0;
- }
- /** This cluster provides an interface for controlling a device like a TV using action commands such as UP, DOWN, and SELECT. */
- server cluster KeypadInput = 1289 {
- enum CecKeyCode : ENUM8 {
- kSelect = 0;
- kUp = 1;
- kDown = 2;
- kLeft = 3;
- kRight = 4;
- kRightUp = 5;
- kRightDown = 6;
- kLeftUp = 7;
- kLeftDown = 8;
- kRootMenu = 9;
- kSetupMenu = 10;
- kContentsMenu = 11;
- kFavoriteMenu = 12;
- kExit = 13;
- kMediaTopMenu = 16;
- kMediaContextSensitiveMenu = 17;
- kNumberEntryMode = 29;
- kNumber11 = 30;
- kNumber12 = 31;
- kNumber0OrNumber10 = 32;
- kNumbers1 = 33;
- kNumbers2 = 34;
- kNumbers3 = 35;
- kNumbers4 = 36;
- kNumbers5 = 37;
- kNumbers6 = 38;
- kNumbers7 = 39;
- kNumbers8 = 40;
- kNumbers9 = 41;
- kDot = 42;
- kEnter = 43;
- kClear = 44;
- kNextFavorite = 47;
- kChannelUp = 48;
- kChannelDown = 49;
- kPreviousChannel = 50;
- kSoundSelect = 51;
- kInputSelect = 52;
- kDisplayInformation = 53;
- kHelp = 54;
- kPageUp = 55;
- kPageDown = 56;
- kPower = 64;
- kVolumeUp = 65;
- kVolumeDown = 66;
- kMute = 67;
- kPlay = 68;
- kStop = 69;
- kPause = 70;
- kRecord = 71;
- kRewind = 72;
- kFastForward = 73;
- kEject = 74;
- kForward = 75;
- kBackward = 76;
- kStopRecord = 77;
- kPauseRecord = 78;
- kReserved = 79;
- kAngle = 80;
- kSubPicture = 81;
- kVideoOnDemand = 82;
- kElectronicProgramGuide = 83;
- kTimerProgramming = 84;
- kInitialConfiguration = 85;
- kSelectBroadcastType = 86;
- kSelectSoundPresentation = 87;
- kPlayFunction = 96;
- kPausePlayFunction = 97;
- kRecordFunction = 98;
- kPauseRecordFunction = 99;
- kStopFunction = 100;
- kMuteFunction = 101;
- kRestoreVolumeFunction = 102;
- kTuneFunction = 103;
- kSelectMediaFunction = 104;
- kSelectAvInputFunction = 105;
- kSelectAudioInputFunction = 106;
- kPowerToggleFunction = 107;
- kPowerOffFunction = 108;
- kPowerOnFunction = 109;
- kF1Blue = 113;
- kF2Red = 114;
- kF3Green = 115;
- kF4Yellow = 116;
- kF5 = 117;
- kData = 118;
- }
- enum KeypadInputStatusEnum : ENUM8 {
- kSuccess = 0;
- kUnsupportedKey = 1;
- kInvalidKeyInCurrentState = 2;
- }
- bitmap Feature : BITMAP32 {
- kNavigationKeyCodes = 0x1;
- kLocationKeys = 0x2;
- kNumberKeys = 0x4;
- }
- 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 SendKeyRequest {
- CecKeyCode keyCode = 0;
- }
- response struct SendKeyResponse = 1 {
- KeypadInputStatusEnum status = 0;
- }
- command SendKey(SendKeyRequest): SendKeyResponse = 0;
- }
- /** This cluster provides an interface for controlling the Output on a media device such as a TV. */
- server cluster AudioOutput = 1291 {
- enum OutputTypeEnum : ENUM8 {
- kHDMI = 0;
- kBT = 1;
- kOptical = 2;
- kHeadphone = 3;
- kInternal = 4;
- kOther = 5;
- }
- bitmap Feature : BITMAP32 {
- kNameUpdates = 0x1;
- }
- struct OutputInfoStruct {
- int8u index = 0;
- OutputTypeEnum outputType = 1;
- char_string<32> name = 2;
- }
- readonly attribute OutputInfoStruct outputList[] = 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;
- request struct SelectOutputRequest {
- INT8U index = 0;
- }
- command SelectOutput(SelectOutputRequest): DefaultSuccess = 0;
- }
- endpoint 0 {
- device type ma_rootdevice = 22, version 1;
- binding cluster OtaSoftwareUpdateProvider;
- server cluster Descriptor {
- callback attribute deviceTypeList;
- callback attribute serverList;
- callback attribute clientList;
- callback attribute partsList;
- ram attribute featureMap default = 0;
- callback attribute clusterRevision default = 1;
- }
- server cluster AccessControl {
- emits event AccessControlEntryChanged;
- emits event AccessControlExtensionChanged;
- callback attribute acl;
- callback attribute extension;
- callback attribute subjectsPerAccessControlEntry;
- callback attribute targetsPerAccessControlEntry;
- callback attribute accessControlEntriesPerFabric;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- server cluster BasicInformation {
- emits event StartUp;
- emits event ShutDown;
- emits event Leave;
- callback attribute dataModelRevision default = 10;
- 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 manufacturingDate default = "20210614123456ZZ";
- callback attribute partNumber;
- callback attribute productURL;
- callback attribute productLabel;
- callback attribute serialNumber;
- persist attribute localConfigDisabled default = 0;
- callback attribute uniqueID;
- callback attribute capabilityMinima;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- server cluster OtaSoftwareUpdateRequestor {
- emits event StateTransition;
- emits event VersionApplied;
- emits event DownloadError;
- callback attribute defaultOTAProviders;
- ram attribute updatePossible default = 1;
- ram attribute updateState default = 0;
- ram attribute updateStateProgress default = 0;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- server cluster LocalizationConfiguration {
- ram attribute activeLocale;
- callback attribute supportedLocales;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- server cluster TimeFormatLocalization {
- persist attribute hourFormat default = 0;
- persist attribute activeCalendarType default = 0;
- callback attribute supportedCalendarTypes;
- 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;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 0x0001;
- }
- 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;
- ram attribute featureMap default = 1;
- ram attribute clusterRevision default = 0x0001;
- }
- server cluster DiagnosticLogs {
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- server cluster GeneralDiagnostics {
- emits event BootReason;
- callback attribute networkInterfaces;
- callback attribute rebootCount default = 0x0000;
- callback attribute upTime default = 0x0000000000000000;
- callback attribute totalOperationalHours default = 0x00000000;
- callback attribute bootReason;
- callback attribute activeHardwareFaults;
- callback attribute activeRadioFaults;
- callback attribute activeNetworkFaults;
- callback attribute testEventTriggersEnabled default = false;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 0x0001;
- }
- server cluster SoftwareDiagnostics {
- callback attribute threadMetrics;
- callback attribute currentHeapFree default = 0x0000000000000000;
- callback attribute currentHeapUsed default = 0x0000000000000000;
- callback attribute currentHeapHighWatermark default = 0x0000000000000000;
- ram attribute featureMap default = 1;
- ram attribute clusterRevision default = 0x0001;
- }
- server cluster AdministratorCommissioning {
- callback attribute windowStatus default = 0;
- callback attribute adminFabricIndex default = 1;
- callback attribute adminVendorId default = 0;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 0x0001;
- }
- server cluster OperationalCredentials {
- callback attribute NOCs;
- callback attribute fabrics;
- callback attribute supportedFabrics;
- callback attribute commissionedFabrics;
- callback attribute trustedRootCertificates;
- callback attribute currentFabricIndex;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 0x0001;
- }
- server cluster GroupKeyManagement {
- callback attribute groupKeyMap;
- callback attribute groupTable;
- callback attribute maxGroupsPerFabric;
- callback attribute maxGroupKeysPerFabric;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- server cluster FixedLabel {
- callback attribute labelList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- }
- endpoint 1 {
- device type ma_basic_videoplayer = 40, version 1;
- server cluster OnOff {
- ram attribute onOff default = 0;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute eventList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 4;
- }
- server cluster Descriptor {
- callback attribute deviceTypeList;
- callback attribute serverList;
- callback attribute clientList;
- callback attribute partsList;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute eventList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- server cluster WakeOnLan {
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute eventList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- server cluster Channel {
- callback attribute channelList;
- callback attribute lineup;
- callback attribute currentChannel;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute eventList;
- callback attribute attributeList;
- ram attribute featureMap default = 3;
- ram attribute clusterRevision default = 1;
- }
- server cluster TargetNavigator {
- callback attribute targetList;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute eventList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- server cluster MediaPlayback {
- ram attribute currentState default = 0x00;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute eventList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- server cluster MediaInput {
- callback attribute inputList;
- ram attribute currentInput default = 0x00;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute eventList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- server cluster LowPower {
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute eventList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- server cluster KeypadInput {
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute eventList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- server cluster AudioOutput {
- callback attribute outputList;
- callback attribute generatedCommandList;
- callback attribute acceptedCommandList;
- callback attribute eventList;
- callback attribute attributeList;
- ram attribute featureMap default = 0;
- ram attribute clusterRevision default = 1;
- }
- }
|