Struct LevelControlHandler 

pub struct LevelControlHandler<'a, H, OH>
where
    H: LevelControlHooks,
    OH: OnOffHooks,
{ /* private fields */ }

Implementation of the LevelControlHandler, providing functionality for the Matter Level Control cluster.

Type Parameters

• 'a: Lifetime for references held by the cluster.
• H: Handler implementing the LevelControlHooks trait, providing cluster-specific configuration and logic.
• OH : Handler implementing the OnOffHooks trait.

Constants

• MAXIMUM_LEVEL: The maximum allowed level value (254).

Panics

• Initialisation panics if the cluster configuration is invalid or required attributes/commands are missing.

Notes

• This implementation follows version 1.3 of the Matter specification.

Implementations

impl<H> LevelControlHandler<'_, H, NoOnOff>

where H: LevelControlHooks,

pub fn new_standalone( dataver: Dataver, endpoint_id: u16, hooks: H, attribute_defaults: AttributeDefaults, ) -> LevelControlHandler<'_, H, NoOnOff>

Creates a new LevelControlHandler with the given hooks which is not coupled to an OnOff cluster.

NOTE: This constructor automatically calls init with no coupled OnOff handler.

Arguments

• hooks - A reference to the struct implementing the device-specific level control logic.

impl<'a, H, OH> LevelControlHandler<'a, H, OH>

where H: LevelControlHooks, OH: OnOffHooks,

pub fn new( dataver: Dataver, endpoint_id: u16, hooks: H, attribute_defaults: AttributeDefaults, ) -> LevelControlHandler<'a, H, OH>

Creates a new LevelControlHandler with the given hooks.

Arguments

• hooks - A reference to the struct implementing the device-specific level control logic.

Usage

• Initialise and optionally couple with an OnOff handler via init.

