Add default value for motorMessageText

sinqMotor is statically compiled into this driver.

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "sinqMotor"]
+	path = sinqMotor
+	url = https://gitea.psi.ch/lin-epics-modules/sinqMotor

Makefile

@@ -12,18 +12,23 @@ REQUIRED+=sinqMotor
 # Specify the version of asynMotor we want to build against
 motorBase_VERSION=7.2.2
 
-# Specify the version of sinqMotor we want to build against
-sinqMotor_VERSION=0.11.0
-
 # These headers allow to depend on this library for derived drivers.
 HEADERS += src/masterMacsAxis.h
 HEADERS += src/masterMacsController.h
 
 # Source files to build
+SOURCES += sinqMotor/src/msgPrintControl.cpp
+SOURCES += sinqMotor/src/sinqAxis.cpp
+SOURCES += sinqMotor/src/sinqController.cpp
 SOURCES += src/masterMacsAxis.cpp
 SOURCES += src/masterMacsController.cpp
 
+# Store the record files
+TEMPLATES += sinqMotor/db/asynRecord.db
+TEMPLATES += sinqMotor/db/sinqMotor.db
+
 # This file registers the motor-specific functions in the IOC shell.
+DBDS += sinqMotor/src/sinqMotor.dbd
 DBDS += src/masterMacs.dbd
 
-USR_CFLAGS += -Wall -Wextra -Weffc++ -Wunused-result -Wpedantic -Wextra -Werror
+USR_CFLAGS += -Wall -Wextra -Weffc++ -Wunused-result -Wextra -Werror

README.md

@@ -14,6 +14,8 @@ This driver is a standard sinqMotor-derived driver and does not need any specifi
 
 The folder "utils" contains utility scripts for working with masterMacs motor controllers:
 - decodeStatus.py: Take the return message of a R10 (read status) command and print it in human-readable form.
+- decodeError.py: Take the return message of a R11 (read error) command and print it in human-readable form.
+- writeRead.py: Send messages to the controller and receive answers.
 
 ## Developer guide
 

src/masterMacsAxis.cpp

@@ -11,6 +11,14 @@
 #include <string.h>
 #include <unistd.h>
 
