Class LightService

Standard Light API service

Hierarchy (View Summary)

BaseEmbedService
- LightService

Index

Constructors

Methods

buildOptionsWithRequest decrementPower enumerate incrementPower setPower

Constructors

constructor

new LightService(): LightService
Returns LightService
Inherited from BaseEmbedService.constructor

Methods

`Protected` `Static`buildOptionsWithRequest

buildOptionsWithRequest(
    mType: string,
    shared: EmbedSharedParams,
    params?: null | EmbedRequestParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Construct embedded peripheral request object
Parameters
- mType: string
  Message type
- shared: EmbedSharedParams
  Shared request parameters
- params: null | EmbedRequestParams = null
  Request specific parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
Inherited from BaseEmbedService.buildOptionsWithRequest
- Defined in services/BaseEmbedService.ts:17

`Static`decrementPower

decrementPower(
    shared: EmbedSharedParams,
    params: LightPowerParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Decrement light power
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: LightPowerParams
  Decrement power request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/standard/LightService.ts:19

`Static`enumerate

enumerate(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Enumerate lights
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/standard/LightService.ts:34

`Static`incrementPower

incrementPower(
    shared: EmbedSharedParams,
    params: LightPowerParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Increment light power
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: LightPowerParams
  Increment power request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/standard/LightService.ts:50

`Static`setPower

setPower(
    shared: EmbedSharedParams,
    params: LightPowerParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Set light power
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: LightPowerParams
  Set power request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/standard/LightService.ts:66