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