Show Menu
Cheatography

PyVisaSim YAML Aint Markup Language (yaml) Format Cheat Sheet (DRAFT) by

YAML file format used in PyVisaSim's device simulators.

This is a draft cheat sheet. It is a work in progress and is not finished yet.

Version

spec: "­"
File Version
float

 Devices

Syntax
Type
Descri­ption
devices:
list
All Devices
 ­ device:
list
Device
 ­ ­ ­ eom:
list
End of Messages
 ­ ­ ­ ­ ­ 
protocol:
resource
Resource Type
 ­ ­ ­ ­ ­ 
q: "­"
str
Write Termin­ation
 ­ ­ ­ ­ ­ 
r: "­"
str
Read Termin­ation
 ­ ­ ­ dialogues:
list
Commun­ication
 ­ ­ ­ ­ ­ 
- q: "­"
str
Command
 ­ ­ ­ ­ ­ 
r: "­"
str
Response
 ­ ­ ­ error:
list
Errors
 ­ ­ ­ ­ ­ 
errortype:
list
Type
 ­ ­ ­ ­ ­ 
- q: "­"
str
Value
 ­ ­ ­ ­ ­ 
default: "­"
str
Default
 ­ ­ ­ ­ ­ 
comman­d_e­rror: "­"
str
Command Error
 ­ ­ ­ ­ ­ 
query_­error: "­"
str
Query Error
 ­ ­ ­ proper­ties:
list
Properties
 ­ ­ ­ ­ ­ ­pro­per­tyname:
list
Name
 ­ ­ ­ ­ ­ ­ ­ 
default:
any
Default
 ­ ­ ­ ­ ­ ­ ­ 
getter:
list
Getters
 ­ ­ ­ ­ ­ ­ ­ ­ ­ 
q: "­"
str
Query
 ­ ­ ­ ­ ­ ­ ­ ­ ­ 
r: "­"
str
Response
 ­ ­ ­ ­ ­ ­ ­ 
setter:
list
Setters
 ­ ­ ­ ­ ­ ­ ­ ­ ­ 
q: "­"
str
Query
 ­ ­ ­ ­ ­ ­ ­ ­ ­ 
r: "­"
str
Response (Optional)
 ­ ­ ­ ­ ­ ­ ­ ­ ­ 
e: "­"
str
Error (Optional)
 ­ ­ ­ ­ ­ ­ ­ 
specs:
list
Attributes
 ­ ­ ­ ­ ­ ­ ­ ­ ­ 
min:
any
Minimum
 ­ ­ ­ ­ ­ ­ ­ ­ ­ 
max:
any
Maximum
 ­ ­ ­ ­ ­ ­ ­ ­ ­ 
type:
type
Type
 ­ ­ ­ ­ ­ ­ ­ ­ ­ 
valid: []
list
Values (Optional)
resources:
list
Addresses
 ­ address:
list
Address
 ­ ­ ­ ­device: device1
device
Address Assign
 ­ ­ ­ ­fil­ename: dev.yaml
filename
External File
 ­ ­ ­ ­bun­dled: false
bool
Stock

dfsg

 

s

 

a

a
a

newstuff

spec: "­1.1­"
devices:
BH15:
eom:
GPIB INSTR:
q: "­\0"
r: "­\n"
dialogues:
- q: "­OUT­P?1­"
r: "­1.0­"
error:
error_­queue:
- q: "­que­ue"
default: "­fal­se"
comman­d_e­rror: "­set­_qu­eue­"
query_­error: "­get­_qu­eue­"
proper­ties:
parity:
default: 0
getter:
q: "­get­par­ity­"
r: "­get­par­ity­"
setter:
q: "­set­par­ity­"
r: "­set­par­ity­"
specs:
min: 0
max: 255
type: int
valid: range(min, max, 1)
resources:
GPIB0:­:1:­:INSTR:
device: BH15
filename: bh15.yaml
bundled: false

Spec

spec: " "
str(float)
File Version

Exam­ple

e: "­​pa­r​i­ty​­err­or"