Skip to content

Commit

Permalink
Merge pull request #28 from ni/ccaltagi-update-documentation
Browse files Browse the repository at this point in the history
Add documentation for the DataRateLevel enumerated type.
  • Loading branch information
chadallee authored Jan 10, 2023
2 parents 4000bd5 + b370f7e commit 9680137
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion src/flexlogger/automation/_data_rate_level.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,25 @@


class DataRateLevel(Enum):
"""An enumeration describing the possible data rate levels."""
"""An enumeration describing the possible data rate levels that channels can be configured to use.
For additional information on configuring data rates, visit
https://www.ni.com/docs/en-US/bundle/flexlogger/page/configuring-data-rates.html
"""

SLOW = 1
"""The slow analog data rate level in Hertz at which your DAQ device acquires data."""

MEDIUM = 2
"""The medium analog data rate level in Hertz at which your DAQ device acquires data."""

FAST = 3
"""The fast analog data rate level in Hertz at which your DAQ device acquires data."""

COUNTER = 4
"""The counter data rate level in Hertz at which your DAQ device acquires data."""

DIGITAL = 6
"""The digital data rate level in Hertz at which your DAQ device acquires data."""

ON_DEMAND = 7
"""The on-demand data rate level in Hertz at which your DAQ device acquires data."""

0 comments on commit 9680137

Please sign in to comment.