Skip to content

Update of save&restore service doc #3396

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shroffk merged 1 commit into from
May 13, 2025
Merged

Update of save&restore service doc #3396

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 28 additions & 19 deletions services/save-and-restore/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -961,54 +961,63 @@ Return value: a list of comparison results, one for each PV in the snapshot, e.g

.. code-block:: JSON

{
"equal" : "false",
"pvCompareMode": "RELATIVE",
"tolerance" : 0,
[
{
"pvName": "COUNTER10",
"equal": false,
"comparison": {
"comparisonMode": "ABSOLUTE",
"tolerance": 0
},
"storedValue": {
"type": {
"name": "VInt",
"name": "VDouble",
"version": 1
},
"value": 18,
"value": 409553,
"alarm": {
"severity": "NONE",
"status": "NONE",
"name": "NONE"
"name": "NO_ALARM"
},
"time": {
"unixSec": 1653903750,
"nanoSec": 532912758
"unixSec": 1747125271,
"nanoSec": 462384000,
"userTag": 0
},
"display": {
"units": ""
"lowDisplay": 0,
"highDisplay": 0,
"units": "",
"description": "This is a description"
}
},
"liveValue": {
"type": {
"name": "VInt",
"name": "VDouble",
"version": 1
},
"value": 14,
"value": 409623,
"alarm": {
"severity": "NONE",
"status": "NONE",
"name": "NO_ALARM"
},
"time": {
"unixSec": 1734688284,
"nanoSec": 605970324,
"unixSec": 1747125341,
"nanoSec": 460785000,
"userTag": 0
},
"display": {
"lowDisplay": 0.0,
"highDisplay": 255.0,
"lowDisplay": 0,
"highDisplay": 0,
"units": "",
"description": "Mapping for Pulser 0"
"description": "This is a description"
}
},
"delta": "+4"
}
"delta": "-70.0"
}
]

Note that if the comparison evaluates to "equal", then ``storedValue`` and ``liveValue`` are set to ``null``.
The ``delta`` field value is formatted in the same manner as the delta column in the client UI.
Expand Down