+/*
+A special communication timeout is used in the following two cases:
+1) Enable command
+2) First move command after enabling the motor
+This is due to MasterMACS running a powerup cycle, which can delay the answer.
+ */
+#define PowerCycleTimeout 10.0 // Value in seconds
+
 /*
 Contains all instances of turboPmacAxis which have been created and is used in
 the initialization hook function.
@@ -79,7 +87,7 @@ masterMacsAxis::masterMacsAxis(masterMacsController *pC, int axisNo)
     stop completely, since this is a configuration error.
     */
     if (axisNo >= pC->numAxes()) {
-        asynPrint(pC_->asynUserSelf(), ASYN_TRACE_ERROR,
+        asynPrint(pC_->pasynUser(), ASYN_TRACE_ERROR,
                   "Controller \"%s\", axis %d => %s, line %d:: FATAL ERROR: "
                   "Axis index %d must be smaller than the total number of axes "
                   "%d. Call the support.",
@@ -106,12 +114,13 @@ masterMacsAxis::masterMacsAxis(masterMacsController *pC, int axisNo)
     // Flag for handshake waiting
     waitForHandshake_ = false;
     timeAtHandshake_ = 0;
+    targetReachedUninitialized_ = true;
 
     // masterMacs motors can always be disabled
     status = pC_->setIntegerParam(axisNo_, pC_->motorCanDisable(), 1);
     if (status != asynSuccess) {
         asynPrint(
-            pC_->asynUserSelf(), ASYN_TRACE_ERROR,
+            pC_->pasynUser(), ASYN_TRACE_ERROR,
             "Controller \"%s\", axis %d => %s, line %d:\nFATAL ERROR "
             "(setting a parameter value failed with %s)\n. Terminating IOC",
             pC_->portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
@@ -123,12 +132,26 @@ masterMacsAxis::masterMacsAxis(masterMacsController *pC, int axisNo)
     status = pC_->setIntegerParam(axisNo_, pC_->motorStatusMoving(), false);
     if (status != asynSuccess) {
         asynPrint(
-            pC_->asynUserSelf(), ASYN_TRACE_ERROR,
+            pC_->pasynUser(), ASYN_TRACE_ERROR,
             "Controller \"%s\", axis %d => %s, line %d:\nFATAL ERROR "
             "(setting a parameter value failed with %s)\n. Terminating IOC",
             pC_->portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
             pC_->stringifyAsynStatus(status));
     }
+
+    // Even though this happens already in sinqAxis, a default value for
+    // motorMessageText is set here again, because apparently the sinqAxis
+    // constructor is not run before the string is accessed?
+    status = setStringParam(pC_->motorMessageText(), "");
+    if (status != asynSuccess) {
+        asynPrint(pC_->pasynUser(), ASYN_TRACE_ERROR,
+                  "Controller \"%s\", axis %d => %s, line %d:\nFATAL ERROR "
+                  "(setting a parameter value failed "
+                  "with %s)\n. Terminating IOC",
+                  pC_->portName, axisNo_, __PRETTY_FUNCTION__, __LINE__,
+                  pC_->stringifyAsynStatus(status));
+        exit(-1);
+    }
 }
 
 masterMacsAxis::~masterMacsAxis(void) {
@@ -148,7 +171,7 @@ asynStatus masterMacsAxis::init() {
 
     // Local variable declaration
     asynStatus pl_status = asynSuccess;
-    char response[pC_->MAXBUF_];
+    char response[pC_->MAXBUF_] = {0};
     int nvals = 0;
     double motorRecResolution = 0.0;
     double motorPosition = 0.0;
@@ -167,7 +190,7 @@ asynStatus masterMacsAxis::init() {
                                         &motorRecResolution);
         if (pl_status == asynParamUndefined) {
             if (now + maxInitTime < time(NULL)) {
-                asynPrint(pC_->asynUserSelf(), ASYN_TRACE_ERROR,
+                asynPrint(pC_->pasynUser(), ASYN_TRACE_ERROR,
                           "Controller \"%s\", axis %d  => %s, line "
                           "%d\nInitializing the parameter library failed.\n",
                           pC_->portName, axisNo_, __PRETTY_FUNCTION__,
@@ -259,7 +282,7 @@ asynStatus masterMacsAxis::init() {
         // If we can't communicate with the parameter library, it doesn't
         // make sense to try and upstream this to the user -> Just log the
         // error
-        asynPrint(pC_->asynUserSelf(), ASYN_TRACE_ERROR,
+        asynPrint(pC_->pasynUser(), ASYN_TRACE_ERROR,
                   "Controller \"%s\", axis %d => %s, line "
                   "%d:\ncallParamCallbacks failed with %s.\n",
                   pC_->portName, axisNo_, __PRETTY_FUNCTION__, __LINE__,
@@ -281,7 +304,7 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
     // Status of parameter library operations
     asynStatus pl_status = asynSuccess;
 
-    char response[pC_->MAXBUF_];
+    char response[pC_->MAXBUF_] = {0};
     int nvals = 0;
 
     int direction = 0;
@@ -306,8 +329,8 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
 
         if (pC_->getMsgPrintControl().shouldBePrinted(
                 pC_->portName, axisNo_, __PRETTY_FUNCTION__, __LINE__, timedOut,
-                pC_->asynUserSelf())) {
-            asynPrint(pC_->asynUserSelf(), ASYN_TRACE_ERROR,
+                pC_->pasynUser())) {
+            asynPrint(pC_->pasynUser(), ASYN_TRACE_ERROR,
                       "Controller \"%s\", axis %d  => %s, line %d\nAsked for a "
                       "handshake at %ld s and didn't get a positive reply yet "
                       "(current time is %ld s).\n",
@@ -341,6 +364,7 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
             // Handshake has been performed successfully -> Continue with the
             // poll
             waitForHandshake_ = false;
+            targetReachedUninitialized_ = false;
         } else {
             // Still waiting for the handshake - try again in the next busy
             // poll. This is already part of the movement procedure.
@@ -385,12 +409,18 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
         return rw_status;
     }
 
-    // If the motor is switched off or if it reached its target, it is not
-    // moving.
-    if (targetReached() || !switchedOn()) {
+    if (targetReachedUninitialized_) {
         *moving = false;
     } else {
-        *moving = true;
+        if (targetReached() || !switchedOn()) {
+            *moving = false;
+        } else {
+            *moving = true;
+        }
+    }
+
+    if (targetReached()) {
+        targetReachedUninitialized_ = false;
     }
 
     // Read the current position
@@ -420,9 +450,9 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
         since this information is not reliable.
          */
         if (communicationError()) {
-            if (pC_->getMsgPrintControl().shouldBePrinted(
-                    keyError, true, pC_->asynUserSelf())) {
-                asynPrint(pC_->asynUserSelf(), ASYN_TRACE_ERROR,
+            if (pC_->getMsgPrintControl().shouldBePrinted(keyError, true,
+                                                          pC_->pasynUser())) {
+                asynPrint(pC_->pasynUser(), ASYN_TRACE_ERROR,
                           "Controller \"%s\", axis %d  => %s, line "
                           "%d\nCommunication error.%s\n",
                           pC_->portName, axisNo_, __PRETTY_FUNCTION__, __LINE__,
@@ -444,7 +474,7 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
 
             // This buffer must be initialized to zero because we build the
             // error message by appending strings.
-            char userMessage[pC_->MAXBUF_] = {0};
+            char errorMessage[pC_->MAXBUF_] = {0};
             char shellMessage[pC_->MAXBUF_] = {0};
 
             // Concatenate all other errors
@@ -452,7 +482,7 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
                 appendErrorMessage(shellMessage, sizeof(shellMessage),
                                    "Short circuit fault.");
                 appendErrorMessage(
-                    userMessage, sizeof(userMessage),
+                    errorMessage, sizeof(errorMessage),
                     "Short circuit error. Please call the support.");
 
                 poll_status = asynError;
@@ -461,7 +491,7 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
             if (encoderError()) {
                 appendErrorMessage(shellMessage, sizeof(shellMessage),
                                    "Encoder error.");
-                appendErrorMessage(userMessage, sizeof(userMessage),
+                appendErrorMessage(errorMessage, sizeof(errorMessage),
                                    "Encoder error. Please call the support.");
 
                 poll_status = asynError;
@@ -472,7 +502,7 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
                     shellMessage, sizeof(shellMessage),
                     "Maximum callowed following error exceeded.");
                 appendErrorMessage(
-                    userMessage, sizeof(userMessage),
+                    errorMessage, sizeof(errorMessage),
                     "Maximum allowed following error exceeded.Check if "
                     "movement range is blocked. Otherwise please call the "
                     "support.");
@@ -483,7 +513,7 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
             if (feedbackError()) {
                 appendErrorMessage(shellMessage, sizeof(shellMessage),
                                    "Feedback error.");
-                appendErrorMessage(userMessage, sizeof(userMessage),
+                appendErrorMessage(errorMessage, sizeof(errorMessage),
                                    "Feedback error. Please call the support.");
 
                 poll_status = asynError;
@@ -519,7 +549,7 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
 
                 // Generic error message for user
                 appendErrorMessage(
-                    userMessage, sizeof(userMessage),
+                    errorMessage, sizeof(errorMessage),
                     "Software limits or end switch hit. Try homing the motor, "
                     "moving in the opposite direction or check the SPS for "
                     "errors (if available). Otherwise please call the "
@@ -532,7 +562,7 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
                 appendErrorMessage(shellMessage, sizeof(shellMessage),
                                    "Overcurrent error.");
                 appendErrorMessage(
-                    userMessage, sizeof(userMessage),
+                    errorMessage, sizeof(errorMessage),
                     "Overcurrent error. Please call the support.");
 
                 poll_status = asynError;
@@ -542,7 +572,7 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
                 appendErrorMessage(shellMessage, sizeof(shellMessage),
                                    "Overtemperature error.");
                 appendErrorMessage(
-                    userMessage, sizeof(userMessage),
+                    errorMessage, sizeof(errorMessage),
                     "Overtemperature error. Please call the support.");
 
                 poll_status = asynError;
@@ -552,7 +582,7 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
                 appendErrorMessage(shellMessage, sizeof(shellMessage),
                                    "Overvoltage error.");
                 appendErrorMessage(
-                    userMessage, sizeof(userMessage),
+                    errorMessage, sizeof(errorMessage),
                     "Overvoltage error. Please call the support.");
 
                 poll_status = asynError;
@@ -562,7 +592,7 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
                 appendErrorMessage(shellMessage, sizeof(shellMessage),
                                    "Undervoltage error.");
                 appendErrorMessage(
-                    userMessage, sizeof(userMessage),
+                    errorMessage, sizeof(errorMessage),
                     "Undervoltage error. Please call the support.");
 
                 poll_status = asynError;
@@ -571,7 +601,7 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
             if (stoFault()) {
                 appendErrorMessage(shellMessage, sizeof(shellMessage),
                                    "STO input is on disable state.");
-                appendErrorMessage(userMessage, sizeof(userMessage),
+                appendErrorMessage(errorMessage, sizeof(errorMessage),
                                    "STO fault. Please call the support.");
 
                 poll_status = asynError;
@@ -579,8 +609,8 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
 
             if (strlen(shellMessage) > 0) {
                 if (pC_->getMsgPrintControl().shouldBePrinted(
-                        keyError, true, pC_->asynUserSelf())) {
-                    asynPrint(pC_->asynUserSelf(), ASYN_TRACE_ERROR,
+                        keyError, true, pC_->pasynUser())) {
+                    asynPrint(pC_->pasynUser(), ASYN_TRACE_ERROR,
                               "Controller \"%s\", axis %d  => %s, line "
                               "%d\n%s%s\n",
                               pC_->portName, axisNo_, __PRETTY_FUNCTION__,
@@ -589,7 +619,7 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
                 }
             }
 
-            pl_status = setStringParam(pC_->motorMessageText(), userMessage);
+            pl_status = setStringParam(pC_->motorMessageText(), errorMessage);
             if (pl_status != asynSuccess) {
                 return pC_->paramLibAccessFailed(pl_status, "motorMessageText_",
                                                  axisNo_, __PRETTY_FUNCTION__,
@@ -597,7 +627,7 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
             }
         }
     } else {
-        pC_->getMsgPrintControl().resetCount(keyError, pC_->asynUserSelf());
+        pC_->getMsgPrintControl().resetCount(keyError, pC_->pasynUser());
     }
 
     // Read out the limits, if the motor is not moving
@@ -750,7 +780,7 @@ asynStatus masterMacsAxis::doMove(double position, int relative,
     }
 
     if (enabled == 0) {
-        asynPrint(pC_->asynUserSelf(), ASYN_TRACE_ERROR,
+        asynPrint(pC_->pasynUser(), ASYN_TRACE_ERROR,
                   "Controller \"%s\", axis %d => %s, line %d:\nAxis is "
                   "disabled.\n",
                   pC_->portName, axisNo_, __PRETTY_FUNCTION__, __LINE__);
@@ -762,7 +792,7 @@ asynStatus masterMacsAxis::doMove(double position, int relative,
     motorVelocity = maxVelocity * motorRecResolution;
 
     asynPrint(
-        pC_->asynUserSelf(), ASYN_TRACE_FLOW,
+        pC_->pasynUser(), ASYN_TRACE_FLOW,
         "Controller \"%s\", axis %d => %s, line %d:\nMove to position %lf.\n",
         pC_->portName, axisNo_, __PRETTY_FUNCTION__, __LINE__, position);
 
@@ -805,7 +835,7 @@ asynStatus masterMacsAxis::doMove(double position, int relative,
             return rw_status;
         }
 
-        asynPrint(pC_->asynUserSelf(), ASYN_TRACE_FLOW,
+        asynPrint(pC_->pasynUser(), ASYN_TRACE_FLOW,
                   "Controller \"%s\", axis %d => %s, line %d:\nSetting speed "
                   "to %lf.\n",
                   pC_->portName, axisNo_, __PRETTY_FUNCTION__, __LINE__,
@@ -825,11 +855,17 @@ asynStatus masterMacsAxis::doMove(double position, int relative,
         return rw_status;
     }
 
+    // If the motor has just been enabled, use Enable
+    double timeout = pC_->comTimeout();
+    if (targetReachedUninitialized_ && timeout < PowerCycleTimeout) {
+        timeout = PowerCycleTimeout;
+    }
+
     // Start the move
     if (relative) {
-        rw_status = pC_->write(axisNo_, 00, "2");
+        rw_status = pC_->write(axisNo_, 00, "2", timeout);
     } else {
-        rw_status = pC_->write(axisNo_, 00, "1");
+        rw_status = pC_->write(axisNo_, 00, "1", timeout);
     }
     if (rw_status != asynSuccess) {
         pl_status = setIntegerParam(pC_->motorStatusProblem(), true);
@@ -912,7 +948,7 @@ asynStatus masterMacsAxis::doHome(double min_velocity, double max_velocity,
     // Status of parameter library operations
     asynStatus pl_status = asynSuccess;
 
-    char response[pC_->MAXBUF_];
+    char response[pC_->MAXBUF_] = {0};
 
     // =========================================================================
 
@@ -964,7 +1000,8 @@ asynStatus masterMacsAxis::readEncoderType() {
     // Status of parameter library operations
     asynStatus pl_status = asynSuccess;
 
-    char command[pC_->MAXBUF_], response[pC_->MAXBUF_];
+    char command[pC_->MAXBUF_] = {0};
+    char response[pC_->MAXBUF_] = {0};
     int nvals = 0;
     int encoder_id = 0;
 
@@ -1012,10 +1049,22 @@ asynStatus masterMacsAxis::enable(bool on) {
     // Status of parameter library operations
     asynStatus pl_status = asynSuccess;
 
-    bool moving = false;
-
     // =========================================================================
 
+    /*
+    When the motor is changing its enable state, its targetReached bit is set to
+    0. In order to prevent the poll method in interpreting the motor state as
+    "moving", this flag is used. It is reset in the handshake.
+    */
+    targetReachedUninitialized_ = true;
+
+    /*
+    Continue regardless of the status returned by the poll; we just want to
+    find out whether the motor is currently moving or not. If the poll
+    function fails before it can determine that, it is assumed that the motor
+    is not moving.
+    */
+    bool moving = false;
     doPoll(&moving);
 
     // If the axis is currently moving, it cannot be disabled. Ignore the
@@ -1023,7 +1072,7 @@ asynStatus masterMacsAxis::enable(bool on) {
     // axis instead of "moving", since status -6 is also moving, but the
     // motor can actually be disabled in this state!
     if (moving) {
-        asynPrint(pC_->asynUserSelf(), ASYN_TRACE_ERROR,
+        asynPrint(pC_->pasynUser(), ASYN_TRACE_ERROR,
                   "Controller \"%s\", axis %d => %s, line %d:\nAxis is not "
                   "idle and can therefore not be disabled.\n",
                   pC_->portName, axisNo_, __PRETTY_FUNCTION__, __LINE__);
@@ -1045,7 +1094,7 @@ asynStatus masterMacsAxis::enable(bool on) {
 
     if ((readyToBeSwitchedOn() && switchedOn()) == on) {
         asynPrint(
-            pC_->asynUserSelf(), ASYN_TRACE_WARNING,
+            pC_->pasynUser(), ASYN_TRACE_WARNING,
             "Controller \"%s\", axis %d => %s, line %d:\nAxis is already %s.\n",
             pC_->portName, axisNo_, __PRETTY_FUNCTION__, __LINE__,
             on ? "enabled" : "disabled");
@@ -1054,25 +1103,20 @@ asynStatus masterMacsAxis::enable(bool on) {
 
     // Enable / disable the axis if it is not moving
     snprintf(value, sizeof(value), "%d", on);
-    asynPrint(pC_->asynUserSelf(), ASYN_TRACE_FLOW,
+    asynPrint(pC_->pasynUser(), ASYN_TRACE_FLOW,
               "Controller \"%s\", axis %d => %s, line %d:\n%s axis.\n",
               pC_->portName, axisNo_, __PRETTY_FUNCTION__, __LINE__,
               on ? "Enable" : "Disable");
-    if (on == 0) {
-        pl_status = setStringParam(pC_->motorMessageText(), "Disabling ...");
-    } else {
-        pl_status = setStringParam(pC_->motorMessageText(), "Enabling ...");
-    }
-    if (pl_status != asynSuccess) {
-        return pC_->paramLibAccessFailed(pl_status, "motorMessageText_",
-                                         axisNo_, __PRETTY_FUNCTION__,
-                                         __LINE__);
-    }
 
     // The answer to the enable command on MasterMACS might take some time,
     // hence we wait for a custom timespan in seconds instead of
     // pC_->comTimeout_
-    rw_status = pC_->write(axisNo_, 04, value, 1.0);
+    double timeout = pC_->comTimeout();
+    if (targetReachedUninitialized_ && timeout < PowerCycleTimeout) {
+        timeout = PowerCycleTimeout;
+    }
+
+    rw_status = pC_->write(axisNo_, 04, value, timeout);
     if (rw_status != asynSuccess) {
         return rw_status;
     }
@@ -1099,7 +1143,7 @@ asynStatus masterMacsAxis::enable(bool on) {
 
     // Failed to change axis status within timeout_enable_disable => Send a
     // corresponding message
-    asynPrint(pC_->asynUserSelf(), ASYN_TRACE_ERROR,
+    asynPrint(pC_->pasynUser(), ASYN_TRACE_ERROR,
               "Controller \"%s\", axis %d => %s, line %d:\nFailed to %s axis "
               "within %d seconds\n",
               pC_->portName, axisNo_, __PRETTY_FUNCTION__, __LINE__,
@@ -1108,7 +1152,7 @@ asynStatus masterMacsAxis::enable(bool on) {
     // Output message to user
     snprintf(value, sizeof(value), "Failed to %s within %d seconds",
              on ? "enable" : "disable", timeout_enable_disable);
-    pl_status = setStringParam(pC_->motorMessageText(), "Enabling ...");
+    pl_status = setStringParam(pC_->motorMessageText(), value);
     if (pl_status != asynSuccess) {
         return pC_->paramLibAccessFailed(pl_status, "motorMessageText_",
                                          axisNo_, __PRETTY_FUNCTION__,
@@ -1132,7 +1176,7 @@ std::bitset<16> toBitset(float val) {
 }
 
 asynStatus masterMacsAxis::readAxisStatus() {
-    char response[pC_->MAXBUF_];
+    char response[pC_->MAXBUF_] = {0};
 
     // =========================================================================
 
@@ -1153,7 +1197,7 @@ asynStatus masterMacsAxis::readAxisStatus() {
 }
 
 asynStatus masterMacsAxis::readAxisError() {
-    char response[pC_->MAXBUF_];
+    char response[pC_->MAXBUF_] = {0};
 
     // =========================================================================
 

src/masterMacsAxis.h

@@ -111,6 +111,8 @@ class masterMacsAxis : public sinqAxis {
     bool waitForHandshake_;
     time_t timeAtHandshake_;
 
+    bool targetReachedUninitialized_;
+
     asynStatus readConfig();
 
     /*

src/masterMacsController.cpp

@@ -70,7 +70,8 @@ masterMacsController::masterMacsController(const char *portName,
     the message length is encoded in the message header.
     */
     const char *message_from_device = "\x0D"; // Hex-code for CR
-    status = pasynOctetSyncIO->setInputEos(ipPortUser_, message_from_device,
+    status = pasynOctetSyncIO->setInputEos(pasynOctetSyncIOipPort(),
+                                           message_from_device,
                                            strlen(message_from_device));
     if (status != asynSuccess) {
         asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
@@ -78,7 +79,7 @@ masterMacsController::masterMacsController(const char *portName,
                   "input EOS failed with %s).\nTerminating IOC",
                   portName, __PRETTY_FUNCTION__, __LINE__,
                   stringifyAsynStatus(status));
-        pasynOctetSyncIO->disconnect(ipPortUser_);
+        pasynOctetSyncIO->disconnect(pasynOctetSyncIOipPort());
         exit(-1);
     }
 
@@ -89,7 +90,7 @@ masterMacsController::masterMacsController(const char *portName,
                   "ParamLib callbacks failed with %s).\nTerminating IOC",
                   portName, __PRETTY_FUNCTION__, __LINE__,
                   stringifyAsynStatus(status));
-        pasynOctetSyncIO->disconnect(ipPortUser_);
+        pasynOctetSyncIO->disconnect(pasynOctetSyncIOipPort());
         exit(-1);
     }
 }
@@ -132,8 +133,6 @@ asynStatus masterMacsController::writeRead(int axisNo, int tcpCmd,
     asynStatus pl_status = asynSuccess;
     char fullCommand[MAXBUF_] = {0};
     char fullResponse[MAXBUF_] = {0};
-    char printableCommand[MAXBUF_] = {0};
-    char printableResponse[MAXBUF_] = {0};
     char drvMessageText[MAXBUF_] = {0};
     int motorStatusProblem = 0;
 
@@ -157,7 +156,7 @@ asynStatus masterMacsController::writeRead(int axisNo, int tcpCmd,
 
     // =========================================================================
 
-    // Check if a timeout has been given
+    // Check if a custom timeout has been given
     if (comTimeout < 0.0) {
         comTimeout = comTimeout_;
     }
@@ -168,6 +167,7 @@ asynStatus masterMacsController::writeRead(int axisNo, int tcpCmd,
         return asynError;
     }
 
+    // Build the full command depending on the inputs to this function
     if (isRead) {
         snprintf(fullCommand, MAXBUF_ - 1, "%dR%02d\x0D", axisNo, tcpCmd);
     } else {
@@ -182,94 +182,39 @@ asynStatus masterMacsController::writeRead(int axisNo, int tcpCmd,
     // Calculate the command length
     const size_t fullCommandLength = strlen(fullCommand);
 
-    adjustForPrint(printableCommand, fullCommand, MAXBUF_);
+    // Flush the IOC-side socket, then write the command and wait for the
+    // response.
+    status = pasynOctetSyncIO->writeRead(
+        pasynOctetSyncIOipPort(), fullCommand, fullCommandLength, fullResponse,
+        MAXBUF_, comTimeout, &nbytesOut, &nbytesIn, &eomReason);
 
-    // Send out the command
-    status = pasynOctetSyncIO->write(ipPortUser_, fullCommand,
-                                     fullCommandLength, comTimeout, &nbytesOut);
-
-    if (status != asynSuccess) {
-        asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
-                  "Controller \"%s\", axis %d => %s, line %d:\nError "
-                  "%s while writing to the controller\n",
-                  portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
-                  stringifyAsynStatus(status));
-    }
-
-    msgPrintControlKey writeKey =
+    // If a communication error occured, print this message to the
+    msgPrintControlKey comKey =
         msgPrintControlKey(portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
-
-    if (status == asynSuccess) {
-        msgPrintControl_.resetCount(writeKey, pasynUserSelf);
-
-        // Try to read the answer repeatedly
-        int maxTrials = 2;
-        for (int i = 0; i < maxTrials; i++) {
-
-            /*
-            A typical response of the MasterMacs controller looks like this:
-            (.. TCP Header ...) 31 20 52 20 31 31 3d 35 31 32 2e 30 30 30 30 06
-            0d 00 00 00 00 00 00 00 00 00 00 00 00 00
-            The message terminator is the carriage return (0d), which is
-            specified in the controller constructor as the end-of-string (EOS)
-            character. However, we also need to remove the buffer zeros at the
-            end, because they will otherwise confuse the
-            pasynOctetSyncIO->read() during the next call. The
-            pasynOctetSyncIO->flush() method does exactly that: it takes all
-            bytes it can find in the socket and throws them away. We don't check
-            the return value of flush(), because it is always asynSuccess (see
-            https://www.slac.stanford.edu/grp/lcls/controls/global/doc/epics-modules/R3-14-12/asyn/asyn-R4-18-lcls2/asyn/interfaces/asynOctetBase.c)
-             */
-            status = pasynOctetSyncIO->read(ipPortUser_, fullResponse, MAXBUF_,
-                                            comTimeout, &nbytesIn, &eomReason);
-            pasynOctetSyncIO->flush(ipPortUser_);
-
-            if (status == asynSuccess) {
-                status = parseResponse(fullCommand, fullResponse,
-                                       drvMessageText, &valueStart, &valueStop,
-                                       axisNo, tcpCmd, isRead);
-
-                if (status == asynSuccess) {
-                    // Received the correct message
-                    break;
-                }
-            } else {
-                if (status != asynTimeout) {
-                    asynPrint(
-                        this->pasynUserSelf, ASYN_TRACE_ERROR,
-                        "Controller \"%s\", axis %d => %s, line %d:\nError "
-                        "%s while reading from the controller\n",
-                        portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
-                        stringifyAsynStatus(status));
-                    break;
-                }
-            }
-
-            if (i + 1 == maxTrials && status == asynError) {
-                asynPrint(
-                    this->pasynUserSelf, ASYN_TRACE_ERROR,
-                    "Controller \"%s\", axis %d => %s, line %d:\nFailed "
-                    "%d times to get the correct response. Aborting read.\n",
-                    portName, axisNo, __PRETTY_FUNCTION__, __LINE__, maxTrials);
-            }
+    if (status != asynSuccess) {
+        if (msgPrintControl_.shouldBePrinted(comKey, true, pasynUserSelf)) {
+            char printableCommand[MAXBUF_] = {0};
+            adjustForPrint(printableCommand, fullCommand, MAXBUF_);
+            asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
+                      "Controller \"%s\", axis %d => %s, line %d:\nError "
+                      "%s while sending command %s to the controller\n",
+                      portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
+                      stringifyAsynStatus(status), printableCommand);
         }
-
     } else {
-        if (msgPrintControl_.shouldBePrinted(writeKey, true, pasynUserSelf)) {
-            asynPrint(
-                this->pasynUserSelf, ASYN_TRACE_ERROR,
-                "Controller \"%s\", axis %d => %s, line %d:\nError %s while "
-                "writing to the controller.%s\n",
-                portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
-                stringifyAsynStatus(status), msgPrintControl_.getSuffix());
-        }
+        msgPrintControl_.resetCount(comKey, pasynUserSelf);
     }
 
     // Create custom error messages for different failure modes
     switch (status) {
     case asynSuccess:
+        // We did get a response, but does it make sense and is it designated as
+        // OK from the controller? This is checked here.
+        status = parseResponse(fullCommand, fullResponse, drvMessageText,
+                               &valueStart, &valueStop, axisNo, tcpCmd, isRead);
 
-        if (isRead) {
+        // Read out the important information from the response
+        if (status == asynSuccess && isRead) {
             /*
             If a property has been read, we need just the part between the
             "=" (0x3D) and the [ACK] (0x06). Therefore, we remove all
@@ -280,31 +225,30 @@ asynStatus masterMacsController::writeRead(int axisNo, int tcpCmd,
                 response[i] = fullResponse[i + valueStart];
             }
         }
-
         break;
     case asynTimeout:
         snprintf(drvMessageText, sizeof(drvMessageText),
-                 "connection timeout for axis %d", axisNo);
+                 "Connection timeout. Please call the support.");
         break;
     case asynDisconnected:
         snprintf(drvMessageText, sizeof(drvMessageText),
-                 "axis is not connected");
+                 "Axis is not connected.");
         break;
     case asynDisabled:
-        snprintf(drvMessageText, sizeof(drvMessageText), "axis is disabled");
+        snprintf(drvMessageText, sizeof(drvMessageText), "Axis is disabled.");
         break;
     case asynError:
         // Do nothing - error message drvMessageText has already been set.
         break;
     default:
         snprintf(drvMessageText, sizeof(drvMessageText),
-                 "Communication failed (%s)", stringifyAsynStatus(status));
+                 "Communication failed (%s). Please call the support.",
+                 stringifyAsynStatus(status));
         break;
     }
 
     // Log the overall status (communication successfull or not)
     if (status == asynSuccess) {
-        adjustForPrint(printableResponse, fullResponse, MAXBUF_);
         pl_status = axis->setIntegerParam(this->motorStatusCommsError_, 0);
     } else {
 
@@ -361,12 +305,21 @@ asynStatus masterMacsController::parseResponse(
 
     bool responseValid = false;
     int responseStart = 0;
+    asynStatus status = asynSuccess;
+    int prevConnected = 0;
     char printableCommand[MAXBUF_] = {0};
     char printableResponse[MAXBUF_] = {0};
 
     msgPrintControlKey parseKey =
         msgPrintControlKey(portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
 
+    // Was the motor previously connected?
+    status = getIntegerParam(axisNo, motorConnected(), &prevConnected);
+    if (status != asynSuccess) {
+        return paramLibAccessFailed(status, "motorConnected", axisNo,
+                                    __PRETTY_FUNCTION__, __LINE__);
+    }
+
     // We don't use strlen here since the C string terminator 0x00
     // occurs in the middle of the char array.
     for (uint32_t i = 0; i < MAXBUF_; i++) {
@@ -375,20 +328,75 @@ asynStatus masterMacsController::parseResponse(
         } else if (fullResponse[i] == '=') {
             *valueStart = i + 1;
         } else if (fullResponse[i] == '\x06') {
+            // ACK
             *valueStop = i;
             responseValid = true;
-            break;
-        } else if (fullResponse[i] == '\x15') {
-            // NAK
-            snprintf(drvMessageText, MAXBUF_, "Communication failed.");
 
-            if (msgPrintControl_.shouldBePrinted(parseKey, true,
-                                                 pasynUserSelf)) {
+            // Motor wasn't connected before -> Update the paramLib entry and PV
+            // to show it is now connected.
+            if (prevConnected == 0) {
+
                 asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
                           "Controller \"%s\", axis %d => %s, line "
-                          "%d:\nCommunication failed.%s\n",
-                          portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
-                          msgPrintControl_.getSuffix());
+                          "%d:\nAxis connection status has changed to "
+                          "connected.\n",
+                          portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
+
+                masterMacsAxis *axis = getMasterMacsAxis(axisNo);
+                if (axis == nullptr) {
+                    return asynError;
+                }
+                status = axis->setIntegerParam(motorConnected(), 1);
+                if (status != asynSuccess) {
+                    return paramLibAccessFailed(status, "motorConnected",
+                                                axisNo, __PRETTY_FUNCTION__,
+                                                __LINE__);
+                }
+                status = callParamCallbacks();
+                if (status != asynSuccess) {
+                    asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
+                              "Controller \"%s\", axis %d => %s, line "
+                              "%d:\nCould not update parameter library\n",
+                              portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
+                    return status;
+                }
+            }
+
+            break;
+        } else if (fullResponse[i] == '\x15') {
+            /*
+            NAK
+            This indicates that the axis is not connected. This is not an error!
+            */
+            snprintf(drvMessageText, MAXBUF_, "Axis not connected.");
+
+            // Motor was connected before -> Update the paramLib entry and PV
+            // to show it is now disconnected.
+            if (prevConnected == 1) {
+                asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
+                          "Controller \"%s\", axis %d => %s, line "
+                          "%d:\nAxis connection status has changed to "
+                          "disconnected.\n",
+                          portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
+
+                masterMacsAxis *axis = getMasterMacsAxis(axisNo);
+                if (axis == nullptr) {
+                    return asynError;
+                }
+                status = axis->setIntegerParam(motorConnected(), 0);
+                if (status != asynSuccess) {
+                    return paramLibAccessFailed(status, "motorConnected",
+                                                axisNo, __PRETTY_FUNCTION__,
+                                                __LINE__);
+                }
+                status = callParamCallbacks();
+                if (status != asynSuccess) {
+                    asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
+                              "Controller \"%s\", axis %d => %s, line "
+                              "%d:\nCould not update parameter library\n",
+                              portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
+                    return status;
+                }
             }
             break;
         } else if (fullResponse[i] == '\x18') {
@@ -399,6 +407,7 @@ asynStatus masterMacsController::parseResponse(
 
             if (msgPrintControl_.shouldBePrinted(parseKey, true,
                                                  pasynUserSelf)) {
+                adjustForPrint(printableCommand, fullCommand, MAXBUF_);
                 asynPrint(
                     this->pasynUserSelf, ASYN_TRACE_ERROR,
                     "Controller \"%s\", axis %d => %s, line %d:\nTried to "
@@ -438,13 +447,13 @@ asynStatus masterMacsController::parseResponse(
 
             if (msgPrintControl_.shouldBePrinted(parseKey, true,
                                                  pasynUserSelf)) {
-                asynPrint(
-                    this->pasynUserSelf, ASYN_TRACEIO_DRIVER,
-                    "Controller \"%s\", axis %d => %s, line %d:\nMismatched "
-                    "response %s to command %s.%s\n",
-                    portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
-                    printableResponse, printableCommand,
-                    msgPrintControl_.getSuffix());
+                asynPrint(this->pasynUserSelf, ASYN_TRACEIO_DRIVER,
+                          "Controller \"%s\", axis %d => %s, line "
+                          "%d:\nMismatched "
+                          "response %s to command %s.%s\n",
+                          portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
+                          printableResponse, printableCommand,
+                          msgPrintControl_.getSuffix());
             }
 
             snprintf(drvMessageText, MAXBUF_,
@@ -459,7 +468,8 @@ asynStatus masterMacsController::parseResponse(
     return asynSuccess;
 }
 
-asynStatus sinqController::readInt32(asynUser *pasynUser, epicsInt32 *value) {
+asynStatus masterMacsController::readInt32(asynUser *pasynUser,
+                                           epicsInt32 *value) {
     // masterMacs can be disabled
     if (pasynUser->reason == motorCanDisable_) {
         *value = 1;

src/masterMacsController.h

@@ -31,6 +31,15 @@ class masterMacsController : public sinqController {
                          int numAxes, double movingPollPeriod,
                          double idlePollPeriod, double comTimeout);
 
+    /**
+     * @brief Overloaded version of the sinqController version
+     *
+     * @param pasynUser
+     * @param value
+     * @return asynStatus
+     */
+    asynStatus readInt32(asynUser *pasynUser, epicsInt32 *value);
+
     /**
      * @brief Get the axis object
      *
@@ -118,6 +127,13 @@ class masterMacsController : public sinqController {
     // responses from it.
     static const uint32_t MAXBUF_ = 200;
 
+    /**
+     * @brief Get the communication timeout used in the writeRead command
+     *
+     * @return double Timeout in seconds
+     */
+    double comTimeout() { return comTimeout_; }
+
   private:
     /*
     Stores the constructor input comTimeout

utils/writeRead.py

@@ -0,0 +1,171 @@
+#!/usr/bin/env python3
+"""
+This script allows direct interaction with a MasterMACS-Controller over an ethernet connection.
+To read the manual, simply run this script without any arguments.
+
+Stefan Mathis, April 2025
+"""
+
+import struct
+import socket
+import curses
+
+def packMasterMacsCommand(command):
+    # 0x0D = Carriage return 
+    buf = struct.pack('B',0x0D)
+    buf = bytes(command,'utf-8') + buf
+    return bytes(command,'utf-8')
+
+def readMasterMacsReply(input):
+    msg = bytearray()
+    expectAck = True
+    while True:
+        b = input.recv(1)
+        bint = int.from_bytes(b,byteorder='little')
+        if bint == 2 or bint == 7: #STX or BELL
+            expectAck = False
+            continue
+        if expectAck and bint == 6: # ACK
+            return bytes(msg)
+        else:
+            if bint == 13 and not expectAck: # CR
+                return bytes(msg)
+            else:
+                msg.append(bint)
+
+if __name__ == "__main__":
+    from sys import argv
+
+    try:
+
+        addr = argv[1].split(':')
+        s = socket.socket(socket.AF_INET,socket.SOCK_STREAM)
+        s.connect((addr[0],int(addr[1])))
+
+        if len(argv) == 3:
+            buf = packMasterMacsCommand(argv[2])
+            s.send(buf)
+            reply = readMasterMacsReply(s)
+            print(reply.decode('utf-8') + '\n')
+
+        else:
+
+            try:
+
+                stdscr = curses.initscr()
+                curses.noecho()
+                curses.cbreak()
+                stdscr.keypad(True)
+                stdscr.scrollok(True)
+
+                stdscr.addstr(">> ")
+                stdscr.refresh()
+
+                history = [""]
+                ptr = len(history) - 1
+
+                while True:
+                    c = stdscr.getch()
+                    if c == curses.KEY_RIGHT:
+                        (y, x) = stdscr.getyx()
+                        if x < len(history[ptr]) + 3:
+                            stdscr.move(y, x+1)
+                            stdscr.refresh()
+                    elif c == curses.KEY_LEFT:
+                        (y, x) = stdscr.getyx()
+                        if x > 3:
+                            stdscr.move(y, x-1)
+                            stdscr.refresh()
+                    elif c == curses.KEY_UP:
+                        if ptr > 0:
+                            ptr -= 1
+                            stdscr.addch("\r")
+                            stdscr.clrtoeol() 
+                            stdscr.addstr(">> " + history[ptr])
+                    elif c == curses.KEY_DOWN:
+                        if ptr < len(history) - 1:
+                            ptr += 1
+                            stdscr.addch("\r")
+                            stdscr.clrtoeol() 
+                            stdscr.addstr(">> " + history[ptr])
+                    elif c == curses.KEY_ENTER or c == ord('\n') or c == ord('\r'):
+                        if history[ptr] == 'quit':
+                            break
+
+                        # because of arrow keys move back to the end of the line
+                        (y, x) = stdscr.getyx()
+                        stdscr.move(y, 3+len(history[ptr]))
+
+                        if history[ptr]:
+                            buf = packMasterMacsCommand(history[ptr])
+                            s.send(buf)
+                            reply = readMasterMacsReply(s)
+                            stdscr.addstr("\n" + reply.decode('utf-8')[0:-1])
+
+                        if ptr == len(history) - 1 and history[ptr] != "":
+                            history += [""]
+                        else:
+                            history[-1] = ""
+                        ptr = len(history) - 1
+
+                        stdscr.addstr("\n>> ")
+                        stdscr.refresh()
+
+                    else:
+                        if ptr < len(history) - 1: # Modifying previous input
+                            if len(history[-1]) == 0:
+                                history[-1] = history[ptr]
+                                ptr = len(history) - 1
+
+                            else:
+                                history += [history[ptr]]
+                                ptr = len(history) - 1
+
+                        if c == curses.KEY_BACKSPACE:
+                            if len(history[ptr]) == 0:
+                                continue
+                            (y, x) = stdscr.getyx()
+                            history[ptr] = history[ptr][0:x-4] + history[ptr][x-3:]
+                            stdscr.addch("\r")
+                            stdscr.clrtoeol() 
+                            stdscr.addstr(">> " + history[ptr])
+                            stdscr.move(y, x-1)
+                            stdscr.refresh()
+
+                        else:
+                            (y, x) = stdscr.getyx()
+                            history[ptr] = history[ptr][0:x-3] + chr(c) + history[ptr][x-3:]
+                            stdscr.addch("\r")
+                            stdscr.clrtoeol() 
+                            stdscr.addstr(">> " + history[ptr])
+                            stdscr.move(y, x+1)
+                            stdscr.refresh()
+
+            finally:
+
+                # to quit
+                curses.nocbreak()
+                stdscr.keypad(False)
+                curses.echo()
+                curses.endwin()
+
+    except:
+        print("""
+        Invalid Arguments
+
+        Option 1: Single Command
+        ------------------------
+
+        Usage: writeRead.py pmachost:port command
+        This then returns the response for command. 
+
+        Option 2: CLI Mode
+        ------------------
+
+        Usage: writeRead.py pmachost:port
+
+        You can then type in a command, hit enter, and the response will see
+        the reponse, before being prompted to again enter a command. Type
+        'quit' to close prompt.
+        """)
+