Enum fidl_fuchsia_hardware_light::LightRequest

pub enum LightRequest {
    GetNumLights {
        responder: LightGetNumLightsResponder,
    },
    GetNumLightGroups {
        responder: LightGetNumLightGroupsResponder,
    },
    GetInfo {
        index: u32,
        responder: LightGetInfoResponder,
    },
    GetCurrentSimpleValue {
        index: u32,
        responder: LightGetCurrentSimpleValueResponder,
    },
    SetSimpleValue {
        index: u32,
        value: bool,
        responder: LightSetSimpleValueResponder,
    },
    GetCurrentBrightnessValue {
        index: u32,
        responder: LightGetCurrentBrightnessValueResponder,
    },
    SetBrightnessValue {
        index: u32,
        value: f64,
        responder: LightSetBrightnessValueResponder,
    },
    GetCurrentRgbValue {
        index: u32,
        responder: LightGetCurrentRgbValueResponder,
    },
    SetRgbValue {
        index: u32,
        value: Rgb,
        responder: LightSetRgbValueResponder,
    },
    GetGroupInfo {
        group_id: u32,
        responder: LightGetGroupInfoResponder,
    },
    GetGroupCurrentSimpleValue {
        group_id: u32,
        responder: LightGetGroupCurrentSimpleValueResponder,
    },
    SetGroupSimpleValue {
        group_id: u32,
        values: Vec<bool>,
        responder: LightSetGroupSimpleValueResponder,
    },
    GetGroupCurrentBrightnessValue {
        group_id: u32,
        responder: LightGetGroupCurrentBrightnessValueResponder,
    },
    SetGroupBrightnessValue {
        group_id: u32,
        values: Vec<f64>,
        responder: LightSetGroupBrightnessValueResponder,
    },
    GetGroupCurrentRgbValue {
        group_id: u32,
        responder: LightGetGroupCurrentRgbValueResponder,
    },
    SetGroupRgbValue {
        group_id: u32,
        values: Vec<Rgb>,
        responder: LightSetGroupRgbValueResponder,
    },
}

Variants

GetNumLights

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 “index” parameter in the calls below.

Fields

responder: LightGetNumLightsResponder

GetNumLightGroups

Returns the total number of light groups (does not count single lights). The light groups are addressed using “group_id” parameter in the calls below.

Fields

responder: LightGetNumLightGroupsResponder

GetInfo

Returns info for the single light. index: Index of the light defined by board. Must be less than value returned by GetNumLights.

Fields

index: u32

responder: LightGetInfoResponder

GetCurrentSimpleValue

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.

Fields

index: u32

responder: LightGetCurrentSimpleValueResponder

SetSimpleValue

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.

Fields

index: u32

value: bool

responder: LightSetSimpleValueResponder

GetCurrentBrightnessValue

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.

Fields

index: u32

responder: LightGetCurrentBrightnessValueResponder

SetBrightnessValue

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.

Fields

index: u32

value: f64

responder: LightSetBrightnessValueResponder

GetCurrentRgbValue

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.

Fields

index: u32

responder: LightGetCurrentRgbValueResponder

SetRgbValue

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.

Fields

index: u32

value: Rgb

responder: LightSetRgbValueResponder

GetGroupInfo

Returns group info for the light group. group_id: a number between 0 inclusive and the count received from GetNumLightGroups.

Fields

group_id: u32

responder: LightGetGroupInfoResponder

GetGroupCurrentSimpleValue

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.

Fields

group_id: u32

responder: LightGetGroupCurrentSimpleValueResponder

SetGroupSimpleValue

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.

Fields

group_id: u32

values: Vec<bool>

responder: LightSetGroupSimpleValueResponder

GetGroupCurrentBrightnessValue

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.

Fields

group_id: u32

responder: LightGetGroupCurrentBrightnessValueResponder

SetGroupBrightnessValue

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.

Fields

group_id: u32

values: Vec<f64>

responder: LightSetGroupBrightnessValueResponder

GetGroupCurrentRgbValue

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.

Fields

group_id: u32

responder: LightGetGroupCurrentRgbValueResponder

SetGroupRgbValue

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.

Fields

group_id: u32

values: Vec<Rgb>

responder: LightSetGroupRgbValueResponder

Implementations

impl LightRequest

pub fn into_get_num_lights(self) -> Option<LightGetNumLightsResponder>

pub fn into_get_num_light_groups( self ) -> Option<LightGetNumLightGroupsResponder>

pub fn into_get_info(self) -> Option<(u32, LightGetInfoResponder)>

pub fn into_get_current_simple_value( self ) -> Option<(u32, LightGetCurrentSimpleValueResponder)>

pub fn into_set_simple_value( self ) -> Option<(u32, bool, LightSetSimpleValueResponder)>

pub fn into_get_current_brightness_value( self ) -> Option<(u32, LightGetCurrentBrightnessValueResponder)>

pub fn into_set_brightness_value( self ) -> Option<(u32, f64, LightSetBrightnessValueResponder)>

pub fn into_get_current_rgb_value( self ) -> Option<(u32, LightGetCurrentRgbValueResponder)>

pub fn into_set_rgb_value(self) -> Option<(u32, Rgb, LightSetRgbValueResponder)>

pub fn into_get_group_info(self) -> Option<(u32, LightGetGroupInfoResponder)>

pub fn into_get_group_current_simple_value( self ) -> Option<(u32, LightGetGroupCurrentSimpleValueResponder)>

pub fn into_set_group_simple_value( self ) -> Option<(u32, Vec<bool>, LightSetGroupSimpleValueResponder)>

pub fn into_get_group_current_brightness_value( self ) -> Option<(u32, LightGetGroupCurrentBrightnessValueResponder)>

pub fn into_set_group_brightness_value( self ) -> Option<(u32, Vec<f64>, LightSetGroupBrightnessValueResponder)>

pub fn into_get_group_current_rgb_value( self ) -> Option<(u32, LightGetGroupCurrentRgbValueResponder)>

pub fn into_set_group_rgb_value( self ) -> Option<(u32, Vec<Rgb>, LightSetGroupRgbValueResponder)>

pub fn method_name(&self) -> &'static str

Name of the method defined in FIDL

Trait Implementations

impl Debug for LightRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.