class
ScriptDeviceDescription.
ScriptDeviceCollection
iterable=()
/
Bases: list
A collection of ScriptDeviceDescription objects.
property
vendors
Gets the list of all vendors in the collection.
tuple[int]
get_devices_of_vendor
vendor
Get all devices in the list which match the specified vendor.
vendor (str) – Vendor name.
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.
DeviceID
DeviceID
property
device_info
Get information about the device.
ScriptDeviceInfo
DeviceInfo
property
connectors
Gets the connectors.
ScriptDeviceConnectorSet
DeviceConnectorSet
property
name
Internationalized name of the device.
str
property
description
Internationalized description of the device.
str
property
vendor
Internationalized vendor of the device vendor.
str
property
categories
Gets a list of categories this device belongs to.
tuple[int]
property
families
Gets a list of vendor-specific families this device belongs to.
Each string has got the format VendorId:FamilyId.
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>\ |
str
property
order_number
Vendor specific order number for this device.
str
property
default_instance_name
The default intance name for this device.
3.5.11.0
str
class
ScriptDeviceDescription.
ScriptVendorDescription
Bases: object
Vendor description.
property
vendor_id
Id of the vendor.
int
property
version
Version.
str
property
vendor_info
Vendor information.
property
families
Get all families of the vendor.
tuple[ScriptDeviceFamily]
get_family
family_id
Get the family with the specified family Id.
family_id (int) – Family Id.
Device family object or None if there is no matching family.
class
ScriptDeviceDescription.
ScriptVendorInfo
Bases: object
Vendor information.
property
name
Vendor name.
str
property
addresses
Address of the vendor.
tuple[str]
property
phones
Phone number(s).
tuple[str]
property
faxes
Fax number(s).
tuple[str]
property
mail_addresses
eMail address(es).
tuple[str]
property
web_addresses
Web address(es).
tuple[str]
class
ScriptDeviceDescription.
ScriptDeviceFamily
Bases: object
Family Id.
property
family_id
Family Id.
int
property
parent_family
Parent family.
str
property
name
Family name.
str
property
description
Description of the family.
str
property
sub_families
Sub families of the family.
tuple[ScriptDeviceFamily]