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:96

Methods

addInstallCode

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

backup

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

coordinatorCheck

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

createGroup

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

getCoordinatorVersion

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

getDeviceByIeeeAddr

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

getDeviceByNetworkAddress

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

getDeviceIeeeAddresses

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

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

getDevices

getDevices(): Device[]
Get all devices

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

getDevicesByType

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

getDevicesIterator

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

getGroupByID

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

getGroups

getGroups(): Group[]
Get all groups

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

getGroupsIterator

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

getNetworkParameters

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

getPermitJoin

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

getPermitJoinEnd

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

identifyUnknownDevice

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

isAdapterDisconnected

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

isStopping

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

permitJoin

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

reset

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

start

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

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

stop

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

touchlinkFactoryReset

touchlinkFactoryReset(ieeeAddr: string, channel: number): Promise<boolean>
Parameters
- ieeeAddr: string
- channel: number
Returns Promise<boolean>
- Defined in src/controller/controller.ts:240

touchlinkFactoryResetFirst

touchlinkFactoryResetFirst(): Promise<boolean>
Returns Promise<boolean>
- Defined in src/controller/controller.ts:244

touchlinkIdentify

touchlinkIdentify(ieeeAddr: string, channel: number): Promise<void>
Parameters
- ieeeAddr: string
- channel: number
Returns Promise<void>
- Defined in src/controller/controller.ts:232

touchlinkScan

touchlinkScan(): Promise<{ channel: number; ieeeAddr: string }[]>
Returns Promise<{ channel: number; ieeeAddr: string }[]>
- Defined in src/controller/controller.ts:236