Skip to content

Latest commit

 

History

History
167 lines (110 loc) · 4.29 KB

Phoebus.md

File metadata and controls

167 lines (110 loc) · 4.29 KB

phoebus-env

Configuration Environment for phoebus at https://github.com/ControlSystemStudio/phoebus

Prerequired Packages

git make sudo tree maven

A typical example to build and run the Phoebus

The following rules work in most Linux distribution and MacOS Big Sur (x86_64). In addtion, there are three additional rules for the MacOS. One is shown in the later in this document, and others are shown in docs/PhoebusOnAppleM1.md. For Windows, please see the below instruction.

make init
make build.phoebus
make prop.phoebus
make install.phoebus
source scripts/activate-phoebus
xPhoebus

macOS (M1)

make init
make conf.macos
make build.phoebus
make prop.phoebus
make install.phoebus
source scripts/activate-phoebus
xPhoebus

Makefile Rules

make init

  • Download the fastest phoebus source

  • Switch to a specific version defined in $(SRC_TAG) in configure/RELEASE

make init

make patch if patch files exist

  • Apply patch files if patch files exist in patch

  • Each patch file is an unique SRC_TAG prefix.

make patchrevert

  • Revert applied patch files if patch files exist in patch

  • Each patch file is an unique SRC_TAG prefix.

make build.phoebus

  • Build the default community phoebus, located in phoebus-src/phoebus-product/target.

  • This rule builds everything in phoebus-src include all alarm services.

make prop.phoebus

  • Generate phoebus setting file phoebus_settings.ini locate in site-template path based on repository configuration. One can check the most important configuration variables via
make vars
make vars FILTER=PS_

Please check site-template/phoebus_settings.ini file to match your environment. This rule is independent one, so any others cannot modify this file, so the local modification is safe. One can put its own settings.ini in site-template path. In this case, please don't run this command, but run install.phoebus directly.

make install.phoebus

  • sudo permission may be required.

  • Install all phoebus files into INSTALL_LOCATION_PHOEBUS defined in configure/CONTIG_SITE and configure/CONFIG_TARGET

  • one can check after execute this rule, what they are in, make exist or make exist.phoebus

tree -aL 1 /opt/phoebus-products/phoebus
/opt/phoebus-products/phoebus
├── activate-phoebus
├── bin
├── lib
├── phoebus.jar
├── phoebus_logback.xml
├── phoebus_logging.properties
├── phoebus_settings.ini
├── phoebus.sh
├── product-phoebus.jar -> /opt/phoebus-products/phoebus/phoebus.jar
└── .versions
  • Expand its tree level with make exist.phoebus LEVEL=2
  • Prerequirement of this rule is make sh.phoebus which generates two files
  • If the exist phoebus path is found, the exist one will be renamed to phoebus_backup_YYMMDD-HHMMSS.

make sh.phoebus

  • PHOEBUS_SHELL and PHOEBUS_ACTIVATE in configure/CONFIG_OPTS_PHOEBUS.
  • With make install.phoebus, this rule generate two files : activate-phoebus and xphoebus in scripts path.
souce scripts/activate-phoebus
xPhoebus

That activate-phoebus is also installed in INSTALL_LOCATION_PHOEBUS. The installation location of xpheobus is INSTALL_LOCATION_PHOEBUS/bin. In addtion. the genric phoebus.sh is installed in INSTALL_LOCATION_PHOEBUS, however we don't add the path to PATH in activate-phoebus.

For Mac and Windows Builds

Phoebus is very easy to build cross platform. See [4].

To build a Phoebus windows product and create a zip file in $(TOP), run this command:

make windows

To build a tarball Phoebus product for Mac in $(TOP), run this command:

make mac

Upcoming feature based on nsls2-phoebus

  • Build the ALS Windows products
make windows.als
  • Build the ALS home Linux edition
make linux.als.home
  • Install the ALS accelerator edition
make init
make patch
make build.phoebus
make prop.phoebus
make install.phoebus.als

References

[1] https://github.com/ControlSystemStudio/phoebus

[2] https://github.com/shroffk/nsls2-phoebus

[3] https://github.com/kasemir/phoebus-sns

[4] https://github.com/controlSystemStudio/phoebus#cross-platform-build