Drivers: Difference between revisions

From SweepMe! Wiki
Jump to navigation Jump to search
(start)
No edit summary
Line 1: Line 1:
A Device Class is small piece of code allowing you to implement devices on your own. It is a file written in the programming language python 2.7 (https://www.python.org/).
A Device Class is small piece of code allowing you to use any device. It basically is a small code snippet/library written in the programming language python 2.7 (https://www.python.org/). All Device Classes can be found in the folder DeviceClasses of the SweepMe! installation.  


All Device Classes can be found in the folder DeviceClasses of the SweepMe! installation.
== Download ==


Each Device Class can be found in a further folder of the following folder name structure:
=== Device manager ===
You can download Device Classes via the device-manager.exe which you can find in your SweepMe! installation. Please close SweepMe! beforehand. The [[device manager]] lists all online available Device Classes which have been uploaded to our server. Check all Device Classes you need and press "Install/Update" to download them to your local Device Class folder.


<Type of the Measurement Class>-<Name of the manufacturer>_<Name of the device model>
The device manager will automatically store your previous Device class version so that you can swap back if something does not work as expected after an update.
 
=== Direct download ===
Click the link "Supported Devices" on the left side of this page and you will come to a list of all available Device Classes. You can download the Device Class directly as a zip-folder and you only need to unzip the Device Class into your local "DeviceClasses" folder of your SweepMe! installation.
 
 
== Structure ==
 
Each Device Class file can be found in a folder of the following folder name structure:
 
'''<Type of the Measurement Class>-<Name of the manufacturer>_<Name of the device model>'''


Examples:
Examples:
Line 17: Line 28:


The [[Device Class Structure]] provides various standard functions which can be used at certain points during the run of the measurement sequence.
The [[Device Class Structure]] provides various standard functions which can be used at certain points during the run of the measurement sequence.
== Creating Device Classes ==
You implement Device Classes on your own to implement your own equipment into SweepMe!
1.) Use the [[Device Class Assistant]]
2.) Copy another Device Class of your SweepMe! installation of the same type of [[Measurement Class]] you are aiming for and modify it according to your needs
3.) Start with a [[minimal example|Device Class Structure]] and add further functions as supported by SweepMe!. See [[Sequencer procedure]] for a full list.
=== Open/Modify ===
=== Upload your Device Class ===

Revision as of 10:38, 12 November 2017

A Device Class is small piece of code allowing you to use any device. It basically is a small code snippet/library written in the programming language python 2.7 (https://www.python.org/). All Device Classes can be found in the folder DeviceClasses of the SweepMe! installation.

Download

Device manager

You can download Device Classes via the device-manager.exe which you can find in your SweepMe! installation. Please close SweepMe! beforehand. The device manager lists all online available Device Classes which have been uploaded to our server. Check all Device Classes you need and press "Install/Update" to download them to your local Device Class folder.

The device manager will automatically store your previous Device class version so that you can swap back if something does not work as expected after an update.

Direct download

Click the link "Supported Devices" on the left side of this page and you will come to a list of all available Device Classes. You can download the Device Class directly as a zip-folder and you only need to unzip the Device Class into your local "DeviceClasses" folder of your SweepMe! installation.


Structure

Each Device Class file can be found in a folder of the following folder name structure:

<Type of the Measurement Class>-<Name of the manufacturer>_<Name of the device model>

Examples:

  • SMU-Keithley_2400
  • LCRmeter-HP_4284A
  • Logger-PC_Mouse

The <Type of the Measurement Class> must be related to the Measurement Classes provided by SweepMe! and every Measurement Class provides different functionality to control a certain type of equipment.

The Device Class itself is a file which always has the name "main.py" and which can load further python modules, [dll]s, or simply text files as needed to get your Device Class working.

The Device Class Structure provides various standard functions which can be used at certain points during the run of the measurement sequence.


Creating Device Classes

You implement Device Classes on your own to implement your own equipment into SweepMe!

1.) Use the Device Class Assistant

2.) Copy another Device Class of your SweepMe! installation of the same type of Measurement Class you are aiming for and modify it according to your needs

3.) Start with a Device Class Structure and add further functions as supported by SweepMe!. See Sequencer procedure for a full list.


Open/Modify

Upload your Device Class