File: DevCommands.html

package info (click to toggle)
tango 10.0.2%2Bdfsg1-1~bpo12%2B1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-backports
  • size: 89,480 kB
  • sloc: cpp: 201,245; sh: 1,645; python: 953; java: 800; perl: 467; javascript: 447; xml: 325; makefile: 269; sql: 72; ruby: 24
file content (293 lines) | stat: -rw-r--r-- 9,845 bytes parent folder | download | duplicates (4) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>
<HEAD>
<Title> Tango Device Server User's Guide </Title>
</HEAD>
<BODY TEXT="#000000" BGCOLOR="#FFFFFF" LINK="#0000FF" VLINK="#7F00FF" ALINK="#FF0000">

<P><!-------TITLE------></P>

<TABLE BORDER="0" WIDTH="100%">
    <TR>
        <TD ALIGN="left">
			<A HREF="http://www.esrf.fr/" TARGET=new>
			<IMG SRC="http://www.esrf.fr/gifs/logo/80.gif" BORDER=0 Height="60"></A>
		</Td>
        <TD ALIGN="center">
			<A HREF="http://www.elettra.trieste.it/" TARGET=new>
			<IMG SRC="http://www.esrf.fr/computing/cs/tango/elettra_logo.gif" BORDER=0 Height="60"></A>

		</Td>
        <TD ALIGN="center">
			<A HREF="http://www.synchrotron-soleil.fr/" TARGET=new>
			<IMG SRC="http://www.esrf.fr/computing/cs/tango/soleil_logo.gif" BORDER=0 Height="60"></A>
		</Td>
        <TD ALIGN="right">
			<A HREF="http://www.cells.es/" TARGET=new>
			<IMG SRC="http://www.esrf.fr/computing/cs/tango/alba.jpg" BORDER=0 Height="54"></A>
		</Td>
        <TD ALIGN="right">
			<A HREF="http://www.desy.de/html/home/index_eng.html" TARGET=new>
			<IMG SRC="http://www.esrf.fr/computing/cs/tango/desy.gif" BORDER=0 Height="60"></A>
		</Td>
    	 <Td>
			<H2><FONT COLOR="#7F00FF">
			<Center><A HREF="http://www.tango-controls.org/" TARGET="_top">
					 TANGO </a> <Br> Device Server
			</Center></FONT>
		</Td>
    </TR>
</TABLE>

<HR WIDTH="100%"></H5>
<Br>
<center>
<h1>
Starter for Tango Administration		<Br>
Device Commands Description 		<Br> <Br>
Starter Class	<Br>
</h1>
<b>
Revision:  - Author: verdier
</b>
</center>


<Br>
<Br>
<Br>
<A NAME="Init"><!-- --></A>
<A NAME="Init"><!-- --></A>
<h2>1 - Init</h2>
<ul>
<Li><Strong>Description: </Strong> This commands re-initialise a device keeping the same network connection.<Br>
After an Init command executed on a device, it is not necessary for client to re-connect to the device.<Br>
This command first calls the device <i> delete_device() </i>method and then execute its <i> init_device()</i> method.<Br>
For C++ device server, all the memory allocated in the <i> nit_device() </i> method must be freed in the <i> delete_device() </i> method.<Br>
The language device desctructor automatically calls the <i> delete_device() </i> method.<Br>&nbsp
<Li><Strong>Argin:<Br>DEV_VOID</Strong>
 : none.<Br>&nbsp
<Li><Strong>Argout:<Br>DEV_VOID</Strong>
 : none.<Br>&nbsp
<Li><Strong>Command allowed for: </Strong><Ul>
<Li>Tango::UNKNOWN<Li>Tango::ON<Li>Tango::ALARM<Li>Tango::MOVING</Ul>
<Br>&nbsp
</ul><Br>
<Br>
<A NAME="State"><!-- --></A>
<A NAME="State"><!-- --></A>
<h2>2 - State</h2>
<ul>
<Li><Strong>Description: </Strong> This command gets the device state (stored in its <i>device_state</i> data member) and returns it to the caller.<Br>&nbsp
<Li><Strong>Argin:<Br>DEV_VOID</Strong>
 : none.<Br>&nbsp
<Li><Strong>Argout:<Br>DEV_STATE</Strong>
 : State Code<Br>&nbsp
<Li><Strong>Command allowed for: </Strong><Ul>
<Li>Tango::UNKNOWN<Li>Tango::ON<Li>Tango::ALARM<Li>Tango::MOVING</Ul>
<Br>&nbsp
</ul><Br>
<Br>
<A NAME="Status"><!-- --></A>
<A NAME="Status"><!-- --></A>
<h2>3 - Status</h2>
<ul>
<Li><Strong>Description: </Strong> This command gets the device status (stored in its <i>device_status</i> data member) and returns it to the caller.<Br>&nbsp
<Li><Strong>Argin:<Br>DEV_VOID</Strong>
 : none.<Br>&nbsp
