epics examples

1# @Language: Markdown
2# @Software: VS Code/MacDown/Typora/Vim
3# @Author  : Di Wang
4# @Email   : [email protected]

1<IOC app name>_DBD += caPutLog.dbd  # For standard format
2<IOC app name>_DBD += caPutJsonLog.dbd  # For JSON format (Exists only if module is compiled with supported version of base)
3<IOC app name>_LIBS += caPutLog  # Required for both output formats

 1caPutLogInit "host[:port]" [config]
 2caPutJsonLogInit "host[:port]" [config]
 3# for example
 4caPutLogInit "localhost:7011" 0
 5caPutJsonLogInit $(CAPUTLOG_INET):$(CAPUTLOG_INET_PORT=8002) $(CAPUTLOG_OPTION=0)
 6
 7# 重新加载配置
 8caPutLogReconf config
 9caPutJsonLogReconf config
10
11# info
12caPutLogShow level
13caPutJsonLogShow level
14
15# 修改日期格式
16caPutLogSetTimeFmt "<date_time_format>"
17
18# log to a PV
19epicsEnvSet(EPICS_AS_PUT_LOG_PV, "pv.VAL$")
20epicsEnvSet(EPICS_AS_PUT_JSON_LOG_PV, "pv.VAL$")
21
22# debug
23var caPutLogDebug,1

 1INSTALL_BIN=/home/sdcswd/epics/R7.0.8/base/bin/linux-x86_64
 2
 3# To change the default values for the EPICS Environment parameters,
 4# uncomment and modify the relevant lines below.
 5
 6# EPICS_IOC_LOG_PORT="6500" export EPICS_IOC_LOG_PORT
 7EPICS_IOC_LOG_FILE_NAME="ioclog.log" export EPICS_IOC_LOG_FILE_NAME
 8# EPICS_IOC_LOG_FILE_LIMIT="1000000" export EPICS_IOC_LOG_FILE_LIMIT
 9
10if [ $1 = "start" ]; then
11    if [ -x $INSTALL_BIN/iocLogServer ]; then
12        echo "Starting EPICS Log Server "
13        $INSTALL_BIN/iocLogServer &
14    fi
15else
16    if [ $1 = "stop" ]; then
17        pid=`ps -e | sed -ne '/iocLogSe/s/^ *\([1-9][0-9]*\).*$/\1/p'`
18        if [ "${pid}" != "" ]; then
19            echo "Stopping EPICS Log Server "
20            kill ${pid}
21        fi
22    fi
23fi

 1dbLoadTemplate("db/user.substitutions")
 2
 3epicsEnvSet(EPICS_IOC_LOG_INET, "localhost")
 4#epicsEnvSet(EPICS_IOC_LOG_PORT, "$(LOG_INET_PORT)")
 5epicsEnvSet(iocLogDisable, "$(LOGDISABLE=0)")
 6
 7asSetFilename("access.acf")
 8iocLogPrefix("${IOC} ")
 9
10cd "${TOP}/iocBoot/${IOC}"
11iocInit
12
13caPutLogInit "localhost:7004" 0
14iocLogInit()

1localhost:55142 Sun May 12 15:26:47 2024 iocexample iocPause: IOC suspended
2localhost:55142 Sun May 12 15:26:47 2024 iocexample iocRun: IOC restarted
3localhost:55128 Sun May 12 15:26:57 2024 iocexample 12-May-24 15:26:51 zephyrus sdcswd sdcswd:circle:step new=2 old=1
4localhost:55128 Sun May 12 15:27:02 2024 iocexample 12-May-24 15:26:57 zephyrus sdcswd sdcswd:circle:step new=1 old=2

1test_DBD += reccaster.dbd
2test_LIBS += reccaster

 1var(reccastTimeout, 5.0)
 2var(reccastMaxHoldoff, 5.0)
 3epicsEnvSet("CONTACT", "mycontact")
 4epicsEnvSet("BUILDING", "mybuilding")
 5epicsEnvSet("SECTOR", "mysector")
 6
 7addReccasterEnvVars("CONTACT", "SECTOR")
 8addReccasterEnvVars("BUILDING")
 9
