外观
lib-trend 库参考
原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793620026/FIN+5.3.1+lib-trend 中文整理基于 FIN 5.3.1
导读: 本页为
lib-trend的 API / 标签 / 函数参考文档。
以下为 API 参考,保留英文以便对照源码;目录已列出(英文标题便于检索);概述已尽量中译。
目录(导读)
- lib
- meta
- tags
- funcs
- def
- finFormTrendConnDiscoverSettings(settings: null)
- trendDiscover()
- trendLearn(conn, arg: null)
- trendPing(conn)
- trendSyncHis(points, dates)
概述(中译)
趋势连接器
API 正文(英文)
tags
| tplTrendConn | TplTrend connector |
| tplTrendConnRef | Used on a proxy point to reference its parent tplTrendConn |
| tplTrendCur | TplTrend address to use for reading the current value |
| tplTrendHis | TplTrend address to use for reading historical data |
| tplTrendPoint | Point which synchronizes data via the TplTrend connector |
funcs
| finFormTrendConnDiscoverSettings | |
| trendDiscover | |
| trendLearn | Learn - discover points on a device |
| trendPing | Ping |
| trendSyncHis |
def
func:finFormTrendConnDiscoverSettings
finFormTrendConnDiscoverSettings(settings: null)
meta
| admin | ✓ |
| def | func:finFormTrendConnDiscoverSettings |
| is | func |
| lib | lib:trend |
| name | finFormTrendConnDiscoverSettings |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:trendDiscover
trendDiscover()
meta
| def | func:trendDiscover |
| is | func |
| lib | lib:trend |
| name | trendDiscover |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:trendLearn
trendLearn(conn, arg: null)
Learn - discover points on a device
meta
| def | func:trendLearn |
| is | func |
| lib | lib:trend |
| name | trendLearn |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:trendPing
trendPing(conn)
Ping
meta
| def | func:trendPing |
| is | func |
| lib | lib:trend |
| name | trendPing |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:trendSyncHis
trendSyncHis(points, dates)
meta
| def | func:trendSyncHis |
| is | func |
| lib | lib:trend |
| name | trendSyncHis |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
tplTrendConn
TplTrend connector.
meta
| def | tplTrendConn |
| is | conn |
| lib | lib:trend |
usage
| tplTrendConn conn |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| conn | Connector for communication to a remote system |
tags
| actorTimeout | Timeout for messages send to the connector's actor thread |
| connErr | Error message associated when connStatus indicates an error condition |
| 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 |
| 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 |
| connTuningRef | Reference to a tuning configuration defined by a connTuning rec |
| dis | Display name for an entity |
| disabled | Indicates the entity is in a disabled state |
| id | Defines the unique identifier of an entity in system using a ref value type |
| password | Manages password which is hashed/stored to the password store |
| uri | Universal resource identifier |
| username | Username for an authentication account |
def
tplTrendConnRef
Used on a proxy point to reference its parent tplTrendConn
meta
| def | tplTrendConnRef |
| is | ref |
| lib | lib:trend |
| of | tplTrendConn |
| tagOn | tplTrendPoint |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
tplTrendCur
TplTrend address to use for reading the current value.
meta
| def | tplTrendCur |
| is | str |
| lib | lib:trend |
| tagOn | tplTrendPoint |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
tplTrendHis
TplTrend address to use for reading historical data.
meta
| def | tplTrendHis |
| is | str |
| lib | lib:trend |
| tagOn | tplTrendPoint |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
tplTrendPoint
Point which synchronizes data via the TplTrend connector.
meta
| def | tplTrendPoint |
| is | connPoint |
| lib | lib:trend |
usage
| tplTrendPoint 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 |
| connPoint | Point associated with a connector for data synchronization with a remote system |
tags
| connTuningRef | Reference to a tuning configuration defined by a connTuning rec |
| cur | Supports current value |
| curCalibration | Calibration value to apply to adjust the value read from the connector before updating curVal |
| curConvert | Conversion to apply when reading curVal from connector |
| 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 |
| ghgFactorHis | Identifies point record with interval emission factor data that the Greenhouse Gas Emission Engine uses to calculate emissions |
| his | Supports historization of data |
| hisConvert | Conversion to apply when reading history data from connector |
| 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 |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| 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 |
| tplTrendConnRef | Used on a proxy point to reference its parent tplTrendConn |
| tplTrendCur | TplTrend address to use for reading the current value |
| tplTrendHis | TplTrend address to use for reading historical data |
| tz | Timezone identifier from standard timezone database |
| unit | Unit identifier from standard unit database |
| writable | Supports writing data |
| writeConvert | Conversion to apply when writing writeVal to the connector |