Commit b2579170 authored by Benoit Formet's avatar Benoit Formet
Browse files

taac: document allow_failure

parent 972b29b7
Pipeline #51599 passed with stages
in 10 minutes
......@@ -18,8 +18,13 @@ BLISS counter.
- `format` (optional) (str): string representing the display format to use.
- `index` (optional) (int): index of the wanted value in case the attribute is an array.
- `allow_failure` (optional, default:`True`) (bool): raise exception or return numpy.nan upon error reading the attribute
!!! note
`allow_failure: False` is useful when you don't want a scan interrupted by a failed reading of a tango attribute. Data will be numpy.nan in this case.
### Tango attribute parameters
If the following parameters are defined in the attribute configuration (in Tango
database), and not overwritten in YAML configuration, they will be used in
......@@ -62,7 +67,7 @@ Out [2]: 'hpz_off_2` Tango attribute counter info:
!!! note
The formated and the raw values can be obtained directly via `.value` and
`.raw_value` properties:
DEMO [5]: hpz_off_2.value
Out [5]: 167.19
DEMO [6]: hpz_off_2.raw_value
......@@ -88,6 +93,7 @@ server:
format: "3.2f"
- name: lifetime
attr_name: SR_Lifetime
allow_failure: False
Example to read a wago thermocouple via a Tango device server attribute:
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment