Binary-Coalescence/motorDSM
2
0
Fork 0
mirror of https://github.com/Binary-Coalescence/motorDSM.git synced 2025-08-04 21:55:40 -05:00
Code Issues Packages Projects Releases Wiki Activity

Clarified install instructions in README.

Browse Source
This commit is contained in:
Daniel Sissom
2024-06-28 16:04:24 -05:00
parent c8dbd0916d
commit 1a4794a9b2
1 changed files with 15 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@@ -1,14 +1,11 @@
motorDSM motorDSM
========== ==========
EPICS motor drivers for the following [Dynamic Structures and EPICS motor drivers for the following [Dynamic Structures and Materials](https://www.dynamic-structures.com/) motor controllers: MD-90
Materials](https://www.dynamic-structures.com/) motor controllers: MD-90
[![Build Status](https://github.com/Binary-Coalescence/motorDSM/actions/workflows/ci-scripts-build.yml/badge.svg)](https://github.com/Binary-Coalescence/motorDSM/actions/workflows/ci-scripts-build.yml) [![Build Status](https://github.com/Binary-Coalescence/motorDSM/actions/workflows/ci-scripts-build.yml/badge.svg)](https://github.com/Binary-Coalescence/motorDSM/actions/workflows/ci-scripts-build.yml)
motorDSM is a submodule of [motor](https://github.com/epics-modules/motor). motorDSM is a submodule of [motor](https://github.com/epics-modules/motor). When motorDSM is built in the ``motor/modules`` directory, no manual configuration is needed.
When motorDSM is built in the ``motor/modules`` directory, no manual
configuration is needed.
motorDSM can also be built outside of motor by copying it's ``configure/EXAMPLE_RELEASE.local`` file to ``RELEASE.local`` and defining the paths to ``EPICS_BASE``, ``MOTOR``, and itself. motorDSM can also be built outside of motor by copying it's ``configure/EXAMPLE_RELEASE.local`` file to ``RELEASE.local`` and defining the paths to ``EPICS_BASE``, ``MOTOR``, and itself.
@@ -22,7 +19,7 @@ for one attached MD-90 controller, or
$ ../../bin/linux-x86_64/dsm st.cmd.md90.multi $ ../../bin/linux-x86_64/dsm st.cmd.md90.multi
for eight attached MD-90 controllers. for eight attached MD-90 controllers. You may need to change the path(s) for the serial port(s) in ``st.cmd.md90`` or ``st.cmd.md90.multi`` if the MD-90 is not attached at ``/dev/ttyUSB0``.
------------------------ ------------------------
@@ -51,18 +48,19 @@ asyn
$ cd $SUPPORT $ cd $SUPPORT
$ git clone git@github.com:epics-modules/asyn.git $ git clone git@github.com:epics-modules/asyn.git
Needed to install (on Arch Linux) ``rpcsvc-proto`` package to get ``rpcgen`` You may need to install (on Arch Linux) ``rpcsvc-proto`` package to get ``rpcgen``
binary needed to make asyn. binary needed to make asyn.
In ``asyn/configure``, copy ``RELEASE`` to ``RELEASE.local`` and set ``SUPPORT`` In ``asyn/configure``, create the file ``RELEASE.local`` with contents:
and ``EPICS_BASE`` paths. SUPPORT=/path/to/install/directory
EPICS_BASE=/path/to/epics-base
In ``asyn/configure``, create ``CONFIG_SITE.local`` file with the line: In ``asyn/configure``, create ``CONFIG_SITE.local`` file with the line:
TIRPC=YES TIRPC=YES
if appropriate header files are in ``/usr/include/tirpc/rpc`` instead if appropriate header files are in ``/usr/include/tirpc/rpc`` instead
of ``/usr/include/rpc``. of ``/usr/include/rpc``.
$ cd asyn $ cd $SUPPORT/asyn
$ make clean $ make clean
$ make $ make
@@ -74,15 +72,15 @@ seq
$ cd $SUPPORT $ cd $SUPPORT
$ git clone git@github.com:ISISComputingGroup/EPICS-seq.git seq $ git clone git@github.com:ISISComputingGroup/EPICS-seq.git seq
Install the ``re2c`` package (Arch). Install the ``re2c`` package (Arch) if needed.
Create ``seq/configure/RELEASE.local`` and set path for ``EPICS_BASE``. Create ``seq/configure/RELEASE.local`` and set path for ``EPICS_BASE``.
(Note this package seems to forget to git-ignore the .local file.) (Note this package seems to forget to git-ignore the .local file.)
Edit ``seq/configure/RELEASE`` to add the missing '-' before include for ``ISIS_CONFIG`` Edit ``seq/configure/RELEASE`` to add the missing '-' before include for ``ISIS_CONFIG``
on the next to last line. Seems to be a typo. on the next to last line. This seems to be a typo.
$ cd seq $ cd $SUPPORT/seq
$ make clean $ make clean
$ make $ make
@@ -94,24 +92,10 @@ motor
$ cd $SUPPORT $ cd $SUPPORT
$ git clone git@github.com:epics-modules/motor.git $ git clone git@github.com:epics-modules/motor.git
Optionally, if you want to install additional motor drivers: Create ``motor/configure/RELEASE.local`` and set ``SUPPORT``, ``ASYN``, ``SNCSEQ``,
$ cd motor
$ git submodule init
$ git submodule update modules/motorAcs
$ git submodule update modules/foo
$ git submodule update modules/bar
Optionally, edit ``motor/modules/Makefile`` and comment out all unused driver
submodules.
Optionally, create ``motor/config/CONFIG_SITE.local`` with the line:
BUILD_IOCS = YES
Create ``motor/config/RELEASE.local`` and set ``SUPPORT``, ``ASYN``, ``SNCSEQ``,
and ``EPICS_BASE`` to the appropriate paths. and ``EPICS_BASE`` to the appropriate paths.
$ cd motor $ cd $SUPPORT/motor
$ make distclean $ make distclean
$ make $ make
@@ -127,13 +111,13 @@ In ``motorDSM/configure``, copy ``EXAMPLE_RELEASE.local`` to ``RELEASE.local``
and set paths for ``EPICS_BASE``, ``MOTOR``, and ``MOTOR_DSM``. and set paths for ``EPICS_BASE``, ``MOTOR``, and ``MOTOR_DSM``.
In ``motorDSM/configure``, copy ``EXAMPLE_CONFIG_SITE.local`` In ``motorDSM/configure``, copy ``EXAMPLE_CONFIG_SITE.local``
to ``CONFIG_SITE.local`` and set: to ``CONFIG_SITE.local`` and uncomment to set:
BUILD_IOCS = YES BUILD_IOCS = YES
In ``motorDSM/iocs/dsmIOC/configure``, copy ``EXAMPLE_RELEASE.local`` to In ``motorDSM/iocs/dsmIOC/configure``, copy ``EXAMPLE_RELEASE.local`` to
``RELEASE.local``. Comment out the "if built inside motor" lines, uncomment the ``RELEASE.local``. Comment out the "if built inside motor" lines, uncomment the
"if built outside motor" lines, and set the path for ``MOTOR_DSM``. "if built outside motor" lines, and set the path for ``MOTOR_DSM``.
$ cd motorDSM $ cd $SUPPORT/motorDSM
$ make distclean $ make distclean
$ make $ make