updateTag

Update or create metadata for a tag.

See also Create Tag

Signature

updateTag(tag, description=None, units=None, stepped=False, create_missing=False)

• tag (str)
• description (str | None)
• units (str | None)
• stepped (bool, default: False)
• create_missing (bool, default: False)

Inputs

• tag: Tag name to update.
• description: Optional description.
• units: Optional engineering units.
• stepped: Set true for discrete values.
• create_missing: Create tag if it does not exist.

Examples

JSON output (update + create missing)

result = hm.updateTag(
  "DEMO_02TI999.PV",
  description="Updated description",
  units="C",
  stepped=False,
  create_missing=True,
)

Output:

{ "success": true, "errors": {} }

JSON output (partial update)

result = hm.updateTag(
  "DEMO_02TI999.PV",
  units="degC",
)

Output:

{ "success": true, "errors": {} }