@kusinta/iot-schema 0.1.0-beta.9 → 0.2.0-beta.10

package/src/kusinta/iot/device/v1/matter_options_pb.js

@@ -0,0 +1,118 @@
+// @generated by protoc-gen-es v2.12.0 with parameter "target=js+dts,import_extension=js"
+// @generated from file kusinta/iot/device/v1/matter_options.proto (package kusinta.iot.device.v1, syntax proto3)
+/* eslint-disable */
+
+import { extDesc, fileDesc } from "@bufbuild/protobuf/codegenv2";
+import { file_google_protobuf_descriptor } from "@bufbuild/protobuf/wkt";
+
+/**
+ * Describes the file kusinta/iot/device/v1/matter_options.proto.
+ */
+export const file_kusinta_iot_device_v1_matter_options = /*@__PURE__*/
+  fileDesc("CiprdXNpbnRhL2lvdC9kZXZpY2UvdjEvbWF0dGVyX29wdGlvbnMucHJvdG8SFWt1c2ludGEuaW90LmRldmljZS52MTpLChFtYXR0ZXJfY2x1c3Rlcl9pZBIdLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE9wdGlvbnMY0YYDIAEoDVIPbWF0dGVyQ2x1c3RlcklkOkoKEG1hdHRlcl9hdHRyaWJ1dGUSHS5nb29nbGUucHJvdG9idWYuRmllbGRPcHRpb25zGNKGAyABKAlSD21hdHRlckF0dHJpYnV0ZTpPChNtYXR0ZXJfYXR0cmlidXRlX2lkEh0uZ29vZ2xlLnByb3RvYnVmLkZpZWxkT3B0aW9ucxjWhgMgASgNUhFtYXR0ZXJBdHRyaWJ1dGVJZDpjCh1tYXR0ZXJfYXR0cmlidXRlX2NhcGFiaWxpdGllcxIdLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE9wdGlvbnMY2YYDIAEoDVIbbWF0dGVyQXR0cmlidXRlQ2FwYWJpbGl0aWVzOk8KEm1hdHRlcl9kZXZpY2VfdHlwZRIfLmdvb2dsZS5wcm90b2J1Zi5NZXNzYWdlT3B0aW9ucxjThgMgAygNUhBtYXR0ZXJEZXZpY2VUeXBlOlcKFm1hdHRlcl9jb21tYW5kX2NsdXN0ZXISHy5nb29nbGUucHJvdG9idWYuTWVzc2FnZU9wdGlvbnMY14YDIAEoDVIUbWF0dGVyQ29tbWFuZENsdXN0ZXI6UAoRbWF0dGVyX2NvbW1hbmRfaWQSHy5nb29nbGUucHJvdG9idWYuTWVzc2FnZU9wdGlvbnMY2IYDIAEoDVIPbWF0dGVyQ29tbWFuZElkiAEBQgJIAWIGcHJvdG8z", [file_google_protobuf_descriptor]);
+
+/**
+ * The Matter cluster this attribute belongs to, e.g. 0x0201 for Thermostat.
+ *
+ * Required alongside matter_attribute because a properties message may span
+ * clusters: DimmableLightProperties.on_off is On/Off (0x0006) while its
+ * current_level is Level Control (0x0008). Matches PropertyUpdate.cluster_id, which
+ * is a uint32 too, so the comparison needs no parsing.
+ *
+ * @generated from extension: uint32 matter_cluster_id = 50001;
+ */
+export const matter_cluster_id = /*@__PURE__*/
+  extDesc(file_kusinta_iot_device_v1_matter_options, 0);
+
+/**
+ * The Matter attribute name in the spec's own PascalCase, e.g.
+ * "PIROccupiedToUnoccupiedDelay". This is the authoritative spelling; the proto
+ * field name is not derived from it and must not be assumed to be. Matches
+ * PropertyUpdate.attribute_name byte for byte.
+ *
+ * @generated from extension: string matter_attribute = 50002;
+ */
+export const matter_attribute = /*@__PURE__*/
+  extDesc(file_kusinta_iot_device_v1_matter_options, 1);
+
+/**
+ * The Matter attribute ID within that cluster, e.g. 0x0012 for OccupiedHeatingSetpoint.
+ * This is what a PropertyUpdate resolves on — Matter addresses attributes numerically and
+ * so does this schema, because the generic cluster carrier must address attributes of
+ * clusters this schema does not model, and a vendor-defined cluster has no spec name to
+ * address it by. One scheme rather than two.
+ *
+ * matter_attribute above stays as the authoritative spelling for logs and for anything
+ * rendering an attribute to a human; it is not what resolution matches on.
+ *
+ * @generated from extension: uint32 matter_attribute_id = 50006;
+ */
+export const matter_attribute_id = /*@__PURE__*/
+  extDesc(file_kusinta_iot_device_v1_matter_options, 2);
+
+/**
+ * What the Matter specification says this attribute supports, as a bitmask:
+ * READ = 1, WRITE = 2, REPORT = 4. So a read-only reportable attribute is 5, a
+ * writable one 7, a write-only one 2.
+ *
+ * Two things this is NOT.
+ *
+ * It is not PERMISSION. access/v1/acl.proto's PermissionAction and allowed_actions
+ * say what a given user may do; this says what the attribute is capable of. They are
+ * orthogonal — a user can hold WRITE on an attribute no device will ever accept a
+ * write for, and the schema would be lying if either could be read off the other.
+ *
+ * It is not the IMPLEMENTED SET either. This is uniform for every device that reports
+ * the attribute, because it comes from the specification. Whether one particular
+ * device implements it at all is a runtime fact, carried per endpoint by
+ * ClusterState.attribute_ids — Matter's own AttributeList. A device may implement
+ * less than the specification allows; it may not implement more.
+ *
+ * Bit 4 is Matter's subscribable/reportable quality. Named REPORT rather than EVENT
+ * because Matter spends "event" on a separate concept; the vendor branch's
+ * equivalent bit means the same thing under its own name.
+ *
+ * @generated from extension: uint32 matter_attribute_capabilities = 50009;
+ */
+export const matter_attribute_capabilities = /*@__PURE__*/
+  extDesc(file_kusinta_iot_device_v1_matter_options, 3);
+
+/**
+ * The Matter device type IDs this properties message models, e.g. 0x0301 for
+ * Thermostat. Repeated because one shape of properties can serve several device
+ * types; empty on vendor extension messages, which have no Matter device type.
+ *
+ * A device type appears on at most one properties message, so the mapping from
+ * Endpoint.matter_device_type_id to an Endpoint.matter_properties case is a
+ * function.
+ *
+ * @generated from extension: repeated uint32 matter_device_type = 50003;
+ */
+export const matter_device_type = /*@__PURE__*/
+  extDesc(file_kusinta_iot_device_v1_matter_options, 4);
+
+/**
+ * The Matter cluster a command-parameters message belongs to, e.g. 0x0006 for On/Off.
+ * Always exactly one — a parameters message never spans clusters.
+ *
+ * @generated from extension: uint32 matter_command_cluster = 50007;
+ */
+export const matter_command_cluster = /*@__PURE__*/
+  extDesc(file_kusinta_iot_device_v1_matter_options, 5);
+
+/**
+ * The Matter command ID this parameters message carries arguments for, e.g. 0x00 for
+ * Thermostat's SetpointRaiseLower.
+ *
+ * Singular on purpose. An earlier form was repeated, so that one message could cover
+ * several commands and choose between them by its own fields — but a message that
+ * encodes WHICH command it is duplicates DeviceCommand.matter_command_id, in a second
+ * numbering, with nothing reconciling the two. The parameters carry arguments; the
+ * command ID says which command. A message shared by several commands that take the
+ * same arguments simply omits this and lets matter_command_id stand alone.
+ *
+ * @generated from extension: optional uint32 matter_command_id = 50008;
+ */
+export const matter_command_id = /*@__PURE__*/
+  extDesc(file_kusinta_iot_device_v1_matter_options, 6);
+