milestonexprotectrestpython.xprdevice

Module: xprdevice.py

Revision History

Date Version Description
2023/07/11 1.0.0.0 Initial Version.

@export
class XPRDevice:

Device information base class.

More information about Device configuration can be found on the vendor documentation page.

Threadsafety:

This class is fully thread-safe.

XPRDevice()

Initializes a new instance of the class.

Channel: int

The channel number of the device.

Returns:

The Channel property value.

CoverageDirection: float

The viewing coverage direction of the device.

Returns:

The CoverageDirection property value.

CoverageDepth: float

The viewing coverage depth of the device.

Returns:

The CoverageDepth property value.

CoverageFieldOfView: float

The coverage field of view of the device.

Returns:

The CoverageFieldOfView property value.

DateCreated: datetime.datetime

Date and time (in UTC format) that the item was created.

Returns:

The DateCreated property value.

DateModified: datetime.datetime

Date and time (in UTC format) that the item was last modified.

Returns:

The DateModified property value.

Description: str

A description of the device.

Returns:

The Description property value.

DisplayName: str

User-friendly display name used in various user-interface displays.

Returns:

The DisplayName property value.

Enabled: str

The enabled status of the device - True if enabled; otherwise False.

Returns:

The Enabled property value.

GisPoint: str

Geographic location of the device in the format latitude, longitude, and potentially altitude.

Returns:

The GisPoint property value.

The format is "POINT (LATITUDE LONGITUDE)" and if you want to clear the coordinates, the value to use is "POINT EMPTY".
Examples: "POINT (55.656932878513 12.3763545558449)" "POINT EMPTY". Can also include altitude; if so the format is "POINT (LATITUDE LONGITUDE ALTITUDE)".

The value determines the position of the device icon on the smart map in XProtect Smart Client.

HardwareId: str

The globally unique identifier of the hardware, with which the device is connected.

Returns:

The HardwareId property value.

Icon: int

Icon identifier. The relevant device icon to show.

Returns:

The Icon property value.

Id: str

The globally unique identifier of the device.

Returns:

The Id property value.

Name: str

Name of the device.

Returns:

The Name property value.

ShortName: str

Short name. Used as name in the user interface where appropriate.

Returns:

The ShortName property value.

The maximum length of characters is 128.