_src_controller_model_group_.group.md

zigbee-herdsman

Globals / "src/controller/model/group" / Group

Class: Group

Hierarchy

• Entity

  ↳ Group

Index

Properties

• groupID
• meta

Accessors

• members

Methods

• addMember
• command
• hasMember
• read
• removeFromDatabase
• removeFromNetwork
• removeMember
• save
• write
• all
• byGroupID
• create
• injectAdapter
• injectDatabase

Properties

groupID

• Readonly groupID: number

Defined in src/controller/model/group.ts:25

---

meta

• Readonly meta: KeyValue

Defined in src/controller/model/group.ts:29

Accessors

members

• get members(): Endpoint[]

Defined in src/controller/model/group.ts:27

Returns: Endpoint[]

Methods

addMember

▸ addMember(endpoint: Endpoint): void

Defined in src/controller/model/group.ts:126

Parameters:

Name	Type
endpoint	Endpoint

Returns: void

---

command

▸ command(clusterKey: number | string, commandKey: number | string, payload: KeyValue, options?: Options): Promise<void>

Defined in src/controller/model/group.ts:206

Parameters:

Name	Type
clusterKey	number | string
commandKey	number | string
payload	KeyValue
options?	Options

Returns: Promise<void>

---

hasMember

▸ hasMember(endpoint: Endpoint): boolean

Defined in src/controller/model/group.ts:136

Parameters:

Name	Type
endpoint	Endpoint

Returns: boolean

---

read

▸ read(clusterKey: number | string, attributes: string[] | number[], options?: Options): Promise<void>

Defined in src/controller/model/group.ts:178

Parameters:

Name	Type
clusterKey	number | string
attributes	string[] | number[]
options?	Options

Returns: Promise<void>

---

removeFromDatabase

▸ removeFromDatabase(): void

Defined in src/controller/model/group.ts:112

Returns: void

---

removeFromNetwork

▸ removeFromNetwork(): Promise<void>

Defined in src/controller/model/group.ts:104

Returns: Promise<void>

---

removeMember

▸ removeMember(endpoint: Endpoint): void

Defined in src/controller/model/group.ts:131

Parameters:

Name	Type
endpoint	Endpoint

Returns: void

---

save

▸ save(): void

Defined in src/controller/model/group.ts:122

Returns: void

---

write

▸ write(clusterKey: number | string, attributes: KeyValue, options?: Options): Promise<void>

Defined in src/controller/model/group.ts:144

Parameters:

Name	Type
clusterKey	number | string
attributes	KeyValue
options?	Options

Returns: Promise<void>

---

all

▸ Staticall(): Group[]

Defined in src/controller/model/group.ts:84

Returns: Group[]

---

byGroupID

▸ StaticbyGroupID(groupID: number): Group

Defined in src/controller/model/group.ts:79

Parameters:

Name	Type
groupID	number

Returns: Group

---

create

▸ Staticcreate(groupID: number): Group

Defined in src/controller/model/group.ts:89

Parameters:

Name	Type
groupID	number

Returns: Group

---

injectAdapter

▸ StaticinjectAdapter(adapter: Adapter): void

Inherited from Group.injectAdapter

Defined in src/controller/model/entity.ts:12

Parameters:

Name	Type
adapter	Adapter

Returns: void

---

injectDatabase

▸ StaticinjectDatabase(database: Database): void

Inherited from Group.injectDatabase

Defined in src/controller/model/entity.ts:8

Parameters:

Name	Type
database	Database

Returns: void