From ceb19c980c6692ad055e4bb159ce195ec3213d7a Mon Sep 17 00:00:00 2001 From: Ron Sluiter Date: Wed, 26 Jun 2013 21:20:44 +0000 Subject: [PATCH] Updated docs. --- README | 88 ++++++++++++++++---------------------- iocBoot/iocNoAsyn/README | 10 ++--- iocBoot/iocWithAsyn/README | 18 ++------ 3 files changed, 45 insertions(+), 71 deletions(-) diff --git a/README b/README index eb4ed7ad..190a9d87 100644 --- a/README +++ b/README @@ -1,8 +1,8 @@ -Motor Record R6-8 Release Notice +Motor Module R6-9 Release Notes =============================================================================== -The motor record software in this release is compatible with EPICS base -R3-14-12-1. See the /configure/RELEASE file for support module version +The motor module software in this release is compatible with EPICS base +R3-14-12-3. See the /configure/RELEASE file for support module version dependencies. @@ -10,67 +10,53 @@ Contents ======== This contains the following motor record related items: - - motor record and device driver database definitions. - - the record level support library. - - device/driver libraries for various controllers. - - motor record/device/driver level documentation. - - motor record release documentation. - - two example applications; one without ASYN (i.e. motorExApp/NoMPF) - and one with ASYN (i.e., motorExApp/WithMPF). See the README files - under /iocBoot/* for configuration instructions. -As distributed, this support directory builds the following: - - Record support and common code for all device/drivers; libmotor.a. - - All non-asyn dependent device drivers; liboms.a, libsoftMotor.a, - libDeltaTau.a. - - If ASYN is defined, all other device drivers are built. +- motor database and record support (/motorApp/MotorSrc). +- Model (or phase) #1, #2 and #3 device/driver support + (/motorApp/MotorSrc). +- device/driver support for various manufactures motor controllers (in + manufacture specific directories; e.g., /motorApp/OmsSrc, + /motorApp/NewportSrc). +- motor record and device/driver level documentation (/documentation). +- two example applications; one without ASYN (i.e. motorExApp/NoMPF) and one + with ASYN (i.e., motorExApp/WithMPF). See the README files under + /iocBoot/* for configuration instructions. +- Back Up and Restore Tool (BURT) files (in /motorApp/op/burt). +- medm displays (/motorApp/op/adl). +- CSS/BOY displays (/motorApp/op/opi). +- caQtDM displays (/motorApp/op/adl/ui). -Any of the following device/driver libraries can be omitted from the build by -commenting out the appropriate line in ./motorApp/Makefile. - Acs - Advanced Control Systems controllers; AcsSrc directory. - DeltaTau - Delta Tau controllers; DeltaTauSrc directory. - Ims - Intelligent Motion Systems (IMS) controllers; ImsSrc directory. - Mclennan - Mclennan controllers; MclennanSrc directory. - Micos - Micos controller; MicosSrc directory. - MicroMo - MicroMo controllers; MicroMoSrc directory. - Newport - Newport controllers; NewportSrc directory. - oms - Oregon Micro System (OMS) controllers; OmsSrc directory. - PI - Physik Instrumente (PI) GmbH & Co. controllers; PiSrc - directory. - softMotor - Soft Channel device support; SoftMotorSrc directory. - -Valuable device information can be found in the README files located in many of -the above manufacture specific directories (e.g., motorApp/OmsSrc, -motorApp/NewportSrc). +Any of the manufacture specific device/driver libraries can be omitted from the +build by commenting out the appropriate line in /motorApp/Makefile; see +"Configuration" below. In addition, valuable device information can be found +in the README files located in many of the manufacture specific directories. Configuration ============= -The following files can be edited to tailor this distribution to site specific +The following files can be edited to tailor the distribution to site specific needs. See individual files for instructions. - /configure/RELEASE: Define location of external products. - If only VMEbus based motor controllers (e.g., OMS, Highland - V544) and/or Soft Channel device support is used, then only - EPICS_BASE is required. + If only EPICS_BASE is defined, then only the following + libraries are built; libmotor, libsoftMotor and liboms. + (Although it is built, liboms is for VxWorks targets only + if ASYN is undefined). - For serial and/or GPIB motor controller communication, ALL of - the following support modules are required; - - EPICS base R3-14-7 - - ASYN R4-2 + For any motor controllers requiring serial or GPIB + communication, ASYN is required. - If any example applications (motorExApp) are to be built, then - TEMPLATE_TOP and MSITOP must be defined. + - /motorApp/Makefile: Defines which manufacture specific + directories to build. For example, commenting out these lines + #!DIRS += NewportSrc + #!NewportSrc_DEPEND_DIRS = MotorSrc + will result in skipping all the Newport controllers from the + build. - - /motorApp/Makefile: Defines which device/driver modules to - build. - ./Makefile: uncomment the following to build example applications. - #DIRS := $(DIRS) $(filter-out $(DIRS), motorExApp) - #DIRS := $(DIRS) $(filter-out $(DIRS), iocBoot) - - ./motorExApp/Makefile: Define which, if any, example applications are - to be built. - - + #!DIRS += motorExApp iocBoot + #!motorExApp_DEPEND_DIRS = motorApp + #!iocBoot_DEPEND_DIRS = motorExApp Known Problems ============== diff --git a/iocBoot/iocNoAsyn/README b/iocBoot/iocNoAsyn/README index 42335a47..e639fe36 100644 --- a/iocBoot/iocNoAsyn/README +++ b/iocBoot/iocNoAsyn/README @@ -1,11 +1,11 @@ To build any examples; -- in /configure/RELEASE: EPICS_BASE, TEMPLATE_TOP and MSI must - be defined. +- in /configure/RELEASE: EPICS_BASE must be defined and, + #!MOTOR=$(TOP) must be uncommented. - in /Makefile: the following two lines must be uncommented; - #!DIRS := $(DIRS) $(filter-out $(DIRS), motorExApp) - #!DIRS := $(DIRS) $(filter-out $(DIRS), iocBoot) + #!DIRS := $(DIRS) $(filter-out $(DIRS), motorExApp) + #!DIRS := $(DIRS) $(filter-out $(DIRS), iocBoot) To build the OMS example in this directory; - in /motorApp/Makefile: #!DIRS += OmsSrc must be uncommented. @@ -13,7 +13,7 @@ To build the OMS example in this directory; - in /motorExApp/Makefile: #!DIRS += NoAsyn must be uncommented. - in /motorExApp/NoAsyn/Makefile: #!NoAsynVx_LIBS += oms must be - uncommented. + uncommented. Finally, cd ; gnumake clean uninstall; gnumake diff --git a/iocBoot/iocWithAsyn/README b/iocBoot/iocWithAsyn/README index 9bdbcaa0..aeed602c 100644 --- a/iocBoot/iocWithAsyn/README +++ b/iocBoot/iocWithAsyn/README @@ -6,22 +6,10 @@ To build any examples; #DIRS := $(DIRS) $(filter-out $(DIRS), motorExApp) #DIRS := $(DIRS) $(filter-out $(DIRS), iocBoot) -To build this Newport MM4000/5/6 example; +To build the iocWithAsyn example; -- in /configure/RELEASE: IPAC and ASYN must all be defined. - -- in /motorApp/Makefile: #DIRS += NewportSrc must be uncommented. - -- in /motorExApp/Makefile: #DIRS += WithAsyn must be uncommented. - -- in /motorExApp/WithAsyn/Makefile: uncomment both, - #!WithAsyn_LIBS += Newport - and, - #!WithAsynVx_LIBS += Newport - -- in both /motorExApp/WithAsyn/WithAsynInclude.dbd, and in - /motorExApp/WithAsyn/WithAsynVxInclude.dbd - uncomment, #include "devNewport.dbd" +- in /configure/RELEASE: IPAC and ASYN must be defined. + Finally, cd ; gnumake clean uninstall; gnumake