Skip to content

PropertyValue

Source code in docs_src/capo_iottwinmaker/types/property_value.py
class PropertyValue(TypedDict, closed=True):
    timestamp: NotRequired["capo_iottwinmaker.types.timestamp.Timestamp"]
    """<p>The timestamp of a value for a time series property.</p>"""
    value: "capo_iottwinmaker.types.data_value.DataValue"
    """<p>An object that specifies a value for a time series property.</p>"""
    time: NotRequired["capo_iottwinmaker.types.time.Time"]
    """<p>ISO8601 DateTime of a value for a time series property.</p> <p>The time for when the property value was recorded in ISO 8601 format: <i>YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm]</i>.</p> <ul> <li> <p> <i>[YYYY]</i>: year</p> </li> <li> <p> <i>[MM]</i>: month</p> </li> <li> <p> <i>[DD]</i>: day</p> </li> <li> <p> <i>[hh]</i>: hour</p> </li> <li> <p> <i>[mm]</i>: minute</p> </li> <li> <p> <i>[ss]</i>: seconds</p> </li> <li> <p> <i>[.SSSSSSSSS]</i>: additional precision, where precedence is maintained. For example: [.573123] is equal to 573123000 nanoseconds.</p> </li> <li> <p> <i>Z</i>: default timezone UTC</p> </li> <li> <p> <i>± HH:mm</i>: time zone offset in Hours and Minutes.</p> </li> </ul> <p> <i>Required sub-fields</i>: YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]</p>"""

time instance-attribute

time: NotRequired[Time]

ISO8601 DateTime of a value for a time series property.

The time for when the property value was recorded in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm].

  • [YYYY]: year

  • [MM]: month

  • [DD]: day

  • [hh]: hour

  • [mm]: minute

  • [ss]: seconds

  • [.SSSSSSSSS]: additional precision, where precedence is maintained. For example: [.573123] is equal to 573123000 nanoseconds.

  • Z: default timezone UTC

  • ± HH:mm: time zone offset in Hours and Minutes.

Required sub-fields: YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]

timestamp instance-attribute

timestamp: NotRequired[Timestamp]

The timestamp of a value for a time series property.

value instance-attribute

value: DataValue

An object that specifies a value for a time series property.