dishwasheralarm

package
v0.8.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 19, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

Package dishwasheralarm is the generated definition of the Matter DishwasherAlarm cluster (0x005D, revision 1, derived from AlarmBase), from the matter.js model at 862ad75 (Matter 1.6.1).

It declares the cluster's ids, typed enums, bitmaps and structs with their TLV codecs, the command and event payloads, and Definition, the metadata the cluster/spec runtime derives lists, privileges and write checks from. Importing the package registers the definition with spec.Register, so the bridge decodes the cluster's request payloads.

Index

Constants

View Source 
const (
	ClusterID uint32 = 0x005D
	Name             = "DishwasherAlarm"
	Revision  uint16 = 1
)

Cluster identity.

View Source 
const (
	AttrMask      uint32 = 0x0000 // AlarmBitmap, M, R V
	AttrLatch     uint32 = 0x0001 // AlarmBitmap, RESET, R V, F
	AttrState     uint32 = 0x0002 // AlarmBitmap, M, R V
	AttrSupported uint32 = 0x0003 // AlarmBitmap, M, R V, F
)

Attribute ids.

View Source 
const (
	CmdReset               uint32 = 0x00 // request → status, RESET
	CmdModifyEnabledAlarms uint32 = 0x01 // request → status, O
)

Command ids.

View Source 
const (
	EventNotify uint32 = 0x00 // info, M
)

Event ids.

Variables

View Source 
var AlarmBitmapDef = &spec.Bitmap{Name: "AlarmBitmap", Bits: 32, Members: []spec.BitmapMember{
	{Name: "InflowError", Bit: 0, Width: 1, Conformance: spec.Conformance{Text: "P, O.a+", Op: spec.ConfOtherwise, Args: []spec.Conformance{{Op: spec.ConfProvisional}, {Op: spec.ConfChoice, Choice: &spec.Choice{Name: "a", Num: 1, OrMore: true, OrLess: false}, Args: []spec.Conformance{{Op: spec.ConfOptional}}}}}},
	{Name: "DrainError", Bit: 1, Width: 1, Conformance: spec.Conformance{Text: "P, O.a+", Op: spec.ConfOtherwise, Args: []spec.Conformance{{Op: spec.ConfProvisional}, {Op: spec.ConfChoice, Choice: &spec.Choice{Name: "a", Num: 1, OrMore: true, OrLess: false}, Args: []spec.Conformance{{Op: spec.ConfOptional}}}}}},
	{Name: "DoorError", Bit: 2, Width: 1, Conformance: spec.Conformance{Text: "O.a+", Op: spec.ConfChoice, Choice: &spec.Choice{Name: "a", Num: 1, OrMore: true, OrLess: false}, Args: []spec.Conformance{{Op: spec.ConfOptional}}}},
	{Name: "TempTooLow", Bit: 3, Width: 1, Conformance: spec.Conformance{Text: "P, O.a+", Op: spec.ConfOtherwise, Args: []spec.Conformance{{Op: spec.ConfProvisional}, {Op: spec.ConfChoice, Choice: &spec.Choice{Name: "a", Num: 1, OrMore: true, OrLess: false}, Args: []spec.Conformance{{Op: spec.ConfOptional}}}}}},
	{Name: "TempTooHigh", Bit: 4, Width: 1, Conformance: spec.Conformance{Text: "P, O.a+", Op: spec.ConfOtherwise, Args: []spec.Conformance{{Op: spec.ConfProvisional}, {Op: spec.ConfChoice, Choice: &spec.Choice{Name: "a", Num: 1, OrMore: true, OrLess: false}, Args: []spec.Conformance{{Op: spec.ConfOptional}}}}}},
	{Name: "WaterLevelError", Bit: 5, Width: 1, Conformance: spec.Conformance{Text: "P, O.a+", Op: spec.ConfOtherwise, Args: []spec.Conformance{{Op: spec.ConfProvisional}, {Op: spec.ConfChoice, Choice: &spec.Choice{Name: "a", Num: 1, OrMore: true, OrLess: false}, Args: []spec.Conformance{{Op: spec.ConfOptional}}}}}},
}}

AlarmBitmapDef describes AlarmBitmap.