10iocInit

 1$ cd recsync/server
 2$ python3 -m venv venv
 3$ source venv/bin/activate
 4$ pip3 install --upgrade pip
 5$ pip3 install requests
 6$ pip3 install .
 7$ pip3 list
 8Package            Version
 9------------------ --------
10attrs              23.2.0
11Automat            22.10.0
12certifi            2024.2.2
13channelfinder      3.0.0
14charset-normalizer 3.3.2
15constantly         23.10.4
16hyperlink          21.0.0
17idna               3.7
18incremental        22.10.0
19pip                24.0
20recceiver          1.5
21requests           2.31.0
22setuptools         66.1.1
23simplejson         3.19.2
24six                1.16.0
25Twisted            24.3.0
26typing_extensions  4.11.0
27urllib3            2.2.1
28zope.interface     6.3
29# 或者直接指定PYTHONPATH
30$ export PYTHONPATH=${PWD}:${PWD}/build/lib:${channelfinder_path}
31$ twistd -r poll -n recceiver -f demo.conf

 1$ caput -S long_string.INP$  SomeReallyLongRecordNameThatExceeds40Characters
 2Old : long_string.INP$ SomeReallyLongRecordNameThatExceeds40Ch NPP NMS
 3New : long_string.INP$ SomeReallyLongRecordNameThatExceeds40Characters NPP NMS
 4
 5$ caput -S long_string.INP  SomeReallyLongRecordNameThatExceeds40Characters
 6Old : long_string.INP                SomeReallyLongRecordNameThatExceeds40Ch
 7Error from put operation: Invalid element count requested
 8
 9$ caget -S long_string.INP$
10long_string.INP$ SomeReallyLongRecordNameThatExceeds40Characters NPP NMS
11
12$ caget -S long_string.INP
13long_string.INP                SomeReallyLongRecordNameThatExceeds40Ch

 1$ cat st.cmd
 2# print this comment
 3#- not print this comment
 4dbLoadRecords a.db
 5
 6$ softIocPVA st.cmd
 7# print this comment
 8dbLoadRecords a.db
 9iocInit
10Starting iocInit
11############################################################################
12## EPICS R7.0.8
13## Rev. 2024-03-27T10:23+0100
14## Rev. Date build date/time:
15############################################################################
16iocRun: All initialization complete
17epics>
18iocInit

 1// base中的一些macro
 2#define generalTimeCurrentTpName generalTimeCurrentProviderName
 3#define generalTimeEventTpName generalTimeEventProviderName
 4
 5#define epicsTimeEventCurrentTime 0
 6#define epicsTimeEventBestTime -1
 7#define epicsTimeEventDeviceTime -2
 8
 9int epicsShareAPI epicsTimeGetEvent(epicsTimeStamp *pDest, int eventNumber)
10{
11    if (eventNumber == epicsTimeEventCurrentTime) {
12        // TSE为0的情况
13        return epicsTimeGetCurrent(pDest);
14    } else {
15        // TSE为-1或[1-255]的情况
16        return generalTimeGetEventPriority(pDest, eventNumber, NULL);
17    }
18}
19
20// mrfioc2 处理longout record中TSE=-2的情况
21static long process_longout(longoutRecord *prec)
22{
23    priv *p=static_cast<priv*>(prec->dpvt);
24    long ret=0;
25
26    if (prec->val>=0 && prec->val<=255)
27        post_event(prec->val);
28
29    if(prec->tse==epicsTimeEventDeviceTime){
30        p->evr->getTimeStamp(&prec->time,p->event);
31    }
32}

 1record(ai, ai){
 2  field(DISV, "1")
 3  field(DISS, "MAJOR")
 4  field(VAL,  "311")
 5  field(SDIS, "bi PP")
 6}
 7
 8record(bi, bi){
 9  field(INP, "1")
10  field(PINI, "YES")
11}

 1           --  (SIMM = NO?)
 2         /         (if supported and directed by device support,
 3        /              INP -> RVAL -- convert -> VAL),
 4                   (else INP -> VAL)
 5 SIML -> SIMM
 6
 7         \
 8           --  (SIMM = YES?) SIOL -> SVAL -> VAL
 9           \
