devicediscoverymanager.md

Rocket Nuimo - v1.2.1 / DeviceDiscoveryManager

Class: DeviceDiscoveryManager

A device manager is the main entry for connecting to Nuimo devices. It offers device discovery and

Hierarchy

• EventEmitter

  ↳ DeviceDiscoveryManager

Table of contents

Properties

• defaultManager

Accessors

• discoveredDevices
• discoveryState

Methods

• addListener
• listenerCount
• listeners
• off
• on
• once
• prependListener
• prependOnceListener
• removeListener
• startDiscoverySession
• stopDiscovery
• stopDiscoverySession

Properties

defaultManager

▪ Static defaultManager: DeviceDiscoveryManager

Default device discovery manager to manage discovery of one or more Nuimo devices

Accessors

discoveredDevices

• get discoveredDevices(): NuimoControlDevice[]

All discovered devices by the device manager

Returns

NuimoControlDevice[]

---

discoveryState

• get discoveryState(): DeviceDiscoveryState

Active discovery state

Returns

DeviceDiscoveryState

Methods

addListener

▸ addListener(eventName, listener): DeviceDiscoveryManager

Parameters

Name	Type
eventName	"device"
listener	OnDeviceDiscoveredCallback

Returns

DeviceDiscoveryManager

Inherited from

EventEmitter.addListener

▸ addListener(eventName, listener): DeviceDiscoveryManager

Parameters

Name	Type
eventName	"error"
listener	OnErrorCallback

Returns

DeviceDiscoveryManager

Inherited from

EventEmitter.addListener

▸ addListener(eventName, listener): DeviceDiscoveryManager

Parameters

Name	Type
eventName	"started" | "stopped"
listener	OnEventCallback

Returns

DeviceDiscoveryManager

Inherited from

EventEmitter.addListener

---

listenerCount

▸ listenerCount(type): number

Parameters

Name	Type
type	"error" | "device" | "started" | "stopped"

Returns

number

Inherited from

EventEmitter.listenerCount

---

listeners

▸ listeners(eventName): OnDeviceDiscoveredCallback[]

Parameters

Name	Type
eventName	"device"

Returns

OnDeviceDiscoveredCallback[]

Inherited from

EventEmitter.listeners

▸ listeners(eventName): OnErrorCallback[]

Parameters

Name	Type
eventName	"error"

Returns

OnErrorCallback[]

Inherited from

EventEmitter.listeners

▸ listeners(eventName): OnEventCallback[]

Parameters

Name	Type
eventName	"started" | "stopped"

Returns

OnEventCallback[]

Inherited from

EventEmitter.listeners

---

off

▸ off(eventName, listener): DeviceDiscoveryManager

Parameters

Name	Type
eventName	"device"
listener	OnDeviceDiscoveredCallback

Returns

DeviceDiscoveryManager

Inherited from

EventEmitter.off

▸ off(eventName, listener): DeviceDiscoveryManager

Parameters

Name	Type
eventName	"error"
listener	OnErrorCallback

Returns

DeviceDiscoveryManager

Inherited from

EventEmitter.off

▸ off(eventName, listener): DeviceDiscoveryManager

Parameters

Name	Type
eventName	"started" | "stopped"
listener	OnEventCallback

Returns

DeviceDiscoveryManager

Inherited from

EventEmitter.off

---

on

▸ on(eventName, listener): DeviceDiscoveryManager

Parameters

Name	Type
eventName	"device"
listener	OnDeviceDiscoveredCallback

Returns

DeviceDiscoveryManager

Inherited from

EventEmitter.on

▸ on(eventName, listener): DeviceDiscoveryManager

Parameters

Name	Type
eventName	"error"
listener	OnErrorCallback

Returns

DeviceDiscoveryManager

Inherited from

EventEmitter.on

▸ on(eventName, listener): DeviceDiscoveryManager

Parameters

