def

number

Integer or floating point numbers annotated with an optional unit. See Kinds chapter.

meta

supertypes

val

Data value type

    scalar

Scalar is an atomic value kind

subtypes

area

Area of a shape or floor space

coolingCapacity

Measurement of a chiller ability to remove heat measured

curCalibration

Calibration value to apply to adjust the value read from the connector before updating curVal

duration

Number with a unit of time

    actorTimeout

Timeout for messages send to the connector's actor thread

    connLinger

Linger timeout used to keep a connector open

    connOpenRetryFreq

Duration used for connector open retries

    connPingFreq

Duration used to configure the auto-ping feature on a given connector

    haystackPollFreq

Applied to haystackConn to tune the duration between watch polls

    hisCollectCovRateLimit

Rate limits the frequency for hisCollectCov

    hisCollectInterval

Enables interval history collection of the curVal

    hisCollectWriteFreq

This tag configures how long to buffer collected history items in memory before flushing them to the historian

    modbusReadTimeout

How long to wait before timing out on a modbus read

    modbusWriteTimeout

How long to wait before timing out on a modbus write

    mqttRetryInterval

How long to wait between retries for messages that require acknowlegment

    obixPollFreq

Duration between obixConn watch polls

    obsScheduleFreq

Schedule events with given frequency

    pollTime

Frequency between polls of curVal

    staleTime

Time before a point's curStatus marked from "ok" to "stale" See Connector Tuning

    steadyState

The delay before transitioning to the steady state

    writeMaxTime

Maximum time between writes used to send periodic writes

    writeMinTime

Minimum time between writes used to throttle the speed of writes

geoElevation

Elevation above sea-level of the location

hisCollectCov

Enables COV history collection of the curVal

int

Unitless integer number

    floorNum

Unitless integer indicating the floor's distance from ground level

    haystackWriteLevel

Number between 1 and 16 used with haystackWrite to determine which priority level of the remote system is written to

    modbusBlockGap

Applied to modbusConn to allow for gaps in block reads

    modbusBlockMax

Applied to modbusConn to limit the maximum number of registers to read in a block read

    modbusSlave

Applied to modbusConn to identify the slave address on this modbus network

    mqttMaxRetry

How many times to retry sending messages that require acknowlegment

    obixWritable

Server export of a writable point as an obix:Writable:Point

    obixWriteLevel

Number between 1 and 16 used with obixWrite to determine which priority level of the remote system is written to

    stage

Stage number of staged equipment operation such as coil or pump

    writeLevel

Current priority level for writeVal as number between 1 and 17

    yearBuilt

Original year of construction as four digit year such as 1980

maxVal

Inclusive maximum for a numeric value

minVal

Inclusive minimum for a numeric value

mqttQos

MQTT Quality of Service (QoS)

  • 0 - At most once (fire-and-forget)
  • 1 - At least once
  • 2 - Exactly once