10             -- (SIMM = RAW?) SIOL -> SVAL -> RVAL -- convert -> VAL

 1record(ai, ai){
 2  field(VAL,  "13")
 3  field(HOPR, "0")
 4  field(LOPR, "100")
 5  field(PREC, "3")
 6  field(HIHI, "90")
 7  field(HIGH, "80")
 8  field(LOW,  "20")
 9  field(LOLO, "10")
10  field(HHSV, "MAJOR")
11  field(HSV,  "MINOR")
12  field(LSV,  "MINOR")
13  field(LLSV, "MAJOR")
14  field(PINI, "RUNNING")
15  field(HYST, "1")
16}

 1record(aai, aai){
 2  field(NELM, "10")
 3  field(FTVL, "SHORT")
 4  field(APST, "On Change")
 5  field(MPST, "Always")
 6#  field(INP,  "[3,1,1]")
 7  field(INP,  "{const: [315, 10, 0, 0, 1]}")
 8}
 9
10record(aao, aao){
11  field(OMSL, "closed_loop")
12  field(DOL,  "aai")
13  field(PINI, "RUNNING")
14  field(FTVL, "SHORT")
15  field(NELM, "10")
16  field(OUT,  "wf")
17}
18record(waveform, wf){
19  field(FTVL, "LONG")
20  field(NELM, "20")
21}

1record(bi, bi){
2  field(VAL,  "0")
3  field(ZNAM, "OFF")
4  field(ONAM, "ON")
5  field(ZSV,  "MAJOR")
6  field(OSV,  "NO_ALARM")
7  field(COSV, "MINOR")
8  field(PINI, "YES")
9}

 1record(bo, "i_am_alive") {
 2    field(DTYP, "Soft Channel")
 3    field(SCAN, "1 second")
 4    field(DOL, "1")
 5    field(UDF, "0")
 6    field(ZNAM, "Dead")
 7    field(ONAM, "Alive")
 8    field(OUT, "deadIfZero.VAL PP")
 9}
10
11record(bo, "deadIfZero") {
12    field(DTYP, "Soft Channel")
13    field(ZNAM, "Dead")
14    field(ONAM, "Alive")
15    field(HIGH, "$(DEAD_SECONDS=5)")
16}

 1# 简单的例子, heartbeat
 2record(calc, "calc"){
 3  field(VAL,  "0")
 4  field(CALC, "VAL?0:1")
 5  field(SCAN, "1 second")
 6}
 7# 复杂的例子, 产生连续正弦波, 初始相位可调
 8record(calc, "calc"){
 9  field(INPA, "1.57079632679489661923") # 初始相位为pi/2
10  field(CALC, "A:=(A+D2R)>(2*PI)?0:(A+D2R); sin(A)")
11  field(SCAN, ".1 second")
12}

 1record(calcout, "co"){
 2  field(CALC, "VAL<10?VAL+1:0")
 3  field(OCAL, "90-89")
 4  field(OOPT, "When Zero")
 5  field(DOPT, "Use OCAL")
 6  field(OUT,  "res PP")
 7  field(SCAN, "1 second")
 8}
 9
10record(ao, "res") {
11  field(TPRO, "1")
12}

 1record(calc, calc){
 2  field(CALC, "VAL+1")
 3  field(FLNK, "cp PP")
 4  field(SCAN, "1 second")
 5}
 6record(compress, cp) {
 7  field(INP,  "calc NPP")
 8  field(ALG,  "Average")
 9  field(BALG, "LIFO Buffer")
10  field(NSAM, "2")
11  field(N,    "10")
12  field(PINI, "YES")
13}

