From cbcace34d8272be58e6e4fd59a56167dcc5bf531 Mon Sep 17 00:00:00 2001 From: darksnake Date: Thu, 4 Feb 2016 16:55:50 +0300 Subject: [PATCH] fixed msp device in accordance with new device framework --- numass-control/msp/docs/commands.htm | 489 ++++++++++++++++++ .../inr/numass/control/msp/MspDevice.java | 322 ++++++------ .../control/msp/fx/MspViewController.java | 14 +- 3 files changed, 645 insertions(+), 180 deletions(-) create mode 100644 numass-control/msp/docs/commands.htm diff --git a/numass-control/msp/docs/commands.htm b/numass-control/msp/docs/commands.htm new file mode 100644 index 00000000..6b3c5b60 --- /dev/null +++ b/numass-control/msp/docs/commands.htm @@ -0,0 +1,489 @@ + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

 

+ 		+

MKSRGA  Multi

+

Protocol_Revision 1.1

+

Min_Compatibility 1.1

+ 		+

Асинхронное сообщение о подключении к прибору по tcp-ip

+
+

 

+ 		+

«command»     ERROR

+

Number            + 200  

+

Description      «err + description»*

+ 		+

В случае ошибки возвращается это + сообщение

+
+

Sensors

+ 		+

Sensors OK  

+

State     SerialNumber            Name

+

Ready   LM70-00197021  “Chamber A”

+ 		+

Выдает все сенсоры, которые могут быть использованы

+
+

Select "SerialNumber"

+ 		+

Select OK

+

SerialNumber  LM70-00197021

+

State         Ready 

+ 		+

Выбираем сенсор, с которым будем работать

+
+

Control "AppName" "Version"

+ 		+

Control OK

+

SerialNumber  LM70-00197021

+ 		+

Получаем контроль над сенсором

+
+

FilamentControl         

+

"On/Off"

+ 		+

FilamentControl OK

+

State On

+

 

+ 		+

Включение нити накала

+
+

FilamentStatus 1    ON/OFF/WARM-UP/COOL- DOWN

+

Trip                        None

+

Drive                       Off

+

EmissionTripState   OK

+

ExternalTripState    OK

+

RVCTripState          OK

+ 		+

Асинхронное сообщение о любом изменении состояния нити накала

+

Последовательность : WARM-UP -> OK -> ON или COOL-DOWN -> OK -> OFF

+
+

AddPeakJump "MeasurementName" "FilterMode" + "0..8" "0" "0" "0"

+ 		+

AddPeakJump OK

+

Name                   PeakJump1

+

FilterMode           + PeakCenter/PeakMax/PeakAverage

+

Accuracy                 5

+

EGainIndex             0

+

SourceIndex            0

+

DetectorIndex          0

+ 		+

Создаем режим измерения PeakJump

+

0..8 — точность измерений: 0 — меньшая точность, но большая + скорость, 8 — наоборот

+

Все остальное полагать 0

+
+

MeasurementAddMass "Mass"

+ 		+

MeasurementAddMass  OK

+

Mass  10

+ 		+

Добавляем массы в PeakJump, которые хотим измерить.

+

Чтобы добавить новую массу, нужно повторно вызвать эту команду.

+
+

MeasurementChangeMass

+

"MassIndex" "NewMass"

+ 		+

MeasurementChangeMass OK + MassIndex                          0  

+

NewMass                           6  +

+ 		+

Заменяет массу с индексом " + MassIndex" на новое значение

+

(индексация с нуля)

+
+

MeasurementSelect "Analog1"

+ 		+

MeasurementSelect      OK

+

Measurement                + Analog1

+ 		+

Определяет Measurement по его + имени, который будет использоваться в дальнейшем для MeasurementXXXX команд

+
+

MeasurementRemoveAll

+ 		+

MeasurementRemoveAll OK

+ 		+

Удаляет все Measurements из списка + сканера

+

 

+
+

MeasurementRemove + "Barchart1"

+ 		+

