zigbee-herdsman › "controller/controller" › Controller
-
EventEmitter
↳ Controller
- createGroup
- getCoordinatorVersion
- getDeviceByIeeeAddr
- getDevices
- getDevicesByType
- getGroupByID
- getGroups
- getNetworkParameters
- getPermitJoin
- permitJoin
- reset
- setLED
- start
- stop
- supportsLED
+ 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
▸ createGroup(groupID
: number): Group
Defined in controller/controller.ts:244
Create a Group
Parameters:
Name | Type |
---|---|
groupID |
number |
Returns: Group
▸ getCoordinatorVersion(): Promise‹CoordinatorVersion›
Defined in controller/controller.ts:198
Returns: Promise‹CoordinatorVersion›
▸ getDeviceByIeeeAddr(ieeeAddr
: string): Device
Defined in controller/controller.ts:223
Get device by ieeeAddr
Parameters:
Name | Type |
---|---|
ieeeAddr |
string |
Returns: Device
▸ getDevices(): Device[]
Defined in controller/controller.ts:209
Get all devices
Returns: Device[]
▸ 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(groupID
: number): Group
Defined in controller/controller.ts:230
Get group by ID
Parameters:
Name | Type |
---|---|
groupID |
number |
Returns: Group
▸ getGroups(): Group[]
Defined in controller/controller.ts:237
Get all groups
Returns: Group[]
▸ getNetworkParameters(): Promise‹NetworkParameters›
Defined in controller/controller.ts:202
Returns: Promise‹NetworkParameters›
▸ getPermitJoin(): boolean
Defined in controller/controller.ts:158
Returns: boolean
▸ permitJoin(permit
: boolean): Promise‹void›
Defined in controller/controller.ts:135
Parameters:
Name | Type |
---|---|
permit |
boolean |
Returns: Promise‹void›
▸ reset(type
: "soft" | "hard"): Promise‹void›
Defined in controller/controller.ts:194
Parameters:
Name | Type |
---|---|
type |
"soft" | "hard" |
Returns: Promise‹void›
▸ setLED(enabled
: boolean): Promise‹void›
Defined in controller/controller.ts:258
Enable/Disable the LED
Parameters:
Name | Type |
---|---|
enabled |
boolean |
Returns: Promise‹void›
▸ start(): Promise‹void›
Defined in controller/controller.ts:89
Start the Herdsman controller
Returns: Promise‹void›
▸ stop(): Promise‹void›
Defined in controller/controller.ts:162
Returns: Promise‹void›
▸ supportsLED(): Promise‹boolean›
Defined in controller/controller.ts:251
Check if the adapters supports LED
Returns: Promise‹boolean›