Skip to content

DeviceConfigurationService.md

Latest commit

 

History

History
599 lines (353 loc) · 11.2 KB

DeviceConfigurationService.md

File metadata and controls

599 lines (353 loc) · 11.2 KB
Raw

incyclist-services - v1.2.2 / DeviceConfigurationService

Class: DeviceConfigurationService

Manages the user configuration of devices and interfaces

  • Detected Devices and Sensors
  • Selected Devices and Sensors per Capability
  • Cycling Mode settings for all devices.
  • Enabled/Disabled Interfaces

Hierarchy

  • EventEmitter

    ↳ DeviceConfigurationService

Table of contents

Constructors

Properties

Methods

Events

Constructors

constructor

• new DeviceConfigurationService(): DeviceConfigurationService

Returns

DeviceConfigurationService

Overrides

EventEmitter.constructor

Properties

settings

• settings: DeviceConfigurationSettings

userSettings

• userSettings: UserSettingsService

adapters

• adapters: DeviceAdapterList = {}

Methods

init

▸ init(): Promise<void>

Initializes the Device Settings

It will use the [[UserSettingsService]] to read the data and stores it in the [[settings]] property

The init method will check if the settings format is

Returns

Promise<void>

Emits

initialized Emitted once the configuration is fully initialized

setFeature

▸ setFeature(name, enabled): void

Parameters

Name Type
name string
enabled boolean

Returns

void

isInitialized

▸ isInitialized(): boolean

Provides the initialization state of the interface

Returns

boolean

true if the interface has been initialized, false otherwise

initFromLegacy

▸ initFromLegacy(settings?): void

Parameters

Name Type
settings LegacySettings

Returns

void

load

▸ load(): Object

Returns

Object

Name Type
capabilities DeviceConfigurationInfo
interfaces InterfaceSetting[]

disableCapability

▸ disableCapability(cability, disabled?): void

Parameters

Name Type Default value
cability ExtendedIncyclistCapability undefined
disabled boolean true

Returns

void

unselect

▸ unselect(capability, shouldEmit?): void

Parameters

Name Type Default value
capability ExtendedIncyclistCapability undefined
shouldEmit boolean true

Returns

void

add

▸ add(deviceSettings, props?): string

Parameters

Name Type
deviceSettings IncyclistDeviceSettings
props? Object
props.legacy? boolean

Returns

string

delete

▸ delete(udid, capability?, forceSingle?): void

Parameters

Name Type Default value
udid string undefined
capability? ExtendedIncyclistCapability undefined
forceSingle boolean false

Returns

void

getUdid

▸ getUdid(deviceSettings): string

Parameters

Name Type
deviceSettings IncyclistDeviceSettings

Returns

string

setDisplayName

▸ setDisplayName(deviceSettings, displayName?): void

Parameters

Name Type
deviceSettings IncyclistDeviceSettings
displayName? string

Returns

void

getAdapter

▸ getAdapter(udid): IncyclistDeviceAdapter

Parameters

Name Type
udid string

Returns

IncyclistDeviceAdapter

updateUserSettings

▸ updateUserSettings(): void

Returns

void

canStartRide

▸ canStartRide(): boolean

provides information if for all requires capabilities a device has been selected, so that a training can be started

Returns

boolean

getModeSettings

▸ getModeSettings(requestedUdid?, requestedMode?): DeviceModeInfo

Parameters

Name Type
requestedUdid? string
requestedMode? string

Returns

DeviceModeInfo

setMode

▸ setMode(udid, mode): void

Parameters

Name Type
udid string
mode string

Returns

void

setModeSettings

▸ setModeSettings(udid, mode, settings): void

Parameters

Name Type
udid string
mode string
settings any

Returns

void

emitModeChanged

▸ emitModeChanged(udid, mode, settings): void

Parameters

Name Type
udid string
mode string
settings any

Returns

void

getAdapters

▸ getAdapters(onlySelected?): AdapterInfo[]

provides the list of adapters (to be used by the DeviceRideService and DevicePairingService )

Parameters

Name Type Default value Description
onlySelected boolean true if set to true, only Adapters of selected devices will be returned

Returns

AdapterInfo[]

The AdapterInfo List or an empty array

getAllAdapters

▸ getAllAdapters(): AdapterInfo[]

provides the list of all adapters (to be used by the DeviceRideService)

Returns

AdapterInfo[]

getSelected

▸ getSelected(capability): IncyclistDeviceAdapter

Parameters

Name Type
capability ExtendedIncyclistCapability

Returns

IncyclistDeviceAdapter

getSelectedDevices

▸ getSelectedDevices(capability?): { capability: IncyclistCapability ; selected?: string }[]

Parameters

Name Type
capability? IncyclistCapability

Returns

{ capability: IncyclistCapability ; selected?: string }[]

getInterfaceSettings

▸ getInterfaceSettings(ifName): InterfaceSetting

Parameters

Name Type
ifName string

Returns

InterfaceSetting

isInterfaceEnabled

▸ isInterfaceEnabled(ifName): boolean

Parameters

Name Type
ifName string

Returns

boolean

enableInterface

▸ enableInterface(ifName): void

Parameters

Name Type
ifName string

Returns

void

disableInterface

▸ disableInterface(ifName): void

Parameters

Name Type
ifName string

Returns

void

setInterfaceSettings

▸ setInterfaceSettings(ifName, settings): void

Parameters

Name Type
ifName any
settings InterfaceSetting

Returns

void

emitInterfaceChanged

▸ emitInterfaceChanged(ifName): void

Parameters

Name Type
ifName string

Returns

void

emitDeviceDeleted

▸ emitDeviceDeleted(settings): void

Parameters

Name Type
settings IncyclistDeviceSettings

Returns

void

getInstance

▸ getInstance(): DeviceConfigurationService

Returns

DeviceConfigurationService

Events

select

▸ select(udid, capability, props?): void

Marks a device as selected for a given capability

Parameters

Name Type Description
udid string The unique device id of the device
capability ExtendedIncyclistCapability The cability for which the device should be marked as selected device-changed in case the settings were changed device-added in case the device was not yet known
props? Object -
props.noRecursive? boolean -
props.legacy? boolean -
props.emit? boolean -

Returns

void