Skip to main content

EntityToAccessoryMapper

homecore_hap::mapping

Struct EntityToAccessoryMapper

pub struct EntityToAccessoryMapper;

Expand description

Maps a HOMECORE entity (EntityId, State) pair to a HapAccessoryType and its current characteristic values.

Rule table (mirrors HA homekit_controller mapping):

Domain	device_class	HAP service
`light`	—	Lightbulb
`switch`	—	Switch
`binary_sensor`	`occupancy`	OccupancySensor
`binary_sensor`	`motion`	MotionSensor
`binary_sensor`	`door` / `window`	ContactSensor
`sensor`	— + unit=°C/°F	TemperatureSensor
`sensor`	— + unit=% (humidity)	HumiditySensor
`cover` (door)	—	Door
`lock`	—	Lock

Implementations§

impl EntityToAccessoryMapper

pub fn map( entity_id: &EntityId, state: &State, ) -> Result<AccessoryMapping, HapError>

Map a HOMECORE entity to its HAP representation.

Returns HapError::UnmappableEntity for domains that have no defined HAP mapping (e.g. automation, input_boolean).

Auto Trait Implementations§

impl Freeze for EntityToAccessoryMapper

impl RefUnwindSafe for EntityToAccessoryMapper

impl Send for EntityToAccessoryMapper

impl Sync for EntityToAccessoryMapper

impl Unpin for EntityToAccessoryMapper

impl UnsafeUnpin for EntityToAccessoryMapper

impl UnwindSafe for EntityToAccessoryMapper

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more