Compare commits
11 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 25286652d5 | |||
| 27f7cc8602 | |||
| 21a73717a5 | |||
| 2cbb4f9028 | |||
| 23a911206a | |||
| 6553b468c8 | |||
| 954fc82414 | |||
| ff183576ec | |||
| 83f9be3be8 | |||
| 2c0c9a33b7 | |||
| 8bb81b1716 |
5
Makefile
5
Makefile
@@ -23,9 +23,14 @@ SOURCES += src/masterMacsController.cpp
|
||||
# Store the record files
|
||||
TEMPLATES += sinqMotor/db/asynRecord.db
|
||||
TEMPLATES += sinqMotor/db/sinqMotor.db
|
||||
TEMPLATES += db/masterMacs.db
|
||||
|
||||
# This file registers the motor-specific functions in the IOC shell.
|
||||
DBDS += sinqMotor/src/sinqMotor.dbd
|
||||
DBDS += src/masterMacs.dbd
|
||||
|
||||
USR_CFLAGS += -Wall -Wextra -Weffc++ -Wunused-result -Wextra -Werror
|
||||
|
||||
# These flags define the expected firmware version. See README.md, section
|
||||
# "Firmware version checking" for details.
|
||||
USR_CXXFLAGS += -DFIRMWARE_MAJOR_VERSION=2 -DFIRMWARE_MINOR_VERSION=2
|
||||
|
||||
26
README.md
26
README.md
@@ -66,6 +66,32 @@ dbLoadRecords("$(masterMacs_DB)/asynRecord.db","P=$(INSTR)$(NAME),PORT=$(ASYN_PO
|
||||
|
||||
Please see the documentation for the module sinqMotor: https://git.psi.ch/sinq-epics-modules/sinqmotor/-/blob/main/README.md.
|
||||
|
||||
### Firmware version checking
|
||||
|
||||
This driver expects a certain version of the firmware running on the controller itself.
|
||||
This is checked at IOC startup by reading the version directly from the hardware.
|
||||
If the firmware version is incompatible to the driver, the IOC will be shut down.
|
||||
If the firmware version cannot be read (e.g. because the variable used to do so
|
||||
does not exist yet on old firmware versions), the firmware is assumed to be compatible
|
||||
to the driver.
|
||||
|
||||
The version check is separated into a check of the major and the minor firmware
|
||||
version against expected values. The firmware is seen as compatible if the following conditions hold:
|
||||
- Read-out major version == Expected major version
|
||||
- Read-out read major version >= Expected minor version
|
||||
|
||||
The expected versions are defined via compiler flags in `Makefile`:
|
||||
|
||||
```
|
||||
USR_CXXFLAGS += -DFIRMWARE_MAJOR_VERSION=1 -DFIRMWARE_MINOR_VERSION=0
|
||||
```
|
||||
Be aware that these flags are only used to compile C++-files (.cpp, .cxx) and not
|
||||
C-files (.c). For C-files, the Makefile variable `USR_CFLAGS` must be used.
|
||||
|
||||
In order to disable the checks, the flags can be set to -1 or just be removed
|
||||
entirely. If one of the flags is not given, both the major and the minor version
|
||||
checks are deactivated.
|
||||
|
||||
### How to build it
|
||||
|
||||
Please see the documentation for the module sinqMotor: https://git.psi.ch/sinq-epics-modules/sinqmotor/-/blob/main/README.md.
|
||||
|
||||
7
db/masterMacs.db
Executable file
7
db/masterMacs.db
Executable file
@@ -0,0 +1,7 @@
|
||||
# Call the nodeReset function of the corresponding masterMacsAxis.
|
||||
# This record is coupled to the parameter library via nodeReset_ -> NODE_RESET.
|
||||
record(longout, "$(INSTR)$(M):NodeReset") {
|
||||
field(DTYP, "asynInt32")
|
||||
field(OUT, "@asyn($(CONTROLLER),$(AXIS),1) NODE_RESET")
|
||||
field(PINI, "NO")
|
||||
}
|
||||
Submodule sinqMotor updated: 55a9fe6f3e...7a0de4e9d9
@@ -357,7 +357,10 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
|
||||
|
||||
if (timedOut) {
|
||||
setAxisParamChecked(this, motorMessageText,
|
||||
"Timed out while waiting for a handshake");
|
||||
"Timed out while waiting for a handshake. "
|
||||
"Please call the support.");
|
||||
|
||||
poll_status = asynError;
|
||||
}
|
||||
|
||||
pC_->read(axisNo_, 86, response);
|
||||
@@ -377,14 +380,10 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
|
||||
pMasterMacsA_->waitForHandshake = false;
|
||||
pMasterMacsA_->targetReachedUninitialized = false;
|
||||
} else {
|
||||
// Still waiting for the handshake - try again in the next busy
|
||||
// poll. This is already part of the movement procedure.
|
||||
*moving = true;
|
||||
|
||||
setAxisParamChecked(this, motorStatusMoving, *moving);
|
||||
setAxisParamChecked(this, motorStatusDone, !(*moving));
|
||||
|
||||
return asynSuccess;
|
||||
return poll_status;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -403,6 +402,9 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
|
||||
return rw_status;
|
||||
}
|
||||
|
||||
// If we wait for a handshake, but the motor was moving in its last poll
|
||||
// cycle and has reached its target, it is not moving. Otherwise it is
|
||||
// considered moving, even if we're still waiting for the handshake.
|
||||
if (pMasterMacsA_->targetReachedUninitialized) {
|
||||
*moving = false;
|
||||
} else {
|
||||
@@ -432,184 +434,181 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
|
||||
Read out the error if either a fault condition status flag has been set or
|
||||
if a movement has just ended.
|
||||
*/
|
||||
if (faultConditionSet() || !(*moving)) {
|
||||
rw_status = readAxisError();
|
||||
}
|
||||
|
||||
msgPrintControlKey keyError = msgPrintControlKey(
|
||||
pC_->portName, axisNo_, __PRETTY_FUNCTION__, __LINE__);
|
||||
|
||||
if (faultConditionSet() || !(*moving)) {
|
||||
rw_status = readAxisError();
|
||||
/*
|
||||
A communication error is a special case. If a communication between
|
||||
controller and axis error occurred, all subsequent errors are ignored,
|
||||
since this information is not reliable.
|
||||
*/
|
||||
if (communicationError()) {
|
||||
if (pC_->getMsgPrintControl().shouldBePrinted(keyError, true,
|
||||
pC_->pasynUser())) {
|
||||
asynPrint(pC_->pasynUser(), ASYN_TRACE_ERROR,
|
||||
"Controller \"%s\", axis %d => %s, line "
|
||||
"%d\nCommunication error.%s\n",
|
||||
pC_->portName, axisNo_, __PRETTY_FUNCTION__, __LINE__,
|
||||
pC_->getMsgPrintControl().getSuffix());
|
||||
}
|
||||
|
||||
setAxisParamChecked(this, motorMessageText,
|
||||
"Communication error between PC and motor "
|
||||
"controller. Please call the support.");
|
||||
|
||||
poll_status = asynError;
|
||||
} else {
|
||||
|
||||
// This buffer must be initialized to zero because we build the
|
||||
// error message by appending strings.
|
||||
char errorMessage[pC_->MAXBUF_] = {0};
|
||||
char shellMessage[pC_->MAXBUF_] = {0};
|
||||
|
||||
// Concatenate all other errors
|
||||
if (shortCircuit()) {
|
||||
appendErrorMessage(shellMessage, sizeof(shellMessage),
|
||||
"Short circuit fault.");
|
||||
appendErrorMessage(errorMessage, sizeof(errorMessage),
|
||||
"Short circuit error. Please call the support.");
|
||||
|
||||
poll_status = asynError;
|
||||
}
|
||||
|
||||
if (encoderError()) {
|
||||
appendErrorMessage(shellMessage, sizeof(shellMessage),
|
||||
"Encoder error.");
|
||||
appendErrorMessage(errorMessage, sizeof(errorMessage),
|
||||
"Encoder error. Please call the support.");
|
||||
|
||||
poll_status = asynError;
|
||||
}
|
||||
|
||||
if (followingError()) {
|
||||
appendErrorMessage(shellMessage, sizeof(shellMessage),
|
||||
"Maximum callowed following error exceeded.");
|
||||
appendErrorMessage(
|
||||
errorMessage, sizeof(errorMessage),
|
||||
"Maximum allowed following error exceeded.Check if "
|
||||
"movement range is blocked. Otherwise please call the "
|
||||
"support.");
|
||||
|
||||
poll_status = asynError;
|
||||
}
|
||||
|
||||
if (feedbackError()) {
|
||||
appendErrorMessage(shellMessage, sizeof(shellMessage),
|
||||
"Feedback error.");
|
||||
appendErrorMessage(errorMessage, sizeof(errorMessage),
|
||||
"Feedback error. Please call the support.");
|
||||
|
||||
poll_status = asynError;
|
||||
}
|
||||
|
||||
/*
|
||||
A communication error is a special case. If a communication between
|
||||
controller and axis error occurred, all subsequent errors are ignored,
|
||||
since this information is not reliable.
|
||||
*/
|
||||
if (communicationError()) {
|
||||
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 (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.");
|
||||
}
|
||||
|
||||
// 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;
|
||||
}
|
||||
|
||||
if (overCurrent()) {
|
||||
appendErrorMessage(shellMessage, sizeof(shellMessage),
|
||||
"Overcurrent error.");
|
||||
appendErrorMessage(errorMessage, sizeof(errorMessage),
|
||||
"Overcurrent error. Please call the support.");
|
||||
|
||||
poll_status = asynError;
|
||||
}
|
||||
|
||||
if (overTemperature()) {
|
||||
appendErrorMessage(shellMessage, sizeof(shellMessage),
|
||||
"Overtemperature error.");
|
||||
appendErrorMessage(
|
||||
errorMessage, sizeof(errorMessage),
|
||||
"Overtemperature error. Please call the support.");
|
||||
|
||||
poll_status = asynError;
|
||||
}
|
||||
|
||||
if (overVoltage()) {
|
||||
appendErrorMessage(shellMessage, sizeof(shellMessage),
|
||||
"Overvoltage error.");
|
||||
appendErrorMessage(errorMessage, sizeof(errorMessage),
|
||||
"Overvoltage error. Please call the support.");
|
||||
|
||||
poll_status = asynError;
|
||||
}
|
||||
|
||||
if (underVoltage()) {
|
||||
appendErrorMessage(shellMessage, sizeof(shellMessage),
|
||||
"Undervoltage error.");
|
||||
appendErrorMessage(errorMessage, sizeof(errorMessage),
|
||||
"Undervoltage error. Please call the support.");
|
||||
|
||||
poll_status = asynError;
|
||||
}
|
||||
|
||||
if (stoFault()) {
|
||||
appendErrorMessage(shellMessage, sizeof(shellMessage),
|
||||
"STO input is on disable state.");
|
||||
appendErrorMessage(errorMessage, sizeof(errorMessage),
|
||||
"STO fault. Please call the support.");
|
||||
|
||||
poll_status = asynError;
|
||||
}
|
||||
|
||||
if (strlen(shellMessage) > 0) {
|
||||
if (pC_->getMsgPrintControl().shouldBePrinted(keyError, true,
|
||||
pC_->pasynUser())) {
|
||||
asynPrint(pC_->pasynUser(), ASYN_TRACE_ERROR,
|
||||
"Controller \"%s\", axis %d => %s, line "
|
||||
"%d\nCommunication error.%s\n",
|
||||
"%d\n%s%s\n",
|
||||
pC_->portName, axisNo_, __PRETTY_FUNCTION__, __LINE__,
|
||||
pC_->getMsgPrintControl().getSuffix());
|
||||
shellMessage, pC_->getMsgPrintControl().getSuffix());
|
||||
}
|
||||
|
||||
setAxisParamChecked(this, motorMessageText,
|
||||
"Communication error between PC and motor "
|
||||
"controller. Please call the support.");
|
||||
|
||||
poll_status = asynError;
|
||||
} else {
|
||||
|
||||
// This buffer must be initialized to zero because we build the
|
||||
// error message by appending strings.
|
||||
char errorMessage[pC_->MAXBUF_] = {0};
|
||||
char shellMessage[pC_->MAXBUF_] = {0};
|
||||
|
||||
// Concatenate all other errors
|
||||
if (shortCircuit()) {
|
||||
appendErrorMessage(shellMessage, sizeof(shellMessage),
|
||||
"Short circuit fault.");
|
||||
appendErrorMessage(
|
||||
errorMessage, sizeof(errorMessage),
|
||||
"Short circuit error. Please call the support.");
|
||||
|
||||
poll_status = asynError;
|
||||
}
|
||||
|
||||
if (encoderError()) {
|
||||
appendErrorMessage(shellMessage, sizeof(shellMessage),
|
||||
"Encoder error.");
|
||||
appendErrorMessage(errorMessage, sizeof(errorMessage),
|
||||
"Encoder error. Please call the support.");
|
||||
|
||||
poll_status = asynError;
|
||||
}
|
||||
|
||||
if (followingError()) {
|
||||
appendErrorMessage(
|
||||
shellMessage, sizeof(shellMessage),
|
||||
"Maximum callowed following error exceeded.");
|
||||
appendErrorMessage(
|
||||
errorMessage, sizeof(errorMessage),
|
||||
"Maximum allowed following error exceeded.Check if "
|
||||
"movement range is blocked. Otherwise please call the "
|
||||
"support.");
|
||||
|
||||
poll_status = asynError;
|
||||
}
|
||||
|
||||
if (feedbackError()) {
|
||||
appendErrorMessage(shellMessage, sizeof(shellMessage),
|
||||
"Feedback error.");
|
||||
appendErrorMessage(errorMessage, sizeof(errorMessage),
|
||||
"Feedback error. Please call the support.");
|
||||
|
||||
poll_status = asynError;
|
||||
}
|
||||
|
||||
/*
|
||||
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 (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.");
|
||||
}
|
||||
|
||||
// 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;
|
||||
}
|
||||
|
||||
if (overCurrent()) {
|
||||
appendErrorMessage(shellMessage, sizeof(shellMessage),
|
||||
"Overcurrent error.");
|
||||
appendErrorMessage(
|
||||
errorMessage, sizeof(errorMessage),
|
||||
"Overcurrent error. Please call the support.");
|
||||
|
||||
poll_status = asynError;
|
||||
}
|
||||
|
||||
if (overTemperature()) {
|
||||
appendErrorMessage(shellMessage, sizeof(shellMessage),
|
||||
"Overtemperature error.");
|
||||
appendErrorMessage(
|
||||
errorMessage, sizeof(errorMessage),
|
||||
"Overtemperature error. Please call the support.");
|
||||
|
||||
poll_status = asynError;
|
||||
}
|
||||
|
||||
if (overVoltage()) {
|
||||
appendErrorMessage(shellMessage, sizeof(shellMessage),
|
||||
"Overvoltage error.");
|
||||
appendErrorMessage(
|
||||
errorMessage, sizeof(errorMessage),
|
||||
"Overvoltage error. Please call the support.");
|
||||
|
||||
poll_status = asynError;
|
||||
}
|
||||
|
||||
if (underVoltage()) {
|
||||
appendErrorMessage(shellMessage, sizeof(shellMessage),
|
||||
"Undervoltage error.");
|
||||
appendErrorMessage(
|
||||
errorMessage, sizeof(errorMessage),
|
||||
"Undervoltage error. Please call the support.");
|
||||
|
||||
poll_status = asynError;
|
||||
}
|
||||
|
||||
if (stoFault()) {
|
||||
appendErrorMessage(shellMessage, sizeof(shellMessage),
|
||||
"STO input is on disable state.");
|
||||
appendErrorMessage(errorMessage, sizeof(errorMessage),
|
||||
"STO fault. Please call the support.");
|
||||
|
||||
poll_status = asynError;
|
||||
}
|
||||
|
||||
if (strlen(shellMessage) > 0) {
|
||||
if (pC_->getMsgPrintControl().shouldBePrinted(
|
||||
keyError, true, pC_->pasynUser())) {
|
||||
asynPrint(pC_->pasynUser(), ASYN_TRACE_ERROR,
|
||||
"Controller \"%s\", axis %d => %s, line "
|
||||
"%d\n%s%s\n",
|
||||
pC_->portName, axisNo_, __PRETTY_FUNCTION__,
|
||||
__LINE__, shellMessage,
|
||||
pC_->getMsgPrintControl().getSuffix());
|
||||
}
|
||||
}
|
||||
|
||||
setAxisParamChecked(this, motorMessageText, errorMessage);
|
||||
}
|
||||
} else {
|
||||
|
||||
setAxisParamChecked(this, motorMessageText, errorMessage);
|
||||
}
|
||||
|
||||
// No error has been detected -> Reset the error count
|
||||
if (poll_status == asynSuccess) {
|
||||
pC_->getMsgPrintControl().resetCount(keyError, pC_->pasynUser());
|
||||
}
|
||||
|
||||
@@ -682,7 +681,6 @@ asynStatus masterMacsAxis::doPoll(bool *moving) {
|
||||
if (pl_status != asynSuccess) {
|
||||
return pl_status;
|
||||
}
|
||||
|
||||
return poll_status;
|
||||
}
|
||||
|
||||
@@ -808,23 +806,40 @@ asynStatus masterMacsAxis::doReset() {
|
||||
|
||||
asynStatus status = asynSuccess;
|
||||
|
||||
// Reset errors
|
||||
status = pC_->write(axisNo_, 16, "");
|
||||
if (status != asynSuccess) {
|
||||
setAxisParamChecked(this, motorStatusProblem, true);
|
||||
}
|
||||
|
||||
// Reset the controller
|
||||
// Reset any errors
|
||||
status = pC_->write(axisNo_, 17, "");
|
||||
if (status != asynSuccess) {
|
||||
setAxisParamChecked(this, motorStatusProblem, true);
|
||||
}
|
||||
|
||||
// Reset the driver to idle state and move out of the handshake wait loop,
|
||||
// if we're currently inside it.
|
||||
// Move out of the handshake wait loop, if we're currently inside it.
|
||||
pMasterMacsA_->waitForHandshake = false;
|
||||
|
||||
return status;
|
||||
// Disable the axis
|
||||
return enable(false);
|
||||
}
|
||||
|
||||
asynStatus masterMacsAxis::nodeReset() {
|
||||
|
||||
asynStatus status = asynSuccess;
|
||||
|
||||
// Reset the controller ("node reset"). Since the node reset results in a
|
||||
// power cycle, we use the corresponding timeout.
|
||||
status = pC_->write(axisNo_, 16, "", PowerCycleTimeout);
|
||||
if (status != asynSuccess) {
|
||||
setAxisParamChecked(this, motorStatusProblem, true);
|
||||
}
|
||||
|
||||
// Move out of the handshake wait loop, if we're currently inside it.
|
||||
pMasterMacsA_->waitForHandshake = false;
|
||||
|
||||
// Reinitialize the axis
|
||||
status = masterMacsAxis::init();
|
||||
if (status != asynSuccess) {
|
||||
return status;
|
||||
}
|
||||
bool moving = false;
|
||||
return forcedPoll(&moving);
|
||||
}
|
||||
|
||||
/*
|
||||
@@ -990,7 +1005,7 @@ asynStatus masterMacsAxis::enable(bool on) {
|
||||
if (switchedOn() == on) {
|
||||
bool moving = false;
|
||||
// Perform a poll to update the parameter library
|
||||
poll(&moving);
|
||||
forcedPoll(&moving);
|
||||
return asynSuccess;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
#include "sinqAxis.h"
|
||||
#include <memory>
|
||||
|
||||
struct masterMacsAxisImpl;
|
||||
struct HIDDEN masterMacsAxisImpl;
|
||||
|
||||
class masterMacsAxis : public sinqAxis {
|
||||
class HIDDEN masterMacsAxis : public sinqAxis {
|
||||
public:
|
||||
/**
|
||||
* @brief Construct a new masterMacsAxis
|
||||
@@ -75,12 +75,27 @@ class masterMacsAxis : public sinqAxis {
|
||||
*/
|
||||
asynStatus doReset();
|
||||
|
||||
/**
|
||||
* @brief Performs a "node reset" on the axis as defined in the CANopen
|
||||
* standard
|
||||
*
|
||||
* A "node reset" is a factory reset on the axis which completely deletes
|
||||
* all configured information (e.g. limits or speed) from the axis. The
|
||||
* MasterMACS controller then reapplies the initial configuration to this
|
||||
* axis. It can therefore be seen as a "hard" version of the normal error
|
||||
* reset performed by the `doReset` method.
|
||||
*
|
||||
* @return asynStatus
|
||||
*/
|
||||
asynStatus nodeReset();
|
||||
|
||||
/**
|
||||
* @brief Readout of some values from the controller at IOC startup
|
||||
*
|
||||
* The following steps are performed:
|
||||
* - Read out the motor status, motor position, velocity and acceleration
|
||||
* from the MCU and store this information in the parameter library.
|
||||
* - Read out the motor status, motor position, velocity and
|
||||
* acceleration from the MCU and store this information in the parameter
|
||||
* library.
|
||||
* - Set the enable PV accordint to the initial status of the axis.
|
||||
*
|
||||
* @return asynStatus
|
||||
@@ -96,8 +111,8 @@ class masterMacsAxis : public sinqAxis {
|
||||
asynStatus enable(bool on);
|
||||
|
||||
/**
|
||||
* @brief Read the encoder type (incremental or absolute) for this axis from
|
||||
* the MCU and store the information in the PV ENCODER_TYPE.
|
||||
* @brief Read the encoder type (incremental or absolute) for this axis
|
||||
* from the MCU and store the information in the PV ENCODER_TYPE.
|
||||
*
|
||||
* @return asynStatus
|
||||
*/
|
||||
@@ -112,7 +127,8 @@ class masterMacsAxis : public sinqAxis {
|
||||
bool needInit();
|
||||
|
||||
/**
|
||||
* @brief Instruct the axis to run its init() function during the next poll
|
||||
* @brief Instruct the axis to run its init() function during the next
|
||||
* poll
|
||||
*
|
||||
* @param needInit
|
||||
*/
|
||||
@@ -124,8 +140,8 @@ class masterMacsAxis : public sinqAxis {
|
||||
virtual masterMacsController *pController() override { return pC_; };
|
||||
|
||||
/**
|
||||
* @brief Read the Master MACS status with the xR10 command and store the
|
||||
* result in axisStatus_
|
||||
* @brief Read the Master MACS status with the xR10 command and store
|
||||
* the result in axisStatus_
|
||||
*
|
||||
*/
|
||||
asynStatus readAxisStatus();
|
||||
@@ -203,8 +219,8 @@ class masterMacsAxis : public sinqAxis {
|
||||
bool powerEnabled();
|
||||
|
||||
/**
|
||||
* @brief Read the Master MACS status with the xR10 command and store the
|
||||
* result in axisStatus_
|
||||
* @brief Read the Master MACS status with the xR10 command and store
|
||||
* the result in axisStatus_
|
||||
*
|
||||
*/
|
||||
asynStatus readAxisError();
|
||||
|
||||
@@ -12,8 +12,33 @@
|
||||
#include <string>
|
||||
#include <unistd.h>
|
||||
|
||||
/*
|
||||
These functions are used to read out the compiler flags defining the major and
|
||||
minor versions. See README.md, section "Firmware version checking" for
|
||||
details. If these flags are not given, a default value of -1 is used, which
|
||||
disables the version checks (it suffices to have one of these at -1 to disable
|
||||
both major and minor version check)
|
||||
*/
|
||||
constexpr int firmware_major_version() {
|
||||
#ifdef FIRMWARE_MAJOR_VERSION
|
||||
return FIRMWARE_MAJOR_VERSION;
|
||||
#else
|
||||
return -1;
|
||||
#endif
|
||||
}
|
||||
constexpr int firmware_minor_version() {
|
||||
#ifdef FIRMWARE_MINOR_VERSION
|
||||
return FIRMWARE_MINOR_VERSION;
|
||||
#else
|
||||
return -1;
|
||||
#endif
|
||||
}
|
||||
|
||||
struct masterMacsControllerImpl {
|
||||
double comTimeout;
|
||||
|
||||
// Indices of additional ParamLib entries
|
||||
int nodeReset;
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -62,12 +87,27 @@ masterMacsController::masterMacsController(const char *portName,
|
||||
|
||||
// Initialization of local variables
|
||||
asynStatus status = asynSuccess;
|
||||
char response[MAXBUF_] = {0};
|
||||
|
||||
pMasterMacsC_ =
|
||||
std::make_unique<masterMacsControllerImpl>((masterMacsControllerImpl){
|
||||
.comTimeout = comTimeout,
|
||||
});
|
||||
|
||||
// =========================================================================
|
||||
// Create additional parameter library entries
|
||||
|
||||
status =
|
||||
createParam("NODE_RESET", asynParamInt32, &pMasterMacsC_->nodeReset);
|
||||
if (status != asynSuccess) {
|
||||
asynPrint(this->pasynUser(), ASYN_TRACE_ERROR,
|
||||
"Controller \"%s\" => %s, line %d\nFATAL ERROR (creating a "
|
||||
"parameter failed with %s).\nTerminating IOC",
|
||||
portName, __PRETTY_FUNCTION__, __LINE__,
|
||||
stringifyAsynStatus(status));
|
||||
exit(-1);
|
||||
}
|
||||
|
||||
// =========================================================================
|
||||
|
||||
/*
|
||||
@@ -99,6 +139,60 @@ masterMacsController::masterMacsController(const char *portName,
|
||||
pasynOctetSyncIO->disconnect(pasynOctetSyncIOipPort());
|
||||
exit(-1);
|
||||
}
|
||||
|
||||
// =========================================================================
|
||||
|
||||
if (firmware_major_version() >= 0 && firmware_minor_version() >= 0) {
|
||||
// Check the firmware version according to the conditions outlined in
|
||||
// README.md
|
||||
status = read(0, 99, response);
|
||||
|
||||
if (status == asynSuccess) {
|
||||
|
||||
// Just interpret the version if the variable already exists
|
||||
double versionRaw = 0.0;
|
||||
int nvals = sscanf(response, "%lf", &versionRaw);
|
||||
if (nvals == 1 && versionRaw != 0.0) {
|
||||
// Discard decimal part
|
||||
long long versionInt = (long long)versionRaw;
|
||||
|
||||
// Extract bugfix (last 3 digits)
|
||||
// Currently not used, just here for completions sake
|
||||
// int bugfix = versionInt % 1000;
|
||||
versionInt /= 1000;
|
||||
|
||||
// Extract minor (next 3 digits)
|
||||
int minor = versionInt % 1000;
|
||||
versionInt /= 1000;
|
||||
|
||||
// Remaining is major
|
||||
int major = (int)versionInt;
|
||||
|
||||
// Compare to target values
|
||||
if (firmware_major_version() != major ||
|
||||
firmware_minor_version() > minor) {
|
||||
asynPrint(this->pasynUser(), ASYN_TRACE_ERROR,
|
||||
"Controller \"%s\" => %s, line %d\nFATAL ERROR "
|
||||
"(Incorrect "
|
||||
"version number of firmware: Expected major "
|
||||
"version equal "
|
||||
"to %d, got %d. Expected minor version equal to "
|
||||
"or larger "
|
||||
"than %d, got %d).\nTerminating IOC",
|
||||
portName, __PRETTY_FUNCTION__, __LINE__,
|
||||
firmware_major_version(), major,
|
||||
firmware_minor_version(), minor);
|
||||
exit(-1);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
asynPrint(
|
||||
this->pasynUser(), ASYN_TRACE_ERROR,
|
||||
"Controller \"%s\" => %s, line %d\nCould not read firmware "
|
||||
"version\n",
|
||||
portName, __PRETTY_FUNCTION__, __LINE__);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
@@ -120,6 +214,22 @@ masterMacsAxis *masterMacsController::getMasterMacsAxis(int axisNo) {
|
||||
return dynamic_cast<masterMacsAxis *>(asynAxis);
|
||||
}
|
||||
|
||||
asynStatus masterMacsController::writeInt32(asynUser *pasynUser,
|
||||
epicsInt32 value) {
|
||||
int function = pasynUser->reason;
|
||||
|
||||
// =====================================================================
|
||||
|
||||
masterMacsAxis *axis = getMasterMacsAxis(pasynUser);
|
||||
|
||||
// Handle custom PVs
|
||||
if (function == nodeReset()) {
|
||||
return axis->nodeReset();
|
||||
} else {
|
||||
return sinqController::writeInt32(pasynUser, value);
|
||||
}
|
||||
}
|
||||
|
||||
asynStatus masterMacsController::read(int axisNo, int tcpCmd, char *response,
|
||||
double comTimeout) {
|
||||
return writeRead(axisNo, tcpCmd, NULL, response);
|
||||
@@ -166,12 +276,6 @@ asynStatus masterMacsController::writeRead(int axisNo, int tcpCmd,
|
||||
comTimeout = pMasterMacsC_->comTimeout;
|
||||
}
|
||||
|
||||
masterMacsAxis *axis = getMasterMacsAxis(axisNo);
|
||||
if (axis == nullptr) {
|
||||
// We already did the error logging directly in getAxis
|
||||
return asynError;
|
||||
}
|
||||
|
||||
// Build the full command depending on the inputs to this function
|
||||
if (isRead) {
|
||||
snprintf(fullCommand, MAXBUF_ - 1, "%dR%02d\x0D", axisNo, tcpCmd);
|
||||
@@ -253,32 +357,39 @@ asynStatus masterMacsController::writeRead(int axisNo, int tcpCmd,
|
||||
}
|
||||
|
||||
// Log the overall status (communication successfull or not)
|
||||
if (status == asynSuccess) {
|
||||
setAxisParamChecked(axis, motorStatusCommsError, false);
|
||||
} else {
|
||||
if (axisNo != 0) {
|
||||
masterMacsAxis *axis = getMasterMacsAxis(axisNo);
|
||||
if (axis == nullptr) {
|
||||
// We already did the error logging directly in getAxis
|
||||
return asynError;
|
||||
}
|
||||
|
||||
/*
|
||||
Since the communication failed, there is the possibility that the
|
||||
controller is not connected at all to the network. In that case, we
|
||||
cannot be sure that the information read out in the init method of the
|
||||
axis is still up-to-date the next time we get a connection. Therefore,
|
||||
an info flag is set which the axis object can use at the start of its
|
||||
poll method to try to initialize itself.
|
||||
*/
|
||||
axis->setNeedInit(true);
|
||||
|
||||
/*
|
||||
Check if the axis already is in an error communication mode. If
|
||||
it is not, upstream the error. This is done to avoid "flooding"
|
||||
the user with different error messages if more than one error
|
||||
ocurred before an error-free communication
|
||||
*/
|
||||
getAxisParamChecked(axis, motorStatusProblem, &motorStatusProblem);
|
||||
|
||||
if (motorStatusProblem == 0) {
|
||||
setAxisParamChecked(axis, motorMessageText, drvMessageText);
|
||||
setAxisParamChecked(axis, motorStatusProblem, true);
|
||||
if (status == asynSuccess) {
|
||||
setAxisParamChecked(axis, motorStatusCommsError, false);
|
||||
} else {
|
||||
/*
|
||||
Since the communication failed, there is the possibility that the
|
||||
controller is not connected at all to the network. In that case, we
|
||||
cannot be sure that the information read out in the init method of
|
||||
the axis is still up-to-date the next time we get a connection.
|
||||
Therefore, an info flag is set which the axis object can use at the
|
||||
start of its poll method to try to initialize itself.
|
||||
*/
|
||||
axis->setNeedInit(true);
|
||||
|
||||
/*
|
||||
Check if the axis already is in an error communication mode. If
|
||||
it is not, upstream the error. This is done to avoid "flooding"
|
||||
the user with different error messages if more than one error
|
||||
ocurred before an error-free communication
|
||||
*/
|
||||
getAxisParamChecked(axis, motorStatusProblem, &motorStatusProblem);
|
||||
|
||||
if (motorStatusProblem == 0) {
|
||||
setAxisParamChecked(axis, motorMessageText, drvMessageText);
|
||||
setAxisParamChecked(axis, motorStatusProblem, true);
|
||||
setAxisParamChecked(axis, motorStatusCommsError, false);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -301,7 +412,7 @@ asynStatus masterMacsController::parseResponse(
|
||||
bool responseValid = false;
|
||||
int responseStart = 0;
|
||||
asynStatus status = asynSuccess;
|
||||
int prevConnected = 0;
|
||||
int prevConnected = 1;
|
||||
char printableCommand[MAXBUF_] = {0};
|
||||
char printableResponse[MAXBUF_] = {0};
|
||||
|
||||
@@ -309,12 +420,14 @@ asynStatus masterMacsController::parseResponse(
|
||||
msgPrintControlKey(portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
|
||||
|
||||
masterMacsAxis *axis = getMasterMacsAxis(axisNo);
|
||||
if (axis == nullptr) {
|
||||
if (axisNo != 0 && axis == nullptr) {
|
||||
return asynError;
|
||||
}
|
||||
|
||||
// Was the motor previously connected?
|
||||
getAxisParamChecked(axis, motorConnected, &prevConnected);
|
||||
if (axis != nullptr) {
|
||||
getAxisParamChecked(axis, motorConnected, &prevConnected);
|
||||
}
|
||||
|
||||
// We don't use strlen here since the C string terminator 0x00
|
||||
// occurs in the middle of the char array.
|
||||
@@ -338,14 +451,17 @@ asynStatus masterMacsController::parseResponse(
|
||||
"connected.\n",
|
||||
portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
|
||||
|
||||
setAxisParamChecked(axis, motorConnected, true);
|
||||
status = callParamCallbacks();
|
||||
if (status != asynSuccess) {
|
||||
asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
|
||||
"Controller \"%s\", axis %d => %s, line "
|
||||
"%d:\nCould not update parameter library\n",
|
||||
portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
|
||||
return status;
|
||||
if (axis != nullptr) {
|
||||
setAxisParamChecked(axis, motorConnected, true);
|
||||
status = callParamCallbacks();
|
||||
if (status != asynSuccess) {
|
||||
asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
|
||||
"Controller \"%s\", axis %d => %s, line "
|
||||
"%d:\nCould not update parameter library\n",
|
||||
portName, axisNo, __PRETTY_FUNCTION__,
|
||||
__LINE__);
|
||||
return status;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -366,14 +482,17 @@ asynStatus masterMacsController::parseResponse(
|
||||
"disconnected.\n",
|
||||
portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
|
||||
|
||||
setAxisParamChecked(axis, motorConnected, false);
|
||||
status = callParamCallbacks();
|
||||
if (status != asynSuccess) {
|
||||
asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
|
||||
"Controller \"%s\", axis %d => %s, line "
|
||||
"%d:\nCould not update parameter library\n",
|
||||
portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
|
||||
return status;
|
||||
if (axis != nullptr) {
|
||||
setAxisParamChecked(axis, motorConnected, false);
|
||||
status = callParamCallbacks();
|
||||
if (status != asynSuccess) {
|
||||
asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
|
||||
"Controller \"%s\", axis %d => %s, line "
|
||||
"%d:\nCould not update parameter library\n",
|
||||
portName, axisNo, __PRETTY_FUNCTION__,
|
||||
__LINE__);
|
||||
return status;
|
||||
}
|
||||
}
|
||||
}
|
||||
break;
|
||||
@@ -459,6 +578,8 @@ asynStatus masterMacsController::readInt32(asynUser *pasynUser,
|
||||
|
||||
double masterMacsController::comTimeout() { return pMasterMacsC_->comTimeout; }
|
||||
|
||||
int masterMacsController::nodeReset() { return pMasterMacsC_->nodeReset; }
|
||||
|
||||
/***************************************************************************/
|
||||
/** The following functions are C-wrappers, and can be called directly from
|
||||
* iocsh */
|
||||
|
||||
@@ -15,11 +15,11 @@
|
||||
// Forward declaration of the controller class to resolve the cyclic dependency
|
||||
// between the controller and the axis .h-file. See
|
||||
// https://en.cppreference.com/w/cpp/language/class.
|
||||
class masterMacsAxis;
|
||||
class HIDDEN masterMacsAxis;
|
||||
|
||||
struct masterMacsControllerImpl;
|
||||
struct HIDDEN masterMacsControllerImpl;
|
||||
|
||||
class masterMacsController : public sinqController {
|
||||
class HIDDEN masterMacsController : public sinqController {
|
||||
|
||||
public:
|
||||
/**
|
||||
@@ -65,6 +65,17 @@ class masterMacsController : public sinqController {
|
||||
*/
|
||||
masterMacsAxis *getMasterMacsAxis(int axisNo);
|
||||
|
||||
/**
|
||||
* @brief Overloaded function of sinqController
|
||||
*
|
||||
* The function is overloaded to allow resetting the node
|
||||
*
|
||||
* @param pasynUser Specify the axis via the asynUser
|
||||
* @param value New value
|
||||
* @return asynStatus
|
||||
*/
|
||||
virtual asynStatus writeInt32(asynUser *pasynUser, epicsInt32 value);
|
||||
|
||||
/**
|
||||
* @brief Send a command to the hardware (S mode)
|
||||
*
|
||||
@@ -141,6 +152,9 @@ class masterMacsController : public sinqController {
|
||||
*/
|
||||
double comTimeout();
|
||||
|
||||
// Accessors for additional PVs
|
||||
int nodeReset();
|
||||
|
||||
private:
|
||||
std::unique_ptr<masterMacsControllerImpl> pMasterMacsC_;
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user