Class LedService

Embedded LED API service

Hierarchy (View Summary)

BaseEmbedService
- LedService

Index

Constructors

Methods

buildOptionsWithRequest greenFlashing greenPulse greenSet greenSetOff greenSetOn redFlashing redPulse redSet redSetOff redSetOn

Constructors

constructor

new LedService(): LedService
Returns LedService
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`greenFlashing

greenFlashing(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Flash green LED continuously
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/LedService.ts:93

`Static`greenPulse

greenPulse(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Generate green LED pulse
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/LedService.ts:108

`Static`greenSet

greenSet(
    shared: EmbedSharedParams,
    params: EmbedRequestParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Set green LED on or off
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: EmbedRequestParams
  LEDG set parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/LedService.ts:124

`Static`greenSetOff

greenSetOff(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Set green LED off
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/LedService.ts:139

`Static`greenSetOn

greenSetOn(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Set green LED off
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/LedService.ts:154

`Static`redFlashing

redFlashing(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Flash red LED continuously
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/LedService.ts:17

`Static`redPulse

redPulse(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Generate red LED pulse
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/LedService.ts:32

`Static`redSet

redSet(
    shared: EmbedSharedParams,
    params: EmbedRequestParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Set red LED on or off
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: EmbedRequestParams
  LEDR set parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/LedService.ts:48

`Static`redSetOff

redSetOff(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Set red LED off
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/LedService.ts:63

`Static`redSetOn

redSetOn(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Set red LED on
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/LedService.ts:78

Class LedService

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Returns LedService

Methods

Protected StaticbuildOptionsWithRequest

Parameters

Returns DaemonMessageOptions

StaticgreenFlashing

Parameters

Returns DaemonMessageOptions

StaticgreenPulse

Parameters

Returns DaemonMessageOptions

StaticgreenSet

Parameters

Returns DaemonMessageOptions

StaticgreenSetOff

Parameters

Returns DaemonMessageOptions

StaticgreenSetOn

Parameters

Returns DaemonMessageOptions

StaticredFlashing

Parameters

Returns DaemonMessageOptions

StaticredPulse

Parameters

Returns DaemonMessageOptions

StaticredSet

Parameters

Returns DaemonMessageOptions

StaticredSetOff

Parameters

Returns DaemonMessageOptions

StaticredSetOn

Parameters

Returns DaemonMessageOptions

Settings

On This Page

`Protected` `Static`buildOptionsWithRequest

`Static`greenFlashing

`Static`greenPulse

`Static`greenSet

`Static`greenSetOff

`Static`greenSetOn

`Static`redFlashing

`Static`redPulse

`Static`redSet

`Static`redSetOff

`Static`redSetOn