AbstractRemoteControlService
On this page
- AbstractRemoteControlService ⇐
Abstract
- AbstractRemoteControlService()
- getReleaseVersion() ⇒
Promise.<String>
- getProductID() ⇒
Promise.<String>
- getVendorID() ⇒
Promise.<String>
- getMode() ⇒
Promise.<String>
- checkFirmwareUpdate() ⇒
Promise.<boolean>
- updateFirmware() ⇒
Promise
- pair() ⇒
Promise
- dasSearch() ⇒
Promise
- _getReleaseVersion() ⇒
Promise.<String>
- _getProductID() ⇒
Promise.<String>
- _getVendorID() ⇒
Promise.<String>
- _getMode() ⇒
Promise.<String>
- _checkFirmwareUpdate() ⇒
Promise.<boolean>
- _updateFirmware() ⇒
Promise.<*, Error>
- _pair() ⇒
Promise.<*, Error>
- _dasSearch() ⇒
Promise.<*, Error>
- _onFirmwareUpdateAvailable() ⇒
Promise
- _onFirmwareUpdateStart() ⇒
Promise
- _onFirmwareUpdateProgress(progress) ⇒
Promise
- _onFirmwareUpdateEnd() ⇒
Promise
- _onPairingDone() ⇒
Promise
- _onPairingProgress(progress) ⇒
Promise
- _onPairingError(error) ⇒
Promise
- _onDasSearchDone() ⇒
Promise
- _onDasSearchProgress(progress) ⇒
Promise
- _onDasSearchError(error) ⇒
Promise
- _onDasUnmappedKey(error) ⇒
Promise
- _onBatteryLow() ⇒
Promise
AbstractRemoteControlService ⇐ Abstract
Kind: global abstract class
Extends: Abstract
Service:
- AbstractRemoteControlService ⇐
Abstract
- new AbstractRemoteControlService()
- .getReleaseVersion() ⇒
Promise.<String>
- .getProductID() ⇒
Promise.<String>
- .getVendorID() ⇒
Promise.<String>
- .getMode() ⇒
Promise.<String>
- .checkFirmwareUpdate() ⇒
Promise.<boolean>
- .updateFirmware() ⇒
Promise
- .pair() ⇒
Promise
- .dasSearch() ⇒
Promise
- ._getReleaseVersion() ⇒
Promise.<String>
- ._getProductID() ⇒
Promise.<String>
- ._getVendorID() ⇒
Promise.<String>
- ._getMode() ⇒
Promise.<String>
- ._checkFirmwareUpdate() ⇒
Promise.<boolean>
- ._updateFirmware() ⇒
Promise.<*, Error>
- ._pair() ⇒
Promise.<*, Error>
- ._dasSearch() ⇒
Promise.<*, Error>
- ._onFirmwareUpdateAvailable() ⇒
Promise
- ._onFirmwareUpdateStart() ⇒
Promise
- ._onFirmwareUpdateProgress(progress) ⇒
Promise
- ._onFirmwareUpdateEnd() ⇒
Promise
- ._onPairingDone() ⇒
Promise
- ._onPairingProgress(progress) ⇒
Promise
- ._onPairingError(error) ⇒
Promise
- ._onDasSearchDone() ⇒
Promise
- ._onDasSearchProgress(progress) ⇒
Promise
- ._onDasSearchError(error) ⇒
Promise
- ._onDasUnmappedKey(error) ⇒
Promise
- ._onBatteryLow() ⇒
Promise
AbstractRemoteControlService()
Service to handle bluetooth remote control feature
getReleaseVersion() ⇒ Promise.<String>
Allows to retrieve remote control release version
Kind: instance method of AbstractRemoteControlService
getProductID() ⇒ Promise.<String>
Allows to retrieve remote control product ID
Kind: instance method of AbstractRemoteControlService
getVendorID() ⇒ Promise.<String>
Allows to retrieve remote control vendor ID
Kind: instance method of AbstractRemoteControlService
getMode() ⇒ Promise.<String>
Allows to retrieve remote control type
Kind: instance method of AbstractRemoteControlService
checkFirmwareUpdate() ⇒ Promise.<boolean>
Check for RCU firmware updates
Kind: instance method of AbstractRemoteControlService
Emits: AbstractRemoteControlService#event:firmwareUpdateAvailable
updateFirmware() ⇒ Promise
Allows to update remote control firmware
Kind: instance method of AbstractRemoteControlService
Emits: AbstractRemoteControlService#event:firmwareUpdateStart
, AbstractRemoteControlService#event:firmwareUpdateEnd
pair() ⇒ Promise
Allows to pair a device Note: AbstractRemoteControlService#pairingProgress must be trigger by implementation
Kind: instance method of AbstractRemoteControlService
Emits: AbstractRemoteControlService#event:pairingProgress
, AbstractRemoteControlService#event:pairingDone
dasSearch() ⇒ Promise
Allows to perform a DAS search Note: AbstractRemoteControlService#dasSearchProgress must be trigger by implementation
Kind: instance method of AbstractRemoteControlService
Emits: AbstractRemoteControlService#event:dasSearchProgress
, AbstractRemoteControlService#event:dasSearchDone
_getReleaseVersion() ⇒ Promise.<String>
Kind: instance abstract method of AbstractRemoteControlService
Access: protected
_getProductID() ⇒ Promise.<String>
Kind: instance abstract method of AbstractRemoteControlService
Access: protected
_getVendorID() ⇒ Promise.<String>
Kind: instance abstract method of AbstractRemoteControlService
Access: protected
_getMode() ⇒ Promise.<String>
Kind: instance abstract method of AbstractRemoteControlService
Access: protected
_checkFirmwareUpdate() ⇒ Promise.<boolean>
Kind: instance abstract method of AbstractRemoteControlService
_updateFirmware() ⇒ Promise.<*, Error>
Kind: instance abstract method of AbstractRemoteControlService
Returns: Promise.<*, Error>
- Promise resolved when update is done
Access: protected
_pair() ⇒ Promise.<*, Error>
Kind: instance abstract method of AbstractRemoteControlService
Returns: Promise.<*, Error>
- Promise resolved when pairing is done
Access: protected
_dasSearch() ⇒ Promise.<*, Error>
Kind: instance abstract method of AbstractRemoteControlService
Returns: Promise.<*, Error>
- Promise resolved when DAS search is done
Access: protected
_onFirmwareUpdateAvailable() ⇒ Promise
Kind: instance method of AbstractRemoteControlService
Access: protected
_onFirmwareUpdateStart() ⇒ Promise
Kind: instance method of AbstractRemoteControlService
Access: protected
_onFirmwareUpdateProgress(progress) ⇒ Promise
Kind: instance method of AbstractRemoteControlService
Access: protected
Param | Type | Description |
---|---|---|
progress | Number | Progress value between 0 and 100 |
_onFirmwareUpdateEnd() ⇒ Promise
Kind: instance method of AbstractRemoteControlService
Access: protected
_onPairingDone() ⇒ Promise
Kind: instance method of AbstractRemoteControlService
Access: protected
_onPairingProgress(progress) ⇒ Promise
Kind: instance method of AbstractRemoteControlService
Access: protected
Param | Type | Description |
---|---|---|
progress | number | Paring progress. |
_onPairingError(error) ⇒ Promise
Kind: instance method of AbstractRemoteControlService
Access: protected
Param | Type | Description |
---|---|---|
error | Error | Paring error. |
_onDasSearchDone() ⇒ Promise
Kind: instance method of AbstractRemoteControlService
Access: protected
_onDasSearchProgress(progress) ⇒ Promise
Kind: instance method of AbstractRemoteControlService
Access: protected
Param | Type | Description |
---|---|---|
progress | number | Paring progress. |
_onDasSearchError(error) ⇒ Promise
Kind: instance method of AbstractRemoteControlService
Access: protected
Param | Type | Description |
---|---|---|
error | Error | Paring error. |
_onDasUnmappedKey(error) ⇒ Promise
Kind: instance method of AbstractRemoteControlService
Access: protected
Param | Type | Description |
---|---|---|
error | Error | Paring error. |
_onBatteryLow() ⇒ Promise
Event triggered when remote control battery is low
Kind: instance method of AbstractRemoteControlService
Access: protected