Class Controller

No Inherit Doc

Hierarchy

EventEmitter<ControllerEventMap>
- Controller

Constructors

constructor

new Controller(options: Options): Controller
Create a controller

To auto detect the port provide null for options.serialPort.path
Parameters
- options: Options
Returns Controller
Overrides events.EventEmitter<ControllerEventMap>.constructor
- Defined in src/controller/controller.ts:95

Accessors

greenPower

get greenPower(): GreenPower
Returns GreenPower
- Defined in src/controller/controller.ts:122

touchlink

get touchlink(): Touchlink
Returns Touchlink
- Defined in src/controller/controller.ts:126

Methods

addInstallCode

addInstallCode(installCode: string): Promise<void>
Parameters
- installCode: string
Returns Promise<void>
- Defined in src/controller/controller.ts:352

backup

backup(): Promise<void>
Returns Promise<void>
- Defined in src/controller/controller.ts:469

coordinatorCheck

coordinatorCheck(): Promise<{ missingRouters: Device[] }>
Returns Promise<{ missingRouters: Device[] }>
- Defined in src/controller/controller.ts:482

createGroup

createGroup(groupID: number): Group
Create a Group
Parameters
- groupID: number
Returns Group
- Defined in src/controller/controller.ts:589

getCoordinatorVersion

getCoordinatorVersion(): Promise<CoordinatorVersion>
Returns Promise<CoordinatorVersion>
- Defined in src/controller/controller.ts:502

getDeviceByIeeeAddr

getDeviceByIeeeAddr(ieeeAddr: string): Device | undefined
Get device by ieeeAddr
Parameters
- ieeeAddr: string
Returns Device | undefined
- Defined in src/controller/controller.ts:540

getDeviceByNetworkAddress

getDeviceByNetworkAddress(networkAddress: number): Device | undefined
Get device by networkAddress
Parameters
- networkAddress: number
Returns Device | undefined
- Defined in src/controller/controller.ts:547

getDeviceIeeeAddresses

getDeviceIeeeAddresses(): string[]
Get IEEE address for all devices

Returns string[]
- Defined in src/controller/controller.ts:554

getDevices

getDevices(): Device[]
Get all devices

Returns Device[]
Deprecated
use getDevicesIterator()
- Defined in src/controller/controller.ts:519

getDevicesByType

getDevicesByType(type: DeviceType): Device[]
Get all devices with a specific type
Parameters
- type: DeviceType
Returns Device[]
- Defined in src/controller/controller.ts:533

getDevicesIterator

getDevicesIterator(predicate?: (value: Device) => boolean): Generator<Device>
Get iterator for all devices
Parameters
- Optionalpredicate: (value: Device) => boolean
Returns Generator<Device>
- Defined in src/controller/controller.ts:526

getGroupByID

getGroupByID(groupID: number): Group | undefined
Get group by ID
Parameters
- groupID: number
Returns Group | undefined
- Defined in src/controller/controller.ts:567

getGroups

getGroups(): Group[]
Get all groups

Returns Group[]
Deprecated
use getGroupsIterator()
- Defined in src/controller/controller.ts:575

getGroupsIterator

getGroupsIterator(predicate?: (value: Group) => boolean): Generator<Group>
Get iterator for all groups
Parameters
- Optionalpredicate: (value: Group) => boolean
Returns Generator<Group>
- Defined in src/controller/controller.ts:582

getNetworkParameters

getNetworkParameters(): Promise<NetworkParameters>
Returns Promise<NetworkParameters>
- Defined in src/controller/controller.ts:506

getPermitJoin

getPermitJoin(): boolean
Returns boolean
- Defined in src/controller/controller.ts:407

getPermitJoinEnd

getPermitJoinEnd(): number | undefined
Returns number | undefined
- Defined in src/controller/controller.ts:411

identifyUnknownDevice

identifyUnknownDevice(nwkAddress: number): Promise<Device | undefined>
Parameters
- nwkAddress: number
Returns Promise<Device | undefined>
- Defined in src/controller/controller.ts:626

isAdapterDisconnected

isAdapterDisconnected(): boolean
Returns boolean
- Defined in src/controller/controller.ts:419

isStopping

isStopping(): boolean
Returns boolean
- Defined in src/controller/controller.ts:415

permitJoin

permitJoin(time: number, device?: Device): Promise<void>
Parameters
- time: number
- Optionaldevice: Device
Returns Promise<void>
- Defined in src/controller/controller.ts:375

reset

reset(type: "soft" | "hard"): Promise<void>
Parameters
- type: "soft" | "hard"
Returns Promise<void>
- Defined in src/controller/controller.ts:498

sendRaw

sendRaw(
rawPayload: RawPayload,
customClusters?: CustomClusters,
): Promise<ZclPayload | GenericZdoResponse | undefined>
Send a request according to given payload.
Parameters
- rawPayload: RawPayload
  Payload used to determine and build the request
- customClusters: CustomClusters = {}
  Manually passed custom clusters used in ZCL serialization (if any, if matching)
Returns Promise<ZclPayload | GenericZdoResponse | undefined>
A response may or may not be returned depending on given payload (up to caller to verify)
- Defined in src/controller/controller.ts:248

start

start(): Promise<StartResult>
Start the Herdsman controller

Returns Promise<StartResult>
- Defined in src/controller/controller.ts:133

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in src/controller/controller.ts:423