From 325478b0ee27fd3f26af3af404307091bff2ae73 Mon Sep 17 00:00:00 2001 From: anderssandstrom Date: Fri, 27 Sep 2024 12:56:43 +0000 Subject: [PATCH] deploy: a4bab8efd2b91cd5ba51069b1c598bf63b76031e --- 404.html | 2 +- categories/index.html | 6 +- index.html | 6 +- index.xml | 118 +++++++++--------- manual/build/index.html | 6 +- manual/general_cfg/best_practice/index.html | 6 +- manual/general_cfg/data_storage/index.html | 6 +- .../general_cfg/ecmc_command_ref/index.html | 6 +- manual/general_cfg/index.html | 6 +- manual/general_cfg/iocsh_utils/index.html | 6 +- manual/general_cfg/startup/index.html | 6 +- manual/general_cfg/startup/modes/index.html | 6 +- manual/index.html | 6 +- manual/introduction/index.html | 6 +- manual/knowledgebase/ethercatcli/index.html | 6 +- .../knowledgebase/hardware/el5042/index.html | 6 +- .../knowledgebase/hardware/el70x1/index.html | 6 +- .../knowledgebase/hardware/el9xxx/index.html | 6 +- manual/knowledgebase/hardware/host/index.html | 6 +- manual/knowledgebase/hardware/index.html | 6 +- manual/knowledgebase/index.html | 6 +- manual/knowledgebase/manual/index.html | 6 +- manual/knowledgebase/motion/index.html | 6 +- manual/knowledgebase/tuning/index.html | 8 +- manual/motion_cfg/axisplc/index.html | 6 +- manual/motion_cfg/axisyaml/index.html | 6 +- manual/motion_cfg/best_practice/index.html | 6 +- .../motion_cfg/best_practice/servo/index.html | 6 +- .../best_practice/stepper_biss_c/index.html | 6 +- manual/motion_cfg/direction/index.html | 6 +- manual/motion_cfg/homing/index.html | 6 +- manual/motion_cfg/index.html | 6 +- manual/motion_cfg/scaling/index.html | 6 +- manual/plc_cfg/best_practice/index.html | 6 +- manual/plc_cfg/function_libs/index.html | 6 +- manual/plc_cfg/index.html | 6 +- manual/plc_cfg/syntax/index.html | 6 +- sitemap.xml | 2 +- .../general/chkoversampfactordie/index.html | 6 +- .../general/chkoversamptimeordie/index.html | 6 +- .../chkvalidcurrentsetordie/index.html | 6 +- .../chkvalidvoltagesetordie/index.html | 6 +- source/general/general/index.html | 6 +- source/general/generaldiagnostics/index.html | 6 +- source/general/index.html | 6 +- source/general/index.xml | 22 ++-- source/general/init/index.html | 6 +- source/general/initall/index.html | 6 +- source/general/initaxis/index.html | 6 +- source/general/issuewarning/index.html | 6 +- source/general/verifyordie/index.html | 6 +- source/index.html | 6 +- source/index.xml | 2 +- source/motion/ecmc_axis-records/index.html | 6 +- source/motion/ecmc_axis/index.html | 6 +- source/motion/ecmc_axis_diag/index.html | 6 +- source/motion/ecmc_axis_mr/index.html | 6 +- source/motion/ecmc_axis_sync/index.html | 6 +- source/motion/ecmc_axis_sync_unset/index.html | 6 +- source/motion/ecmc_axis_unset/index.html | 6 +- source/motion/ecmc_enc-records/index.html | 6 +- source/motion/ecmc_enc/index.html | 6 +- source/motion/ecmc_enc_unset/index.html | 6 +- .../motion/ecmc_virt_axis-records/index.html | 6 +- source/motion/ecmc_virt_axis/index.html | 6 +- source/motion/ecmc_virt_axis_unset/index.html | 6 +- source/motion/index.html | 6 +- source/motion/index.xml | 18 +-- source/naming/ecmcclassicnaming/index.html | 6 +- source/naming/ecmcessnaming/index.html | 6 +- source/naming/ecmcmxsxxx/index.html | 6 +- source/naming/index.html | 6 +- source/naming/index.xml | 6 +- source/scripts/addaxis/index.html | 6 +- source/scripts/adddatastorage/index.html | 6 +- source/scripts/adddomain/index.html | 6 +- source/scripts/addecdataitem/index.html | 6 +- source/scripts/addecsdort/index.html | 6 +- source/scripts/addencoder/index.html | 6 +- source/scripts/addmaster/index.html | 6 +- source/scripts/addslave/index.html | 6 +- source/scripts/addslavekl/index.html | 6 +- source/scripts/addvirtualaxis/index.html | 6 +- .../applyaxissynchronization/index.html | 6 +- source/scripts/applyconfig/index.html | 6 +- source/scripts/applyslaveconfig/index.html | 6 +- source/scripts/applyslavedcconfig/index.html | 6 +- source/scripts/applysubstitutions/index.html | 6 +- source/scripts/applytemplate/index.html | 6 +- source/scripts/configureaxis/index.html | 6 +- source/scripts/configureslave/index.html | 6 +- .../scripts/configurevirtualaxis/index.html | 6 +- source/scripts/empty/index.html | 6 +- source/scripts/finalize/index.html | 6 +- source/scripts/index.html | 6 +- source/scripts/index.xml | 64 +++++----- source/scripts/jinja2/index.html | 6 +- source/scripts/jinja2/index.xml | 6 +- source/scripts/jinja2/loadyamlaxis/index.html | 6 +- source/scripts/jinja2/loadyamlenc/index.html | 6 +- source/scripts/jinja2/loadyamlplc/index.html | 6 +- source/scripts/loadaxisplcfile/index.html | 6 +- source/scripts/loadplcfile/index.html | 6 +- source/scripts/loadplclib/index.html | 6 +- source/scripts/loadplugin/index.html | 6 +- source/scripts/loadsubstaxes/index.html | 6 +- source/scripts/loadsubstconfig/index.html | 6 +- source/scripts/loadsubsthw/index.html | 6 +- .../restorerecordupdaterate/index.html | 6 +- source/scripts/setappmode/index.html | 6 +- source/scripts/setdiagnostics/index.html | 6 +- source/scripts/setrecordupdaterate/index.html | 6 +- source/scripts/slaveverify/index.html | 6 +- source/startup/index.html | 6 +- tags/index.html | 6 +- 115 files changed, 439 insertions(+), 439 deletions(-) diff --git a/404.html b/404.html index f4bb9040c..439f143ed 100644 --- a/404.html +++ b/404.html @@ -1 +1 @@ -404 Page not found