fabric:reachable:reason="generated: referenced from Definition and the generated test; a package-level initializer, which RTA does not follow"

View Source 
var Definition = &spec.Cluster{
	ID: ClusterID, Name: Name, Revision: Revision,
	Base: "AlarmBase",
	Features: []spec.Feature{
		{Name: "RESET", Title: "Reset", Bit: 0, Conformance: spec.Conformance{Text: "O", Op: spec.ConfOptional}},
	},
	Attributes: []spec.Attribute{
		{
			ID: AttrMask, Name: "Mask",
			Type:        spec.Type{Name: "AlarmBitmap", Kind: spec.KindBitmap, Bits: 32, Bitmap: AlarmBitmapDef},
			Conformance: spec.Conformance{Text: "M", Op: spec.ConfMandatory},
			Access:      spec.Access{RW: "R", Read: spec.PrivilegeView},
		},
		{
			ID: AttrLatch, Name: "Latch",
			Type:        spec.Type{Name: "AlarmBitmap", Kind: spec.KindBitmap, Bits: 32, Bitmap: AlarmBitmapDef},
			Conformance: spec.Conformance{Text: "RESET", Op: spec.ConfName, Name: "RESET"},
			Access:      spec.Access{RW: "R", Read: spec.PrivilegeView},
			Quality:     spec.Quality{Fixed: true},
		},
		{
			ID: AttrState, Name: "State",
			Type:        spec.Type{Name: "AlarmBitmap", Kind: spec.KindBitmap, Bits: 32, Bitmap: AlarmBitmapDef},
			Conformance: spec.Conformance{Text: "M", Op: spec.ConfMandatory},
			Access:      spec.Access{RW: "R", Read: spec.PrivilegeView},
		},
		{
			ID: AttrSupported, Name: "Supported",
			Type:        spec.Type{Name: "AlarmBitmap", Kind: spec.KindBitmap, Bits: 32, Bitmap: AlarmBitmapDef},
			Conformance: spec.Conformance{Text: "M", Op: spec.ConfMandatory},
			Access:      spec.Access{RW: "R", Read: spec.PrivilegeView},
			Quality:     spec.Quality{Fixed: true},
		},
	},
	Commands: []spec.Command{
		{
			ID: CmdReset, Name: "Reset", Direction: spec.Request,
			Response:    "status",
			Conformance: spec.Conformance{Text: "RESET", Op: spec.ConfName, Name: "RESET"},
			Access:      spec.Access{RW: "R", Read: spec.PrivilegeOperate, Write: spec.PrivilegeOperate},
			Fields: []spec.Field{
				{ID: 0, Name: "Alarms", Type: spec.Type{Name: "AlarmBitmap", Kind: spec.KindBitmap, Bits: 32, Bitmap: AlarmBitmapDef}, Conformance: spec.Conformance{Text: "M", Op: spec.ConfMandatory}},
			},
			Decode: decodeResetRequest,
		},
		{
			ID: CmdModifyEnabledAlarms, Name: "ModifyEnabledAlarms", Direction: spec.Request,
			Response:    "status",
			Conformance: spec.Conformance{Text: "O", Op: spec.ConfOptional},
			Access:      spec.Access{RW: "R", Read: spec.PrivilegeOperate, Write: spec.PrivilegeOperate},
			Fields: []spec.Field{
				{ID: 0, Name: "Mask", Type: spec.Type{Name: "AlarmBitmap", Kind: spec.KindBitmap, Bits: 32, Bitmap: AlarmBitmapDef}, Conformance: spec.Conformance{Text: "M", Op: spec.ConfMandatory}},
			},
			Decode: decodeModifyEnabledAlarmsRequest,
		},
	},
	Events: []spec.Event{
		{
			ID: EventNotify, Name: "Notify", Priority: spec.PriorityInfo,
			Conformance: spec.Conformance{Text: "M", Op: spec.ConfMandatory},
			Access:      spec.Access{RW: "R", Read: spec.PrivilegeView},
			Fields: []spec.Field{
				{ID: 0, Name: "Active", Type: spec.Type{Name: "AlarmBitmap", Kind: spec.KindBitmap, Bits: 32, Bitmap: AlarmBitmapDef}, Conformance: spec.Conformance{Text: "M", Op: spec.ConfMandatory}},
				{ID: 1, Name: "Inactive", Type: spec.Type{Name: "AlarmBitmap", Kind: spec.KindBitmap, Bits: 32, Bitmap: AlarmBitmapDef}, Conformance: spec.Conformance{Text: "M", Op: spec.ConfMandatory}},
				{ID: 2, Name: "State", Type: spec.Type{Name: "AlarmBitmap", Kind: spec.KindBitmap, Bits: 32, Bitmap: AlarmBitmapDef}, Conformance: spec.Conformance{Text: "M", Op: spec.ConfMandatory}},
				{ID: 3, Name: "Mask", Type: spec.Type{Name: "AlarmBitmap", Kind: spec.KindBitmap, Bits: 32, Bitmap: AlarmBitmapDef}, Conformance: spec.Conformance{Text: "M", Op: spec.ConfMandatory}},
			},
			Decode: decodeNotifyEvent,
		},
	},
}

