Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mariusgreuel committed Oct 31, 2024
1 parent e025c06 commit b3106a8
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@

**DwfPy** is a Python package that allows you to access **Digilent WaveForms** devices via Python. It provides a low-level API with complete access to the Digilent WaveForms API, and also a simple but powerful high-level API, which allows you to configure WaveForms devices with a single statement.

For instance, to output a 1kHz sine-wave on a **Analog Discovery 2**, you can simply write:
For instance, to output a 1kHz sine-wave on an **Analog Discovery**, you can simply write:

```python
import dwfpy as dwf

with dwf.AnalogDiscovery2() as device:
with dwf.Device() as device:
print('Generating a 1kHz sine wave on WaveGen channel 1...')
device.analog_output['ch1'].setup('sine', frequency=1e3, amplitude=1, start=True)
input('Press Enter key to exit.')
Expand Down
4 changes: 2 additions & 2 deletions docs/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ It provides a low-level API with complete access to the Digilent WaveForms API,
and also a simple but powerful high-level API,
which allows you to configure WaveForms devices with a single statement.

For instance, to output a 1kHz sine-wave on a **Analog Discovery 2**, you can simply write:
For instance, to output a 1kHz sine-wave on an **Analog Discovery**, you can simply write:

.. code-block::
import dwfpy as dwf
with dwf.AnalogDiscovery2() as device:
with dwf.Device() as device:
print('Generating a 1kHz sine wave on WaveGen channel 1...')
device.analog_output['ch1'].setup('sine', frequency=1e3, amplitude=1, start=True)
input('Press Enter key to exit.')
Expand Down

0 comments on commit b3106a8

Please sign in to comment.