Skip to content

incendium.tag.read

César Román edited this page Apr 30, 2024 · 15 revisions

Description

Read the value of the Tags at the given paths.

Note that this function will block until the read operation is complete or times out.

Syntax

incendium.tag.read(tag_path)

Args:

  • tag_path (str): Reads from the given tag path. If no property is specified in the path, the Value property is assumed.

Returns:

  • BasicQualifiedValue: A qualified value. This object has three sub-members: value, quality, and timestamp.

Code Examples

from incendium import tag as _tag
from incendium.vision import gui as _gui

# This example would read a value and display it in a message box.
qv = _tag.read("[default]EastSection/ValveG/HOA_bit")
_gui.info("The value is {}".format(qv.value))
Clone this wiki locally