occheung
/
artiq
forked from M-Labs/artiq
1
0
Fork 0
Code Pull Requests Activity

almazny: fix doc formatting

This commit is contained in:
Florian Agbuya 2023-09-04 16:06:33 +08:00 committed by Sébastien Bourdeauducq
parent 7f63bb322d
commit 4e770509db
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
artiq/coredevice/almazny.py
View File

@ -21,7 +21,7 @@ class AlmaznyLegacy:
This applies to Almazny hardware v1.1 and earlier. This applies to Almazny hardware v1.1 and earlier.
Use :class:`artiq.coredevice.almazny.AlmaznyChannel` for Almazny v1.2 and later. Use :class:`artiq.coredevice.almazny.AlmaznyChannel` for Almazny v1.2 and later.
:param host_mirny - Mirny device Almazny is connected to :param host_mirny: Mirny device Almazny is connected to
""" """
def __init__(self, dmgr, host_mirny): def __init__(self, dmgr, host_mirny):
@ -61,8 +61,9 @@ class AlmaznyLegacy:
def set_att(self, channel, att, rf_switch=True): def set_att(self, channel, att, rf_switch=True):
""" """
Sets attenuators on chosen shift register (channel). Sets attenuators on chosen shift register (channel).
:param channel - index of the register [0-3] :param channel - index of the register [0-3]
:param att_mu - attenuation setting in dBm [0-31.5] :param att - attenuation setting in dBm [0-31.5]
:param rf_switch - rf switch (bool) :param rf_switch - rf switch (bool)
""" """
self.set_att_mu(channel, self.att_to_mu(att), rf_switch) self.set_att_mu(channel, self.att_to_mu(att), rf_switch)
@ -71,6 +72,7 @@ class AlmaznyLegacy:
def set_att_mu(self, channel, att_mu, rf_switch=True): def set_att_mu(self, channel, att_mu, rf_switch=True):
""" """
Sets attenuators on chosen shift register (channel). Sets attenuators on chosen shift register (channel).
:param channel - index of the register [0-3] :param channel - index of the register [0-3]
:param att_mu - attenuation setting in machine units [0-63] :param att_mu - attenuation setting in machine units [0-63]
:param rf_switch - rf switch (bool) :param rf_switch - rf switch (bool)
@ -83,6 +85,7 @@ class AlmaznyLegacy:
def output_toggle(self, oe): def output_toggle(self, oe):
""" """
Toggles output on all shift registers on or off. Toggles output on all shift registers on or off.
:param oe - toggle output enable (bool) :param oe - toggle output enable (bool)
""" """
self.output_enable = oe self.output_enable = oe
@ -141,6 +144,7 @@ class AlmaznyChannel:
""" """
Convert an attenuation in dB, RF switch state and LED state to machine Convert an attenuation in dB, RF switch state and LED state to machine
units. units.
:param att: attenuator setting in dB (0-31.5) :param att: attenuator setting in dB (0-31.5)
:param enable: RF switch state (bool) :param enable: RF switch state (bool)
:param led: LED state (bool) :param led: LED state (bool)
@ -162,6 +166,7 @@ class AlmaznyChannel:
def set_mu(self, mu): def set_mu(self, mu):
""" """
Set channel state (machine units). Set channel state (machine units).
:param mu: channel state in machine units. :param mu: channel state in machine units.
""" """
self.mirny_cpld.write_ext( self.mirny_cpld.write_ext(
@ -171,6 +176,7 @@ class AlmaznyChannel:
def set(self, att, enable, led=False): def set(self, att, enable, led=False):
""" """
Set attenuation, RF switch, and LED state (SI units). Set attenuation, RF switch, and LED state (SI units).
:param att: attenuator setting in dB (0-31.5) :param att: attenuator setting in dB (0-31.5)
:param enable: RF switch state (bool) :param enable: RF switch state (bool)
:param led: LED state (bool) :param led: LED state (bool)