Skip to main content

Class: BacklightLevelController

A controller for automated backlighting levels based upon the angle of the sun in the sky.

Constructors

constructor

new BacklightLevelController(bus, paused?, minIntensity?, maxIntensity?): BacklightLevelController

Creates an automatic backlight controller.

Parameters

NameTypeDefault valueDescription
busEventBusundefinedThe event bus.
pausedbooleanfalseWhether the controller should be initially paused. Defaults to false.
minIntensitynumberBacklightLevelController.DEFAULT_MIN_INTENSITYThe maximum intensity commanded by the controller. Defaults to 0.
maxIntensitynumberBacklightLevelController.DEFAULT_MAX_INTENSITYThe minimum intensity commanded by the controller. Defaults to 1.

Returns

BacklightLevelController

Defined in

src/sdk/utils/controllers/Backlight.ts:60

Properties

intensity

Readonly intensity: Subscribable<number>

The automatic backlight intensity computed by this controller.

Defined in

src/sdk/utils/controllers/Backlight.ts:51

Accessors

autoMaxIntensity

get autoMaxIntensity(): number

Get the max auto intensity value

Returns

number

The maximum intensity applied by the auto backlight.

Defined in

src/sdk/utils/controllers/Backlight.ts:82

set autoMaxIntensity(max_intensity): void

Set the max auto intensity value.

Parameters

NameTypeDescription
max_intensitynumberThe maximum intensity applied by auto backlight.

Returns

void

Defined in

src/sdk/utils/controllers/Backlight.ts:90


autoMinIntensity

get autoMinIntensity(): number

Get the min auto intensity value

Returns

number

THe minimum intensity applied by the auto backlight.

Defined in

src/sdk/utils/controllers/Backlight.ts:99

set autoMinIntensity(min_intensity): void

Set the min auto intensity value.

Parameters

NameTypeDescription
min_intensitynumberThe minimum intensity applied by the auto backlight.

Returns

void

Defined in

src/sdk/utils/controllers/Backlight.ts:107

Methods

setPaused

setPaused(paused): void

Pause or unpause real-time processing.

Parameters

NameTypeDescription
pausedbooleanWhether to pause or not.

Returns

void

Defined in

src/sdk/utils/controllers/Backlight.ts:116