ui.lighting.lighting_request_handler_if.LightingRequestHandlerIf Class Reference

Handle semantic lighting changes requested by a UI. More...

Inheritance diagram for ui.lighting.lighting_request_handler_if.LightingRequestHandlerIf:

Public Member Functions
None	request_power (self, bool enabled)
	Request that lighting power be enabled or disabled.
None	request_color (self, LightingColor color)
	Request a normalized RGB lighting color.
None	request_brightness (self, int percent)
	Request brightness from zero through 100 percent.
None	request_pattern (self, int pattern_index)
	Request a controller lighting pattern.
None	request_music_mode (self, int mode_index)
	Request a music-reactive mode.

Detailed Description

Handle semantic lighting changes requested by a UI.

Member Function Documentation

request_brightness()

None ui.lighting.lighting_request_handler_if.LightingRequestHandlerIf.request_brightness	(		self,
		int	percent
	)

Request brightness from zero through 100 percent.

Parameters

percent

Requested brightness percentage in the range 0..100.

Reimplemented in lighting.lighting_presenter.LightingPresenter, and ui.lighting.lighting_request_handler_stub.LightingRequestHandlerStub.

request_color()

None ui.lighting.lighting_request_handler_if.LightingRequestHandlerIf.request_color	(		self,
		LightingColor	color
	)

Request a normalized RGB lighting color.

Parameters

color

Requested RGB color.

Reimplemented in lighting.lighting_presenter.LightingPresenter, and ui.lighting.lighting_request_handler_stub.LightingRequestHandlerStub.

request_music_mode()

None ui.lighting.lighting_request_handler_if.LightingRequestHandlerIf.request_music_mode	(		self,
		int	mode_index
	)

Request a music-reactive mode.

Parameters

mode_index

Controller-defined music mode index.

Reimplemented in lighting.lighting_presenter.LightingPresenter, and ui.lighting.lighting_request_handler_stub.LightingRequestHandlerStub.

request_pattern()

None ui.lighting.lighting_request_handler_if.LightingRequestHandlerIf.request_pattern	(		self,
		int	pattern_index
	)

Request a controller lighting pattern.

Parameters

pattern_index

Controller-defined pattern index.

Reimplemented in lighting.lighting_presenter.LightingPresenter, and ui.lighting.lighting_request_handler_stub.LightingRequestHandlerStub.

request_power()

None ui.lighting.lighting_request_handler_if.LightingRequestHandlerIf.request_power	(		self,
		bool	enabled
	)

Request that lighting power be enabled or disabled.

Parameters

enabled

True to enable lighting power.

Reimplemented in lighting.lighting_presenter.LightingPresenter, and ui.lighting.lighting_request_handler_stub.LightingRequestHandlerStub.

---

The documentation for this class was generated from the following file:

• ui/lighting/lighting_request_handler_if.py