Skip to content

Commit

Permalink
ad53xx: fix load() references in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Spaqin authored and sbourdeauducq committed Oct 16, 2023
1 parent 81d2b37 commit 9a3f6f8
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions artiq/coredevice/ad53xx.py
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ def write_offset_dacs_mu(self, value):
def write_gain_mu(self, channel, gain=0xffff):
"""Program the gain register for a DAC channel.
The DAC output is not updated until LDAC is pulsed (see :meth load:).
The DAC output is not updated until LDAC is pulsed (see :meth:`load`).
This method advances the timeline by the duration of one SPI transfer.
:param gain: 16-bit gain register value (default: 0xffff)
Expand All @@ -245,7 +245,7 @@ def write_gain_mu(self, channel, gain=0xffff):
def write_offset_mu(self, channel, offset=0x8000):
"""Program the offset register for a DAC channel.
The DAC output is not updated until LDAC is pulsed (see :meth load:).
The DAC output is not updated until LDAC is pulsed (see :meth:`load`).
This method advances the timeline by the duration of one SPI transfer.
:param offset: 16-bit offset register value (default: 0x8000)
Expand All @@ -258,7 +258,7 @@ def write_offset(self, channel, voltage):
"""Program the DAC offset voltage for a channel.
An offset of +V can be used to trim out a DAC offset error of -V.
The DAC output is not updated until LDAC is pulsed (see :meth load:).
The DAC output is not updated until LDAC is pulsed (see :meth:`load`).
This method advances the timeline by the duration of one SPI transfer.
:param voltage: the offset voltage
Expand All @@ -270,7 +270,7 @@ def write_offset(self, channel, voltage):
def write_dac_mu(self, channel, value):
"""Program the DAC input register for a channel.
The DAC output is not updated until LDAC is pulsed (see :meth load:).
The DAC output is not updated until LDAC is pulsed (see :meth:`load`).
This method advances the timeline by the duration of one SPI transfer.
"""
self.bus.write(
Expand All @@ -280,7 +280,7 @@ def write_dac_mu(self, channel, value):
def write_dac(self, channel, voltage):
"""Program the DAC output voltage for a channel.
The DAC output is not updated until LDAC is pulsed (see :meth load:).
The DAC output is not updated until LDAC is pulsed (see :meth:`load`).
This method advances the timeline by the duration of one SPI transfer.
"""
self.write_dac_mu(channel, voltage_to_mu(voltage, self.offset_dacs,
Expand Down Expand Up @@ -313,7 +313,7 @@ def set_dac_mu(self, values, channels=list(range(40))):
If no LDAC device was defined, the LDAC pulse is skipped.
See :meth load:.
See :meth:`load`.
:param values: list of DAC values to program
:param channels: list of DAC channels to program. If not specified,
Expand Down Expand Up @@ -355,7 +355,7 @@ def calibrate(self, channel, vzs, vfs):
""" Two-point calibration of a DAC channel.
Programs the offset and gain register to trim out DAC errors. Does not
take effect until LDAC is pulsed (see :meth load:).
take effect until LDAC is pulsed (see :meth:`load`).
Calibration consists of measuring the DAC output voltage for a channel
with the DAC set to zero-scale (0x0000) and full-scale (0xffff).
Expand Down

0 comments on commit 9a3f6f8

Please sign in to comment.