1$ camonitor cp
2cp                             <undefined> UDF INVALID
3cp                             2024-05-17 16:03:37.379709 4.5
4cp 2024-05-17 16:03:47.379616 2 14.5 4.5
5cp 2024-05-17 16:03:57.379640 2 24.5 14.5

 1record(event, event){
 2  field(INP, "14")
 3  field(TPRO, "1")
 4}
 5
 6record(calc, calc){
 7  field(CALC, "VAL+1")
 8  field(SCAN, "Event")
 9  field(EVNT, "14")
10  field(TPRO, "1")
11  field(PRIO, "HIGH")
12}
13record(ai, ai){
14  field(INP, "calc")
15  field(SCAN, "Event")
16  field(EVNT, "14")
17  field(TPRO, "1")
18}

1epics> dbpf event.PROC 0
2_main_: dbProcess of 'event'
3DBF_UCHAR:          0 = 0x0
4cbLow: dbProcess of 'ai'
5cbHigh: dbProcess of 'calc'
6# caput event.PROC 0
7epics> ca:sdcswd@zephyrus: dbProcess of 'event'
8cbLow: dbProcess of 'ai'
9cbHigh: dbProcess of 'calc'

 1record(fanout, fo){
 2  # Specified, LNK1被触发
 3  field(SELM, "Specified")
 4  field(SELN, "0")
 5  field(OFFS, "1")
 6
 7  # Mask, LNK1和LNK2被触发
 8  # field(SELM, "Mask")
 9  # field(SELN, "6")
10  # field(SHFT, "0")
11
12  field(LNK0, "calc0")
13  field(LNK1, "calc1")
14  field(LNK2, "calc2")
15  field(LNK3, "calc3")
16  field(LNK4, "calc4")
17}
18record(calc, calc0){
19  field(CALC, "VAL+1")
20}
21record(calc, calc1){
22  field(CALC, "VAL+1")
23}
24record(calc, calc2){
25  field(CALC, "VAL+1")
26}
27record(calc, calc3){
28  field(CALC, "VAL+1")
29}
30record(calc, calc4){
31  field(CALC, "VAL+1")
32}

 1record(dfanout, dfo){
 2  field(OMSL, "closed_loop")
 3  field(DOL,  "19")
 4
 5  # Specified, SELN为0时无输出
 6  # field(SELM, "Specified")
 7  # field(SELN, "0")
 8
 9  # Mask, 二进制为`101`, 所以输出到OUTA和OUTC
10  field(SELM, "Mask")
11  field(SELN, "5")
12
13  field(OUTA, "calc0")
14  field(OUTB, "calc1")
15  field(OUTC, "calc2")
16  field(OUTD, "calc3")
17  field(OUTE, "calc4")
18}

 1record(calc, "calc"){
 2  field(INPA, "1.57079632679489661923") # Phase
 3  field(CALC, "A:=(A+D2R)>(2*PI)?0:(A+D2R); sin(A)")
 4  field(SCAN, ".1 second")
 5  field(FLNK, "hist")
 6}
 7
 8record(histogram, hist){
 9  field(SVL,  "calc NPP")
10  field(NELM, "10")
11  field(ULIM, "1")
12  field(LLIM, "-1")
13  field(MDEL, "20")
14  field(SDEL, "0")
15  field(CMD,  "Read")
16}

1$ caput hist.CMD "Stop"
2Old : hist.CMD                       Read
3New : hist.CMD                       Read

1record(longin, li){
2}
3record(int64in, i64){
4}

 1$ caput li 2147483647
 2Old : li                             111
 3New : li                             2147483647
 4sdcswd @ zephyrus in  ~/epics/R7.0.8/base [11:47]
 5$ caput li 2147483649
 6Old : li                             2147483647
 7CA.Client.Exception...............................................
 8New : li                             2147483647
 9    Warning: "Channel write request failed"
