Add Keithley2281S

[PfannenHans]

Add support for Keithley2281S-20-6 battery simulator and analyzer.

[BenediktBurger]

Thank you for your contribution, it is always great to see new contributors.

A few quick comments to the code and some general comments:

• You may add yourself to the authors.txt, if you wish so.
• Please add proper documentation files and add it to the manufacturer's init, see https://pymeasure.readthedocs.io/en/latest/dev/adding_instruments/instrument.html
• I encourage you to add protocol tests in order to test your functionality, see https://pymeasure.readthedocs.io/en/latest/dev/adding_instruments/tests.html#

[codecov]

Codecov Report

Attention: Patch coverage is 78.00000% with 33 lines in your changes are missing coverage. Please review.

Project coverage is 58.33%. Comparing base (5e1a514) to head (374b8ab).
Report is 6 commits behind head on master.

❗ Current head 374b8ab differs from pull request most recent head 0d39ae2. Consider uploading reports for the commit 0d39ae2 to get more accurate results

Files	Patch %	Lines
pymeasure/instruments/keithley/keithley2281S.py	77.70%	33 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1054      +/-   ##
==========================================
+ Coverage   58.16%   58.33%   +0.16%     
==========================================
  Files         259      260       +1     
  Lines       17934    18083     +149     
==========================================
+ Hits        10432    10548     +116     
- Misses       7502     7535      +33     

Flag	Coverage Δ
unittests	58.33% <78.00%> (+0.16%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[PfannenHans]

Unfortunately I could not find a solution for the warnings ins the Documentation generation step.

[BenediktBurger]

Thanks for your contribution. I added a few comments.

[BenediktBurger]

Did you consider using channels for the power supply, battery testing, and battery simulation modes?

That would make it easier to understand, I think, as you could drop all the prefixes.

[PfannenHans]

Good idea, i will look into channels. They must be mutually exclusive thou.

[BenediktBurger]

You could add/remove the channels dynamically.
However, I think it is best to keep them active, as the driver never know, which mode the device is in.
Right now, you do not disable these "forbidden" methods either.

[BenediktBurger]

By the way: I thought about three different channels: One simulation, one measurement and one power supply.

[BenediktBurger]

Unfortunately I could not find a solution for the warnings ins the Documentation generation step.

I do not understand them either.
As both enums are broken, you could try a few things: Maybe the comments are the problem or the underscores. Another idea is to check their docstrings.

Finally, if you make the enum values descriptive, you do not have to add them to the .rst file, which will make the error disappear (I guess).

[mcdo0486]

Unfortunately I could not find a solution for the warnings ins the Documentation generation step.

This is caused by generating documentation for inherited methods for the enum.IntFlag classes (Keithley2281SOperationEventRegister & Keithley2281SMeasurementEventRegister) in docs/api/instruments/keithley/keithley2281S.rst

I made a small PR for your branch if you'd like to merge it, which removes the inheritance.

The inherited docstrings in int do not follow some linting rules. In fact, I think you can just remove the Keithley2281SOperationEventRegister & Keithley2281SMeasurementEventRegister classes from generated documentation, as the user wouldn't be using those classes directly.

[BenediktBurger]

Ah, that makes sense. Thanks @mcdo0486 .

[BenediktBurger]

Your changes till now look good, only the question of channels remains open.

Please refrain from force-pushing commits as that prevents github from showing previous comments on the right spot (as the respective commit is not present anymore).