Drivers: Difference between revisions

From SweepMe! Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
A Device Class is a library file allowing you to include and use any device with SweepMe!. It basically is a small code snippet called '''main.py''' written in the programming language python 3.6 (https://www.python.org/). All Device Classes can be found in the folder DeviceClasses of the SweepMe! installation.  
Several Modules can load Devices and they are represented by Device Classes which are small python based code snippets allowing you to include and use any equipment with SweepMe!. It basically is a file called '''main.py''' written in the programming language python 3.6 (https://www.python.org/). All Device Classes can be found in the folder Devices of the SweepMe! installation.  


== Download ==
== Download ==


=== Device manager ===
=== Version 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.
You can download or update Devices via the Version Manager which is part of the SweepMe! installation. (>= v.1.5.4 needed)


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 ===
=== 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.
Click the link "Devices" on the left side of this page and you will come to a list of all available Devices. You can download the Device directly as a zip-folder and you only need to unzip the Device Class into your local "Devices" folder of your SweepMe! installation.
 
== Upload ==
 
To make SweepMe! a powerful tool, we are relying on you! Help us to build up a large library of Devices. Implement your own Device Classes and upload your files to our webpage. Contact us and request an account. Using the dashboard, you can upload, manage, and share your Devices with other users.




Line 44: Line 47:


You can open any Device Class out of SweepMe! in an included notepad++ editor. Any change to the Device Class will automatically affect its operation after saving the file. If you like to try some modifications, we recommend to create a copy of the respective Device Class folder and rename it by keeping the same folder name structure as given above.
You can open any Device Class out of SweepMe! in an included notepad++ editor. Any change to the Device Class will automatically affect its operation after saving the file. If you like to try some modifications, we recommend to create a copy of the respective Device Class folder and rename it by keeping the same folder name structure as given above.
== Upload your Device Class ==
To make SweepMe! a powerful tool, we are relying on you! Help us to build up a large library of Device Classes. Implement your own Device Classes and upload your files to our webpage. Contact us and you get an account over which you can create a new Device Class available for everyone to download.

Revision as of 22:20, 5 August 2019

Several Modules can load Devices and they are represented by Device Classes which are small python based code snippets allowing you to include and use any equipment with SweepMe!. It basically is a file called main.py written in the programming language python 3.6 (https://www.python.org/). All Device Classes can be found in the folder Devices of the SweepMe! installation.

Download

Version manager

You can download or update Devices via the Version Manager which is part of the SweepMe! installation. (>= v.1.5.4 needed)


Direct download

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

Upload

To make SweepMe! a powerful tool, we are relying on you! Help us to build up a large library of Devices. Implement your own Device Classes and upload your files to our webpage. Contact us and request an account. Using the dashboard, you can upload, manage, and share your Devices with other users.


Structure

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

<Type of the Module>-<Name of the manufacturer>_<Name of the device model>

Examples:

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

The <Type of the Module> must be related to the Modules provided by SweepMe! and every Module 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 new Device Classes

You can implement Device Classes on your own into SweepMe!:

1.) Use the Device Class Assistant

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

3.) Go to Device Class Programming and learn how it works.


Open/Modify

You can open any Device Class out of SweepMe! in an included notepad++ editor. Any change to the Device Class will automatically affect its operation after saving the file. If you like to try some modifications, we recommend to create a copy of the respective Device Class folder and rename it by keeping the same folder name structure as given above.