Updated sinqMotor to new 1.6.0

See comment in src/masterMacsAxis.cpp, line 640ff.

.gitignore

@@ -0,0 +1,4 @@
+O.*
+.cvsignore
+.vscode
+utils/__pycache__

Makefile

@@ -9,6 +9,8 @@ ARCH_FILTER=RHEL%
 # Specify the version of asynMotor we want to build against
 motorBase_VERSION=7.2.2
 
+LIBVERSION=homeerror
+
 # These headers allow to depend on this library for derived drivers.
 HEADERS += src/masterMacsAxis.h
 HEADERS += src/masterMacsController.h
@@ -29,7 +31,8 @@ TEMPLATES += db/masterMacs.db
 DBDS += sinqMotor/src/sinqMotor.dbd
 DBDS += src/masterMacs.dbd
 
-USR_CFLAGS += -Wall -Wextra -Weffc++ -Wunused-result -Wextra -Werror
+USR_CFLAGS += -Wall -Wextra -Wunused-result -Wextra -Werror
+USR_CXXFLAGS += -Wall -Wextra -Wunused-result
 
 # These flags define the expected firmware version. See README.md, section
 # "Firmware version checking" for details.

README.md

@@ -17,23 +17,50 @@ The folder "utils" contains utility scripts for working with masterMacs motor co
 - 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