Name	Type
eventName	"started" | "stopped"
listener	OnEventCallback

Returns

DeviceDiscoveryManager

Inherited from

EventEmitter.on

---

once

▸ once(eventName, listener): DeviceDiscoveryManager

Parameters

Name	Type
eventName	"device"
listener	OnDeviceDiscoveredCallback

Returns

DeviceDiscoveryManager

Inherited from

EventEmitter.once

▸ once(eventName, listener): DeviceDiscoveryManager

Parameters

Name	Type
eventName	"error"
listener	OnErrorCallback

Returns

DeviceDiscoveryManager

Inherited from

EventEmitter.once

▸ once(eventName, listener): DeviceDiscoveryManager

Parameters

Name	Type
eventName	"started" | "stopped"
listener	OnEventCallback

Returns

DeviceDiscoveryManager

Inherited from

EventEmitter.once

---

prependListener

▸ prependListener(eventName, listener): DeviceDiscoveryManager

Parameters

Name	Type
eventName	"device"
listener	OnDeviceDiscoveredCallback

Returns

DeviceDiscoveryManager

Inherited from

EventEmitter.prependListener

▸ prependListener(eventName, listener): DeviceDiscoveryManager

Parameters

Name	Type
eventName	"error"
listener	OnErrorCallback

Returns

DeviceDiscoveryManager

Inherited from

EventEmitter.prependListener

▸ prependListener(eventName, listener): DeviceDiscoveryManager

Parameters

Name	Type
eventName	"started" | "stopped"
listener	OnEventCallback

Returns

DeviceDiscoveryManager

Inherited from

EventEmitter.prependListener

---

prependOnceListener

▸ prependOnceListener(eventName, listener): DeviceDiscoveryManager

Parameters

Name	Type
eventName	"device"
listener	OnDeviceDiscoveredCallback

Returns

DeviceDiscoveryManager

Inherited from

EventEmitter.prependOnceListener

▸ prependOnceListener(eventName, listener): DeviceDiscoveryManager

Parameters

Name	Type
eventName	"error"
listener	OnErrorCallback

Returns

DeviceDiscoveryManager

Inherited from

EventEmitter.prependOnceListener

▸ prependOnceListener(eventName, listener): DeviceDiscoveryManager

Parameters

Name	Type
eventName	"started" | "stopped"
listener	OnEventCallback

Returns

DeviceDiscoveryManager

Inherited from

EventEmitter.prependOnceListener

---

removeListener

▸ removeListener(eventName, listener): DeviceDiscoveryManager

Parameters

Name	Type
eventName	"device"
listener	OnDeviceDiscoveredCallback

Returns

DeviceDiscoveryManager

Inherited from

EventEmitter.removeListener

▸ removeListener(eventName, listener): DeviceDiscoveryManager

Parameters

Name	Type
eventName	"error"
listener	OnErrorCallback

Returns

DeviceDiscoveryManager

Inherited from

EventEmitter.removeListener

▸ removeListener(eventName, listener): DeviceDiscoveryManager

Parameters

Name	Type
eventName	"started" | "stopped"
listener	OnEventCallback

Returns

DeviceDiscoveryManager

Inherited from

EventEmitter.removeListener

---

startDiscoverySession

▸ startDiscoverySession(options?): DeviceDiscoverySession

Start a new discovery session to discover Nuimo devices

Parameters

Name	Type	Description
options?	DeviceDiscoverySessionOptions	discovery session options

Returns

DeviceDiscoverySession

Session object initialized based on options and to observe discovery events on

---

stopDiscovery

▸ stopDiscovery(): void

Stops all discovery sessions in progress

Returns

void

---

stopDiscoverySession

▸ stopDiscoverySession(session): void

Stops and removes a session from the list of managed sessions. When all session have been removed discovery will cease.

Parameters

Name	Type	Description
session	DeviceDiscoverySession	session to remove

Returns

void