Definition is the DishwasherAlarm cluster definition.

Functions

This section is empty.

Types

type AlarmBitmap 

type AlarmBitmap uint32

AlarmBitmap is the AlarmBitmap map32.

fabric:reachable:reason="generated: referenced from Definition and the generated test; a package-level initializer, which RTA does not follow" 

const (
	AlarmInflowError     AlarmBitmap = 1 << 0 // P, O.a+
	AlarmDrainError      AlarmBitmap = 1 << 1 // P, O.a+
	AlarmDoorError       AlarmBitmap = 1 << 2 // O.a+
	AlarmTempTooLow      AlarmBitmap = 1 << 3 // P, O.a+
	AlarmTempTooHigh     AlarmBitmap = 1 << 4 // P, O.a+
	AlarmWaterLevelError AlarmBitmap = 1 << 5 // P, O.a+
)

AlarmBitmap bits; a member wider than one bit is its mask.

type Feature 

type Feature uint32

Feature is a DishwasherAlarm FeatureMap bit.

fabric:reachable:reason="generated: referenced from Definition and the generated test; a package-level initializer, which RTA does not follow" 

const (
	FeatureReset Feature = 1 << 0 // RESET, O
)

FeatureMap bits.

type ModifyEnabledAlarmsRequest 

type ModifyEnabledAlarmsRequest struct {
	Mask AlarmBitmap // 0: AlarmBitmap, M
}

ModifyEnabledAlarmsRequest is the ModifyEnabledAlarms command payload.

func (*ModifyEnabledAlarmsRequest) DecodeTLV 

func (v *ModifyEnabledAlarmsRequest) DecodeTLV(n spec.Node) error

DecodeTLV decodes the structure n into v.

func (ModifyEnabledAlarmsRequest) EncodeTLV 

func (v ModifyEnabledAlarmsRequest) EncodeTLV(enc *tlv.Encoder, tag tlv.Tag)

EncodeTLV implements spec.Encodable.

type NotifyEvent 

type NotifyEvent struct {
	Active   AlarmBitmap // 0: AlarmBitmap, M
	Inactive AlarmBitmap // 1: AlarmBitmap, M
	State    AlarmBitmap // 2: AlarmBitmap, M
	Mask     AlarmBitmap // 3: AlarmBitmap, M
}

NotifyEvent is the Notify event payload.

func (*NotifyEvent) DecodeTLV 

func (v *NotifyEvent) DecodeTLV(n spec.Node) error

DecodeTLV decodes the structure n into v.

func (NotifyEvent) EncodeTLV 

func (v NotifyEvent) EncodeTLV(enc *tlv.Encoder, tag tlv.Tag)

EncodeTLV implements spec.Encodable.

type ResetRequest 

type ResetRequest struct {
	Alarms AlarmBitmap // 0: AlarmBitmap, M
}

ResetRequest is the Reset command payload.

func (*ResetRequest) DecodeTLV 

func (v *ResetRequest) DecodeTLV(n spec.Node) error

DecodeTLV decodes the structure n into v.

func (ResetRequest) EncodeTLV 

func (v ResetRequest) EncodeTLV(enc *tlv.Encoder, tag tlv.Tag)

EncodeTLV implements spec.Encodable.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.