M-Labs
/
artiq
mirror of https://github.com/m-labs/artiq.git
2
0
Fork 2
Code Issues Projects Releases Wiki Activity

coredevice/suservo: Fix output IIR state width in docstring

This commit is contained in:
David Nadlinger 2019-06-20 17:42:24 +01:00 committed by Robert Jördens
parent 34f48f57cc
commit 8bf9640185
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
artiq/coredevice/suservo.py
View File

@ -450,12 +450,12 @@ class Channel:
"""Get a profile's IIR state (filter output, Y0) in machine units. """Get a profile's IIR state (filter output, Y0) in machine units.
The IIR state is also know as the "integrator", or the DDS amplitude The IIR state is also know as the "integrator", or the DDS amplitude
scale factor. It is 18 bits wide and unsigned. scale factor. It is 17 bits wide and unsigned.
This method does not advance the timeline but consumes all slack. This method does not advance the timeline but consumes all slack.
:param profile: Profile number (0-31) :param profile: Profile number (0-31)
:return: 18 bit unsigned Y0 :return: 17 bit unsigned Y0
""" """
return self.servo.read(STATE_SEL | (self.servo_channel << 5) | profile) return self.servo.read(STATE_SEL | (self.servo_channel << 5) | profile)
@ -464,7 +464,7 @@ class Channel:
"""Get a profile's IIR state (filter output, Y0). """Get a profile's IIR state (filter output, Y0).
The IIR state is also know as the "integrator", or the DDS amplitude The IIR state is also know as the "integrator", or the DDS amplitude
scale factor. It is 18 bits wide and unsigned. scale factor. It is 17 bits wide and unsigned.
This method does not advance the timeline but consumes all slack. This method does not advance the timeline but consumes all slack.
@ -478,7 +478,7 @@ class Channel:
"""Set a profile's IIR state (filter output, Y0) in machine units. """Set a profile's IIR state (filter output, Y0) in machine units.
The IIR state is also know as the "integrator", or the DDS amplitude The IIR state is also know as the "integrator", or the DDS amplitude
scale factor. It is 18 bits wide and unsigned. scale factor. It is 17 bits wide and unsigned.
This method must not be used when the servo could be writing to the This method must not be used when the servo could be writing to the
same location. Either deactivate the profile, or deactivate IIR same location. Either deactivate the profile, or deactivate IIR
@ -498,7 +498,7 @@ class Channel:
"""Set a profile's IIR state (filter output, Y0). """Set a profile's IIR state (filter output, Y0).
The IIR state is also know as the "integrator", or the DDS amplitude The IIR state is also know as the "integrator", or the DDS amplitude
scale factor. It is 18 bits wide and unsigned. scale factor. It is 17 bits wide and unsigned.
This method must not be used when the servo could be writing to the This method must not be used when the servo could be writing to the
same location. Either deactivate the profile, or deactivate IIR same location. Either deactivate the profile, or deactivate IIR