Skip to content

DevicePositionUpdate

Source code in docs_src/capo_location/types/device_position_update.py
class DevicePositionUpdate(TypedDict, closed=True):
    device_id: "capo_location.types.id.Id"
    """<p>The device associated to the position update.</p>"""
    sample_time: "capo_location.types.timestamp.Timestamp"
    """<p>The timestamp at which the device's position was determined. Uses <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code> </p>"""
    position: "capo_location.types.position.Position"
    """<p>The latest device position defined in <a href="https://earth-info.nga.mil/index.php?dir=wgs84&amp;action=wgs84">WGS 84</a> format: <code>[X or longitude, Y or latitude]</code>.</p>"""
    accuracy: NotRequired["capo_location.types.positional_accuracy.PositionalAccuracy"]
    """<p>The accuracy of the device position.</p>"""
    position_properties: NotRequired[
        "capo_location.types.position_property_map.PositionPropertyMap"
    ]
    """<p>Associates one of more properties with the position update. A property is a key-value pair stored with the position update and added to any geofence event the update may trigger.</p> <p>Format: <code>"key" : "value"</code> </p>"""

accuracy instance-attribute

accuracy: NotRequired[PositionalAccuracy]

The accuracy of the device position.

device_id instance-attribute

device_id: Id

The device associated to the position update.

position instance-attribute

position: Position

The latest device position defined in WGS 84 format: [X or longitude, Y or latitude].

position_properties instance-attribute

position_properties: NotRequired[PositionPropertyMap]

Associates one of more properties with the position update. A property is a key-value pair stored with the position update and added to any geofence event the update may trigger.

Format: "key" : "value"

sample_time instance-attribute

sample_time: Timestamp

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