From 74e2c26549e5da160ade990e07e349bf4a981098 Mon Sep 17 00:00:00 2001
From: Guilherme Rodrigues de Lima <guilherme.lima@lnls.br>
Date: Wed, 3 Apr 2024 10:34:50 -0300
Subject: [PATCH] Add script to create parameter db file

---
 .../example_parameter_phoibos.db              | 256 ++++++++++++++++++
 etc/makeDbParameter/makeDbParameter.py        | 183 +++++++++++++
 2 files changed, 439 insertions(+)
 create mode 100644 etc/makeDbParameter/example_parameter_phoibos.db
 create mode 100644 etc/makeDbParameter/makeDbParameter.py

diff --git a/etc/makeDbParameter/example_parameter_phoibos.db b/etc/makeDbParameter/example_parameter_phoibos.db
new file mode 100644
index 0000000..9b22748
--- /dev/null
+++ b/etc/makeDbParameter/example_parameter_phoibos.db
@@ -0,0 +1,256 @@
+# Macros:
+#% macro, P, Device Prefix
+#% macro, R, Device Suffix
+#% macro, PORT, Asyn Port name
+#% macro, TIMEOUT, Timeout, default=1
+#% macro, ADDR, Asyn Port address, default=0
+
+record(longin, "$(P)$(R)NumEnergyChannels_RBV") {
+  field(DTYP, "asynInt32")
+  field(INP,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))NUMENERGYCHANNELS")
+  field(SCAN, "I/O Intr")
+  field(DISA, "0")
+}
+
+record(longout, "$(P)$(R)NumEnergyChannels") {
+  field(DTYP, "asynInt32")
+  field(OUT,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))NUMENERGYCHANNELS")
+  field(DISA, "0")
+}
+
+record(longin, "$(P)$(R)NumNonEnergyChannels_RBV") {
+  field(DTYP, "asynInt32")
+  field(INP,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))NUMNONENERGYCHANNELS")
+  field(SCAN, "I/O Intr")
+  field(DISA, "0")
+}
+
+record(longout, "$(P)$(R)NumNonEnergyChannels") {
+  field(DTYP, "asynInt32")
+  field(OUT,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))NUMNONENERGYCHANNELS")
+  field(DISA, "0")
+}
+
+record(ai, "$(P)$(R)ScreenVoltage_RBV") {
+  field(DTYP, "asynFloat64")
+  field(INP,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))SCREENVOLTAGE")
+  field(PREC, "3")
+  field(SCAN, "I/O Intr")
+  field(DISA, "0")
+}
+
+record(ao, "$(P)$(R)ScreenVoltage") {
+  field(DTYP, "asynFloat64")
+  field(OUT,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))SCREENVOLTAGE")
+  field(PREC, "3")
+  field(DISA, "0")
+}
+
+record(ai, "$(P)$(R)BiasVoltageElectrons_RBV") {
+  field(DTYP, "asynFloat64")
+  field(INP,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))BIASVOLTAGEELECTRONS")
+  field(PREC, "3")
+  field(SCAN, "I/O Intr")
+  field(DISA, "0")
+}
+
+record(ao, "$(P)$(R)BiasVoltageElectrons") {
+  field(DTYP, "asynFloat64")
+  field(OUT,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))BIASVOLTAGEELECTRONS")
+  field(PREC, "3")
+  field(DISA, "0")
+}
+
+record(ai, "$(P)$(R)BiasVoltageIons_RBV") {
+  field(DTYP, "asynFloat64")
+  field(INP,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))BIASVOLTAGEIONS")
+  field(PREC, "3")
+  field(SCAN, "I/O Intr")
+  field(DISA, "0")
+}
+
+record(ao, "$(P)$(R)BiasVoltageIons") {
+  field(DTYP, "asynFloat64")
+  field(OUT,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))BIASVOLTAGEIONS")
+  field(PREC, "3")
+  field(DISA, "0")
+}
+
+record(ai, "$(P)$(R)DetectorVoltage_RBV") {
+  field(DTYP, "asynFloat64")
+  field(INP,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))DETECTORVOLTAGE")
+  field(PREC, "3")
+  field(SCAN, "I/O Intr")
+  field(DISA, "0")
+}
+
+record(ao, "$(P)$(R)DetectorVoltage") {
+  field(DTYP, "asynFloat64")
+  field(OUT,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))DETECTORVOLTAGE")
+  field(PREC, "3")
+  field(DISA, "0")
+}
+
+record(ai, "$(P)$(R)FocusDisplacement1_RBV") {
+  field(DTYP, "asynFloat64")
+  field(INP,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))FOCUSDISPLACEMENT1")
+  field(PREC, "3")
+  field(SCAN, "I/O Intr")
+  field(DISA, "0")
+}
+
+record(ao, "$(P)$(R)FocusDisplacement1") {
+  field(DTYP, "asynFloat64")
+  field(OUT,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))FOCUSDISPLACEMENT1")
+  field(PREC, "3")
+  field(DISA, "0")
+}
+
+record(ai, "$(P)$(R)FocusDisplacement2_RBV") {
+  field(DTYP, "asynFloat64")
+  field(INP,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))FOCUSDISPLACEMENT2")
+  field(PREC, "3")
+  field(SCAN, "I/O Intr")
+  field(DISA, "0")
+}
+
+record(ao, "$(P)$(R)FocusDisplacement2") {
+  field(DTYP, "asynFloat64")
+  field(OUT,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))FOCUSDISPLACEMENT2")
+  field(PREC, "3")
+  field(DISA, "0")
+}
+
+record(ai, "$(P)$(R)CoilCurrent_RBV") {
+  field(DTYP, "asynFloat64")
+  field(INP,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))COILCURRENT")
+  field(PREC, "3")
+  field(SCAN, "I/O Intr")
+  field(DISA, "0")
+}
+
+record(ao, "$(P)$(R)CoilCurrent") {
+  field(DTYP, "asynFloat64")
+  field(OUT,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))COILCURRENT")
+  field(PREC, "3")
+  field(DISA, "0")
+}
+
+record(ai, "$(P)$(R)Lx_RBV") {
+  field(DTYP, "asynFloat64")
+  field(INP,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))LX")
+  field(PREC, "3")
+  field(SCAN, "I/O Intr")
+  field(DISA, "0")
+}
+
+record(ao, "$(P)$(R)Lx") {
+  field(DTYP, "asynFloat64")
+  field(OUT,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))LX")
+  field(PREC, "3")
+  field(DISA, "0")
+}
+
+record(ai, "$(P)$(R)ShiftX_RBV") {
+  field(DTYP, "asynFloat64")
+  field(INP,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))SHIFTX")
+  field(PREC, "3")
+  field(SCAN, "I/O Intr")
+  field(DISA, "0")
+}
+
+record(ao, "$(P)$(R)ShiftX") {
+  field(DTYP, "asynFloat64")
+  field(OUT,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))SHIFTX")
+  field(PREC, "3")
+  field(DISA, "0")
+}
+
+record(ai, "$(P)$(R)ShiftY_RBV") {
+  field(DTYP, "asynFloat64")
+  field(INP,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))SHIFTY")
+  field(PREC, "3")
+  field(SCAN, "I/O Intr")
+  field(DISA, "0")
+}
+
+record(ao, "$(P)$(R)ShiftY") {
+  field(DTYP, "asynFloat64")
+  field(OUT,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))SHIFTY")
+  field(PREC, "3")
+  field(DISA, "0")
+}
+
+record(ai, "$(P)$(R)LensShiftX_RBV") {
+  field(DTYP, "asynFloat64")
+  field(INP,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))LENSSHIFTX")
+  field(PREC, "3")
+  field(SCAN, "I/O Intr")
+  field(DISA, "0")
+}
+
+record(ao, "$(P)$(R)LensShiftX") {
+  field(DTYP, "asynFloat64")
+  field(OUT,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))LENSSHIFTX")
+  field(PREC, "3")
+  field(DISA, "0")
+}
+
+record(ai, "$(P)$(R)LensShiftY_RBV") {
+  field(DTYP, "asynFloat64")
+  field(INP,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))LENSSHIFTY")
+  field(PREC, "3")
+  field(SCAN, "I/O Intr")
+  field(DISA, "0")
+}
+
+record(ao, "$(P)$(R)LensShiftY") {
+  field(DTYP, "asynFloat64")
+  field(OUT,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))LENSSHIFTY")
+  field(PREC, "3")
+  field(DISA, "0")
+}
+
+record(ai, "$(P)$(R)AnalyzerStandbyDelay_RBV") {
+  field(DTYP, "asynFloat64")
+  field(INP,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))ANALYZERSTANDBYDELAY")
+  field(PREC, "3")
+  field(SCAN, "I/O Intr")
+  field(DISA, "0")
+}
+
+record(ao, "$(P)$(R)AnalyzerStandbyDelay") {
+  field(DTYP, "asynFloat64")
+  field(OUT,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))ANALYZERSTANDBYDELAY")
+  field(PREC, "3")
+  field(DISA, "0")
+}
+
+record(bi, "$(P)$(R)SkipDelayUp/Down_RBV") {
+  field(DTYP, "asynInt32")
+  field(INP,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))SKIPDELAYUPDOWN")
+  field(SCAN, "I/O Intr")
+  field(DISA, "0")
+}
+
+record(bo, "$(P)$(R)SkipDelayUp/Down") {
+  field(DTYP, "asynInt32")
+  field(OUT,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))SKIPDELAYUPDOWN")
+  field(DISA, "0")
+}
+
+record(ai, "$(P)$(R)MaximumCountRate_RBV") {
+  field(DTYP, "asynFloat64")
+  field(INP,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))MAXIMUMCOUNTRATE")
+  field(PREC, "3")
+  field(SCAN, "I/O Intr")
+  field(DISA, "0")
+}
+
+record(ao, "$(P)$(R)MaximumCountRate") {
+  field(DTYP, "asynFloat64")
+  field(OUT,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))MAXIMUMCOUNTRATE")
+  field(PREC, "3")
+  field(DISA, "0")
+}
+
diff --git a/etc/makeDbParameter/makeDbParameter.py b/etc/makeDbParameter/makeDbParameter.py
new file mode 100644
index 0000000..f25bc55
--- /dev/null
+++ b/etc/makeDbParameter/makeDbParameter.py
@@ -0,0 +1,183 @@
+#!/bin/env python
+import sys
+import socket
+import time
+from optparse import OptionParser
+
+socketObject = socket.socket()
+
+def connect(host):
+    print('Creating socket')
+    try:
+        socketObject.connect((host, 7010))
+        socketObject.settimeout(5)
+        print("Successful connection")
+
+    except socket.error as e:
+        print(str(e))
+        sys.exit()
+
+def sendReceive(string):
+
+    data = ""
+    string = string+"\n"
+    bytes = string.encode()
+    socketObject.send(bytes)
+    while True:
+        try:
+            data = data + socketObject.recv(1024).decode()
+            if "\n" in data:
+                data = data.replace("\n","")
+                break
+            elif not data:
+                break
+
+        except socket.timeout as e:
+            print(str(e))
+            break
+        except socket.error as e:
+            print(str(e))
+            break
+    return data
+
+def makeDb(db_filename):
+    
+    receive = sendReceive("?0000 GetAllAnalyzerParameterNames")
+    print(receive)
+    receive = receive.split("ParameterNames:")[1]
+    receive = receive[1:-1]
+    receive = receive.replace("\"", "")
+    parameters = []
+    parameters = receive.split(",")
+
+    db_file = open(db_filename, "w")
+    stdout = sys.stdout
+    sys.stdout = db_file
+    
+    print('# Macros:')
+    print('#% macro, P, Device Prefix')
+    print('#% macro, R, Device Suffix')
+    print('#% macro, PORT, Asyn Port name')
+    print('#% macro, TIMEOUT, Timeout, default=1')
+    print('#% macro, ADDR, Asyn Port address, default=0')
+    print('')
+
+    # for each node
+    for parameter in parameters:
+
+        recordname = parameter.replace("/","").replace(" ","").replace("[","").replace("]","")
+        upperparameter = parameter.replace("/","").replace(" ","").replace("[","").replace("]","").upper()
+
+        receive = sendReceive("?0000 GetAnalyzerParameterInfo ParameterName:\""+parameter+"\"")
+        receive = receive.split("OK: ")[1]
+
+        parameterinforaw = []
+        parameterinfo = {}
+
+        parameterinforaw = receive.split(" ")
+        for i in parameterinforaw:
+            if i.split(":")[0] == "Values":
+                parameterinfo[i.split(":")[0]] = i.split(":")[1][1:-1].split(",")
+            else:
+                parameterinfo[i.split(":")[0]] = i.split(":")[1]
+
+        ro = False
+        
+        if parameterinfo["ValueType"] in ["Integer", "integer"]:
+            print('record(longin, "$(P)$(R)%s_RBV") {' % recordname)
+            print('  field(DTYP, "asynInt32")')
+            print('  field(INP,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))%s")' % upperparameter)
+            print('  field(SCAN, "I/O Intr")')
+            print('  field(DISA, "0")')
+            print('}')
+            print('')
+            if ro:
+                continue        
+            print('record(longout, "$(P)$(R)%s") {' % recordname)
+            print('  field(DTYP, "asynInt32")')
+            print('  field(OUT,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))%s")' % upperparameter)
+            print('  field(DISA, "0")')
+            print('}')
+            print('')
+        
+        if parameterinfo["ValueType"] in ["Bool", "bool"]:
+            print('record(bi, "$(P)$(R)%s_RBV") {' % recordname)
+            print('  field(DTYP, "asynInt32")')
+            print('  field(INP,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))%s")' % upperparameter)
+            print('  field(SCAN, "I/O Intr")')
+            print('  field(DISA, "0")')
+            print('}')
+            print('')
+            if ro:
+                continue        
+            print('record(bo, "$(P)$(R)%s") {' % recordname)
+            print('  field(DTYP, "asynInt32")')
+            print('  field(OUT,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))%s")' % upperparameter)
+            print('  field(DISA, "0")')
+            print('}')
+            print('')
+
+        elif parameterinfo["ValueType"] in ["Double", "double"]:
+            print('record(ai, "$(P)$(R)%s_RBV") {' % recordname)
+            print('  field(DTYP, "asynFloat64")')
+            print('  field(INP,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))%s")' % upperparameter)
+            print('  field(PREC, "3")'        )
+            print('  field(SCAN, "I/O Intr")')
+            print('  field(DISA, "0")')
+            print('}')
+            print('')
+            if ro:
+                continue    
+            print('record(ao, "$(P)$(R)%s") {' % recordname)
+            print('  field(DTYP, "asynFloat64")')
+            print('  field(OUT,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))%s")' % upperparameter)
+            print('  field(PREC, "3")')
+            print('  field(DISA, "0")')
+            print('}')
+            print('')
+
+        elif parameterinfo["ValueType"] in ["String", "string"]:
+            print('record(stringin, "$(P)$(R)%s_RBV") {' % recordname)
+            print('  field(DTYP, "asynOctetRead")')
+            print('  field(INP,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))%s")' % upperparameter)
+            print('  field(SCAN, "I/O Intr")')
+            print('  field(DISA, "0")')
+            print('}')
+            print('')
+            if ro:
+                continue
+            print('record(stringout, "$(P)$(R)%s") {' % recordname)
+            print('  field(DTYP, "asynOctetWrite")')
+            print('  field(OUT,  "@asyn($(PORT),$(ADDR=0),$(TIMEOUT=1))%s")' % upperparameter)
+            print('  field(DISA, "0")')
+            print('}')
+            print('')
+
+        else:
+            print("#Don't know what to do with parameter %s, value type %s" %parameter,parameterinfo["ValueType"])
+            print('')
+
+    db_file.close()     
+    sys.stdout = stdout
+
+# parse args
+parser = OptionParser("""%prog <ip_server> <db_filename>
+This script creates the database file of device parameters used in SpecsLab Prodigy Remote Control""")
+options, args = parser.parse_args()
+
+if len(args) != 2:
+    parser.error("Incorrect number of arguments")
+else:
+    connect(args[0])
+    status = sendReceive("?0000 Connect")
+    print(status)
+    if "OK" in status:
+        makeDb(args[1])
+        print("Db parameters created successfully")
+        sendReceive("?0000 Disconnect")
+    else:
+        print("Connection Error")
+
+socketObject.close()
+print("Finish")
+sys.exit()