- Index
- »
- ph
- »
- WritablePoint
WritablePoint
WritablePoint : Point
Point with writable output using 16-level priority array. Writable points typically are a setpoint or actuator command. Haystack writable points are modeled on the BACnet 16-level priority array with a relinquish default which effectively acts as level 17.
The following levels have special behavior:
- Level 1: highest priority reserved for emergency overrides
- Level 8: manual override with ability to set timer to expire back to auto
- Default: implicitly acts as level 17 for relinquish default
The priority array provides for contention resolution when many different control applications may be vying for control of a given point. Low level applications like scheduling typically control levels 14, 15, or 16. Then users can override at level 8. But a higher levels like 2 to 7 can be used to trump a user override (for example a demand response energy routine that requires higher priority).
The actual value to write is resolved by starting at level 1 and working down to relinquish default to find the first non-null value. It is possible for all levels to be null, in which case the overall write output is null (which in turn may be auto/null to another system). Anytime a null value is written to a priority level, we say that level has been set to auto or released (this allows the next highest level to take command of the output).
Also see Points chapter.
Unique identifier for entity in its project
Type of this entity
Data point such as a sensor or actuator
Supports current value
Defines an eumeration of string key names
Reference to equip which contains this entity
Supports historization of data
Kind name used to identity a value data type
Inclusive maximum for a numeric value
Inclusive minimum for a numeric value
Reference to site which contains the entity
Reference to space which contains this entity
Reference to system
Timezone identifier from standard timezone database
Unit identifier from standard unit database
Supports writing data
Parent Equips that contain this Point
Error description when writeStatus indicates error condition
Current priority level for writeVal as number between 1 and 17
Current status of a writable point output
Current desired value to write to output
Marker
Supports writing data
Str?
Error description when writeStatus indicates error condition
Number?
Current priority level for writeVal as number between 1 and 17. The value 17 indicates the relinquish default value.
WriteStatus?
Current status of a writable point output
Obj?
Current desired value to write to output. This is the current "winning" value of the priority array indicated by writeLevel. If this tag is missing then the winning value is null/auto.