Class CoordinatorService

Embedded Coordinator API service

Hierarchy (View Summary)

BaseEmbedService
- CoordinatorService

Index

Constructors

Methods

addrInfo authorizeBond backup bondedDevices bondIquip bondNode buildOptionsWithRequest clearAllBonds discoveredDevices discovery restore setDpaParam setHops setMid smartConnect

Constructors

constructor

new CoordinatorService(): CoordinatorService
Returns CoordinatorService
Inherited from BaseEmbedService.constructor

Methods

`Static`addrInfo

addrInfo(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Get addressing information
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/CoordinatorService.ts:30

`Static`authorizeBond

authorizeBond(
    shared: EmbedSharedParams,
    params: AuthorizeBondParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Authorize bond
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: AuthorizeBondParams
  Authorize bond request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/CoordinatorService.ts:46

`Static`backup

backup(
    shared: EmbedSharedParams,
    params: EmbedBackupParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Backup coordinator data
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: EmbedBackupParams
  Backup request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/CoordinatorService.ts:62

`Static`bondedDevices

bondedDevices(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Get bonded devices
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/CoordinatorService.ts:112

`Static`bondIquip

bondIquip(options: DaemonMessageOptions): DaemonMessageOptions
Bond IQUIP tool the network
Parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/CoordinatorService.ts:76

`Static`bondNode

bondNode(
    shared: EmbedSharedParams,
    params: EmbedBondNodeParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Bond new node device
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: EmbedBondNodeParams
  Bond node request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/CoordinatorService.ts:97

`Protected` `Static`buildOptionsWithRequest

buildOptionsWithRequest(
    mType: string,
    shared: EmbedSharedParams,
    params?: null | EmbedRequestParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Construct embedded peripheral request object
Parameters
- mType: string
  Message type
- shared: EmbedSharedParams
  Shared request parameters
- params: null | EmbedRequestParams = null
  Request specific parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
Inherited from BaseEmbedService.buildOptionsWithRequest
- Defined in services/BaseEmbedService.ts:17

`Static`clearAllBonds

clearAllBonds(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Clear all bonds
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/CoordinatorService.ts:127

`Static`discoveredDevices

discoveredDevices(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Get discovered devices
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/CoordinatorService.ts:142

`Static`discovery

discovery(
    shared: EmbedSharedParams,
    params: DiscoveryParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Run discovery
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: DiscoveryParams
  Discovery request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/CoordinatorService.ts:158

`Static`restore

restore(
    shared: EmbedSharedParams,
    params: CoordinatorRestoreParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Restore coordinator data
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: CoordinatorRestoreParams
  Discovery request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/CoordinatorService.ts:174

`Static`setDpaParam

setDpaParam(
    shared: EmbedSharedParams,
    params: EmbedSetDpaParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Set DPA param
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: EmbedSetDpaParams
  Set DPA param request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/CoordinatorService.ts:190

`Static`setHops

setHops(
    shared: EmbedSharedParams,
    params: EmbedSetHopsParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Set request and response hops
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: EmbedSetHopsParams
  Set hops request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/CoordinatorService.ts:206

`Static`setMid

setMid(
    shared: EmbedSharedParams,
    params: AddrMidPairParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Set device module ID
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: AddrMidPairParams
  Set MID request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/CoordinatorService.ts:222

`Static`smartConnect

smartConnect(
    shared: EmbedSharedParams,
    params: EmbedSmartConnectParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Smart connect
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: EmbedSmartConnectParams
  SmartConnect request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/CoordinatorService.ts:238

Class CoordinatorService

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Returns CoordinatorService

Methods

StaticaddrInfo

Parameters

Returns DaemonMessageOptions

StaticauthorizeBond

Parameters

Returns DaemonMessageOptions

Staticbackup

Parameters

Returns DaemonMessageOptions

StaticbondedDevices

Parameters

Returns DaemonMessageOptions

StaticbondIquip

Parameters

Returns DaemonMessageOptions

StaticbondNode

Parameters

Returns DaemonMessageOptions

Protected StaticbuildOptionsWithRequest

Parameters

Returns DaemonMessageOptions

StaticclearAllBonds

Parameters

Returns DaemonMessageOptions

StaticdiscoveredDevices

Parameters

Returns DaemonMessageOptions

Staticdiscovery

Parameters

Returns DaemonMessageOptions

Staticrestore

Parameters

Returns DaemonMessageOptions

StaticsetDpaParam

Parameters

Returns DaemonMessageOptions

StaticsetHops

Parameters

Returns DaemonMessageOptions

StaticsetMid

Parameters

Returns DaemonMessageOptions

StaticsmartConnect

Parameters

Returns DaemonMessageOptions

Settings

On This Page

`Static`addrInfo

`Static`authorizeBond

`Static`backup

`Static`bondedDevices

`Static`bondIquip

`Static`bondNode

`Protected` `Static`buildOptionsWithRequest

`Static`clearAllBonds

`Static`discoveredDevices

`Static`discovery

`Static`restore

`Static`setDpaParam

`Static`setHops

`Static`setMid

`Static`smartConnect