Attending Haystack Connect 2019?Drop by our exhibition stand and say hello!

bfitDesigoExt

Connector for Siemens Desigo API
bfitDesigoExtAxon funcs

Registered StackHub users may elect to receive email notifications whenever a new package version is released or a comment is posted on the forum.

v1.5.6

bfitDesigoExport
bfitDesigoExport(connRec, entryPoint, filename)

This function takes the Desigo connector and a filename URI and creates a CSV file with information helpful for automatic point creation. Entry point can be null to gather everything. Otherwise, it is a string containing the learn path obtained from either the bfitDesigoLearn function or the Connector hierarchy explorer in the Builder view. This process is recursive and as a result the progress percentage cannot be calculated. The progress message will indicate which node is currently being traversed. Long running function. Run in jobs.

Params

  • connRec: The connector record that points to the Desigo WSI where the points are housed
  • entryPoint: The learn path as a string obtained from calls to bfitDesigoLearn or null to start at the root.
  • filename: The URI to write the output csv to.

Return

A grid of discovered points.

Example

  • read(bfitDesigoConn).bfitDesigoExport(null, \`io/export_output.csv\`)
  • read(bfitDesigoConn).bfitDesigoExport("api/systembrowser/1/9/JMS_Desigo.ManagementView", \`io/export_output.csv\`)
Fantom signature:
@Axon const static Grid? bfitDesigoExport(Dict connRec, Str? entryPoint, Uri filename)
bfitDesigoLearn
bfitDesigoLearn(conn, arg)

Gather the nodes list of the selected point. For system nodes, pass null to arg. Otherwise pass the learn address returned from a previous level.

Params

  • conn: The connector record that points to the Desigo WSI where the points are housed
  • arg: The learn path as a string obtained from previous calls to bfitDesigoLearn or null to start at the root.

Return

A grid of children found below the arg node with associated parameters, if any.

Example

  • read(bfitDesigoConn).bfitDesigoLearn(null)
  • read(bfitDesigoConn).bfitDesigoLearn("api/systembrowser/1/9/JMS_Desigo.ManagementView")
Fantom signature:
@Axon const static Grid? bfitDesigoLearn(Obj conn, Obj? arg)
bfitDesigoPing
bfitDesigoPing(connRec)

Pings the API address. This is a global ping to ensure that the API is receiving and processing requests.

Params

  • connRec: The connector record that points to the Desigo WSI where the points are housed

Return

1 on a successful ping, -1 otherwise.

Example

  • readAll(bfitDesigoConn).bfitDesigoPing()
Fantom signature:
@Axon const static Number? bfitDesigoPing(Dict connRec)
bfitDesigoSyncCur
bfitDesigoSyncCur(points)

Sync the cur value of the points using the bfitDesigoCur ID.

Params

  • points: Any number of point records that contain valid bfitDesigoConnRef and BfitDesigoCur tags

Return

None

Example

  • read(point and bfitDesigoCur).bfitDesigoSyncCur()
Fantom signature:
@Axon const static Void bfitDesigoSyncCur(Obj points)
bfitDesigoSyncHis
bfitDesigoSyncHis(points, dates: null)

Sync the history data of a point from the trendlog. Requires bfitDesigoHis ID.

Params

  • points: Any number of point records that contain valid bfitDesigoConnRef and BfitDesigoHis tags
  • dates: A DateSpan for the desired period of time to sync. Calling this function without passing a span will sync from the current date to the hisEnd on the point record. If no hisEnd exists, it will sync from the current date to one month previous.

Return

The number of points that were updated. One row for each history in the order that they were passed to the function.

Example

  • readAll(point and bfitDesigoHis).bfitDesigoSyncHis(pastWeek())
  • readAll(point and bfitDesigoHis).bfitDesigoSyncHis()
Fantom signature:
@Axon const static Obj? bfitDesigoSyncHis(Obj points, Obj? dates := null)
bfitDesigoTrendseriesInfo
bfitDesigoTrendseriesInfo(connRec, systemId)

Gets the table of objectId to trendseriesId mappings. The systemId variable takes the id number of the system node.

SystemIds can be seen in the Connectors page in Builder as well as by running the following command in folio: read(bfitDesigoConn).bfitDesigoLearn(null)

Params

  • connRec: The connector record that points to the Desigo WSI where the points are housed
  • systemId: The SystemId value as a number. Most easily found by running: read(bfitDesigoConn).bfitDesigoLearn(null)

Return

A grid of all the objectIds with their associated trendseriesId. The objectId will match the bfitDesigoCur tag.

Example

  • read(bfitDesigoConn).bfitDesigoTrendseriesInfo(1)
Fantom signature:
@Axon const static Grid? bfitDesigoTrendseriesInfo(Dict connRec, Number systemId)
Published by BuildingFit

Products & Services by BuildingFit

Packages by BuildingFit

Commercial packages

Free packages