Class: BacklightLevelController
Defined in: src/sdk/utils/controllers/Backlight.ts:17
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
Defined in: src/sdk/utils/controllers/Backlight.ts:60
Creates an automatic backlight controller.
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
bus | EventBus | undefined | The event bus. |
paused | boolean | false | Whether the controller should be initially paused. Defaults to false . |
minIntensity | number | BacklightLevelController.DEFAULT_MIN_INTENSITY | The maximum intensity commanded by the controller. Defaults to 0. |
maxIntensity | number | BacklightLevelController.DEFAULT_MAX_INTENSITY | The minimum intensity commanded by the controller. Defaults to 1. |
Returns
BacklightLevelController
Properties
intensity
readonly
intensity:Subscribable
<number
>
Defined in: src/sdk/utils/controllers/Backlight.ts:51
The automatic backlight intensity computed by this controller.
Accessors
autoMaxIntensity
Get Signature
get autoMaxIntensity():
number
Defined in: src/sdk/utils/controllers/Backlight.ts:82
Get the max auto intensity value
Returns
number
The maximum intensity applied by the auto backlight.
Set Signature
set autoMaxIntensity(
max_intensity
):void
Defined in: src/sdk/utils/controllers/Backlight.ts:90
Set the max auto intensity value.
Parameters
Parameter | Type | Description |
---|---|---|
max_intensity | number | The maximum intensity applied by auto backlight. |
Returns
void
autoMinIntensity
Get Signature
get autoMinIntensity():
number
Defined in: src/sdk/utils/controllers/Backlight.ts:99
Get the min auto intensity value
Returns
number
THe minimum intensity applied by the auto backlight.
Set Signature
set autoMinIntensity(
min_intensity
):void
Defined in: src/sdk/utils/controllers/Backlight.ts:107
Set the min auto intensity value.
Parameters
Parameter | Type | Description |
---|---|---|
min_intensity | number | The minimum intensity applied by the auto backlight. |
Returns
void
Methods
setPaused()
setPaused(
paused
):void
Defined in: src/sdk/utils/controllers/Backlight.ts:116
Pause or unpause real-time processing.
Parameters
Parameter | Type | Description |
---|---|---|
paused | boolean | Whether to pause or not. |
Returns
void