pychemstation.utils.macro

  1from __future__ import annotations
  2
  3from dataclasses import dataclass
  4from enum import Enum
  5from typing import Union
  6
  7
  8@dataclass
  9class Response:
 10    """Class representing a response from Chemstation"""
 11
 12    string_response: str
 13    num_response: Union[int, float]
 14
 15
 16# Commands sent to the Chemstation Macro
 17# See https://www.agilent.com/cs/library/usermanuals/Public/MACROS.PDF
 18class Command(Enum):
 19    def __str__(self):
 20        return "%s" % self.value
 21
 22    GET_NUM_VAL_CMD = "response_num = {cmd}"
 23    GET_TEXT_VAL_CMD = "response$ = {cmd}"
 24    RESET_COUNTER_CMD = "last_cmd_no = 0"
 25    GET_STATUS_CMD = "response$ = AcqStatus$"
 26    SLEEP_CMD = "Sleep {seconds}"
 27    STANDBY_CMD = "Standby"
 28    STOP_MACRO_CMD = "Stop"
 29    PREPRUN_CMD = "PrepRun"
 30
 31    # Instrument Control
 32    LAMP_ON_CMD = "LampAll ON"
 33    LAMP_OFF_CMD = "LampAll OFF"
 34    PUMP_ON_CMD = "PumpAll ON"
 35    PUMP_OFF_CMD = "PumpAll OFF"
 36    COLUMN_ON_CMD = "ColumnAll ON"
 37    COLUMN_OFF_CMD = "ColumnAll OFF"
 38    INSTRUMENT_OFF = 'macro "SHUTDOWN.MAC" ,go'
 39    INSTRUMENT_ON = 'LIDoOperation "TURN_ON"'
 40
 41    # Method and Sequence Related
 42    GET_METHOD_CMD = "response$ = _MethFile$"
 43    GET_ROWS_CMD = 'response_num = TabHdrVal({register}, "{table_name}", "{col_name}")'
 44    SWITCH_METHOD_CMD = "LoadMethod _MethPath$, _MethFile$"
 45    SWITCH_METHOD_CMD_SPECIFIC = 'LoadMethod "{method_dir}", "{method_name}.M"'
 46    START_METHOD_CMD = "StartMethod"
 47    RUN_METHOD_CMD = 'RunMethod "{data_dir}",, "{experiment_name}"'
 48    STOP_METHOD_CMD = "StopMethod"
 49    UPDATE_METHOD_CMD = "UpdateMethod"
 50    SWITCH_SEQUENCE_CMD = "LoadSequence _SeqPath$, _SeqFile$"
 51    SAVE_SEQUENCE_CMD = "SaveSequence _SeqPath$, _SeqFile$"
 52    SAVE_METHOD_CMD = 'SaveMethod _MethPath$, _MethFile$, "{commit_msg}"'
 53    GET_SEQUENCE_CMD = "response$ = _SeqFile$"
 54    RUN_SEQUENCE_CMD = "RunSequence"
 55    CURRENT_RUNNING_SEQ_LINE = "response_num = _SEQCURRLINE1"
 56
 57    # Get directories
 58    GET_METHOD_DIR = "response$ = _METHPATH$"
 59    GET_SEQUENCE_DIR = "response$ = _SEQUENCEPATHS$"
 60    CONFIG_MET_PATH = "_CONFIGMETPATH"
 61    CONFIG_SEQ_PATH = "_CONFIGSEQPATH"
 62    GET_RUNNING_SEQUENCE_DIR = "response$ = _SEQPATHS$"
 63    GET_DATA_DIRS = "response$ = _DATAPATHS$"
 64    GET_CURRENT_RUN_DATA_DIR = "response$ = _DATAPath$"
 65    GET_CURRENT_RUN_DATA_FILE = "response$ = _DATAFILE1$"
 66
 67    # Errors
 68    ERROR = "response$ = _ERRMSG$"
 69
 70
 71class HPLCRunningStatus(Enum):
 72    @classmethod
 73    def has_member_key(cls, key):
 74        return key in cls.__members__
 75
 76    INJECTING = "INJECTING"
 77    PREPARING = "PREPARING"
 78    RUN = "RUN"
 79    NOTREADY = "NOTREADY"
 80    POSTRUN = "POSTRUN"
 81    RAWDATA = "RAWDATA"
 82    INITIALIZING = "INITIALIZING"
 83    NOMODULE = "NOMODULE"
 84
 85
 86class HPLCAvailStatus(Enum):
 87    @classmethod
 88    def has_member_key(cls, key):
 89        return key in cls.__members__
 90
 91    PRERUN = "PRERUN"
 92    OFFLINE = "OFFLINE"
 93    STANDBY = "STANDBY"
 94
 95
 96class HPLCErrorStatus(Enum):
 97    @classmethod
 98    def has_member_key(cls, key):
 99        return key in cls.__members__
100
101    ERROR = "ERROR"
102    BREAK = "BREAK"
103    NORESPONSE = "NORESPONSE"
104    MALFORMED = "MALFORMED"
105
106
107def str_to_status(
108    status: str,
109):
110    if HPLCErrorStatus.has_member_key(status):
111        return HPLCErrorStatus[status]
112    if HPLCRunningStatus.has_member_key(status):
113        return HPLCRunningStatus[status]
114    if HPLCAvailStatus.has_member_key(status):
115        return HPLCAvailStatus[status]
116    raise KeyError(status)
117
118
119Status = Union[HPLCRunningStatus, HPLCAvailStatus, HPLCErrorStatus]