Merge pull request #790 from lnls-sirius/add-injctrl

Add injection control IOC
lnls-sirius · Feb 4, 2022 · a0cdafe · a0cdafe
2 parents 1473725 + 79aaf5a
commit a0cdafe
Show file tree

Hide file tree

Showing 3 changed files with 1,252 additions and 0 deletions.
diff --git a/siriuspy/siriuspy/injctrl/__init__.py b/siriuspy/siriuspy/injctrl/__init__.py
@@ -0,0 +1 @@
+"""Injection control subpackage."""
diff --git a/siriuspy/siriuspy/injctrl/csdev.py b/siriuspy/siriuspy/injctrl/csdev.py
@@ -0,0 +1,235 @@
+"""Injection Control App."""
+
+from .. import csdev as _csdev
+from ..devices import InjSysStandbyHandler as _InjSysHandler, \
+    EGun as _EGun
+
+
+# --- Enumeration Types ---
+
+class ETypes(_csdev.ETypes):
+    """Local enumerate types."""
+
+    INJMODE = ('Decay', 'TopUp')
+    INJTYPE_SEL = ('SingleBunch', 'MultiBunch')
+    INJTYPE_STS = ('SingleBunch', 'MultiBunch', 'Undefined')
+    TOPUPSTS = (
+        'Off', 'Waiting', 'TurningOn', 'Injecting', 'TurningOff')
+    INJSYSCMDSTS = ('Idle', 'On', 'Off')
+
+
+_et = ETypes
+
+
+# --- Const class ---
+
+class Const(_csdev.Const):
+    """Const class."""
+
+    InjMode = _csdev.Const.register('InjMode', _et.INJMODE)
+    InjTypeSel = _csdev.Const.register('InjTypeSel', _et.INJTYPE_SEL)
+    InjTypeSts = _csdev.Const.register('InjTypeSts', _et.INJTYPE_STS)
+    TopUpSts = _csdev.Const.register('TopUpSts', _et.TOPUPSTS)
+    InjSysCmdSts = _csdev.Const.register('InjSysCmdSts', _et.INJSYSCMDSTS)
+
+    GEN_STATUS_LABELS = ('LI', 'TB', 'BO', 'TS', 'SI', 'AS')
+    LI_STATUS_LABELS = ('Egun', 'PS', 'PU', 'RF', 'TI')
+    TL_STATUS_LABELS = ('PS', 'PU', 'TI')
+    SR_STATUS_LABELS = ('PS', 'PU', 'RF', 'TI')
+    AS_STATUS_LABELS = ('TI', )
+    INJ_STATUS_LABELS = (
+        'TI ContinuousEvt is off',
+        'BucketList not synced',
+        'EGBiasPS voltage diff. from desired',
+        'EGFilaPS current diff. from op.value',
+        'EGHVPS voltage diff. from op.value',
+        'EGPulsePS setup is diff. from desired',
+        'EGTriggerPS is off',
+        'Inj.System is not on',
+    )
+
+    MIN_BKT = 1
+    MAX_BKT = 864
+
+    RF_RMP_TIMEOUT = 3*60  # [s]
+    TI_INJ_TIMEOUT = 3*60  # [s]
+
+
+_ct = Const
+
+
+def get_status_labels(sec=''):
+    """Return Status Labels enum."""
+    if sec == 'LI':
+        return _ct.LI_STATUS_LABELS
+    if sec in ['TB', 'TS']:
+        return _ct.TL_STATUS_LABELS
+    if sec in ['BO', 'SI']:
+        return _ct.SR_STATUS_LABELS
+    if sec == 'AS':
+        return _ct.AS_STATUS_LABELS
+    if sec == 'Inj':
+        return _ct.INJ_STATUS_LABELS
+    return _ct.GEN_STATUS_LABELS
+
+
+# --- Databases ---
+
+
+def get_injctrl_propty_database():
+    """Return property database of injection control IOC."""
+    # injsys properties
+    injsys_onorder = ','.join(_InjSysHandler.DEF_ON_ORDER)
+    injsys_offorder = ','.join(_InjSysHandler.DEF_OFF_ORDER)
+    # egun properties
+    egsbbias = _EGun.BIAS_SINGLE_BUNCH
+    egmbbias = _EGun.BIAS_MULTI_BUNCH
+    egfilacurr = _EGun.FILACURR_OPVALUE
+    eghvolt = _EGun.HV_OPVALUE
+
+    dbase = {
+        'Version-Cte': {'type': 'str', 'value': 'UNDEF'},
+        'Log-Mon': {'type': 'str', 'value': 'Starting...'},
+
+        'Mode-Sel': {
+            'type': 'enum', 'value': _ct.InjMode.Decay,
+            'enums': _et.INJMODE},
+        'Mode-Sts': {
+            'type': 'enum', 'value': _ct.InjMode.Decay,
+            'enums': _et.INJMODE},
+        'Type-Sel': {
+            'type': 'enum', 'value': _ct.InjTypeSel.MultiBunch,
+            'enums': _et.INJTYPE_SEL},
+        'Type-Sts': {
+            'type': 'enum', 'value': _ct.InjTypeSts.Undefined,
+            'enums': _et.INJTYPE_STS},
+        'SglBunBiasVolt-SP': {
+            'type': 'float', 'value': egsbbias, 'prec': 1,
+            'unit': 'V', 'lolim': -150.0, 'hilim': 0.0},
+        'SglBunBiasVolt-RB': {
+            'type': 'float', 'value': egsbbias, 'prec': 1,
+            'unit': 'V', 'lolim': -150.0, 'hilim': 0.0},
+        'MultBunBiasVolt-SP': {
+            'type': 'float', 'value': egmbbias, 'prec': 1,
+            'unit': 'V', 'lolim': -150.0, 'hilim': 0.0},
+        'MultBunBiasVolt-RB': {
+            'type': 'float', 'value': egmbbias, 'prec': 1,
+            'unit': 'V', 'lolim': -150.0, 'hilim': 0.0},
+        'FilaOpCurr-SP': {
+            'type': 'float', 'value': egfilacurr, 'prec': 3,
+            'unit': 'A', 'lolim': 0.0, 'hilim': 1.5},
+        'FilaOpCurr-RB': {
+            'type': 'float', 'value': egfilacurr, 'prec': 3,
+            'unit': 'A', 'lolim': 0.0, 'hilim': 1.5},
+        'HVOpVolt-SP': {
+            'type': 'float', 'value': eghvolt, 'prec': 3,
+            'unit': 'kV', 'lolim': 0.0, 'hilim': 95.0},
+        'HVOpVolt-RB': {
+            'type': 'float', 'value': eghvolt, 'prec': 3,
+            'unit': 'kV', 'lolim': 0.0, 'hilim': 95.0},
+        'TargetCurrent-SP': {
+            'type': 'float', 'value': 100.0, 'unit': 'mA',
+            'prec': 2, 'lolim': 0.0, 'low': 0.0, 'lolo': 0.0,
+            'hilim': 500.0, 'high': 500.0, 'hihi': 500.0},
+        'TargetCurrent-RB': {
+            'type': 'float', 'value': 100.0, 'unit': 'mA',
+            'prec': 2, 'lolim': 0.0, 'low': 0.0, 'lolo': 0.0,
+            'hilim': 500.0, 'high': 500.0, 'hihi': 500.0},
+        'BucketListStart-SP': {
+            'type': 'int', 'value': 1, 'unit': 'bucket index',
+            'lolim': _ct.MIN_BKT, 'hilim': _ct.MAX_BKT},
+        'BucketListStart-RB': {
+            'type': 'int', 'value': 1, 'unit': 'bucket index',
+            'lolim': _ct.MIN_BKT, 'hilim': _ct.MAX_BKT},
+        'BucketListStop-SP': {
+            'type': 'int', 'value': 864, 'unit': 'bucket index',
+            'lolim': _ct.MIN_BKT, 'hilim': _ct.MAX_BKT, },
+        'BucketListStop-RB': {
+            'type': 'int', 'value': 864, 'unit': 'bucket index',
+            'lolim': _ct.MIN_BKT, 'hilim': _ct.MAX_BKT},
+        'BucketListStep-SP': {
+            'type': 'int', 'value': 15, 'unit': 'buckets',
+            'lolim': -_ct.MAX_BKT+1, 'hilim': _ct.MAX_BKT-1},
+        'BucketListStep-RB': {
+            'type': 'int', 'value': 15, 'unit': 'buckets',
+            'lolim': -_ct.MAX_BKT+1, 'hilim': _ct.MAX_BKT-1},
+
+        'TopUpState-Sel': {
+            'type': 'enum', 'value': _ct.OffOn.Off, 'enums': _et.OFF_ON},
+        'TopUpState-Sts': {
+            'type': 'enum', 'value': _ct.TopUpSts.Off, 'enums': _et.TOPUPSTS},
+        'TopUpPeriod-SP': {
+            'type': 'int', 'value': 15*60, 'unit': 's',
+            'lolim': 30, 'hilim': 6*60*60},
+        'TopUpPeriod-RB': {
+            'type': 'int', 'value': 15*60, 'unit': 's',
+            'lolim': 30, 'hilim': 6*60*60},
+        'TopUpNextInj-Mon': {
+            'type': 'float', 'value': 0.0, 'unit': 's'},
+        'TopUpNextInjRound-Cmd': {'type': 'int', 'value': 0},
+        'TopUpMaxNrPulses-SP': {
+            'type': 'int', 'value': 100, 'unit': 'pulses',
+            'lolim': 1, 'hilim': 1000},
+        'TopUpMaxNrPulses-RB': {
+            'type': 'int', 'value': 100, 'unit': 'pulses',
+            'lolim': 1, 'hilim': 1000},
+        'AutoStop-Sel': {
+            'type': 'enum', 'value': _ct.OffOn.Off, 'enums': _et.OFF_ON},
+        'AutoStop-Sts': {
+            'type': 'enum', 'value': _ct.OffOn.Off, 'enums': _et.OFF_ON},
+
+        'InjSysTurnOn-Cmd': {'type': 'int', 'value': 0},
+        'InjSysTurnOff-Cmd': {'type': 'int', 'value': 0},
+        'InjSysCmdDone-Mon': {
+            'type': 'string', 'value': ''},
+        'InjSysCmdSts-Mon': {
+            'type': 'enum', 'value': _ct.InjSysCmdSts.Idle,
+            'enums': _et.INJSYSCMDSTS},
+        'InjSysTurnOnOrder-SP': {'type': 'string', 'value': injsys_onorder},
+        'InjSysTurnOnOrder-RB': {'type': 'string', 'value': injsys_onorder},
+        'InjSysTurnOffOrder-SP': {'type': 'string', 'value': injsys_offorder},
+        'InjSysTurnOffOrder-RB': {'type': 'string', 'value': injsys_offorder},
+
+        'DiagStatusLI-Mon': {
+            'type': 'int', 'value': 2**len(_ct.LI_STATUS_LABELS)-1},
+        'DiagStatusLILabels-Cte': {
+            'type': 'char', 'count': 1000,
+            'value': '\n'.join(_ct.LI_STATUS_LABELS)},
+        'DiagStatusTB-Mon': {
+            'type': 'int', 'value': 2**len(_ct.TL_STATUS_LABELS)-1},
+        'DiagStatusTBLabels-Cte': {
+            'type': 'char', 'count': 1000,
+            'value': '\n'.join(_ct.TL_STATUS_LABELS)},
+        'DiagStatusBO-Mon': {
+            'type': 'int', 'value': 2**len(_ct.SR_STATUS_LABELS)-1},
+        'DiagStatusBOLabels-Cte': {
+            'type': 'char', 'count': 1000,
+            'value': '\n'.join(_ct.SR_STATUS_LABELS)},
+        'DiagStatusTS-Mon': {
+            'type': 'int', 'value': 2**len(_ct.TL_STATUS_LABELS)-1},
+        'DiagStatusTSLabels-Cte': {
+            'type': 'char', 'count': 1000,
+            'value': '\n'.join(_ct.TL_STATUS_LABELS)},
+        'DiagStatusSI-Mon': {
+            'type': 'int', 'value': 2**len(_ct.SR_STATUS_LABELS)-1},
+        'DiagStatusSILabels-Cte': {
+            'type': 'char', 'count': 1000,
+            'value': '\n'.join(_ct.SR_STATUS_LABELS)},
+        'DiagStatusAS-Mon': {
+            'type': 'int', 'value': 2**len(_ct.AS_STATUS_LABELS)-1},
+        'DiagStatusASLabels-Cte': {
+            'type': 'char', 'count': 1000,
+            'value': '\n'.join(_ct.AS_STATUS_LABELS)},
+        'DiagStatus-Mon': {
+            'type': 'int', 'value': 2**len(_ct.GEN_STATUS_LABELS)-1},
+        'DiagStatusLabels-Cte': {
+            'type': 'char', 'count': 1000,
+            'value': '\n'.join(_ct.GEN_STATUS_LABELS)},
+        'InjStatus-Mon': {
+            'type': 'int', 'value': 2**len(_ct.INJ_STATUS_LABELS)-1},
+        'InjStatusLabels-Cte': {
+            'type': 'char', 'count': 1000,
+            'value': '\n'.join(_ct.INJ_STATUS_LABELS)},
+    }
+    dbase = _csdev.add_pvslist_cte(dbase)
+    return dbase