Update README.md
This commit is contained in:
parent
b4f8b89d49
commit
9bd4a670a9
25
README.md
25
README.md
@ -1,2 +1,27 @@
|
||||
# MeasKit
|
||||
MeasKit is a python package for efficiently making control classes for test equipment operating on PyVisa.
|
||||
The classes can be largely described in simplistic markdown files and with very little structure a skeleton clas can be generated.
|
||||
|
||||
## How to create a markdown file
|
||||
The markdown files are broken down in the following sections denoted by a single '#':
|
||||
```
|
||||
# LIBRARY COMMANDS
|
||||
# SETTEABLE PARAMETERS
|
||||
# GETTEABLE PARAMETERS
|
||||
# GETSETTEABLE PARAMETERS
|
||||
```
|
||||
|
||||
Under library commands custom chains of multiple commands can be defined such as:
|
||||
```
|
||||
# LIBRARY COMMANDS
|
||||
|
||||
- CONF_CHANNEL(channel,state,range,bandwidth,coupling)
|
||||
1. recalls measured samples in the background and recall from memory
|
||||
2. RMEM(1,nsamples)
|
||||
3. READ
|
||||
```
|
||||
every command started with a '-'. Within every command you can use 3 numbers
|
||||
1 being a description
|
||||
2 being a generic command
|
||||
3 being a command with a return for the function
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user