Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add adistream CLI tool #496

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add adistream CLI tool #496

wants to merge 2 commits into from
+626 −0

Conversation

SaikiranGudla
Copy link
Contributor

@SaikiranGudla SaikiranGudla commented Nov 7, 2023 •
edited

Add adistream CLI tool to support data generation and streaming for tx devices like DACs.
Update doc to include new tools optional dependency.

Description

The new CLI tool helps in generating various types of waveforms using the Genalyzer APIs and streaming them to the device.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How has this been tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Test Configuration:

  • Hardware:
  • OS:

Documentation

Quick start doc has been updated with the dependencies. The help command in the tool gives a detailed description of how to use the tool.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have signed off all commits and they contain "Signed-off by: "
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

mphalke
mphalke reviewed Nov 7, 2023
View reviewed changes
adi/tools/adistream.py
from genalyzer import WaveformGen
from pynput import keyboard


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should add documentation/comments for functions/properties

tfcollins
tfcollins reviewed Nov 8, 2023
View reviewed changes
doc/source/guides/quick.rst
.. note::

For the adistream CLI tool to generate and stream data to the device, it's also needed to install the `genalyzer <https://analogdevicesinc.github.io/genalyzer/master/setup.html#windows>`_ and its python bindings.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the #windows

tfcollins
tfcollins requested changes Nov 8, 2023
View reviewed changes
Copy link
Collaborator

@tfcollins tfcollins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a specific doc page for tools. That way users are aware these things exist. We will also need a unit to this as well. See here https://jugmac00.github.io/blog/testing-argparse-applications-the-better-way/

@SaikiranGudla
Add adistream CLI tool
e0e8d1f 
Add adistream CLI tool to support data generation
and streaming for tx devices like DACs.
Update doc to include new tools optional
dependency.
Add doc page for tools.

Signed-off-by: SGudla <Saikiran.Gudla@analog.com>
tfcollins
tfcollins reviewed Jan 8, 2024
View reviewed changes
test/test_adistream.py Outdated
import argparse

import pytest
from adi.tools.adistream import run_adi_stream
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You'll need an import check to see if adi tools was imported. Otherwise this will always break tests when the dependencies don't exist

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, ModuleNotFoundError is occurring when importing Genalyzer. Shall I skip the tests if an import error occurs here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May I know if any more changes need to be made, @tfcollins?

@SaikiranGudla
Copy link
Contributor Author

Change log:
Rename ad578x class name occurrences with ad579x with respect to the driver name change.

@SaikiranGudla
Add tests for adistream cli tool
acdcc9b 
Signed-off-by: SGudla <Saikiran.Gudla@analog.com>
@SaikiranGudla
Copy link
Contributor Author

Change log:
Fixed Lint issues (F841).

@SaikiranGudla
Copy link
Contributor Author

Hi @tfcollins,
Is this PR good to be merged?

@tfcollins
Copy link
Collaborator

CI is failing still. That needs to be addressed first

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tfcollins tfcollins tfcollins requested changes

@mphalke mphalke mphalke left review comments

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@SaikiranGudla @tfcollins @mphalke