Error

Woops. Looks like this page doesn't exist ¯\_(ツ)_/¯.

Go to homepage

Page not found!

\ No newline at end of file +404 Page not found

Error

Woops. Looks like this page doesn't exist ¯\_(ツ)_/¯.

Go to homepage

Page not found!

\ No newline at end of file diff --git a/categories/index.html b/categories/index.html index ec4fd5390..f9f293e92 100644 --- a/categories/index.html +++ b/categories/index.html @@ -1,8 +1,8 @@ -Categories :: ecmccfg

category :: -Categories

    \ No newline at end of file +Categories
    \ No newline at end of file diff --git a/index.html b/index.html index 11b3a5e61..7f15203aa 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,6 @@ -ecmccfg :: ecmccfg
    navigation

    ecmccfg

    A configuration framework for ECMC Motion Control Module for EPICS.

    License GitHub

    This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -10,4 +10,4 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

    You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, -Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

    Latest release

    GitHub release (latest by date)

    Download

    GitHub top language

    \ No newline at end of file +Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

    Latest release

    GitHub release (latest by date)

    Download

    GitHub top language

    \ No newline at end of file diff --git a/index.xml b/index.xml index cffeb1a24..a4b8ad0c8 100644 --- a/index.xml +++ b/index.xml @@ -1,8 +1,8 @@ -ecmccfghttps://paulscherrerinstitute.github.io/ecmccfg/Recent content on ecmccfgHugo -- gohugo.ioen-usFri, 27 Sep 2024 12:53:13 +0000build at PSIhttps://paulscherrerinstitute.github.io/ecmccfg/manual/build/Mon, 01 Jan 0001 00:00:00 +0000https://paulscherrerinstitute.github.io/ecmccfg/manual/build/These instructions only work at PSI! +ecmccfghttps://paulscherrerinstitute.github.io/ecmccfg/Recent content on ecmccfgHugo -- gohugo.ioen-usFri, 27 Sep 2024 12:56:41 +0000build at PSIhttps://paulscherrerinstitute.github.io/ecmccfg/manual/build/Mon, 01 Jan 0001 00:00:00 +0000https://paulscherrerinstitute.github.io/ecmccfg/manual/build/These instructions only work at PSI! Build at PSI, using driver.makefile by default this module is only build for RHEL7 and Epics >=R7.0.5 -build on login cluster make [LIBVERSION] [clean] [uninstall] install check a particular version check the module loads for version dev, Epics R7+ and ECMC version dev, note MASTER_ID=-1 which runs ECMC in master-less mode. Make proper adjustments to match your needs in terms of versions.addAxis.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addaxis/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addaxis/description Script for adding axis EPICS PVs. +build on login cluster make [LIBVERSION] [clean] [uninstall] install check a particular version check the module loads for version dev, Epics R7+ and ECMC version dev, note MASTER_ID=-1 which runs ECMC in master-less mode. Make proper adjustments to match your needs in terms of versions.addAxis.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addaxis/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addaxis/description Script for adding axis EPICS PVs. details Adds an motion axis. -author Niko KiveladdDataStorage.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/adddatastorage/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/adddatastorage/description Script for adding dataStorage. +author Niko KiveladdDataStorage.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/adddatastorage/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/adddatastorage/description Script for adding dataStorage. details Adds dataStorage buffer. author Anders Sandstroem paramters DS_SIZE Size of data buffer. @@ -11,17 +11,17 @@ DS_TYPE (optional), default 0, 0: Normal Buffer, 1: Ring Buffer, 2: FIFO Buffer SAMPLE_RATE_MS (optional), default 1 DS_DEBUG (optional), default 0, 0: No debug printouts, 1: Debug printouts Example calls: -call for 1000 elements at 10 Hz ${SCRIPTEXEC} ${ecmccfg_DIR}addDataStorage.cmd "DS_ID=1, DS_SIZE=1000, SAMPLE_RATE_MS=100"addDomain.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/adddomain/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/adddomain/description Script for adding an EtherCAT domain. +call for 1000 elements at 10 Hz ${SCRIPTEXEC} ${ecmccfg_DIR}addDataStorage.cmd "DS_ID=1, DS_SIZE=1000, SAMPLE_RATE_MS=100"addDomain.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/adddomain/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/adddomain/description Script for adding an EtherCAT domain. details Adds an EtherCAt domain. author Anders Sandström paramters EXE_RATE (optional) Execution rate [cycles] defaults 0 (same EC_RATE) EXE_OFFSET (optional) Execution offset cycles [cycles] defaults 0 ALLOW_OFFLINE (optional) Allow domain to be offline defaults 0 -All EtherCAT entries generated after this command will be assignedaddEcDataItem.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addecdataitem/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addecdataitem/description Script for adding a ethercat data item. +All EtherCAT entries generated after this command will be assignedaddEcDataItem.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addecdataitem/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addecdataitem/description Script for adding a ethercat data item. details The ethercat data item allows for accessing alreday configured ethercat domain data in a flexible -author Anders SandströmaddEcSdoRT.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addecsdort/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addecsdort/description Script for adding asyn SDO object (access to SDO:s in realtime) +author Anders SandströmaddEcSdoRT.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addecsdort/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addecsdort/description Script for adding asyn SDO object (access to SDO:s in realtime) details Add SDO for async access during realtime operation -author Anders SandströmaddEncoder.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addencoder/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addencoder/description Script for adding an extra encoder to an axis. +author Anders SandströmaddEncoder.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addencoder/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addencoder/description Script for adding an extra encoder to an axis. details Adds an encoder to the last configured axis. author Niko Kivel paramters CONFIG configuration file, i.e. ./cfg/axis_1_enc_2.enc @@ -29,12 +29,12 @@ DEV (optional) device name, i.e. MOTOR1 CLEAR_VARS_CMD (optional) Set to “empty” for not clear env vars (if vars needed for later use). CFG_MACROS (optional) Substitution macros for config file Example call: -${SCRIPTEXEC} ${ecmccfg_DIR}addEncoder.cmd, "CONFIG=./cfg/linear_1_enc_3.enc"addMaster.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addmaster/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addmaster/description Script for claiming a particular master. +${SCRIPTEXEC} ${ecmccfg_DIR}addEncoder.cmd, "CONFIG=./cfg/linear_1_enc_3.enc"addMaster.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addmaster/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addmaster/description Script for claiming a particular master. details Claims an EtherCAT master. author Niko Kivel paramters MASTER_ID (optional) master ID as shown by ethercat master. Example calls: -call w/o MASTER_ID ${SCRIPTEXEC} ${ecmccfg_DIR}addMaster.cmd call w/ MASTER_ID, which claims the 4th master. ${SCRIPTEXEC} ${ecmccfg_DIR}addMaster.cmd, "MASTER_ID=3"addSlave.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addslave/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addslave/description Script for adding a slave to the EtherCAT bus configuration. +call w/o MASTER_ID ${SCRIPTEXEC} ${ecmccfg_DIR}addMaster.cmd call w/ MASTER_ID, which claims the 4th master. ${SCRIPTEXEC} ${ecmccfg_DIR}addMaster.cmd, "MASTER_ID=3"addSlave.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addslave/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addslave/description Script for adding a slave to the EtherCAT bus configuration. details Adds the respective hardware to the bus configuration, adds specific and default PV to the EPICS database. For some/most slaves also a default author Niko Kivel paramters HW_DESC Hardware descriptor, i.e. EL1008 @@ -42,32 +42,32 @@ SLAVE_ID (optional) bus position SUBST_FILE (optional) substitution file P_SCRIPT (optional) naming convention prefix script NELM (optional) Used for oversampling cards. Defaults to 1 -DEFAULT_SUBS (optional) option to disble default PVs for mapped PDOsaddSlaveKL.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addslavekl/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addslavekl/description Script for adding a KL slave to the EtherCAT bus configuration of KL type. +DEFAULT_SUBS (optional) option to disble default PVs for mapped PDOsaddSlaveKL.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addslavekl/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addslavekl/description Script for adding a KL slave to the EtherCAT bus configuration of KL type. details Adds the respective hardware to the bus configuration, adds specific and default PV to the EPICS database. For some/most slaves also a default author Anders Sandstrom paramters HW_DESC Hardware descriptor, i.e. KL2032 SLAVE_ID EtherCAT bus position of the BK1250 (or similar terminal) -SLAVE_ID_KL KL-Bus index in two digit hex starting at zero for the first slave after BK1250 (or similar terminal)addVirtualAxis.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addvirtualaxis/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addvirtualaxis/description Script for adding axis EPICS PVs. +SLAVE_ID_KL KL-Bus index in two digit hex starting at zero for the first slave after BK1250 (or similar terminal)addVirtualAxis.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addvirtualaxis/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/addvirtualaxis/description Script for adding axis EPICS PVs. details Adds an virtual axis with PVs. -author Niko KivelapplyAxisSynchronization.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applyaxissynchronization/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applyaxissynchronization/description Script for applying axis synchronization +author Niko KivelapplyAxisSynchronization.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applyaxissynchronization/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applyaxissynchronization/description Script for applying axis synchronization details Adds synchronization parameters to an axis provided by CONFIG. author Niko Kivel paramters CONFIG configuration file, i.e. ./cfg/linear_1.sax CLEAR_VARS_CMD (optional) Set to “empty” for not clear env vars (if needed vars for later use). Example call: -${SCRIPTEXEC} ${ecmccfg_DIR}applyAxisSynchronization.cmd, "CONFIG=./cfg/linear_1.sax"applyConfig.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applyconfig/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applyconfig/description Script for applying bus configuration. +${SCRIPTEXEC} ${ecmccfg_DIR}applyAxisSynchronization.cmd, "CONFIG=./cfg/linear_1.sax"applyConfig.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applyconfig/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applyconfig/description Script for applying bus configuration. details Applies the EtherCAT configuration and caluclates data offsets in the process image. author Niko Kivel Example call: -${SCRIPTEXEC} ${ecmccfg_DIR}applyConfig.cfgapplySlaveConfig.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applyslaveconfig/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applyslaveconfig/description Script for applying a specific slave configuration after the slave had been added manually. +${SCRIPTEXEC} ${ecmccfg_DIR}applyConfig.cfgapplySlaveConfig.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applyslaveconfig/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applyslaveconfig/description Script for applying a specific slave configuration after the slave had been added manually. details Apply configurations to a slave. author Niko Kivel Example call: call applySlaveConfig with CONFIG ${SCRIPTEXEC} ${ecmccfg_DIR}applySlaveConfig.cmd, "CONFIG=-Motor-Nanotec-ST4118L1804-B" call applySlaveConfig with LOCAL_CONFIG -${SCRIPTEXEC} ${ecmccfg_DIR}applySlaveConfig.cmd, "LOCAL_CONFIG=./myFancyServoConfig.cfg"applySlaveDCconfig.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applyslavedcconfig/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applyslavedcconfig/description Script for applying dc config to slave +${SCRIPTEXEC} ${ecmccfg_DIR}applySlaveConfig.cmd, "LOCAL_CONFIG=./myFancyServoConfig.cfg"applySlaveDCconfig.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applyslavedcconfig/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applyslavedcconfig/description Script for applying dc config to slave details Apply dc configurations to a slave. -author Anders SandstroemapplySubstitutions.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applysubstitutions/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applysubstitutions/description Script for applying substitution file +author Anders SandstroemapplySubstitutions.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applysubstitutions/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applysubstitutions/description Script for applying substitution file details Applies substitution from ${SUBST_FILE} with ${P_SCRIPT} author Niko Kivel paramters SUBST_FILE (optional) substitution file @@ -75,22 +75,22 @@ ECMC_P PV prefix P_SCRIPT (optional) naming convention prefix script NELM (optional) Used for oversampling cards. Defaults to 1 Example calls: -call w/o SLAVE_ID ${SCRIPTEXEC} "${ECMC_CONFIG_ROOT}applySubstitutions.cmd" "SUBST_FILE=${SUBST_FILE=ecmc${ECMC_EC_HWTYPE}.substitutions},ECMC_P=${ECMC_P}"applyTemplate.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applytemplate/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applytemplate/description Script for applying a template +call w/o SLAVE_ID ${SCRIPTEXEC} "${ECMC_CONFIG_ROOT}applySubstitutions.cmd" "SUBST_FILE=${SUBST_FILE=ecmc${ECMC_EC_HWTYPE}.substitutions},ECMC_P=${ECMC_P}"applyTemplate.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applytemplate/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/applytemplate/description Script for applying a template details Applies template from ${TEMPLATE_FILE} with ${P_SCRIPT}, PARAMS can be passed author Niko Kivel paramters TEMPLATE_FILE template file ECMC_P PV prefix PARAMS (optional) additional parameters Example calls: -call w/o SLAVE_ID ${SCRIPTEXEC} "${ECMC_CONFIG_ROOT}applyTemplate.cmd" "TEMPLATE_FILE=ecmcEcSlave.template,ECMC_P=${ECMC_P}"chkOverSampFactOrDie.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/chkoversampfactordie/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/chkoversampfactordie/description Validates requested oversampling factor +call w/o SLAVE_ID ${SCRIPTEXEC} "${ECMC_CONFIG_ROOT}applyTemplate.cmd" "TEMPLATE_FILE=ecmcEcSlave.template,ECMC_P=${ECMC_P}"chkOverSampFactOrDie.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/chkoversampfactordie/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/chkoversampfactordie/description Validates requested oversampling factor details Checks if requested oversampling factor is valid otherwise exits EPICS/ECMC -author Anders SandstroemchkOverSampTimeOrDie.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/chkoversamptimeordie/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/chkoversamptimeordie/description Validates the resulting sampling time for oversampling slaves. +author Anders SandstroemchkOverSampTimeOrDie.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/chkoversamptimeordie/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/chkoversamptimeordie/description Validates the resulting sampling time for oversampling slaves. details Checks if the resulting sampling time for oversampling slaves is higher or equal to the minimum time. -author Anders SandstroemchkValidCurrentSetOrDie.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/chkvalidcurrentsetordie/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/chkvalidcurrentsetordie/description Validates current settings +author Anders SandstroemchkValidCurrentSetOrDie.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/chkvalidcurrentsetordie/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/chkvalidcurrentsetordie/description Validates current settings details Checks if requested run current and standby current is less than max current and larger than 0. -author Anders SandstroemchkValidVoltageSetOrDie.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/chkvalidvoltagesetordie/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/chkvalidvoltagesetordie/description Validates requested voltage +author Anders SandstroemchkValidVoltageSetOrDie.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/chkvalidvoltagesetordie/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/chkvalidvoltagesetordie/description Validates requested voltage details Ensure requested nominal voltage is less than max voltage and larger than 0 -author Anders SandstroemconfigureAxis.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/configureaxis/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/configureaxis/description Script for adding an axis with configuration. +author Anders SandstroemconfigureAxis.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/configureaxis/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/configureaxis/description Script for adding an axis with configuration. details Adds an axis to the configuration and applies parameters provided by CONFIG. author Niko Kivel paramters CONFIG configuration file, i.e. ./cfg/linear_1.pax @@ -98,84 +98,84 @@ DEV (optional) device name, i.e. MOTOR1 CLEAR_VARS_CMD (optional) Set to “empty” for not clear env vars (if vars needed for later use). CFG_MACROS (optional) Substitution macros for config file Example call: -${SCRIPTEXEC} ${ecmccfg_DIR}configureAxis.cmd, "CONFIG=./cfg/linear_1.pax"configureSlave.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/configureslave/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/configureslave/description Script for adding a slave with dedicated slave configuration to the EtherCAT bus configuration. +${SCRIPTEXEC} ${ecmccfg_DIR}configureAxis.cmd, "CONFIG=./cfg/linear_1.pax"configureSlave.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/configureslave/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/configureslave/description Script for adding a slave with dedicated slave configuration to the EtherCAT bus configuration. details Adds the respective hardware to the bus configuration, adds specific and default PV to the EPICS database. Applies a specific slave configuration. author Niko Kivel paramters HW_DESC Hardware descriptor, i.e. EL7037 CONFIG configuration file, i.e. -Motor-Nanotec-ST4118L1804-B -The CONFIG together with the HW_DESC form the full filename which by definition is ecmc${HW_DESC}${CONFIG}.cmd, i.e.: ecmcEL7037-Motor-Nanotec-ST4118L1804-B.configureVirtualAxis.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/configurevirtualaxis/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/configurevirtualaxis/description Script for adding a virtual axis with configuration. +The CONFIG together with the HW_DESC form the full filename which by definition is ecmc${HW_DESC}${CONFIG}.cmd, i.e.: ecmcEL7037-Motor-Nanotec-ST4118L1804-B.configureVirtualAxis.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/configurevirtualaxis/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/configurevirtualaxis/description Script for adding a virtual axis with configuration. details Adds a virtual axis to the configuration and applies parameters provided by CONFIG. author Niko Kivel paramters CONFIG configuration file, i.e. ./cfg/linear_11.vax DEV (optional) device name, i.e. GAP CLEAR_VARS_CMD (optional) Set to “empty” for not clear env vars (if needed vars for later use). Example call: -${SCRIPTEXEC} ${ecmccfg_DIR}configureVirtualAxis.cmd, "CONFIG=./cfg/linear_11.vax"ecmc_axis-records.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_axis-records/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_axis-records/description Script for adding axis related EPICS PVs. +${SCRIPTEXEC} ${ecmccfg_DIR}configureVirtualAxis.cmd, "CONFIG=./cfg/linear_11.vax"ecmc_axis-records.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_axis-records/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_axis-records/description Script for adding axis related EPICS PVs. details Adds motorRecord to the IOC. author Anders Sandstroem -This script is typically called by \b addAxis.cmdecmc_axis.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_axis/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_axis/description Script for configuring a physical axis. +This script is typically called by \b addAxis.cmdecmc_axis.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_axis/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_axis/description Script for configuring a physical axis. details Configures a physical axis in ECMC, based on previously set environment variables. author Anders Sandstroem -This script is typically called by \b addAxis.cmd, often via \b ecmc_axis-records.cmdecmc_axis_diag.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_axis_diag/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_axis_diag/description Script for adding axis diagnostic EPICS PVs. +This script is typically called by \b addAxis.cmd, often via \b ecmc_axis-records.cmdecmc_axis_diag.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_axis_diag/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_axis_diag/description Script for adding axis diagnostic EPICS PVs. details Adds diagnostic PVs to the IOC. -author Anders Sandstroemecmc_axis_mr.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_axis_mr/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_axis_mr/description Script for loading motor record related databases +author Anders Sandstroemecmc_axis_mr.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_axis_mr/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_axis_mr/description Script for loading motor record related databases details Script for loading motor record related databases and creating motor record axis object author Anders Sandstroem -This script is typically called by \b ecmc_axis.cmd, often via \b ecmc_axis-records.cmdecmc_axis_sync.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_axis_sync/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_axis_sync/description Script for configuring axis synchronization +This script is typically called by \b ecmc_axis.cmd, often via \b ecmc_axis-records.cmdecmc_axis_sync.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_axis_sync/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_axis_sync/description Script for configuring axis synchronization details Configures ECMC for axis synchronization, based on previously set environment variables. author Anders Sandstroem -This script is typically called by \b applyAxisSynchronization.cmdecmc_enc-records.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_enc-records/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_enc-records/description Script for adding encoder related EPICS PVs. +This script is typically called by \b applyAxisSynchronization.cmdecmc_enc-records.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_enc-records/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_enc-records/description Script for adding encoder related EPICS PVs. details Script for adding an encoder to a previously created axis. author Anders Sandstroem -This script is typically called by \b addAxis.cmdecmc_enc.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_enc/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_enc/description Script for adding an extra encoder +This script is typically called by \b addAxis.cmdecmc_enc.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_enc/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_enc/description Script for adding an extra encoder details Configures a encoder object in ECMC, based on previously set environment variables. author Anders Sandstroem -This script is typically called by \b addEncoder.cmdecmc_virt_axis-records.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_virt_axis-records/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_virt_axis-records/description Script for adding axis related EPICS PVs. +This script is typically called by \b addEncoder.cmdecmc_virt_axis-records.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_virt_axis-records/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_virt_axis-records/description Script for adding axis related EPICS PVs. details Adds motorRecord to the IOC. author Anders Sandstroem -This script is typically called by \b addVirtualAxis.cmdecmc_virt_axis.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_virt_axis/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_virt_axis/description Script for configuring a virtual axis. +This script is typically called by \b addVirtualAxis.cmdecmc_virt_axis.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_virt_axis/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/motion/ecmc_virt_axis/description Script for configuring a virtual axis. details Configures a virtual axis in ECMC, based on previously set environment variables. author Anders Sandstroem -This script is typically called by \b addVirtualAxis.cmd, often via \b ecmc_virt_axis-records.cmdecmcClassicNaming.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/naming/ecmcclassicnaming/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/naming/ecmcclassicnaming/description Script for defining ${ECMC_PREFIX} +This script is typically called by \b addVirtualAxis.cmd, often via \b ecmc_virt_axis-records.cmdecmcClassicNaming.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/naming/ecmcclassicnaming/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/naming/ecmcclassicnaming/description Script for defining ${ECMC_PREFIX} details Gathers relevant information about MasterID, SlaveID, … to create naming convention compliant PREFIX -author Niko KivelecmcESSnaming.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/naming/ecmcessnaming/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/naming/ecmcessnaming/description Script for defining ${ECMC_P} +author Niko KivelecmcESSnaming.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/naming/ecmcessnaming/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/naming/ecmcessnaming/description Script for defining ${ECMC_P} details Gathers relevant information about MasterID, SlaveID, … to create naming convention compliant PREFIX -author Niko KivelecmcmXsXXX.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/naming/ecmcmxsxxx/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/naming/ecmcmxsxxx/description Script for defining ${ECMC_P} +author Niko KivelecmcmXsXXX.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/naming/ecmcmxsxxx/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/naming/ecmcmxsxxx/description Script for defining ${ECMC_P} details Gathers relevant information about MasterID, SlaveID, … to create naming convention compliant PREFIX -author Niko Kivelfinalize.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/finalize/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/finalize/description Script for finalizing. Executed just before iocInit (atInit) +author Niko Kivelfinalize.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/finalize/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/finalize/description Script for finalizing. Executed just before iocInit (atInit) details Script for finalizing. Executed just before iocInit (atInit). -author Anders Sandströmgeneral.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/general/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/general/description Add general PVs +author Anders Sandströmgeneral.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/general/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/general/description Add general PVs details Script for adding general and master diagnostics EPICS PVs -author Niko Kivel, Anders SandstroemgeneralDiagnostics.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/generaldiagnostics/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/generaldiagnostics/description Script for general diagnostics +author Niko Kivel, Anders SandstroemgeneralDiagnostics.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/generaldiagnostics/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/generaldiagnostics/description Script for general diagnostics details Script for setting default diagnostics -author Niko Kivel, Anders Sandstroeminit.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/init/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/init/description Initialization script +author Niko Kivel, Anders Sandstroeminit.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/init/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/init/description Initialization script details Script for setting up the basic EPICS environment. -author Niko Kivel, Anders SandstroeminitAll.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/initall/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/initall/description Init main script +author Niko Kivel, Anders SandstroeminitAll.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/initall/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/initall/description Init main script details Script for setting up the basic EPICS environment. -author Niko Kivel, Anders SandstroeminitAxis.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/initaxis/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/initaxis/description init axis environment +author Niko Kivel, Anders SandstroeminitAxis.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/initaxis/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/initaxis/description init axis environment details Script for setting up the basic AXIS environment. -author Niko Kivel, Anders SandstroemissueWarning.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/issuewarning/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/issuewarning/description Issue a warning +author Niko Kivel, Anders SandstroemissueWarning.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/issuewarning/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/issuewarning/description Issue a warning details Generic verification script for expressions -author Anders SandstroemloadAxisPLCFile.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadaxisplcfile/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadaxisplcfile/description Script for adding a PLC from file. +author Anders SandstroemloadAxisPLCFile.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadaxisplcfile/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadaxisplcfile/description Script for adding a PLC from file. details Adds a PLC defined in FILE. Also adds PLC specific EPICS PVs, i.e. for enable/disable. author Niko Kivel paramters FILE PLC definition file, i.e. ./plc/homeSlit.plc AX_ID (optional) Ax number, default 0 PLC_MACROS (optional) Substitution macros for PLC code TMP_PATH (optional) directory to dump the temporary plc file after macro substitution -PRINT_PLC_FILE (optional) 1/0, printout msi parsed plc file (default enable(1)).loadPLCFile.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadplcfile/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadplcfile/description Script for adding a PLC from file. +PRINT_PLC_FILE (optional) 1/0, printout msi parsed plc file (default enable(1)).loadPLCFile.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadplcfile/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadplcfile/description Script for adding a PLC from file. details Adds a PLC defined in FILE. Also adds PLC specific EPICS PVs, i.e. for enable/disable. author Niko Kivel, Anders Sandström paramters FILE PLC definition file, i.e. ./plc/homeSlit.plc PLC_ID (optional) PLC number, default 0, or to next free PLC, the actual PLC Id is stored in ECMC_PLC_ID and can be used after this command SAMPLE_RATE_MS (optional) excecution rate, default 1000/EC_RATE -PLC_MACROS (optional) Substitution macros for PLC code.loadPLCLib.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadplclib/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadplclib/description Script for loading a PLC from lib from file. +PLC_MACROS (optional) Substitution macros for PLC code.loadPLCLib.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadplclib/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadplclib/description Script for loading a PLC from lib from file. details Adds a PLC defined in FILE. Also adds PLC specific EPICS PVs, i.e. for enable/disable. author Anders Sandström paramters FILE PLC definition file, i.e. ./plc/homeSlit.plc PLC_ID (optional) PLC number, default last loaded PLC PLC_MACROS (optional) Substitution macros for PLC code. The macros “SELF_ID”,“SELF”,M_ID, and M are reserved: -INC (optional) List of directories for include files to pass to MSI (if several paths thendivide with ‘:').loadPlugin.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadplugin/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadplugin/description Script for loading a ecmc plugin from file. +INC (optional) List of directories for include files to pass to MSI (if several paths thendivide with ‘:').loadPlugin.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadplugin/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadplugin/description Script for loading a ecmc plugin from file. details Loads a ecmc-plugin from file. author Anders Sandström paramters FILE Filename of plugin shared lib (./ecmcPlugin_Advanced.so) @@ -183,44 +183,44 @@ PLUGIN_ID Id of plugin to load CONFIG (optional) Configuration string sent to plugin at construct REPORT (optional) Printout information of loaded plugin if set to “1” Example call: -${SCRIPTEXEC} ${ecmccfg_DIR}loadPlugin.cmd, "PLUGIN_ID=0,FILE=./ecmcPlugin_Advanced.so,CONFIG='PLUGIN CONFIGS GO HERE 'loadSubstAxes.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadsubstaxes/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadsubstaxes/description Script for adding multiple axes based on subst and template file +${SCRIPTEXEC} ${ecmccfg_DIR}loadPlugin.cmd, "PLUGIN_ID=0,FILE=./ecmcPlugin_Advanced.so,CONFIG='PLUGIN CONFIGS GO HERE 'loadSubstAxes.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadsubstaxes/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadsubstaxes/description Script for adding multiple axes based on subst and template file details Configure multiple axes by using subst file author Anders Sandström -${SCRIPTEXEC} ${ecmccfg_DIR}loadSubstAxes.cmd, "FILE=./ax.subs"loadSubstConfig.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadsubstconfig/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadsubstconfig/description Script for loading complete ecmc cfg based on subst files and templates +${SCRIPTEXEC} ${ecmccfg_DIR}loadSubstAxes.cmd, "FILE=./ax.subs"loadSubstConfig.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadsubstconfig/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadsubstconfig/description Script for loading complete ecmc cfg based on subst files and templates details Loads complete ecmc cfg based on subst files and templates author Anders Sandström -${SCRIPTEXEC} ${ecmccfg_DIR}loadSubstConfig.cmd, "FILE=./cfg.subs"loadSubstHw.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadsubsthw/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadsubsthw/description Script for adding multiple hw based on subst and template file +${SCRIPTEXEC} ${ecmccfg_DIR}loadSubstConfig.cmd, "FILE=./cfg.subs"loadSubstHw.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadsubsthw/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/loadsubsthw/description Script for adding multiple hw based on subst and template file details Loads hw cfg based on subst files and templates author Anders Sandström -${SCRIPTEXEC} ${ecmccfg_DIR}loadSubstHw.cmd, "FILE=./hw.subs"loadYamlAxis.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/jinja2/loadyamlaxis/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/jinja2/loadyamlaxis/description Script for loading Axis from yaml file via jinja2 +${SCRIPTEXEC} ${ecmccfg_DIR}loadSubstHw.cmd, "FILE=./hw.subs"loadYamlAxis.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/jinja2/loadyamlaxis/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/jinja2/loadyamlaxis/description Script for loading Axis from yaml file via jinja2 details adds an Axis, based on a yaml config file author Niko Kivel, Anders Sandström paramters FILE the yaml-file containing the PLC definition DEV the device name (optional, defaults to ${IOC} Example calls: -call ${SCRIPTEXEC} "./loadYamlAxis.cmd" "FILE=./axis1.yaml" ${SCRIPTEXEC} "./loadYamlAxis.cmd" "FILE=./axis1.yaml, DEV=foobar"loadYamlEnc.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/jinja2/loadyamlenc/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/jinja2/loadyamlenc/description Script for adding Encoder from yaml file via jinja2 +call ${SCRIPTEXEC} "./loadYamlAxis.cmd" "FILE=./axis1.yaml" ${SCRIPTEXEC} "./loadYamlAxis.cmd" "FILE=./axis1.yaml, DEV=foobar"loadYamlEnc.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/jinja2/loadyamlenc/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/jinja2/loadyamlenc/description Script for adding Encoder from yaml file via jinja2 details adds an encoder to an axis, based on a yaml config file author Anders Sandström paramters FILE the yaml-file containing the PLC definition DEV the device name (optional, defaults to ${IOC} Example calls: -call ${SCRIPTEXEC} "./loadYamlEnc.cmd" "FILE=./enc.yaml" ${SCRIPTEXEC} "./loadYamlEnc.cmd" "FILE=./enc.yaml, DEV=foobar"loadYamlPlc.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/jinja2/loadyamlplc/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/jinja2/loadyamlplc/description Script for loading PLC from yaml file via jinja2 +call ${SCRIPTEXEC} "./loadYamlEnc.cmd" "FILE=./enc.yaml" ${SCRIPTEXEC} "./loadYamlEnc.cmd" "FILE=./enc.yaml, DEV=foobar"loadYamlPlc.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/jinja2/loadyamlplc/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/jinja2/loadyamlplc/description Script for loading PLC from yaml file via jinja2 details adds a PLC, line by line, from a yaml-file, parsed by jinja2 author Niko Kivel, Anders Sandström paramters FILE the yaml-file containing the PLC definition Example calls: -call ${SCRIPTEXEC} "./loadYamlPlc.cmd" "FILE=./plc1.yaml"restoreRecordUpdateRate.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/restorerecordupdaterate/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/restorerecordupdaterate/description Restores record update rate to what was defined in startup.cmd +call ${SCRIPTEXEC} "./loadYamlPlc.cmd" "FILE=./plc1.yaml"restoreRecordUpdateRate.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/restorerecordupdaterate/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/restorerecordupdaterate/description Restores record update rate to what was defined in startup.cmd details Restores record update rate to what was defined in startup.cmd -author Anders SandströmsetAppMode.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/setappmode/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/setappmode/description Script for switching to operational mode. +author Anders SandströmsetAppMode.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/setappmode/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/setappmode/description Script for switching to operational mode. details Validates configuration, starts realtime thread and checks EtherCAT slaves are in OP. -author Niko KivelsetDiagnostics.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/setdiagnostics/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/setdiagnostics/description Script for enabling default diagnostics. +author Niko KivelsetDiagnostics.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/setdiagnostics/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/setdiagnostics/description Script for enabling default diagnostics. details Set some default values to diagostics -author Niko KivelsetRecordUpdateRate.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/setrecordupdaterate/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/setrecordupdaterate/description Script for changing record update rate +author Niko KivelsetRecordUpdateRate.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/setrecordupdaterate/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/setrecordupdaterate/description Script for changing record update rate details Update record processing rate, all records created after this command will be updated in the specified rate. -author Anders SandströmslaveVerify.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/slaveverify/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/slaveverify/description ** script for slave verification and optional reset** +author Anders SandströmslaveVerify.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/scripts/slaveverify/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/scripts/slaveverify/description ** script for slave verification and optional reset** details will verify the slave identity and reset by writing to 0x1011, optionally read firmwre version from 0x100a author Niko Kivel -MacrosverifyOrDie.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/verifyordie/Fri, 27 Sep 2024 12:53:13 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/verifyordie/description Generic verification script +MacrosverifyOrDie.cmdhttps://paulscherrerinstitute.github.io/ecmccfg/source/general/verifyordie/Fri, 27 Sep 2024 12:56:41 +0000https://paulscherrerinstitute.github.io/ecmccfg/source/general/verifyordie/description Generic verification script details Generic verification script for expressions author Anders Sandstroemintroductionhttps://paulscherrerinstitute.github.io/ecmccfg/manual/introduction/Mon, 01 Jan 0001 00:00:00 +0000https://paulscherrerinstitute.github.io/ecmccfg/manual/introduction/Principle EtherCAT requires the field bus components (slaves) to be configured on the master. The master must know about the data exchanges with the slaves, this is referred to as process image. During IOC-startup, the requested configuration is validated against the actually present hardware on the bus. Mismatches will result in an error, the IOC will not start. diff --git a/manual/build/index.html b/manual/build/index.html index 6e6a0a8e5..43ee85f4f 100644 --- a/manual/build/index.html +++ b/manual/build/index.html @@ -1,6 +1,6 @@ -build at PSI :: ecmccfg

    check a particular version

    check the module loads for version dev, Epics R7+ and ECMC version dev, note MASTER_ID=-1 which runs ECMC in master-less mode. Make proper adjustments to match your needs in terms of versions.

    iocsh -7 -r "ecmccfg,dev 'ECMC_VER=dev,MASTER_ID=-1'"
    \ No newline at end of file +
    \ No newline at end of file diff --git a/manual/general_cfg/best_practice/index.html b/manual/general_cfg/best_practice/index.html index 0ede7b468..791d0644b 100644 --- a/manual/general_cfg/best_practice/index.html +++ b/manual/general_cfg/best_practice/index.html @@ -1,6 +1,6 @@ -best practice :: ecmccfg