Python bindings for the official Linkam SDK
Project description
pylinkam
This Python module provides Python bindings for the official C/C++ Linkam SDK. It enables monitoring and control of various instruments provided by Linkam. Can optionally be used with the pint package to handle unit conversion.
Installation
Note that the Linkam SDK binary files (LinkamSDK_release.dll
or LinkamSDK_debug.dll
) and the required license file (typically Linkam.lsk
) are not distributed as part of this module.
By default the module will look for the Linkam SDK dll using the $PATH
environment variable, appending the module directory before searching.
- If necessary rename
LinkamSDK.dll
(used in recent versions) toLinkamSDK_release.dll
- Place
LinkamSDK_release.dll
(orLinkamSDK_debug.dll
) andLinkam.lsk
files inside thepylinkam
module folder (the one that contains__init__.py
) - Run
demo.py
to check for any issues. This will set the stage temperature to 25°C temporarily.
Usage
Initialise the SDK by creating an instance of pylinkam.sdk.SDKWrapper
providing optional paths for SDK binary files and the license file. Once initialised, use the connect()
method to create a context manager for the connection to a device.
Example
from pylinkam import interface, sdk
with sdk.SDKWrapper() as wrapper:
with wrapper.connect() as connection:
print(f"Name: {connection.get_controller_name()}")
Tested Devices
This library has been developed for the following Linkam instruments/addons, a check indicated that functionality has been verified on working hardware:
- T96 System Controller (via USB)
- T96 System Controller (via RS-232, this might work :shrug:)
- HFS600E-PB4 Probe Stage
- RH95 Humidity Controller
- LNP96 Cooling Option (should work)
Only tested under Windows 10 using LinkamSDK v3.0.5.5
and v3.0.15.35
. In theory the SDK binary files for Linux should have identical mappings, but this hasn't been tested.
Acknowledgments
Developed at Swinburne University of Technology. If used in an academic project, please consider citing this work as it helps attract funding and track research outputs:
C. J. Harrison and M. Shafiei. pylinkam. (2022). [Online]. doi: https://doi.org/10.5281/zenodo.6758012
This activity received funding from ARENA as part of ARENA’s Research and Development Program – Renewable Hydrogen for Export (Contract No. 2018/RND012). The views expressed herein are not necessarily the views of the Australian Government, and the Australian Government does not accept responsibility for any information or advice contained herein.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.