<Li><Strong>Argout:<Br>CONST_DEV_STRING</Strong>
 : Status description<Br>&nbsp
<Li><Strong>Command allowed for: </Strong><Ul>
<Li>Tango::UNKNOWN<Li>Tango::ON<Li>Tango::ALARM<Li>Tango::MOVING</Ul>
<Br>&nbsp
</ul><Br>
<Br>
<A NAME="DevStartAll"><!-- --></A>
<A NAME="DevStartAll"><!-- --></A>
<h2>4 - DevStartAll</h2>
<ul>
<Li><Strong>Description: </Strong> Start all device servers controlled on the host for the argin level.<Br>&nbsp
<Li><Strong>Argin:<Br>DEV_SHORT</Strong>
 : Startup level.<Br>&nbsp
<Li><Strong>Argout:<Br>DEV_VOID</Strong>
 : <Br>&nbsp
<Li><Strong>Command allowed for: </Strong><Ul>
<Li>Tango::UNKNOWN<Li>Tango::ON<Li>Tango::ALARM<Li>Tango::MOVING</Ul>
<Br>&nbsp
</ul><Br>
<Br>
<A NAME="DevStopAll"><!-- --></A>
<A NAME="DevStopAll"><!-- --></A>
<h2>5 - DevStopAll</h2>
<ul>
<Li><Strong>Description: </Strong> Stop all device servers controlled on the host for the argin level.<Br>&nbsp
<Li><Strong>Argin:<Br>DEV_SHORT</Strong>
 : Startup Level.<Br>&nbsp
<Li><Strong>Argout:<Br>DEV_VOID</Strong>
 : <Br>&nbsp
<Li><Strong>Command allowed for: </Strong><Ul>
<Li>Tango::UNKNOWN<Li>Tango::ON<Li>Tango::ALARM<Li>Tango::MOVING</Ul>
<Br>&nbsp
</ul><Br>
<Br>
<A NAME="DevGetRunningServers"><!-- --></A>
<A NAME="DevGetRunningServers"><!-- --></A>
<h2>6 - DevGetRunningServers</h2>
<ul>
<Li><Strong>Description: </Strong> Control the running process from property list.
And return the list of the processes which are really running.<Br>&nbsp
<Li><Strong>Argin:<Br>DEV_BOOLEAN</Strong>
 : True for all servers. False for controlled servers only.<Br>&nbsp
<Li><Strong>Argout:<Br>DEVVAR_STRINGARRAY</Strong>
 : List of the processes which are running.<Br>&nbsp
<Li><Strong>Command allowed for: </Strong><Ul>
<Li>Tango::UNKNOWN<Li>Tango::ON<Li>Tango::ALARM<Li>Tango::MOVING</Ul>
<Br>&nbsp
</ul><Br>
<Br>
<A NAME="DevGetStopServers"><!-- --></A>
<A NAME="DevGetStopServers"><!-- --></A>
<h2>7 - DevGetStopServers</h2>
<ul>
<Li><Strong>Description: </Strong> Control the running process from property list.
And return the list of the processes which are not running.<Br>&nbsp
<Li><Strong>Argin:<Br>DEV_BOOLEAN</Strong>
 : True for all servers. False for controlled servers only.<Br>&nbsp
<Li><Strong>Argout:<Br>DEVVAR_STRINGARRAY</Strong>
 : List of the processes which are not running.<Br>&nbsp
<Li><Strong>Command allowed for: </Strong><Ul>
<Li>Tango::UNKNOWN<Li>Tango::ON<Li>Tango::ALARM<Li>Tango::MOVING</Ul>
<Br>&nbsp
</ul><Br>
<Br>
<A NAME="DevStart"><!-- --></A>
<A NAME="DevStart"><!-- --></A>
<h2>8 - DevStart</h2>
<ul>
<Li><Strong>Description: </Strong> Start the specified server.<Br>&nbsp
<Li><Strong>Argin:<Br>DEV_STRING</Strong>
 : Server to be started.<Br>&nbsp
<Li><Strong>Argout:<Br>DEV_VOID</Strong>
 : <Br>&nbsp
<Li><Strong>Command allowed for: </Strong><Ul>
<Li>Tango::UNKNOWN<Li>Tango::ON<Li>Tango::ALARM<Li>Tango::MOVING</Ul>
<Br>&nbsp
</ul><Br>
<Br>
<A NAME="DevStop"><!-- --></A>
<A NAME="DevStop"><!-- --></A>
<h2>9 - DevStop</h2>
<ul>
<Li><Strong>Description: </Strong> Stop the specified server.<Br>&nbsp
<Li><Strong>Argin:<Br>DEV_STRING</Strong>
 : Servero be stopped.<Br>&nbsp
<Li><Strong>Argout:<Br>DEV_VOID</Strong>
 : <Br>&nbsp