10    Context: "op=1, channel=li, type=DBR_STRING, count=1, ctx="li""
11    Source File: ../oldChannelNotify.cpp line 159
12    Current Time: Thu May 16 2024 11:47:58.193643892
13..................................................................
14$ caput i64 2147483647
15Old : i64                            0
16New : i64                            2.14748e+09
17sdcswd @ zephyrus in  ~/epics/R7.0.8/base [11:48]
18$ caput i64 2147483999
19Old : i64                            2.14748e+09
20New : i64                            2.14748e+09

 1record(mbbi, mbbi){
 2  field(NOBT, "4")
 3  field(DTYP, "Raw Soft Channel")
 4  field(INP,  "0x1234")
 5  field(SHFT, "4")
 6  field(ZRVL, "0x4")
 7  field(ZRST, "VAL&0xf")
 8  field(ZRSV, "MINOR")
 9  field(ONVL, "0x3")
10  field(ONST, "VAL&0xf0")
11  field(ONSV, "MINOR")
12  field(FFVL, "0x1234")
13  field(FFST, "All")
14  field(PINI, "RUNNING")
15}

 1record(mbbo, mbbo){
 2  field(DTYP, "Raw Soft Channel")
 3  field(DOL,  "15")
 4  field(OMSL, "closed_loop")
 5  field(PINI, "RUNNING")
 6  field(OUT,  "li")
 7  field(ZRVL, "111")
 8  field(ZRST, "aaa")
 9  field(ZRSV, "MINOR")
10  field(ONVL, "222")
11  field(ONST, "bbb")
12  field(ONSV, "MINOR")
13  field(FFVL, "32768")
14  field(FFST, "fff")
15}
16record(longin, li){}

1record(mbbiDirect, mbbidir){
2  #field(NOBT, "4")
3  field(DTYP, "Raw Soft Channel")
4  field(INP,  "0xaaaa")
5  #field(SHFT, "4")
6  field(PINI, "RUNNING")
7}

1record(longout, lo){}
2record(mbboDirect, mbbodir){
3  field(PINI, "YES")
4  field(DOL,  "0xaaaa")
5  field(OMSL, "closed_loop")
6  field(DTYP, "Raw Soft Channel")
7  field(OUT,  "lo PP")
8}

 1record(printf, pr){
 2  field(DTYP, "stdio")
 3  field(SIZV, "80")
 4  field(FMT,  "0: %s, 1: %f, 2: %f, 3: %s")
 5  field(INP0, {const: hello})
 6  field(INP1, {const: "3.14159"})
 7  field(INP2, {const: "pi:3.14159"})
 8  field(INP3, "non-exist-link")
 9  field(IVLS, "Whoops")
10  field(PINI, "YES")
11  field(OUT,  "@stdout")
12}

 1record(seq, seq){
 2  field(SELM, "Mask")
 3  field(SELN, "3")
 4  field(SHFT, "0")
 5  field(OFFS, "0")
 6
 7  field(DOL0, "10")
 8  field(DOL1, "11")
 9  field(DOL2, "12")
10  field(DOL3, "13")
11  field(DOL4, "14")
12  field(LNK0, "calc0")
13  field(LNK1, "calc1")
14  field(LNK2, "calc2")
15  field(LNK3, "calc3")
16  field(LNK4, "calc4")
17}

1record(lsi, lsi){
2  field(SIZV, "32768")
3  field(INP,  {const: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa})
4  field(PINI, "YES")
5}

1record(lso, lso){
2  field(OMSL, "closed_loop")
3  field(DOL,  {const: bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb})
4  field(SIZV, "32768")
5  field(PINI, "YES")
6}

 1record(subArray,"subarr") {
 2  field(INP,  "wf.VAL NPP NMS")
 3  field(MALM, "5")
 4  field(NELM, "2")
 5  field(INDX, "4")
 6  field(FTVL, "ULONG")
 7}
 8record(waveform,"wf") {
 9  field(PINI, "YES")
10  field(INP,  "[3,1,4,1,5,9,2,6]")
11  field(NELM, "10")
12  field(FTVL, "ULONG")
13  field(FLNK, "subarr")
14}

1record(sub,"$(user):subExample")
2{
3  field(INAM,"mySubInit")
4  field(SNAM,"mySubProcess")
5}

1record(aSub,"$(user):aSubExample")
2{
3  field(INAM,"myAsubInit")
4  field(SNAM,"myAsubProcess")
5  field(FTA,"DOUBLE")
6  field(NOA,"10")
7  field(INPA,"$(user):compressExample CPP")
8}