From 4c401140d83ced3f308107e39d43909a6e426a7f Mon Sep 17 00:00:00 2001 From: kpetersn Date: Wed, 17 Apr 2019 14:55:38 -0500 Subject: [PATCH] Simplified the Files section --- docs/motorRecord.html | 359 ++---------------------------------------- 1 file changed, 12 insertions(+), 347 deletions(-) diff --git a/docs/motorRecord.html b/docs/motorRecord.html index b12cbf14..355d4b2c 100644 --- a/docs/motorRecord.html +++ b/docs/motorRecord.html @@ -21,7 +21,7 @@ Field Descriptions
  • - Files, device-support + Files
  • Restrictions @@ -3235,20 +3235,14 @@ below.

    -

    Files, device support

    The following table briefly describes all of the -files required to implement and use the motor record. The reader is assumed to -be familiar with the EPICS -Application Source/Release Control document which describes how to build an -EPICS application tree into which these files are to be placed, and how to run -"makesdr" and "gnumake" to build the record support. These files can all be -obtained from the EPICS -Software Distribution (in the custom-software -section ). +

    Files

    +

    + The following tables briefly describe some of the files in the motor module.
    +

    - + @@ -3300,134 +3294,6 @@ section ). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -3443,68 +3309,13 @@ section ). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    SOURCE CODE
    - files to be placed in &lttop>/&ltapp&gtApp/src/
    SOURCE CODE
    motorRecord.dbd
    devOmsCom.cDevice support common to all Oregon Micro Systems device drivers.
    devOmsCom.hDevice support header file common to all Oregon Micro Systems device drivers.
    drvOmsCom.hDriver support header file common to all Oregon Micro Systems device drivers.

    -
    NOTE: The above files are required for any and all Oregon Micro Systems - device drivers.

    -

    -
    devOms.cDevice support for Oregon Micro Systems VME8 and VME44 series boards
    drvOms.cDriver for Oregon Micro Systems VME8 and VME44 series boards
    drvOms.hHeader included by devOms.c and drvOms.c

    -

    -
    devOms58.cDevice support for Oregon Micro Systems VME58 series boards
    drvOms58.cDriver for Oregon Micro Systems VME58 series boards
    drvOms58.hHeader included by devOms58.c and drvOms58.c

    -

    -
    devV544.cDevice support for Highland Technology boards.
    drvV544.cDriver for Highland Technology boards.
    drvV544.hHeader included by devV544.c and drvV544.c

    -

    -
    drvMMCom.hCommon header included by all Newport Motion Master device drivers.

    -
    NOTE: The above files are required for any and all Newport Motion Master - device drivers.
    devMM3000.cDevice support for Newport MM3000.
    drvMM3000.cDriver for Newport MM3000.
    devMM4000.cDevice support for Newport MM4000/40005.
    drvMM4000.cDriver for Newport MM4000/40005.
    devPM500.cDevice support for Newport PM500.
    drvPM500.cDriver for Newport PM500.
    devESP300.c
    -
    Device support for Newport ESP300.
    drvESP300.c
    -
    Driver for Newport ESP300.

    -

    -
    devSoft.c Soft Channel device support.devSoft.h Header included by devSoft.c and devSoftAux.c

    -

    -
    gpibIO.hGPIB communication include file.
    gpibIO.cGPIB interface via Hideos.
    serialIO.hSerial communication include file.
    serialIOMPF.ccSerial communication interface via MPF.

    -

    -
    drvIM483.hCommon header included by all IMS device drivers.
    devIM483PL.cDevice support for IM483 in party line communication mode.
    devIM483SM.cDevice support for IM483 in single mode communication mode.
    drvIM483PL.cDriver for IM483 in party line communication mode.
    drvIM483SM.cDriver for IM483 in single mode communication mode.

    -

    -
    - + @@ -3547,151 +3358,10 @@ section ). - - - - + EPICS STARTUP FILES - @@ -3701,15 +3371,11 @@ section ).
    MEDM DISPLAY SCREENS
    - files to be placed in &lttop>/&ltapp&gtApp/op/adl/
    MEDM DISPLAY SCREENS
    motorx.adl

    - EPICS STARTUP FILES
    - files to be placed in &lttop>/ioc/ioc&ltname>/
    st.cmdmv167 Startup script
    A sample startup script, containing excerpts relevant to motors, - is included in the distribution. Here is an annotated copy: - -
    #######################################################################
    - # vxWorks startup script to load and execute system (iocCore) software.
    - Load standard EPICS software - -
    # the following should be loaded first - BEGIN
    ld < targetmv167/ - iocCore
    ld < targetmv167/drvSup
    ld < targetmv167/devSup
    ld < - targetmv167/recSup
    # the following should be loaded first - END
    - Load custom EPICS software (including motor support) - -
    ld < ../../stdApp/src/O.mv167/stdlib.o
    - Motor-related debug switches  - -
    recMotordebug = 0

    #OMS vme8/vme44 debug switches
    devOMSdebug = 0
    - drvOMSdebug = 0

    #OMS vme58 debug switches
    devOms58debug = 0
    - drvOms58debug = 0

    #Highland Technology V544 debug switches
    devV544ebug - = 0
    drvV544debug = 0
    - Motor-related databases  - -
    # load this before loading any databases
    dbLoad "../../default.dctsdr"

    - #allstop
    dbLoadRecords("../../stdApp/gDb/allstop.db","P=tmm:")
    #motors
    - dbLoadRecords("../../stdApp/gDb/m16.db","P=tmm:")
    - Specify motor-controller board address, interrupt - vector, etc. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      omsSetup(nCards, baseAddress, intVectBase, - intLevel, pollRate)
    - oms58Setup(nCards, baseAddress, intVectBase, intLevel, pollRate)
    -

    - MM3000Setup(nCards, pollRate)
    - MM3000Config(card#, portName, GPIB#) -

    - -

    - MM4000Setup(nCards, pollRate)
    - MM4000Config(card#, portName, GPIB#) -

    - -

    - IM483SMSetup(nCards, pollRate) 
    - IM483SMConfig(card#, portName)  - -

    - -

    - IM483PLSetup(nCommNet, pollRate) 
    - IM483PLConfig(CommNet#, portName) 
    -

    - -

    - ESP300Setup(nCards, pollRate)
    - ESP300Config(card#, portName, GPIB#)
    -
    -
    -

    -
    nCardsthe number of cards or controllers; may be less, but not greater than this - value.
    nCommNetthe number of Communication networks  (e.g., the number of RS-422 - networks for a IM483PL device).
    baseAddressthe base address of the first card of a series. This must agree with address - jumpers on the actual card(s). - -

    - OMS VME8, VME44, and VMEX cards are all of one series, with a base address in - the short address space, on a 16-byte (0x10) boundary. (I.e., these cards - require 16 bytes each, and must all be addressed contiguously as, e.g., 0xFC00, - 0xFC10). -

    - -

    - OMS VME58-x cards are in their own series, also in the short address space, on - a 4k-byte (0x1000) boundary. -

    - -

    - Highland Technology V544 cards are in their own series, in the short address - space, on a 128-byte (0x80) boundary. -

    -
    intVectBasethe interrupt vector that will be loaded into the first card of a series. - Succeeding cards will be loaded with intVectBase+1, intVectBase+2, etc. Set to "0 - " to disable interrupt generation; otherwise, stay in the range [64..255].
    intLevelthe VME-interrupt level (in [1..6]) the cards will use. This must agree - with jumper settings on the cards.
    pollRatethe rate (in Hz.) at which the driver will interrogate a card when one of - its motors is moving. This is also the rate at which channel-access monitors - will be posted; to avoid saturating the network with motor-readback information, - don't set pollRate much higher than 10 Hz. pollRate must be in the range [1..60].
    portNameASYN port name.
    link
    -
    GPIB link or MPF server CPU location
    -
    GPIB#
    -
    GPIB address.
    -
    - -

    - # OMS VME8, VME44, VMEX driver setup parameters:
    omsSetup(5, 0xFC00, 180, 5, - 10)

    # OMS VME58 driver setup parameters:
    oms58Setup(5, 0x2000, 190, 5, - 10) -

    -

    #Start EPICS
    iocInit

    +
    Example startup scripts can be found in the example IOCs in the driver modules
    - + - + @@ -3718,8 +3384,7 @@ section ). - +
    BACKUP/RESTORE (BURT) REQUEST FILES
    - files to be placed in &lttop>/&ltapp&gtApp/op/burt/
    BACKUP/RESTORE (BURT) REQUEST FILES
    settings.reqsample request file to save settings of all motors. Edit this file, - supplying names of the motor records whose settings you want saved. (The sample - file also saves the states of other records in the sample database, m16.db, that - enable or disable the motor records.)A file that could be created to save settings from multiple motors.
    yyMotorSettings.req 
    positions.req sample request file to save positions of all motors. Edit this file, - supplying names of the motor records whose positions you want saved.A file that could be created to save positions from multiple motors.
    yyMotorPositions.req