devicediscoverysession.md

Rocket Nuimo - v1.2.1 / DeviceDiscoverySession

Class: DeviceDiscoverySession

A single discovery session, keeping the vending manager monitor for Nuimo devices

Do not create a session manually, instead use DeviceDiscoveryManager to start discovery

Hierarchy

• EventEmitter

  ↳ DeviceDiscoverySession

Table of contents

Constructors

• constructor

Properties

• deviceManager

Accessors

• discoveredDevices
• discoveryState

Methods

• addListener
• listenerCount
• listeners
• off
• on
• once
• prependListener
• prependOnceListener
• removeListener
• stop
• waitForFirstDevice

Constructors

constructor

• new DeviceDiscoverySession(manager, options?)

Parameters

Name	Type	Description
manager	DeviceDiscoveryManager	vending discovery manager
options?	DeviceDiscoverySessionOptions	-

Overrides

EventEmitter.constructor

Properties

deviceManager

• Readonly deviceManager: DeviceDiscoveryManager

Vending device manager

Accessors

discoveredDevices

• get discoveredDevices(): NuimoControlDevice[]

All discovered devices by the device manager

Returns

NuimoControlDevice[]

---

discoveryState

• get discoveryState(): DeviceDiscoveryState

Discovery state for the session

Returns

DeviceDiscoveryState

Methods

addListener

▸ addListener(eventName, listener): DeviceDiscoverySession

Parameters

Name	Type
eventName	"device"
listener	OnDeviceDiscoveredCallback

Returns

DeviceDiscoverySession

Inherited from

EventEmitter.addListener

▸ addListener(eventName, listener): DeviceDiscoverySession

Parameters

Name	Type
eventName	"timeout"
listener	OnEventCallback

Returns

DeviceDiscoverySession

Inherited from

EventEmitter.addListener

▸ addListener(eventName, listener): DeviceDiscoverySession

Parameters

Name	Type
eventName	"done"
listener	OnDiscoveryDoneCallback

Returns

DeviceDiscoverySession

Inherited from

EventEmitter.addListener

---

listenerCount

▸ listenerCount(type): number

Parameters

Name	Type
type	"device" | "timeout" | "done"

Returns

number

Inherited from

EventEmitter.listenerCount

---

listeners

▸ listeners(eventName): OnDeviceDiscoveredCallback[]

Parameters

Name	Type
eventName	"device"

Returns

OnDeviceDiscoveredCallback[]

Inherited from

EventEmitter.listeners

▸ listeners(eventName): OnEventCallback[]

Parameters

Name	Type
eventName	"timeout"

Returns

OnEventCallback[]

Inherited from

EventEmitter.listeners

▸ listeners(eventName): OnDiscoveryDoneCallback[]

Parameters

Name	Type
eventName	"done"

Returns

OnDiscoveryDoneCallback[]

Inherited from

EventEmitter.listeners

---

off

▸ off(eventName, listener): DeviceDiscoverySession

Parameters

Name	Type
eventName	"device"
listener	OnDeviceDiscoveredCallback

Returns

DeviceDiscoverySession

Inherited from

EventEmitter.off

▸ off(eventName, listener): DeviceDiscoverySession

Parameters

Name	Type
eventName	"timeout"
listener	OnEventCallback

Returns

DeviceDiscoverySession

Inherited from

EventEmitter.off

▸ off(eventName, listener): DeviceDiscoverySession

Parameters

Name	Type
eventName	"done"
listener	OnDiscoveryDoneCallback

Returns

DeviceDiscoverySession

Inherited from

EventEmitter.off

---

on

▸ on(eventName, listener): DeviceDiscoverySession

Parameters

Name	Type
eventName	"device"
listener	OnDeviceDiscoveredCallback

Returns

DeviceDiscoverySession

Inherited from

EventEmitter.on

▸ on(eventName, listener): DeviceDiscoverySession

Parameters

Name	Type
eventName	"timeout"
listener	OnEventCallback

Returns

DeviceDiscoverySession

Inherited from

EventEmitter.on

▸ on(eventName, listener): DeviceDiscoverySession

Parameters

Name	Type
eventName	"done"
listener	OnDiscoveryDoneCallback

Returns

DeviceDiscoverySession

Inherited from

EventEmitter.on

---

once

▸ once(eventName, listener): DeviceDiscoverySession

Parameters

Name	Type
eventName	"device"
listener	OnDeviceDiscoveredCallback

Returns

DeviceDiscoverySession

Inherited from

EventEmitter.once

▸ once(eventName, listener): DeviceDiscoverySession

Parameters

Name	Type
eventName	"timeout"
listener	OnEventCallback

Returns

DeviceDiscoverySession

Inherited from

EventEmitter.once

▸ once(eventName, listener): DeviceDiscoverySession

Parameters

Name	Type
eventName	"done"
listener	OnDiscoveryDoneCallback

Returns

DeviceDiscoverySession

Inherited from

EventEmitter.once

---

prependListener

▸ prependListener(eventName, listener): DeviceDiscoverySession

Parameters

Name	Type
eventName	"device"
listener	OnDeviceDiscoveredCallback

Returns

DeviceDiscoverySession

Inherited from

EventEmitter.prependListener

▸ prependListener(eventName, listener): DeviceDiscoverySession

Parameters

Name	Type
eventName	"timeout"
listener	OnEventCallback

Returns

DeviceDiscoverySession

Inherited from

EventEmitter.prependListener

▸ prependListener(eventName, listener): DeviceDiscoverySession

Parameters

Name	Type
eventName	"done"
listener	OnDiscoveryDoneCallback

Returns

DeviceDiscoverySession

Inherited from

EventEmitter.prependListener

---

prependOnceListener

▸ prependOnceListener(eventName, listener): DeviceDiscoverySession

Parameters

Name	Type
eventName	"device"
listener	OnDeviceDiscoveredCallback

Returns

DeviceDiscoverySession

Inherited from

EventEmitter.prependOnceListener

▸ prependOnceListener(eventName, listener): DeviceDiscoverySession

Parameters

Name	Type
eventName	"timeout"
listener	OnEventCallback

Returns

DeviceDiscoverySession

Inherited from

EventEmitter.prependOnceListener

▸ prependOnceListener(eventName, listener): DeviceDiscoverySession

Parameters

Name	Type
eventName	"done"
listener	OnDiscoveryDoneCallback

Returns

DeviceDiscoverySession

Inherited from

EventEmitter.prependOnceListener

---

removeListener

▸ removeListener(eventName, listener): DeviceDiscoverySession

Parameters

Name	Type
eventName	"device"
listener	OnDeviceDiscoveredCallback

Returns

DeviceDiscoverySession

Inherited from

EventEmitter.removeListener

▸ removeListener(eventName, listener): DeviceDiscoverySession

Parameters

Name	Type
eventName	"timeout"
listener	OnEventCallback

Returns

DeviceDiscoverySession

Inherited from

EventEmitter.removeListener

▸ removeListener(eventName, listener): DeviceDiscoverySession

Parameters

Name	Type
eventName	"done"
listener	OnDiscoveryDoneCallback

Returns

DeviceDiscoverySession

Inherited from

EventEmitter.removeListener

---

stop

▸ stop(): void

Stop device discover for this session

Returns

void

---

waitForFirstDevice

▸ waitForFirstDevice(autoStop?): Promise<NuimoControlDevice>

Waits for a single (first) device or until time out, if specified when creating the session

throw NuimoDeviceError when timing out

Parameters

Name	Type	Default value
autoStop	boolean	true

Returns

Promise<NuimoControlDevice>