Skip to main content

BACnetLightingCommand

Struct BACnetLightingCommand 

Source
pub struct BACnetLightingCommand {
    pub operation: LightingOperation,
    pub target_level: Option<f32>,
    pub ramp_rate: Option<f32>,
    pub step_increment: Option<f32>,
    pub fade_time: Option<u32>,
    pub priority: Option<u8>,
}
Expand description

BACnetLightingCommand (Clause 21): a lighting operation and the parameters it may carry.

A Lighting Output serves the last one written as Lighting_Command, and a Channel can pass one to its members (Clause 12.53). On the wire it is a SEQUENCE of primitive context tags in ascending order: the operation [0], then whichever of the target level [1], ramp rate [2], step increment [3] (each a REAL), fade time [4] and priority [5] (each an Unsigned) are present. The bacnet-encoding crate owns the codec.

The type holds any values that fit its fields. Which fields an operation uses, and their ranges, are for the object that takes the command to check; a Lighting Output does so on every write (Table 12-67).

use bacnet_types::constructed::BACnetLightingCommand;
use bacnet_types::enums::LightingOperation;

// Fade to 40 % over two seconds at priority 8.
let fade = BACnetLightingCommand {
    target_level: Some(40.0),
    fade_time: Some(2_000),
    priority: Some(8),
    ..BACnetLightingCommand::new(LightingOperation::FADE_TO)
};
assert_eq!(fade.ramp_rate, None);

Fields§

§operation: LightingOperation

Context tag 0: the operation requested.

§target_level: Option<f32>

Context tag 1: the level to fade or ramp to, in percent.

§ramp_rate: Option<f32>

Context tag 2: the ramp rate, in percent per second.

§step_increment: Option<f32>

Context tag 3: the amount a step changes the level by, in percent.

§fade_time: Option<u32>

Context tag 4: how long a fade takes, in milliseconds.

§priority: Option<u8>

Context tag 5: the priority the command acts at, 1 (highest) to 16.

Implementations§

Source§

impl BACnetLightingCommand

Source

pub const fn new(operation: LightingOperation) -> Self

A command for operation that carries no other field.

Trait Implementations§

Source§

impl Clone for BACnetLightingCommand

Source§

fn clone(&self) -> Self

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 Copy for BACnetLightingCommand

Source§

impl Debug for BACnetLightingCommand

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for BACnetLightingCommand

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for BACnetLightingCommand

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, 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.