Replaced ipPortUser_ with ipPortAsynOctetSyncIO_

See comment to sinqMotor 0.12.0

.clang-format

@@ -0,0 +1,246 @@
+---
+Language: Cpp
+# BasedOnStyle:  LLVM
+AccessModifierOffset: -2
+AlignAfterOpenBracket: Align
+AlignArrayOfStructures: None
+AlignConsecutiveAssignments:
+  Enabled: false
+  AcrossEmptyLines: false
+  AcrossComments: false
+  AlignCompound: false
+  AlignFunctionPointers: false
+  PadOperators: true
+AlignConsecutiveBitFields:
+  Enabled: false
+  AcrossEmptyLines: false
+  AcrossComments: false
+  AlignCompound: false
+  AlignFunctionPointers: false
+  PadOperators: false
+AlignConsecutiveDeclarations:
+  Enabled: false
+  AcrossEmptyLines: false
+  AcrossComments: false
+  AlignCompound: false
+  AlignFunctionPointers: false
+  PadOperators: false
+AlignConsecutiveMacros:
+  Enabled: false
+  AcrossEmptyLines: false
+  AcrossComments: false
+  AlignCompound: false
+  AlignFunctionPointers: false
+  PadOperators: false
+AlignConsecutiveShortCaseStatements:
+  Enabled: false
+  AcrossEmptyLines: false
+  AcrossComments: false
+  AlignCaseColons: false
+AlignEscapedNewlines: Right
+AlignOperands: Align
+AlignTrailingComments:
+  Kind: Always
+  OverEmptyLines: 0
+AllowAllArgumentsOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowBreakBeforeNoexceptSpecifier: Never
+AllowShortBlocksOnASingleLine: Never
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortCompoundRequirementOnASingleLine: true
+AllowShortEnumsOnASingleLine: true
+AllowShortFunctionsOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLambdasOnASingleLine: All
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: MultiLine
+AttributeMacros:
+  - __capability
+BinPackArguments: true
+BinPackParameters: true
+BitFieldColonSpacing: Both
+BraceWrapping:
+  AfterCaseLabel: false
+  AfterClass: false
+  AfterControlStatement: Never
+  AfterEnum: false
+  AfterExternBlock: false
+  AfterFunction: false
+  AfterNamespace: false
+  AfterObjCDeclaration: false
+  AfterStruct: false
+  AfterUnion: false
+  BeforeCatch: false
+  BeforeElse: false
+  BeforeLambdaBody: false
+  BeforeWhile: false
+  IndentBraces: false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakAdjacentStringLiterals: true
+BreakAfterAttributes: Leave
+BreakAfterJavaFieldAnnotations: false
+BreakArrays: true
+BreakBeforeBinaryOperators: None
+BreakBeforeConceptDeclarations: Always
+BreakBeforeBraces: Attach
+BreakBeforeInlineASMColon: OnlyMultiline
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializers: BeforeColon
+BreakInheritanceList: BeforeColon
+BreakStringLiterals: true
+ColumnLimit: 80
+CommentPragmas: "^ IWYU pragma:"
+CompactNamespaces: false
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DerivePointerAlignment: false
+DisableFormat: false
+EmptyLineAfterAccessModifier: Never
+EmptyLineBeforeAccessModifier: LogicalBlock
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IfMacros:
+  - KJ_IF_MAYBE
+IncludeBlocks: Preserve
+IncludeCategories:
+  - Regex: '^"(llvm|llvm-c|clang|clang-c)/'
+    Priority: 2
+    SortPriority: 0
+    CaseSensitive: false
+  - Regex: '^(<|"(gtest|gmock|isl|json)/)'
+    Priority: 3
+    SortPriority: 0
+    CaseSensitive: false
+  - Regex: ".*"
+    Priority: 1
+    SortPriority: 0
+    CaseSensitive: false
+IncludeIsMainRegex: "(Test)?$"
+IncludeIsMainSourceRegex: ""
+IndentAccessModifiers: false
+IndentCaseBlocks: false
+IndentCaseLabels: false
+IndentExternBlock: AfterExternBlock
+IndentGotoLabels: true
+IndentPPDirectives: None
+IndentRequiresClause: true
+IndentWidth: 4
+IndentWrappedFunctionNames: false
+InsertBraces: false
+InsertNewlineAtEOF: false
+InsertTrailingCommas: None
+IntegerLiteralSeparator:
+  Binary: 0
+  BinaryMinDigits: 0
+  Decimal: 0
+  DecimalMinDigits: 0
+  Hex: 0
+  HexMinDigits: 0
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: true
+KeepEmptyLinesAtEOF: false
+LambdaBodyIndentation: Signature
+LineEnding: DeriveLF
+MacroBlockBegin: ""
+MacroBlockEnd: ""
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBinPackProtocolList: Auto
+ObjCBlockIndentWidth: 2
+ObjCBreakBeforeNestedBlockParam: true
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PackConstructorInitializers: BinPack
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 19
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakOpenParenthesis: 0
+PenaltyBreakScopeResolution: 500
+PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 1000000
+PenaltyIndentedWhitespace: 0
+PenaltyReturnTypeOnItsOwnLine: 60
+PointerAlignment: Right
+PPIndentWidth: -1
+QualifierAlignment: Leave
+ReferenceAlignment: Pointer
+ReflowComments: true
+RemoveBracesLLVM: false
+RemoveParentheses: Leave
+RemoveSemicolon: false
+RequiresClausePosition: OwnLine
+RequiresExpressionIndentation: OuterScope
+SeparateDefinitionBlocks: Leave
+ShortNamespaceLines: 1
+SkipMacroDefinitionBody: false
+SortIncludes: CaseSensitive
+SortJavaStaticImport: Before
+SortUsingDeclarations: LexicographicNumeric
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: true
+SpaceAroundPointerQualifiers: Default
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCaseColon: false
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeJsonColon: false
+SpaceBeforeParens: ControlStatements
+SpaceBeforeParensOptions:
+  AfterControlStatements: true
+  AfterForeachMacros: true
+  AfterFunctionDefinitionName: false
+  AfterFunctionDeclarationName: false
+  AfterIfMacros: true
+  AfterOverloadedOperator: false
+  AfterPlacementOperator: true
+  AfterRequiresInClause: false
+  AfterRequiresInExpression: false
+  BeforeNonEmptyParentheses: false
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceBeforeSquareBrackets: false
+SpaceInEmptyBlock: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles: Never
+SpacesInContainerLiterals: true
+SpacesInLineCommentPrefix:
+  Minimum: 1
+  Maximum: -1
+SpacesInParens: Never
+SpacesInParensOptions:
+  InCStyleCasts: false
+  InConditionalStatements: false
+  InEmptyParentheses: false
+  Other: false
+SpacesInSquareBrackets: false
+Standard: Latest
+StatementAttributeLikeMacros:
+  - Q_EMIT
+StatementMacros:
+  - Q_UNUSED
+  - QT_REQUIRE_VERSION
+TabWidth: 8
+UseTab: Never
+VerilogBreakBetweenInstancePorts: true
+WhitespaceSensitiveMacros:
+  - BOOST_PP_STRINGIZE
+  - CF_SWIFT_NAME
+  - NS_SWIFT_NAME
+  - PP_STRINGIZE
+  - STRINGIZE
+---
+

