dependencies

org.clojure/clojure		1.10.1
com.taoensso/carmine		3.0.0
com.ashafa/clutch		0.4.0
clj-time		0.15.0
org.clojure/data.json		0.2.6
com.taoensso/timbre		5.0.0
clj-http		3.10.0
clojang/codox-theme		0.2.0-SNAPSHOT

(this space intentionally left almost blank)

namespaces

example-session.clj

example-session.clj

toc

cmp.core Namespace

After starting a clojure repl change the name space (ns) you are working in to cmp.core by:

(in-ns 'cmp.core)

=> #namespace[cmp.core]

A list of the functions available in cmp.core may be generated by:

(dir cmp.core)

=> c-info c-mon c-reset c-run c-status c-stop c-suspend check ... workon!

Use (doc c-info) or (doc c-mon) etc to explore the functions

(doc c-info)

cmp.core/c-info

([] [i] [mp-id i])

Returns a info map about the ith container of the mpd with the id mp-id.

... ... ...

... ... ...

... ... ...

The reference definition mpd-ref.edn

On a fresh system load and build a reference measurement program definition called ref. ref is stored in edn format at resources/mpd-ref.edn. The function:

(m-build-edn)

builds the mpd(s) defined in the cmp configuration file resources/config.edn (see keyword :edn-mpds). The build process embeds the data structure in a fast key-value-store kvs (here redis). This kvs is called short term memory (stm).

The kvs may be inspected by graphical frontends (see redis gui section of cmp docu) by cli or by the function:

(st/pat->keys "ref*")

("ref@container@000@ctrl"
 "ref@container@000@definition@000@000"
 "ref@container@000@definition@000@001"
 "ref@container@000@definition@001@000"
 "ref@container@000@definition@001@001"
 "ref@container@000@definition@001@002"
 "ref@container@000@definition@001@003"
 "ref@container@000@definition@002@000"
 "ref@container@000@descr"
 "ref@container@000@elem"
 "ref@container@000@state@000@000"
 "ref@container@000@state@000@001"
 "ref@container@000@state@001@000"
 "ref@container@000@state@001@001"
 "ref@container@000@state@001@002"
 "ref@container@000@state@001@003"
 "ref@container@000@state@002@000"
 "ref@container@000@title"
 "ref@container@001@ctrl"; ... and so on
 )

(count
 (st/pat->keys "ref*"))

The value of a key (e.g. ref@definitions@000@cond@000) can be accessed by:

(st/key->val "ref@definitions@000@cond@000")

{:ExchangePath "A.Unit" :Methode "eq" :Value "Pa"}

key pattern

The function pat->keys in the st_mem namespace (imported :as st) alows to find a key subset:

(st/pat->keys "ref@*@*@descr")

("ref@container@000@descr"
 "ref@container@001@descr"
 "ref@container@002@descr"
 "ref@container@003@descr"
 "ref@container@004@descr"
 "ref@container@005@descr"
 "ref@container@006@descr"
 "ref@container@007@descr"
 "ref@container@008@descr"
 "ref@container@009@descr"
 "ref@container@010@descr"
 "ref@definitions@000@descr"
 "ref@definitions@001@descr"
 "ref@definitions@002@descr")

access the values by:

(map
 st/key->val
 (st/pat->keys "ref@*@*@descr"))

("Container just waits parallel and sequential."
 "Container with one task only"
 "Show case select feature"
 "Run a mpd (first container of ref)."
 "Test modbus action with prescript (get)"
 "Test modbus action with prescript (set)"
 "Test TCP action."
 "Test read_exchange action."
 "Test anselm request."
 "Test date and time and the ability to parallel write to database docs."
 "Message test."
 "waits 1 and 2s\n"
 "waits 3 and 4s\n"
 "waits 4 and 5s\n")

or use:

(cs-info)

"
| :c-no-idx |                   :c-title |                                         :c-descr | :c-ctrl |
|-----------+----------------------------+--------------------------------------------------+---------|
|       000 |        multiple wait tasks | Container just waits parallel and sequential.... |   ready |
|       001 | container with single task |                     Container with one task only |   ready |
|       002 |  choose definition, run it |                         Show case select feature |   ready |
|       003 |          run 1st container |              Run a mpd (first container of ref). |   ready |
|       004 |            modbus get test |          Test modbus action with prescript (get) |    void |
|       005 |            modbus set test |          Test modbus action with prescript (set) |    void |
|       006 |  TCP test with result set. |                                 Test TCP action. |    void |
|       007 |             read exchange. |                       Test read_exchange action. |   ready |
|       008 |                    anselm. |                             Test anselm request. |    void |
|       009 |                date & time | Test date and time and the ability to paralle... |    void |
|       010 |                    message |                                    Message test. |    void |
"

for a nice formated table.

Set the definition to work on

Most api functions in the cmp.core namespace need the id of the mpd to work on.

After

(workon! "ref")

the command

(c-info "ref" 1)

is the same as

(c-info 1)

(workon! "ref") stores the mp-id argument in an atom called current-mp-id

(deref current-mp-id)
"ref"

With a defined current-mp-id, the mp-id argument may be skiped for most of the cmp.core functions.

(m-info)

{:mp-id "ref"
 :mp-descr "Simple measurement programm definition (mpd) ..."
 :mp-std "NN"
 :mp-ncont 7
 :mp-ndefins 3}

Build the tasks

The mpd building block is the task. Tasks are stored in the stm too. This means that they can be modified during runtime (a desperately needed but missing ssmp-feature) Run

(t-refresh)

The the available tasks are saved under the key prefix tasks

(count
 (st/pat->keys "tasks*"))

229

(st/key->val
 (first
  (st/pat->keys "tasks*")))

{:TaskName "SE1_ATMION-degas",
 :Action "TCP",
 :Host "%host",
 :Port "%port",
 :Values {:on "SDG1, 1%CR", :off "SDG1, 0%CR"},
 :Defaults {:%host "e75437", :%port "5302", :%CR "\r"}}

(t-table) delivers a overview table of all tasks This table may be filtered:

(t-table)

"
| :Action |                         :TaskName |                                :stm-key |
|---------+-----------------------------------+-----------------------------------------|
|     TCP |                 BO_CE3-device_ini |                 tasks@BO_CE3-device_ini |
|     TCP |                   BO_CE3-get_info |                   tasks@BO_CE3-get_info |
|     TCP |           Corvus_1-check_position |           tasks@Corvus_1-check_position |
|     TCP |                     Corvus_1-exec |                     tasks@Corvus_1-exec |
|     TCP |                 Corvus_1-is_ready |                 tasks@Corvus_1-is_ready |
|     TCP |                Corvus_2-close_dvg |                tasks@Corvus_2-close_dvg |
|     TCP |           Corvus_2-displacer_exec |           tasks@Corvus_2-displacer_exec |
|     TCP |       Corvus_2-displacer_position |       tasks@Corvus_2-displacer_position |
|     TCP |        Corvus_2-displacer_sz_exec |        tasks@Corvus_2-displacer_sz_exec |
|     TCP |    Corvus_2-displacer_sz_position |    tasks@Corvus_2-displacer_sz_position |
|     TCP |             Corvus_2-dvg_position |             tasks@Corvus_2-dvg_position |
|     TCP |                 Corvus_2-is_ready |                 tasks@Corvus_2-is_ready |
|     TCP |                 Corvus_2-open_dvg |                 tasks@Corvus_2-open_dvg |
|     TCP |                        DCF77-exec |                        tasks@DCF77-exec |
...
"

(t-table :Action "TCP")

"
|  :Action |               :TaskName |                      :stm-key |
|----------+-------------------------+-------------------------------|
| genDbDoc | SE3_state-gen_state_doc | tasks@SE3_state-gen_state_doc |
"

start mpd

In order to make cmp react on commands, appearing at the containers ctrl endpoint use

(workon! "ref")
(m-start)

run container

Run the first container with:

(set-ctrl "ref" 0 "run")

" OK
log => INFO [cmp.ctrl:17] - ctrl dispatch call for path:  ref@container@000@ctrl
log => INFO [cmp.state:323] - register start-next! callback and start-next!
log => INFO [cmp.st-mem:381] - subscribed to  __keyspace@0*__:ref@container@000@state*
log => DEBUG [cmp.st-mem:60] - wrote new state:  :working  to:  ref@container@000@state@000@000
log => DEBUG [cmp.st-mem:60] - wrote new state:  :working  to:  ref@container@000@state@000@001
log => DEBUG [cmp.state:236] - nop! for:  ref@container@000@ctrl
...
"

or:

(c-run 0)

documents

To add or remove documents for storing data in use (d-add mp-id doc-id), (d-rm mp-id doc-id). Again, if @current-mp-id is set (by (workon! mp-id)) (d-add doc-id), (d-rm doc-id) is sufficient.

(d-add "cal-2020-se3-kk-11111_0002")

"
log => DEBUG [cmp.lt-mem:14] - try to get document with id: cal-2020-se3-kk-11111_0002
"

(d-ids)

("cal-2020-se3-kk-11111_0001")

(d-rm "cal-2020-se3-kk-11111_0002")
(d-ids)

()

cmp

0.13.0