class
ScriptDeviceRepository.
ScriptDeviceRepository
Bases: object
sources
Get the repository sources of the device repository.
Return type
create_device_identification
type
id
version
create_module_identification
type
id
version
module_id
import_device
source
stream=None
path=None
source_path=None
save_device_cache=True
converter_factory_guid=None
Import a device description file into a repository.
Warning
The original C# function that is called with this method contains 3 overloads. It is strongly advised to pass all arguments with their respective keywords. stream, path, and source_path are not actually optional, they just aren't required in every overload. Pass them if your overload needs them!
import_device(stream, source, source_path, save_device_cache=True) (1/3)
Parameters
stream (System.IO.Stream) -- The stream that contains the device description. This must be a valid device description file. Other types of device descriptions must be imported by special plug-ins.
source (ScriptRepositorySource) -- The repository source where the device should be stored. This parameter may be None, in which case the default repository source is used. The repository source must be one of the sources defined in sources.
source_path (str) -- Sourcepath for the import. Relative file references inside the device description are resolved relative to this source path. May be empty, if the device description contains only absolute file references.
save_device_cache (bool) -- If True, after removing the device the device cache is also written. If False, the device cache is not written. If many devices are removed, this is much faster.
Return type
DeviceId
Returns
The ID of the imported device description.
import_device(path, source, save_device_cache=True) (2/3)
Import a device description file into a repository.
Parameters
path (str) -- The file that contains the device description. This must be a valid device description file. Other types of device descriptions must be imported by special plug-ins.
source (ScriptRepositorySource) -- The repository source where the device should be stored. This parameter may be None, in which case the default repository source is used. The repository source must be one of the sources defined in sources.
save_device_cache (bool) -- If True, after removing the device the device cache is also written. If False, the device cache is not written. If many devices are removed, this is much faster.
Return type
DeviceId
Returns
The ID of the imported device description.
import_device(path, source, converter_factory_guid, save_device_cache=True) (3/3)
Convert a foreign device description file and import the result into a repository.
List of known converter factories:
|
{C633F245-876F-45E8-AAB4-3FBD994C08B8} |
Use as default because all available converters are tried |
|
{3992C588-7BDB-4A7C-908D-F444808D8CD2} |
XML files of EtherCAT |
|
{6066AEF4-F19A-41ac-A249-721BDAE32D40} |
GSDML files of Profinet IO |
|
{CDDE0374-9EFD-401e-93C8-F19443FB60ED} |
XML files of Sercos3 |
|
{1ce4a9c1-37d3-496c-9e80-cd99ad3807ee} |
EDS files of CANbus |
Parameters
path (str) -- The file that contains the device description. This must be a valid device description file. Other types of device descriptions must be imported by special plug-ins.
source (ScriptRepositorySource) -- The repository source where the device should be stored. This parameter may be None, in which case the default repository source is used. The repository source must be one of the sources defined in sources.
converter_factory_guid (str) -- The guid of the converter to import a foreign device description. For example CANopen EDS files.
save_device_cache (bool) -- If True, after removing the device the device cache is also written. If False, the device cache is not written. If many devices are removed, this is much faster.
Return type
DeviceId
Returns
The ID of the imported device description.
import_vendor_description
source
stream=None
path=None
source_path=None
Import a device description file into a repository.
Warning
The original C# function that is called with this method contains 2 overloads. It is strongly advised to pass all arguments with their respective keywords. stream, path, and source_path are not actually optional, they just aren't required in every overload. Pass them if your overload needs them!
import_vendor_description(stream, source, source_path) (1/2)
Parameters
stream (System.IO.Stream) -- The stream that contains the vendor description. This must be a valid vendor description file. Other types of vendor descriptions must be imported by special plug-ins.
source (ScriptRepositorySource) -- The repository source where the device should be stored. This parameter may be None, in which case the default repository source is used. The repository source must be one of the sources defined in sources.
source_path (str) -- Sourcepath for the import. Relative file references inside the vendor description are resolved relative to this source path. May be empty, if the vendor description contains only absolute file references.
Return type
ScriptVendorDescription
Returns
The imported vendor description.
import_vendor_description(path, source) (2/2)
Parameters
path (str) -- The file that contains the vendor description. This must be a valid vendor description file.
source (ScriptRepositorySource) -- The repository source where the device should be stored. This parameter may be None, in which case the default repository source is used. The repository source must be one of the sources defined in sources.
Return type
ScriptVendorDescription
Returns
The imported vendor description.
remove_device
device_id
source
save_device_cache=True
Remove a device from the specified repository source.
Parameters
device_id (DeviceId) -- Defines the device to remove.
source (ScriptRepositorySource) -- Remove the device from this repository source. If None the device is removed from the default repository source.
save_device_cache (bool) -- If True, after removing the device the device cache is also written. If False, the device cache is not written. If many devices are removed, this is much faster.
remove_vendor_description
vendor_id
source
Remove a vendor description from the specified repository source.
Parameters
device_id (int) -- The vendor id.
source (ScriptRepositorySource) -- Remove the device from this repository source. If None the device is removed from the default repository source.
save_device_cache
Saves the current devices in the device cache. Could be used to force it after adding or removing many devices.
rebuild_device_cache
Rebuild the device cache.
The device cache is deleted, initialized and saved.
get_device_category
category_id
This overload is called when category_id is of type int.
Get the device category with the specified device category ID.
Parameters
category_id (int) -- The device category ID of the device category implementation. This value corresponds to the DeviceDescription/DeviceInfo/Category tags of the device description file.
Return type
Returns
The requested device category, or None if the device category does not exist.
This overload is called when category_id is of type Guid:
Get the device category with the specified type GUID.
Parameters
category_id (Guid) -- The type GUID of the device category implementation.
Return type
Returns
The requested device category, or None if the device category does not exist.
get_device_family
family
Device family.
Parameters
family (str) -- VendorID:FamilyID.
Return type
ScriptDeviceFamily
get_all_devices
name=None
device_id=None
source=None
Get a collection containing all devices in the repository.
Warning
The original C# function that is called with this method contains 5 overloads. It is strongly advised to pass all arguments with their respective keywords.
get_all_devices() (1/5)
Devices which are installed in more than one repository source are returned only once.
Return type
Returns
A device collection containing the current result of the query.
get_all_devices(device_id) (2/5)
Get a collection containing all devices in the repository, including local modules of device_id
Parameters
device_id (DeviceId) -- The id of the device that provides the context for the local modules.
Return type
Returns
A device collection containing the current result of the query.
get_all_devices(source) (3/5)
Get a collection containing all devices in the specified repository source.
Parameters
source (ScriptRepositorySource) -- The repository source to enumerate.
Return type
Returns
A device collection containing the current result of the query.
get_all_devices(device_id, source) (4/5)
Get a collection containing all devices in the specified repository source.
Parameters
device_id (DeviceId) -- The id of the device that provides the context for the local modules.
source (ScriptRepositorySource) -- The repository source to enumerate.
Return type
Returns
A device collection containing the current result of the query.
get_all_devices(name, source=None) (5/5)
Get all device which contain the specified name.
Parameters
name (str) -- Text which the name of the device has to contain.
source (ScriptRepositorySource) -- If not None, only this repository source will be searched.
Return type
tuple
Returns
A device tuple containing the current result of the query.
get_all_vendor_descriptions
source=None
Get a collection of all vendor descriptions in the repository.
Warning
The original C# function that is called with this method contains 2 overloads. It is strongly advised to pass all arguments with their respective keywords.
get_all_vendor_descriptions() (1/2)
Return type
PythonTuple
Returns
A collection of vendor descriptions.
get_all_vendor_descriptions(source) (2/2)
Get the vendor description with the specified vendor Id.
Parameters
source (ScriptRepositorySource) -- Repository source.
Return type
PythonTuple
Returns
A collection of vendor descriptions containing the current result of the query.
get_vendor_description
vendor_id
Get the vendor description with the specified vendor Id.
Parameters
vendor_id (int) -- Vendor Id.
Return type
Returns
The requested vendor description, or None if the vendor description does not exist.
class
ScriptDeviceRepository.
ScriptRepositorySourceList
Bases: list
A collection of ScriptRepositorySource objects.
add
name
location_url
Add a new repository source with the specified name.
Parameters
name (str) -- Name for the new source.
Return type
Returns
The added repository source.
remove
source
Remove an existing repository source.
Internal sources cannot be removed.
Parameters
source (ScriptRepositorySource) -- The repository source to remove.
move
source
index
Move an existing repository source to the specified location in the collection.
Parameters
source (ScriptRepositorySource) -- Existing repository source.
index (int) -- New index of the repository source.
class
ScriptDeviceRepository.
ScriptRepositorySource
Bases: object
name
Get or set the name of the repository source.
Return type
str
location_url
Get or set the location URL.
Return type
str
is_internal
Return whether the repository source is internal.
If true, then this repository source is an implicit source (like the project internal repository or the installation specific repository). Therefore its properties like name and location are readonly and may not be changed.
Return type
bool
class
ScriptDeviceRepository.
ScriptDeviceCategory
Bases: object
Category of devices.
Devices can be grouped into categories by means of the DeviceDescription/Device/DeviceInfo/Category tags of the device description file. One can implement a corresponding class of this interface to display these types in a user-friendly way.
category_id
Id of the category.
Return type
int
parent_category
The type GUID of the parent device category implementation, or Guid.Empty, if this device implementation is top-level.
Return type
Guid
name
Gets a user-friendly display name for this device category.
This string should be localized.
Return type
str
description
Gets a user-friendly description for this device category.
This string should be localized.
Return type
str