.gitlab-ci.yml

@@ -1,6 +1,6 @@
 default:
   image: docker.psi.ch:5000/sinqdev/sinqepics:latest
-    
+
 stages:
   - lint
   - build
@@ -9,7 +9,7 @@ stages:
 cppcheck:
   stage: lint
   script:
-    - cppcheck --std=c++17 --addon=cert --addon=misc --error-exitcode=1 src/*.cpp
+    - cppcheck --std=c++17 --addon=cert --addon=misc --suppress=cert-STR07-C --error-exitcode=1 src/*.cpp
   artifacts:
     expire_in: 1 week
   tags:
@@ -24,16 +24,6 @@ formatting:
   tags:
     - sinq
 
-# clangtidy:
-#   stage: lint
-#   script:
-#     - curl https://docker.psi.ch:5000/v2/_catalog
-# #     - dnf update -y
-# #     - dnf install -y clang-tools-extra
-# #     - clang-tidy sinqEPICSApp/src/*.cpp sinqEPICSApp/src/*.c sinqEPICSApp/src/*.h -checks=cppcoreguidelines-*,cert-*
-# #   tags:
-# #     - sinq
-
 build_module:
   stage: build
   script:

Makefile

@@ -13,7 +13,7 @@ REQUIRED+=sinqMotor
 motorBase_VERSION=7.2.2
 
 # Specify the version of sinqMotor we want to build against
-sinqMotor_VERSION=0.7.0
+sinqMotor_VERSION=0.12.0
 
 # These headers allow to depend on this library for derived drivers.
 HEADERS += src/masterMacsAxis.h

README.md

@@ -1,9 +1,13 @@
 # masterMacs
 
+## <span style="color:red">Please read the documentation of sinqMotor first: https://git.psi.ch/sinq-epics-modules/sinqmotor</span>
+
 ## Overview
 
 This is a driver for the masterMacs motion controller with the SINQ communication protocol. It is based on the sinqMotor shared library (https://git.psi.ch/sinq-epics-modules/sinqmotor). The header files contain detailed documentation for all public functions. The headers themselves are exported when building the library to allow other drivers to depend on this one.
 
+Compatible to MasterMACS software 2.0.0.
+
 ## User guide
 
 This driver is a standard sinqMotor-derived driver and does not need any specific configuration. For the general configuration, please see https://git.psi.ch/sinq-epics-modules/sinqmotor/-/blob/main/README.md.
@@ -18,22 +22,42 @@ The folder "utils" contains utility scripts for working with masterMacs motor co
 masterMacs exposes the following IOC shell functions (all in masterMacsController.cpp):
 - `masterMacsController`: Create a new controller object.
 - `masterMacsAxis`: Create a new axis object.
-These functions are parametrized as follows:
+
+The full mcu.cmd file looks like this:
+
 ```
-masterMacsController(
+# Define the name of the controller and the corresponding port
-    "$(NAME)", # Name of the MCU, e.g. mcu1. This parameter should be provided by an environment variable.
+epicsEnvSet("NAME","mcu")
-    "$(ASYN_PORT)", # IP-Port of the MCU. This parameter should be provided by an environment variable.
+epicsEnvSet("ASYN_PORT","p$(NAME)")
-    8, # Maximum number of axes
+
-    0.05, # Busy poll period in seconds
+# 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
-    1, # Idle poll period in seconds
+drvAsynIPPortConfigure("$(ASYN_PORT)","172.28.101.24:1025")
-    0.05 # Communication timeout in seconds
+
-    );
+# Create the controller object with the defined name and connect it to the socket via the port name.
-```
+# The other parameters are as follows:
-```
+# 8: Maximum number of axes
-masterMacsAxis(
+# 0.05: Busy poll period in seconds
-    "$(NAME)", # Name of the associated MCU, e.g. mcu1. This parameter should be provided by an environment variable.
+# 1: Idle poll period in seconds
-    1, # Index of the axis.
+# 1: Socket communication timeout in seconds
-    );
+masterMacsController("$(NAME)", "$(ASYN_PORT)", 8, 0.05, 1, 1);
+
+# Define some axes for the specified MCU at the given slot (1, 2 and 5). No slot may be used twice!
+masterMacsAxis("$(NAME)",1);
+masterMacsAxis("$(NAME)",2);
+masterMacsAxis("$(NAME)",5);
+
+# Set the number of subsequent timeouts 
+setMaxSubsequentTimeouts("$(NAME)", 20);
+
+# Configure the timeout frequency watchdog:
+setThresholdComTimeout("$(NAME)", 100, 1);
+
+# Parametrize the EPICS record database with the substitution file named after the MCU.
+epicsEnvSet("SINQDBPATH","$(sinqMotor_DB)/sinqMotor.db")
+dbLoadTemplate("$(TOP)/$(NAME).substitutions", "INSTR=$(INSTR)$(NAME):,CONTROLLER=$(NAME)")
+epicsEnvSet("SINQDBPATH","$(masterMacs_DB)/masterMacs.db")
+dbLoadTemplate("$(TOP)/$(NAME).substitutions", "INSTR=$(INSTR)$(NAME):,CONTROLLER=$(NAME)")
+dbLoadRecords("$(sinqMotor_DB)/asynRecord.db","P=$(INSTR)$(NAME),PORT=$(ASYN_PORT)")
 ```
 
 ### Versioning

src/masterMacsAxis.h

@@ -4,7 +4,7 @@
 #include <bitset>
 
 // Forward declaration of the controller class to resolve the cyclic dependency
-// between C804Controller.h and C804Axis.h. See
+// between the controller and the axis .h-file. See
 // https://en.cppreference.com/w/cpp/language/class.
 class masterMacsController;
 
@@ -24,15 +24,6 @@ class masterMacsAxis : public sinqAxis {
      */
     virtual ~masterMacsAxis();
 
