AX/N4 BFormat

Erstellt von support alvasys, Geändert am Di, 13 Mai um 4:55 NACHMITTAGS von support alvasys

Anleitung

Niagara AX/N4 BFormat

Vertraulichkeitshinweis

Die Informationen in diesem Dokument sind vertrauliche Informationen der alvasys automation ag ("alvasys"). Solche Informationen und die hier beschriebene Software werden unter Lizenzvereinbarung bereitgestellt und dürfen nur gemäss dieser Vereinbarung verwendet werden. Die in diesem Dokument enthaltenen Informationen werden ausschliesslich für den Gebrauch durch Mitarbeiter, Lizenznehmer und Systembesitzer von ALVASYS bereitgestellt. Der Inhalt dieses Dokuments darf nicht an andere weitergegeben oder für andere vervielfältigt werden. Obwohl alle Anstrengungen unternommen wurden, um die Richtigkeit dieses Dokuments zu gewährleisten, ist ALVASYS nicht verantwortlich für Schäden jeglicher Art, einschliesslich Folgeschäden, die aus der Anwendung der hier enthaltenen Informationen resultieren. Informationen und Spezifikationen, die hier veröffentlicht werden, sind zum Zeitpunkt dieser Veröffentlichung aktuell und können ohne vorherige Ankündigung geändert werden. Dieses Dokument darf von Parteien, die autorisiert sind, ALVASYS-Produkte im Zusammenhang mit der Verteilung dieser Produkte zu verteilen, kopiert werden, unter der Bedingung, dass dies durch die Verträge autorisiert ist, die eine solche Verteilung ermöglichen. Es darf anderweitig, ganz oder teilweise, nicht kopiert, fotokopiert, reproduziert, übersetzt oder in irgendeiner elektronischen Form oder maschinenlesbaren Form reduziert werden, ohne vorherige schriftliche Zustimmung von ALVASYS.

Beschreibung

Niagara bietet zur Visualisierung der Datenpunkte verschieden Arten an.

Dieses nennen sich BFormat. Hier eine Auflistung von den gängigsten.

Anforderungen

Niagara AX / N4

BFormat	Text	Description
%.%	2,0°C {überschrieben, unbestätigter Alarm} @ 1	Value + Status of the Out slot
%out.value%	2,0°C	Value of the Out slot
%out.status%	{überschrieben, unbestätigter Alarm} @ 1	Status of the Out slot
%status.flagsToString%	überschrieben, unbestätigter Alarm	String value(s) for status flags set, without braces. If non: “ok”.
%fallback.value%	2,0°C	Value of the fallback slot
%in10%	23°C	Value + Status of the In10 slot
%activeLevel%	1	Number only (1-16, def)
%displayName%	Temperaturä	Display Name of the component
%parent.displayName%	BFormat1	Display Name of the parent component (1 level up)
%displayName.substring(4)%	erature	Display Name of the component showing only the part from the first to the third character
%displayName.substring(-4)%	turä	Display Name of the component showing only the end part from the second-last character
%displayName.substring(2,6)%	mper	Display Name of the component showing from the first to the end part from the second-last character
%displayName.escape()%	Temperatur$e4	Transforms special characters into their encoded values
%displayName.unescape()%	Temperaturä	Transforms special characters from their encoded values
%name%	Temp	Name of the component
%parent.name%	BFormat1	Name of the parent component (1 level up)
%parent.parent.name%	Config	Name of the parent of the parent component (2 levels up)
%facets%	°C	Facets
%facets.units%	Units= °C,precision=1	Facets Units
%Hours%	0	Get the total elapsed time in hours
%Minutes%	0	Get the total elapsed time in minutes
%time()%	13.Mai 2025 16.29 MESZ	Returns the current time
%out.prevDay%	12.Mai 2025 16.29 MESZ	Kit Control Current Timer
%out.prevMonth%	13.April 2025 16.29 MESZ	Kit Control Current Timer
%out.prevYear%	13.Mai 2024 16.29 MESZ	Kit Control Current Timer
%out.Hour%	16	Kit Control Current Timer
%out.Minute%	29
%out.Day%	13
%out.Month%	Mai
time().toDateString%	13.Mai 2025
%user()%	admin	Returns the username of the user logged in
%slotPath%	Slot:/Bformat1/Temp	Pfad
%parent.proxyExt.device.name%		Name of the device in which a proxy point resides (no matter how many levels above the point)
%parent.proxyExt.network.name%		Name of the network in which a proxy point resides (no matter how many levels above the point)
%proxyExt.topic%		On an MQTT point, returns the "topic" text
%changeOfStateCount%
%status.flagsToString%
%lexicon(module:key)%		Retrieves the translation key
%alarmData.sourceName%		(to use on Alarm Extension Text) Returns the "Source Name" within the Fault, Offnormal or Normal text of an alarm
%alarmData.alarmValue%		Returns the "Value" within the Fault, Offnormal or Normal text of an alarm
%alarmData.highLimit%		(to use on Alarm Extension Text) Returns the "High Limit" within the Fault, Offnormal or Normal text of an alarm
%alarmData.lowLimit%		(to use on Alarm Extension Text) Returns the "Low Limit" within the Fault, Offnormal or Normal text of an alarm
%alarmData.timestamp%		Zeigt den Zeitstempel des Alarms an
%alarmData.msgText%		Sends the alarm message to print on the sixth line.
%alarmClass%		Sends the alarm class to print on the fifth line.
%priority%		Sends the alarm priority to print on the fourth line.
%sourceState% / %ackState%		Sends the alarm state and the acknowledged state to print on the third line.

The %out.value% BFormat gets the "value" of the "out" slot of a component, but you can use this format for any other slot/property.

Example:

You could check the "value" of slot "in10" for example on a Boolean Writable component using %in10.value%.

Always check the correct name of the slot using the Slot Sheet view, on the column "Name":

Static text can be used together with BFormat strings. All the static text is placed outside % signs.

Example:

Value = %out.value% is my value

Assuming the "out" slot value of the component is 22.3 °C, the returned text is going to be:

Value = 22.3 °C is my value

Multiple BFormat can be used in the same text

Example 1:

%parent.name% - %name% - %out.value%

Will show the slot name of the component 1 level up, followed by the fixed text " - ", the name of the component, followed again by the fixed text " - " and then the value of the "out" slot.

Like Points - WSupplyTemp - 59.5 °C

Example 2:

%displayName.substring(0,3)% %displayName.substring(-2)%

Will show the Display Name of a component named "AHU_01" as "AHU 01" (a space instead of the underscore)

In alarm text boxes, this can be useful to provide additional information about an alarm

Example:

%alarmData.sourceName% > %alarmData.highLimit%!

Would return something like Hot Water Temp > 60 °C!