Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
E
e3-autosave
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Jira
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
ESS EPICS Environment
wrappers
e3-autosave
Commits
a91cd37f
Commit
a91cd37f
authored
1 year ago
by
Anders Lindh Olsson
Browse files
Options
Downloads
Patches
Plain Diff
Update README; add instructions
parent
04aedba9
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!30
E3-1392: Module review fixes
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+41
-15
41 additions, 15 deletions
README.md
with
41 additions
and
15 deletions
README.md
+
41
−
15
View file @
a91cd37f
# e3-autosave
## Preparation of DB
Wrapper for the
`autosave`
module - part of EPICS infrastructure at ESS. This module is loaded through
`essioc`
for production IOCs.
Each record in database file that needs to have values saved by
`autosave`
must have the one of following
`info`
tags. Such as
## Installation
```
sh
$
make init patch build
$
make
install
```
info(autosaveFields, "PREC SCAN DESC OUT")
info(autosaveFields_pass0, "VAL")
info(autosaveFields_pass1, "VAL")
For further targets, type
`make`
.
## Usage
```
sh
$
iocsh
-r
"autosave"
```
Each info tag should be matched with what one would like to use such as
### How it works
To set up autosave (and boot-time restore) of record fields, use one of the following info-tags:
*
`autosaveFields`
: before and after record initialization
-
`settings.sav`
: in
`$(AS_TOP)/$(IOCNAME)/save`
-
`settings.req`
: in
`$(AS_TOP)/$(IOCNAME)/req`
*
`autosaveFields`
:
to restore
**
before
**
and
**
after
**
record initialization
-
`settings.sav`
: in
`$(AS_TOP)/$(IOCNAME)/save`
-
`settings.req`
: in
`$(AS_TOP)/$(IOCNAME)/req`
*
`autosaveFields_pass0`
: before record initialization
-
`values_pass0.sav`
: in
`$(AS_TOP)/$(IOCNAME)/save`
-
`values_pass0.req`
: in
`$(AS_TOP)/$(IOCNAME)/req`
*
`autosaveFields_pass0`
: to restore only
**before**
record initialization
-
`values_pass0.sav`
: in
`$(AS_TOP)/$(IOCNAME)/save`
-
`values_pass0.req`
: in
`$(AS_TOP)/$(IOCNAME)/req`
*
`autosaveFields_pass1`
: to restore only
**after**
record initialization
-
`values_pass1.sav`
: in
`$(AS_TOP)/$(IOCNAME)/save`
-
`values_pass1.req`
: in
`$(AS_TOP)/$(IOCNAME)/req`
For example:
```
record("*", "some-record") {
info(autosaveFields, "PREC SCAN DESC OUT")
info(autosaveFields_pass0, "VAL")
info(autosaveFields_pass1, "VAL")
}
```
Each info tag should be matched with what one would like to use such as
## Contributing
*
`autosaveFields_pass1`
: after record initialization (Most autosave values can be restored at Pass 0 and Pass 1 using the
`autosaveFields`
info tag.)
-
`values_pass1.sav`
: in
`$(AS_TOP)/$(IOCNAME)/save`
-
`values_pass1.req`
: in
`$(AS_TOP)/$(IOCNAME)/req`
Contributions through pull/merge requests only.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment