Struct Scene 

pub struct Scene {
    pub name: String,
    pub id: i64,
    pub param_id: Option<i64>,
    pub capability_type: String,
    pub instance: String,
}

A light scene (dynamic or DIY) that can be activated on a device.

Dynamic light scenes (from /router/api/v1/device/scenes) carry a param_id alongside the scene id; DIY scenes (from /router/api/v1/device/diy-scenes) are identified by a single integer value, so param_id is None.

Fields

name: String

Human-readable scene name (e.g., “Sunrise”)

id: i64

Scene identifier sent in the control request

param_id: Option<i64>

Companion parameter id (dynamic light scenes only)

capability_type: String

Capability type to send when activating this scene (e.g., “devices.capabilities.dynamic_scene” or “devices.capabilities.diy_color_setting”)

instance: String

Capability instance to send when activating this scene (e.g., “lightScene” or “diyScene”)

Implementations

impl Scene

pub fn control_value(&self) -> Value

The control-request value for this scene: {"paramId": .., "id": ..} for dynamic scenes, a bare integer for DIY scenes.

pub fn from_capabilities(capabilities: &[Capability]) -> Vec<Scene>

Extract scenes from a list of scene capabilities (as returned by the scenes and diy-scenes endpoints).

Trait Implementations

impl Clone for Scene

fn clone(&self) -> Scene

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Scene

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Scene

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Scene

impl PartialEq for Scene

fn eq(&self, other: &Scene) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Scene

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Scene