devicediscoverysession.md

Ortho Remote - v0.4.0 / DeviceDiscoverySession

Class: DeviceDiscoverySession

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

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

Hierarchy

• EventEmitter

  ↳ DeviceDiscoverySession

Table of contents

Properties

• deviceManager

Accessors

• discoveredDevices
• discoveryState

Methods

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

Properties

deviceManager

• Readonly deviceManager: DeviceDiscoveryManager

Vending device manager

Accessors

discoveredDevices

• get discoveredDevices(): OrthoRemote[]

All discovered devices by the device manager

Returns: OrthoRemote[]

---

discoveryState

• get discoveryState(): DeviceDiscoveryState

Discovery state for the session

Returns: DeviceDiscoveryState

Methods

addListener

▸ addListener(eventName: "device", listener: OnDeviceDiscoveredCallback): DeviceDiscoverySession

Parameters

Name	Type
eventName	"device"
listener	OnDeviceDiscoveredCallback

Returns: DeviceDiscoverySession

Inherited from: EventEmitter.addListener

▸ addListener(eventName: "timeout", listener: OnEventCallback): DeviceDiscoverySession

Parameters

Name	Type
eventName	"timeout"
listener	OnEventCallback

Returns: DeviceDiscoverySession

Inherited from: EventEmitter.addListener

▸ addListener(eventName: "done", listener: OnDiscoveryDoneCallback): DeviceDiscoverySession

Parameters

Name	Type
eventName	"done"
listener	OnDiscoveryDoneCallback

Returns: DeviceDiscoverySession

Inherited from: EventEmitter.addListener

---

listenerCount

▸ listenerCount(type: "device" | "timeout" | "done"): number

Parameters

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

Returns: number

Inherited from: EventEmitter.listenerCount

---

listeners

▸ listeners(eventName: "device"): OnDeviceDiscoveredCallback[]

Parameters

Name	Type
eventName	"device"

Returns: OnDeviceDiscoveredCallback[]

Inherited from: EventEmitter.listeners

▸ listeners(eventName: "timeout"): OnEventCallback[]

Parameters

Name	Type
eventName	"timeout"

Returns: OnEventCallback[]

Inherited from: EventEmitter.listeners

▸ listeners(eventName: "done"): OnDiscoveryDoneCallback[]

Parameters

Name	Type
eventName	"done"

Returns: OnDiscoveryDoneCallback[]

Inherited from: EventEmitter.listeners

---

off

▸ off(eventName: "device", listener: OnDeviceDiscoveredCallback): DeviceDiscoverySession

Parameters

Name	Type
eventName	"device"
listener	OnDeviceDiscoveredCallback

Returns: DeviceDiscoverySession

Inherited from: EventEmitter.off

▸ off(eventName: "timeout", listener: OnEventCallback): DeviceDiscoverySession

Parameters

Name	Type
eventName	"timeout"
listener	OnEventCallback

Returns: DeviceDiscoverySession

Inherited from: EventEmitter.off

▸ off(eventName: "done", listener: OnDiscoveryDoneCallback): DeviceDiscoverySession

Parameters

Name	Type
eventName	"done"
listener	OnDiscoveryDoneCallback

Returns: DeviceDiscoverySession

Inherited from: EventEmitter.off

---

on

▸ on(eventName: "device", listener: OnDeviceDiscoveredCallback): DeviceDiscoverySession

Parameters

Name	Type
eventName	"device"
listener	OnDeviceDiscoveredCallback

Returns: DeviceDiscoverySession

Inherited from: EventEmitter.on

▸ on(eventName: "timeout", listener: OnEventCallback): DeviceDiscoverySession

Parameters

Name	Type
eventName	"timeout"
listener	OnEventCallback

Returns: DeviceDiscoverySession

Inherited from: EventEmitter.on

▸ on(eventName: "done", listener: OnDiscoveryDoneCallback): DeviceDiscoverySession

Parameters

Name	Type
eventName	"done"
listener	OnDiscoveryDoneCallback

Returns: DeviceDiscoverySession

Inherited from: EventEmitter.on

---

once

▸ once(eventName: "device", listener: OnDeviceDiscoveredCallback): DeviceDiscoverySession

Parameters

Name	Type
eventName	"device"
listener	OnDeviceDiscoveredCallback

Returns: DeviceDiscoverySession

Inherited from: EventEmitter.once

▸ once(eventName: "timeout", listener: OnEventCallback): DeviceDiscoverySession

Parameters

Name	Type
eventName	"timeout"
listener	OnEventCallback

Returns: DeviceDiscoverySession

Inherited from: EventEmitter.once

▸ once(eventName: "done", listener: OnDiscoveryDoneCallback): DeviceDiscoverySession

Parameters

Name	Type
eventName	"done"
listener	OnDiscoveryDoneCallback

Returns: DeviceDiscoverySession

Inherited from: EventEmitter.once

---

prependListener

▸ prependListener(eventName: "device", listener: OnDeviceDiscoveredCallback): DeviceDiscoverySession

Parameters

Name	Type
eventName	"device"
listener	OnDeviceDiscoveredCallback

Returns: DeviceDiscoverySession

Inherited from: EventEmitter.prependListener

▸ prependListener(eventName: "timeout", listener: OnEventCallback): DeviceDiscoverySession

Parameters

Name	Type
eventName	"timeout"
listener	OnEventCallback

Returns: DeviceDiscoverySession

Inherited from: EventEmitter.prependListener

▸ prependListener(eventName: "done", listener: OnDiscoveryDoneCallback): DeviceDiscoverySession

Parameters

Name	Type
eventName	"done"
listener	OnDiscoveryDoneCallback

Returns: DeviceDiscoverySession

Inherited from: EventEmitter.prependListener

---

prependOnceListener

▸ prependOnceListener(eventName: "device", listener: OnDeviceDiscoveredCallback): DeviceDiscoverySession

Parameters

Name	Type
eventName	"device"
listener	OnDeviceDiscoveredCallback

Returns: DeviceDiscoverySession

Inherited from: EventEmitter.prependOnceListener

▸ prependOnceListener(eventName: "timeout", listener: OnEventCallback): DeviceDiscoverySession

Parameters

Name	Type
eventName	"timeout"
listener	OnEventCallback

Returns: DeviceDiscoverySession

Inherited from: EventEmitter.prependOnceListener

▸ prependOnceListener(eventName: "done", listener: OnDiscoveryDoneCallback): DeviceDiscoverySession

Parameters

Name	Type
eventName	"done"
listener	OnDiscoveryDoneCallback

Returns: DeviceDiscoverySession

Inherited from: EventEmitter.prependOnceListener

---

removeListener

▸ removeListener(eventName: "device", listener: OnDeviceDiscoveredCallback): DeviceDiscoverySession

Parameters

Name	Type
eventName	"device"
listener	OnDeviceDiscoveredCallback

Returns: DeviceDiscoverySession

Inherited from: EventEmitter.removeListener

▸ removeListener(eventName: "timeout", listener: OnEventCallback): DeviceDiscoverySession

Parameters

Name	Type
eventName	"timeout"
listener	OnEventCallback

Returns: DeviceDiscoverySession

Inherited from: EventEmitter.removeListener

▸ removeListener(eventName: "done", listener: OnDiscoveryDoneCallback): 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?: boolean): Promise<OrthoRemote>

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<OrthoRemote>