Backlight services - Revision history

Hexkyz at 23:10, 9 September 2024

2024-09-09T21:10:23Z

← Older revision		Revision as of 01:10, 10 September 2024
Line 68:		Line 68:
	\| 29 \|\| [7.0.0+] IsAutoBrightnessControlSupported		\| 29 \|\| [7.0.0+] IsAutoBrightnessControlSupported
	\|}		\|}

	~~== Ambient Light Sensor Notes ==~~
	The BH1730 outputs 2 values. Visible light and IR light. This is then calculated through an algorithm that checks for Gain, Measurement time, filter qualities and ouputs lux (max correct measurement of 100K lux).
	The default values are Gain 64x and ITIME of 38 (256 - 218). This allows for a max lux value of 17972 lux when visible light value is maximum and IR light is 0. When both of them are on their limit, the output is 1192 lux.
	~~The sensor is fully configurable.~~

	== GetAmbientLightSensorValue ==		== GetAmbientLightSensorValue ==
Line 107:		Line 102:
	== IsVrModeEnabled ==		== IsVrModeEnabled ==
	No input. Returns an output u8 bool set by the above commands.		No input. Returns an output u8 bool set by the above commands.

			= Notes =
			The BH1730 outputs 2 values. Visible light and IR light. This is then calculated through an algorithm that checks for Gain, Measurement time, filter qualities and ouputs lux (max correct measurement of 100K lux).
			The default values are Gain 64x and ITIME of 38 (256 - 218). This allows for a max lux value of 17972 lux when visible light value is maximum and IR light is 0. When both of them are on their limit, the output is 1192 lux.
			The sensor is fully configurable.

	[[Category:Services]]		[[Category:Services]]

Hexkyz at 17:05, 14 April 2020

2020-04-14T15:05:11Z

