_controller_controller_.controller.md

zigbee-herdsman › "controller/controller" › Controller

Class: Controller

Hierarchy

• EventEmitter

  ↳ Controller

Index

Constructors

• constructor

Methods

• createGroup
• getCoordinatorVersion
• getDeviceByIeeeAddr
• getDevices
• getDevicesByType
• getGroupByID
• getGroups
• getNetworkParameters
• getPermitJoin
• permitJoin
• reset
• setLED
• start
• stop
• supportsLED

Constructors

constructor

+ new Controller(options: Options): Controller

Defined in controller/controller.ts:67

Create a controller

To auto detect the port provide null for options.serialPort.path

Parameters:

Name	Type
options	Options

Returns: Controller

Methods

createGroup

▸ createGroup(groupID: number): Group

Defined in controller/controller.ts:244

Create a Group

Parameters:

Name	Type
groupID	number

Returns: Group

---

getCoordinatorVersion

▸ getCoordinatorVersion(): Promise‹CoordinatorVersion›

Defined in controller/controller.ts:198

Returns: Promise‹CoordinatorVersion›

---

getDeviceByIeeeAddr

▸ getDeviceByIeeeAddr(ieeeAddr: string): Device

Defined in controller/controller.ts:223

Get device by ieeeAddr

Parameters:

Name	Type
ieeeAddr	string

Returns: Device

---

getDevices

▸ getDevices(): Device[]

Defined in controller/controller.ts:209

Get all devices

Returns: Device[]

---

getDevicesByType

▸ getDevicesByType(type: DeviceType): Device[]

Defined in controller/controller.ts:216

Get all devices with a specific type

Parameters:

Name	Type
type	DeviceType

Returns: Device[]

---

getGroupByID

▸ getGroupByID(groupID: number): Group

Defined in controller/controller.ts:230

Get group by ID

Parameters:

Name	Type
groupID	number

Returns: Group

---

getGroups

▸ getGroups(): Group[]

Defined in controller/controller.ts:237

Get all groups

Returns: Group[]

---

getNetworkParameters

▸ getNetworkParameters(): Promise‹NetworkParameters›

Defined in controller/controller.ts:202

Returns: Promise‹NetworkParameters›

---

getPermitJoin

▸ getPermitJoin(): boolean

Defined in controller/controller.ts:158

Returns: boolean

---

permitJoin

▸ permitJoin(permit: boolean): Promise‹void›

Defined in controller/controller.ts:135

Parameters:

Name	Type
permit	boolean

Returns: Promise‹void›

---

reset

▸ reset(type: "soft" | "hard"): Promise‹void›

Defined in controller/controller.ts:194

Parameters:

Name	Type
type	"soft" | "hard"

Returns: Promise‹void›

---

setLED

▸ setLED(enabled: boolean): Promise‹void›

Defined in controller/controller.ts:258

Enable/Disable the LED

Parameters:

Name	Type
enabled	boolean

Returns: Promise‹void›

---

start

▸ start(): Promise‹void›

Defined in controller/controller.ts:89

Start the Herdsman controller

Returns: Promise‹void›

---

stop

▸ stop(): Promise‹void›

Defined in controller/controller.ts:162

Returns: Promise‹void›

---

supportsLED

▸ supportsLED(): Promise‹boolean›

Defined in controller/controller.ts:251

Check if the adapters supports LED

Returns: Promise‹boolean›