-    /**
-     * @brief Implementation of the `stop` function from asynMotorAxis
-     *
-     * @param acceleration        Acceleration ACCEL from the motor record. This
-     * value is currently not used.
-     * @return asynStatus
-     */
-    asynStatus stop(double acceleration);
-
     /**
      * @brief Implementation of the `doHome` function from sinqAxis. The
      * parameters are described in the documentation of `sinqAxis::doHome`.
@@ -69,6 +60,23 @@ class masterMacsAxis : public sinqAxis {
     asynStatus doMove(double position, int relative, double min_velocity,
                       double max_velocity, double acceleration);
 
+    /**
+     * @brief Implementation of the `stop` function from asynMotorAxis
+     *
+     * @param acceleration        Acceleration ACCEL from the motor record. This
+     * value is currently not used.
+     * @return asynStatus
+     */
+    asynStatus stop(double acceleration);
+
+    /**
+     * @brief Implementation of the `doReset` function from sinqAxis.
+     *
+     * @param on
+     * @return asynStatus
+     */
+    asynStatus doReset();
+
     /**
      * @brief Readout of some values from the controller at IOC startup
      *
@@ -273,9 +281,6 @@ class masterMacsAxis : public sinqAxis {
      * @brief Read the property from axisError_
      */
     bool stoFault() { return axisError_[15]; }
