python module for communicating via nanonis TCP protocal
Project description
nanonisTCP
Python module for communicating to nanonis via TCP. I am actively developing this so if you have any requests or find any bugs, feel free to raise an issue.
Installing
Clone this repository, navigate to said directory, and run:
pip install .
Using
The following code demonstrates how to change tip bias.
from nanonisTCP import nanonisTCP
from nanonisTCP.Bias import Bias
TCP_IP = '127.0.0.1' # Local host
TCP_PORT= 6501 # Check available ports in NANONIS > File > Settings Options > TCP Programming Interface
NTCP = nanonisTCP(TCP_IP, TCP_PORT) # This is how you establish a TCP connection. NTCP is the connection handle.
bias = Bias(NTCP) # Nanonis Bias Module - Pass in the connection handle
bias.Set(1.1) # Set bias to 1.1 V
v = bias.Get() # Get the current bias
print("Bias: " + str(v) + " V") # Confirm bias has been set
NTCP.close_connection() # Close the connection.
See any of the xxxTest.py scripts to see how each module can be implemented in more detail
Citing
If you use nanonisTCP, please consider citing it: 10.5281/zenodo.7402664
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
nanonisTCP-0.1.0.tar.gz
(44.2 kB
view hashes)
Built Distribution
nanonisTCP-0.1.0-py3-none-any.whl
(58.9 kB
view hashes)
Close
Hashes for nanonisTCP-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 95ef0b6886e03da77522b2db68092cc0e9acef8ee5a53fd19ae1c4205a81a3cc |
|
MD5 | 150e6975df714c2b99924e7984401901 |
|
BLAKE2b-256 | fd6582897f6860115e44a103e008f37cd3e620441254100205751eb931fb9d00 |