pub fn with_scene_invalidator( self, invalidator: &'a dyn SceneInvalidator, ) -> LevelControlHandler<'a, H, OH>

Attach a SceneInvalidator — typically the crate::dm::clusters::scenes::ScenesState backing Scenes Management on the same endpoint — so command-driven CurrentLevel mutations flip SceneValid → false for any recalled scene. No-op when unset.

pub fn init(&self, on_off_handler: Option<&'a OnOffHandler<'a, OH, H>>)

Initializes the cluster on startup;

• wire coupled handlers
• validate the handler setup with the configuration
• set the CurrentLevel attribute according to the StartUpCurrentLevel attribute.

Parameters

*on_off_handler: the OnOffHandler instance coupled with this LevelControlHandler, i.e. the OnOff cluster on the same endpoint. This should be set if the OnOff feature is set.

Panics

panics if the state’s CLUSTER is misconfigured.

pub const fn adapt(self) -> HandlerAsyncAdaptor<LevelControlHandler<'a, H, OH>>

Adapt the handler instance to the generic rs-matter Handler trait

Trait Implementations

impl<H, OH> ClusterAsyncHandler for LevelControlHandler<'_, H, OH>

where H: LevelControlHooks, OH: OnOffHooks,

const CLUSTER: Cluster<'static> = H::CLUSTER

The cluster-metadata corresponding to this handler trait.

async fn run(&self, ctx: impl HandlerContext) -> Result<(), Error>

fn dataver(&self) -> u32

fn dataver_changed(&self)

fn current_level( &self, _ctx: impl ReadContext, ) -> impl Future<Output = Result<Maybe<u8, AsNullable>, Error>>

fn on_level( &self, _ctx: impl ReadContext, ) -> impl Future<Output = Result<Maybe<u8, AsNullable>, Error>>

fn set_on_level( &self, ctx: impl WriteContext, value: Maybe<u8, AsNullable>, ) -> impl Future<Output = Result<(), Error>>

fn options( &self, _ctx: impl ReadContext, ) -> impl Future<Output = Result<OptionsBitmap, Error>>

fn set_options( &self, ctx: impl WriteContext, value: OptionsBitmap, ) -> impl Future<Output = Result<(), Error>>

fn remaining_time( &self, _ctx: impl ReadContext, ) -> impl Future<Output = Result<u16, Error>>

fn max_level( &self, _ctx: impl ReadContext, ) -> impl Future<Output = Result<u8, Error>>

fn min_level( &self, _ctx: impl ReadContext, ) -> impl Future<Output = Result<u8, Error>>

fn on_off_transition_time( &self, _ctx: impl ReadContext, ) -> impl Future<Output = Result<u16, Error>>

fn set_on_off_transition_time( &self, ctx: impl WriteContext, value: u16, ) -> impl Future<Output = Result<(), Error>>

fn on_transition_time( &self, _ctx: impl ReadContext, ) -> impl Future<Output = Result<Maybe<u16, AsNullable>, Error>>

fn set_on_transition_time( &self, ctx: impl WriteContext, value: Maybe<u16, AsNullable>, ) -> impl Future<Output = Result<(), Error>>

fn off_transition_time( &self, _ctx: impl ReadContext, ) -> impl Future<Output = Result<Maybe<u16, AsNullable>, Error>>

fn set_off_transition_time( &self, ctx: impl WriteContext, value: Maybe<u16, AsNullable>, ) -> impl Future<Output = Result<(), Error>>

fn default_move_rate( &self, _ctx: impl ReadContext, ) -> impl Future<Output = Result<Maybe<u8, AsNullable>, Error>>

fn set_default_move_rate( &self, ctx: impl WriteContext, value: Maybe<u8, AsNullable>, ) -> impl Future<Output = Result<(), Error>>

fn start_up_current_level( &self, _ctx: impl ReadContext, ) -> impl Future<Output = Result<Maybe<u8, AsNullable>, Error>>

fn set_start_up_current_level( &self, ctx: impl WriteContext, value: Maybe<u8, AsNullable>, ) -> impl Future<Output = Result<(), Error>>

fn handle_move_to_level( &self, _ctx: impl InvokeContext, request: MoveToLevelRequest<'_>, ) -> impl Future<Output = Result<(), Error>>

fn handle_move( &self, _ctx: impl InvokeContext, request: MoveRequest<'_>, ) -> impl Future<Output = Result<(), Error>>

fn handle_step( &self, _ctx: impl InvokeContext, request: StepRequest<'_>, ) -> impl Future<Output = Result<(), Error>>

fn handle_stop( &self, ctx: impl InvokeContext, request: StopRequest<'_>, ) -> impl Future<Output = Result<(), Error>>

fn handle_move_to_level_with_on_off( &self, _ctx: impl InvokeContext, request: MoveToLevelWithOnOffRequest<'_>, ) -> impl Future<Output = Result<(), Error>>

fn handle_move_with_on_off( &self, _ctx: impl InvokeContext, request: MoveWithOnOffRequest<'_>, ) -> impl Future<Output = Result<(), Error>>

fn handle_step_with_on_off( &self, _ctx: impl InvokeContext, request: StepWithOnOffRequest<'_>, ) -> impl Future<Output = Result<(), Error>>

fn handle_stop_with_on_off( &self, ctx: impl InvokeContext, request: StopWithOnOffRequest<'_>, ) -> impl Future<Output = Result<(), Error>>

fn handle_move_to_closest_frequency( &self, _ctx: impl InvokeContext, _request: MoveToClosestFrequencyRequest<'_>, ) -> impl Future<Output = Result<(), Error>>

fn lifecycle( &self, _ctx: impl HandlerContext, _op: LifecycleOp, ) -> Result<(), Error>

fn current_frequency( &self, ctx: impl ReadContext, ) -> impl Future<Output = Result<u16, Error>>

fn min_frequency( &self, ctx: impl ReadContext, ) -> impl Future<Output = Result<u16, Error>>

fn max_frequency( &self, ctx: impl ReadContext, ) -> impl Future<Output = Result<u16, Error>>

impl<H, OH> SceneClusterHandler for LevelControlHandler<'_, H, OH>

where H: LevelControlHooks, OH: OnOffHooks,

Scenes Management integration for the LevelControl cluster. The only scenable attribute is CurrentLevel; apply routes through MoveToLevel with the scene’s transition time.

const CLUSTER_ID: u32

The Matter cluster ID this impl handles.

fn endpoint_id(&self) -> u16

Endpoint this handler instance is installed on. Used to skip clusters not on the StoreScene / RecallScene target endpoint.

fn is_scenable_attribute(attribute_id: u32) -> bool

True if attribute_id is a scenable attribute of this cluster per the Matter Core Spec. AddScene rejects EFS payloads that reference non-scenable attributes.

fn capture<P>( &self, avp_array: AttributeValuePairStructArrayBuilder<P>, ) -> Result<AttributeValuePairStructArrayBuilder<P>, Error>

where P: TLVBuilderParent,

Emit AVP entries for this cluster’s scenable state into avp_array. Use AttributeValuePairStructArrayBuilder::push_u8 / AttributeValuePairStructArrayBuilder::push_u16 for a one-line per-attribute API.

async fn apply<C>( &self, _ctx: &C, avp_list: &TLVContainer<'_, AttributeValuePairStruct<'_>, ArrayContainer>, transition_time_ms: u32, ) -> Result<(), Error>

where C: HandlerContext,

Apply captured AVPs to the cluster’s internal state. Async because some clusters (LevelControl) kick off transition tasks; sync-only impls can return core::future::ready.