BACnetStack_SetLiftOrEscalatorEnergyMeterRef
bool BACnetStack_SetLiftOrEscalatorEnergyMeterRef( const uint32_t deviceInstance, const uint16_t objectType, const uint32_t objectInstance, const bool energyMeterRefUseDevice, const uint32_t energyMeterRefDeviceInstance, const uint16_t energyMeterRefObjectType, const uint32_t energyMeterRefObjectInstance);Sets the EnergyMeterRef property of a Lift or Escalator object.
If the EnergyMeterRef property has not been enabled for this Lift or Escalator object, then this function will enable it.
If a Lift object already has the EnergyMeter property enabled and if the energyMeterRefObjectInstance is not set to 4194303, then the CAS BACnet Stack will use a value of 0.0 for the Energy Meter propery. Note: The above only applies to Lift objects, not Escalator objects
cl. 12.59.27 (Lift) and cl. 12.60.12 (Escalator): once Energy_Meter_Ref exists and holds an instance other than 4194303, an Energy_Meter property on the same object, where there is one, has to read 0.0.
BACnet reference: ANSI/ASHRAE 135-2024 clause 12.59 (Lift Object Type); clause 12.60 (Escalator Object Type).
Parameters
Section titled “Parameters”| Parameter | Direction | Description |
|---|---|---|
deviceInstance |
in | The instance of the device that contains the Lift object. |
objectType |
in | The BACnet Object Type of this object. Must be either Lift or Escalator. See CASBACnetStack::BACnetObjectType for more info. With objectInstance, this is one BACnet Object Identifier carried as two parameters (see the API conventions). |
objectInstance |
in | The instance of the Lift object to update. |
energyMeterRefUseDevice |
in | Flag that specifies whether the energy meter reference has a device identifier (true) or not (false). With the three energyMeterRef parameters after it, this forms Energy_Meter_Ref, a BACnetDeviceObjectReference (cl. 12.59, 12.60, cl. 21) whose device-identifier is present only when this is true. |
energyMeterRefDeviceInstance |
in | The instance of the Device holding the Energy Meter Ref object. |
energyMeterRefObjectType |
in | The BACnet Object Type of the object that is the Energy Meter Ref. CASBACnetStack::BACnetObjectType for more info. With energyMeterRefObjectInstance, this is one BACnet Object Identifier carried as two parameters. |
energyMeterRefObjectInstance |
in | The instance of the object that is the Energy Meter Ref. |
Returns
Section titled “Returns”True on success; false if the device or Lift/Escalator object does not exist, or Lift/Escalator support was not compiled.
Topic: Schedules, calendars, trend logs and other object configuration. Declared in CASBACnetStackDLL.h.