Skip to main content

ControlCommand

Enum ControlCommand 

Source
pub enum ControlCommand {
Show 17 variants Floodlight { camera: String, state: bool, }, FloodlightTasks { camera: String, state: bool, }, Led { camera: String, state: bool, }, Ir { camera: String, mode: IrMode, }, Pir { camera: String, state: bool, }, Reboot { camera: String, }, Ptz { camera: String, direction: PtzDirection, amount: f32, }, PtzPreset { camera: String, preset_id: u8, }, PtzPresetByName { camera: String, name: String, }, PtzAssign { camera: String, preset_id: u8, name: String, }, Zoom { camera: String, level: f32, }, Siren { camera: String, state: bool, }, Wakeup { camera: String, minutes: u32, }, QueryBattery { camera: String, }, QueryPreview { camera: String, }, QueryPir { camera: String, }, QueryPtzPreset { camera: String, },
}
Expand description

A validated control or query command extracted from an MQTT message.

Variants§

§

Floodlight

Fields

§camera: String
§state: bool
§

FloodlightTasks

Fields

§camera: String
§state: bool
§

Led

Fields

§camera: String
§state: bool
§

Ir

Fields

§camera: String
§mode: IrMode
§

Pir

Fields

§camera: String
§state: bool
§

Reboot

Fields

§camera: String
§

Ptz

Fields

§camera: String
§direction: PtzDirection
§amount: f32
§

PtzPreset

Fields

§camera: String
§preset_id: u8
§

PtzPresetByName

Variant used by HA’s preset select entity, which publishes the preset name (the option label). The dispatcher resolves the name to an id via the camera’s preset_cache.

Fields

§camera: String
§name: String
§

PtzAssign

Fields

§camera: String
§preset_id: u8
§name: String
§

Zoom

Fields

§camera: String
§level: f32
§

Siren

Fields

§camera: String
§state: bool
§

Wakeup

Fields

§camera: String
§minutes: u32
§

QueryBattery

Fields

§camera: String
§

QueryPreview

Fields

§camera: String
§

QueryPir

Fields

§camera: String
§

QueryPtzPreset

Fields

§camera: String

Implementations§

Source§

impl ControlCommand

Source

pub fn control_topic(&self, prefix: &str) -> String

Returns the MQTT control topic this command was received on. Used for publishing OK/FAIL replies. prefix is the configured mqtt.topic_prefix.

Source

pub fn camera_name(&self) -> &str

Returns the camera name that this command targets.

Trait Implementations§

Source§

impl Clone for ControlCommand

Source§

fn clone(&self) -> ControlCommand

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ControlCommand

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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