Commit be38892f authored by Claes Sjofors's avatar Claes Sjofors

Doc modifications

parent 33ff3cf8
...@@ -1789,6 +1789,41 @@ set the attribute ScanOff to 0. Observe that there might be subwindows in this p ...@@ -1789,6 +1789,41 @@ set the attribute ScanOff to 0. Observe that there might be subwindows in this p
that also need to be turned on. that also need to be turned on.
</topic> </topic>
<topic> file_proview_cnf
/etc/proview.cnf
A configuration file for definition of various parameters both in developmen, runtime and
storage environment. In the development environment the definitions are valid for all projects
on the station.
<b>Parameters in the development environment
mysqlSocket <t><t>mysql socket for volumes with mysql database. Default value
<t><t>"/var/run/mysqld/mysqld.sock".
mysqlServer <t><t>mysql server node.
defaultProjectRoot <t><t>The default path to projects when creating new projects.
<t><t>Default value "/usr/local/pwrp".
defaultProductionBus <t><t>The default production bus when creating new projects.
<t><t>Default value 1.
defaultSimulationBus <t><t>The default simulation bus when creating new projects.
<t><t>Default value 999.
defaultSystemGroup <t><t>The default system group when creating new projects.
<t><t>Default value "Common".
defaultNodeHierRoot <t><t>Default name of the top level object in the node hierarchy when
<t><t>creating new projects. Default value "Nodes".
qcomBusId <t><t>QCom bus identity for simulation.
<b>Parameters in the runtime environment
qcomBusId <t><t>QCom bus identity.
curveExportFile <t><t>Default file name for the history curve export function.
webDirectory <t><t>Directory where the web files are placed and accessed by the web server.
<b>Parameters in the storage environment
sevDatabaseType <t><t>Database type, mysql or sqlite.
sevXttDefaultPriv <t><t>Default privileges for access of the sev databse from sev_xtt.
sevMysqlEngine <t><t>Mysql engine for created tables, innodb or myisam.
</topic>
</headerlevel> </headerlevel>
......
...@@ -1532,6 +1532,7 @@ collect open<t>Open a stored collect window <LINK> collect open ...@@ -1532,6 +1532,7 @@ collect open<t>Open a stored collect window <LINK> collect open
close alarmlist <t>Close alarmlist <LINK> close alarmlist close alarmlist <t>Close alarmlist <LINK> close alarmlist
close eventlist <t>Close eventlist <LINK> close eventlist close eventlist <t>Close eventlist <LINK> close eventlist
close graph <t>Close a graph <LINK> close graph close graph <t>Close a graph <LINK> close graph
close multiview <t>Close a multiview <LINK> close multiview
close navigator <t>Close the navigator <LINK> close navigator close navigator <t>Close the navigator <LINK> close navigator
create item <t>Create a menu item in the Xtt menu <LINK> create item create item <t>Create a menu item in the Xtt menu <LINK> create item
create opmenuitem <t>Create a menu item in the operator window menu <LINK> create opmenuitem create opmenuitem <t>Create a menu item in the operator window menu <LINK> create opmenuitem
...@@ -1545,14 +1546,7 @@ help <t>Display help <LINK> help ...@@ -1545,14 +1546,7 @@ help <t>Display help <LINK> help
login <t>User login <LINK> login login <t>User login <LINK> login
logout <t>User logout <LINK> logout logout <t>User logout <LINK> logout
logging <t>Logg attributes to file <LINK> logging logging <t>Logg attributes to file <LINK> logging
open fileview <t>Open a fileview <LINK> open fileview open <t>Open various windows <LINK> open
open graph <t>Open a graph <LINK> open graph
open multiview <t>Open a multiview <LINK> open multiview
open jgraph <t>Open a java graph <LINK> open jgraph
open navigator <t>Open the navigator <LINK> open navigator
open operatorwindow<t>Open the operator window <LINK> open operatorwindow
open trace <t>Open trace for a plc window <LINK> open trace
open trend <t>Open DsTrend or PlotGroup graph <LINK> open trend
read object <t>Read the content of an object from file <LINK> read object read object <t>Read the content of an object from file <LINK> read object
search <t>Search for an object or a string <LINK> search search <t>Search for an object or a string <LINK> search
set advanceduser<t>Set advanced user <LINK> set advanceduser set advanceduser<t>Set advanced user <LINK> set advanceduser
...@@ -2038,6 +2032,28 @@ Logout a user, and return to the original user. ...@@ -2038,6 +2032,28 @@ Logout a user, and return to the original user.
login <LINK> login login <LINK> login
</TOPIC> </TOPIC>
<TOPIC> open <style> function
Command open
Open various windows.
open attribute <t>Open a value change dialog for an attribute <LINK> open attribute
open consolelog <t>Display system messages <LINK> open consolelog
open fast <t>Open fast curve <LINK> open fast
open fileview <t>Open a fileview <LINK> open fileview
open graph <t>Open a graph <LINK> open graph
open history <t>Open process history curve <LINK> open history
open multiview <t>Open a multiview <LINK> open multiview
open jgraph <t>Open a java graph <LINK> open jgraph
open navigator <t>Open the navigator <LINK> open navigator
open operatorwindow<t>Open the operator window <LINK> open operatorwindow
open shistory <t>Open a list with all history curves for an object <LINK>open shistory
open trace <t>Open trace for a plc window <LINK> open trace
open trend <t>Open DsTrend or PlotGroup graph <LINK> open trend
open tcurve <t>Open a trend snapshot <LINK> open tcurve
open url <t>Open an URL in a web browser <LINK> open url
</TOPIC>
<TOPIC> open graph <style> function <TOPIC> open graph <style> function
Command open graph Command open graph
...@@ -2046,16 +2062,23 @@ a XttGraph object. ...@@ -2046,16 +2062,23 @@ a XttGraph object.
<B>xtt> open graph 'filename' /width= /height= /scrollbar /menu /navigator <B>xtt> open graph 'filename' /width= /height= /scrollbar /menu /navigator
<B> /instance= /focus= /inputempty <B> /instance= /focus= /inputempty
<B>xtt> open graph /object= /focus= /inputempty <B>xtt> open graph /object= /focus= /inputempty
<B>xtt> open graph /class /instance=
/width <t>Width in pixel. /width <t>Width in pixel.
/height <t>Height in pixel. /height <t>Height in pixel.
/scrollbar<t>Scrollbars will be displayed in the graph window. /scrollbar<t>Scrollbars will be displayed in the graph window.
/menu <t>A menu will be displayed in the graph window. /menu <t>A menu will be displayed in the graph window.
/navigator<t>A navigator window will be opened. /navigator<t>A navigator window will be opened.
/object <t>A XttGraph-object. If the namestring begins with '*', * is /object <t>An XttGraph-object. If the name starts with '$node' or '*' this will be
<t>replaced by the node object. <t>replaced by the node object.
/instance <t>Open the class graph for this instance. /instance <t>Open the object graph or an hierarchy graph for this instance.
<t>If /class is supplied the object graph is opened, otherwise a
<t>filename can be supplied.
/class <t>Open the object graph for the instance object.
/parent <t>Specifies that the object graph for the parent of the instance object
<t>should be opened.
/focus <t>Name of a value input object. The object will gain input focus /focus <t>Name of a value input object. The object will gain input focus
<t>when the graph is opened. <t>when the graph is opened.
/inputempty <t>The input label of the input focus object will be empty. /inputempty <t>The input label of the input focus object will be empty.
...@@ -2064,19 +2087,98 @@ a XttGraph object. ...@@ -2064,19 +2087,98 @@ a XttGraph object.
<t>when the graph is opened from a push button in this window. <t>when the graph is opened from a push button in this window.
/pinstance <t>Instance name for the pwindow graph, if pwindow is an object /pinstance <t>Instance name for the pwindow graph, if pwindow is an object
<t>graph. <t>graph.
/fullscreen <t>Open the window fullscreen without frame.
/maximize <t>Open the window maximized with frame.
/iconify <t>Open the window iconified.
/hide <t>Don't display the graph on the screen.
</TOPIC> </TOPIC>
<TOPIC> open multiview <style> function
Command open multiview Command open multiview
Open a multiview window specified by an XttMultiView object. Open a multiview window specified by an XttMultiView object.
<B>xtt> open multiview 'objectname' /width= /height= /xposition= /yposition= <B>xtt> open multiview 'objectname' /width= /height= /xposition= /yposition=
<t><t>/fullscreen /maximize /fullmaximize /iconify /hide <t><t>/fullscreen /maximize /iconify /hide
'objectname' <t>Name of and XttMultiView object. If the name starts with '$node'
<t>or '*' this will be replace by the node object.
/width <t>Window width in pixels. /width <t>Window width in pixels.
/height <t>Window height in pixels. /height <t>Window height in pixels.
/xposition <t>Window x position in pixels. /xposition <t>Window x position in pixels.
/yposition <t>Window y position in pixels. /yposition <t>Window y position in pixels.
/fullscreen <t>Open the window fullscreen without frame.
/maximize <t>Open the window maximized with frame.
/iconify <t>Open the window iconified.
</TOPIC>
<TOPIC> open shistory <style> function
Command open shistory
Open a list of history curves for an object.
Displays a list of all SevHist and SevHistObject storing process history
for different attributes in an object.
<B>xtt> open shistory /name=
/name <t>Object name.
</TOPIC>
<TOPIC> open history <style> function
Command open history
Open process history for an object. Data is fetched from the storage server,
but can also read from a file containing history data previously stored with
the export function.
<B>xtt> open history [/name=] [/title=]
<B>xtt> open history /file=
/name <t>An object with stored process history.
/file <t>Open a file containing history data previously stored with the
<t>export function.
/title <t>Title of curve window.
/width <t>Window width in pixels.
/height <t>Window height in pixels.
/fullscreen <t>Open the window fullscreen without frame.
/maximize <t>Open the window maximized with frame.
/iconify <t>Open the window iconified.
Example
xtt> open history /name=hql-hvk-flow
</TOPIC>
<TOPIC> open attribute <style> function
Command open attribute
Open a value input dialog for an attribute.
<B>xtt> open attribute /name= [/title=]
/name <t>Attribute name.
/title <t>Window title.
</TOPIC>
<TOPIC> open consolelog <style> function
Command open consolelog
Display system messages.
<B>xtt> open consolelog
</TOPIC>
<TOPIC> open url <style> function
Command open url
Open an URL in a web browser.
<B>xtt> open url 'URL'
<B>Example
xtt> open url http://www.proview.se
</TOPIC> </TOPIC>
<TOPIC> open jgraph <style> function <TOPIC> open jgraph <style> function
...@@ -2151,19 +2253,72 @@ xtt> open trace /name=hql-hvk-flow /center=Pid0 ...@@ -2151,19 +2253,72 @@ xtt> open trace /name=hql-hvk-flow /center=Pid0
<TOPIC> open trend <style> function <TOPIC> open trend <style> function
Command open trend Command open trend
Open a graph for a DsTrend or PlotGroup object. Open a graph for a DsTrend, DsTrendCurve or PlotGroup object.
<B>xtt> open trend [/name=] [/title=] <B>xtt> open trend [/name=] [/title=]
/name <t>DsTrend or PlotGroup. Can be a list of DsTrend-objects separated /name <t>DsTrend, DsTrendCurve or PlotGroup. Can be a list of DsTrend-objects
<t>by comma. <t>separated by comma.
/title <t>Title of graph window. /title <t>Title of curve window.
/width <t>Window width in pixels.
/height <t>Window height in pixels.
/fullscreen <t>Open the window fullscreen without frame.
/maximize <t>Open the window maximized with frame.
/iconify <t>Open the window iconified.
Examples Examples
xtt> open trend /name=hql-hvk-flow-Trend,hql-hvk-temperature-Trend xtt> open trend /name=hql-hvk-flow-Trend,hql-hvk-temperature-Trend
</TOPIC> </TOPIC>
<TOPIC> open fast <style> function
Command open fast
Open a fast curve specfied with a DsFastCurve object.
<B>xtt> open fast /name= [/title=]
<B>xtt> open fast /file=
/name <t>DsFastCurve or PlotGroup. Can be a list of DsFast-objects
<t>separated by comma.
/file <t>Opens a file previously created with the export function for fast
<t>curves.
/title <t>Title of curve window.
/width <t>Window width in pixels.
/height <t>Window height in pixels.
/fullscreen <t>Open the window fullscreen without frame.
/maximize <t>Open the window maximized with frame.
/iconify <t>Open the window iconified.
Examples
xtt> open fast /name=hql-hvk-flow-Fast
</TOPIC>
<TOPIC> open tcurve <style> function
Command open tcurve
Takes a snapshot of a trend curve and displays the snapshot. With the /new qualifier
an empty curve window is opened where a previously stored snapshot curve can be viewed.
<B>xtt> open tcurve /name= [/title=] [/height=] [/width=]
<B>xtt> open tcurve /new [/title=]
/name <t>DsTrendCurve object to take a snapshot from.
/new <t>Opens an empty tcurve window where a stored snapshot curve can inserted from
<t>File/Open in the menu.
/title <t>Title of graph window.
/width <t>Window width in pixels.
/height <t>Window height in pixels.
/fullscreen <t>Open the window fullscreen without frame.
/maximize <t>Open the window maximized with frame.
/iconify <t>Open the window iconified.
Example
xtt> open tcurve /name=hql-hvk-flow-Trend
</TOPIC>
<TOPIC> open operatorwindow <style> function <TOPIC> open operatorwindow <style> function
Command open operatorwindow Command open operatorwindow
...@@ -2176,7 +2331,8 @@ Open the operatorwindow. ...@@ -2176,7 +2331,8 @@ Open the operatorwindow.
Command close graph Command close graph
Close a ge graph. The graph can be supplied as a pwg-file or as Close a ge graph. The graph can be supplied as a pwg-file or as
a XttGraph object. a XttGraph object. To close a graph from a button inside the graph
$current can be used, 'close graph $current'.
<B>xtt> close graph 'filename' /instance= <B>xtt> close graph 'filename' /instance=
<B>xtt> close graph /object= <B>xtt> close graph /object=
...@@ -2186,6 +2342,18 @@ a XttGraph object. ...@@ -2186,6 +2342,18 @@ a XttGraph object.
/instance <t>Open the class graph for this instance. /instance <t>Open the class graph for this instance.
</TOPIC> </TOPIC>
<TOPIC> close multiview <style> function
Command close multiview
Close a multiview window.
To close a multiview from a button inside the multiview $current can be used
'close multiview $current'.
<B>xtt> close multiview 'objectname'
'objectname' <t>Name of the XttMuliView object.
</TOPIC>
<TOPIC> close alarmlist <style> function <TOPIC> close alarmlist <style> function
Command close alarmlist Command close alarmlist
......
...@@ -1507,7 +1507,7 @@ Det h ...@@ -1507,7 +1507,7 @@ Det h
<c><volumename>.dbs <c><volumename>.dbs
</topic> </topic>
Här läggs även filer som skaöas när man editerar plc-programmet. De innehåller all information Här läggs även filer som skapas när man editerar plc-programmet. De innehåller all information
som behövs för att visa plc-programmet grafiskt och för att köra plc trace. De här filerna som behövs för att visa plc-programmet grafiskt och för att köra plc trace. De här filerna
är av filtyp .flw och kallas flow-filer. är av filtyp .flw och kallas flow-filer.
...@@ -1774,6 +1774,39 @@ objektet (ligger som barn till PlcPgm-objektet) till 0. Observera att eventuella ...@@ -1774,6 +1774,39 @@ objektet (ligger som barn till PlcPgm-objektet) till 0. Observera att eventuella
också kan behöva startas. också kan behöva startas.
</topic> </topic>
<topic> file_proview_cnf
/etc/proview.cnf
En konfigurations-fil för definition av diverse parametrar både i utvecklings-, runtime- och
lagrings-miljön. På en utvecklings-station gäller definitionerna alla projekt på noden.
<b>Parametrar i utvecklings-miljön
mysqlSocket <t><t>mysql socket för volymer med mysql databas. Default värde
<t><t>"/var/run/mysqld/mysqld.sock".
mysqlServer <t><t>Server node för mysql.
defaultProjectRoot <t><t>Default rot-katalog för projekt när nya projekt skapas.
<t><t>Default värde "/usr/local/pwrp".
defaultProductionBus <t><t>Default produktionsbuss när nya projekt skapas.
<t><t>Default värde 1.
defaultSimulationBus <t><t>Default simuleringsbuss när nya projekt skapas.
<t><t>Default värde 999.
defaultSystemGroup <t><t>Default systemgrupp när nya projekt skapas.
<t><t>Default värde "Common".
defaultNodeHierRoot <t><t>Default namn på översta objektet i node-hierarkin när nya
<t><t>projekt skapas. Default värde "Nodes".
qcomBusId <t><t>QCom bus identitet för simulering.
<b>Parameterar i runtime-miljön
qcomBusId <t><t>QCom bus identitet.
curveExportFile <t><t>Default fil-namn vid export från en historik kurva.
webDirectory <t><t>Katalog där web-filer placeras och läses av webservern.
<b>Parameterar i lagrings-miljön
sevDatabaseType <t><t>Databastyp, mysql eller sqlite.
sevXttDefaultPriv <t><t>Default priviligier för access av sev-databasen från sev_xtt.
sevMysqlEngine <t><t>Mysql engine för tabeller som skapas, innodb eller myisam.
</topic>
</headerlevel> </headerlevel>
</headerlevel> </headerlevel>
......
...@@ -64,7 +64,7 @@ SObject pwrb:Class ...@@ -64,7 +64,7 @@ SObject pwrb:Class
! - plc file. ! - plc file.
! - rtt crossreference files. ! - rtt crossreference files.
! @b ApplFile ! @b ApplFile
! The startup file $pwrp_load/ld_appl_'nodename'_'busnumber'.dat is included. ! The startup file $pwrp_load/ld_appl_'nodename'_'busnumber'.txt is included.
! @b PwrpAliasFile ! @b PwrpAliasFile
! $pwrp_load/pwrp_alias.dat is included. ! $pwrp_load/pwrp_alias.dat is included.
! @b IncludeFiles ! @b IncludeFiles
......
...@@ -74,7 +74,7 @@ SObject pwrb:Type ...@@ -74,7 +74,7 @@ SObject pwrb:Type
EndBody EndBody
EndObject EndObject
!/** !/**
! The startup file $pwrp_load/ld_appl_'nodename'_'busnumber'.dat is included. ! The startup file $pwrp_load/ld_appl_'nodename'_'busnumber'.txt is included.
!*/ !*/
Object ApplFile $Bit Object ApplFile $Bit
Body SysBody Body SysBody
......
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