MeasurementRemove   OK   + Measurement                Barchart1

+ 		+

Удаляет Measurement с данным + именем из списка сканера

+
+

ScanAdd "MeasurementName"

+ 		+

ScanAdd OK

+

Measurement PeakJump1

+ 		+

Добавляем созданное измерение сканеру.

+

Сканер НЕ должен быть запущен.

+
+

ScanStart "NumScans"

+ 		+

ScanStart OK

+ 		+

Запускаем сканер.

+

Далее - асинхронные сообщения после каждого из NumScans + сканирования.

+
+

StartingScan  1 16858 0

+

 

+ 		+

Сообщение о том, что закончилось некоторое измерение, указано + время с момента первого измерения и оставшееся количество измерений до + перезапуска

+
+

StartingMeasurement PeakJump1

+ 		+

Сообщение о том, какой Measurment сканера запущен (сканер может + иметь несколько режимов измерений)

+
+

ZeroReading 5.5 1.01e-8

+ 		+

Нулевое значени давления ( 5.5 - это MassPosition)

+

Изменяется командой:   MeasurementZeroMass "ZeroMass"

+
+

MassReading 1 2.9383e-5

+ 		+

Парциальное давление газа заданной массы в формате масса, + давление (выводится весь список масс)

+

Далее сканер остается запущенным в режиме ожидания

+
+

ScanResume "NumScans"

+ 		+

ScanResume  OK

+ 		+

Продолжает работу сканера для повторного считывания данных с + последующей цепочкой аналогичных сообщений

+
+

ScanRestart "NumScans"

+ 		+

ScanRestart  OK

+ 		+

Перезапускает сканер с самого + начала для "NumScans" измерений

+

(полезно в случае сбоев + сканирования, чтобы заново не переопределять параметры сенсора)

+
+

ScanStop

+ 		+

ScanStop OK

+ 		+

Выключает сканер и сбрасывает с него все имеющиеся Measurements

+

Для следующих измерений нужно снова ScanAdd + "MeasurementName"

+
+

Release

+ 		+

Release OK

+ 		+

Теряем контроль над сенсором

+
+ +

* номера и описания ошибок:

+ +

200 – некорректная команда

+ +

201 — неверное количество + параметров в команде

+ +

202 – ошибочно переданный параметр (Parameter 1 'State' could not be interpreted as on/off)

+ +

203 – ошибка действия, подразумевающего корректное выполнение какого либо другого действия  (No sensor selected/Must be in control + of sensor/Not scanning)

+ +

204 – ошибка в параметрах, связанных с Measurement (Measurement with this + name already exists/Bad SourceIndex/Invalid mass value)

+ +

300 – ошибка выбора сенсора + (неверный серийный номер сенсора)

+ +

 

