Skip to content

Change AMDC encoder function names to use counts instead of pulses #506

@elsevers

Description

@elsevers

Context

Related Issues / PRs:

We are preparing an article for docs.amdc.dev on how to use the encoder interface in Severson-Group/docs.amdc.dev#103. As part of preparing this article, we realized that the AMDC has a series of encoder functions (i.e. encoder_set_pulses_per_rev()) that refer to pulses when they should refer to counts. See these comments:

That is, we wish to change functions like encoder_set_pulses_per_rev() to be named encoder_set_counts_per_rev().

The distinction between pulses and counts are explained in the AMDC's encoder subsystem documentation.

Approach

  • Compile a list of what C functions and FPGA HDL need changing.
  • Decide if we are going to do this as a graceful change (we keep the old user API functions, but display compiler warnings that they are deprecated and will be removed in a future major release, and have the old functions call the new functions) OR if we rip the bandaid off and force everyone to upgrade their function names
  • Decide if we want to include this in the upcoming release (i.e., release at the same time as adding AMDS daisy chain support?)

Close this issue via a PR that renames the functions.

Metadata

Metadata

Labels

dspInvolves the DSP C code.fpgaInvolves the FPGA Verilog code.

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions