blob: ba790fba8b35b4e7ae3140ba3696001c7ee790c9 [file] [log] [blame] [view]
<link rel="stylesheet" href="../style.css" />
[TOC]
# fuchsia.hardware.light
<div class="fidl-version-div"><span class="fidl-attribute fidl-version">Added: 7</span></div>
## **PROTOCOLS**
## Light {#Light}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=44)*
### GetCurrentBrightnessValue {#Light.GetCurrentBrightnessValue}
<p>Returns the current brightness value (0.0 - 1.0) of the light indicated by index, where 0.0
is minimum brightness and 1.0 is maximum.
If the capability 'BRIGHTNESS' is not supported by this light, returns NOT_SUPPORTED.
Use GetInfo to check if light supports this operation.
index: a number between 0 inclusive and the count received from GetNumLights.</p>
#### Request {#Light.GetCurrentBrightnessValue_Request}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>index</code></td>
<td>
<code>uint32</code>
</td>
</tr>
</table>
#### Response {#Light.GetCurrentBrightnessValue_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>result</code></td>
<td>
<code><a class='link' href='#Light_GetCurrentBrightnessValue_Result'>Light_GetCurrentBrightnessValue_Result</a></code>
</td>
</tr>
</table>
### GetCurrentRgbValue {#Light.GetCurrentRgbValue}
<p>Returns the current RGB value for the single light.
If the capability 'RGB' is not supported by this light, returns NOT_SUPPORTED.
Use GetInfo to check if light supports this operation.
index: a number between 0 inclusive and the count received from GetNumLights.</p>
#### Request {#Light.GetCurrentRgbValue_Request}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>index</code></td>
<td>
<code>uint32</code>
</td>
</tr>
</table>
#### Response {#Light.GetCurrentRgbValue_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>result</code></td>
<td>
<code><a class='link' href='#Light_GetCurrentRgbValue_Result'>Light_GetCurrentRgbValue_Result</a></code>
</td>
</tr>
</table>
### GetCurrentSimpleValue {#Light.GetCurrentSimpleValue}
<p>Returns the current value. If the light is ON, the value is True. If the light is OFF,
the value is False.
If the capability 'SIMPLE' is not supported by this light, returns NOT_SUPPORTED.
Use GetInfo to check if light supports this operation.
index: a number between 0 inclusive and the count received from GetNumLights.</p>
#### Request {#Light.GetCurrentSimpleValue_Request}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>index</code></td>
<td>
<code>uint32</code>
</td>
</tr>
</table>
#### Response {#Light.GetCurrentSimpleValue_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>result</code></td>
<td>
<code><a class='link' href='#Light_GetCurrentSimpleValue_Result'>Light_GetCurrentSimpleValue_Result</a></code>
</td>
</tr>
</table>
### GetGroupCurrentBrightnessValue {#Light.GetGroupCurrentBrightnessValue}
<p>Returns an array of the current brightness values (0.0 - 1.0) for the light group, where 0.0
is minimum brightness and 1.0 is maximum.
If group_id is invalid, INVALID_INDEX will be returned.
If the capability 'BRIGHTNESS' is not supported by this group, returns NOT_SUPPORTED.
Use GetGroupInfo to check if group supports this operation.
group_id: a number between 0 inclusive and the count received from GetNumLightGroups.</p>
#### Request {#Light.GetGroupCurrentBrightnessValue_Request}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>group_id</code></td>
<td>
<code>uint32</code>
</td>
</tr>
</table>
#### Response {#Light.GetGroupCurrentBrightnessValue_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>result</code></td>
<td>
<code><a class='link' href='#Light_GetGroupCurrentBrightnessValue_Result'>Light_GetGroupCurrentBrightnessValue_Result</a></code>
</td>
</tr>
</table>
### GetGroupCurrentRgbValue {#Light.GetGroupCurrentRgbValue}
<p>Returns an array of the current RGB values for the light group.
If group_id is invalid, INVALID_INDEX will be returned.
If the capability 'RGB' is not supported by this group, returns NOT_SUPPORTED.
Use GetGroupInfo to check if group supports this operation.
group_id: a number between 0 inclusive and the count received from GetNumLightGroups.</p>
#### Request {#Light.GetGroupCurrentRgbValue_Request}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>group_id</code></td>
<td>
<code>uint32</code>
</td>
</tr>
</table>
#### Response {#Light.GetGroupCurrentRgbValue_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>result</code></td>
<td>
<code><a class='link' href='#Light_GetGroupCurrentRgbValue_Result'>Light_GetGroupCurrentRgbValue_Result</a></code>
</td>
</tr>
</table>
### GetGroupCurrentSimpleValue {#Light.GetGroupCurrentSimpleValue}
<p>Returns an array of the current values.If the light is ON, the value is True. If the light
is OFF, the value is False.
If group_id is invalid, INVALID_INDEX will be returned.
If the capability 'SIMPLE' is not supported by this group, returns NOT_SUPPORTED.
Use GetGroupInfo to check if group supports this operation.
group_id: a number between 0 inclusive and the count received from GetNumLightGroups.</p>
#### Request {#Light.GetGroupCurrentSimpleValue_Request}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>group_id</code></td>
<td>
<code>uint32</code>
</td>
</tr>
</table>
#### Response {#Light.GetGroupCurrentSimpleValue_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>result</code></td>
<td>
<code><a class='link' href='#Light_GetGroupCurrentSimpleValue_Result'>Light_GetGroupCurrentSimpleValue_Result</a></code>
</td>
</tr>
</table>
### GetGroupInfo {#Light.GetGroupInfo}
<p>Returns group info for the light group.
group_id: a number between 0 inclusive and the count received from GetNumLightGroups.</p>
#### Request {#Light.GetGroupInfo_Request}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>group_id</code></td>
<td>
<code>uint32</code>
</td>
</tr>
</table>
#### Response {#Light.GetGroupInfo_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>result</code></td>
<td>
<code><a class='link' href='#Light_GetGroupInfo_Result'>Light_GetGroupInfo_Result</a></code>
</td>
</tr>
</table>
### GetInfo {#Light.GetInfo}
<p>Returns info for the single light.
index: Index of the light defined by board. Must be less than value returned by GetNumLights.</p>
#### Request {#Light.GetInfo_Request}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>index</code></td>
<td>
<code>uint32</code>
</td>
</tr>
</table>
#### Response {#Light.GetInfo_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>result</code></td>
<td>
<code><a class='link' href='#Light_GetInfo_Result'>Light_GetInfo_Result</a></code>
</td>
</tr>
</table>
### GetNumLightGroups {#Light.GetNumLightGroups}
<p>Returns the total number of light groups (does not count single lights).
The light groups are addressed using &quot;group_id&quot; parameter in the calls below.</p>
#### Request {#Light.GetNumLightGroups_Request}
&lt;EMPTY&gt;
#### Response {#Light.GetNumLightGroups_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>count</code></td>
<td>
<code>uint32</code>
</td>
</tr>
</table>
### GetNumLights {#Light.GetNumLights}
<p>Returns the total number of physical lights.
This will typically be 1 for a simple LED light, but may be greater than one for an array of
lights or a more complicated lighting device.
The multiple lights are addressed using &quot;index&quot; parameter in the calls below.</p>
#### Request {#Light.GetNumLights_Request}
&lt;EMPTY&gt;
#### Response {#Light.GetNumLights_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>count</code></td>
<td>
<code>uint32</code>
</td>
</tr>
</table>
### SetBrightnessValue {#Light.SetBrightnessValue}
<p>Sets the current brightness value (0.0 - 1.0), where 0.0 is minimum brightness and 1.0 is
maximum.
If the capability 'BRIGHTNESS' is not supported by this light, returns NOT_SUPPORTED.
Use GetInfo to check if light supports this operation.
index: a number between 0 inclusive and the count received from GetNumLights.</p>
#### Request {#Light.SetBrightnessValue_Request}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>index</code></td>
<td>
<code>uint32</code>
</td>
</tr>
<tr>
<td><code>value</code></td>
<td>
<code>float64</code>
</td>
</tr>
</table>
#### Response {#Light.SetBrightnessValue_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>result</code></td>
<td>
<code><a class='link' href='#Light_SetBrightnessValue_Result'>Light_SetBrightnessValue_Result</a></code>
</td>
</tr>
</table>
### SetGroupBrightnessValue {#Light.SetGroupBrightnessValue}
<p>Sets the current brightness values (0.0 - 1.0) for the light group through the values array,
where 0.0 is minimum brightness and 1.0 is maximum.
If group_id is invalid, INVALID_INDEX will be returned.
If the capability 'BRIGHTNESS' is not supported by this group, returns NOT_SUPPORTED.
Use GetGroupInfo to check if group supports this operation.
group_id: a number between 0 inclusive and the count received from GetNumLightGroups.</p>
#### Request {#Light.SetGroupBrightnessValue_Request}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>group_id</code></td>
<td>
<code>uint32</code>
</td>
</tr>
<tr>
<td><code>values</code></td>
<td>
<code>vector&lt;float64&gt;</code>
</td>
</tr>
</table>
#### Response {#Light.SetGroupBrightnessValue_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>result</code></td>
<td>
<code><a class='link' href='#Light_SetGroupBrightnessValue_Result'>Light_SetGroupBrightnessValue_Result</a></code>
</td>
</tr>
</table>
### SetGroupRgbValue {#Light.SetGroupRgbValue}
<p>Sets the current RGB value for the light group.
If group_id is invalid, INVALID_INDEX will be returned.
If the capability 'RGB' is not supported by this group, returns NOT_SUPPORTED.
Use GetGroupInfo to check if group supports this operation.
group_id: a number between 0 inclusive and the count received from GetNumLightGroups.</p>
#### Request {#Light.SetGroupRgbValue_Request}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>group_id</code></td>
<td>
<code>uint32</code>
</td>
</tr>
<tr>
<td><code>values</code></td>
<td>
<code>vector&lt;<a class='link' href='#Rgb'>Rgb</a>&gt;</code>
</td>
</tr>
</table>
#### Response {#Light.SetGroupRgbValue_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>result</code></td>
<td>
<code><a class='link' href='#Light_SetGroupRgbValue_Result'>Light_SetGroupRgbValue_Result</a></code>
</td>
</tr>
</table>
### SetGroupSimpleValue {#Light.SetGroupSimpleValue}
<p>Sets the current values through the values array. Value should be set to 'TRUE' to turn on
the light. Value should be set to 'FALSE' to turn off the light.
If group_id is invalid, INVALID_INDEX will be returned.
If the capability 'SIMPLE' is not supported by this group, returns NOT_SUPPORTED.
Use GetGroupInfo to check if group supports this operation.
group_id: a number between 0 inclusive and the count received from GetNumLightGroups.</p>
#### Request {#Light.SetGroupSimpleValue_Request}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>group_id</code></td>
<td>
<code>uint32</code>
</td>
</tr>
<tr>
<td><code>values</code></td>
<td>
<code>vector&lt;bool&gt;</code>
</td>
</tr>
</table>
#### Response {#Light.SetGroupSimpleValue_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>result</code></td>
<td>
<code><a class='link' href='#Light_SetGroupSimpleValue_Result'>Light_SetGroupSimpleValue_Result</a></code>
</td>
</tr>
</table>
### SetRgbValue {#Light.SetRgbValue}
<p>Sets the current RGB value.
If the capability 'RGB' is not supported by this light, returns NOT_SUPPORTED.
Use GetInfo to check if light supports this operation.
index: a number between 0 inclusive and the count received from GetNumLights.</p>
#### Request {#Light.SetRgbValue_Request}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>index</code></td>
<td>
<code>uint32</code>
</td>
</tr>
<tr>
<td><code>value</code></td>
<td>
<code><a class='link' href='#Rgb'>Rgb</a></code>
</td>
</tr>
</table>
#### Response {#Light.SetRgbValue_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>result</code></td>
<td>
<code><a class='link' href='#Light_SetRgbValue_Result'>Light_SetRgbValue_Result</a></code>
</td>
</tr>
</table>
### SetSimpleValue {#Light.SetSimpleValue}
<p>Sets the current value. Value should be set to 'TRUE' to turn on the light. Value should be
set to 'FALSE' to turn off the light.
If the capability 'SIMPLE' is not supported by this light, returns NOT_SUPPORTED.
Use GetInfo to check if light supports this operation.
index: a number between 0 inclusive and the count received from GetNumLights.</p>
#### Request {#Light.SetSimpleValue_Request}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>index</code></td>
<td>
<code>uint32</code>
</td>
</tr>
<tr>
<td><code>value</code></td>
<td>
<code>bool</code>
</td>
</tr>
</table>
#### Response {#Light.SetSimpleValue_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>result</code></td>
<td>
<code><a class='link' href='#Light_SetSimpleValue_Result'>Light_SetSimpleValue_Result</a></code>
</td>
</tr>
</table>
## **STRUCTS**
### GroupInfo {#GroupInfo data-text="GroupInfo"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=30)*
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="GroupInfo.name">
<td><code>name</code></td>
<td>
<code>string[32]</code>
</td>
<td></td>
<td>No default</td>
</tr>
<tr id="GroupInfo.count">
<td><code>count</code></td>
<td>
<code>uint32</code>
</td>
<td></td>
<td>No default</td>
</tr>
<tr id="GroupInfo.capability">
<td><code>capability</code></td>
<td>
<code><a class='link' href='#Capability'>Capability</a></code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### Info {#Info data-text="Info"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=25)*
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="Info.name">
<td><code>name</code></td>
<td>
<code>string[32]</code>
</td>
<td></td>
<td>No default</td>
</tr>
<tr id="Info.capability">
<td><code>capability</code></td>
<td>
<code><a class='link' href='#Capability'>Capability</a></code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### Light_GetCurrentBrightnessValue_Response {#Light_GetCurrentBrightnessValue_Response data-text="Light_GetCurrentBrightnessValue_Response"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=95)*
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="Light_GetCurrentBrightnessValue_Response.value">
<td><code>value</code></td>
<td>
<code>float64</code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### Light_GetCurrentRgbValue_Response {#Light_GetCurrentRgbValue_Response data-text="Light_GetCurrentRgbValue_Response"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=115)*
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="Light_GetCurrentRgbValue_Response.value">
<td><code>value</code></td>
<td>
<code><a class='link' href='#Rgb'>Rgb</a></code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### Light_GetCurrentSimpleValue_Response {#Light_GetCurrentSimpleValue_Response data-text="Light_GetCurrentSimpleValue_Response"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=74)*
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="Light_GetCurrentSimpleValue_Response.value">
<td><code>value</code></td>
<td>
<code>bool</code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### Light_GetGroupCurrentBrightnessValue_Response {#Light_GetGroupCurrentBrightnessValue_Response data-text="Light_GetGroupCurrentBrightnessValue_Response"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=167)*
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="Light_GetGroupCurrentBrightnessValue_Response.values">
<td><code>values</code></td>
<td>
<code>vector&lt;float64&gt;?</code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### Light_GetGroupCurrentRgbValue_Response {#Light_GetGroupCurrentRgbValue_Response data-text="Light_GetGroupCurrentRgbValue_Response"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=189)*
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="Light_GetGroupCurrentRgbValue_Response.values">
<td><code>values</code></td>
<td>
<code>vector&lt;<a class='link' href='#Rgb'>Rgb</a>&gt;?</code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### Light_GetGroupCurrentSimpleValue_Response {#Light_GetGroupCurrentSimpleValue_Response data-text="Light_GetGroupCurrentSimpleValue_Response"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=144)*
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="Light_GetGroupCurrentSimpleValue_Response.values">
<td><code>values</code></td>
<td>
<code>vector&lt;bool&gt;?</code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### Light_GetGroupInfo_Response {#Light_GetGroupInfo_Response data-text="Light_GetGroupInfo_Response"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=132)*
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="Light_GetGroupInfo_Response.info">
<td><code>info</code></td>
<td>
<code><a class='link' href='#GroupInfo'>GroupInfo</a></code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### Light_GetInfo_Response {#Light_GetInfo_Response data-text="Light_GetInfo_Response"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=63)*
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="Light_GetInfo_Response.info">
<td><code>info</code></td>
<td>
<code><a class='link' href='#Info'>Info</a></code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### Light_SetBrightnessValue_Response {#Light_SetBrightnessValue_Response data-text="Light_SetBrightnessValue_Response"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=107)*
&lt;EMPTY&gt;
### Light_SetGroupBrightnessValue_Response {#Light_SetGroupBrightnessValue_Response data-text="Light_SetGroupBrightnessValue_Response"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=180)*
&lt;EMPTY&gt;
### Light_SetGroupRgbValue_Response {#Light_SetGroupRgbValue_Response data-text="Light_SetGroupRgbValue_Response"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=201)*
&lt;EMPTY&gt;
### Light_SetGroupSimpleValue_Response {#Light_SetGroupSimpleValue_Response data-text="Light_SetGroupSimpleValue_Response"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=157)*
&lt;EMPTY&gt;
### Light_SetRgbValue_Response {#Light_SetRgbValue_Response data-text="Light_SetRgbValue_Response"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=126)*
&lt;EMPTY&gt;
### Light_SetSimpleValue_Response {#Light_SetSimpleValue_Response data-text="Light_SetSimpleValue_Response"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=86)*
&lt;EMPTY&gt;
### Rgb {#Rgb data-text="Rgb"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=19)*
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="Rgb.red">
<td><code>red</code></td>
<td>
<code>float64</code>
</td>
<td></td>
<td>No default</td>
</tr>
<tr id="Rgb.green">
<td><code>green</code></td>
<td>
<code>float64</code>
</td>
<td></td>
<td>No default</td>
</tr>
<tr id="Rgb.blue">
<td><code>blue</code></td>
<td>
<code>float64</code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
## **ENUMS**
### Capability [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#Capability data-text="Capability"}
Type: <code>uint32</code>
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=9)*
<table>
<tr><th>Name</th><th>Value</th><th>Description</th></tr>
<tr id="Capability.BRIGHTNESS">
<td><h3 id="Capability.BRIGHTNESS" class="add-link hide-from-toc">BRIGHTNESS</h3></td>
<td><code>1</code></td>
<td><p>This capability indicates that the light supports setting brightness to a uint8_t value.
If this capability is not supported, the light only supports off and on state.</p>
</td>
</tr>
<tr id="Capability.RGB">
<td><h3 id="Capability.RGB" class="add-link hide-from-toc">RGB</h3></td>
<td><code>2</code></td>
<td><p>This capability indicates that the light supports setting an RGB value.</p>
</td>
</tr>
<tr id="Capability.SIMPLE">
<td><h3 id="Capability.SIMPLE" class="add-link hide-from-toc">SIMPLE</h3></td>
<td><code>3</code></td>
<td><p>No capabilities</p>
</td>
</tr>
</table>
### LightError [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#LightError data-text="LightError"}
Type: <code>uint32</code>
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=36)*
<table>
<tr><th>Name</th><th>Value</th><th>Description</th></tr>
<tr id="LightError.OK">
<td><h3 id="LightError.OK" class="add-link hide-from-toc">OK</h3></td>
<td><code>0</code></td>
<td></td>
</tr>
<tr id="LightError.NOT_SUPPORTED">
<td><h3 id="LightError.NOT_SUPPORTED" class="add-link hide-from-toc">NOT_SUPPORTED</h3></td>
<td><code>1</code></td>
<td></td>
</tr>
<tr id="LightError.INVALID_INDEX">
<td><h3 id="LightError.INVALID_INDEX" class="add-link hide-from-toc">INVALID_INDEX</h3></td>
<td><code>2</code></td>
<td></td>
</tr>
<tr id="LightError.FAILED">
<td><h3 id="LightError.FAILED" class="add-link hide-from-toc">FAILED</h3></td>
<td><code>3</code></td>
<td></td>
</tr>
</table>
## **UNIONS**
### Light_GetCurrentBrightnessValue_Result [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#Light_GetCurrentBrightnessValue_Result data-text="Light_GetCurrentBrightnessValue_Result"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=95)*
<table>
<tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
<tr id="Light_GetCurrentBrightnessValue_Result.response">
<td><h3 id="Light_GetCurrentBrightnessValue_Result.response" class="add-link hide-from-toc">1</h3></td>
<td><code>response</code></td>
<td>
<code><a class='link' href='#Light_GetCurrentBrightnessValue_Response'>Light_GetCurrentBrightnessValue_Response</a></code>
</td>
<td></td>
</tr>
<tr id="Light_GetCurrentBrightnessValue_Result.err">
<td><h3 id="Light_GetCurrentBrightnessValue_Result.err" class="add-link hide-from-toc">2</h3></td>
<td><code>err</code></td>
<td>
<code><a class='link' href='#LightError'>LightError</a></code>
</td>
<td></td>
</tr>
</table>
### Light_GetCurrentRgbValue_Result [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#Light_GetCurrentRgbValue_Result data-text="Light_GetCurrentRgbValue_Result"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=115)*
<table>
<tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
<tr id="Light_GetCurrentRgbValue_Result.response">
<td><h3 id="Light_GetCurrentRgbValue_Result.response" class="add-link hide-from-toc">1</h3></td>
<td><code>response</code></td>
<td>
<code><a class='link' href='#Light_GetCurrentRgbValue_Response'>Light_GetCurrentRgbValue_Response</a></code>
</td>
<td></td>
</tr>
<tr id="Light_GetCurrentRgbValue_Result.err">
<td><h3 id="Light_GetCurrentRgbValue_Result.err" class="add-link hide-from-toc">2</h3></td>
<td><code>err</code></td>
<td>
<code><a class='link' href='#LightError'>LightError</a></code>
</td>
<td></td>
</tr>
</table>
### Light_GetCurrentSimpleValue_Result [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#Light_GetCurrentSimpleValue_Result data-text="Light_GetCurrentSimpleValue_Result"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=74)*
<table>
<tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
<tr id="Light_GetCurrentSimpleValue_Result.response">
<td><h3 id="Light_GetCurrentSimpleValue_Result.response" class="add-link hide-from-toc">1</h3></td>
<td><code>response</code></td>
<td>
<code><a class='link' href='#Light_GetCurrentSimpleValue_Response'>Light_GetCurrentSimpleValue_Response</a></code>
</td>
<td></td>
</tr>
<tr id="Light_GetCurrentSimpleValue_Result.err">
<td><h3 id="Light_GetCurrentSimpleValue_Result.err" class="add-link hide-from-toc">2</h3></td>
<td><code>err</code></td>
<td>
<code><a class='link' href='#LightError'>LightError</a></code>
</td>
<td></td>
</tr>
</table>
### Light_GetGroupCurrentBrightnessValue_Result [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#Light_GetGroupCurrentBrightnessValue_Result data-text="Light_GetGroupCurrentBrightnessValue_Result"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=167)*
<table>
<tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
<tr id="Light_GetGroupCurrentBrightnessValue_Result.response">
<td><h3 id="Light_GetGroupCurrentBrightnessValue_Result.response" class="add-link hide-from-toc">1</h3></td>
<td><code>response</code></td>
<td>
<code><a class='link' href='#Light_GetGroupCurrentBrightnessValue_Response'>Light_GetGroupCurrentBrightnessValue_Response</a></code>
</td>
<td></td>
</tr>
<tr id="Light_GetGroupCurrentBrightnessValue_Result.err">
<td><h3 id="Light_GetGroupCurrentBrightnessValue_Result.err" class="add-link hide-from-toc">2</h3></td>
<td><code>err</code></td>
<td>
<code><a class='link' href='#LightError'>LightError</a></code>
</td>
<td></td>
</tr>
</table>
### Light_GetGroupCurrentRgbValue_Result [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#Light_GetGroupCurrentRgbValue_Result data-text="Light_GetGroupCurrentRgbValue_Result"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=189)*
<table>
<tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
<tr id="Light_GetGroupCurrentRgbValue_Result.response">
<td><h3 id="Light_GetGroupCurrentRgbValue_Result.response" class="add-link hide-from-toc">1</h3></td>
<td><code>response</code></td>
<td>
<code><a class='link' href='#Light_GetGroupCurrentRgbValue_Response'>Light_GetGroupCurrentRgbValue_Response</a></code>
</td>
<td></td>
</tr>
<tr id="Light_GetGroupCurrentRgbValue_Result.err">
<td><h3 id="Light_GetGroupCurrentRgbValue_Result.err" class="add-link hide-from-toc">2</h3></td>
<td><code>err</code></td>
<td>
<code><a class='link' href='#LightError'>LightError</a></code>
</td>
<td></td>
</tr>
</table>
### Light_GetGroupCurrentSimpleValue_Result [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#Light_GetGroupCurrentSimpleValue_Result data-text="Light_GetGroupCurrentSimpleValue_Result"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=144)*
<table>
<tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
<tr id="Light_GetGroupCurrentSimpleValue_Result.response">
<td><h3 id="Light_GetGroupCurrentSimpleValue_Result.response" class="add-link hide-from-toc">1</h3></td>
<td><code>response</code></td>
<td>
<code><a class='link' href='#Light_GetGroupCurrentSimpleValue_Response'>Light_GetGroupCurrentSimpleValue_Response</a></code>
</td>
<td></td>
</tr>
<tr id="Light_GetGroupCurrentSimpleValue_Result.err">
<td><h3 id="Light_GetGroupCurrentSimpleValue_Result.err" class="add-link hide-from-toc">2</h3></td>
<td><code>err</code></td>
<td>
<code><a class='link' href='#LightError'>LightError</a></code>
</td>
<td></td>
</tr>
</table>
### Light_GetGroupInfo_Result [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#Light_GetGroupInfo_Result data-text="Light_GetGroupInfo_Result"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=132)*
<table>
<tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
<tr id="Light_GetGroupInfo_Result.response">
<td><h3 id="Light_GetGroupInfo_Result.response" class="add-link hide-from-toc">1</h3></td>
<td><code>response</code></td>
<td>
<code><a class='link' href='#Light_GetGroupInfo_Response'>Light_GetGroupInfo_Response</a></code>
</td>
<td></td>
</tr>
<tr id="Light_GetGroupInfo_Result.err">
<td><h3 id="Light_GetGroupInfo_Result.err" class="add-link hide-from-toc">2</h3></td>
<td><code>err</code></td>
<td>
<code><a class='link' href='#LightError'>LightError</a></code>
</td>
<td></td>
</tr>
</table>
### Light_GetInfo_Result [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#Light_GetInfo_Result data-text="Light_GetInfo_Result"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=63)*
<table>
<tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
<tr id="Light_GetInfo_Result.response">
<td><h3 id="Light_GetInfo_Result.response" class="add-link hide-from-toc">1</h3></td>
<td><code>response</code></td>
<td>
<code><a class='link' href='#Light_GetInfo_Response'>Light_GetInfo_Response</a></code>
</td>
<td></td>
</tr>
<tr id="Light_GetInfo_Result.err">
<td><h3 id="Light_GetInfo_Result.err" class="add-link hide-from-toc">2</h3></td>
<td><code>err</code></td>
<td>
<code><a class='link' href='#LightError'>LightError</a></code>
</td>
<td></td>
</tr>
</table>
### Light_SetBrightnessValue_Result [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#Light_SetBrightnessValue_Result data-text="Light_SetBrightnessValue_Result"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=107)*
<table>
<tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
<tr id="Light_SetBrightnessValue_Result.response">
<td><h3 id="Light_SetBrightnessValue_Result.response" class="add-link hide-from-toc">1</h3></td>
<td><code>response</code></td>
<td>
<code><a class='link' href='#Light_SetBrightnessValue_Response'>Light_SetBrightnessValue_Response</a></code>
</td>
<td></td>
</tr>
<tr id="Light_SetBrightnessValue_Result.err">
<td><h3 id="Light_SetBrightnessValue_Result.err" class="add-link hide-from-toc">2</h3></td>
<td><code>err</code></td>
<td>
<code><a class='link' href='#LightError'>LightError</a></code>
</td>
<td></td>
</tr>
</table>
### Light_SetGroupBrightnessValue_Result [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#Light_SetGroupBrightnessValue_Result data-text="Light_SetGroupBrightnessValue_Result"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=180)*
<table>
<tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
<tr id="Light_SetGroupBrightnessValue_Result.response">
<td><h3 id="Light_SetGroupBrightnessValue_Result.response" class="add-link hide-from-toc">1</h3></td>
<td><code>response</code></td>
<td>
<code><a class='link' href='#Light_SetGroupBrightnessValue_Response'>Light_SetGroupBrightnessValue_Response</a></code>
</td>
<td></td>
</tr>
<tr id="Light_SetGroupBrightnessValue_Result.err">
<td><h3 id="Light_SetGroupBrightnessValue_Result.err" class="add-link hide-from-toc">2</h3></td>
<td><code>err</code></td>
<td>
<code><a class='link' href='#LightError'>LightError</a></code>
</td>
<td></td>
</tr>
</table>
### Light_SetGroupRgbValue_Result [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#Light_SetGroupRgbValue_Result data-text="Light_SetGroupRgbValue_Result"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=201)*
<table>
<tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
<tr id="Light_SetGroupRgbValue_Result.response">
<td><h3 id="Light_SetGroupRgbValue_Result.response" class="add-link hide-from-toc">1</h3></td>
<td><code>response</code></td>
<td>
<code><a class='link' href='#Light_SetGroupRgbValue_Response'>Light_SetGroupRgbValue_Response</a></code>
</td>
<td></td>
</tr>
<tr id="Light_SetGroupRgbValue_Result.err">
<td><h3 id="Light_SetGroupRgbValue_Result.err" class="add-link hide-from-toc">2</h3></td>
<td><code>err</code></td>
<td>
<code><a class='link' href='#LightError'>LightError</a></code>
</td>
<td></td>
</tr>
</table>
### Light_SetGroupSimpleValue_Result [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#Light_SetGroupSimpleValue_Result data-text="Light_SetGroupSimpleValue_Result"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=157)*
<table>
<tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
<tr id="Light_SetGroupSimpleValue_Result.response">
<td><h3 id="Light_SetGroupSimpleValue_Result.response" class="add-link hide-from-toc">1</h3></td>
<td><code>response</code></td>
<td>
<code><a class='link' href='#Light_SetGroupSimpleValue_Response'>Light_SetGroupSimpleValue_Response</a></code>
</td>
<td></td>
</tr>
<tr id="Light_SetGroupSimpleValue_Result.err">
<td><h3 id="Light_SetGroupSimpleValue_Result.err" class="add-link hide-from-toc">2</h3></td>
<td><code>err</code></td>
<td>
<code><a class='link' href='#LightError'>LightError</a></code>
</td>
<td></td>
</tr>
</table>
### Light_SetRgbValue_Result [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#Light_SetRgbValue_Result data-text="Light_SetRgbValue_Result"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=126)*
<table>
<tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
<tr id="Light_SetRgbValue_Result.response">
<td><h3 id="Light_SetRgbValue_Result.response" class="add-link hide-from-toc">1</h3></td>
<td><code>response</code></td>
<td>
<code><a class='link' href='#Light_SetRgbValue_Response'>Light_SetRgbValue_Response</a></code>
</td>
<td></td>
</tr>
<tr id="Light_SetRgbValue_Result.err">
<td><h3 id="Light_SetRgbValue_Result.err" class="add-link hide-from-toc">2</h3></td>
<td><code>err</code></td>
<td>
<code><a class='link' href='#LightError'>LightError</a></code>
</td>
<td></td>
</tr>
</table>
### Light_SetSimpleValue_Result [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#Light_SetSimpleValue_Result data-text="Light_SetSimpleValue_Result"}
*Defined in [fuchsia.hardware.light/light.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=86)*
<table>
<tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
<tr id="Light_SetSimpleValue_Result.response">
<td><h3 id="Light_SetSimpleValue_Result.response" class="add-link hide-from-toc">1</h3></td>
<td><code>response</code></td>
<td>
<code><a class='link' href='#Light_SetSimpleValue_Response'>Light_SetSimpleValue_Response</a></code>
</td>
<td></td>
</tr>
<tr id="Light_SetSimpleValue_Result.err">
<td><h3 id="Light_SetSimpleValue_Result.err" class="add-link hide-from-toc">2</h3></td>
<td><code>err</code></td>
<td>
<code><a class='link' href='#LightError'>LightError</a></code>
</td>
<td></td>
</tr>
</table>
## **CONSTANTS**
<table>
<tr><th>Name</th><th>Value</th><th>Type</th><th>Description</th></tr>
<tr id="LIGHT_NAME_LEN">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.light/light.fidl;l=7">LIGHT_NAME_LEN</a></td>
<td>
<code>32</code>
</td>
<td><code>uint8</code></td>
<td></td>
</tr>
</table>