(howto-start-device-server)=

# Start a device server

```{tags} audience:all
```

While reading this how-to please refer to manuals of [Jive](inv:jive:std#index) and [Astor](#astor-manual) tools.

## Starting device servers with Jive

- In Jive select {guilabel}`Tools > Server Wizard` from the menu.
- In the wizard, fill the server and the instance name and click {guilabel}`Next`. The server
name should be the same as the server executable name, and instance name can be
any name you provide.

:::{figure} how-to-start-device-server/wizard1.png
:alt: Wizard - step 1

Wizard - step 1 - device server instance
:::

- The wizard will now wait until you start the device server, which you can do
from the command line. Device servers usually take the instance name as an
argument. For this example you can use the command `TangoTest test2` where *test2*
is the instance name. When done click {guilabel}`Next`.

:::{figure} how-to-start-device-server/wizard2.png
:alt: Wizard - step 2

Wizard - step 2 - starting the device server
:::

- In the next steps you will be asked to configure the devices that your device
server instance will host. For this you need to pick a class and name for your
device. A list of supported classes is provided by the device server, and the
name of the device can be any name unique in the system following the format
`<domain>/<family>/<member>`.

:::{figure} how-to-start-device-server/wizard3.png
:alt: Wizard - step 3

Wizard - step 3 - device class
:::

:::{figure} how-to-start-device-server/wizard4.png
:alt: Wizard - step 4

Wizard - step 4 - device name
:::

- Next, you can configure properties for the newly created devices.

:::{figure} how-to-start-device-server/wizard5.png
:alt: Wizard - step 5

Wizard - step 5 - device properties
:::

- After that you can create another device of the same class by clicking
{guilabel}`New Device` or pick another class by clicking {guilabel}`New Class`.
You can also finish the configuration and exit the wizard with the
{guilabel}`Finish` button.

:::{figure} how-to-start-device-server/wizard6.png
:alt: Wizard - step 6

Wizard - step 6 - finish
:::

- After the configuration, the device server must be restarted to load and start
configured devices.

:::{figure} how-to-start-device-server/wizard7.png
:alt: Wizard - step 7

Wizard - step 7 - device server restart
:::

## Starting device servers with Astor

:::{note}
To configure device servers with Astor, you will need [Starter](#Starter)
installed and running on the host you want to start your device server on.
Device server should be available in paths configured for the Starter.
:::

- In Astor go to the host control panel and click {guilabel}`Start New` button in
the top left corner. If you want to just start an existing device server
instance, pick it from the list and click {guilabel}`Start Server`.

:::{figure} how-to-start-device-server/start_server.png
:alt: Astor server list

Server list in Astor
:::

- If you want to add new server, click {guilabel}`Create New Server`. This will
open the device installation wizard from Jive. Astor will handle starting the
device server for you in step 2 of the wizard.
- At the end of the wizard, you
will be asked to select the startup level of the new server.

:::{figure} how-to-start-device-server/startup_level.png
:alt: Startup level configuration

Startup level configuration
:::

## Other options

You can also use the [Tango Admin](#tango-admin) utility to register servers from scripts or
the command line. There are also some device servers (e.g. [Sardana](#sardana)) that can
register themselves upon starting.

[tango_admin]: https://gitlab.com/tango-controls/tango_admin