def
str
Unicode string of characters. See Kinds chapter.
meta
supertypes
subtypes
connErr |
Error message associated when |
---|---|
connState |
Current connection state of a connector as one of the predefined strings |
connStatus |
Current status of a connector as one of the predefined strings See Connectors |
curErr |
Error description when |
curStatus |
Status of point's current value reading |
dis |
Display name for an entity |
disKey |
Localized string key formatted as |
disMacro |
Display name using macro syntax |
doc |
Documentation in simplified flavor of markdown |
dockerState |
Current status of a Docker container |
dockerStatus |
Additional human-readable status of the container |
ecobeeCur |
Ecobee address to use to get the current value |
ecobeeHis |
Ecobee address to use to sync point history |
ecobeeWrite |
Ecobee address to use to write a point value |
elecLine |
Single-phase line measurement of an electric quantity in an AC electric power system |
lineCurrent |
Single-phase line current measured in an AC electric power system |
phaseEnergy |
Single-phase energy measured line-to-neutral in an AC electric power system |
phasePf |
Single-phase power factor measured line-to-neutral in an AC electric power system |
phasePower |
Single-phase power measured line-to-neutral in an AC electric power system |
elecLineToLine |
Single-phase electric quantity measured line-to-line in an AC electric power system |
lineEnergy |
Single-phase energy measured line-to-line in an AC electric power system |
linePf |
Single-phase power factor measured line-to-line in an AC electric power system |
linePower |
Single-phase power measured line-to-line in an AC electric power system |
lineVolt |
Single-phase voltage measured line-to-line in an AC electric power system |
phaseCurrent |
Single-phase current measured line-to-line in an AC electric power system |
elecLineToNeutral |
Single-phase electric quantity measured line-to-neutral in an AC electric power system |
phaseVolt |
Single-phase voltage measured line-to-neutral in an AC electric power system |
errTrace |
Exception stack trace |
expr |
Axon expression string |
taskExpr |
Task messaging handling Axon expression |
fileExt |
Filename extension such as "csv" |
filterStr |
Haystack filter string |
obsFilter |
Filter string to define the record data set observed |
flags |
Flags string |
foldOn |
Registers a function as folding a given value type |
geoAddr |
Free form street address |
geoCity |
Geographic city or locality name |
geoCountry |
Geographic country as ISO 3166-1 two letter code |
geoCounty |
Geographic subdivision of US state |
geoPostalCode |
Geographic postal code |
geoState |
State or province name |
geoStreet |
Geographic street address and name |
haystackCur |
Used on a haystack proxy point to store the id of the entity in the remote system used to read and watch |
haystackHis |
Used on a haystack proxy point object to store the id of the historized point in the remote system used to sync history data |
haystackWrite |
Used on a haystack proxy point to store the id of the entity in the remote system used to write |
hisErr |
Error description when |
hisMode |
Indicates the way that history data is collected for a point |
hisStatus |
Status of point's history collection or synchronization |
kind |
Kind name used to identity a value data type |
mime |
Mime type formatted as type/subtype |
modbusCur |
Modbus address to use for current value subscriptions |
modbusWrite |
Used on a modbus proxy point to store the id of the entity in the remote system used to write |
mqttCertAlias |
Used on an |
mqttClientId |
The client identifier to use when connecting to the broker |
mqttVersion |
MQTT protocol version |
name |
Name key |
nestCur |
Nest address to use to get the current value |
nestProjectId |
The project identifier from your Google Device Access project |
nestWrite |
Nest address to use to write a point value |
obsMqttTopic |
Receive published messages that match this filter |
obsScheduleDaysOfMonth |
Schedule events for given days of the month |
obsScheduleDaysOfWeek |
Schedule events for given days of the week |
password |
Manages password which is hashed/stored to the password store |
ecobeeClientId |
Your Ecobee API Key |
ecobeeRefreshToken |
The refresh token you obtained for your API key |
nestClientId |
The OAuth client_id for your application |
nestClientSecret |
The OAuth client_secret for your application |
nestRefreshToken |
The OAuth refresh_token for your application |
phase |
Phase measurement in a three-phase electrical system |
pointConvert |
Point value conversion used to normalize data to/from a remote system |
curConvert |
Conversion to apply when reading curVal from connector |
hisConvert |
Conversion to apply when reading history data from connector |
writeConvert |
Conversion to apply when writing writeVal to the connector |
primaryFunction |
Primary function of building as US Energy Star key |
reader |
Fantom type qname for reader class |
sedonaCur |
Sedona address to use for current value subscritions |
sedonaWrite |
Sedona address to use for writing |
sqlHis |
Arbitrary key used by the SQL connector to synchronized history data |
sqlSyncHisExpr |
This is a tag which must be configured on each |
src |
Source code |
taskStatus |
Current status of a task |
typeName |
Fantom type qname |
tz |
Timezone identifier from standard timezone database |
unit |
Unit identifier from standard unit database |
username |
Username for an authentication account |
version |
Version string formatted as decimal integers separated by a dot |
writeErr |
Error description when |
writeStatus |
Current status of a writable point output |
writer |
Fantom type qname for writer class |