ni / ni/nimi-python

Investigate the need for defining constants in nimi-python API

Open
#1,078 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API enhancement
Dominant language
Python
Stars
128
Forks
110
Avg merge
5d 14h
Merged PRs (30d)
10

Description

Description of issue

In driver C APIs, there usually are constants defined to represent certain magic numbers. e.g. In nidigital, there is NIDIGITAL_VAL_ACQUIRE_ALL_SAMPLES (= -1), intended to represent capturing all available History RAM samples in FetchHRAMData() function.

There isn't a way to represent these magic number in nimi-python API. We should consider adding something similar.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the nimi-python driver APIs, especially nidigital's FetchHRAMData() and the corresponding C API constant NIDIGITAL_VAL_ACQUIRE_ALL_SAMPLES. The issue names no files or tests; done requires deciding whether magic-number constants are needed and defining the scope of any API change.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.