This device server is certified as a reference implementation.
Development status:
Released
Information status: Updated
Repository:
https://github.com/tango-controls/starter
Contact:
Class Description
This device server is able to control <b>Tango</b> components (database, device servers, clients...). It is able to start or stop and to report the status of these components.
Families: System
Key words:
Platform: All Platforms
Language: Cpp
License: GPL
Contact:
Hardware
Manufacturer: ESRF
Bus: Not Applicable
Class interface
Attributes:
| Name | Description |
|---|---|
| NotifdStateScalar: DevState | return ON or FAULT if notify daemon is running or not. |
| HostStateScalar: DevShort | — |
| RunningServersSpectrum: DevString | — |
| StoppedServersSpectrum: DevString | Return all the Stopped servers.\n |
| ServersSpectrum: DevString | Return all registred servers for this host.\nServer names are followed by their states and controls |
Commands:
| Name | Description |
|---|---|
| ResetStatisticsInput: DevVoid Output: DevVoid |
Reset statistics file. |
| StateInput: DevVoid Output: State State Code |
This command gets the device state (stored in its <i>device_state</i> data member) and returns it to the caller. |
| StatusInput: DevVoid Output: ConstDevString Status description |
This command gets the device status (stored in its <i>device_status</i> data member) and returns it to the caller. |
| DevStartInput: DevString Server to be started. Output: DevVoid |
Start the specified server. |
| DevStopInput: DevString Servero be stopped. Output: DevVoid |
Stop the specified server. |
| DevStartAllInput: DevShort Startup level. Output: DevVoid |
Start all device servers controled on the host for the argin level. |
| DevStopAllInput: DevShort Startup Level. Output: DevVoid |
Stop all device servers controled on the host for the argin level. |
| DevGetRunningServersInput: DevBoolean True for all servers. False for controled servers only. Output: DevVarStringArray List of the processes which are running. |
Control the running process from property list. And return the list of the processes which are really running. |
| DevGetStopServersInput: DevBoolean True for all servers. False for controled servers only. Output: DevVarStringArray List of the processes which are not running. |
Control the running process from property list. And return the list of the processes which are not running. |
| DevReadLogInput: DevString server name and domain (e.g. Starter/corvus) If argin ==``Starter`` -> return Starter logg file content. If argin ==``Statistics`` -> return Starter statistics file content. Output: ConstDevString String found in log file. |
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. |
| HardKillServerInput: DevString Server name Output: DevVoid |
Hard kill a server (kill -9) |
| NotifyDaemonStateInput: DevVoid Output: State Tango::ON if Notify daemon is running else Tango::FAULT. |
Returns the Notify Daemon state. |
| UpdateServersInfoInput: DevVoid Output: DevVoid |
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. |
Pipes:
Properties:
| Name | Description |
|---|---|
| AutoRestartDurationDevLong | If this property is greater than 0, if a server has been running more than the specified value (in minutes), and has failed, it will be restart automaticly. |
| InterStartupLevelWaitDevLong | Time to wait before two startup levels in seconds. |
| KeepLogFilesDevLong | Number of log file kept. |
| LogFileHomeDevString | The home directory to log servers traces. For Linux the default value is /var/tmp For Win32 it is c:\temp |
| ServerStartupTimeoutDevLong | Timeout on device server startup in seconds. |
| StartDsPathArray of DevString | Path to find executable files to start device servers |
| StartServersAtStartupDevBoolean | Skip starting servers at startup if false. |
| UseEventsDevShort | Use events if not null. |
| WaitForDriverStartupDevShort | The Starter will wait a bit before starting servers, to be sure than the drivers are started.This time is in seconds. |
| AutoRestartDurationDevLong | If this property is greater than 0, if a server has been running more than the specified value (in minutes), and has failed, it will be restart automaticly. |
| LogFileHomeDevString | The home directory to log servers traces. For Linux the default value is /var/tmp For Win32 it is c:\temp |
| NbStartupLevelsDevShort | Number of startup levels managed by starter. |
| ReadInfoDbPeriodDevShort | Period to read database for new info if not fired from Database server. |
| ServerStartupTimeoutDevLong | Timeout on device server startup in seconds. |
| StartServersAtStartupDevBoolean | Skip starting servers at startup if false. It a way to do not have a big re-start of many servers after a power cut. |
| UseEventsDevShort | Use events if not null. |
Please log in to comment.
Generated
https://github.com/tango-controls/starter/blob/master/docs/Starter.pdf
Generated
https://github.com/tango-controls/starter/blob/master/docs/Starter.pdf
Updated:
The device server has been updated.
You can see previous version here .
5 Jan 2017, Andy Gotz
Created:
The device server has been added to catalogue.