milestonexprotectwspython.xpwdevice

Module: xpwdevice.py

Revision History

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

@export
class XPWDevice:

Device information base class.

Supplemental documentation can be found at: https://doc.milestonesys.com/latest/en-US/standard_features/sf_mc/sf_ui/mc_devicestabs_devices.htm#MC_InfoTabExplained.htm

Threadsafety:

This class is fully thread-safe.

XPWDevice()

Initializes a new instance of the class.

Description: str

A description of the device.

Returns:

The Description property value.

DeviceId: str

The globally unique identifier of the device.

Returns:

The DeviceId property value.

DeviceIndex: int

The index of the device.

Returns:

The DeviceIndex 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.

Name: str

Name of the device.

Returns:

The Name property value.

RecorderId: str

Globally unique identifier of the recording server holding this item.

Returns:

The RecorderId 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.