Open RF Prototyping

def initialize(self) -> None:
    """Initialize the signal generator hardware and software.

    >>> import rpyc
    >>> ddsgen = rpyc.connect("127.0.0.1", 18866)
    >>> ddsgen.root.initialize()

    """

@property
def dds_controllers(self) -> Dict[str, AD9913Controller]:
    """A dictionary containing the signal generator DDS controllers.

    The controllers are instances of AD9913_Controller keyed using
    the channel identifiers 'Chan 1' and 'Chan 2' respectively.

    >>> import rpyc
    >>> ddsgen = rpyc.connect("127.0.0.1", 18866)
    >>> ddsgen.root.initialize()
    >>> dds1 = ddsgen.root.dds_controllers['Chan 1']
    >>> dds1
    <rfblocks.ad9913_controller.AD9913Controller object at 0x126f8b4c0>
    >>> dds2 = ddsgen.root.dds_controllers['Chan 2']

    """

@property
def clk_controller(self) -> HMC833Controller:
    """The controller for the DDS reference clock.

    An instance of HMC833Controller.

    >>> import rpyc
    >>> ddsgen = rpyc.connect("127.0.0.1", 18866)
    >>> ddsgen.root.initialize()
    >>> refclk = ddsgen.root.clk_controller

    """

def configure(self, ctl_id: str) -> None:
    """Configure AD9913 DDS hardware registers for a specified channel.

    :param ctl_id: A channel id.  This will be one of "Chan 1" or "Chan 2".
    :type ctl_id: str

    >>> import rpyc
    >>> ddsgen = rpyc.connect("127.0.0.1", 18866)
    >>> ddsgen.root.initialize()
    >>> dds1 = ddsgen.root.dds_controllers['Chan 1']
    >>> dds1.freq = 25.0
    >>> dds1.dbm = -10.0
    >>> ddsgen.root.configure('Chan 1')
    """

def configure_sweep(self, ctl_id: str) -> None:
    """Configure AD9913 DDS sweep registers for a specified channel.

    :param ctl_id: A channel id.  This will be one of "Chan 1" or "Chan 2".
    :type ctl_id: str

    >>> import rpyc
    >>> ddsgen = rpyc.connect("127.0.0.1", 18862)
    >>> ddsgen.root.initialize()
    >>> dds1 = ddsgen.root.dds_controllers['Chan 1']

    >>> dds1._ad9913.cfr1 = ad9913.DEFAULT_CFR1
    >>> dds1.sweep_start = 20.0
    >>> dds1.sweep_end = 30.0
    >>> dds1.sweep_type = ad9913.SweepType.FREQUENCY
    >>> dds1.sweep_ramp_type = ad9913.SweepRampType.RAMP_BIDIR
    >>> dds1.sweep_rising_step = 0.001
    >>> dds1.sweep_falling_step = 0.001
    >>> dds1.sweep_rising_rate = 256
    >>> dds1.sweep_falling_rate = 256
    >>> ddsgen.root.configure_sweep('Chan 1')
    >>> ddsgen.root.start_sweep('Chan 1')
    """

def update_profile(self, ctl_id: str, profnum: int) -> None:
    """Update AD9913 DDS profile registers for a specified channel and profile.

    :param ctl_id: A channel id.  This will be one of "Chan 1" or "Chan 2".
    :type ctl_id: str
    :param profnum: The AD9913 profile register to update.
    :type profnum: An integer in the range 0 to 7.

    >>> import rpyc
    >>> ddsgen = rpyc.connect("127.0.0.1", 18862)
    >>> ddsgen.root.initialize()
    >>> dds1 = ddsgen.root.dds_controllers['Chan 1']

    >>> dds1.direct_switch_enabled = True
    >>> dds1.profile_type = ad9913.SweepType.FREQUENCY
    >>> dds1.set_profile_freq(0, 25.0)
    >>> dds1.set_profile_freq(1, 35.0)
    >>> ddsgen.root.update_profile('Chan 1', 0)
    >>> ddsgen.root.update_profile('Chan 1', 1)
    """

def configure_profile(self, ctl_id: str) -> None:
    """Configure the currently set profile parameters in DDS hardware.

    This updates the DDS output to reflect the selected profile.

    :param ctl_id: A channel id.  This will be one of "Chan 1" or "Chan 2".
    :type ctl_id: str

    >>> import rpyc
    >>> ddsgen = rpyc.connect("127.0.0.1", 18862)
    >>> ddsgen.root.initialize()
    >>> dds1 = ddsgen.root.dds_controllers['Chan 1']

    >>> dds1.direct_switch_enabled = True
    >>> dds1.profile_type = ad9913.SweepType.FREQUENCY
    >>> dds1.set_profile_freq(0, 25.0)
    >>> dds1.set_profile_freq(1, 35.0)
    >>> ddsgen.root.update_profile('Chan 1', 0)
    >>> ddsgen.root.update_profile('Chan 1', 1)
    >>> dds1.selected_profile = 0
    >>> ddsgen.root.configure_profile('Chan 1')
    >>> dds1.selected_profile = 1
    >>> ddsgen.root.configure_profile('Chan 1')
    >>> dds1.selected_profile = 0
    >>> ddsgen.root.configure_profile('Chan 1')
    >>> dds1.direct_switch_enabled = False
    """

def start_sweep(self, ctl_id: str) -> None:
    """Start an AD9913 sweep operation for a specified channel.

    :param ctl_id: A channel id.  This will be one of "Chan 1" or "Chan 2".
    :type ctl_id: str
    """

def stop_sweep(self, ctl_id: str) -> None:
    """Stop an AD9913 sweep operation.

    :param ctl_id: A channel id.  This will be one of "Chan 1" or "Chan 2".
    :type ctl_id: str
    """

def set_pmod(self, ctl_id: str, state: bool) -> None:
    """Set the DDS programmable modulus state.

    :param ctl_id: A channel id.  This will be one of "Chan 1" or "Chan 2".
    :type ctl_id: str
    :param state: Set to True in order to enable progammable modulus.
        False to disable it.
    :type state: bool

    Note that :py:meth:`configure` must be invoked in order to
    update the DDS hardware
    """