+These scripts can be run from anywhere. On Linux, the shebang (#!) automatically
+calls the system Python 3 executable:
 
-### Usage in IOC shell
+```bash
+# To show the help, use either flag -h or --help (works on all scripts)
+/path/to/mastermacs_repo/utils/decodeStatus.py -h 
+/path/to/mastermacs_repo/utils/decodeError.py --help
+/path/to/mastermacs_repo/utils/writeRead.py -h
 
-masterMacs exposes the following IOC shell functions (all in masterMacsController.cpp):
+# To run in non-interactive mode, give the value as an argument
+/path/to/mastermacs_repo/utils/decodeStatus.py 1234
+/path/to/mastermacs_repo/utils/decodeError.py 5678
+/path/to/mastermacs_repo/utils/writeRead.py "R11"
+
+# To run in interactive mode, don't give any argument. This only works on Linux
+/path/to/mastermacs_repo/utils/decodeStatus.py
+/path/to/mastermacs_repo/utils/decodeError.py
+/path/to/mastermacs_repo/utils/writeRead.py
+```
+
+To use these scripts on Windows, prefix the Python 3 executable:
+```bash
+C:/path/to/python3.exe C:/path/to/mastermacs_repo/utils/decodeStatus.py 1234
+```
+
+### IOC startup script
+
+masterMacs exposes the following IOC shell functions:
 - `masterMacsController`: Create a new controller object.
 - `masterMacsAxis`: Create a new axis object.
 
-The full mcu.cmd file looks like this:
+The full masterMacsX.cmd file looks like this:
 
-```
+```bash
 # Define the name of the controller and the corresponding port
 epicsEnvSet("NAME","mcu")
 epicsEnvSet("ASYN_PORT","p$(NAME)")
 
-# Create the TCP/IP socket used to talk with the controller. The socket can be adressed from within the IOC shell via the port name
-drvAsynIPPortConfigure("$(ASYN_PORT)","172.28.101.24:1025")
+# Create the TCP/IP socket used to talk with the controller. The socket can be
+# adressed from within the IOC shell via the port name
+# We do not use the standard asyn port driver here, but a PMAC-specific one
+# which enables the usage of StreamDevices for
+# communicating with the controller directly.
+masterMacsAsynIPPortConfigure("$(ASYN_PORT)","172.28.101.24:1025")
 
 # Create the controller object with the defined name and connect it to the socket via the port name.
 # The other parameters are as follows:
@@ -62,6 +89,8 @@ dbLoadTemplate("$(TOP)/$(NAME).substitutions", "INSTR=$(INSTR)$(NAME):,CONTROLLE
 dbLoadRecords("$(masterMacs_DB)/asynRecord.db","P=$(INSTR)$(NAME),PORT=$(ASYN_PORT)")
 ```
 
+## Developer guide
+
 ### Versioning
 
 Please see the documentation for the module sinqMotor: https://git.psi.ch/sinq-epics-modules/sinqmotor/-/blob/main/README.md.

db/masterMacs.db

@@ -5,3 +5,13 @@ record(longout, "$(INSTR)$(M):NodeReset") {
     field(OUT, "@asyn($(CONTROLLER),$(AXIS),1) NODE_RESET")
     field(PINI, "NO")
 }
+
+# Overrides the default value for the "Connected" record provided by sinqMotor.
+record(longin, "$(INSTR)$(M):Connected")
+{
+    field(DTYP, "asynInt32")
+    field(INP,  "@asyn($(CONTROLLER),$(AXIS)) MOTOR_CONNECTED")
+    field(SCAN, "I/O Intr")
+    field(PINI, "NO")
+    field(VAL, "0")
+}

src/masterMacsAxis.cpp

@@ -23,6 +23,7 @@ struct masterMacsAxisImpl {
     time_t timeAtHandshake;
     bool needInit = true;
     bool targetReachedUninitialized;
+    bool dynamicLimits;
 };
 
 /*
@@ -85,7 +86,15 @@ void appendErrorMessage(char *fullMessage, size_t capacityFullMessage,
 }
 
 masterMacsAxis::masterMacsAxis(masterMacsController *pC, int axisNo)
-    : sinqAxis(pC, axisNo), pC_(pC) {
+    : sinqAxis(pC, axisNo), pC_(pC),
+      pMasterMacsA_(std::make_unique<masterMacsAxisImpl>((masterMacsAxisImpl){
+          .axisStatus = std::bitset<16>(0),
+          .axisError = std::bitset<16>(0),
+          .waitForHandshake = false,
+          .timeAtHandshake = 0,
+          .targetReachedUninitialized = true,
+          .dynamicLimits = false,
+      })) {
 
     asynStatus status = asynSuccess;
 
@@ -118,14 +127,6 @@ masterMacsAxis::masterMacsAxis(masterMacsController *pC, int axisNo)
     // Collect all axes into this list which will be used in the hook function
     axes.push_back(this);
 
-    pMasterMacsA_ = std::make_unique<masterMacsAxisImpl>((masterMacsAxisImpl){
-        .axisStatus = std::bitset<16>(0),
-        .axisError = std::bitset<16>(0),
-        .waitForHandshake = false,
-        .timeAtHandshake = 0,
-        .targetReachedUninitialized = true,
-    });
-
     // masterMacs motors can always be disabled
     status = pC_->setIntegerParam(axisNo_, pC_->motorCanDisable(), 1);
     if (status != asynSuccess) {
@@ -180,14 +181,16 @@ Read out the following values:
 asynStatus masterMacsAxis::init() {
 
     // Local variable declaration
-    asynStatus pl_status = asynSuccess;
+    asynStatus status = asynSuccess;
     char response[pC_->MAXBUF_] = {0};
     int nvals = 0;
-    double motorRecResolution = 0.0;
-    double motorPosition = 0.0;
-    double motorVelocity = 0.0;
-    double motorVmax = 0.0;
-    double motorAccel = 0.0;
+    double motRecResolution = 0.0;
+    double motPosition = 0.0;
+    double motPositionDeadband = 0.0;
+    double motVelocity = 0.0;
+    double motVmax = 0.0;
+    double motAccel = 0.0;
+    int dynamicLimits = 0;
 
     // =========================================================================
 
@@ -196,9 +199,9 @@ asynStatus masterMacsAxis::init() {
     time_t now = time(NULL);
     time_t maxInitTime = 60;
     while (1) {
-        pl_status = pC_->getDoubleParam(axisNo_, pC_->motorRecResolution(),
-                                        &motorRecResolution);
-        if (pl_status == asynParamUndefined) {
+        status = pC_->getDoubleParam(axisNo_, pC_->motorRecResolution(),
+                                     &motRecResolution);
+        if (status == asynParamUndefined) {
             if (now + maxInitTime < time(NULL)) {
                 asynPrint(pC_->pasynUser(), ASYN_TRACE_ERROR,
                           "Controller \"%s\", axis %d  => %s, line "
@@ -207,83 +210,114 @@ asynStatus masterMacsAxis::init() {
                           __LINE__);
                 return asynError;
             }
-        } else if (pl_status == asynSuccess) {
+        } else if (status == asynSuccess) {
             break;
-        } else if (pl_status != asynSuccess) {
-            return pC_->paramLibAccessFailed(pl_status, "motorRecResolution_",
+        } else if (status != asynSuccess) {
+            return pC_->paramLibAccessFailed(status, "motorRecResolution_",
                                              axisNo_, __PRETTY_FUNCTION__,
                                              __LINE__);
         }
     }
 
+    // Initially assume that the axis is disconnected. It will be set to
+    // connected after the first communication attempted succeeded.
+    setAxisParamChecked(this, motorConnected, false);
+
     // Read out the current position
-    pl_status = pC_->read(axisNo_, 12, response);
-    if (pl_status != asynSuccess) {
-        return pl_status;
+    status = pC_->read(axisNo_, 12, response);
+    if (status != asynSuccess) {
+        return status;
     }
-    nvals = sscanf(response, "%lf", &motorPosition);
+    nvals = sscanf(response, "%lf", &motPosition);
     if (nvals != 1) {
         return pC_->couldNotParseResponse("R12", response, axisNo_,
                                           __PRETTY_FUNCTION__, __LINE__);
     }
+    status = setMotorPosition(motPosition);
+    if (status != asynSuccess) {
+        return status;
+    }
 
     // Read out the current velocity
-    pl_status = pC_->read(axisNo_, 05, response);
-    if (pl_status != asynSuccess) {
-        return pl_status;
+    status = pC_->read(axisNo_, 05, response);
+    if (status != asynSuccess) {
+        return status;
     }
-    nvals = sscanf(response, "%lf", &motorVelocity);
+    nvals = sscanf(response, "%lf", &motVelocity);
     if (nvals != 1) {
         return pC_->couldNotParseResponse("R05", response, axisNo_,
                                           __PRETTY_FUNCTION__, __LINE__);
     }
 
     // Read out the maximum velocity
-    pl_status = pC_->read(axisNo_, 26, response);
-    if (pl_status != asynSuccess) {
-        return pl_status;
+    status = pC_->read(axisNo_, 26, response);
+    if (status != asynSuccess) {
+        return status;
     }
-    nvals = sscanf(response, "%lf", &motorVmax);
+    nvals = sscanf(response, "%lf", &motVmax);
     if (nvals != 1) {
         return pC_->couldNotParseResponse("R26", response, axisNo_,
                                           __PRETTY_FUNCTION__, __LINE__);
     }
 
-    // Read out the acceleration
-    pl_status = pC_->read(axisNo_, 06, response);
-    if (pl_status != asynSuccess) {
-        return pl_status;
+    status = setVeloFields(motVelocity, 0.0, motVmax);
+    if (status != asynSuccess) {
+        return status;
     }
-    nvals = sscanf(response, "%lf", &motorAccel);
+
+    // Read out the acceleration
+    status = pC_->read(axisNo_, 06, response);
+    if (status != asynSuccess) {
+        return status;
+    }
+    nvals = sscanf(response, "%lf", &motAccel);
     if (nvals != 1) {
         return pC_->couldNotParseResponse("R06", response, axisNo_,
                                           __PRETTY_FUNCTION__, __LINE__);
     }
-
-    // Store the motor position in the parameter library
-    pl_status = setMotorPosition(motorPosition);
-    if (pl_status != asynSuccess) {
-        return pl_status;
+    status = setAcclField(motAccel);
+    if (status != asynSuccess) {
+        return status;
     }
 
-    // Write to the motor record fields
-    pl_status = setVeloFields(motorVelocity, 0.0, motorVmax);
-    if (pl_status != asynSuccess) {
-        return pl_status;
+    // Read out the motor position deadband
+    status = pC_->read(axisNo_, 13, response);
+    if (status != asynSuccess) {
+        return status;
     }
-    pl_status = setAcclField(motorAccel);
-    if (pl_status != asynSuccess) {
-        return pl_status;
+    nvals = sscanf(response, "%lf", &motPositionDeadband);
+    if (nvals != 1) {
+        return pC_->couldNotParseResponse("R13", response, axisNo_,
+                                          __PRETTY_FUNCTION__, __LINE__);
+    }
+    setAxisParamChecked(this, motorPositionDeadband, motPositionDeadband);
+
+    // Check if the motor has dynamic limits
+    status = pC_->read(axisNo_, 32, response);
+    if (status != asynSuccess) {
+        return status;
+    }
+    nvals = sscanf(response, "%d", &dynamicLimits);
+    if (nvals != 1) {
+        return pC_->couldNotParseResponse("R32", response, axisNo_,
+                                          __PRETTY_FUNCTION__, __LINE__);
+    }
+    pMasterMacsA_->dynamicLimits = bool(dynamicLimits);
+
+    status = readEncoderType();
+    if (status != asynSuccess) {
+        return status;
     }
 
-    pl_status = readEncoderType();
-    if (pl_status != asynSuccess) {
-        return pl_status;
+    // Read the axis limits
+    status = readLimits();
+    if (status != asynSuccess) {
+        return status;
     }
 
     // Update the parameter library immediately
-    pl_status = callParamCallbacks();
-    if (pl_status != asynSuccess) {
+    status = callParamCallbacks();
+    if (status != asynSuccess) {
         // 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
@@ -291,14 +325,71 @@ asynStatus masterMacsAxis::init() {
                   "Controller \"%s\", axis %d => %s, line "
                   "%d:\ncallParamCallbacks failed with %s.\n",
                   pC_->portName, axisNo_, __PRETTY_FUNCTION__, __LINE__,
-                  pC_->stringifyAsynStatus(pl_status));
-        return pl_status;
+                  pC_->stringifyAsynStatus(status));
+        return status;
     }
 
     // Axis is fully initialized
     setNeedInit(false);
 
-    return pl_status;
+    return status;
+}
+
+asynStatus masterMacsAxis::readLimits() {
+
+    asynStatus status = asynSuccess;
+
+    char response[pC_->MAXBUF_] = {0};
+    int nvals = 0;
+
+    double highLimit = 0.0;
+    double lowLimit = 0.0;
+    double limitsOffset = 0.0;
+
+    // =========================================================================
+
+    status = pC_->read(axisNo_, 34, response);
+    if (status != asynSuccess) {
+        return status;
+    }
+    nvals = sscanf(response, "%lf", &lowLimit);
+    if (nvals != 1) {
+        return pC_->couldNotParseResponse("R34", response, axisNo_,
+                                          __PRETTY_FUNCTION__, __LINE__);
+    }
+
+    status = pC_->read(axisNo_, 33, response);
+    if (status != asynSuccess) {
+        return status;
+    }
+    nvals = sscanf(response, "%lf", &highLimit);
+    if (nvals != 1) {
+        return pC_->couldNotParseResponse("R33", response, axisNo_,
+                                          __PRETTY_FUNCTION__, __LINE__);
+    }
+
+    /*
+    The axis limits are set as: ({[]})
+    where [] are the positive and negative limits set in EPICS/NICOS, {} are
+    the software limits set on the MCU and () are the hardware limit
+    switches. In other words, the EPICS/NICOS limits must be stricter than
+    the software limits on the MCU which in turn should be stricter than the
+    hardware limit switches. For example, if the hardware limit switches are
+    at [-10, 10], the software limits could be at [-9, 9] and the EPICS /
+    NICOS limits could be at
+    [-8, 8]. Therefore, we cannot use the software limits read from the MCU
+    directly, but need to shrink them a bit. In this case, we're shrinking
+    them by 0.1 mm or 0.1 degree (depending on the axis type) on both sides.
+    */
+    getAxisParamChecked(this, motorLimitsOffset, &limitsOffset);
+
+    highLimit = highLimit - limitsOffset;
+    lowLimit = lowLimit + limitsOffset;
+
+    setAxisParamChecked(this, motorHighLimitFromDriver, highLimit);
+    setAxisParamChecked(this, motorLowLimitFromDriver, lowLimit);
+
+    return status;
 }
 
 // Perform the actual poll
@@ -321,19 +412,15 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
     double currentPosition = 0.0;
     double previousPosition = 0.0;
     double motorRecResolution = 0.0;
-    double highLimit = 0.0;
-    double lowLimit = 0.0;
-    double limitsOffset = 0.0;
     double handshakePerformed = 0;
 
     // =========================================================================
 
-    // Does the axis need to be intialized?
+    // Does the axis need to be initialized?
     if (needInit()) {
-        rw_status = init();
-        if (rw_status != asynSuccess) {
-            return rw_status;
-        }
+        // Perform the rest of the poll, but remember if sth. failed in the
+        // init.
+        poll_status = init();
     }
 
     // Are we currently waiting for a handshake?
@@ -509,42 +596,83 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
         }
 
         /*
-        Either the software limits or the end switches of the controller
-        have been hit. Since the EPICS limits are derived from the software
-        limits and are a little bit smaller, these error cases can only
-        happen if either the axis has an incremental encoder which is not
-        properly homed or if a bug occured.
+        If the motor is homing or has been homed, ignore limit switch errors.
+         */
+        int homing = 0;
+        int homed = 0;
+        getAxisParamChecked(this, motorStatusHome, &homing);
+        getAxisParamChecked(this, motorStatusHomed, &homed);
+
+        /*
+        Ignore limit switch errors when homing / motor has been homed or when
+        the motor is moving.
+
+        Background:
+        MasterMACS controllers move the motor outside the allowed range defined
+        by the "software limits" defined within the controllers because they
+        need to hit the physical end switch to determine the motor position. The
+        motor then rests close to the end switch, which might be outside the
+        controller-side software limits. This leads to this error, which is then
+        forwarded to the user even though nothing went wrong. The three checks
+        are here to prevent this:
+        - "homing": Is set at the start of a homing maneuver and removed once
+        the motor does not move anymore => Prevents the error from showing up
+        during the homing procedure
+        - "homed": Is set after a homing maneuver has been finished => Prevents
+        the error from showing up while the motor is resting idle outside the
+        software limits.
+        - "moving": Prevents the error from showing up when moving out of the
+        homing position.
+
+        If the motor hits the limits during normal operation, it is stopped by
+        the controller. Once stopped, moving is false and then the error is
+        shown to the user (because "homed" is not set).
+
+        Note: strictly speaking, it is not necessary to check homing because
+        moving would be set to true anyway. The check is here for clarity /
+        being explicit.
         */
-        if (positiveLimitSwitch() || negativeLimitSwitch() ||
-            positiveSoftwareLimit() || negativeSoftwareLimit()) {
+        if (!homing && !homed && !(*moving)) {
+            /*
+            Either the software limits or the end switches of the controller
+            have been hit. Since the EPICS limits are derived from the software
+            limits and are a little bit smaller, these error cases can only
+            happen if either the axis has an incremental encoder which is not
+            properly homed or if the motor moved outside the limits while homing
+            (but in that case, the error is not shown, see previous
+            if-statement).
+            */
+            if (positiveLimitSwitch() || negativeLimitSwitch() ||
+                positiveSoftwareLimit() || negativeSoftwareLimit()) {
 
-            // Distinction for developers
-            if (positiveLimitSwitch()) {
-                appendErrorMessage(shellMessage, sizeof(shellMessage),
-                                   "Positive limit switch.");
-            }
-            if (negativeLimitSwitch()) {
-                appendErrorMessage(shellMessage, sizeof(shellMessage),
-                                   "Negative limit switch.");
-            }
-            if (positiveSoftwareLimit()) {
-                appendErrorMessage(shellMessage, sizeof(shellMessage),
-                                   "Positive software limit.");
-            }
-            if (negativeSoftwareLimit()) {
-                appendErrorMessage(shellMessage, sizeof(shellMessage),
-                                   "Negative software limit.");
-            }
+                // Distinction for developers
+                if (positiveLimitSwitch()) {
+                    appendErrorMessage(shellMessage, sizeof(shellMessage),
+                                       "Positive limit switch.");
+                }
+                if (negativeLimitSwitch()) {
+                    appendErrorMessage(shellMessage, sizeof(shellMessage),
+                                       "Negative limit switch.");
+                }
+                if (positiveSoftwareLimit()) {
+                    appendErrorMessage(shellMessage, sizeof(shellMessage),
+                                       "Positive software limit.");
+                }
+                if (negativeSoftwareLimit()) {
+                    appendErrorMessage(shellMessage, sizeof(shellMessage),
+                                       "Negative software limit.");
+                }
 
-            // Generic error message for user
-            appendErrorMessage(
-                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 "
-                "support.");
+                // Generic error message for user
+                appendErrorMessage(
+                    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 "
+                    "support.");
 
-            poll_status = asynError;
+                poll_status = asynError;
+            }
         }
 
         if (overCurrent()) {
@@ -612,48 +740,13 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
         pC_->getMsgPrintControl().resetCount(keyError, pC_->pasynUser());
     }
 
-    // Read out the limits, if the motor is not moving
-    if (!(*moving)) {
-        rw_status = pC_->read(axisNo_, 34, response);
+    // Read out the limits, if the motor is not moving and if the limits are
+    // dynamic
+    if (pMasterMacsA_->dynamicLimits && !(*moving)) {
+        rw_status = readLimits();
         if (rw_status != asynSuccess) {
             return rw_status;
         }
-        nvals = sscanf(response, "%lf", &lowLimit);
-        if (nvals != 1) {
-            return pC_->couldNotParseResponse("R34", response, axisNo_,
-                                              __PRETTY_FUNCTION__, __LINE__);
-        }
-
-        rw_status = pC_->read(axisNo_, 33, response);
-        if (rw_status != asynSuccess) {
-            return rw_status;
-        }
-        nvals = sscanf(response, "%lf", &highLimit);
-        if (nvals != 1) {
-            return pC_->couldNotParseResponse("R33", response, axisNo_,
-                                              __PRETTY_FUNCTION__, __LINE__);
-        }
-
-        /*
-        The axis limits are set as: ({[]})
-        where [] are the positive and negative limits set in EPICS/NICOS, {} are
-        the software limits set on the MCU and () are the hardware limit
-        switches. In other words, the EPICS/NICOS limits must be stricter than
-        the software limits on the MCU which in turn should be stricter than the
-        hardware limit switches. For example, if the hardware limit switches are
-        at [-10, 10], the software limits could be at [-9, 9] and the EPICS /
-        NICOS limits could be at
-        [-8, 8]. Therefore, we cannot use the software limits read from the MCU
-        directly, but need to shrink them a bit. In this case, we're shrinking
-        them by 0.1 mm or 0.1 degree (depending on the axis type) on both sides.
-        */
-        getAxisParamChecked(this, motorLimitsOffset, &limitsOffset);
-
-        highLimit = highLimit - limitsOffset;
-        lowLimit = lowLimit + limitsOffset;
-
-        setAxisParamChecked(this, motorHighLimitFromDriver, highLimit);
-        setAxisParamChecked(this, motorLowLimitFromDriver, lowLimit);
     }
 
     // Update the enable PV
@@ -684,14 +777,74 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
     return poll_status;
 }
 
-asynStatus masterMacsAxis::doMove(double position, int relative,
-                                  double minVelocity, double maxVelocity,
-                                  double acceleration) {
+asynStatus masterMacsAxis::doMoveVelocity(double minVelocity,
+                                          double maxVelocity,
+                                          double acceleration) {
+    // Suppress unused variable warning
+    (void)minVelocity;
+    (void)acceleration;
 
     // Status of read-write-operations of ASCII commands to the controller
     asynStatus status = asynSuccess;
 
-    char value[pC_->MAXBUF_];
+    char command[pC_->MAXBUF_];
+
+    double motorRecResolution = 0.0;
+    double motorVelocity = 0.0;
+    int enabled = 0;
+
+    // =========================================================================
+
+    getAxisParamChecked(this, motorEnableRBV, &enabled);
+    getAxisParamChecked(this, motorRecResolution, &motorRecResolution);
+
+    if (enabled == 0) {
+        asynPrint(pC_->pasynUser(), ASYN_TRACE_ERROR,
+                  "Controller \"%s\", axis %d => %s, line %d:\nAxis is "
+                  "disabled.\n",
+                  pC_->portName, axisNo_, __PRETTY_FUNCTION__, __LINE__);
+        return asynSuccess;
+    }
+
+    // Convert from EPICS to user / motor units
+    motorVelocity = maxVelocity * motorRecResolution;
+
+    snprintf(command, sizeof(command), "%lf", motorVelocity);
+    status = pC_->write(axisNo_, 05, command);
+    if (status != asynSuccess) {
+        setAxisParamChecked(this, motorStatusProblem, true);
+        return status;
+    }
+
+    asynPrint(pC_->pasynUser(), ASYN_TRACE_FLOW,
+              "Controller \"%s\", axis %d => %s, line %d:\nSetting speed "
+              "to %lf.\n",
+              pC_->portName, axisNo_, __PRETTY_FUNCTION__, __LINE__,
+              motorVelocity);
+
+    double timeout = pC_->comTimeout();
+    if (pMasterMacsA_->targetReachedUninitialized &&
+        timeout < PowerCycleTimeout) {
+        timeout = PowerCycleTimeout;
+    }
+
+    // Start the move. We do not use the MovTimeout watchdog here, because the
+    // motor can move for any time in velocity mode.
+    return pC_->write(axisNo_, 00, "3", timeout);
+}
+
+asynStatus masterMacsAxis::doMove(double position, int relative,
+                                  double minVelocity, double maxVelocity,
+                                  double acceleration) {
+
+    // Suppress unused variable warning
+    (void)minVelocity;
+    (void)acceleration;
+
+    // Status of read-write-operations of ASCII commands to the controller
+    asynStatus status = asynSuccess;
+
+    char command[pC_->MAXBUF_];
     double motorCoordinatesPosition = 0.0;
     double motorRecResolution = 0.0;
     double motorVelocity = 0.0;
@@ -734,8 +887,8 @@ asynStatus masterMacsAxis::doMove(double position, int relative,
     // motor speed changed since the last move command.
     if (motorCanSetSpeed != 0) {
 
-        snprintf(value, sizeof(value), "%lf", motorVelocity);
-        status = pC_->write(axisNo_, 05, value);
+        snprintf(command, sizeof(command), "%lf", motorVelocity);
+        status = pC_->write(axisNo_, 05, command);
         if (status != asynSuccess) {
             setAxisParamChecked(this, motorStatusProblem, true);
             return status;
@@ -749,14 +902,14 @@ asynStatus masterMacsAxis::doMove(double position, int relative,
     }
 
     // Set the target position
-    snprintf(value, sizeof(value), "%lf", motorCoordinatesPosition);
-    status = pC_->write(axisNo_, 02, value);
+    snprintf(command, sizeof(command), "%lf", motorCoordinatesPosition);
+    status = pC_->write(axisNo_, 02, command);
     if (status != asynSuccess) {
         setAxisParamChecked(this, motorStatusProblem, true);
         return status;
     }
 
-    // If the motor has just been enabled, use Enable
+    // If the motor has just been enabled, use a longer timeout for starting
     double timeout = pC_->comTimeout();
     if (pMasterMacsA_->targetReachedUninitialized &&
         timeout < PowerCycleTimeout) {
@@ -790,6 +943,9 @@ asynStatus masterMacsAxis::doMove(double position, int relative,
 
 asynStatus masterMacsAxis::stop(double acceleration) {
 
+    // Suppress unused variable warning
+    (void)acceleration;
+
     asynStatus status = pC_->write(axisNo_, 00, "8");
     if (status != asynSuccess) {
         setAxisParamChecked(this, motorStatusProblem, true);
@@ -845,13 +1001,19 @@ asynStatus masterMacsAxis::nodeReset() {
 /*
 Home the axis. On absolute encoder systems, this is a no-op
 */
-asynStatus masterMacsAxis::doHome(double min_velocity, double max_velocity,
+asynStatus masterMacsAxis::doHome(double minVelocity, double maxVelocity,
                                   double acceleration, int forwards) {
 
     char response[pC_->MAXBUF_] = {0};
 
     // =========================================================================
 
+    // Suppress unused variable warning
+    (void)minVelocity;
+    (void)maxVelocity;
+    (void)acceleration;
+    (void)forwards;
+
     getAxisParamChecked(this, encoderType, &response);
 
     // Only send the home command if the axis has an incremental encoder
@@ -905,7 +1067,7 @@ asynStatus masterMacsAxis::readEncoderType() {
 
     /*
     Defined encoder IDs:
-    0=INC (Incremental)
+    0=INC (Incremental or no encoder)
     1=SSI (Absolute encoder with SSI interface)
     2=SSI (Absolute encoder with BiSS interface)
      */
@@ -942,9 +1104,7 @@ asynStatus masterMacsAxis::enable(bool on) {
     doPoll(&moving);
 
     // If the axis is currently moving, it cannot be disabled. Ignore the
-    // command and inform the user. We check the last known status of the
-    // axis instead of "moving", since status -6 is also moving, but the
-    // motor can actually be disabled in this state!
+    // command and inform the user.
     if (moving) {
         asynPrint(pC_->pasynUser(), ASYN_TRACE_ERROR,
                   "Controller \"%s\", axis %d => %s, line %d:\nAxis is not "
@@ -1026,6 +1186,28 @@ asynStatus masterMacsAxis::enable(bool on) {
     return asynError;
 }
 
+asynStatus masterMacsAxis::setMode(int mode) {
+
+    char command[pC_->MAXBUF_] = {0};
+
+    // Map the EPICS value to MasterMACS values (see
+    // MasterMACS_manual.pdf).
+    int adjustedMode = 0;
+    if (mode == 0) {
+        adjustedMode = 1;
+    } else if (mode == 1) {
+        adjustedMode = 3;
+    } else {
+        // This branch is unreachable, as it is is already checked
+        // within sinqController::writeInt32 that value is either 0
+        // or 1.
+        return asynError;
+    }
+
+    snprintf(command, sizeof(command), "%d", adjustedMode);
+    return pC_->write(axisNo(), 07, command);
+}
+
 bool masterMacsAxis::needInit() { return pMasterMacsA_->needInit; }
 
 /**
@@ -1246,8 +1428,9 @@ static const iocshArg CreateAxisArg0 = {"Controller name (e.g. mmacs1)",
 static const iocshArg CreateAxisArg1 = {"Axis number", iocshArgInt};
 static const iocshArg *const CreateAxisArgs[] = {&CreateAxisArg0,
                                                  &CreateAxisArg1};
-static const iocshFuncDef configMasterMacsCreateAxis = {"masterMacsAxis", 2,
-                                                        CreateAxisArgs};
+static const iocshFuncDef configMasterMacsCreateAxis = {
+    "masterMacsAxis", 2, CreateAxisArgs,
+    "Create a new instance of a MasterMACS axis."};
 static void configMasterMacsCreateAxisCallFunc(const iocshArgBuf *args) {
     masterMacsCreateAxis(args[0].sval, args[1].ival);
 }

src/masterMacsAxis.h

@@ -16,6 +16,13 @@ class HIDDEN masterMacsAxis : public sinqAxis {
      */
     masterMacsAxis(masterMacsController *pController, int axisNo);
 
+    /**
+     * @brief Delete the copy and copy assignment constructors, because this
+     * class should not be copied (it is tied to hardware!)
+     */
+    masterMacsAxis(const masterMacsAxis &) = delete;
+    masterMacsAxis &operator=(const masterMacsAxis &) = delete;
+
     /**
      * @brief Destroy the masterMacsAxis
      *
@@ -44,19 +51,32 @@ class HIDDEN masterMacsAxis : public sinqAxis {
      */
     asynStatus doPoll(bool *moving);
 
+    /**
+     * @brief Implementation of the `doMoveVelocity` function from sinqAxis. The
+     * parameters are described in the documentation of
+     * `sinqAxis::doMoveVelocity`.
+     *
+     * @param minVelocity
+     * @param maxVelocity
+     * @param acceleration
+     * @return asynStatus
+     */
+    asynStatus doMoveVelocity(double minVelocity, double maxVelocity,
+                              double acceleration);
+
     /**
      * @brief Implementation of the `doMove` function from sinqAxis. The
      * parameters are described in the documentation of `sinqAxis::doMove`.
      *
      * @param position
      * @param relative
-     * @param min_velocity
-     * @param max_velocity
+     * @param minVelocity
+     * @param maxVelocity
      * @param acceleration
      * @return asynStatus
      */
-    asynStatus doMove(double position, int relative, double min_velocity,
-                      double max_velocity, double acceleration);
+    asynStatus doMove(double position, int relative, double minVelocity,
+                      double maxVelocity, double acceleration);
 
     /**
      * @brief Implementation of the `stop` function from asynMotorAxis
@@ -110,6 +130,15 @@ class HIDDEN masterMacsAxis : public sinqAxis {
      */
     asynStatus enable(bool on);
 
+    /**
+     * @brief Write the new operation mode (position or velocity) to the
+     * MasterMACS controller.
+     *
+     * @param mode
+     * @return asynStatus
+     */
+    asynStatus setMode(int mode);
+
     /**
      * @brief Read the encoder type (incremental or absolute) for this axis
      * from the MCU and store the information in the PV ENCODER_TYPE.
@@ -141,163 +170,197 @@ class HIDDEN masterMacsAxis : public sinqAxis {
 
     /**
      * @brief Read the Master MACS status with the xR10 command and store
-     * the result in axisStatus_
+     * the result in axisStatus (see masterMacsAxisImpl redefinition in
+     * masterMacsAxis.cpp)
      *
      */
     asynStatus readAxisStatus();
 
+    /**
+     * @brief Read the upper and lower limits and store them in the parameter
+     * library.
+     */
+    asynStatus readLimits();
+
     /*
-    The functions below read the specified status bit from the axisStatus
-    bitset. Since a bit can either be 0 or 1, the return value is given as a
-    boolean.
+    The functions below read the specified status bit from the axisStatus (see
+    masterMacsAxisImpl redefinition in masterMacsAxis.cpp) bitset. Since a bit
+    can either be 0 or 1, the return value is given as a boolean.
     */
 
     /**
-     * @brief Read the property from axisStatus_
+     * @brief Read the property from axisStatus (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool readyToBeSwitchedOn();
 
     /**
-     * @brief Read the property from axisStatus_
+     * @brief Read the property from axisStatus (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool switchedOn();
 
     // Bit 2 is unused
 
     /**
-     * @brief Read the property from axisStatus_
+     * @brief Read the property from axisStatus (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool faultConditionSet();
 
     /**
-     * @brief Read the property from axisStatus_
+     * @brief Read the property from axisStatus (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool voltagePresent();
 
     /**
-     * @brief Read the property from axisStatus_
+     * @brief Read the property from axisStatus (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool quickStopping();
 
     /**
-     * @brief Read the property from axisStatus_
+     * @brief Read the property from axisStatus (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool switchOnDisabled();
 
     /**
-     * @brief Read the property from axisStatus_
+     * @brief Read the property from axisStatus (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool warning();
 
     // Bit 8 is unused
 
     /**
-     * @brief Read the property from axisStatus_
+     * @brief Read the property from axisStatus (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool remoteMode();
 
     /**
-     * @brief Read the property from axisStatus_
+     * @brief Read the property from axisStatus (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool targetReached();
 
     /**
-     * @brief Read the property from axisStatus_
+     * @brief Read the property from axisStatus (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool internalLimitActive();
 
     // Bits 12 and 13 are unused
 
     /**
-     * @brief Read the property from axisStatus_
+     * @brief Read the property from axisStatus (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool setEventHasOcurred();
 
     /**
-     * @brief Read the property from axisStatus_
+     * @brief Read the property from axisStatus (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool powerEnabled();
 
     /**
-     * @brief Read the Master MACS status with the xR10 command and store
-     * the result in axisStatus_
+     * @brief Read the Master MACS error with the xR10 command and store
+     * the result in axisError (see masterMacsAxisImpl redefinition in
+     * masterMacsAxis.cpp)
      *
      */
     asynStatus readAxisError();
 
     /*
-    The functions below read the specified error bit from the axisError_
-    bitset. Since a bit can either be 0 or 1, the return value is given as a
-    boolean.
+    The functions below read the specified error bit from the axisError (see
+    masterMacsAxisImpl redefinition in masterMacsAxis.cpp) bitset. Since a bit
+    can either be 0 or 1, the return value is given as a boolean.
     */
 
     /**
-     * @brief Read the property from axisError_
+     * @brief Read the property from axisError (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool shortCircuit();
 
     /**
-     * @brief Read the property from axisError_
+     * @brief Read the property from axisError (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool encoderError();
 
     /**
-     * @brief Read the property from axisError_
+     * @brief Read the property from axisError (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool followingError();
 
     /**
-     * @brief Read the property from axisError_
+     * @brief Read the property from axisError (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool communicationError();
 
     /**
-     * @brief Read the property from axisError_
+     * @brief Read the property from axisError (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool feedbackError();
 
     /**
-     * @brief Read the property from axisError_
+     * @brief Read the property from axisError (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool positiveLimitSwitch();
 
     /**
-     * @brief Read the property from axisError_
+     * @brief Read the property from axisError (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool negativeLimitSwitch();
 
     /**
-     * @brief Read the property from axisError_
+     * @brief Read the property from axisError (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool positiveSoftwareLimit();
 
     /**
-     * @brief Read the property from axisError_
+     * @brief Read the property from axisError (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool negativeSoftwareLimit();
 
     /**
-     * @brief Read the property from axisError_
+     * @brief Read the property from axisError (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool overCurrent();
 
     /**
-     * @brief Read the property from axisError_
+     * @brief Read the property from axisError (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool overTemperature();
 
     /**
-     * @brief Read the property from axisError_
+     * @brief Read the property from axisError (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool overVoltage();
 
     /**
-     * @brief Read the property from axisError_
+     * @brief Read the property from axisError (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool underVoltage();
 
     /**
-     * @brief Read the property from axisError_
+     * @brief Read the property from axisError (see masterMacsAxisImpl
+     * redefinition in masterMacsAxis.cpp)
      */
     bool stoFault();
 

src/masterMacsController.cpp

@@ -81,7 +81,12 @@ masterMacsController::masterMacsController(const char *portName,
     : sinqController(portName, ipPortConfigName, numAxes, movingPollPeriod,
                      idlePollPeriod,
                      // No additional parameter library entries
-                     0)
+                     0),
+      pMasterMacsC_(
+          std::make_unique<masterMacsControllerImpl>((masterMacsControllerImpl){
+              .comTimeout = comTimeout,
+              .nodeReset = 0, // Overwritten later
+          }))
 
 {
 
@@ -89,11 +94,6 @@ masterMacsController::masterMacsController(const char *portName,
     asynStatus status = asynSuccess;
     char response[MAXBUF_] = {0};
 
-    pMasterMacsC_ =
-        std::make_unique<masterMacsControllerImpl>((masterMacsControllerImpl){
-            .comTimeout = comTimeout,
-        });
-
     // =========================================================================
     // Create additional parameter library entries
 
@@ -231,7 +231,7 @@ asynStatus masterMacsController::writeInt32(asynUser *pasynUser,
 }
 
 asynStatus masterMacsController::read(int axisNo, int tcpCmd, char *response,
-                                      double comTimeout) {
+                                      double /*comTimeout*/) {
     return writeRead(axisNo, tcpCmd, NULL, response);
 }
 
@@ -429,8 +429,6 @@ asynStatus masterMacsController::parseResponse(
         getAxisParamChecked(axis, motorConnected, &prevConnected);
     }
 
-    // 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++) {
         if (fullResponse[i] == '\x19') {
             responseStart = i;
@@ -572,7 +570,7 @@ asynStatus masterMacsController::readInt32(asynUser *pasynUser,
         *value = 1;
         return asynSuccess;
     } else {
-        return asynMotorController::readInt32(pasynUser, value);
+        return sinqController::readInt32(pasynUser, value);
     }
 }
 
@@ -639,7 +637,8 @@ static const iocshArg *const CreateControllerArgs[] = {
     &CreateControllerArg0, &CreateControllerArg1, &CreateControllerArg2,
     &CreateControllerArg3, &CreateControllerArg4, &CreateControllerArg5};
 static const iocshFuncDef configMasterMacsCreateController = {
-    "masterMacsController", 6, CreateControllerArgs};
+    "masterMacsController", 6, CreateControllerArgs,
+    "Create a new instance of a MasterMACS controller."};
 static void configMasterMacsCreateControllerCallFunc(const iocshArgBuf *args) {
     masterMacsCreateController(args[0].sval, args[1].sval, args[2].ival,
                                args[3].dval, args[4].dval, args[5].dval);

src/masterMacsController.h

@@ -38,6 +38,13 @@ class HIDDEN masterMacsController : public sinqController {
                          int numAxes, double movingPollPeriod,
                          double idlePollPeriod, double comTimeout);
 
+    /**
+     * @brief Delete the copy and copy assignment constructors, because this
+     * class should not be copied (it is tied to hardware!)
+     */
+    masterMacsController(const masterMacsController &) = delete;
+    masterMacsController &operator=(const masterMacsController &) = delete;
+
     /**
      * @brief Overloaded version of the sinqController version
      *
@@ -68,7 +75,8 @@ class HIDDEN masterMacsController : public sinqController {
     /**
      * @brief Overloaded function of sinqController
      *
-     * The function is overloaded to allow resetting the node
+     * The function is overloaded to allow resetting the node and changing the
+     * operation mode.
      *
      * @param pasynUser           Specify the axis via the asynUser
      * @param value               New value

utils/decodeError.py

@@ -9,73 +9,82 @@ To read the manual, simply run this script without any arguments.
 Stefan Mathis, January 2025
 """
 
+import platform
+
 from decodeCommon import interactive, decode, print_decoded
 
 # List of tuples which encodes the states given in the file description.
 # Index first with the bit index, then with the bit value
 interpretation = [
-    ("Not specified", "Not specified"), # Bit 0
-    ("Ok", "Short circuit"), # Bit 1
-    ("Ok", "Encoder error"), # Bit 2
-    ("Ok", "Following error"), # Bit 3
-    ("Ok", "Communication error"), # Bit 4
-    ("Ok", "Feedback error"), # Bit 5
-    ("Ok", "Positive limit switch hit"), # Bit 6
-    ("Ok", "Negative limit switch hit"), # Bit 7
-    ("Ok", "Positive software limit hit"), # Bit 8
-    ("Ok", "Negative software limit hit"), # Bit 9
-    ("Ok", "Over-current"), # Bit 10
-    ("Ok", "Over-temperature drive"), # Bit 11
-    ("Ok", "Over-voltage"), # Bit 12
-    ("Ok", "Under-voltage"), # Bit 13
-    ("Not specified", "Not specified"), # Bit 14
-    ("Ok", "STO fault (STO input is on disable state)"), # Bit 15
+    ("Not specified", "Not specified"),  # Bit 0
+    ("Ok", "Short circuit"),  # Bit 1
+    ("Ok", "Encoder error"),  # Bit 2
+    ("Ok", "Following error"),  # Bit 3
+    ("Ok", "Communication error"),  # Bit 4
+    ("Ok", "Feedback error"),  # Bit 5
+    ("Ok", "Positive limit switch hit"),  # Bit 6
+    ("Ok", "Negative limit switch hit"),  # Bit 7
+    ("Ok", "Positive software limit hit"),  # Bit 8
+    ("Ok", "Negative software limit hit"),  # Bit 9
+    ("Ok", "Over-current"),  # Bit 10
+    ("Ok", "Over-temperature drive"),  # Bit 11
+    ("Ok", "Over-voltage"),  # Bit 12
+    ("Ok", "Under-voltage"),  # Bit 13
+    ("Not specified", "Not specified"),  # Bit 14
+    ("Ok", "STO fault (STO input is on disable state)"),  # Bit 15
 ]
 
+help = """
+Decode R11 message of MasterMACs
+------------------
+    
+MasterMACs returns its error message (R11) as a floating-point number.
+The bits of this float encode different states. These states are stored 
+in the interpretation variable.
+
+This script can be used in two different ways:
+    
+Option 1: Single Command
+------------------------
+
+Usage: decodeError.py value
+    
+'value' is the return value of a R11 command. This value is interpreted
+bit-wise and the result is printed out.
+
+Option 2: CLI Mode (Linux-only)
+-------------------------------
+
+Usage: decodeError.py
+
+ONLY AVAILABLE ON LINUX!
+
+A prompt will be opened. Type in the return value of a R11 command, hit
+enter and the interpretation will be printed in the prompt. After that,
+the next value can be typed in. Type 'quit' to close the prompt.
+"""
+
 if __name__ == "__main__":
     from sys import argv
 
+    if "-h" or "--help" in argv:
+        print(help)
+
     if len(argv) == 1:
         # Start interactive mode
-        interactive()
+        if platform.system() == "Linux":
+            interactive()
+        else:
+            print(help)
     else:
 
         number = None
         try:
             number = int(float(argv[1]))
-
         except:
-            print("""
-            Decode R11 message of MasterMACs
-            ------------------
-                
-            MasterMACs returns its error message (R11) as a floating-point number.
-            The bits of this float encode different states. These states are stored 
-            in the interpretation variable.
-            
-            This script can be used in two different ways:
-                
-            Option 1: Single Command
-            ------------------------
-
-            Usage: decodeError.py value
-                
-            'value' is the return value of a R11 command. This value is interpreted
-            bit-wise and the result is printed out.
-
-            Option 2: CLI Mode
-            ------------------       
-
-            Usage: decodeError.py
-            
-            A prompt will be opened. Type in the return value of a R11 command, hit
-            enter and the interpretation will be printed in the prompt. After that,
-            the next value can be typed in. Type 'quit' to close the prompt.
-            """)
-
-        
+            print(help)
         if number is not None:
             print("Motor error")
-            print("============")
+            print("===========")
             (bit_list, interpreted) = decode(number, interpretation)
             print_decoded(bit_list, interpreted)

utils/decodeStatus.py

@@ -9,71 +9,81 @@ To read the manual, simply run this script without any arguments.
 Stefan Mathis, December 2024
 """
 
+import platform
+
 from decodeCommon import interactive, decode, print_decoded
 
 # List of tuples which encodes the states given in the file description.
 # Index first with the bit index, then with the bit value
 interpretation = [
-    ("Not ready to be switched on", "Ready to be switched on"), # Bit 0
-    ("Not switched on", "Switched on"), # Bit 1
-    ("Disabled", "Enabled"), # Bit 2
-    ("Ok", "Fault condition set"), # Bit 3
-    ("Motor supply voltage absent ", "Motor supply voltage present"), # Bit 4
-    ("Motor performs quick stop", "Ok"), # Bit 5
-    ("Switch on enabled", "Switch on disabled"), # Bit 6
-    ("Ok", "Warning: Movement function was called while motor is still moving. The function call is ignored"), # Bit 7
-    ("Not specified", "Not specified"), # Bit 8
-    ("Motor does not execute command messages (local mode)", "Motor does execute command messages (remote mode)"), # Bit 9
-    ("Target not reached", "Target reached"), # Bit 10
-    ("Ok", "Internal limit active (current, voltage, velocity or position)"), # Bit 11
-    ("Not specified", "Not specified"), # Bit 12
-    ("Not specified", "Not specified"), # Bit 13
-    ("Not specified", "Not specified"), # Bit 14
-    ("Not specified", "Not specified"), # Bit 15
+    ("Not ready to be switched on", "Ready to be switched on"),  # Bit 0
+    ("Not switched on", "Switched on"),  # Bit 1
+    ("Disabled", "Enabled"),  # Bit 2
+    ("Ok", "Fault condition set"),  # Bit 3
+    ("Motor supply voltage absent ", "Motor supply voltage present"),  # Bit 4
+    ("Motor performs quick stop", "Ok"),  # Bit 5
+    ("Switch on enabled", "Switch on disabled"),  # Bit 6
+    ("Ok", "Warning: Movement function was called while motor is still moving. The function call is ignored"),  # Bit 7
+    ("Not specified", "Not specified"),  # Bit 8
+    ("Motor does not execute command messages (local mode)",
+     "Motor does execute command messages (remote mode)"),  # Bit 9
+    ("Target not reached", "Target reached"),  # Bit 10
+    ("Ok", "Internal limit active (current, voltage, velocity or position)"),  # Bit 11
+    ("Not specified", "Not specified"),  # Bit 12
+    ("Not specified", "Not specified"),  # Bit 13
+    ("Not specified", "Not specified"),  # Bit 14
+    ("Not specified", "Not specified"),  # Bit 15
 ]
 
+help = """
+Decode R10 message of MasterMACs
+------------------
+    
+MasterMACs returns its status message (R10) as a floating-point number.
+The bits of this float encode different states. These states are stored 
+in the interpretation variable.
+
+This script can be used in two different ways:
+    
+Option 1: Single Command
+------------------------
+
+Usage: decodeStatus.py value
+    
+'value' is the return value of a R10 command. This value is interpreted
+bit-wise and the result is printed out.
+
+Option 2: CLI Mode (Linux-only)
+-------------------------------
+
+Usage: decodeStatus.py
+
+ONLY AVAILABLE ON LINUX!
+
+A prompt will be opened. Type in the return value of a R10 command, hit
+enter and the interpretation will be printed in the prompt. After that,
+the next value can be typed in. Type 'quit' to close the prompt.
+"""
+
 if __name__ == "__main__":
     from sys import argv
 
+    if "-h" or "--help" in argv:
+        print(help)
+
     if len(argv) == 1:
         # Start interactive mode
-        interactive()
+        if platform.system() == "Linux":
+            interactive()
+        else:
+            print(help)
     else:
 
         number = None
         try:
             number = int(float(argv[1]))
-
         except:
-            print("""
-            Decode R10 message of MasterMACs
-            ------------------
-                
-            MasterMACs returns its status message (R10) as a floating-point number.
-            The bits of this float encode different states. These states are stored 
-            in the interpretation variable.
-            
-            This script can be used in two different ways:
-                
-            Option 1: Single Command
-            ------------------------
-
-            Usage: decodeStatus.py value
-                
-            'value' is the return value of a R10 command. This value is interpreted
-            bit-wise and the result is printed out.
-
-            Option 2: CLI Mode
-            ------------------       
-
-            Usage: decodeStatus.py
-            
-            A prompt will be opened. Type in the return value of a R10 command, hit
-            enter and the interpretation will be printed in the prompt. After that,
-            the next value can be typed in. Type 'quit' to close the prompt.
-            """)
-
-        
+            print(help)
         if number is not None:
             print("Motor status")
             print("============")

utils/writeRead.py

@@ -6,51 +6,72 @@ To read the manual, simply run this script without any arguments.
 Stefan Mathis, April 2025
 """
 
+import platform
+
 import struct
 import socket
-import curses
+
+help = """
+Send commands to and receive replies from MasterMACS controllers
+
+Option 1: Single Command
+------------------------
+
+Usage: writeRead.py pmachost:port command
+This then returns the response for command. 
+
+Option 2: CLI Mode (Linux-only)
+-------------------------------
+
+Usage: writeRead.py pmachost:port
+
+ONLY AVAILABLE ON LINUX!
+
+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.
+"""
+
 
 def packMasterMacsCommand(command):
     # 0x0D = Carriage return
-    buf = struct.pack('B',0x0D)
-    buf = bytes(command,'utf-8') + buf
-    return bytes(command,'utf-8')
+    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
+        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
+        if expectAck and bint == 6:  # ACK
             return bytes(msg)
         else:
-            if bint == 13 and not expectAck: # CR
+            if bint == 13 and not expectAck:  # CR
                 return bytes(msg)
             else:
                 msg.append(bint)
 
+
 if __name__ == "__main__":
     from sys import argv
 
-    try:
-
+    if "-h" or "--help" in argv:
+        print(help)
+    else:
         addr = argv[1].split(':')
-        s = socket.socket(socket.AF_INET,socket.SOCK_STREAM)
-        s.connect((addr[0],int(addr[1])))
+        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')
+        if len(argv) == 2:
 
-        else:
-
-            try:
+            if platform.system() == "Linux":
+                import curses
 
                 stdscr = curses.initscr()
                 curses.noecho()
@@ -112,7 +133,7 @@ if __name__ == "__main__":
                         stdscr.refresh()
 
                     else:
-                        if ptr < len(history) - 1: # Modifying previous input
+                        if ptr < len(history) - 1:  # Modifying previous input
                             if len(history[-1]) == 0:
                                 history[-1] = history[ptr]
                                 ptr = len(history) - 1
@@ -125,7 +146,8 @@ if __name__ == "__main__":
                             if len(history[ptr]) == 0:
                                 continue
                             (y, x) = stdscr.getyx()
-                            history[ptr] = history[ptr][0:x-4] + history[ptr][x-3:]
+                            history[ptr] = history[ptr][0:x-4] + \
+                                history[ptr][x-3:]
                             stdscr.addch("\r")
                             stdscr.clrtoeol()
                             stdscr.addstr(">> " + history[ptr])
@@ -134,38 +156,24 @@ if __name__ == "__main__":
 
                         else:
                             (y, x) = stdscr.getyx()
-                            history[ptr] = history[ptr][0:x-3] + chr(c) + history[ptr][x-3:]
+                            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.
-        """)
-
+                    # to quit
+                    curses.nocbreak()
+                    stdscr.keypad(False)
+                    curses.echo()
+                    curses.endwin()
+            else:
+                print(help)
+        elif len(argv) == 3:
+            buf = packMasterMacsCommand(argv[2])
+            s.send(buf)
+            reply = readMasterMacsReply(s)
+            print(reply.decode('utf-8') + '\n')
+        else:
+            print(help)