def

his-point

Historized point with a history log of timestamp/value pairs. Points marked as historized indicate the system can response to queries via the hisRead operation to return a trend log of timestamp/value pairs.

There are typically two mechanisms for historization:

the local system performs the historization by logging the point's curVal to local storage
in overlay systems a downstream device performs the historization and the local system synchronizes the history data in batch on a periodic basis

Also see Points chapter.

conjunct

his	Supports historization of data
point	Data point such as a sensor or actuator

def	his-point
is	point
lib	lib:phIoT

usage

his point

supertypes

marker	Marker labels a dict with typing information
entity	Top-level dicts with a unique identifier
point	Data point such as a sensor or actuator

tags

cur	Supports current value
dis	Display name for an entity
disMacro	Display name using macro syntax
disabled	Indicates the entity is in a disabled state
enum	Defines an eumeration of string key names
equipRef	Reference to equip which contains this entity
his	Supports historization of data
hisCollectCov	Enables COV history collection of the `curVal`
hisCollectCovRateLimit	Rate limits the frequency for `hisCollectCov`
hisCollectInterval	Enables interval history collection of the `curVal`
hisCollectNA	Historize the NA value whenever the `curVal` is null or `curStatus` is not equal to "ok"
hisCollectWriteFreq	This tag configures how long to buffer collected history items in memory before flushing them to the historian
hisErr	Error description when `hisStatus` indicates error condition
hisMode	Indicates the way that history data is collected for a point
hisStatus	Status of point's history collection or synchronization
hisTotalized	Indicates values which are a continuous stream of totalization
id	Defines the unique identifier of an entity in system using a `ref` value type
kind	Kind name used to identity a value data type
maxVal	Inclusive maximum for a numeric value
minVal	Inclusive minimum for a numeric value
pointFunction	Classifies the point as a sensor, command, or setpoint
pointQuantity	Quantity the point senses or controls
pointSubject	What the point senses or controls
siteRef	Reference to site which contains the entity
spaceRef	Reference to space which contains this entity
systemRef	Reference to system
tz	Timezone identifier from standard timezone database
unit	Unit identifier from standard unit database
writable	Supports writing data

def

his-point

conjunct

meta

usage

supertypes

tags