-
-  private:
-    friend class masterMacsController;
 };
 
 #endif

src/masterMacsController.cpp

@@ -49,14 +49,10 @@ masterMacsController::masterMacsController(const char *portName,
                                            int numAxes, double movingPollPeriod,
                                            double idlePollPeriod,
                                            double comTimeout)
-    : sinqController(
+    : sinqController(portName, ipPortConfigName, numAxes, movingPollPeriod,
-          portName, ipPortConfigName, numAxes, movingPollPeriod, idlePollPeriod,
+                     idlePollPeriod,
-          /*
+                     // No additional parameter library entries
-          The following parameter library entries are added in this driver:
+                     0)
-          - REREAD_ENCODER_POSITION
-          - READ_CONFIG
-          */
-          NUM_masterMacs_DRIVER_PARAMS)
 
 {
 
@@ -64,39 +60,26 @@ masterMacsController::masterMacsController(const char *portName,
     asynStatus status = asynSuccess;
 
     // Initialization of all member variables
-    lowLevelPortUser_ = nullptr;
     comTimeout_ = comTimeout;
 
-    // =========================================================================;
+    // =========================================================================
-
-    /*
-    We try to connect to the port via the port name provided by the constructor.
-    If this fails, the function is terminated via exit
-    */
-    pasynOctetSyncIO->connect(ipPortConfigName, 0, &lowLevelPortUser_, NULL);
-    if (status != asynSuccess || lowLevelPortUser_ == nullptr) {
-        errlogPrintf("Controller \"%s\" => %s, line %d:\nFATAL ERROR (cannot "
-                     "connect to MCU controller).\nTerminating IOC",
-                     portName, __PRETTY_FUNCTION__, __LINE__);
-        exit(-1);
-    }
 
     /*
     Define the end-of-string of a message coming from the device to EPICS.
     It is not necessary to append a terminator to outgoing messages, since
-    the message length is encoded in the message header in the getSetResponse
+    the message length is encoded in the message header.
-    method.
     */
-    const char *message_from_device = "\x03"; // Hex-code for ETX
+    const char *message_from_device = "\x0D"; // Hex-code for CR
-    status = pasynOctetSyncIO->setInputEos(
+    status = pasynOctetSyncIO->setInputEos(ipPortAsynOctetSyncIO_,
-        lowLevelPortUser_, message_from_device, strlen(message_from_device));
+                                           message_from_device,
+                                           strlen(message_from_device));
     if (status != asynSuccess) {
         asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
                   "Controller \"%s\" => %s, line %d:\nFATAL ERROR (setting "
                   "input EOS failed with %s).\nTerminating IOC",
                   portName, __PRETTY_FUNCTION__, __LINE__,
                   stringifyAsynStatus(status));
-        pasynOctetSyncIO->disconnect(lowLevelPortUser_);
+        pasynOctetSyncIO->disconnect(ipPortAsynOctetSyncIO_);
         exit(-1);
     }
 
@@ -107,7 +90,7 @@ masterMacsController::masterMacsController(const char *portName,
                   "ParamLib callbacks failed with %s).\nTerminating IOC",
                   portName, __PRETTY_FUNCTION__, __LINE__,
                   stringifyAsynStatus(status));
-        pasynOctetSyncIO->disconnect(lowLevelPortUser_);
+        pasynOctetSyncIO->disconnect(ipPortAsynOctetSyncIO_);
         exit(-1);
     }
 }
