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

lda: docstring style

This commit is contained in:
Yann Sionneau 2015-01-09 15:08:25 +01:00 committed by Sebastien Bourdeauducq
parent 1407a48836
commit d21211a473
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
artiq/devices/lda/driver.py
View File

@ -23,8 +23,8 @@ class Ldasim:
:return: Returns the attenuation value in dB, or None if it was :return: Returns the attenuation value in dB, or None if it was
never set. never set.
:rtype: float :rtype: float
""" """
return self._attenuation return self._attenuation
def set_attenuation(self, attenuation): def set_attenuation(self, attenuation):
@ -32,8 +32,8 @@ class Ldasim:
:param attenuation: The attenuation value in dB. :param attenuation: The attenuation value in dB.
:type attenuation: int, float or Fraction :type attenuation: int, float or Fraction
""" """
attenuation = round(attenuation*4)/4. attenuation = round(attenuation*4)/4.
print("[LDA-sim] setting attenuation to {}".format(attenuation)) print("[LDA-sim] setting attenuation to {}".format(attenuation))
self._attenuation = attenuation self._attenuation = attenuation
@ -63,8 +63,7 @@ class Lda:
def __init__(self, serial=None, product="LDA-102"): def __init__(self, serial=None, product="LDA-102"):
""" """
:param serial: The serial number. :param serial: The serial number.
:param product: The product identifier string: LDA-102, LDA-602 or sim. :param product: The product identifier string: LDA-102, LDA-602.
""" """
from artiq.devices.lda.hidapi import hidapi from artiq.devices.lda.hidapi import hidapi
@ -101,8 +100,8 @@ class Lda:
:param command: command ID. :param command: command ID.
:param length: number of meaningful bytes in the data array. :param length: number of meaningful bytes in the data array.
:param data: a byte array containing the payload of the command. :param data: a byte array containing the payload of the command.
""" """
# 0 is report id/padding # 0 is report id/padding
buf = struct.pack("BBB6s", 0, command, length, data) buf = struct.pack("BBB6s", 0, command, length, data)
res = self._check_error(self.hidapi.hid_write(self._dev, buf, res = self._check_error(self.hidapi.hid_write(self._dev, buf,
@ -114,8 +113,8 @@ class Lda:
:param command: command ID, must have most significant bit set. :param command: command ID, must have most significant bit set.
:param data: payload of the command. :param data: payload of the command.
""" """
assert command & 0x80 assert command & 0x80
assert data assert data
self.write(command, len(data), data) self.write(command, len(data), data)
@ -128,8 +127,8 @@ class Lda:
:param int timeout: Timeout of the HID read in ms. :param int timeout: Timeout of the HID read in ms.
:return: Returns the value read from the device. :return: Returns the value read from the device.
:rtype: bytes :rtype: bytes
""" """
assert not command & 0x80 assert not command & 0x80
status = None status = None
self.write(command, length) self.write(command, length)
@ -148,8 +147,8 @@ class Lda:
:return: Returns the attenuation value in dB. :return: Returns the attenuation value in dB.
:rtype: float :rtype: float
""" """
return ord(self.get(0x0d, 1))/4. return ord(self.get(0x0d, 1))/4.
def set_attenuation(self, attenuation): def set_attenuation(self, attenuation):
@ -157,6 +156,6 @@ class Lda:
:param attenuation: Attenuation value in dB. :param attenuation: Attenuation value in dB.
:type attenuation: int, float or Fraction :type attenuation: int, float or Fraction
""" """
self.set(0x8d, bytes([int(round(attenuation*4))])) self.set(0x8d, bytes([int(round(attenuation*4))]))