ScriptDeviceDescription¶

class ScriptDeviceDescription.ScriptDeviceCollection(iterable=(), /)¶

Bases: list

A collection of ScriptDeviceDescription objects.

property vendors¶

Gets the list of all vendors in the collection.

Return type:

tuple[int]

get_devices_of_vendor(vendor)¶

Get all devices in the list which match the specified vendor.

Parameters:

vendor (str) – Vendor name.

Return type:

ScriptDeviceCollection

Returns:

A collection of devices from one vendor.

class ScriptDeviceDescription.ScriptDeviceDescription¶

Bases: object

Description of a device.

property device_id¶

Get the identification object of the device.

Return type:

DeviceID

Returns:

DeviceID

property device_info¶

Get information about the device.

Return type:

ScriptDeviceInfo

Returns:

DeviceInfo

property connectors¶

Gets the connectors.

Return type:

ScriptDeviceConnectorSet

Returns:

DeviceConnectorSet

property name¶

Internationalized name of the device.

Return type:

str

property description¶

Internationalized description of the device.

Return type:

str

property vendor¶

Internationalized vendor of the device vendor.

Return type:

str

property categories¶

Gets a list of categories this device belongs to.

Return type:

tuple[int]

property families¶

Gets a list of vendor-specific families this device belongs to.

Each string has got the format VendorId:FamilyId.

Return type:

tuple[str]

property custom¶

Get vendor specific information for the device.

This property may contain all kinds of information not defined by the specification, structured as an XML-Fragment with root node “Custom”.

Example::

<Custom><MaxTemp>30</MaxTemp></Custom>\

Return type:

str

property order_number¶

Vendor specific order number for this device.

Return type:

str

property default_instance_name¶

The default intance name for this device.

Version added:

3.5.11.0

Return type:

str

class ScriptDeviceDescription.ScriptVendorDescription¶

Bases: object

Vendor description.

property vendor_id¶

Id of the vendor.

Return type:

int

property version¶

Version.

Return type:

str

property vendor_info¶

Vendor information.

Return type:

ScriptVendorInfo

property families¶

Get all families of the vendor.

Return type:

tuple[ScriptDeviceFamily]

get_family(family_id)¶

Get the family with the specified family Id.

Parameters:

family_id (int) – Family Id.

Return type:

ScriptDeviceFamily

Returns:

Device family object or None if there is no matching family.

class ScriptDeviceDescription.ScriptVendorInfo¶

Bases: object

Vendor information.

property name¶

Vendor name.

Return type:

str

property addresses¶

Address of the vendor.

Return type:

tuple[str]

property phones¶

Phone number(s).

Return type:

tuple[str]

property faxes¶

Fax number(s).

Return type:

tuple[str]

property mail_addresses¶

eMail address(es).

Return type:

tuple[str]

property web_addresses¶

Web address(es).

Return type:

tuple[str]

class ScriptDeviceDescription.ScriptDeviceFamily¶

Bases: object

Family Id.

property family_id¶

Family Id.

Return type:

int

property parent_family¶

Parent family.

Return type:

str

property name¶

Family name.

Return type:

str

property description¶

Description of the family.

Return type:

str

property sub_families¶

Sub families of the family.

Return type:

tuple[ScriptDeviceFamily]