+ +
+ + + + diff --git a/numass-control/msp/src/main/java/inr/numass/control/msp/MspDevice.java b/numass-control/msp/src/main/java/inr/numass/control/msp/MspDevice.java index 853f0e6a..5c657e7b 100644 --- a/numass-control/msp/src/main/java/inr/numass/control/msp/MspDevice.java +++ b/numass-control/msp/src/main/java/inr/numass/control/msp/MspDevice.java @@ -17,6 +17,7 @@ package inr.numass.control.msp; import hep.dataforge.context.Context; import hep.dataforge.context.GlobalContext; +import hep.dataforge.control.connections.StorageConnection; import hep.dataforge.control.devices.SingleMeasurementDevice; import hep.dataforge.control.measurements.AbstractMeasurement; import hep.dataforge.control.measurements.Measurement; @@ -34,7 +35,6 @@ import hep.dataforge.meta.Meta; import hep.dataforge.storage.api.PointLoader; import hep.dataforge.storage.api.Storage; import hep.dataforge.storage.commons.LoaderFactory; -import hep.dataforge.storage.loaders.ChainPointLoader; import hep.dataforge.values.Value; import java.time.Instant; import java.util.ArrayList; @@ -43,36 +43,24 @@ import java.util.List; import java.util.Map; import java.util.Scanner; import java.util.concurrent.ConcurrentSkipListMap; -import java.util.logging.Level; -import java.util.logging.Logger; +import java.util.function.Consumer; /** * * @author Alexander Nozik */ -public class MspDevice extends SingleMeasurementDevice { +public class MspDevice extends SingleMeasurementDevice implements PortHandler.PortController { // private static final String PEAK_SET_PATH = "peakJump.peak"; private static final int TIMEOUT = 200; - //storage -// /** -// * Separate storage configuration for backup storage. -// */ -// private Meta backupStorage; - private PointLoader peakJumpLoader; - - //port handler private TcpPortHandler handler; //listener private MspListener mspListener; - private String sensorName = null; - private boolean isSelected = false; - private boolean isControlled = false; - private boolean isFilamentOn = false; -// private boolean isScanning = false; + private Consumer responseDelegate; + private Consumer errorDelegate; public MspDevice(String name, Meta annotation) { super(name, GlobalContext.instance(), annotation); @@ -90,6 +78,28 @@ public class MspDevice extends SingleMeasurementDevice { getLogger().info("Connection to MKS mass-spectrometer on {}:{}...", ip, port); handler = new TcpPortHandler(ip, port, "msp"); handler.setDelimeter("\r\r"); + handler.holdBy(this); + setConnected(true); + } + + @Override + public void shutdown() throws ControlException { + super.shutdown(); + super.stopMeasurement(true); + setFileamentOn(false); + setConnected(false); + handler.unholdBy(this); + handler.close(); + } + + @Override + protected Meta getMetaForMeasurement(String name) { + switch (name) { + case "peakJump": + return meta().getNode("peakJump"); + default: + return super.getMetaForMeasurement(name); + } } @Override @@ -104,7 +114,14 @@ public class MspDevice extends SingleMeasurementDevice { @Override protected Object calculateState(String stateName) throws ControlException { - throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates. + switch (stateName) { + case "filamentOn": + return false;//Always return false on first request + case "filamentStatus": + return "UNKNOWN"; + default: + throw new ControlException("State not defined"); + } } @Override @@ -114,7 +131,14 @@ public class MspDevice extends SingleMeasurementDevice { @Override protected boolean applyState(String stateName, Value stateValue) throws ControlException { - + switch (stateName) { + case "connected": + return setConnected(stateValue.booleanValue()); + case "filamentOn": + return setFileamentOn(stateValue.booleanValue()); + default: + return super.applyState(stateName, stateValue); + } } /** @@ -123,96 +147,43 @@ public class MspDevice extends SingleMeasurementDevice { * @param measurement * @throws hep.dataforge.exceptions.PortException */ - public void setConnected(boolean connected) throws ControlException { - if (getState("connection").booleanValue() != connected) { -// if (handler.isLocked()) { -// LoggerFactory.getLogger(getClass()).error("Trying to init MSP controller on locked port. Breaking the lock."); -// handler.breakHold(); -// } -// handler.holdBy(this); + public boolean setConnected(boolean connected) throws ControlException { + String sensorName; + if (isConnected() != connected) { if (connected) { MspResponse response = sendAndWait("Sensors"); if (response.isOK()) { - this.sensorName = response.get(2, 1); + sensorName = response.get(2, 1); } else { - evaluateError(response.errorDescription(), null); - return; + error(response.errorDescription(), null); + return false; } //PENDING определеить в конфиге номер прибора response = sendAndWait("Select", sensorName); if (response.isOK()) { - this.isSelected = true; + updateState("selected", true); } else { - evaluateError(response.errorDescription(), null); - return; + error(response.errorDescription(), null); + return false; } response = sendAndWait("Control", "inr.numass.msp", "1.0"); if (response.isOK()) { - this.isControlled = true; + updateState("controlled", true); } else { - evaluateError(response.errorDescription(), null); + error(response.errorDescription(), null); + return false; } - updateState("", TIMEOUT); + updateState("connected", true); + return true; } else { - + return !sendAndWait("Release").isOK(); } + } else { + return false; } -// createPeakJumpMeasurement(buildMeasurementLaminate(measurement).getNode("peakJump")); -// this.peakJumpLoader = getPeakJumpLoader(measurement); - } - -// public void setStorageConfig(Meta storageConfig, List peaks) throws StorageException { -// Storage storage = getContext().provide("storage", StoragePlugin.class).buildStorage(storageConfig); -// String suffix = Integer.toString((int) Instant.now().toEpochMilli()); -// -// this.peakJumpLoader = LoaderFactory.buildPointLoder(storage, "msp" + suffix, "", "timestamp", DataFormat.forNames(10, peaks)); -// } - private PointLoader getPeakJumpLoader(Meta measurement) { - if (peakJumpLoader == null) { - try { -// StoragePlugin plugin = getContext().provide("storage", StoragePlugin.class); - - Storage primaryStorage = getPrimaryStorage(measurement); - - if (peakMap == null) { - throw new IllegalStateException("Peak map is not initialized"); - } - - DataFormatBuilder builder = new DataFormatBuilder().addTime("timestamp"); - for (String peakName : this.peakMap.values()) { - builder.addNumber(peakName); - } - - DataFormat format = builder.build(); - - //TODO Переделать!!! - String run = meta().getString("numass.run", ""); - - String suffix = Integer.toString((int) Instant.now().toEpochMilli()); - peakJumpLoader = LoaderFactory - .buildPointLoder(primaryStorage, "msp" + suffix, run, "timestamp", format); - - try { - Storage secondaryStorage = getSecondaryStorage(measurement); - if (secondaryStorage != null) { - PointLoader backupLoader = LoaderFactory - .buildPointLoder(secondaryStorage, "msp" + suffix, run, "timestamp", format); - peakJumpLoader = new ChainPointLoader(peakJumpLoader, backupLoader); - } - } catch (Exception ex) { - getLogger().error("Failed to initialize backup peak jump loader", ex); - } - - } catch (StorageException ex) { - getLogger().error("Failed to initialize primary peak jump loader", ex); - return null; - } - - } - return peakJumpLoader; } public void setListener(MspListener listener) { @@ -274,21 +245,22 @@ public class MspDevice extends SingleMeasurementDevice { return new MspResponse(response); } + public boolean isConnected() { + return getState("connected") != null && getState("connected").booleanValue(); + } + public boolean isSelected() { - return isSelected; + return getState("selected") != null && getState("selected").booleanValue(); } public boolean isControlled() { - return isControlled; + return getState("controlled") != null && getState("controlled").booleanValue(); } public boolean isFilamentOn() { - return isFilamentOn; + return getState("filamentOn").booleanValue(); } -// public boolean isIsScanning() { -// return isScanning; -// } /** * Turn filament on or off * @@ -305,59 +277,40 @@ public class MspDevice extends SingleMeasurementDevice { } } -// /** -// * Create measurement with parameters and return its name -// * -// * @param an -// * @return -// * @throws hep.dataforge.exceptions.PortException -// */ -// private void createPeakJumpMeasurement(Meta an) throws ControlException { -// String name = "peakJump";//an.getString("measurementNAmname", "default"); -// String filterMode = an.getString("filterMode", "PeakAverage"); -// int accuracy = an.getInt("accuracy", 5); -// //PENDING вставить остальные параметры? -// sendAndWait("MeasurementRemove", name); -// if (sendAndWait("AddPeakJump", name, filterMode, accuracy, 0, 0, 0).isOK()) { -// peakMap = new LinkedHashMap<>(); -// for (Meta peak : an.getNodes("peak")) { -// peakMap.put(peak.getInt("mass"), peak.getString("name", peak.getString("mass"))); -// if (!sendAndWait("MeasurementAddMass", peak.getString("mass")).isOK()) { -// throw new ControlException("Can't add mass to measurement measurement for msp"); -// } -// } -// } else { -// throw new ControlException("Can't create measurement for msp"); -// } -// } - @Override - public void shutdown() throws ControlException { - super.shutdown(); - super.stopMeasurement(true); - setFileamentOn(false); - sendAndWait("Release"); - handler.close(); - } - /** * Evaluate general async messages * * @param response */ private void evaluateResponse(MspResponse response) { + + } + + @Override + public void accept(String message) { + if (mspListener != null) { + mspListener.acceptMessage(message.trim()); + } + MspResponse response = new MspResponse(message); + switch (response.getCommandName()) { // all possible async messages case "FilamentStatus": String status = response.get(0, 2); - isFilamentOn = status.equals("ON"); + updateState("filamentOn", status.equals("ON")); + updateState("filamentStatus", status); if (mspListener != null) { mspListener.acceptFillamentStateChange(status); } break; } + if (responseDelegate != null) { + responseDelegate.accept(response); + } } - private void evaluateError(String errorMessage, Throwable error) { + @Override + public void error(String errorMessage, Throwable error) { if (mspListener != null) { mspListener.error(errorMessage, error); } else if (error != null) { @@ -418,24 +371,50 @@ public class MspDevice extends SingleMeasurementDevice { } } - private class PeakJumpMeasurement extends AbstractMeasurement implements PortHandler.PortController { + private class PeakJumpMeasurement extends AbstractMeasurement { private final Map measurement = new ConcurrentSkipListMap<>(); private Map peakMap; + private List loaders = new ArrayList<>(); private final Meta meta; public PeakJumpMeasurement(Meta meta) { this.meta = meta; } + private void prepareLoaders() { + loaders = new ArrayList<>(); + forEachTypedConnection("storage", StorageConnection.class, (StorageConnection con) -> { + try { + Storage storage = con.getStorage(); + + if (peakMap == null) { + throw new IllegalStateException("Peak map is not initialized"); + } + + DataFormatBuilder builder = new DataFormatBuilder().addTime("timestamp"); + for (String peakName : this.peakMap.values()) { + builder.addNumber(peakName); + } + + DataFormat format = builder.build(); + + //TODO Переделать!!! + String run = meta().getString("numass.run", ""); + + String suffix = Integer.toString((int) Instant.now().toEpochMilli()); + PointLoader loader = LoaderFactory + .buildPointLoder(storage, "msp" + suffix, run, "timestamp", format); + loaders.add(loader); + } catch (StorageException ex) { + getLogger().error("Failed to initialize peak jump loader", ex); + } + }); + } + @Override public void start() { - try { - //Take control of port - handler.holdBy(this); - } catch (PortException ex) { - Logger.getLogger(MspDevice.class.getName()).log(Level.SEVERE, null, ex); - } + responseDelegate = this::eval; try { String name = "peakJump";//an.getString("measurementNAmname", "default"); @@ -468,21 +447,22 @@ public class MspDevice extends SingleMeasurementDevice { } catch (ControlException ex) { onError(ex); } + onStart(); } @Override - public boolean stop(boolean force) { - handler.unholdBy(this); - throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates. - } - - @Override - public void accept(String message) { - if (mspListener != null) { - mspListener.acceptMessage(message.trim()); + public boolean stop(boolean force) throws MeasurementException { + try { + boolean stop = sendAndWait("ScanStop").isOK(); + onStop(); + responseDelegate = null; + return stop; + } catch (PortException ex) { + throw new MeasurementException(ex); } + } - MspResponse response = new MspResponse(message); + public void eval(MspResponse response) { //Evaluating device state change evaluateResponse(response); @@ -494,14 +474,11 @@ public class MspDevice extends SingleMeasurementDevice { measurement.put((int) Math.floor(mass + 0.5), value); break; case "StartingScan": - if (mspListener != null && !measurement.isEmpty() && isFilamentOn) { - + if (mspListener != null && !measurement.isEmpty()) { if (peakMap == null) { throw new IllegalStateException("Peal map is not initialized"); } - mspListener.acceptScan(measurement); - Instant time = Instant.now(); MapDataPoint point = new MapDataPoint(); @@ -512,37 +489,36 @@ public class MspDevice extends SingleMeasurementDevice { point.putValue(peakMap.get(entry.getKey()), val); }); - if (peakJumpLoader != null) { - try { - peakJumpLoader.push(point); - } catch (StorageException ex) { - getLogger().error("Push to repo failed", ex); + if (isFilamentOn()) { + mspListener.acceptScan(measurement); + + for (PointLoader loader : this.loaders) { + try { + loader.push(point); + } catch (StorageException ex) { + getLogger().error("Push to repo failed", ex); + } } } - } - measurement.clear(); + measurement.clear(); - int numScans = Integer.parseInt(response.get(0, 3)); + int numScans = Integer.parseInt(response.get(0, 3)); - if (numScans == 0) { - try { - send("ScanResume", 2); - //FIXME обработать ошибку связи - } catch (PortException ex) { - error(null, ex); + if (numScans == 0) { + try { + send("ScanResume", 2); + //FIXME обработать ошибку связи + } catch (PortException ex) { + error(null, ex); + } } - } - break; + break; + } } } - public boolean stopMeasurement() throws PortException { - return sendAndWait("ScanStop").isOK(); - } - - @Override public void error(String errorMessage, Throwable error) { if (error == null) { onError(new MeasurementException(errorMessage)); diff --git a/numass-control/msp/src/main/java/inr/numass/control/msp/fx/MspViewController.java b/numass-control/msp/src/main/java/inr/numass/control/msp/fx/MspViewController.java index 54ef4f55..73a3c848 100644 --- a/numass-control/msp/src/main/java/inr/numass/control/msp/fx/MspViewController.java +++ b/numass-control/msp/src/main/java/inr/numass/control/msp/fx/MspViewController.java @@ -15,16 +15,16 @@ */ package inr.numass.control.msp.fx; -import hep.dataforge.meta.Meta; -import hep.dataforge.meta.MetaBuilder; -import hep.dataforge.meta.ConfigChangeListener; -import hep.dataforge.meta.Configuration; import hep.dataforge.context.Context; import hep.dataforge.context.GlobalContext; import hep.dataforge.data.MapDataPoint; import hep.dataforge.exceptions.ControlException; import hep.dataforge.exceptions.PortException; import hep.dataforge.io.MetaFileReader; +import hep.dataforge.meta.ConfigChangeListener; +import hep.dataforge.meta.Configuration; +import hep.dataforge.meta.Meta; +import hep.dataforge.meta.MetaBuilder; import hep.dataforge.plots.data.DynamicPlottable; import hep.dataforge.plots.data.DynamicPlottableSet; import hep.dataforge.plots.jfreechart.JFreeChartFrame; @@ -155,7 +155,7 @@ public class MspViewController implements Initializable, MspListener { try { getDevice().setListener(this); getDevice().init(); - getDevice().startMeasurement("peakJump"); +// getDevice().startMeasurement("peakJump"); } catch (ControlException ex) { showError(String.format("Can't connect to %s:%d. The port is either busy or not the MKS mass-spectrometer port", config.getString("connection.ip", "127.0.0.1"), @@ -186,11 +186,11 @@ public class MspViewController implements Initializable, MspListener { public void initPlot() { Meta plotConfig = new MetaBuilder("plotFrame") .setNode(new MetaBuilder("yAxis") - .setValue("logAxis", true) + .setValue("type", "log") .setValue("axisTitle", "partial pressure") .setValue("axisUnits", "mbar") ) - .setValue("xAxis.timeAxis", true); + .setValue("xAxis.type", "time"); this.plotFrame = new JFreeChartFrame(mspName, plotConfig).display(plotPane); updatePlot(); // this.plot = DynamicPlot.attachToFX(plotPane, new AnnotationBuilder("plot-config").putValue("logY", true).build());