= softIoc コマンドで簡単に ioc データベースをテストする =

(KEKB佐々木さんからネタ提供。それにいくつかデータベース例を加えてwikiに掲載）

簡単にレコードのテストをしたいときに便利。
seqencerを使う場合は makeBaseApp して application を作る必用があるが、
データベースの単体テストであれば "softIoc" コマンドがお手軽で便利。
dbLoadTemplateなどの検証にも使用可能。


== 使用例１ ==
dbファイルを用意する。例えば、単にカウントアップするレコードとして
{{{
record(calc,"test:count") {
    field(SCAN, ".1 second")
    field(INPA, "test:count.VAL")
    field(CALC, "A+1")
}
}}}
こんなファイルを作成して test.db として保存する。

単純に使うならば、-dオプションでdbファイルを指定して実行するのみ。
{{{
$ softIoc -d test.db
Starting iocInit
############################################################################
## EPICS R3.15.5
## EPICS Base built Jan 24 2018
############################################################################
iocRun: All initialization complete
epics> dbl
test:count
epics>
epics> dbpr test:count
A: 44               ASG:                B: 0                C: 0
CALC: A+1           D: 0                DESC:               DISA: 0
DISP: 0             DISV: 1             E: 0                F: 0
G: 0                H: 0                I: 0                J: 0
K: 0                L: 0                NAME: test:count    SEVR: NO_ALARM
STAT: NO_ALARM      TPRO: 0             VAL: 45
epics>
}}}

別の端末を開いて camonitor で確認
{{{
$ camonitor test:count
test:count                     2018-03-31 13:38:04.648396 82
test:count                     2018-03-31 13:38:05.649164 83
test:count                     2018-03-31 13:38:06.648305 84
test:count                     2018-03-31 13:38:07.648437 85
}}}
ちゃんと１秒ごとにカウントアップしている。


== コマンドのインストール場所、オプション ==
softIoc コマンドは、caget, caput などと同じフォルダにインストールされているので、確認。
{{{
$ which caget
/opt/epics/R315.5/base/bin/linux-x86_64/caget
$ which softIoc
/opt/epics/R315.5/base/bin/linux-x86_64/softIoc
}}}

オプション類は -h で確認。
{{{
$ softIoc -h
Usage: softIoc [-D softIoc.dbd] [-h] [-S] [-a ascf]
        [-m macro=value,macro2=value2] [-d file.db]
        [-x prefix] [st.cmd]
Compiled-in path to softIoc.dbd is:
        /opt/epics/R315.5/base/dbd/softIoc.dbd
}}}


== 使用例２ ==
FLNK の使い方の例：count レコードのスキャン時間を 0.1 sec にして、sin とつなげる
{{{
record(calc,"test:count") {
    field(SCAN, ".1 second")
    field(INPA, "test:count.VAL")
    field(CALC, "A+1")
    field(FLNK, "test:sin1")
}
record(calc, "test:sin1") {
    field(SCAN, "Passive")
    field(INPA, "test:count.VAL")
    field(CALC, "sin(A/10.0)")
}
}}}
このようなレコードを作っておくと、磁石をsinで振ったり、あるいは単にGUIやプログラム（スクリプト）のテストを
したいときなどに便利です。
当然ですがハードリアルタイムOSでない場合は確実に動く保証はありませんし、"確実に動く" and/or "きれいな"sin波形を作りたいならば
ハードウェアベースで別途検討する必要があります.....が、実際のところこの程度でもテストには十分な場合が多いです。
例えばマグネット電源に出力する場合は calcOut レコードに変更すればより簡単に記述できるでしょう。


== 使用例３ ==
独自のdbdファイルを使いたいときには、-D オプションでdbdファイルを指定する。例えば SCAN 20 sec を作りたい場合を例とすると、
/opt/epics/R315.5/base/dbd/softIoc.dbdをコピーしてきて、menuScanを下のように編集して、custom.dbd として保存。
{{{
menu(menuScan) {
    choice(menuScanPassive, "Passive")
    choice(menuScanEvent, "Event")
    choice(menuScanI_O_Intr, "I/O Intr")
    choice(menuScan20_second, "20 second")  <------- これを追加する
    choice(menuScan10_second, "10 second")
    choice(menuScan5_second, "5 second")
    choice(menuScan2_second, "2 second")
    choice(menuScan1_second, "1 second")
    choice(menuScan_5_second, ".5 second")
    choice(menuScan_2_second, ".2 second")
    choice(menuScan_1_second, ".1 second")
}
}}}

softIoc実行
{{{
$ softIoc -D custom.dbd -d test1.db
Starting iocInit
############################################################################
## EPICS R3.15.5
## EPICS Base built Jan 24 2018
############################################################################
iocRun: All initialization complete
epics> dbl
test:count
epics> dbpr test:count, 4
A: 1                ACKS: NO_ALARM      ACKT: YES           ADEL: 0
....
RPRO: 0             RSET: 0x7f333a9f2820                    SCAN: 20 second
....
}}}
確認
{{{
$ camonitor test:count
test:count                     2018-03-31 13:58:08.453467 1
test:count                     2018-03-31 13:58:28.454018 2
test:count                     2018-03-31 13:58:48.454025 3
test:count                     2018-03-31 13:59:08.453544 4
}}}