Skip to content

Commit c3c1045

Browse files
committed
Update version and readme
1 parent 1a31bbb commit c3c1045

File tree

2 files changed

+20
-2
lines changed

2 files changed

+20
-2
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,28 @@
22

33
Repository based on work from @iclegrand in repository: https://github.com/iclegrand/AliDip2BK
44

5-
Projects consumes selected messages from the CERN DIP system (LHC & ALICE -DCS) and publishes them into the O2 systems. A detailed description for this project is provided by Roberto in this document:
5+
The BKP-LHC Client is a java based application which uses the CERN DIP `jar` dependency to consume events from desired tracks. These events are then either:
6+
- published on O2 Kafka Topics to be consumed further by O2 applications (e.g. ECS)
7+
- updates the O2 Bookkeeping application via their HTTP endpoints.
8+
9+
A detailed description for this project is provided by Roberto in this document:
610
https://codimd.web.cern.ch/G0TSXqA1R8iPqWw2w2wuew
711

12+
### Published Events
13+
Currently the BKP-LHC-Client publishes on Kafka (topic: "dip.lhc.beam_mode") events for the start and end of stable beams in the format of `Ev_BeamModeEvent`. The proto file's source of truth is within the [Control Repository](https://github.com/AliceO2Group/Control/blob/master/common/protos/events.proto)
14+
815
### Requirements
916
- This program requires java 11 on a 64 bit system (this is a constrain from the DIP library)
1017
- maven
18+
-
19+
### Configuration
20+
The run configuration is defined in the `AliDip2BK.properties` file.
1121

1222
### Maven Commands for dev,tst,deployments
1323
```bash
1424
mvn <clean> compile -Dos.version={os_version}
1525
mvn <clean> package -Dos.version={os_version}
26+
mvn tst -Dos.version={os_version}
1627
```
1728

1829
E.g. os_version `macosx-x86_64`

pom.xml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<maven.compiler.target>16</maven.compiler.target>
1414
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
1515
<os.version>linux-x86_64</os.version>
16-
<cern.dip.version>5.7.0</cern.dip.version>
16+
<cern.dip.version>2.7.0</cern.dip.version>
1717
<protobuf.version>4.29.3</protobuf.version>
1818
<kafka.version>3.1.0</kafka.version>
1919
<slf4j-api.version>1.7.30</slf4j-api.version>
@@ -47,6 +47,13 @@
4747
<groupId>org.slf4j</groupId>
4848
<artifactId>slf4j-simple</artifactId>
4949
<version>${slf4j-simple.version}</version>
50+
</dependency>
51+
<!-- Test Dependencies -->
52+
<dependency>
53+
<groupId>org.junit.jupiter</groupId>
54+
<artifactId>junit-jupiter</artifactId>
55+
<version>5.13.4</version>
56+
<scope>test</scope>
5057
</dependency>
5158
</dependencies>
5259

0 commit comments

Comments
 (0)