← Older revision		Revision as of 19:05, 14 April 2020
Line 1:		Line 1:
	= lbl =		= lbl =
	This is "nn::lbl::detail::ILblController".		This is "nn::lbl::detail::ILblController".

			This was moved to [[PTM_services\|PTM]] with [10.0.0+].

	{\| class="wikitable" border="1"		{\| class="wikitable" border="1"

Hexkyz: Add official name

2020-02-29T17:16:49Z

Add official name

← Older revision		Revision as of 20:16, 29 February 2020
Line 64:		Line 64:
	\| 28 \|\| [3.0.0+] [[#IsVrModeEnabled]]		\| 28 \|\| [3.0.0+] [[#IsVrModeEnabled]]
	\|-		\|-
	\| 29 \|\| [7.0.0+] ~~IsAlsEnabled~~		\| 29 \|\| [7.0.0+] IsAutoBrightnessControlSupported
	\|}		\|}

Shchmue: /* lbl */ Name cmd29

2020-02-28T22:33:44Z

lbl: Name cmd29

← Older revision		Revision as of 01:33, 29 February 2020
Line 64:		Line 64:
	\| 28 \|\| [3.0.0+] [[#IsVrModeEnabled]]		\| 28 \|\| [3.0.0+] [[#IsVrModeEnabled]]
	\|-		\|-
	\| 29 \|\| [7.0.0+]		\| 29 \|\| [7.0.0+] IsAlsEnabled
	\|}		\|}

Hexkyz: /* lbl */

2019-03-24T15:54:55Z

lbl

← Older revision		Revision as of 18:54, 24 March 2019
Line 63:		Line 63:
	\|-		\|-
	\| 28 \|\| [3.0.0+] [[#IsVrModeEnabled]]		\| 28 \|\| [3.0.0+] [[#IsVrModeEnabled]]
			\|-
			\| 29 \|\| [7.0.0+]
	\|}		\|}

Ctcaer at 01:21, 15 January 2019

2019-01-15T00:21:55Z

← Older revision		Revision as of 03:21, 15 January 2019
Line 38:		Line 38:
	\| 15 \|\| SetAmbientLightSensorValue		\| 15 \|\| SetAmbientLightSensorValue
	\|-		\|-
	\| 16 \|\| GetAmbientLightSensorValue		\| 16 \|\| [[#GetAmbientLightSensorValue]]
	\|-		\|-
	\| 17 \|\| SetBrightnessReflectionDelayLevel		\| 17 \|\| SetBrightnessReflectionDelayLevel
Line 64:		Line 64:
	\| 28 \|\| [3.0.0+] [[#IsVrModeEnabled]]		\| 28 \|\| [3.0.0+] [[#IsVrModeEnabled]]
	\|}		\|}

			== Ambient Light Sensor Notes ==
			The BH1730 outputs 2 values. Visible light and IR light. This is then calculated through an algorithm that checks for Gain, Measurement time, filter qualities and ouputs lux (max correct measurement of 100K lux).
			The default values are Gain 64x and ITIME of 38 (256 - 218). This allows for a max lux value of 17972 lux when visible light value is maximum and IR light is 0. When both of them are on their limit, the output is 1192 lux.
			The sensor is fully configurable.

	== GetAmbientLightSensorValue ==		== GetAmbientLightSensorValue ==
Line 71:		Line 76:
	! Offset \|\| Size \|\| Description		! Offset \|\| Size \|\| Description
	\|-		\|-
	\| 0x0 \|\| 0x4 \|\| ~~bAbove13k~~. (u32) Equals to 1 if ~~fLux >= 13000~~.		\| 0x0 \|\| 0x4 \|\| bOverLimit. (u32) Equals to 1 if visible or IR light data is over 65534.
	\|-		\|-
	\| 0x4 \|\| 0x4 \|\| fLux. (float) Value in lux from the ambient light sensor.		\| 0x4 \|\| 0x4 \|\| fLux. (float) Value in lux from the ambient light sensor.
	\|}		\|}
	Note: if ~~bAbove13k~~ = 1 ~~then~~ the ~~real lux~~ value ~~equals to (13000~~ - ~~fLux) + 13000 and caps out at ~25000~~.		Note: if bOverLimit=1 and the default ALS configuration is used, the measurement of fLux should not be considered and the actual max value depends on the type of light. Ranges from 12.5K - 17.5K.

	== GetCurrentBrightnessSetting ==		== GetCurrentBrightnessSetting ==

P-sam: /* GetAmbientLightSensorValue */ Add 4.1.0 and current behavior

2019-01-04T08:52:17Z

GetAmbientLightSensorValue: Add 4.1.0 and current behavior

← Older revision		Revision as of 11:52, 4 January 2019
Line 66:		Line 66:

	== GetAmbientLightSensorValue ==		== GetAmbientLightSensorValue ==
	No input. Returns an output struct:		No input. Before 5.x, outputs lux in float. (5.0.0+) Returns an output struct:
	{\| class="wikitable" border="1"		{\| class="wikitable" border="1"
	\|-		\|-
	! Offset \|\| Size \|\| Description		! Offset \|\| Size \|\| Description
	\|-		\|-
	\| 0x0 \|\| 0x4 \|\| ~~bSunny~~. (u32) Equals to 1 if fLux >= ~~10000~~.		\| 0x0 \|\| 0x4 \|\| bAbove13k. (u32) Equals to 1 if fLux >= 13000.
	\|-		\|-
	\| 0x4 \|\| 0x4 \|\| fLux. (float) Value in lux from the ambient light sensor.		\| 0x4 \|\| 0x4 \|\| fLux. (float) Value in lux from the ambient light sensor.
	\|}		\|}
			Note: if bAbove13k = 1 then the real lux value equals to (13000 - fLux) + 13000 and caps out at ~25000.

	== GetCurrentBrightnessSetting ==		== GetCurrentBrightnessSetting ==

P-sam: describe more properly the struct returned by GetAmbientLightSensorValue

2019-01-01T15:26:56Z

describe more properly the struct returned by GetAmbientLightSensorValue

← Older revision		Revision as of 18:26, 1 January 2019
Line 66:		Line 66:

	== GetAmbientLightSensorValue ==		== GetAmbientLightSensorValue ==
	No input. Returns an output float of the ~~current~~ ambient light sensor ~~value (unit: lux)~~. ~~Note: float seems to be preceded by an u32 int (zeroes)~~		No input. Returns an output struct:
			{\| class="wikitable" border="1"
			\|-
			! Offset \|\| Size \|\| Description
			\|-
			\| 0x0 \|\| 0x4 \|\| bSunny. (u32) Equals to 1 if fLux >= 10000.
			\|-
			\| 0x4 \|\| 0x4 \|\| fLux. (float) Value in lux from the ambient light sensor.
			\|}

	== GetCurrentBrightnessSetting ==		== GetCurrentBrightnessSetting ==

P-sam: add note about float lux output from GetAmbientLightSensorValue

2019-01-01T13:48:57Z

add note about float lux output from GetAmbientLightSensorValue

← Older revision		Revision as of 16:48, 1 January 2019
Line 64:		Line 64:
	\| 28 \|\| [3.0.0+] [[#IsVrModeEnabled]]		\| 28 \|\| [3.0.0+] [[#IsVrModeEnabled]]
	\|}		\|}

			== GetAmbientLightSensorValue ==
			No input. Returns an output float of the current ambient light sensor value (unit: lux). Note: float seems to be preceded by an u32 int (zeroes)

	== GetCurrentBrightnessSetting ==		== GetCurrentBrightnessSetting ==

Hexkyz: /* lbl */

2018-10-21T15:45:23Z

lbl

← Older revision		Revision as of 19:45, 21 October 2018
Line 6:		Line 6:
	! Cmd \|\| Name		! Cmd \|\| Name
	\|-		\|-
	\| 0 \|\|		\| 0 \|\| SaveCurrentSetting
	\|-		\|-
	\| 1 \|\|		\| 1 \|\| LoadCurrentSetting
	\|-		\|-
	\| 2 \|\|		\| 2 \|\| SetCurrentBrightnessSetting
	\|-		\|-
	\| 3 \|\| ~~GetCurrentBacklightLevel~~		\| 3 \|\| GetCurrentBrightnessSetting
	\|-		\|-
	\| 4 \|\|		\| 4 \|\| ApplyCurrentBrightnessSettingToBacklight
	\|-		\|-
	\| 5 \|\| ~~GetAlsComputedBacklightLevel~~		\| 5 \|\| GetBrightnessSettingAppliedToBacklight
	\|-		\|-
	\| 6 \|\| ~~TurnOnBacklight~~		\| 6 \|\| SwitchBacklightOn
	\|-		\|-
	\| 7 \|\| ~~TurnOffBacklight~~		\| 7 \|\| SwitchBacklightOff
	\|-		\|-
	\| 8 \|\| ~~GetBacklightStatus~~		\| 8 \|\| GetBacklightSwitchStatus
	\|-		\|-
	\| 9 \|\|		\| 9 \|\| EnableDimming
	\|-		\|-
	\| 10 \|\|		\| 10 \|\| DisableDimming
	\|-		\|-
	\| 11 \|\|		\| 11 \|\| IsDimmingEnabled
	\|-		\|-
	\| 12 \|\|		\| 12 \|\| EnableAutoBrightnessControl
	\|-		\|-
	\| 13 \|\|		\| 13 \|\| DisableAutoBrightnessControl
	\|-		\|-
	\| 14 \|\|		\| 14 \|\| IsAutoBrightnessControlEnabled
	\|-		\|-
	\| 15 \|\| ~~GetAutoBrightnessSetting~~		\| 15 \|\| SetAmbientLightSensorValue
	\|-		\|-
	\| 16 \|\| ~~ReadRawLightSensor~~		\| 16 \|\| GetAmbientLightSensorValue
	\|-		\|-
	\| 17 \|\|		\| 17 \|\| SetBrightnessReflectionDelayLevel
	\|-		\|-
	\| 18 \|\|		\| 18 \|\| GetBrightnessReflectionDelayLevel
	\|-		\|-
	\| 19 \|\|		\| 19 \|\| SetCurrentBrightnessMapping
	\|-		\|-
	\| 20 \|\|		\| 20 \|\| GetCurrentBrightnessMapping
	\|-		\|-
	\| 21 \|\|		\| 21 \|\| SetCurrentAmbientLightSensorMapping
	\|-		\|-
	\| 22 \|\|		\| 22 \|\| GetCurrentAmbientLightSensorMapping
	\|-		\|-
	\| 23 \|\| [3.0.0+]		\| 23 \|\| [3.0.0+] IsAmbientLightSensorAvailable
	\|-		\|-
	\| 24 \|\| [3.0.0+]		\| 24 \|\| [3.0.0+] SetCurrentBrightnessSettingForVrMode
	\|-		\|-
	\| 25 \|\| [3.0.0+]		\| 25 \|\| [3.0.0+] GetCurrentBrightnessSettingForVrMode
	\|-		\|-
	\| 26 \|\| [3.0.0+] [[#EnableVrMode]]		\| 26 \|\| [3.0.0+] [[#EnableVrMode]]
Line 62:		Line 62:
	\| 27 \|\| [3.0.0+] [[#DisableVrMode]]		\| 27 \|\| [3.0.0+] [[#DisableVrMode]]
	\|-		\|-
	\| 28 \|\| [3.0.0+] [[#~~GetVrMode~~]]		\| 28 \|\| [3.0.0+] [[#IsVrModeEnabled]]
	\|}		\|}

	==~~GetCurrentBacklightLevel~~==		== GetCurrentBrightnessSetting ==
	No input. Returns an output u32 int of the current backlight level.		No input. Returns an output u32 int of the current backlight level.

	==~~GetAlsComputedBacklightLevel~~==		== GetBrightnessSettingAppliedToBacklight ==
	No input. Returns an output u32 int of the backlight level computed from the ambient light sensor.		No input. Returns an output u32 int of the backlight level computed from the ambient light sensor.

	==~~GetAutoBrightnessSetting~~==		== IsAutoBrightnessControlEnabled ==
	No input. Returns an output u8 bool indicating whether auto brightness is enabled.		No input. Returns an output u8 bool indicating whether auto brightness is enabled.

	==EnableVrMode==		== EnableVrMode ==
	No input/output. Used by [[AM_services#SetVrModeEnabled]].		No input/output. Used by [[AM_services#SetVrModeEnabled]].

	Sets a global state field to 0x1.		Sets a global state field to 0x1.

	==DisableVrMode==		== DisableVrMode ==
	No input/output. Used by [[AM_services#SetVrModeEnabled]].		No input/output. Used by [[AM_services#SetVrModeEnabled]].

	Sets the global state field used by [[#EnableVrMode]] to 0x0.		Sets the global state field used by [[#EnableVrMode]] to 0x0.

	==~~GetVrMode~~==		== IsVrModeEnabled ==
	No input. Returns an output u8 bool set by the above commands.		No input. Returns an output u8 bool set by the above commands.

	[[Category:Services]]		[[Category:Services]]