Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 847f40970f |
@@ -1,24 +0,0 @@
|
|||||||
name: Test And Build
|
|
||||||
on: [push]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
Lint:
|
|
||||||
runs-on: linepics
|
|
||||||
steps:
|
|
||||||
- name: checkout repo
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
- name: cppcheck
|
|
||||||
run: cppcheck --std=c++17 --addon=cert --addon=misc --error-exitcode=1 src/*.cpp
|
|
||||||
- name: formatting
|
|
||||||
run: clang-format --style=file --Werror --dry-run src/*.cpp
|
|
||||||
Build:
|
|
||||||
runs-on: linepics
|
|
||||||
steps:
|
|
||||||
- name: checkout repo
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
submodules: 'true'
|
|
||||||
- run: |
|
|
||||||
sed -i 's/ARCH_FILTER=.*/ARCH_FILTER=linux%/' Makefile
|
|
||||||
echo -e "\nIGNORE_SUBMODULES += sinqmotor" >> Makefile
|
|
||||||
make install
|
|
||||||
48
.gitlab-ci.yml
Normal file
48
.gitlab-ci.yml
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
default:
|
||||||
|
image: docker.psi.ch:5000/sinqdev/sinqepics:latest
|
||||||
|
|
||||||
|
stages:
|
||||||
|
- lint
|
||||||
|
- build
|
||||||
|
- test
|
||||||
|
|
||||||
|
cppcheck:
|
||||||
|
stage: lint
|
||||||
|
script:
|
||||||
|
- cppcheck --std=c++17 --addon=cert --addon=misc --suppress=cert-STR07-C --error-exitcode=1 src/*.cpp
|
||||||
|
artifacts:
|
||||||
|
expire_in: 1 week
|
||||||
|
tags:
|
||||||
|
- sinq
|
||||||
|
|
||||||
|
formatting:
|
||||||
|
stage: lint
|
||||||
|
script:
|
||||||
|
- clang-format --style=file --Werror --dry-run src/*.cpp
|
||||||
|
artifacts:
|
||||||
|
expire_in: 1 week
|
||||||
|
tags:
|
||||||
|
- sinq
|
||||||
|
|
||||||
|
build_module:
|
||||||
|
stage: build
|
||||||
|
script:
|
||||||
|
- export SINQMOTOR_VERSION="$(grep 'sinqMotor_VERSION=' Makefile | cut -d= -f2)"
|
||||||
|
- git clone --depth 1 --branch "${SINQMOTOR_VERSION}" https://gitlab-ci-token:${CI_JOB_TOKEN}@git.psi.ch/sinq-epics-modules/sinqmotor.git
|
||||||
|
- pushd sinqmotor
|
||||||
|
- sed -i 's/ARCH_FILTER=.*/ARCH_FILTER=linux%/' Makefile
|
||||||
|
- echo "LIBVERSION=${SINQMOTOR_VERSION}" >> Makefile
|
||||||
|
- make install
|
||||||
|
- popd
|
||||||
|
- sed -i 's/ARCH_FILTER=.*/ARCH_FILTER=linux%/' Makefile
|
||||||
|
- echo "LIBVERSION=${CI_COMMIT_TAG:-0.0.1}" >> Makefile
|
||||||
|
- make install
|
||||||
|
- cp -rT "/ioc/modules/masterMacs/$(ls -U /ioc/modules/masterMacs/ | head -1)" "./masterMacs-${CI_COMMIT_TAG:-$CI_COMMIT_SHORT_SHA}"
|
||||||
|
artifacts:
|
||||||
|
name: "masterMacs-${CI_COMMIT_TAG:-$CI_COMMIT_SHORT_SHA}"
|
||||||
|
paths:
|
||||||
|
- "masterMacs-${CI_COMMIT_TAG:-$CI_COMMIT_SHORT_SHA}/*"
|
||||||
|
expire_in: 1 week
|
||||||
|
when: always
|
||||||
|
tags:
|
||||||
|
- sinq
|
||||||
7
Makefile
7
Makefile
@@ -23,14 +23,9 @@ SOURCES += src/masterMacsController.cpp
|
|||||||
# Store the record files
|
# Store the record files
|
||||||
TEMPLATES += sinqMotor/db/asynRecord.db
|
TEMPLATES += sinqMotor/db/asynRecord.db
|
||||||
TEMPLATES += sinqMotor/db/sinqMotor.db
|
TEMPLATES += sinqMotor/db/sinqMotor.db
|
||||||
TEMPLATES += db/masterMacs.db
|
|
||||||
|
|
||||||
# This file registers the motor-specific functions in the IOC shell.
|
# This file registers the motor-specific functions in the IOC shell.
|
||||||
DBDS += sinqMotor/src/sinqMotor.dbd
|
DBDS += sinqMotor/src/sinqMotor.dbd
|
||||||
DBDS += src/masterMacs.dbd
|
DBDS += src/masterMacs.dbd
|
||||||
|
|
||||||
USR_CFLAGS += -Wall -Wextra -Wunused-result -Wextra -Werror
|
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 -Wall -Wextra -Weffc++ -Wunused-result -Wextra
|
|
||||||
|
|||||||
30
README.md
30
README.md
@@ -55,43 +55,17 @@ setMaxSubsequentTimeouts("$(NAME)", 20);
|
|||||||
setThresholdComTimeout("$(NAME)", 100, 1);
|
setThresholdComTimeout("$(NAME)", 100, 1);
|
||||||
|
|
||||||
# Parametrize the EPICS record database with the substitution file named after the MCU.
|
# Parametrize the EPICS record database with the substitution file named after the MCU.
|
||||||
epicsEnvSet("SINQDBPATH","$(masterMacs_DB)/sinqMotor.db")
|
epicsEnvSet("SINQDBPATH","$(sinqMotor_DB)/sinqMotor.db")
|
||||||
dbLoadTemplate("$(TOP)/$(NAME).substitutions", "INSTR=$(INSTR)$(NAME):,CONTROLLER=$(NAME)")
|
dbLoadTemplate("$(TOP)/$(NAME).substitutions", "INSTR=$(INSTR)$(NAME):,CONTROLLER=$(NAME)")
|
||||||
epicsEnvSet("SINQDBPATH","$(masterMacs_DB)/masterMacs.db")
|
epicsEnvSet("SINQDBPATH","$(masterMacs_DB)/masterMacs.db")
|
||||||
dbLoadTemplate("$(TOP)/$(NAME).substitutions", "INSTR=$(INSTR)$(NAME):,CONTROLLER=$(NAME)")
|
dbLoadTemplate("$(TOP)/$(NAME).substitutions", "INSTR=$(INSTR)$(NAME):,CONTROLLER=$(NAME)")
|
||||||
dbLoadRecords("$(masterMacs_DB)/asynRecord.db","P=$(INSTR)$(NAME),PORT=$(ASYN_PORT)")
|
dbLoadRecords("$(sinqMotor_DB)/asynRecord.db","P=$(INSTR)$(NAME),PORT=$(ASYN_PORT)")
|
||||||
```
|
```
|
||||||
|
|
||||||
### Versioning
|
### Versioning
|
||||||
|
|
||||||
Please see the documentation for the module sinqMotor: https://git.psi.ch/sinq-epics-modules/sinqmotor/-/blob/main/README.md.
|
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
|
### How to build it
|
||||||
|
|
||||||
Please see the documentation for the module sinqMotor: https://git.psi.ch/sinq-epics-modules/sinqmotor/-/blob/main/README.md.
|
Please see the documentation for the module sinqMotor: https://git.psi.ch/sinq-epics-modules/sinqmotor/-/blob/main/README.md.
|
||||||
|
|||||||
@@ -1,7 +0,0 @@
|
|||||||
# 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: 59a5ba452f...c2eca33ce8
File diff suppressed because it is too large
Load Diff
@@ -1,12 +1,16 @@
|
|||||||
#ifndef masterMacsAXIS_H
|
#ifndef masterMacsAXIS_H
|
||||||
#define masterMacsAXIS_H
|
#define masterMacsAXIS_H
|
||||||
#include "masterMacsController.h"
|
|
||||||
#include "sinqAxis.h"
|
#include "sinqAxis.h"
|
||||||
#include <memory>
|
#include <memory>
|
||||||
|
|
||||||
struct HIDDEN masterMacsAxisImpl;
|
// 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 masterMacsController;
|
||||||
|
|
||||||
class HIDDEN masterMacsAxis : public sinqAxis {
|
struct masterMacsAxisImpl;
|
||||||
|
|
||||||
|
class masterMacsAxis : public sinqAxis {
|
||||||
public:
|
public:
|
||||||
/**
|
/**
|
||||||
* @brief Construct a new masterMacsAxis
|
* @brief Construct a new masterMacsAxis
|
||||||
@@ -16,13 +20,6 @@ class HIDDEN masterMacsAxis : public sinqAxis {
|
|||||||
*/
|
*/
|
||||||
masterMacsAxis(masterMacsController *pController, int axisNo);
|
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
|
* @brief Destroy the masterMacsAxis
|
||||||
*
|
*
|
||||||
@@ -57,13 +54,13 @@ class HIDDEN masterMacsAxis : public sinqAxis {
|
|||||||
*
|
*
|
||||||
* @param position
|
* @param position
|
||||||
* @param relative
|
* @param relative
|
||||||
* @param minVelocity
|
* @param min_velocity
|
||||||
* @param maxVelocity
|
* @param max_velocity
|
||||||
* @param acceleration
|
* @param acceleration
|
||||||
* @return asynStatus
|
* @return asynStatus
|
||||||
*/
|
*/
|
||||||
asynStatus doMove(double position, int relative, double minVelocity,
|
asynStatus doMove(double position, int relative, double min_velocity,
|
||||||
double maxVelocity, double acceleration);
|
double max_velocity, double acceleration);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Implementation of the `stop` function from asynMotorAxis
|
* @brief Implementation of the `stop` function from asynMotorAxis
|
||||||
@@ -82,27 +79,12 @@ class HIDDEN masterMacsAxis : public sinqAxis {
|
|||||||
*/
|
*/
|
||||||
asynStatus doReset();
|
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
|
* @brief Readout of some values from the controller at IOC startup
|
||||||
*
|
*
|
||||||
* The following steps are performed:
|
* The following steps are performed:
|
||||||
* - Read out the motor status, motor position, velocity and
|
* - Read out the motor status, motor position, velocity and acceleration
|
||||||
* acceleration from the MCU and store this information in the parameter
|
* from the MCU and store this information in the parameter library.
|
||||||
* library.
|
|
||||||
* - Set the enable PV accordint to the initial status of the axis.
|
* - Set the enable PV accordint to the initial status of the axis.
|
||||||
*
|
*
|
||||||
* @return asynStatus
|
* @return asynStatus
|
||||||
@@ -118,8 +100,8 @@ class HIDDEN masterMacsAxis : public sinqAxis {
|
|||||||
asynStatus enable(bool on);
|
asynStatus enable(bool on);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Read the encoder type (incremental or absolute) for this axis
|
* @brief Read the encoder type (incremental or absolute) for this axis from
|
||||||
* from the MCU and store the information in the PV ENCODER_TYPE.
|
* the MCU and store the information in the PV ENCODER_TYPE.
|
||||||
*
|
*
|
||||||
* @return asynStatus
|
* @return asynStatus
|
||||||
*/
|
*/
|
||||||
@@ -134,21 +116,17 @@ class HIDDEN masterMacsAxis : public sinqAxis {
|
|||||||
bool needInit();
|
bool needInit();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Instruct the axis to run its init() function during the next
|
* @brief Instruct the axis to run its init() function during the next poll
|
||||||
* poll
|
|
||||||
*
|
*
|
||||||
* @param needInit
|
* @param needInit
|
||||||
*/
|
*/
|
||||||
void setNeedInit(bool needInit);
|
void setNeedInit(bool needInit);
|
||||||
|
|
||||||
/**
|
asynStatus readConfig();
|
||||||
* @brief Return a pointer to the axis controller
|
|
||||||
*/
|
|
||||||
virtual masterMacsController *pController() override { return pC_; };
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Read the Master MACS status with the xR10 command and store
|
* @brief Read the Master MACS status with the xR10 command and store the
|
||||||
* the result in axisStatus_
|
* result in axisStatus_
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
asynStatus readAxisStatus();
|
asynStatus readAxisStatus();
|
||||||
@@ -226,8 +204,8 @@ class HIDDEN masterMacsAxis : public sinqAxis {
|
|||||||
bool powerEnabled();
|
bool powerEnabled();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Read the Master MACS status with the xR10 command and store
|
* @brief Read the Master MACS status with the xR10 command and store the
|
||||||
* the result in axisStatus_
|
* result in axisStatus_
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
asynStatus readAxisError();
|
asynStatus readAxisError();
|
||||||
|
|||||||
@@ -12,33 +12,8 @@
|
|||||||
#include <string>
|
#include <string>
|
||||||
#include <unistd.h>
|
#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 {
|
struct masterMacsControllerImpl {
|
||||||
double comTimeout;
|
double comTimeout;
|
||||||
|
|
||||||
// Indices of additional ParamLib entries
|
|
||||||
int nodeReset;
|
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -81,32 +56,17 @@ masterMacsController::masterMacsController(const char *portName,
|
|||||||
: sinqController(portName, ipPortConfigName, numAxes, movingPollPeriod,
|
: sinqController(portName, ipPortConfigName, numAxes, movingPollPeriod,
|
||||||
idlePollPeriod,
|
idlePollPeriod,
|
||||||
// No additional parameter library entries
|
// No additional parameter library entries
|
||||||
0),
|
0)
|
||||||
pMasterMacsC_(
|
|
||||||
std::make_unique<masterMacsControllerImpl>((masterMacsControllerImpl){
|
|
||||||
.comTimeout = comTimeout,
|
|
||||||
.nodeReset = 0, // Overwritten later
|
|
||||||
}))
|
|
||||||
|
|
||||||
{
|
{
|
||||||
|
|
||||||
// Initialization of local variables
|
// Initialization of local variables
|
||||||
asynStatus status = asynSuccess;
|
asynStatus status = asynSuccess;
|
||||||
char response[MAXBUF_] = {0};
|
|
||||||
|
|
||||||
// =========================================================================
|
pMasterMacsC_ =
|
||||||
// Create additional parameter library entries
|
std::make_unique<masterMacsControllerImpl>((masterMacsControllerImpl){
|
||||||
|
.comTimeout = comTimeout,
|
||||||
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);
|
|
||||||
}
|
|
||||||
|
|
||||||
// =========================================================================
|
// =========================================================================
|
||||||
|
|
||||||
@@ -139,60 +99,6 @@ masterMacsController::masterMacsController(const char *portName,
|
|||||||
pasynOctetSyncIO->disconnect(pasynOctetSyncIOipPort());
|
pasynOctetSyncIO->disconnect(pasynOctetSyncIOipPort());
|
||||||
exit(-1);
|
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__);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/*
|
/*
|
||||||
@@ -214,24 +120,8 @@ masterMacsAxis *masterMacsController::getMasterMacsAxis(int axisNo) {
|
|||||||
return dynamic_cast<masterMacsAxis *>(asynAxis);
|
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,
|
asynStatus masterMacsController::read(int axisNo, int tcpCmd, char *response,
|
||||||
double /*comTimeout*/) {
|
double comTimeout) {
|
||||||
return writeRead(axisNo, tcpCmd, NULL, response);
|
return writeRead(axisNo, tcpCmd, NULL, response);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -246,6 +136,7 @@ asynStatus masterMacsController::writeRead(int axisNo, int tcpCmd,
|
|||||||
|
|
||||||
// Definition of local variables.
|
// Definition of local variables.
|
||||||
asynStatus status = asynSuccess;
|
asynStatus status = asynSuccess;
|
||||||
|
asynStatus pl_status = asynSuccess;
|
||||||
char fullCommand[MAXBUF_] = {0};
|
char fullCommand[MAXBUF_] = {0};
|
||||||
char fullResponse[MAXBUF_] = {0};
|
char fullResponse[MAXBUF_] = {0};
|
||||||
char drvMessageText[MAXBUF_] = {0};
|
char drvMessageText[MAXBUF_] = {0};
|
||||||
@@ -276,6 +167,12 @@ asynStatus masterMacsController::writeRead(int axisNo, int tcpCmd,
|
|||||||
comTimeout = pMasterMacsC_->comTimeout;
|
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
|
// Build the full command depending on the inputs to this function
|
||||||
if (isRead) {
|
if (isRead) {
|
||||||
snprintf(fullCommand, MAXBUF_ - 1, "%dR%02d\x0D", axisNo, tcpCmd);
|
snprintf(fullCommand, MAXBUF_ - 1, "%dR%02d\x0D", axisNo, tcpCmd);
|
||||||
@@ -357,38 +254,54 @@ asynStatus masterMacsController::writeRead(int axisNo, int tcpCmd,
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Log the overall status (communication successfull or not)
|
// Log the overall status (communication successfull or not)
|
||||||
if (axisNo != 0) {
|
if (status == asynSuccess) {
|
||||||
masterMacsAxis *axis = getMasterMacsAxis(axisNo);
|
pl_status = axis->setIntegerParam(this->motorStatusCommsError_, 0);
|
||||||
if (axis == nullptr) {
|
} else {
|
||||||
// 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
|
||||||
|
*/
|
||||||
|
pl_status =
|
||||||
|
getIntegerParam(axisNo, motorStatusProblem_, &motorStatusProblem);
|
||||||
|
if (pl_status != asynSuccess) {
|
||||||
|
return paramLibAccessFailed(pl_status, "motorStatusProblem", axisNo,
|
||||||
|
__PRETTY_FUNCTION__, __LINE__);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (status == asynSuccess) {
|
if (motorStatusProblem == 0) {
|
||||||
setAxisParamChecked(axis, motorStatusCommsError, false);
|
pl_status =
|
||||||
} else {
|
axis->setStringParam(motorMessageText(), drvMessageText);
|
||||||
/*
|
if (pl_status != asynSuccess) {
|
||||||
Since the communication failed, there is the possibility that the
|
return paramLibAccessFailed(pl_status, "motorMessageText",
|
||||||
controller is not connected at all to the network. In that case, we
|
axisNo, __PRETTY_FUNCTION__,
|
||||||
cannot be sure that the information read out in the init method of
|
__LINE__);
|
||||||
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);
|
|
||||||
|
|
||||||
/*
|
pl_status = axis->setIntegerParam(motorStatusProblem_, 1);
|
||||||
Check if the axis already is in an error communication mode. If
|
if (pl_status != asynSuccess) {
|
||||||
it is not, upstream the error. This is done to avoid "flooding"
|
return paramLibAccessFailed(pl_status, "motorStatusProblem",
|
||||||
the user with different error messages if more than one error
|
axisNo, __PRETTY_FUNCTION__,
|
||||||
ocurred before an error-free communication
|
__LINE__);
|
||||||
*/
|
}
|
||||||
getAxisParamChecked(axis, motorStatusProblem, &motorStatusProblem);
|
|
||||||
|
|
||||||
if (motorStatusProblem == 0) {
|
pl_status = axis->setIntegerParam(motorStatusProblem_, 1);
|
||||||
setAxisParamChecked(axis, motorMessageText, drvMessageText);
|
if (pl_status != asynSuccess) {
|
||||||
setAxisParamChecked(axis, motorStatusProblem, true);
|
return paramLibAccessFailed(pl_status, "motorStatusCommsError_",
|
||||||
setAxisParamChecked(axis, motorStatusCommsError, false);
|
axisNo, __PRETTY_FUNCTION__,
|
||||||
|
__LINE__);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -412,21 +325,18 @@ asynStatus masterMacsController::parseResponse(
|
|||||||
bool responseValid = false;
|
bool responseValid = false;
|
||||||
int responseStart = 0;
|
int responseStart = 0;
|
||||||
asynStatus status = asynSuccess;
|
asynStatus status = asynSuccess;
|
||||||
int prevConnected = 1;
|
int prevConnected = 0;
|
||||||
char printableCommand[MAXBUF_] = {0};
|
char printableCommand[MAXBUF_] = {0};
|
||||||
char printableResponse[MAXBUF_] = {0};
|
char printableResponse[MAXBUF_] = {0};
|
||||||
|
|
||||||
msgPrintControlKey parseKey =
|
msgPrintControlKey parseKey =
|
||||||
msgPrintControlKey(portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
|
msgPrintControlKey(portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
|
||||||
|
|
||||||
masterMacsAxis *axis = getMasterMacsAxis(axisNo);
|
|
||||||
if (axisNo != 0 && axis == nullptr) {
|
|
||||||
return asynError;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Was the motor previously connected?
|
// Was the motor previously connected?
|
||||||
if (axis != nullptr) {
|
status = getIntegerParam(axisNo, motorConnected(), &prevConnected);
|
||||||
getAxisParamChecked(axis, motorConnected, &prevConnected);
|
if (status != asynSuccess) {
|
||||||
|
return paramLibAccessFailed(status, "motorConnected", axisNo,
|
||||||
|
__PRETTY_FUNCTION__, __LINE__);
|
||||||
}
|
}
|
||||||
|
|
||||||
// We don't use strlen here since the C string terminator 0x00
|
// We don't use strlen here since the C string terminator 0x00
|
||||||
@@ -451,17 +361,23 @@ asynStatus masterMacsController::parseResponse(
|
|||||||
"connected.\n",
|
"connected.\n",
|
||||||
portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
|
portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
|
||||||
|
|
||||||
if (axis != nullptr) {
|
masterMacsAxis *axis = getMasterMacsAxis(axisNo);
|
||||||
setAxisParamChecked(axis, motorConnected, true);
|
if (axis == nullptr) {
|
||||||
status = callParamCallbacks();
|
return asynError;
|
||||||
if (status != asynSuccess) {
|
}
|
||||||
asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
|
status = axis->setIntegerParam(motorConnected(), 1);
|
||||||
"Controller \"%s\", axis %d => %s, line "
|
if (status != asynSuccess) {
|
||||||
"%d:\nCould not update parameter library\n",
|
return paramLibAccessFailed(status, "motorConnected",
|
||||||
portName, axisNo, __PRETTY_FUNCTION__,
|
axisNo, __PRETTY_FUNCTION__,
|
||||||
__LINE__);
|
__LINE__);
|
||||||
return status;
|
}
|
||||||
}
|
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;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -482,17 +398,23 @@ asynStatus masterMacsController::parseResponse(
|
|||||||
"disconnected.\n",
|
"disconnected.\n",
|
||||||
portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
|
portName, axisNo, __PRETTY_FUNCTION__, __LINE__);
|
||||||
|
|
||||||
if (axis != nullptr) {
|
masterMacsAxis *axis = getMasterMacsAxis(axisNo);
|
||||||
setAxisParamChecked(axis, motorConnected, false);
|
if (axis == nullptr) {
|
||||||
status = callParamCallbacks();
|
return asynError;
|
||||||
if (status != asynSuccess) {
|
}
|
||||||
asynPrint(this->pasynUserSelf, ASYN_TRACE_ERROR,
|
status = axis->setIntegerParam(motorConnected(), 0);
|
||||||
"Controller \"%s\", axis %d => %s, line "
|
if (status != asynSuccess) {
|
||||||
"%d:\nCould not update parameter library\n",
|
return paramLibAccessFailed(status, "motorConnected",
|
||||||
portName, axisNo, __PRETTY_FUNCTION__,
|
axisNo, __PRETTY_FUNCTION__,
|
||||||
__LINE__);
|
__LINE__);
|
||||||
return status;
|
}
|
||||||
}
|
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;
|
break;
|
||||||
@@ -578,8 +500,6 @@ asynStatus masterMacsController::readInt32(asynUser *pasynUser,
|
|||||||
|
|
||||||
double masterMacsController::comTimeout() { return pMasterMacsC_->comTimeout; }
|
double masterMacsController::comTimeout() { return pMasterMacsC_->comTimeout; }
|
||||||
|
|
||||||
int masterMacsController::nodeReset() { return pMasterMacsC_->nodeReset; }
|
|
||||||
|
|
||||||
/***************************************************************************/
|
/***************************************************************************/
|
||||||
/** The following functions are C-wrappers, and can be called directly from
|
/** The following functions are C-wrappers, and can be called directly from
|
||||||
* iocsh */
|
* iocsh */
|
||||||
@@ -639,8 +559,7 @@ static const iocshArg *const CreateControllerArgs[] = {
|
|||||||
&CreateControllerArg0, &CreateControllerArg1, &CreateControllerArg2,
|
&CreateControllerArg0, &CreateControllerArg1, &CreateControllerArg2,
|
||||||
&CreateControllerArg3, &CreateControllerArg4, &CreateControllerArg5};
|
&CreateControllerArg3, &CreateControllerArg4, &CreateControllerArg5};
|
||||||
static const iocshFuncDef configMasterMacsCreateController = {
|
static const iocshFuncDef configMasterMacsCreateController = {
|
||||||
"masterMacsController", 6, CreateControllerArgs,
|
"masterMacsController", 6, CreateControllerArgs};
|
||||||
"Create a new instance of a MasterMACS controller."};
|
|
||||||
static void configMasterMacsCreateControllerCallFunc(const iocshArgBuf *args) {
|
static void configMasterMacsCreateControllerCallFunc(const iocshArgBuf *args) {
|
||||||
masterMacsCreateController(args[0].sval, args[1].sval, args[2].ival,
|
masterMacsCreateController(args[0].sval, args[1].sval, args[2].ival,
|
||||||
args[3].dval, args[4].dval, args[5].dval);
|
args[3].dval, args[4].dval, args[5].dval);
|
||||||
|
|||||||
@@ -8,18 +8,14 @@
|
|||||||
|
|
||||||
#ifndef masterMacsController_H
|
#ifndef masterMacsController_H
|
||||||
#define masterMacsController_H
|
#define masterMacsController_H
|
||||||
|
#include "masterMacsAxis.h"
|
||||||
#include "sinqAxis.h"
|
#include "sinqAxis.h"
|
||||||
#include "sinqController.h"
|
#include "sinqController.h"
|
||||||
#include <memory>
|
#include <memory>
|
||||||
|
|
||||||
// Forward declaration of the controller class to resolve the cyclic dependency
|
struct masterMacsControllerImpl;
|
||||||
// between the controller and the axis .h-file. See
|
|
||||||
// https://en.cppreference.com/w/cpp/language/class.
|
|
||||||
class HIDDEN masterMacsAxis;
|
|
||||||
|
|
||||||
struct HIDDEN masterMacsControllerImpl;
|
class masterMacsController : public sinqController {
|
||||||
|
|
||||||
class HIDDEN masterMacsController : public sinqController {
|
|
||||||
|
|
||||||
public:
|
public:
|
||||||
/**
|
/**
|
||||||
@@ -38,13 +34,6 @@ class HIDDEN masterMacsController : public sinqController {
|
|||||||
int numAxes, double movingPollPeriod,
|
int numAxes, double movingPollPeriod,
|
||||||
double idlePollPeriod, double comTimeout);
|
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
|
* @brief Overloaded version of the sinqController version
|
||||||
*
|
*
|
||||||
@@ -72,17 +61,6 @@ class HIDDEN masterMacsController : public sinqController {
|
|||||||
*/
|
*/
|
||||||
masterMacsAxis *getMasterMacsAxis(int axisNo);
|
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)
|
* @brief Send a command to the hardware (S mode)
|
||||||
*
|
*
|
||||||
@@ -159,9 +137,6 @@ class HIDDEN masterMacsController : public sinqController {
|
|||||||
*/
|
*/
|
||||||
double comTimeout();
|
double comTimeout();
|
||||||
|
|
||||||
// Accessors for additional PVs
|
|
||||||
int nodeReset();
|
|
||||||
|
|
||||||
private:
|
private:
|
||||||
std::unique_ptr<masterMacsControllerImpl> pMasterMacsC_;
|
std::unique_ptr<masterMacsControllerImpl> pMasterMacsC_;
|
||||||
};
|
};
|
||||||
|
|||||||
Reference in New Issue
Block a user