#acl EditorsGroup:read,write,delete,revert All:read
#language en
= Interlock Systems Software =
== i4chanparam - change parameters of hardware input channels ==
The i4chanparam tool is used to configure the paramter of the hardware input channels of the interlock system. Depending on the hardware channel, different parameter can be applied to the channel, f.ex.:

 * Signal Mask (if MASKED, input signal is ignored by interlock logic)
 * Filter Time
 * Analog Thresholds
 * and more...

To get a full description of all possible options run "i4chanparam -h".

{{{
Allowed options:
  -h [ --help ]
  -s [ --slot_channel ] arg n.n (slot.channel)
  -d [ --direction ] arg    r|w (read or write settings)
  -f [ --filter ] arg       [nnn][us|ms]
  --aux                     show aux channels
  --statuslatch arg         [true|false]
  -m [ --mask ] arg         [true|false]
  -l [ --min ] arg          [nnn.n][V|mA|^C|dBm]
  -u [ --max ] arg          [nnn.n][V|mA|^C]
  --dac arg                 [nnn.n][V]
  --daq arg                 [true or false]
  --testsignal arg          [true or false]
  -w [ --wait-cycles ] arg  nnn[us] (FADC & Powermeter Only)
  -t [ --adcTrigger ] arg   nnn[us] (FADC & Powermeter Only)
  -c [ --sample-count ] arg nnn  (FADC & Powermeter Only)
  -p [ --peakmode ] arg     nnn  peak mode
  --debug                   enable debug information
  --signallist              shows the signallist
}}}
=== Example - Display all channels of the module at slot 4 ===
'''i4chanparam -s 4'''

{{{
{Thread: 0 - unknown }
[DEBUG  .../hardware/Interlock.cpp:99]  Opening Device
Signal loaded from signallist:88
Module Information
------------------
  Slot    : 4
  Revision: 0xd30f
  Class   : AI
  Subclass: 0x0
  Input Status : 0x0
  Input Masks  : 0x0
  Output Status: 0x0
  mclock_sel   :   NONE

Channels List
-------------
|  AMax|  AMin|    AVal| Filt.|   HPeak|  ID| LPeak| Mask|        Name|   Sts| slot
+------+------+--------+------+--------+----+------+-----+------------+------+-----
| 0.00A| 0.00A| 40.50uA| 0.00s| 41.44uA| I00|    75|  OFF| {undefined}| ERROR|    4
| 0.00A| 0.00A| 36.73uA| 0.00s| 40.50uA| I01|    69|  OFF| {undefined}| ERROR|    4
| 0.00A| 0.00A| 36.73uA| 0.00s| 37.21uA| I02|    72|  OFF| {undefined}| ERROR|    4
| 0.00A| 0.00A| 36.73uA| 0.00s| 41.91uA| I03|    77|  OFF| {undefined}| ERROR|    4
| 0.00A| 0.00A| 55.10uA| 0.00s| 57.93uA| I04|    97|  OFF| {undefined}| ERROR|    4
| 0.00A| 0.00A| 53.69uA| 0.00s| 56.51uA| I05|    96|  OFF| {undefined}| ERROR|    4
| 0.00A| 0.00A| 50.39uA| 0.00s| 56.51uA| I06|   104|  OFF| {undefined}| ERROR|    4
| 0.00A| 0.00A| 50.39uA| 0.00s| 55.10uA| I07|    96|  OFF| {undefined}| ERROR|    4
| 0.00V| 0.00V| 29.14mV| 0.00s| 30.21mV| I08|   180|  OFF| {undefined}| ERROR|    4
| 0.00V| 0.00V| 25.79mV| 0.00s| 26.86mV| I09|   157|  OFF| {undefined}| ERROR|    4
| 0.00V| 0.00V| 33.42mV| 0.00s| 34.03mV| I10|   210|  OFF| {undefined}| ERROR|    4
| 0.00V| 0.00V| 29.91mV| 0.00s| 31.59mV| I11|   189|  OFF| {undefined}| ERROR|    4
| 0.00V| 0.00V| 28.84mV| 0.00s| 30.98mV| I12|   184|  OFF| {undefined}| ERROR|    4
| 0.00V| 0.00V| 26.09mV| 0.00s| 27.47mV| I13|   159|  OFF| {undefined}| ERROR|    4
| 0.00V| 0.00V| 32.81mV| 0.00s| 34.03mV| I14|   203|  OFF| {undefined}| ERROR|    4
| 0.00V| 0.00V| 33.11mV| 0.00s| 34.33mV| I15|   206|  OFF| {undefined}| ERROR|    4
}}}
=== Example - change min and max thresholds of a channel ===
'''i4chanparam -s 4.02 -l 5mA -u 14mA'''

{{{
{Thread: 0 - unknown }
[DEBUG  .../hardware/Interlock.cpp:99]  Opening Device
Signal loaded from signallist:88
[i4chanparam] 2012-Nov-29 08:05:07 INFO : Set feature 2 to 0.002 (before: 0.00A) at channel 'Interlock Input Channel #2' at module at slot '4'
[i4chanparam] 2012-Nov-29 08:05:07 INFO : Set feature 3 to 0.002 (before: 0.00A) at channel 'Interlock Input Channel #2' at module at slot '4'
}}}
=== Example - change mask of a channel ===
'''i4chanparam -s 4.02 -m true'''

{{{
{Thread: 0 - unknown }
[DEBUG  .../hardware/Interlock.cpp:99]  Opening Device
Signal loaded from signallist:88
mask: TRUE --> [1]
[i4chanparam] 2012-Nov-29 08:05:59 INFO : Set 'mask' = MASKED (before: NOT MASKED) at channel 'Interlock Input Channel #2' at module at slot '4'
}}}
== i4cfg - store and load interlock configuration ==
The i4cfg program is used to store or load all parameters from/to a file and write/read them into the hardware for each input channel. When no file is specified, the parameters are load/stored to the default configuration file '''intlkparameter.xml''' in the system configuration folder '''$INTLK_CONFIG'''. Each time the system is rebooted, the default configuration file is loaded and used to configure the hardware.

To get a full description of all possible options run "i4cfg -h".

{{{
***** intlk4 load/store signal parameter Jul 11 2014 09:41:51
Note: The default config filename can be preset in config.ini with i4cfg.configfile
Allowed options:
  -h [ --help ]
  -f [ --file ] arg (=intlkparameter.xml)
                                        configuration file to work on
  -s [ --store ]                        store the channel parameter to config
                                        file
  -l [ --load ]                         load the channel parameter from
                                        configuration file
}}}
=== Example - store all settings to the default file ===
'''i4cfg -s'''

{{{
[i4cfg] 2012-Nov-29 08:09:00 INFO : storing parameter in intlkparameter.xml
[writeConfigFile] 2012-Nov-29 08:09:00 INFO : 104 channels stored in 'intlkparameter.xml'
}}}
== i4tui - textual user interface to monitor and manipulate signal parameter ==
The i4tui (textual user interface) can be used to change single parameters of the hardware signals and see their current values.

{{attachment:i4tui-screenshoot.jpg}}