Struct LightingOutputObject 

pub struct LightingOutputObject { /* private fields */ }

BACnet Lighting Output object.

Commandable output with a 16-level priority array controlling a floating-point present-value (0.0 to 100.0 percent). A commanded level above 0.0 and below 1.0 is stored as 1.0, and so is such a Relinquish_Default (see set_relinquish_default).

Lighting_Command takes a BACnetLightingCommand checked against its operation (see set_lighting_command), serves the last one taken and carries it out (#1384): fades and ramps move Tracking_Value to a new level over time with In_Progress showing which, steps change the level at once, and the warn operations blink and hold the level for Egress_Time before relinquishing or turning it off. Present_Value takes the blink-warn values -1.0, -2.0 and -3.0 as the three warn commands. Tracking_Value equals Present_Value whenever no fade or ramp is moving it and no trim holds it.

Color_Reference, Color_Override and Override_Color_Reference are absent until set_color_link links the output to its colour objects (#1527).

High_End_Trim, Low_End_Trim and Trim_Fade_Time are absent until set (#1528; see set_high_end_trim). Once set, Tracking_Value is held between the trims, In_Progress reads TRIM_ACTIVE while that keeps it from Present_Value, and a trim change takes Trim_Fade_Time to show.

Fades, ramps and egress timers run on the monotonic clock the database binds; the server’s monotonic task advances them and fans their COV out. With no clock bound they wait on advance_time_internal.

Cloning copies served state into an in-memory object. Tags persistence and pending saves remain solely with the original; cloning or dropping the copy never saves, corrects, settles, or waits on the original writer.

Implementations

impl LightingOutputObject

pub fn set_high_end_trim(&mut self, trim: Option<f32>) -> Result<(), Error>

Set High_End_Trim, the top of the range Tracking_Value is held in, as a WriteProperty of it would; None takes the property away.

A trim is 1.0 to 100.0 percent; anything else is refused with VALUE_OUT_OF_RANGE and changes nothing. Setting either trim makes Trim_Fade_Time present too. Tracking_Value follows the change over Trim_Fade_Time, and a high trim below the low one sets Reliability to CONFIGURATION_ERROR and holds nothing until it’s put right.

pub fn set_low_end_trim(&mut self, trim: Option<f32>) -> Result<(), Error>

Set Low_End_Trim, the bottom of the range Tracking_Value is held in while the light is on; None takes the property away. Checked and applied as set_high_end_trim is.

pub fn set_trim_fade_time(&mut self, milliseconds: u32) -> Result<(), Error>

Set Trim_Fade_Time, the milliseconds Tracking_Value takes to follow a trim change: 0 (at once, the initial value) to 86,400,000 (a day). Anything else is refused with VALUE_OUT_OF_RANGE (Clause 12.54.Y3). The property is present only with a trim, but the setting is kept either way. A change already under way keeps its own time.

impl LightingOutputObject

pub fn new(instance: u32, name: impl Into<String>) -> Result<Self, Error>

Create a new Lighting Output object.

pub fn set_description(&mut self, desc: impl Into<String>)

Set the description string.

pub fn set_relinquish_default(&mut self, value: f32) -> Result<(), Error>

Set the Relinquish_Default (#270).

Checked the same way a commanded Present_Value is: a value outside 0.0 to 100.0, or NaN, is refused with VALUE_OUT_OF_RANGE, and one above 0.0 and below 1.0 is stored as 1.0, so Present_Value never falls back to a level between off and the dimmest on level. After the store, Present_Value is resolved anew from the priority array so an empty array falls back to the new default immediately.

pub fn lighting_command(&self) -> BACnetLightingCommand

The last command written to Lighting_Command, or operation NONE with no other field before any write.

pub fn set_lighting_command( &mut self, command: BACnetLightingCommand, ) -> Result<(), Error>

Set Lighting_Command and carry the command out, as a WriteProperty of the encoded command would.

The command is checked against its operation (Clause 12.54, Table 12-67). NONE, a reserved operation (11 to 255) and anything past 65,535 are refused; FADE_TO and RAMP_TO need a target level. A field the operation uses must be in range: target level 0.0 to 100.0, fade time 100 to 86,400,000 ms, ramp rate and step increment 0.1 to 100.0, priority 1 to 16. Fields it doesn’t use are kept unchecked, and a proprietary operation (256 to 65,535) has only its priority checked. A refusal is VALUE_OUT_OF_RANGE and leaves the object unchanged.

A command taken is stored as written and carried out at its priority, or at Lighting_Command_Default_Priority when it has none. A level it puts in a priority slot is normalized as a commanded Present_Value is (Clause 12.54.4), so a FADE_TO 0.5 fades to 1.0 while Lighting_Command still reads 0.5. A proprietary operation is stored and does nothing else.

pub fn set_color_link(&mut self, link: Option<ColorLink>) -> Result<(), Error>

Link the output to the colour objects that set its colour, or take the link away with None (#1527, Addendum 135-2020ca part 4).

A link serves Color_Reference, and with a ColorOverride also Color_Override and Override_Color_Reference; all of them take writes. Each reference must name a colour object, Color or Color Temperature (instance 4194303 names none); anything else is refused with VALUE_OUT_OF_RANGE and changes nothing. The object only stores the references: ObjectDatabase::lighting_color follows them.

pub fn color_link(&self) -> Option<&ColorLink>

The colour link, if one is set.

pub fn with_tags_persistence( instance: u32, name: impl Into<String>, persistence: Arc<dyn TagsPersistence>, ) -> Result<Self, Error>

Build with application-owned Tags storage. Saved Tags override configured Tags only while set_profile provisions the row. Loaded data must satisfy the normal Tags rules and the opt-in 1 MiB snapshot limit.

pub fn wait_for_tag_saves(&self)

Wait for queued save attempts to finish. This is not a success receipt; writes report their own save outcomes. Unstaged local writes block.

pub fn set_profile(&mut self, profile: ObjectProfile) -> Result<(), Error>

Provision the optional Tags, Profile_Location and Profile_Name rows before registration (#1553), as a Color object’s set_profile does.

pub fn set_default_fade_time(&mut self, milliseconds: u32) -> Result<(), Error>

Set Default_Fade_Time, the milliseconds a fade request without its own fade time takes. A new object uses 100, the shortest fade the clause allows, as Default_Ramp_Rate starts at its fastest rate.

Clause 12.54.16 bounds it to 100..=86_400_000 (one day); a value outside that range is refused with VALUE_OUT_OF_RANGE and the property is left unchanged. WriteProperty applies the same check.

pub fn set_default_ramp_rate(&mut self, value: f32) -> Result<(), Error>

Set Default_Ramp_Rate, the percent-per-second rate a ramp request without its own rate uses. A new object uses 100.0.

Clause 12.54.17 bounds it to 0.1..=100.0; a value outside that range, or a non-finite one, is refused with VALUE_OUT_OF_RANGE and the property is left unchanged. WriteProperty applies the same check.

pub fn set_default_step_increment(&mut self, value: f32) -> Result<(), Error>

Set Default_Step_Increment, the percent a step request without its own increment adds. A new object uses 1.0.

Clause 12.54.18 bounds it to 0.1..=100.0; a value outside that range, or a non-finite one, is refused with VALUE_OUT_OF_RANGE and the property is left unchanged. WriteProperty applies the same check.

Trait Implementations

impl BACnetObject for LightingOutputObject

fn object_identifier(&self) -> ObjectIdentifier

The object’s identifier (type + instance).

fn object_name(&self) -> &str

The object’s name.

fn read_property( &self, property: PropertyIdentifier, array_index: Option<u32>, ) -> Result<PropertyValue, Error>

Read a property value.

fn write_property( &mut self, property: PropertyIdentifier, array_index: Option<u32>, value: PropertyValue, priority: Option<u8>, ) -> Result<(), Error>

Write a property value.

fn property_list(&self) -> Cow<'static, [PropertyIdentifier]>

List all properties this object supports in the legacy projection.

fn property_metadata(&self) -> Cow<'_, [PropertyMetadata]>

Return canonical metadata for this object’s effective property rows.

fn cov_increment(&self) -> Option<f64>

COV increment for this object (objects with a COV_Increment property).

fn supports_cov(&self) -> bool

Whether this object type supports COV notifications.

fn write_property_from( &mut self, property: PropertyIdentifier, array_index: Option<u32>, value: PropertyValue, priority: Option<u8>, _origin: &CommandOrigin, ) -> Result<(), Error>

Write with explicit actual command provenance. Standalone callers assert the origin; server boundaries additionally validate ingress or membership. Decorators must forward this hook without discarding the origin. The default preserves custom/unaffected object behavior. First-party source-tracked commands require this hook and deny context-free writing.

fn is_writable_property(&self, property: PropertyIdentifier) -> bool

Whether a property write route can accept property for this object.

fn is_array_property(&self, property: PropertyIdentifier) -> bool

Whether property accepts an array index on this object.

fn is_list_property(&self, property: PropertyIdentifier) -> bool

Whether property is a BACnetLIST on this object.

fn is_createable(&self) -> bool

Whether this object type can be created at runtime via CreateObject.

fn creation_only_properties(&self) -> &'static [PropertyIdentifier]

The properties whose whole value a CreateObject initial value may set on this object although WriteProperty can’t change it afterwards.

fn initialize_property( &mut self, _property: PropertyIdentifier, _value: PropertyValue, ) -> Result<(), Error>

Apply a CreateObject initial value to one of Self::creation_only_properties, written whole.

fn is_deleteable(&self) -> bool

Whether this object type can be deleted at runtime via DeleteObject.

fn required_properties(&self) -> Cow<'static, [PropertyIdentifier]>

List the REQUIRED properties for this object type.

fn supports_subscribe_cov_property(&self) -> bool

Whether SubscribeCOVProperty and SubscribeCOVPropertyMultiple may monitor this object’s properties.

fn supports_cov_property(&self, property: PropertyIdentifier) -> bool

Whether a readable property supports property-specific COV.

fn cov_reported_properties(&self) -> &'static [CovReportedProperty]

Properties a whole-object (SubscribeCOV) notification reports after its leading value and Status_Flags, in report order.

fn set_overridden(&mut self, _overridden: bool)

Set the OVERRIDDEN bit in StatusFlags.

fn evaluate_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>

Evaluate intrinsic reporting after a present_value change.

fn tick_intrinsic_reporting(&mut self) -> Option<TransitionOutcome>

Advance the Time_Delay countdown for a pending transition.

fn tick_schedule( &mut self, _today: SpecificDate, _time: Time, _calendar_active: &dyn Fn(ObjectIdentifier) -> bool, ) -> Option<ScheduleWrite>

Evaluate this object’s schedule at time on today (Clause 12.24.4).

fn take_owed_schedule_writes(&mut self) -> Vec<ScheduleWrite>

Take the writes this schedule owes its targets apart from its calculation, each once, in order: a NULL to every priority slot a change of List_Of_Object_Property_References or Priority_For_Writing left behind (#1088), then the Present_Value owed out of service, for a client’s write (Clause 12.24.14) or a change of those two properties.

fn complete_schedule_write( &mut self, _write: &ScheduleWrite, _outcomes: &[ScheduleTargetOutcome], ) -> bool

Report how each target took write, one of this schedule’s writes: outcomes holds one entry per member of write.references, in order.

fn retry_refusals_naming( &self, _target: ObjectIdentifier, ) -> Option<ScheduleWrite>

The retry of the current value to the references whose last write was refused and that name target, an object just added to the database (#1440), so the refusal can clear without waiting for the next pass. None when no such refusal stands, or when the pass itself would retry nothing: out of service, outside Effective_Period, or with a NULL Present_Value. Only meaningful for Schedule objects; default returns None.

fn acknowledge_alarm( &mut self, _transition_bit: EventTransitionBits, ) -> Result<(), Error>

Acknowledge an alarm transition. Sets the transition_bit flags in acked_transitions. Returns Ok(()) if the object supports event detection, Err otherwise.

fn apply_life_safety_operation( &mut self, _operation: LifeSafetyOperation, ) -> Result<LifeSafetyOperationOutcome, Error>

Apply a LifeSafetyOperation atomically to this object.

fn set_life_safety_operation_expected_internal( &mut self, _operation: LifeSafetyOperation, ) -> Result<(), Error>

Set the next LifeSafetyOperation expected by trusted local logic.

fn set_event_state_internal(&mut self, _state: EventState) -> Result<(), Error>

Apply an internally-detected Event_State transition.

fn enrollment_eval_state_internal(&self) -> Option<EventEnrollmentEvalState>

Snapshot this object’s Event Enrollment evaluation state, if it models one.

fn set_enrollment_eval_state_internal( &mut self, _state: EventEnrollmentEvalState, ) -> Result<(), Error>

Store this object’s Event Enrollment evaluation state.

fn enrollment_eval_source_internal( &self, ) -> Option<Option<EventEnrollmentMonitoredSource>>

Snapshot the monitored source that owns Event Enrollment private state.

fn set_enrollment_eval_source_internal( &mut self, _source: Option<EventEnrollmentMonitoredSource>, ) -> Result<(), Error>

Store or clear the monitored source that owns Event Enrollment state.

fn set_acked_transitions_internal( &mut self, _transition_bit: EventTransitionBits, _acknowledged: bool, ) -> Result<(), Error>

Set or clear one Acked_Transitions bit on a received event-state transition.

fn evaluate_reliability_internal( &mut self, ) -> Result<ReliabilityEvaluation, Error>

Evaluate and, when necessary, mutate this object’s Reliability.

fn set_reliability_internal( &mut self, _reliability: Reliability, ) -> Result<(), Error>

Apply an internally-derived Reliability value.

fn set_present_value_internal( &mut self, _value: PropertyValue, ) -> Result<(), Error>

Apply the logical Present_Value supplied by the local application.

fn set_present_value_from_internal( &mut self, value: PropertyValue, _origin: &CommandOrigin, ) -> Result<(), Error>

set_present_value_internal on behalf of origin, the local Device the application runs in.

fn set_tracking_value_internal( &mut self, _value: PropertyValue, ) -> Result<(), Error>

Apply the Tracking_Value the local application derived.

fn report_access_input_internal( &mut self, _input: AccessControlInput, ) -> Result<(), Error>

Apply an input the application reports for an access-control object the server holds (#1132): an Access Point’s access event, a Credential Data Input’s read or an Access Door’s hardware state, each a record whose values change together. See AccessControlInput.

fn set_controlled_variable_value_internal( &mut self, _value: PropertyValue, ) -> Result<(), Error>

Apply the Controlled_Variable_Value measured by the local application.

fn add_averaging_sample_internal( &mut self, _sample: Option<PropertyValue>, ) -> Result<(), Error>

Record one sample for an Averaging object.

fn audit_log_storage_internal(&self) -> Option<&dyn AuditLogStorage>

Borrow this object’s Audit Log query storage, if it has any.

fn audit_log_notification_sink_internal( &mut self, ) -> Option<&mut dyn AuditLogNotificationSink>

Mutably borrow this object’s Audit notification receiver capability.

fn file_storage_internal(&self) -> Option<&dyn FileStorage>

Borrow this object’s File storage, if it has any.

fn file_storage_internal_mut(&mut self) -> Option<&mut dyn FileStorage>

Mutably borrow this object’s File storage, if it has any.

fn log_record_identities_internal(&self) -> Option<Vec<LogRecordIdentity>>

Return stable identities aligned with this object’s resident log records.

fn log_buffer_internal(&self) -> Option<&dyn LogBufferRecords>

Borrow this object’s Log_Buffer records as ReadRange pages them.

fn add_trend_record(&mut self, _record: BACnetLogRecord) -> Result<(), Error>

Submit a trend record to an object’s log lifecycle.

fn add_trend_multiple_record( &mut self, _record: BACnetLogMultipleRecord, ) -> Result<(), Error>

Submit a Trend Log Multiple record, one value per monitored member, to an object’s log lifecycle.

fn add_event_log_record( &mut self, _record: BACnetEventLogRecord, ) -> Result<(), Error>

Submit an Event Log record to an object’s log lifecycle.

impl Clone for LightingOutputObject

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.