linse/seweb
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added device name doc

Browse Source
This commit is contained in:
l_samenv
2024-09-11 09:22:15 +02:00
parent d8d1d40881
commit ba118ab56e
2 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -130,6 +130,7 @@ For the `generic.ini` and `<instrument>.ini` files, go to `./doc/variables_confi
### ... in the features
- For the moment, with a server started with `influxsea` or `influx` type, the device name is updated as described in the section "About instrument and device name" in the `client.md` file. The problem is that it is not possible to identify a portion of a device (for example the stick) which is no longer there (there is no way yet to have a `expired=False` tag on these measurements). This has to be discussed to know how to manage this problem.
- For the curves settings :
- The table could display all the curves which are available, including those hidden by some configuration file on the server, meaning that we display all the curves with the parameters "value" and "target", even if hidden, plus the manually added parameters (like raw, for example) from the server or the user.
- The bin item would then be a checkbox, and its column would have the signification "default". All curves which are retrieved from the server would have this checkbox checked, as it is the default content, and any newly user added curves should have it unchecked. When one of the value is changed, the checkbox would then be unchecked. Turning on the checkbox would have two effects : if the line comes from the server, its options are reset to those found on the server. If the line comes from some user configuration, turning on the checkbox would then set the category to "-".

17
doc/client.md
View File

@ -29,6 +29,23 @@ The export popup, the dates popup and the curves settings popup are considered a
## Miscellaneous
### About instrument and device name
There is a difference between what is displayed in the top left hand corner of the left part (in the grey box) and the right part ("main" block).
In the right part, with a server started :
- with `sea` or `influxsea` type, only the instrument name is displayed. This information is taken from SEA.
The behavior is not known for a server started with `secop` type.
In the left part, with a server started :
- with `influxsea` or `influx` type, the instrument is taken from the command that was used to launch the server, and the device is taken from InfluxDB. More specifically, it takes the value out of the `value` field in the measurements `nicos/se_main`, `nicos/se_stick` and `nicos/se_addons`. For each of these measurements, we take the last entry in the database until the end of the visualization window. It has to be mentionned that the device name is updated at each jump in time via the dates popup (go to now or jump). The device name is formatted as `<main>[/<stick>][/<addons>]`. An url can be shown for one of these component.
- with `sea` type, the instrument is taken from the command line used to launch the server, and device is taken from SEA (device is got with the request `samenv name`).
The behavior is not known for a server started with `dummy` type.
###
### About updating graphics
- When the server is pushing data, the newly received data is appened to the current curves (on livemode).