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.

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

API Audit #8

Closed
14 of 15 tasks
sjkelly opened this issue Aug 31, 2021 · 0 comments
Closed
14 of 15 tasks

API Audit #8

sjkelly opened this issue Aug 31, 2021 · 0 comments

Comments

@sjkelly
Copy link
Collaborator

sjkelly commented Aug 31, 2021

Identification API:

GOOD.

Channels API:

GOOD.

Stream API:

  • getNativeStreamFormat
  • getStreamFormats
  • getStreamMTU
  • getStreamStatus

Direct buffer access API

Not needed. This is for driver layers. Stream interface should be used instead.

Antenna API:

  • setAntenna

Frontend corrections API

GOOD.

Gain API:

  • setGainMode
  • getGainMode
  • There may be multiple GainElements, belonging to the Channel. This is not handled in the set/getproperties, and leads to strange behavior.

There is some abstraction started for this, but I have not finished testing. I think it needs to be integrated with Channel.
For the high level API we may want to call listGains on the Channel to pre-populate.

Frequency API:

  • listFrequencies
  • Similar to GainElements.

Sample Rates API:

  • listSampleRate (optional, but seems supported in several bindings)

For high level we can likely choose the closest and warn if it is not exact. EDIT: It is deprecated.

Bandwidth API

GOOD.

ClockAPI

  • Needs implementation

TimeAPI

  • Needs implementation

SensorAPI

  • Needs implementation

SettingsAPI

  • Needs implementation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant