Phoebus client¶

Install, and configure the installation of the Phoebus graphical client.

See also

The Phoebus client user guide for how to use these options.

programs.phoebus-client¶

programs.phoebus-client.enable boolean[source]¶

Whether to enable installing and configuring the Phoebus client.

Default value¶

false

Example¶

true

programs.phoebus-client.colorDef null or (attribute set of string)[source]¶

Phoebus color definitions.

If unset, use the colors from Phoebus’ examples/color.def.

If set, expand on the default colors from Phoebus.

Warning

If colorDef is set, the “additional colors” from examples/color.def, such as Header_Background, On, or Off, won’t be provided by default.

Color format:

red, green, blue
red, green, blue, alpha
PreviouslyDefinedNameOfColor

with values in 0-255 range.

Whenever possible, use named colors in displays instead of arbitrary red/green/blue values.

Default value¶

null

Example¶

{
  OK = "0, 255, 0";
  On = "OK";
  Transparent = "255, 255, 255, 0";
}

programs.phoebus-client.finalPackage package [read-only][source]¶

The final package that will be used in the system, a Phoebus package that will use the provided preference settings, Java options, etc.

The original package is taken from package.

Default value¶

The wrapped Phoebus package

programs.phoebus-client.fontDef null or (attribute set of string)[source]¶

Phoebus font definitions.

If unset, use the fonts from Phoebus’ examples/font.def.

If set, expand on the default fonts from Phoebus.

Warning

If fontDef is set, the example fonts from examples/font.def, such as Oddball, won’t be provided by default.

Name format:

NamedFont
NamedFont(OS)

Font format:

Family - Style - Size
@PreviouslyDefinedNamedFont

Style:

regular, bold, italic, or bold italic.

Size:

Font height in pixels

Family:

Font family name, such as Liberation Sans, Liberation Mono, or Liberation Serif;

OS:

windows, linux, or macosx.

Default value¶

null

Example¶

{
  Oddball = "Comic Sans MS-regular-40";
  "Oddball(linux)" = "PakTypeNaqsh-regular-40";
  "Oddball(macosx)" = "Herculanum-regular-40";
}

programs.phoebus-client.java_opts string[source]¶

Set Java options for the Phoebus client.

For more information, see: https://docs.oracle.com/en/java/javase/21/docs/specs/man/java.html#extra-options-for-java

Default value¶

"-XX:MinHeapSize=128m -XX:MaxHeapSize=4g -XX:InitialHeapSize=1g -XX:MaxHeapFreeRatio=10 -XX:MinHeapFreeRatio=5 -XX:-ShrinkHeapInSteps -XX:NativeMemoryTracking=detail"

Example¶

"-XX:MinHeapSize=128m -XX:MaxHeapSize=4g -XX:InitialHeapSize=1g"

programs.phoebus-client.package package[source]¶

The Phoebus package to use. This package is “wrapped” into finalPackage to use the given preference settings, Java options, etc.

Default value¶

pkgs.epnix.phoebus

programs.phoebus-client.settings attribute set of (string, package, bool, int or float)[source]¶

Phoebus preference setting, as defined in the Preferences Listing Phoebus documentation.

Default value¶

{ }

Example¶

{
  "org.csstudio.trends.databrowser3/urls" = "pbraw://localhost:8080/retrieval";
  "org.phoebus.applications.alarm/config_names" = "Accelerator, Demo";
  "org.phoebus.applications.alarm/server" = "localhost:9092";
}

programs.phoebus-client.settings."org.csstudio.display.builder.model/color_files" absolute path or string[source]¶

Named colors definition files.

One or more color.def files, separated by ;.

By default, the file is generated from the colorDef option, if defined, or to built-in copy of examples/color.def if colorDef isn’t defined.

Note

Use the this option if you want to import an already existing color.def file. If you override this option, colorDef options are ignored.

Default value¶

"<file generated from 'colorDef' if defined, else the default colors>"

Example¶

./color.def

programs.phoebus-client.settings."org.csstudio.display.builder.model/font_files" absolute path or string[source]¶

Named fonts definition files.

One or more font.def files, separated by ;.

By default, the file is generated from the fontDef option, if defined, or to built-in copy of examples/font.def if fontDef isn’t defined.

Note

Use the this option if you want to import an already existing font.def file. If you override this option, fontDef options are ignored.

Default value¶

"<file generated from 'fontDef' if defined, else the default fonts>"

Example¶

./font.def

programs.phoebus-client.settings."org.csstudio.display.builder.model/macros" attribute set of string[source]¶

Global macros, used for all displays.

Displays start with these macros, and can then add new macros or overwrite the values of these macros.

Format:

The macro name must be a valid XML tag name:

Must start with character
May then contain characters or numbers
May also contain underscores

Default value¶

{ }

Example¶

{
  EXAMPLE_MACRO = "Value from Preferences";
  TEST = "true";
}

programs.phoebus-client.settings."org.phoebus.pv.ca/addr_list" list of string[source]¶

Channel Access address list.

Use lib.mkForce to override values from environment.epics.ca_addr_list.

Default value¶

if config.environment.epics.enable
then config.environment.epics.ca_addr_list
else [];

programs.phoebus-client.settings."org.phoebus.pv.ca/auto_addr_list" boolean[source]¶

Derive the CA address list from the available network interfaces.

Use lib.mkForce to override values from environment.epics.ca_auto_addr_list.

Default value¶

if config.environment.epics.enable
then config.environment.epics.ca_auto_addr_list
else [];

programs.phoebus-client.settingsFile absolute path or string[source]¶

Path to a settings.ini file, to be used by Phoebus.

By default, the file is generated from the settings option.

Note

Use the settingsFile option if you want to import an already existing settings.ini file. If you override this option, settings options are ignored.

May also point to a remote URL.

Default value¶

"<file generated from the 'settings' options>"

Example¶

./settings.ini