From df698554c07996d325bb8d25b7335c78d2c7c051 Mon Sep 17 00:00:00 2001 From: smathis Date: Thu, 14 Nov 2024 16:11:52 +0100 Subject: [PATCH] Adjusted the readme and renamed some bits in sinqController. --- README.md | 10 +++++++++- src/sinqController.cpp | 2 -- src/sinqController.h | 1 - 3 files changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4f8806d..1888025 100644 --- a/README.md +++ b/README.md @@ -16,16 +16,24 @@ sinqMotor offers a variety of additional methods for children classes to standar ### sinqAxis - `atFirstPoll`: This function is executed once before the first poll. If it returns anything but `asynSuccess`, it retries. - `poll`: This is a wrapper around `doPoll` which performs some bookkeeping tasks before and after calling `doPoll`: + Before calling `doPoll`: - Try to execute `atFirstPoll` once (and retry, if that failed) + After calling `doPoll`: - Reset `motorStatusProblem_`, `motorStatusCommsError_` and `motorMessageText_` if `doPoll` returned `asynSuccess` - Run `callParamCallbacks` - Return the status of `doPoll` - `doPoll`: This is an empty function which should be overwritten by concrete driver implementations. +## Versioning + +The versioning is done via git tags. Git tags are recognized by the PSI build system: If you tag a version as 1.0, it will be built into the directory /ioc/modules/sinqMotor/1.0. The tag is directly coupled to a commit so that it is always clear which source code was used to build which binary. + +All existing tags can be listed with `git tag` in the sinqMotor directory. Detailed information (author, data, commit number, commit message) regarding a specific tag can be shown with `git show X.X`, where X.X is the name of your version. To create a new tag, use `git tag -a X.X`. If the tag `X.X` is already used by another commit, git will show a corresponding error. + ## How to build it -The makefile in the top directory includes all necessary steps for compiling a shared library together with the header files into `/ioc/modules` (using the PSI EPICS build system).Therefore it is sufficient to run `make install -f Makefile` from the terminal. If you want to compile a new version, adjust the entry `LIBVERSION` accordingly. +The makefile in the top directory includes all necessary steps for compiling a shared library together with the header files into `/ioc/modules` (using the PSI EPICS build system).Therefore it is sufficient to run `make install -f Makefile` from the terminal. To use the library when writing a concrete motor driver, include it in the makefile of your application /library the same way as other libraries such as e.g. `asynMotor` by adding `REQUIRED+=sinqMotor` to your Makefile. diff --git a/src/sinqController.cpp b/src/sinqController.cpp index 73fbc1f..90e7f9a 100644 --- a/src/sinqController.cpp +++ b/src/sinqController.cpp @@ -27,8 +27,6 @@ sinqController::sinqController(const char *portName, const char *SINQPortName, 1, // autoconnect 0, 0) // Default priority and stack size { - createParam(motorMessageIsFromDriverString, asynParamInt32, - &motorMessageIsFromDriver_); createParam(motorMessageTextString, asynParamOctet, &motorMessageText_); } diff --git a/src/sinqController.h b/src/sinqController.h index 90588c6..406158b 100644 --- a/src/sinqController.h +++ b/src/sinqController.h @@ -47,7 +47,6 @@ class epicsShareClass sinqController : public asynMotorController { protected: asynUser *lowLevelPortUser_; - int motorMessageIsFromDriver_; int motorMessageText_; };