Update documentation for Release 1.0

LICENSE

@@ -1,8 +1,8 @@
 Copyright and License Terms
 ---------------------------
 
+Copyright (c) 2024 Oak Ridge National laboratory
 Copyright (c) 2022 Brookhaven National Laboratory
-Copyright (c) 2023 Oak Ridge National laboratory
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
@@ -34,8 +34,8 @@ Additional Disclaimers
 
 This software is copyright in part by these institutions:
 
-* Brookhaven Science Associates, as Operator of Brookhaven National Laboratory
 * UT-Battelle, as Operator of Oak Ridge National Laboratory
+* Brookhaven Science Associates, as Operator of Brookhaven National Laboratory
 
 In no event shall these institutions be liable to any party for direct,
 indirect, special, incidental, or consequential damages arising out of

README.md

@@ -12,10 +12,11 @@ Notes:
 * Depends on the [CPR](https://github.com/libcpr/cpr) verson 1.9.1.
 * Depends on the [json](https://github.com/nlohmann/json) version v3.11.2.
 * Developed with ADCore R3-11 and ADSupport R1-10 or newer.
-* This has only been tested on ubuntu 18.04 and 20.04 Linux 64-bit machines.
-* This has only been developed for 2 x 2 chips layout, since that is what I have access to now
-* This has only been tested with serval version 3.0.0. 
-* Driver is specific to Serval version, since features differ.
+* This has only been developed/tested on ubuntu 22.04, 20.04, 18.04, RHEL 7.9, RHEL 9.1 Linux 64-bit machines.
+* This has only been developed for 2 x 2 chips layout and 1 chip tpx3CAM, since that is what I have access to now.
+* This has been tested with serval version 3.3.0, 3.2.0, 3.1.0 and 3.0.0. Only most recent serval version(s) are tested extensivly.
+* Driver is specific to Serval version, since features differ. Driver for Serval 2.6 is in separate branch, and is not under current development
+* The driver has been developed using TimePix3 Emulator, and real detectors.
 
 Before compiling:
 -----------------
@@ -28,9 +29,10 @@ How to run:
 
 * Under `ADTimePix3/iocs/tpx3IOC/iocBoot/iocTimePix` there is already a ready to use IOC for the TimePix3
   - run serval
-  - Change the IP address in `st.cmd`.
+  - Change the IP address in `st.cmd` or `st_base.cmd`.
   - Run `./st.cmd`.
-* There are CSS-Boy, screens under `areaDetector/tpx3App/op/` [TODO - update for serval 3.0.0].
+* There are CSS-Boy, screens under `ADTimePix3/tpx3App/op/`
+  - Phoebus .bob screens have been converted/created but not yet included in the driver.
 
 Adjust chip thresholds
 ----------------

RELEASE.md

@@ -1,20 +1,26 @@
 ADTimePix3 Releases
 ==================
 
-The latest untagged master branch can be obtained at
-https://github.com/kgofron/ADTimePix3.
-
-Tagged source code can be obtained at
-https://github.com/kgofron/ADTimePix3/tags
+The repository was transferred a while back to 
+https://github.com/areaDetector/ADTimePix3
 
 There are currently only pre-releases for ADTimePix3
 Since Serval features differ the driver is specific to Serval version. 
 Different branches of ADTimePix3 support differnet Serval versions.
-The master branch (under development) is for Serval 3.0.0
+The master branch (under development) is for Serval 3.3.0
 
 
 Driver depends on Serval versions, at this time. The current releases support Serval 3.0.0-3.3.0
 
+R1-0 (August 17, 2024)
+* Chips DACs voltages settings use atomic function. The DACs voltages must be written at the same time (serval constraint).
+    * Two chips DACs voltages have PVs for setting values, but support for changing any of the 18 voltages can be added with new `writeDac()` rewrite.
+        * Vthreshold_coarse
+        * Vthreshold_fine
+* Another rewrite of the layout image rotation [not working, checking with ASI]
+    * There are 8 possible image rotation modes
+* The Phoebus .bob screens are converted/created, but not yet included in the driver.
+
 R0-9 (February 25, 2024)
 * Multiple raw streams (Serval 3.3.0 support)
     * raw can be .tpx3 file

docs/ADTimePix3/ADTimePix3.rst

@@ -2,7 +2,7 @@
 ADTimePix3
 ======================================
 
-:author: Kazimierz Gofron, Brookhaven National Laboratory
+:author: Kazimierz Gofron, Oak Ridge National Laboratory
 
 .. contents:: Contents
 
@@ -12,10 +12,11 @@ Notes
 * Depends on the CPR verson 1.9.1.
 * Depends on the json version v3.11.2.
 * Developed with ADCore R3-11 and ADSupport R1-10 or newer.
-* This has only been tested on ubuntu 18.04 and 20.04 Linux 64-bit machines.
-* This has only been developed for 2 x 2 chips layout, since that is what I have access to now
-* This has only been tested with serval version 3.0.0.
-* Driver is specific to Serval version, since features differ.
+* This has only been developed/tested on ubuntu 22.04, 20.04, 18.04, RHEL 7.9, RHEL 9.1 Linux 64-bit machines.
+* This has only been developed for 2 x 2 chips layout and 1 chip tpx3CAM, since that is what I have access to now.
+* This has been tested with serval version 3.3.0, 3.2.0, 3.1.0 and 3.0.0. Only most recent serval version(s) are tested extensivly.
+* Driver is specific to Serval version, since features differ. Driver for Serval 2.6 is in separate branch, and is not under current development
+* The driver has been developed using TimePix3 Emulator, and real detectors.
 
 Before compiling
 ----------------
@@ -30,11 +31,14 @@ How to run
 
   #. run serval
 
-  #. Change the IP address in st.cmd 
+  #. Change the IP address in st.cmd or st_base.cmd
 
   #. Run ./st.cmd
 
-* There are CSS-Boy, screens under areaDetector/tpx3App/op/ [TODO - update for serval 3.0.0].
+* There are CSS-Boy, screens under TimePix3/tpx3App/op/.
+
+  #. Phoebus .bob screens have been converted/created but not yet included in the driver.
+
 
 Adjust chip thresholds
 ----------------------