Contents Previous

EPICS EPICS _template_ Module

Module Owner:
_owner_name_
This page is the home of the EPICS _template_ module, which provides _record/device/driver_ support for _hardware_. This site gives access to the software source code, information on other modules which are needed to install and run it, and documentation on the how to include and use it in your EPICS applications. Please email any comments and bug reports to _owner_name_ who is responsible for coordinating development and releases. _peer_name1_ and _peer_name2_ are also familiar with this module and may be willing to help with some problems.

Hardware Supported

The module can drive the following types of hardware:

Where to Find it

You can download the software by anonymous ftp from the _lab_ ftp site at ftp://ftp.example.com/_path_ , or directly from the links in the table below:
Module Version EPICS Release Filename
_1-1_ R3.13.1 _module1-0.tar.gz_
_2-0_ R3.14.0 _module2-1.tar.gz_

Required Modules

Applications using this software will also need these other modules to be installed:
_template_ VersionRequires moduleRelease needed
_1-1_ _required__versions_
_2-0_ _required1_ _versions_
_required2_ _versions_

Site Installation and Building

After obtaining a copy of the distribution, it must be installed and built for use at your site. These steps only need to be performed once for the site (unless versions of the module running under different releases of EPICS and/or the other required modules are needed).
  1. Create an installation directory for the module, usually this will end with /support/_class_/_module_.
  2. Unpacking the distribution tar file produces a <supporttop> directory named after the release number.
  3. Edit the config/RELEASE file and set the paths to your installation of EPICS and to the _required1_ and _required2_ modules.
  4. Run gnumake in the top level directory and check for any compilation errors.
  5. Please email _module_owner_ so s/he can keep track of which sites are using this software.

Application Installation

To use the installed and built support software in an <ioctop> application, make the following changes to the application:
  1. Edit the config/RELEASE file and add the line 
    _TEMPLATE_=/path/to/module/version
  2. See the documentation for the _requires1_ and _requires2_ modules for instructions on how to install these in the application. An <ioctop> application must use the same version of these modules that the _template_ module has been built with.
  3. Edit the config/CONFIG_APP file and add the lines 
    ifdef _TEMPLATE_
USR_INCLUDES += -I$(_TEMPLATE_)/include
_TEMPLATE_BIN = $(_TEMPLATE_)/bin/$(T_A)
USER_DBDFLAGS += -I $(_TEMPLATE_)/dbd
endif
  4. In the application source directory where the base object files are linked together, edit Makefile.Vx and add 
    LIBOJBS += $(_TEMPLATE_)/_templateLib_
  5. Ensure the following is included in the construction of the application's .dbd file 
    include "dev_template_.dbd"
  6. Rebuild the application and use the newly installed support as desired.

Documentation

The following documentation is available:

In Use

This software was originally developed by/for _developer_ at _lab_ and is used at the following EPICS sites:
_website_maintainer_
Contents Previous