settings/light/
light_hardware_configuration.rs

1// Copyright 2020 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use crate::config::default_settings::DefaultSetting;
6use crate::inspect::config_logger::InspectConfigLogger;
7use crate::light::types::LightType;
8use serde::{Deserialize, Serialize};
9use std::rc::Rc;
10use std::sync::Mutex;
11
12#[derive(PartialEq, Debug, Clone, Deserialize)]
13pub struct LightHardwareConfiguration {
14    /// List of light groups to surface to clients of the API.
15    pub light_groups: Vec<LightGroupConfiguration>,
16}
17
18#[derive(PartialEq, Debug, Clone, Deserialize)]
19pub struct LightGroupConfiguration {
20    /// Name of the light group.
21    ///
22    /// Must be unique as this is the primary identifier for light groups.
23    pub name: String,
24
25    /// Each light in the underlying fuchsia.hardware.light API has a unique, fixed index. We need
26    /// to remember the index of the lights in this light group in order to write values back.
27    pub hardware_index: Vec<u32>,
28
29    /// Type of values the light group supports, must match the underlying type of all the lights in
30    /// the group.
31    pub light_type: LightType,
32
33    /// True if the values of this light group should be persisted across reboots and restored when
34    /// the settings service starts.
35    pub persist: bool,
36
37    /// A list of conditions under which the "enabled" field of the light group should be false,
38    /// which signals to clients the light's state is being overridden by external conditions, such
39    /// as an LED dedicated to showing that a device's mic is muted that is off when the mic is not
40    /// muted.
41    ///
42    /// Lights that are disabled can still have their value set, but the changes may not be
43    /// noticeable to the user until the condition disabling/overriding ends.
44    pub disable_conditions: Vec<DisableConditions>,
45}
46
47#[derive(PartialEq, Debug, Clone, Serialize, Deserialize)]
48pub enum DisableConditions {
49    /// Signals that the light group should be marked as disabled when the device's mic switch is
50    /// set to "on".
51    MicSwitch,
52}
53
54pub fn build_light_default_settings(
55    config_logger: Rc<Mutex<InspectConfigLogger>>,
56) -> DefaultSetting<LightHardwareConfiguration, &'static str> {
57    DefaultSetting::new(None, "/config/data/light_hardware_config.json", config_logger)
58}
settings/light/light_hardware_configuration.rs

settings/light/
light_hardware_configuration.rs
