Class default

No Inherit Doc

Hierarchy

EventEmitter<ControllerEventMap>
- default

Constructors

constructor

new default(options): default
Create a controller

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

Methods

addInstallCode

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

backup

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

coordinatorCheck

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

createGroup

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

getCoordinatorVersion

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

getDeviceByIeeeAddr

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

getDeviceByNetworkAddress

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

getDeviceIeeeAddresses

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

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

getDevices

getDevices(): default[]
Get all devices

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

getDevicesByType

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

getDevicesIterator

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

getGroupByID

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

getGroups

getGroups(): default[]
Get all groups

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

getGroupsIterator

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

getNetworkParameters

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

getPermitJoin

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

getPermitJoinTimeout

getPermitJoinTimeout(): undefined | number
Returns undefined | number
- Defined in src/controller/controller.ts:332

identifyUnknownDevice

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

isAdapterDisconnected

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

isStopping

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

permitJoin

permitJoin(permit, device?, time?): Promise<void>
Parameters
- permit: boolean
- Optionaldevice: default
- Optionaltime: number
Returns Promise<void>
- Defined in src/controller/controller.ts:277

permitJoinInternal

permitJoinInternal(permit, reason, device?, time?): Promise<void>
Parameters
- permit: boolean
- reason: "manual" | "timer_expired"
- Optionaldevice: default
- Optionaltime: number
Returns Promise<void>
- Defined in src/controller/controller.ts:281

reset

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

setTransmitPower

setTransmitPower(value): Promise<void>
Set transmit power of the adapter
Parameters
- value: number
Returns Promise<void>
- Defined in src/controller/controller.ts:529

start

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

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

stop

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

touchlinkFactoryReset

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

touchlinkFactoryResetFirst

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

touchlinkIdentify

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

touchlinkScan

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