<Li><Strong>Command allowed for: </Strong><Ul>
<Li>Tango::UNKNOWN<Li>Tango::ON<Li>Tango::ALARM<Li>Tango::MOVING</Ul>
<Br>&nbsp
</ul><Br>
<Br>
<A NAME="DevReadLog"><!-- --></A>
<A NAME="DevReadLog"><!-- --></A>
<h2>10 - DevReadLog</h2>
<ul>
<Li><Strong>Description: </Strong> At server startup, its standard error is redirected to a log file.
This command will read this file and return the read string from the file.<Br>&nbsp
<Li><Strong>Argin:<Br>DEV_STRING</Strong>
 : server name and domain<Br>&nbsp
<Li><Strong>Argout:<Br>CONST_DEV_STRING</Strong>
 : ig Starter/corvus)<Br>&nbsp
<Li><Strong>Command allowed for: </Strong><Ul>
<Li>Tango::UNKNOWN<Li>Tango::ON<Li>Tango::ALARM<Li>Tango::MOVING</Ul>
<Br>&nbsp
</ul><Br>
<Br>
<A NAME="HardKillServer"><!-- --></A>
<A NAME="HardKillServer"><!-- --></A>
<h2>11 - HardKillServer</h2>
<ul>
<Li><Strong>Description: </Strong> Hard kill a server (kill -9)<Br>&nbsp
<Li><Strong>Argin:<Br>DEV_STRING</Strong>
 : Server name<Br>&nbsp
<Li><Strong>Argout:<Br>DEV_VOID</Strong>
 : <Br>&nbsp
<Li><Strong>Command allowed for: </Strong><Ul>
<Li>Tango::UNKNOWN<Li>Tango::ON<Li>Tango::ALARM<Li>Tango::MOVING</Ul>
<Br>&nbsp
</ul><Br>
<Br>
<A NAME="NotifyDaemonState"><!-- --></A>
<A NAME="NotifyDaemonState"><!-- --></A>
<h2>12 - NotifyDaemonState</h2>
<ul>
<Li><Strong>Description: </Strong> Returns the Notify Daemon state.<Br>&nbsp
<Li><Strong>Argin:<Br>DEV_VOID</Strong>
 : <Br>&nbsp
<Li><Strong>Argout:<Br>DEV_STATE</Strong>
 : Tango::ON if Notify daemon is running else Tango::FAULT.<Br>&nbsp
<Li><Strong>Command allowed for: </Strong><Ul>
<Li>Tango::UNKNOWN<Li>Tango::ON<Li>Tango::ALARM<Li>Tango::MOVING</Ul>
<Br>&nbsp
</ul><Br>
<Br>
<A NAME="UpdateServersInfo"><!-- --></A>
<A NAME="UpdateServersInfo"><!-- --></A>
<h2>13 - UpdateServersInfo</h2>
<ul>
<Li><Strong>Description: </Strong> Indicate to the device server than the information about servers to be controlled has been modified.
The device server must read the database to update the servers info list.
If the default case, this command is sent by Database server itself.<Br>&nbsp
<Li><Strong>Argin:<Br>DEV_VOID</Strong>
 : <Br>&nbsp
<Li><Strong>Argout:<Br>DEV_VOID</Strong>
 : <Br>&nbsp
<Li><Strong>Command allowed for: </Strong><Ul>
<Li>Tango::UNKNOWN<Li>Tango::ON<Li>Tango::ALARM<Li>Tango::MOVING</Ul>
<Br>&nbsp
</ul><Br>
<Br>

<!--- html Footer --->

<Center>
<Font size=-1>
<br>
<br>
<TABLE BORDER="1" WIDTH="100%">
    <Tr>
		<!--- Hosted by Sourceforge --->
        <Td Align="Center">
			<Font size=-1>
			<b>TANGO</b> is an open source project hosted by :<br>
			<A href="http://sourceforge.net" Target="new">
					<IMG title="Sourceforge logo"
						alt="Sourceforge logo small"
						src="http://www.esrf.fr/computing/cs/tango/sourceforge.gif"
						border=0> </a>
			</Font>
		</Td>
		<!--- 2 Sourceforge Repositories --->
		<Td Align="Center">
			<Font size=-1>
			Core and Tools :
			<a href="http://tango-cs.cvs.sourceforge.net/tango-cs/" Target="new">
			CVS repository</a> on
			<a href="https://sourceforge.net/projects/tango-cs" Target=new>
			tango-cs project</a>

			<br>

			Device Servers :
			<a href="http://tango-ds.cvs.sourceforge.net/tango-ds/" Target="new">
					CVS repository</a> on
			<a href="https://sourceforge.net/projects/tango-ds" Target=new>
					tango-ds project</a>
			</Font>
		</Td>
    </Tr>
</Table>
</Font>
</Center>
</body>
</html>