diff --git a/readme.md b/readme.md index e9d3b40..6afd24f 100644 --- a/readme.md +++ b/readme.md @@ -1,15 +1,25 @@ -# TENG scripts -Helper scripts for measuring TENG-based sensor output from a Keithley 2611B using pyvisa in a jupyter notebook -## Requirements +# K-TENG +Helper scripts for measuring **T**ribo**e**lectric **N**ano**g**enerator-based sensor output with a Keithley 2611B SMU using pyvisa + +## Features +### Useful functions for scripts - Measure Voltage - Measure Voltage and Current - Save to host +- run lua script +- auto-filenames +### Interactive (shell) mode - Live view -- autofilenames - press buttons for start and fin - settings: - interval - count -- run arbitrary command -- run lua script +- easily run arbitrary command on device +## Shell mode +Start with: +```python +ipython -i k_teng_interactive.py +``` + +Use `help()` to get a list of available commands