Skip to content

Commit e5b0db7

Browse files
SabolikSabol Martin
authored andcommitted
doc: extend configuration part.
- update pyvisadriver part - add: - tminstrument driver - tminstrumentpower driver - networkpyvisa resource - extend pyvisa resource usage Signed-off-by: Martin Sabol <martin.sabol@seznam.cz>
1 parent 2c44fe5 commit e5b0db7

1 file changed

Lines changed: 76 additions & 3 deletions

File tree

doc/configuration.rst

Lines changed: 76 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1330,20 +1330,43 @@ Such device could be a signal generator.
13301330

13311331
.. code-block:: yaml
13321332
1333-
PyVISADevice:
1334-
type: 'TCPIP'
1335-
url: '192.168.110.11'
1333+
- PyVISADevice:
1334+
name: lxi_instrument
1335+
type: 'TCPIP'
1336+
url: '192.168.110.11'
1337+
backend: '@py'
1338+
- PyVISADevice:
1339+
name: raw_socket_instrument
1340+
type: 'TCPIP'
1341+
resource: 'SOCKET'
1342+
url: '192.168.110.12'
1343+
backend: '@py'
1344+
- PyVISADevice:
1345+
name: usbtmc_instrument
1346+
type: 'USB0'
1347+
url: '6833::3220::DM3O224500792::0'
1348+
backend: '@py'
1349+
- PyVISADevice:
1350+
name: serial_instrument
1351+
type: 'ASRL/dev/ttyACM0'
1352+
backend: '@py'
13361353
13371354
Arguments:
13381355
- type (str): device resource type following the PyVISA resource syntax, e.g.
13391356
ASRL, TCPIP...
13401357
- url (str): device identifier on selected resource, e.g. <ip> for TCPIP
13411358
resource
1359+
- resource (str): VISA resource type (default is ``INSTR``), ``INSTR``, ``SOCKET`` or ``RAW``.
13421360
- backend (str): optional, Visa library backend, e.g. '@sim' for pyvisa-sim backend
13431361

13441362
Used by:
13451363
- `PyVISADriver`_
13461364

1365+
NetworkPyVISADevice
1366+
~~~~~~~~~~~~~~~~~~~~~~
1367+
A :any:`NetworkPyVISADevice` describes a `PyVISADevice`_ resource
1368+
available on a remote computer.
1369+
13471370
HTTPVideoStream
13481371
~~~~~~~~~~~~~~~
13491372
An :any:`HTTPVideoStream` resource describes an IP video stream over HTTP or HTTPS.
@@ -3388,13 +3411,63 @@ equipment manageable by PyVISA.
33883411
Binds to:
33893412
pyvisa_resource:
33903413
- `PyVISADevice`_
3414+
- `NetworkPyVISADevice`_
3415+
3416+
.. code-block:: yaml
3417+
3418+
PyVISADriver: {}
33913419
33923420
Implements:
33933421
- None yet
33943422

33953423
Arguments:
33963424
- None
33973425

3426+
TMInstrumentDriver
3427+
~~~~~~~~~~~~~~~~~~
3428+
The :any:`TMInstrument` uses a low-level drivers to control SCPI compatible test and measurement instruments.
3429+
3430+
Binds to:
3431+
pyvisa_resource:
3432+
- `PyVISADriver`_
3433+
- `USBTMCDriver`_
3434+
3435+
.. code-block:: yaml
3436+
3437+
TMInstrument: {}
3438+
3439+
Implements:
3440+
- None yet
3441+
3442+
Arguments:
3443+
- None
3444+
3445+
TMInstrumentPowerDriver
3446+
~~~~~~~~~~~~~~~~~~~~~~~
3447+
The :any:`TMInstrumentPower` uses a `PyVISADevice`_ resource to
3448+
control a programmable power supply.
3449+
3450+
Binds to:
3451+
sigrok:
3452+
- `PyVISADevice`_
3453+
- `NetworkPyVISADevice`_
3454+
3455+
Implements:
3456+
- :any:`PowerProtocol`
3457+
- :any:`ResetProtocol`
3458+
3459+
.. code-block:: yaml
3460+
3461+
TMInstrumentPower:
3462+
delay: 3.0
3463+
3464+
Arguments:
3465+
- delay (float, default=3.0): delay in seconds between off and on
3466+
- max_voltage (float): optional, maximum allowed voltage for protection against
3467+
accidental damage (in volts)
3468+
- max_current (float): optional, maximum allowed current for protection against
3469+
accidental damage (in ampere)
3470+
33983471
NetworkInterfaceDriver
33993472
~~~~~~~~~~~~~~~~~~~~~~
34003473
The :any:`NetworkInterfaceDriver` allows controlling a network interface (such

0 commit comments

Comments
 (0)