Commit 29b1207c authored by Claes Sjofors's avatar Claes Sjofors

Documentation of new script functions

parent e5fb3375
......@@ -10100,8 +10100,10 @@ SetSubwindow() <LINK> setsubwindow()
GetIoDeviceData() <LINK> getiodevicedata()
SetIoDeviceData() <LINK> setiodevicedata()
GetVersion() <LINK> getversion()
pwr_get_config() <LINK> pwr_get_config()
get_pwr_config() <LINK> get_pwr_config()
get_node_name() <LINK> get_node_name()
EVEN() <LINK> EVEN()
ODD() <LINK> ODD()
<h2>wtt-commands
wtt-commands <LINK> wtt-commands
......@@ -11688,7 +11690,7 @@ string <t>connectobject <t>Name of object or attribute to connect to.
SetPlcObjectAttr()
int SetPlcObjectAttr( string attribute, (arbitrary type) value)
xxx
<b>Description
Set a value in a plc object.
......@@ -11738,8 +11740,10 @@ SetSubwindow() <t>Open a graph in a window object. <LINK> setsubwindow()
GetIoDeviceData() <t>Get data from IO configuration. <LINK> getiodevicedata()
SetIoDeviceData() <t>Set data in IO configuration. <LINK> setiodevicedata()
GetVersion() <t>Get Proview version. <LINK> getversion()
pwr_get_config() <t>Get configuration values. <LINK> pwr_get_config()
get_pwr_config() <t>Get configuration values. <LINK> get_pwr_config()
get_node_name() <t>Get node name. <LINK> get_node_name()
EVEN() <t>Check if value is even. <LINK> EVEN()
ODD() <t>Check if value is odd. <LINK> ODD()
</TOPIC>
<headerlevel>
......@@ -12190,6 +12194,73 @@ For example V5.3.1 returns 50301.
<c> ...
<c> endif
</TOPIC>
<TOPIC> get_pwr_config() <style> function
get_pwr_config()
string get_pwr_config( string name)
<b>Description
Get the value of a configuration variable.
Configuration values are set in /etc/proview.cnf.
Returns the value of the configuration variable.
<b>Example
<c> group = get_pwr_config( "defaultSystemGroup");
</TOPIC>
<TOPIC> get_node_name() <style> function
get_node_name()
string get_node_name()
<b>Description
Get the host name for the current node.
Returns the host name.
<b>Example
<c> name = get_node_name();
</TOPIC>
<TOPIC> EVEN() <style> function
EVEN()
int EVEN( int sts)
<b>Description
Check is an integer is even.
Returns 1 if even and 0 if odd.
<b>Example
<c> sts = SetAttribute( "Pump-V1-Switch.Description", "Valve switch open");
<c> if ( EVEN(sts))
<c> printf("Couldn't set attribute\n");
<c> endif
</TOPIC>
<TOPIC> ODD() <style> function
ODD()
int ODD( int sts)
<b>Description
Check is an integer is odd.
Returns 1 if odd and 0 if even.
<b>Example
<c> sts = SetAttribute( "Pump-V1-Switch.Description", "Valve switch open");
<c> if ( ODD(sts))
<c> printf("Set operation successful\n");
<c> endif
</TOPIC>
</headerlevel>
<TOPIC> wtt-commands <style> function
......
This diff is collapsed.
......@@ -2801,8 +2801,10 @@ MessageError() <LINK> messageerror()
MessageInfo() <LINK> messageinfo()
GetCurrentText() <LINK> getcurrenttext()
GetCurrentObject() <LINK> getcurrentobject()
pwr_get_config() <LINK> pwr_get_config()
get_pwr_config() <LINK> get_pwr_config()
get_node_name() <LINK> get_node_name()
EVEN() <LINK> EVEN()
ODD() <LINK> ODD()
get_language() <LINK> get_language()
GetUser() <LINK> getuser()
GetPrivileges() <LINK> getprivileges()
......@@ -4021,8 +4023,10 @@ MessageError() <t>Print error message. <LINK> messageerror()
MessageInfo() <t>Print info message. <LINK> messageinfo()
GetCurrentText() <t>Get selected text. <LINK> getcurrenttext()
GetCurrentObject() <t>Get selected object. <LINK> getcurrentobject()
pwr_get_config() <t>Get configuration values <LINK> pwr_get_config()
get_pwr_config() <t>Get configuration values <LINK> get_pwr_config()
get_node_name() <t>Get node name <LINK> get_node_name()
EVEN() <t>Check if value is even. <LINK> EVEN()
ODD() <t>Check if value is odd. <LINK> ODD()
get_language() <t>Get the current language <LINK> get_language()
GetUser() <t>Get the current user. <LINK> getuser()
GetPrivileges() <t>Get the privileges for the current user. <LINK> getprivileges()
......@@ -4140,6 +4144,74 @@ If no object is associated, a null-string i returned.
<c> object = GetCurrentObject();
</TOPIC>
<TOPIC> get_pwr_config() <style> function
get_pwr_config()
string get_pwr_config( string name)
<b>Description
Get the value of a configuration variable.
Configuration values are set in /etc/proview.cnf.
Returns the value of the configuration variable.
<b>Example
<c> string id;
<c>
<c> id = get_pwr_config( "qcomBusId");
</TOPIC>
<TOPIC> get_node_name() <style> function
get_node_name()
string get_node_name()
<b>Description
Get the host name for the current node.
Returns the host name.
<b>Example
<c> name = get_node_name();
</TOPIC>
<TOPIC> EVEN() <style> function
EVEN()
int EVEN( int sts)
<b>Description
Check is an integer is even.
Returns 1 if even and 0 if odd.
<b>Example
<c> sts = SetAttribute( "Pump-V1-Switch.Description", "Valve switch open");
<c> if ( EVEN(sts))
<c> printf("Couldn't set attribute\n");
<c> endif
</TOPIC>
<TOPIC> ODD() <style> function
ODD()
int ODD( int sts)
<b>Description
Check is an integer is odd.
Returns 1 if odd and 0 if even.
<b>Example
<c> sts = SetAttribute( "Pump-V1-Switch.Description", "Valve switch open");
<c> if ( ODD(sts))
<c> printf("Set operation successful\n");
<c> endif
</TOPIC>
<TOPIC> get_language() <style> function
get_language()
......
......@@ -9965,8 +9965,11 @@ CloseGraph() <LINK> closegraph()
SetSubwindow() <LINK> setsubwindow()
GetIoDeviceData() <LINK> getiodevicedata()
SetIoDeviceData() <LINK> setiodevicedata()
pwr_get_config() <LINK> pwr_get_config()
GetVersion() <LINK> getversion()
get_pwr_config() <LINK> get_pwr_config()
get_node_name() <LINK> get_node_name()
EVEN() <LINK> EVEN()
ODD() <LINK> ODD()
<h2>wtt-kommandon
wtt-kommandon <LINK> wtt-commands
......@@ -11596,8 +11599,11 @@ CloseGraph() <LINK> closegraph()
SetSubwindow() <LINK> setsubwindow()
GetIoDeviceData() <LINK> getiodevicedata()
SetIoDeviceData() <LINK> setiodevicedata()
pwr_get_config() <LINK> pwr_get_config()
GetVersion() <LINK> getversion()
get_pwr_config() <LINK> get_pwr_config()
get_node_name() <LINK> get_node_name()
EVEN() <LINK> EVEN()
ODD() <LINK> ODD()
</TOPIC>
<headerlevel>
......@@ -12028,6 +12034,92 @@ string <t>value <t>V
<c> sts = SetIoDeviceData( "Nodes-MyNode-PN-D1", "NetworkSettings-DeviceName", "ET200M-D1");
</TOPIC>
<TOPIC> getversion() <style> function
GetVersion()
int GetVersion()
<b>Beskrivning
Hämta Proview-versionen för aktuell utgåva.
Returnerar ett heltalsvärde som är 10000 * major + 100 * minor + release.
T ex V5.3.1 returnerar 50301.
<b>Exempel
<c> if ( GetVersion() > 50300)
<c> # Only for versions larger than V5.3.0
<c> ...
<c> endif
</TOPIC>
<TOPIC> get_pwr_config() <style> function
get_pwr_config()
string get_pwr_config( string name)
<b>Beskivning
Hämta värdet för en Proview konfigureringsvariabel.
Konfigureringsvariabler sätts i /etc/proview.cnf.
Returnerar värdet på konfigureringsvariablen.
<b>Exempel
<c> group = get_pwr_config( "defaultSystemGroup");
</TOPIC>
<TOPIC> get_node_name() <style> function
get_node_name()
string get_node_name()
<b>Beskrivning
Hämta nodnamnet för aktuell nod.
Returnerar nodnamnet.
<b>Exempel
<c> name = get_node_name();
</TOPIC>
<TOPIC> EVEN() <style> function
EVEN()
int EVEN( int sts)
<b>Beskrivning
Testa om ett heltal är jämnt.
Returnerar 1 om talet är jämnt, 0 om talet är udda.
<b>Exempel
<c> sts = SetAttribute( "Pump-V1-Switch.Description", "Valve switch open");
<c> if ( EVEN(sts))
<c> printf("Couldn't set attribute\n");
<c> endif
</TOPIC>
<TOPIC> ODD() <style> function
ODD()
int ODD( int sts)
<b>Description
Testa om ett heltal är udda.
Returnerar 1 om heltalet är udda, 0 om det är jämnt.
<b>Exempel
<c> sts = SetAttribute( "Pump-V1-Switch.Description", "Valve switch open");
<c> if ( ODD(sts))
<c> printf("Set operation successful\n");
<c> endif
</TOPIC>
</headerlevel>
......@@ -12036,7 +12128,7 @@ Wtt kommandon
Alla wtt kommandon finns tillgängliga i script koden. En wtt-kommando rad
ska INTE avslutas med semikolon. Variabler kan substitueras i kommandot
genom add omges av apostrofer.
genom att omges av apostrofer.
<b>Exempel
......
This diff is collapsed.
......@@ -2574,8 +2574,10 @@ MessageError() <LINK> messageerror()
MessageInfo() <LINK> messageinfo()
GetCurrentText() <LINK> getcurrenttext()
GetCurrentObject() <LINK> getcurrentobject()
pwr_get_config() <LINK> pwr_get_config()
get_pwr_config() <LINK> get_pwr_config()
get_node_name() <LINK> get_node_name()
EVEN() <LINK> EVEN()
ODD() <LINK> ODD()
get_language() <LINK> get_language()
GetUser() <LINK> getuser()
GetPrivileges() <LINK> getprivileges()
......@@ -3784,8 +3786,10 @@ MessageError() <t>Skriv ett felmeddelande. <LINK> messageerror()
MessageInfo() <t>Skriv ett informationsmeddelande. <LINK> messageinfo()
GetCurrentText() <t>Hämta text för utvalt alternativ. <LINK> getcurrenttext()
GetCurrentObject() <t>Hämta utvalt objekt. <LINK> getcurrentobject()
pwr_get_config() <t>Hämta konfigurations-värden <LINK> pwr_get_config()
get_pwr_config() <t>Hämta konfigurations-värden <LINK> get_pwr_config()
get_node_name() <t>Hämta nodnamn <LINK> get_node_name()
EVEN() <t>Testa om ett värde är jämnt. <LINK> EVEN()
ODD() <t>Testa om ett värde är udda. <LINK> ODD()
get_language() <t>Hämta nuvarande språk <LINK> get_language()
GetUser() <t>Hämta nuvarande användare. <LINK> getuser()
GetPrivileges() <t>Hämta privilegier för nuvarande användare. <LINK> getprivileges()
......@@ -3904,6 +3908,74 @@ returneras en null-str
<c> object = GetCurrentObject();
</TOPIC>
<TOPIC> get_pwr_config() <style> function
get_pwr_config()
string get_pwr_config( string name)
<b>Beskivning
Hämta värdet för en Proview konfigureringsvariabel.
Konfigureringsvariabler sätts i /etc/proview.cnf.
Returnerar värdet på konfigureringsvariablen.
<b>Exempel
<c> string id;
<c>
<c> id = get_pwr_config( "qcomBusId");
</TOPIC>
<TOPIC> get_node_name() <style> function
get_node_name()
string get_node_name()
<b>Beskrivning
Hämta nodnamnet för aktuell nod.
Returnerar nodnamnet.
<b>Exempel
<c> name = get_node_name();
</TOPIC>
<TOPIC> EVEN() <style> function
EVEN()
int EVEN( int sts)
<b>Beskrivning
Testa om ett heltal är jämnt.
Returnerar 1 om talet är jämnt, 0 om talet är udda.
<b>Exempel
<c> sts = SetAttribute( "Pump-V1-Switch.Description", "Valve switch open");
<c> if ( EVEN(sts))
<c> printf("Couldn't set attribute\n");
<c> endif
</TOPIC>
<TOPIC> ODD() <style> function
ODD()
int ODD( int sts)
<b>Description
Testa om ett heltal är udda.
Returnerar 1 om heltalet är udda, 0 om det är jämnt.
<b>Exempel
<c> sts = SetAttribute( "Pump-V1-Switch.Description", "Valve switch open");
<c> if ( ODD(sts))
<c> printf("Set operation successful\n");
<c> endif
</TOPIC>
<TOPIC> get_language() <style> function
get_language()
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment