Skip to main content

IdentifyHandler

Struct IdentifyHandler 

Source
pub struct IdentifyHandler<H = ()> { /* private fields */ }
Expand description

The handler for the Identify Matter cluster.

Per-endpoint instance: each endpoint that advertises the Identify cluster must own a separate IdentifyHandler so countdown state and attribute reports stay segregated. The endpoint ID is captured lazily from the first write/command that lands on this instance — no constructor argument required, and the same handler type can therefore serve any endpoint without per-endpoint specialization.

State model: rather than physically decrement an IdentifyTime counter at 1 Hz, the handler captures the originally-requested (endpoint_id, duration, start_instant) when an Identify command (or IdentifyTime write) arrives, and computes the remaining seconds on-demand whenever the framework reads the attribute. This is observably equivalent to a physical countdown per Matter App Cluster spec (which constrains the attribute’s observable value, not the implementation’s internal storage), but it avoids 60 wakeups for a 60-second identify — the run task only schedules a single Timer::at(deadline) per identify cycle, fires the final-zero notify_attr_changed, and parks. On battery-powered targets that’s the difference between a measurable wake-and-radio-on hit per second and a non-event.

Concurrency: the session cell is wrapped in a blocking Mutex so the handler is sound under a future work-stealing executor configuration of rs-matter. Lock holds are bounded to a single Cell::get / Cell::set each — the lock is never held across .await points.

Dataver is bumped automatically by the framework after each write/invoke (via the cluster handler chain’s bump_dataver(MatchContext)), and again whenever a notify_attr_changed is dispatched. This handler therefore never calls self.dataver.changed() directly — it only signals attribute-changed notifications, and the framework takes care of dataver progression.

The handler implements the (sync) ClusterHandler trait — which keeps the read/write/invoke surface as cheap sync calls (smaller footprint than ClusterAsyncHandler’s all-async state machines) — and provides the deadline-timer task via ClusterHandler::run. Adapt it to the generic rs-matter Handler trait with IdentifyHandler::adapt.

Implementations§

Source§

impl IdentifyHandler

Source

pub const fn new(dataver: Dataver) -> IdentifyHandler

Creates a new IdentifyHandler with the no-hardware default () hooks. Suitable for headless test fixtures.

The endpoint ID is not a constructor argument: it is captured at the first write/command from the surrounding OperationContext.

Source§

impl<H> IdentifyHandler<H>
where H: IdentifyHooks,

Source

pub const fn new_with(dataver: Dataver, hooks: H) -> IdentifyHandler<H>

Creates a new IdentifyHandler with application-supplied hooks.

Source

pub const fn adapt(self) -> HandlerAdaptor<IdentifyHandler<H>>

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

Trait Implementations§

Source§

impl<H> ClusterHandler for IdentifyHandler<H>
where H: IdentifyHooks,

Source§

const CLUSTER: Cluster<'static>

The cluster-metadata corresponding to this handler trait.
Source§

fn dataver(&self) -> u32

Source§

fn dataver_changed(&self)

Source§

fn identify_time(&self, _ctx: impl ReadContext) -> Result<u16, Error>

Source§

fn identify_type( &self, _ctx: impl ReadContext, ) -> Result<IdentifyTypeEnum, Error>

Source§

fn set_identify_time( &self, ctx: impl WriteContext, value: u16, ) -> Result<(), Error>

Source§

fn handle_identify( &self, ctx: impl InvokeContext, request: IdentifyRequest<'_>, ) -> Result<(), Error>

Source§

fn handle_trigger_effect( &self, _ctx: impl InvokeContext, request: TriggerEffectRequest<'_>, ) -> Result<(), Error>

Source§

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

Source§

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

Source§

impl<H> IdentifyStatus for IdentifyHandler<H>
where H: IdentifyHooks,

Source§

fn is_identifying(&self) -> bool

Whether the endpoint is currently identifying (IdentifyTime > 0).

Auto Trait Implementations§

§

impl<H = ()> !Freeze for IdentifyHandler<H>

§

impl<H = ()> !RefUnwindSafe for IdentifyHandler<H>

§

impl<H = ()> !Sync for IdentifyHandler<H>

§

impl<H> Send for IdentifyHandler<H>
where H: Send,

§

impl<H> Unpin for IdentifyHandler<H>
where H: Unpin,

§

impl<H> UnsafeUnpin for IdentifyHandler<H>
where H: UnsafeUnpin,

§

impl<H> UnwindSafe for IdentifyHandler<H>
where H: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, E> Init<T, E> for T

Source§

unsafe fn __init(self, slot: *mut T) -> Result<(), E>

Initializes slot. Read more
Source§

fn chain<F>(self, f: F) -> ChainInit<Self, F, T, E>
where F: FnOnce(&mut T) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, I> IntoFallibleInit<T> for I
where I: Init<T>,

Source§

fn into_fallible<E>(self) -> impl Init<T, E>

Convert the infallible initializer to a fallible one.
Source§

impl<Source, Target> OctetsInto<Target> for Source
where Target: OctetsFrom<Source>,

Source§

type Error = <Target as OctetsFrom<Source>>::Error

Source§

fn try_octets_into( self, ) -> Result<Target, <Source as OctetsInto<Target>>::Error>

Performs the conversion.
Source§

fn octets_into(self) -> Target
where Self::Error: Into<Infallible>,

Performs an infallible conversion.
Source§

impl<T, E> PinInit<T, E> for T

Source§

unsafe fn __pinned_init(self, slot: *mut T) -> Result<(), E>

Initializes slot. Read more
Source§

fn pin_chain<F>(self, f: F) -> ChainPinInit<Self, F, T, E>
where F: FnOnce(Pin<&mut T>) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V