cal_type enum missing from nidmm
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
Description of issue
When using the following methods, I am forced to pass 0 or 1 to represent internal calibration (self calibration) or external calibration:
get_cal_date_and_time
get_last_cal_temp
The documentation (https://nimi-python.readthedocs.io/en/master/nidmm/class.html#get-last-cal-temp) states:
One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.
In this instance the 'referenced value' in question is cal_type, however it does not represent a boolean nor does it only define values.
System report
python -c "import nidmm; nidmm.print_diagnostic_information()" output
OS:
Name: Windows
Version: 10.0.18362
Bits: 64
Driver:
Name: NI-DMM
Version: 20.0.0.49152
Module:
Name: nidmm
Version: 1.3.2
Python:
Version: 3.6.8 (tags/v3.6.8:3c6b436a57, Dec 24 2018, 00:16:47) [MSC v.1916 64 bit (AMD64)]
Bits: 64
Is_Venv: False
Installed Packages:
wrapt==1.12.1
typing-extensions==3.7.4.3
typed-ast==1.4.1
toml==0.10.1
six==1.15.0
regex==2020.9.27
pylint==2.6.0
pycodestyle==2.6.0
pathspec==0.8.0
mypy-extensions==0.4.3
mccabe==0.6.1
lazy-object-proxy==1.4.3
isort==5.6.1
dataclasses==0.7
colorama==0.4.3
click==7.1.2
black==20.8b1
autopep8==1.5.4
astroid==2.4.2
appdirs==1.4.4
zipp==3.2.0
virtualenv==20.0.33
urllib3==1.25.10
simplejson==3.17.2
setuptools==40.6.2
requests==2.24.0
pytest==6.1.0
pytest-elk-reporter==0.1.10
pyparsing==2.4.7
py==1.9.0
pluggy==0.13.1
pip==18.1
packaging==20.4
nititan==20.6.0.dev147
nitclk==20.4.14.dev16
nisyscfg==23.0.5
niscope==1.3.2
nidmm==1.3.2
nidcpower==1.3.1
iniconfig==1.0.1
importlib-resources==3.0.0
importlib-metadata==2.0.0
idna==2.10
hightime==0.2.0
future==0.18.2
filelock==3.0.12
enum34==1.1.10
distlib==0.3.1
chardet==3.0.4
certifi==2020.6.20
attrs==20.2.0
atomicwrites==1.4.0
Steps to reproduce issue
N/A
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the nidmm API entry points get_cal_date_and_time and get_last_cal_temp, then trace how their cal_type parameter is represented. Check the linked documentation for the intended values and inspect the existing enum-generation or API definitions. Done means callers can use the exposed cal_type enum instead of passing numeric values.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100