@@ -117,53 +100,33 @@ Access one of the axes of the controller via the axis adress stored in asynUser.
 If the axis does not exist or is not a Axis, a nullptr is returned and an
 error is emitted.
 */
-masterMacsAxis *masterMacsController::getAxis(asynUser *pasynUser) {
+masterMacsAxis *masterMacsController::getMasterMacsAxis(asynUser *pasynUser) {
     asynMotorAxis *asynAxis = asynMotorController::getAxis(pasynUser);
-    return masterMacsController::castToAxis(asynAxis);
+    return dynamic_cast<masterMacsAxis *>(asynAxis);
 }
 
 /*
 Access one of the axes of the controller via the axis index.
 If the axis does not exist or is not a Axis, the function must return Null
 */
-masterMacsAxis *masterMacsController::getAxis(int axisNo) {
+masterMacsAxis *masterMacsController::getMasterMacsAxis(int axisNo) {
     asynMotorAxis *asynAxis = asynMotorController::getAxis(axisNo);
-    return masterMacsController::castToAxis(asynAxis);
+    return dynamic_cast<masterMacsAxis *>(asynAxis);
 }
 
-masterMacsAxis *masterMacsController::castToAxis(asynMotorAxis *asynAxis) {
+asynStatus masterMacsController::read(int axisNo, int tcpCmd, char *response,
-
+                                      double comTimeout) {
-    // =========================================================================
-
-    // If the axis slot of the pAxes_ array is empty, a nullptr must be returned
-    if (asynAxis == nullptr) {
-        return nullptr;
-    }
-
-    // Here, an error is emitted since asyn_axis is not a nullptr but also not
-    // an instance of Axis
-    masterMacsAxis *axis = dynamic_cast<masterMacsAxis *>(asynAxis);
-    if (axis == nullptr) {
-        asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
-                  "Controller \"%s\", axis %d => %s, line %d:\nAxis is not "
-                  "an instance of masterMacsAxis",
-                  portName, axis->axisNo_, __PRETTY_FUNCTION__, __LINE__);
-    }
-    return axis;
-}
-
-asynStatus masterMacsController::read(int axisNo, int tcpCmd, char *response) {
     return writeRead(axisNo, tcpCmd, NULL, response);
 }
 
 asynStatus masterMacsController::write(int axisNo, int tcpCmd,
-                                       const char *payload) {
+                                       const char *payload, double comTimeout) {
-    return writeRead(axisNo, tcpCmd, payload, NULL);
+    return writeRead(axisNo, tcpCmd, payload, NULL, comTimeout);
 }
 
 asynStatus masterMacsController::writeRead(int axisNo, int tcpCmd,
-                                           const char *payload,
+                                           const char *payload, char *response,
-                                           char *response) {
+                                           double comTimeout) {
 
     // Definition of local variables.
     asynStatus status = asynSuccess;
@@ -195,93 +158,93 @@ asynStatus masterMacsController::writeRead(int axisNo, int tcpCmd,
 
     // =========================================================================
 
-    masterMacsAxis *axis = getAxis(axisNo);
+    // Check if a timeout has been given
+    if (comTimeout < 0.0) {
+        comTimeout = comTimeout_;
+    }
+
+    masterMacsAxis *axis = getMasterMacsAxis(axisNo);
     if (axis == nullptr) {
         // We already did the error logging directly in getAxis
         return asynError;
     }
 
-    /*
-    PSI SINQ uses a custom protocol which is described in
-    PSI_TCP_Interface_V1-8.pdf (p. // 4-17).
-    A special case is the message length, which is specified by two bytes
-    LSB and MSB: MSB = message length / 256 LSB = message length % 256. For
-    example, a message length of 47 chars would result in MSB = 0, LSB = 47,
-    whereas a message length of 356 would result in MSB = 1, LSB = 100.
-
-    The full protocol looks as follows:
-    0x05 -> Start of protocol frame ENQ
-    [LSB]
-    [MSB]
-    0x19 -> Data type PDO1
-    value [Actual message] It is not necessary to append a terminator, since
-    this protocol encodes the message length in LSB and MSB.
-    0x0D -> Carriage return (ASCII alias \r)
-    0x03 -> End of text ETX
-    */
-
-    fullCommand[0] = '\x05'; // ENQ
-    fullCommand[1] = 1;      // Placeholder value, can be anything other than 0
-    fullCommand[2] = 1;      // Placeholder value, can be anything other than 0
-    fullCommand[3] = '\x19'; // PD01
-
-    // Create the command and add CR and ETX at the end
     if (isRead) {
-        snprintf(&fullCommand[4], MAXBUF_ - 4, "%dR%02d\x0D\x03", axisNo,
+        snprintf(fullCommand, MAXBUF_ - 1, "%dR%02d\x0D", axisNo, tcpCmd);
-                 tcpCmd);
     } else {
-        snprintf(&fullCommand[4], MAXBUF_ - 4, "%dS%02d=%s\x0D\x03", axisNo,
+        if (strlen(payload) == 0) {
-                 tcpCmd, payload);
+            snprintf(fullCommand, MAXBUF_ - 1, "%dS%02d\x0D", axisNo, tcpCmd);
+        } else {
+            snprintf(fullCommand, MAXBUF_ - 1, "%dS%02d=%s\x0D", axisNo, tcpCmd,
+                     payload);
+        }
     }
 
     // Calculate the command length
     const size_t fullCommandLength = strlen(fullCommand);
 
-    // Length of the command without ENQ and ETX
-    const size_t lenWithMetadata = fullCommandLength - 2;
-
-    // Perform both division and modulo operation at once.
-    div_t lenWithMetadataSep = std::div(lenWithMetadata, 256);
-
-    // Now set the actual command length
-    fullCommand[1] = lenWithMetadataSep.rem;  // LSB
-    fullCommand[2] = lenWithMetadataSep.quot; // MSB
-
     adjustForPrint(printableCommand, fullCommand, MAXBUF_);
-    asynPrint(
-        this->pasynUserSelf, ASYN_TRACEIO_DRIVER,
-        "Controller \"%s\", axis %d => %s, line %d:\nSending command %s\n",
-        portName, axisNo, __PRETTY_FUNCTION__, __LINE__, printableCommand);
 
     // Send out the command
-    status =
+    status = pasynOctetSyncIO->write(ipPortAsynOctetSyncIO_, fullCommand,
-        pasynOctetSyncIO->write(lowLevelPortUser_, fullCommand,
+                                     fullCommandLength, comTimeout, &nbytesOut);
-                                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 =
+        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++) {
-            status =
+
-                pasynOctetSyncIO->read(lowLevelPortUser_, fullResponse, MAXBUF_,
+            /*
-                                       comTimeout_, &nbytesIn, &eomReason);
+            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(ipPortAsynOctetSyncIO_,
+                                            fullResponse, MAXBUF_, comTimeout,
+                                            &nbytesIn, &eomReason);
+            pasynOctetSyncIO->flush(ipPortAsynOctetSyncIO_);
 
             if (status == asynSuccess) {
                 status = parseResponse(fullCommand, fullResponse,
                                        drvMessageText, &valueStart, &valueStop,
                                        axisNo, tcpCmd, isRead);
+
                 if (status == asynSuccess) {
                     // Received the correct message
                     break;
                 }
             } else {
-                asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
+                if (status != asynTimeout) {
-                          "Controller \"%s\", axis %d => %s, line %d:\nError "
+                    asynPrint(
-                          "%s while reading from the controller\n",
+                        this->pasynUserSelf, ASYN_TRACE_ERROR,
-                          portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
+                        "Controller \"%s\", axis %d => %s, line %d:\nError "
-                          stringifyAsynStatus(status));
+                        "%s while reading from the controller\n",
-                break;
+                        portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
+                        stringifyAsynStatus(status));
+                    break;
+                }
             }
 
             if (i + 1 == maxTrials && status == asynError) {
@@ -294,17 +257,16 @@ asynStatus masterMacsController::writeRead(int axisNo, int tcpCmd,
         }
 
     } else {
-        asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
+        if (msgPrintControl_.shouldBePrinted(writeKey, true, pasynUserSelf)) {
-                  "Controller \"%s\", axis %d => %s, line %d:\nError %s while "
+            asynPrint(
-                  "writing to the controller\n",
+                this->pasynUserSelf, ASYN_TRACE_ERROR,
-                  portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
+                "Controller \"%s\", axis %d => %s, line %d:\nError %s while "
-                  stringifyAsynStatus(status));
+                "writing to the controller.%s\n",
+                portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
+                stringifyAsynStatus(status), msgPrintControl_.getSuffix());
+        }
     }
 
-    // MasterMACS needs a bit of time between messages, therefore thr program
-    // execution is paused after the communication happened.
-    // usleep(1500);
-
     // Create custom error messages for different failure modes
     switch (status) {
     case asynSuccess:
@@ -345,10 +307,6 @@ asynStatus masterMacsController::writeRead(int axisNo, int tcpCmd,
     // Log the overall status (communication successfull or not)
     if (status == asynSuccess) {
         adjustForPrint(printableResponse, fullResponse, MAXBUF_);
-        asynPrint(
-            lowLevelPortUser_, ASYN_TRACEIO_DRIVER,
-            "Controller \"%s\", axis %d => %s, line %d:\nReturn value: %s\n",
-            portName, axisNo, __PRETTY_FUNCTION__, __LINE__, printableResponse);
         pl_status = axis->setIntegerParam(this->motorStatusCommsError_, 0);
     } else {
 
@@ -408,6 +366,9 @@ asynStatus masterMacsController::parseResponse(
     char printableCommand[MAXBUF_] = {0};
     char printableResponse[MAXBUF_] = {0};
 
+    msgPrintControlKey parseKey =
+        msgPrintControlKey(portName, 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++) {
@@ -422,27 +383,39 @@ asynStatus masterMacsController::parseResponse(
         } else if (fullResponse[i] == '\x15') {
             // NAK
             snprintf(drvMessageText, MAXBUF_, "Communication failed.");
-            asynPrint(this->pasynUserSelf, ASYN_TRACEIO_DRIVER,
+
-                      "Controller \"%s\", axis %d => %s, line "
+            if (msgPrintControl_.shouldBePrinted(parseKey, true,
-                      "%d:\nCommunication failed\n",
+                                                 pasynUserSelf)) {
-                      portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
+                asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
+                          "Controller \"%s\", axis %d => %s, line "
+                          "%d:\nCommunication failed.%s\n",
+                          portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
+                          msgPrintControl_.getSuffix());
+            }
             break;
         } else if (fullResponse[i] == '\x18') {
             // CAN
             snprintf(drvMessageText, MAXBUF_,
                      "Tried to write with a read-only command. This is a "
                      "bug, please call the support.");
-            asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
+
-                      "Controller \"%s\", axis %d => %s, line %d:\nTried to "
+            if (msgPrintControl_.shouldBePrinted(parseKey, true,
-                      "write with the read-only command %s\n",
+                                                 pasynUserSelf)) {
-                      portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
+                asynPrint(
-                      printableCommand);
+                    this->pasynUserSelf, ASYN_TRACE_ERROR,
+                    "Controller \"%s\", axis %d => %s, line %d:\nTried to "
+                    "write with the read-only command %s.%s\n",
+                    portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
+                    printableCommand, msgPrintControl_.getSuffix());
+            }
             responseValid = false;
             break;
         }
     }
 
     if (responseValid) {
+        msgPrintControl_.resetCount(parseKey, pasynUserSelf);
+
         // Check if the response matches the expectations. Each response
         // contains the string "axisNo R tcpCmd" (including the spaces)
         char expectedResponseSubstring[MAXBUF_] = {0};
@@ -457,22 +430,32 @@ asynStatus masterMacsController::parseResponse(
                      tcpCmd);
         }
 
+        msgPrintControlKey responseMatchKey =
+            msgPrintControlKey(portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
+
         if (strstr(&fullResponse[responseStart], expectedResponseSubstring) ==
             NULL) {
             adjustForPrint(printableCommand, fullCommand, MAXBUF_);
             adjustForPrint(printableResponse, fullResponse, MAXBUF_);
 
-            asynPrint(this->pasynUserSelf, ASYN_TRACEIO_DRIVER,
+            if (msgPrintControl_.shouldBePrinted(parseKey, true,
-                      "Controller \"%s\", axis %d => %s, line %d:\nMismatched "
+                                                 pasynUserSelf)) {
-                      "response %s to command %s\n",
+                asynPrint(
-                      portName, axisNo, __PRETTY_FUNCTION__, __LINE__,
+                    this->pasynUserSelf, ASYN_TRACEIO_DRIVER,
-                      printableResponse, printableCommand);
+                    "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_,
                      "Mismatched response %s to command %s. Please call the "
                      "support.",
                      printableResponse, printableCommand);
             return asynError;
+        } else {
+            msgPrintControl_.resetCount(responseMatchKey, pasynUserSelf);
         }
     }
     return asynSuccess;

src/masterMacsController.h

@@ -38,7 +38,7 @@ class masterMacsController : public sinqController {
      * @return masterMacsAxis*        If no axis could be found, this is a
      * nullptr
      */
-    masterMacsAxis *getAxis(asynUser *pasynUser);
+    masterMacsAxis *getMasterMacsAxis(asynUser *pasynUser);
 
     /**
      * @brief Get the axis object
@@ -47,10 +47,7 @@ class masterMacsController : public sinqController {
      * @return masterMacsAxis*        If no axis could be found, this is a
      * nullptr
      */
-    masterMacsAxis *getAxis(int axisNo);
+    masterMacsAxis *getMasterMacsAxis(int axisNo);
-
-  protected:
-    asynUser *lowLevelPortUser_;
 
     /**
      * @brief Send a command to the hardware (S mode)
@@ -60,7 +57,8 @@ class masterMacsController : public sinqController {
      * @param payload             Value send to MasterMACS.
      * @return asynStatus
      */
-    asynStatus write(int axisNo, int tcpCmd, const char *payload);
+    asynStatus write(int axisNo, int tcpCmd, const char *payload,
+                     double comTimeout = -1.0);
 
     /**
      * @brief Send a command to the hardware and receive a response (R mode)
@@ -71,7 +69,8 @@ class masterMacsController : public sinqController {
      * expected to have the size MAXBUF_.
      * @return asynStatus
      */
-    asynStatus read(int axisNo, int tcpCmd, char *response);
+    asynStatus read(int axisNo, int tcpCmd, char *response,
+                    double comTimeout = -1.0);
 
     /**
      * @brief Send a command to the hardware (R or S mode) and receive a
@@ -88,7 +87,7 @@ class masterMacsController : public sinqController {
      * @return asynStatus
      */
     asynStatus writeRead(int axisNo, int tcpCmd, const char *payload,
-                         char *response);
+                         char *response, double comTimeout = -1.0);
 
     /**
      * @brief Parse "fullResponse" received upon sending "fullCommand".
@@ -114,35 +113,16 @@ class masterMacsController : public sinqController {
                              int *valueStop, int axisNo, int tcpCmd,
                              bool isRead);
 
-    /**
-     * @brief Save cast of the given asynAxis pointer to a masterMacsAxis
-     * pointer. If the cast fails, this function returns a nullptr.
-     *
-     * @param asynAxis
-     * @return masterMacsAxis*
-     */
-    masterMacsAxis *castToAxis(asynMotorAxis *asynAxis);
-
-  private:
     // Set the maximum buffer size. This is an empirical value which must be
     // large enough to avoid overflows for all commands to the device /
     // responses from it.
     static const uint32_t MAXBUF_ = 200;
 
+  private:
     /*
     Stores the constructor input comTimeout
     */
     double comTimeout_;
-
-    // Indices of additional PVs
-#define FIRST_masterMacs_PARAM rereadEncoderPosition_
-    int rereadEncoderPosition_;
-    int readConfig_;
-#define LAST_masterMacs_PARAM readConfig_
-
-    friend class masterMacsAxis;
 };
-#define NUM_masterMacs_DRIVER_PARAMS                                           \
-    (&LAST_masterMacs_PARAM - &FIRST_masterMacs_PARAM + 1)
 
 #endif /* masterMacsController_H */

utils/decodeCommon.py

@@ -2,9 +2,14 @@
 Code shared by "decodeError.py" and "decodeStatus.py"
 """
 
+import struct
+
 def decode(value: int, interpretation):
 
-    bit_list = [int(char) for char in bin(value)[2:]]    
+    # Pack the input as a short and unpack it as an unsigned short
+    value_uint16 = format(value, '016b')  # Format as 16-bit unsigned integer
+
+    bit_list = [int(char) for char in value_uint16]    
     bit_list.reverse()
 
     interpreted = []

utils/decodeStatus.py

@@ -32,109 +32,6 @@ interpretation = [
     ("Not specified", "Not specified"), # Bit 15
 ]
 
-def interactive():
-
-    # Imported here, because curses is not available in Windows. Using the 
-    # interactive mode therefore fails on Windows, but at least the single 
-    # command mode can be used (which would not be possible if we would import
-    # curses at the top level)
-    import curses
-
-    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]:
-                (bit_list, interpreted) = decode(history[ptr])
-                for (idx, (bit_value, msg)) in enumerate(zip(bit_list, interpreted)):
-                    stdscr.addstr(f"\nBit {idx} = {bit_value}: {msg}")
-                stdscr.refresh()
-
-            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()
-
-    # to quit
-    curses.nocbreak()
-    stdscr.keypad(False)
-    curses.echo()
-    curses.endwin()
-
 if __name__ == "__main__":
     from sys import argv