Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .github/workflows/_lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ jobs:
with:
persist-credentials: false
- uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1
- uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd
- uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ phoebus-product/settings_template.ini
# hs_err* files
**/hs_err*

# doc files generated by docs/source/conf.py
# doc files generated by docs/source/conf.py
docs/source/applications.rst
docs/source/services.rst

Expand Down
9 changes: 5 additions & 4 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@ repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v6.0.0
hooks:
- id: check-yaml
# TODO add end of file fixer and whitespace fixer
- id: check-yaml
- id: end-of-file-fixer
- id: trailing-whitespace
- repo: https://github.com/zizmorcore/zizmor-pre-commit
rev: v1.26.1
rev: v1.26.1
hooks:
- id: zizmor
- id: zizmor
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Copyright (c) 2018 Michigan State University
Copyright (c) 2018 Brookhaven National Laboratory
Copyright (c) 2018 Oak Ridge National Laboratory.
Copyright (c) 2018 European Spallation Source
Copyright (c) 2018 European Spallation Source

Eclipse Public License - v 1.0

Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ mvn clean verify -f dependencies/pom.xml

## Building with maven

Define the JAVA_HOME environment variable to point to your Java installation directory.
Define the JAVA_HOME environment variable to point to your Java installation directory.
Mac OS users should use something like:
```
export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk-21.0.11+10/Contents/Home
Expand Down Expand Up @@ -52,7 +52,7 @@ Set the environment variable `LANG` to `en_US.UTF-8`
to execute tests in a specific locale,
or build with `mvn -DskipTests ...` to skip tests.

### Running the phoebus application
### Running the phoebus application

To run the product jar
```
Expand Down Expand Up @@ -253,20 +253,20 @@ Create a sonatype account and update the maven settings.xml file with your sonat
</servers>
```

**Prepare the release**
`mvn release:prepare`
**Prepare the release**
`mvn release:prepare`
In this step will ensure there are no uncommitted changes, ensure the versions number are correct, tag the scm, etc.
A full list of checks is documented [here](https://maven.apache.org/maven-release/maven-release-plugin/usage/prepare-release.html).

**Perform the release**
`mvn -Darguments="-Dskip-executable-jar" -Pdocs,releases release:perform`
**Perform the release**
`mvn -Darguments="-Dskip-executable-jar" -Pdocs,releases release:perform`
Checkout the release tag, build, sign and push the build binaries to sonatype. The `docs` profile is needed in order
to create required javadocs jars.

**Publish**
**Publish**
Open the staging repository in [sonatype](https://s01.oss.sonatype.org/#stagingRepositories) and hit the *publish* button

**Note:**
In order to keep the ant and maven builds in sync, before the prepare:release update the `version` in the
dependencies\ant_settings.xml to match the release version number. After the release is completed the `version` should
In order to keep the ant and maven builds in sync, before the prepare:release update the `version` in the
dependencies\ant_settings.xml to match the release version number. After the release is completed the `version` should
updated to match the next development snapshotData version.
2 changes: 1 addition & 1 deletion app/3d-viewer/build.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@
</jar>
</target>

</project>
</project>
66 changes: 33 additions & 33 deletions app/3d-viewer/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Overview

The 3d Viewer is a tool that allows users to configure 3 dimensional structures using spheres, cylinders, and boxes.

These structures are defined in shape file (`*.shp`) and parsed by the application.
These structures are defined in shape file (`*.shp`) and parsed by the application.

The resultant structure is then rendered on screen. This structure can be viewed in the application which allows rotation, zoom, and movement.

Expand All @@ -23,68 +23,68 @@ structure will be rendered.

**Background Color**
The background color of the viewer can be controlled using the following command.

``background(r, g, b, A)``
This command has four parameters. The red, green, and blue values for the color are the first three. Each color value is an integer from 0 through 255.

This command has four parameters. The red, green, and blue values for the color are the first three. Each color value is an integer from 0 through 255.
These are followed by the alpha value which allows you to control the transparency of the color. Alpha is a floating point number in the range [0, 1].
An alpha of 0 is transparent while an alpha of 1 is opaque.

Multiple background colors may be defined, however only the last defined background color will be used.

**Spheres**
A sphere may be defined using the following command.

``sphere(x, y, z, R, r, g, b, A)``

This command has eight parameters. The first three parameters are the x, y, and z values which represent the center point of the sphere in the three dimensional space.
The x, y, and z parameters are floating point values. These are followed by the radius of the sphere, another floating point value.
The final four parameters are the red, green, blue, and alpha values used to define the color of the sphere. Red, green, and blue are integer values in [0, 255] and
The final four parameters are the red, green, blue, and alpha values used to define the color of the sphere. Red, green, and blue are integer values in [0, 255] and
alpha is a floating point value in [0, 1].

**Cylinders**
A cylinder may be defined using the following command.

``cylinder(x1, y1, z1, x2, y2, z2, R, r, g, b, A)``
This command has eleven parameters. The first three parameters are the x, y, and z values which represent one end point of the cylinder. The second three parameters
are the x, y, and z values which represent the other end point of the cylinder. All x, y, and z parameters are floating point values. These are followed the cylinder's
radius. The radius is a floating point value. The final four parameters are the red, green, blue, and alpha values used to define the color of the sphere. Red, green,

This command has eleven parameters. The first three parameters are the x, y, and z values which represent one end point of the cylinder. The second three parameters
are the x, y, and z values which represent the other end point of the cylinder. All x, y, and z parameters are floating point values. These are followed the cylinder's
radius. The radius is a floating point value. The final four parameters are the red, green, blue, and alpha values used to define the color of the sphere. Red, green,
and blue are integer values in [0, 255] and alpha is a floating point value in [0, 1].

**Boxes**
A box may be defined using the following command.

``box(x1, y1, z1, x2, y2, z2, r, g, b, A)``
This command has 10 parameters. The first three parameters are the x, y, and z values which represent one corner of the box.The second three parameters are the x, y, and z
values which represent the opposite corner of the box. All x, y, and z parameters are floating point values. The final four parameters are the red, green, blue, and alpha

This command has 10 parameters. The first three parameters are the x, y, and z values which represent one corner of the box.The second three parameters are the x, y, and z
values which represent the opposite corner of the box. All x, y, and z parameters are floating point values. The final four parameters are the red, green, blue, and alpha
values used to define the color of the sphere. Red, green, and blue are integer values in [0, 255] and alpha is a floating point value in [0, 1].

If the first corner of a box was defined at (0, 0, 0) and the second corner at (100, 100, 100) then the box would have one corner at the origin and one corner at (100, 100, 100).
Each of the boxes sides would be of length 100, and the boxes center point would be (50, 50, 50).

**Cones**
A cone may be defined using the following command.

``cone(x1, y1, z1, R, x2, y2, z2, r, g, b, A)``

This command has eleven parameters.
The first three parameters are the x, y, and z values of the base, followed by the radius of the base.
The second three parameters are the x, y, and z values of the tip of the cone.
The second three parameters are the x, y, and z values of the tip of the cone.
The final four parameters are the red, green, blue, and alpha values used to define the color.

**Tool Tips**
A final string added to a shape defines a tool tip for the shape.


Example Shape File
------------------

::

# This is a comment. It will be ignored when the file is parsed.

# The background of the viewer is set to be nearly black.
background(32, 32, 32, 1)

Expand All @@ -103,10 +103,10 @@ Example Shape File
# being of magnitude 100.
box(0, 0, 0, 100, 100, 100, 0, 0, 255, 1)

# Cone along the X axis, base at x=200, radius 20, tip at x=300
# Cone along the X axis, base at x=200, radius 20, tip at x=300
cone ( 200, 0, 0, 10, 300, 0, 0, 255, 100, 100, 1, "X")


**Resulting Structure**

.. image:: images/example_struct.png
Expand All @@ -117,29 +117,29 @@ Transparency
JavaFX does not sort 3D objects by depth. What this means is that you have to be thoughtful of the order you add 3D shapes to a scene. For example, if a sphere needed to be displayed
inside a translucent box, the sphere would have to be added *before* the box. If the box first were added first, it would still be translucent, but the JavaFX renderer would not draw
the sphere because it doesn't sort the scene graph by depth.

**Examples**

Here, the box is added first and the sphere is not drawn.
::

background(32, 32, 32, 1)
box(0, 0, 0, 100, 100, 100, 0, 0, 255, 0.1)
sphere(50, 50, 50, 10, 255, 0, 0, 1)

.. image:: images/bad_transparency.png
:width: 50%

Here, the box is added second and the sphere is drawn correctly.
::

background(32, 32, 32, 1)
sphere(50, 50, 50, 10, 255, 0, 0, 1)
box(0, 0, 0, 100, 100, 100, 0, 0, 255, 0.1)

.. image:: images/good_transparency.png
:width: 50%


Compatibility
-------------
Expand All @@ -160,4 +160,4 @@ Can be made to work:

In case of problems which usually include error messages
``System can't support ConditionalFeature.SCENE3D``,
start the program with ``-Dprism.verbose=true`` and ``-Djdk.gtk.verbose=true``
start the program with ``-Dprism.verbose=true`` and ``-Djdk.gtk.verbose=true``
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,3 @@ sphere( 0, 100, 100, 10, 255, 0, 0, 1)
sphere(100, 100, 100, 10, 255, 0, 0, 1)

box(0, 0, 0, 100, 100, 100, 0, 0, 255, 1)

Original file line number Diff line number Diff line change
@@ -1 +1 @@
org.phoebus.applications.viewer3d.Viewer3dApp
org.phoebus.applications.viewer3d.Viewer3dApp
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
org.phoebus.applications.viewer3d.Viewer3dMenuEntry
org.phoebus.applications.viewer3d.InstallExamplesMenuEntry
org.phoebus.applications.viewer3d.InstallExamplesMenuEntry
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ public class Demo3dViewer extends ApplicationWrapper
public void start(Stage primaryStage) throws Exception
{
Viewer3dPane viewerPane = new Viewer3dPane(null, null);

Scene scene = new Scene(viewerPane, 1000, 1000);
primaryStage.setScene(scene);
primaryStage.show();
}

public static void main(String[] args)
{
launch(Demo3dViewer.class, args);
Expand Down
9 changes: 4 additions & 5 deletions app/alarm/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ If the following "First steps" generate errors of the type
or

ERROR ..TimeoutException: Timed out waiting for a node assignment

then define the host name in `config/server.properties`.
For tests, you can use localhost:

Expand Down Expand Up @@ -115,14 +115,14 @@ but simply meant to learn about Kafka or to test connectivity.

# Create new topic
kafka/bin/kafka-topics.sh --bootstrap-server localhost:9092 --create --replication-factor 1 --partitions 1 --topic test

# Topic info
kafka/bin/kafka-topics.sh --bootstrap-server localhost:9092 --list
kafka/bin/kafka-topics.sh --bootstrap-server localhost:9092 --describe
kafka/bin/kafka-topics.sh --bootstrap-server localhost:9092 --describe --topic test
kafka/bin/kafka-configs.sh --bootstrap-server localhost:9092 --entity-type topics --describe
# Produce messages for topic (no key)

# Produce messages for topic (no key)
kafka/bin/kafka-console-producer.sh --broker-list localhost:9092 --topic test
Message 1
Message 2
Expand Down Expand Up @@ -569,4 +569,3 @@ When functional, the file `kafka/logs/log-cleaner.log` shows periodic compaction
Start size: 0.1 MB (414 messages)
End size: 0.1 MB (380 messages)
8.9% size reduction (8.2% fewer messages)

4 changes: 2 additions & 2 deletions app/alarm/audio-annunciator/build.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@
<pathelement path="../model/${build}/app-alarm-ui-${version}.jar"/>
</classpath>
</javac>

<jar destfile="${build}/app-alarm-audio-annunciator-${version}.jar">
<fileset dir="${classes}"/>
<fileset dir="${resources}"/>
</jar>
</target>

</project>
4 changes: 2 additions & 2 deletions app/alarm/datasource/build.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@
<pathelement path="../model/${build}/app-alarm-model-${version}.jar"/>
</classpath>
</javac>

<jar destfile="${build}/app-alarm-datasource-${version}.jar">
<fileset dir="${classes}"/>
<fileset dir="${resources}"/>
</jar>
</target>

</project>
Original file line number Diff line number Diff line change
Expand Up @@ -106,4 +106,4 @@ public Optional<String> getField()
{
return field;
}
}
}
Original file line number Diff line number Diff line change
@@ -1 +1 @@
org.phoebus.pv.alarm.AlarmPVFactory
org.phoebus.pv.alarm.AlarmPVFactory
Original file line number Diff line number Diff line change
Expand Up @@ -157,4 +157,4 @@ public void parseFields()
alarmPVInfo.getField(),
"Failed to parse the field path info for pv: " + onlyRoot);
}
}
}
2 changes: 1 addition & 1 deletion app/alarm/examples/alarm_configuration.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -88,4 +88,4 @@
<xs:element name="delay" type="xs:integer" />
<xs:element name="title" type="xs:string" />
<xs:element name="detail" type="xs:string" />
</xs:schema>
</xs:schema>
1 change: 0 additions & 1 deletion app/alarm/examples/delete_alarm_topics.sh
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,3 @@ for topic in "$1" "${1}Command" "${1}Talk"
do
kafka/bin/kafka-topics.sh --bootstrap-server localhost:9092 --delete --topic $topic
done

1 change: 0 additions & 1 deletion app/alarm/examples/kafka.service
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,3 @@ ExecStop=/opt/kafka/bin/kafka-server-stop.sh

[Install]
WantedBy=multi-user.target

3 changes: 1 addition & 2 deletions app/alarm/examples/monitor_topic.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,4 @@ fi

topic=$1

kafka/bin/kafka-console-consumer.sh --bootstrap-server localhost:9092 --property print.timestamp=true --property print.key=true --property key.separator=": " --topic $topic --from-beginning

kafka/bin/kafka-console-consumer.sh --bootstrap-server localhost:9092 --property print.timestamp=true --property print.key=true --property key.separator=": " --topic $topic --from-beginning
2 changes: 0 additions & 2 deletions app/alarm/examples/send_commands.sh
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,3 @@ echo "restart!"
echo "shutdown!"

kafka/bin/kafka-console-producer.sh --broker-list localhost:9092 --property 'parse.key=true' --property 'key.separator=!' --topic $topic


3 changes: 1 addition & 2 deletions app/alarm/examples/stop_all.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
#!/bin/sh
cd kafka
bin/kafka-server-stop.sh
bin/kafka-server-stop.sh
sleep 5
bin/zookeeper-server-stop.sh

Loading
Loading