Added manual and .gitignore
Some checks failed
Test And Build / Lint (push) Failing after 4s
Test And Build / Build (push) Successful in 7s

This commit is contained in:
2025-11-03 08:40:25 +01:00
parent 6f72766ae6
commit e1732639b2
3 changed files with 67 additions and 35 deletions

4
.gitignore vendored Normal file
View File

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

BIN
MasterMACS_manual.pdf Normal file

Binary file not shown.

View File

@@ -148,163 +148,191 @@ class HIDDEN masterMacsAxis : public sinqAxis {
/**
* @brief Read the Master MACS status with the xR10 command and store
* the result in axisStatus_
* the result in axisStatus (see masterMacsAxisImpl redefinition in
* masterMacsAxis.cpp)
*
*/
asynStatus readAxisStatus();
/*
The functions below read the specified status bit from the axisStatus
bitset. Since a bit can either be 0 or 1, the return value is given as a
boolean.
The functions below read the specified status bit from the axisStatus (see
masterMacsAxisImpl redefinition in masterMacsAxis.cpp) bitset. Since a bit
can either be 0 or 1, the return value is given as a boolean.
*/
/**
* @brief Read the property from axisStatus_
* @brief Read the property from axisStatus (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool readyToBeSwitchedOn();
/**
* @brief Read the property from axisStatus_
* @brief Read the property from axisStatus (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool switchedOn();
// Bit 2 is unused
/**
* @brief Read the property from axisStatus_
* @brief Read the property from axisStatus (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool faultConditionSet();
/**
* @brief Read the property from axisStatus_
* @brief Read the property from axisStatus (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool voltagePresent();
/**
* @brief Read the property from axisStatus_
* @brief Read the property from axisStatus (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool quickStopping();
/**
* @brief Read the property from axisStatus_
* @brief Read the property from axisStatus (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool switchOnDisabled();
/**
* @brief Read the property from axisStatus_
* @brief Read the property from axisStatus (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool warning();
// Bit 8 is unused
/**
* @brief Read the property from axisStatus_
* @brief Read the property from axisStatus (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool remoteMode();
/**
* @brief Read the property from axisStatus_
* @brief Read the property from axisStatus (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool targetReached();
/**
* @brief Read the property from axisStatus_
* @brief Read the property from axisStatus (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool internalLimitActive();
// Bits 12 and 13 are unused
/**
* @brief Read the property from axisStatus_
* @brief Read the property from axisStatus (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool setEventHasOcurred();
/**
* @brief Read the property from axisStatus_
* @brief Read the property from axisStatus (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool powerEnabled();
/**
* @brief Read the Master MACS status with the xR10 command and store
* the result in axisStatus_
* @brief Read the Master MACS error with the xR10 command and store
* the result in axisError (see masterMacsAxisImpl redefinition in
* masterMacsAxis.cpp)
*
*/
asynStatus readAxisError();
/*
The functions below read the specified error bit from the axisError_
bitset. Since a bit can either be 0 or 1, the return value is given as a
boolean.
The functions below read the specified error bit from the axisError (see
masterMacsAxisImpl redefinition in masterMacsAxis.cpp) bitset. Since a bit
can either be 0 or 1, the return value is given as a boolean.
*/
/**
* @brief Read the property from axisError_
* @brief Read the property from axisError (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool shortCircuit();
/**
* @brief Read the property from axisError_
* @brief Read the property from axisError (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool encoderError();
/**
* @brief Read the property from axisError_
* @brief Read the property from axisError (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool followingError();
/**
* @brief Read the property from axisError_
* @brief Read the property from axisError (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool communicationError();
/**
* @brief Read the property from axisError_
* @brief Read the property from axisError (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool feedbackError();
/**
* @brief Read the property from axisError_
* @brief Read the property from axisError (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool positiveLimitSwitch();
/**
* @brief Read the property from axisError_
* @brief Read the property from axisError (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool negativeLimitSwitch();
/**
* @brief Read the property from axisError_
* @brief Read the property from axisError (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool positiveSoftwareLimit();
/**
* @brief Read the property from axisError_
* @brief Read the property from axisError (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool negativeSoftwareLimit();
/**
* @brief Read the property from axisError_
* @brief Read the property from axisError (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool overCurrent();
/**
* @brief Read the property from axisError_
* @brief Read the property from axisError (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool overTemperature();
/**
* @brief Read the property from axisError_
* @brief Read the property from axisError (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool overVoltage();
/**
* @brief Read the property from axisError_
* @brief Read the property from axisError (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool underVoltage();
/**
* @brief Read the property from axisError_
* @brief Read the property from axisError (see masterMacsAxisImpl
* redefinition in masterMacsAxis.cpp)
*/
bool stoFault();