WIP: iohub updates #3685

isolver · 2021-03-17T11:04:33Z

RF: Started removing legacy sections of iohub code such as expRuntime class, ability of iohub to run as package outside of psychopy, and the util.clock.py and util.fix_encoding.py files
RF: Some cleaning up of eye tracker config files with an eye toward builder integration.
RF: all iohub demos now use launchHubServer()
ADD: iohub.util.getDeviceNames(): return list of iohub eye tracker names (that launchHubServer takes as keys)
ADD: iohub.util.getDeviceDefaultConfig(): return the eye tracker device config with default values, filtered to show builder visible settings only.
ADD: iohub.util.getDeviceParams(): returns eye tracker config settings similar to getDeviceDefaultConfig, but the value for each setting is a param dict containing valType, inputType, hint, etc...
ENH: eye tracker config file now supports builder_hides setting, which is used to list the device settings that should not be visible in Builder
ENH: iohub device setting can be static, for example manufacturer_name, so that it should be a disabled setting in builder, but still visible.
ENH: gevent tasks scheduling resolution on windows supports sub msec again.

This has been retested with eyelink and gazepoint, as well as keyboard and mouse, so please pull in if possible.

ENH: Make gevent use original libev backend on windows. gevent now defaults to using libuv, which is limited to a 1 msec event loop, causing extra delay in iohub keyboard event timestamping. Switching to use libev on windows makes performance more like older 2.7 distro's.

ENH: improved iohub keyboard/mouse event timing on macOS. macOS and Windows now both use the 'msgpump_interval' setting in psychopy/iohub/default_config.yaml. Default is 1 msec. Average iohub keypress timestamp error is down to ~2 msec, use to be 3 - 4+ msec average. Still not as good as psychhid, which is ~1 msec more accurate (i.e. has ~1 msec avg error).

…formance

No longer uses iohub ExperimentRuntime class or yaml config files.

And deleted file from source. Now only use launchHubServer() to start iohub

iohub now expects to be a sub package of psychopy and can not be run as a separate package

removed iohub.util.clock and iohub.util.fix_encoding.

Added some functions that, given a device name, returns the devices matching the name and the config dicts for the device(s). Could be used by Builder to get support eye tracker info from iohub

codecov · 2021-03-17T11:17:01Z

Codecov Report

Merging #3685 (af2a890) into dev (1bae708) will increase coverage by 0.21%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##              dev    #3685      +/-   ##
==========================================
+ Coverage   43.27%   43.48%   +0.21%     
==========================================
  Files         274      274              
  Lines       53614    53630      +16     
  Branches     9201     9207       +6     
==========================================
+ Hits        23199    23320     +121     
+ Misses      28090    27953     -137     
- Partials     2325     2357      +32

Impacted Files	Coverage Δ
psychopy/sound/audioclip.py	`39.28% <0.00%> (-1.16%)`	⬇️
psychopy/sound/microphone.py	`39.13% <0.00%> (-0.87%)`	⬇️
psychopy/visual/textbox2/fontmanager.py	`72.20% <0.00%> (-0.69%)`	⬇️
psychopy/tools/wizard.py	`72.12% <0.00%> (-0.67%)`	⬇️
psychopy/visual/textbox2/textbox2.py	`55.63% <0.00%> (+10.14%)`	⬆️
psychopy/tools/linebreak.py	`56.52% <0.00%> (+27.71%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1bae708...af2a890. Read the comment docs.

coveralls · 2021-03-17T11:19:51Z

Coverage increased (+0.3%) to 47.251% when pulling af2a890 on isolver:wip_iohub_refresh into ae519ab on psychopy:dev.

+ 'manufacturer_name' field should be used as eye tracker name in builder.

Will be used by Builder to know which settings should be hidden from the user, either because they are fixed or because builder may set them internally.

lgtm-com · 2021-03-17T14:53:47Z

This pull request introduces 3 alerts and fixes 12 when merging 0b67e56 into ae519ab - view on LGTM.com

new alerts:

1 for Module is imported more than once
1 for Except block handles 'BaseException'
1 for Module is imported with 'import' and 'import from'

fixed alerts:

6 for Variable defined multiple times
2 for Unused import
2 for Module is imported with 'import' and 'import from'
1 for Use of the return value of a procedure
1 for Unused local variable

for getDeviceDefaultConfig and getDeviceNames, provding simple example of using each.

iohub eye tracker device manufacturer_name is used by Builder as the name to display in the eye tracker interface selection list.

lgtm-com · 2021-03-17T16:27:49Z

This pull request introduces 3 alerts and fixes 12 when merging ebbfaf3 into 4d352be - view on LGTM.com

new alerts:

1 for Module is imported more than once
1 for Except block handles 'BaseException'
1 for Module is imported with 'import' and 'import from'

fixed alerts:

6 for Variable defined multiple times
2 for Unused import
2 for Module is imported with 'import' and 'import from'
1 for Use of the return value of a procedure
1 for Unused local variable

needed to be more consistent about use of IOHUB_LIST when needed in supported_config.yaml, so we know if a list should be editable or not. Also made manufacturer_name a read-only param

RF: Also removed the IOHUB_DATE type from iohub and all yaml files

lgtm-com · 2021-03-17T20:22:30Z

This pull request introduces 7 alerts and fixes 12 when merging 18dc2be into 4d352be - view on LGTM.com

new alerts:

3 for Unused local variable
1 for Wrong name for an argument in a call
1 for Module is imported more than once
1 for Except block handles 'BaseException'
1 for Module is imported with 'import' and 'import from'

fixed alerts:

6 for Variable defined multiple times
2 for Unused import
2 for Module is imported with 'import' and 'import from'
1 for Use of the return value of a procedure
1 for Unused local variable

First pass at returning a param type dict for each eye tracker setting.

lgtm-com · 2021-03-17T23:11:31Z

This pull request introduces 4 alerts and fixes 12 when merging c9f47eb into 4d352be - view on LGTM.com

new alerts:

1 for Wrong name for an argument in a call
1 for Module is imported more than once
1 for Except block handles 'BaseException'
1 for Module is imported with 'import' and 'import from'

fixed alerts:

6 for Variable defined multiple times
2 for Unused import
2 for Module is imported with 'import' and 'import from'
1 for Use of the return value of a procedure
1 for Unused local variable

Misc. fixes for changes made so far related to builder integration. Also removed unneeded iohub base device attributes.

lgtm-com · 2021-03-18T12:23:01Z

This pull request introduces 4 alerts and fixes 12 when merging 360b0c4 into 4d352be - view on LGTM.com

new alerts:

1 for Module is imported more than once
1 for Except block handles 'BaseException'
1 for Module is imported with 'import' and 'import from'
1 for Wrong number of arguments in a class instantiation

fixed alerts:

6 for Variable defined multiple times
2 for Unused import
2 for Module is imported with 'import' and 'import from'
1 for Use of the return value of a procedure
1 for Unused local variable

RF: removed some python 2.7 specific code

monitor_event_types -> Monitor Event Types

lgtm-com · 2021-03-18T14:22:41Z

This pull request introduces 1 alert and fixes 12 when merging c7a461e into 4d352be - view on LGTM.com

new alerts:

1 for Unused import

fixed alerts:

6 for Variable defined multiple times
2 for Unused import
2 for Module is imported with 'import' and 'import from'
1 for Use of the return value of a procedure
1 for Unused local variable

- labels are now the full iohub setting path. - hints are read from a builder_hints.yaml in the device folder, it it exists (only did hints for GP3 so far). fixes psychopy#3686

isolver · 2021-03-18T15:39:19Z

@mdcutone , can you please take a look at this and pull it in if it looks OK to you? I've tested it with the iohub coder demos and nothing is broken, so I think it is good to go into DEV.

was still returning allowedVals: None in some cases.

lgtm-com · 2021-03-18T18:14:56Z

This pull request introduces 1 alert and fixes 12 when merging af2a890 into 4d352be - view on LGTM.com

new alerts:

1 for Unused import

fixed alerts:

6 for Variable defined multiple times
2 for Unused import
2 for Module is imported with 'import' and 'import from'
1 for Use of the return value of a procedure
1 for Unused local variable

isolver added 22 commits February 12, 2021 11:13

Merge remote-tracking branch 'upstream/release' into release

10458e5

Merge remote-tracking branch 'upstream/release' into release

27e0308

Merge remote-tracking branch 'upstream/release' into release

48402e1

RF: Moved back to original 0 msec min tasklet switch time

c4d7678

Merge branch 'release' into hotfix-iohub-performance

42d9846

Merge remote-tracking branch 'upstream/release' into release

03ee044

Merge remote-tracking branch 'upstream/release' into release

934f87a

Merge remote-tracking branch 'upstream/release' into hotfix-iohub-per…

c1a9893

…formance

Merge branch 'release' into hotfix-iohub-performance

655236e

RF: Simplified iohub delaytest example.

f6dd2df

No longer uses iohub ExperimentRuntime class or yaml config files.

wip: switching gcCursor demo to use launchHubServer

3122fc8

RF: removed use of iohub.client.expruntime

1c25f1a

And deleted file from source. Now only use launchHubServer() to start iohub

updated todo.txt, pep8 main __init__

c9fefbf

RF: psychopy.iohub all the way

5ade173

iohub now expects to be a sub package of psychopy and can not be run as a separate package

RF: Removed more redundant functionality

a06a198

removed iohub.util.clock and iohub.util.fix_encoding.

Update TODO.txt

5d2efc6

Merge remote-tracking branch 'upstream/dev' into wip_iohub_refresh

68c40c2

Merge branch 'hotfix-iohub-performance' into wip_iohub_refresh

1a4ed7e

ENH: Added utility methods to read iohub device configs

f57f6b0

Added some functions that, given a device name, returns the devices matching the name and the config dicts for the device(s). Could be used by Builder to get support eye tracker info from iohub

BF: reading eyetracker device names

1484b0d

isolver added 4 commits March 17, 2021 08:40

RF: cleaning up eye tracker config files

884f1fc

+ 'manufacturer_name' field should be used as eye tracker name in builder.

ENH: Added builder_hides field to eyetracker config.

d7c47c6

Will be used by Builder to know which settings should be hidden from the user, either because they are fixed or because builder may set them internally.

FF: getDeviceDefaultConfig now hides params that Builder can ignore

6624ffc

FF: handle case of missing/incorrect setting in builder_ignores

0b67e56

Updated function comments

de32c3e

for getDeviceDefaultConfig and getDeviceNames, provding simple example of using each.

Updated purpose of 'manufacturer_name'

ebbfaf3

iohub eye tracker device manufacturer_name is used by Builder as the name to display in the eye tracker interface selection list.

isolver added 3 commits March 17, 2021 13:40

RF: iohub eye tracker config file changes

b5cf353

needed to be more consistent about use of IOHUB_LIST when needed in supported_config.yaml, so we know if a list should be editable or not. Also made manufacturer_name a read-only param

RF: Removed some unused iohub device config options

a1199c0

RF: Also removed the IOHUB_DATE type from iohub and all yaml files

RF: Removed need for IOHUB_NUMBER

18dc2be

ENH: Added iohub.util.getDeviceParams

c9f47eb

First pass at returning a param type dict for each eye tracker setting.

BF: Fixed misc issues found after retesting eyetrackers

360b0c4

Misc. fixes for changes made so far related to builder integration. Also removed unneeded iohub base device attributes.

isolver changed the title ~~WIP: iohub 2021 update~~ WIP: iohub updates Mar 18, 2021

isolver added 2 commits March 18, 2021 09:51

BF: Fixed LTGM issues

6ba837a

RF: removed some python 2.7 specific code

FF: iohub now returns param labels in Title Case format

c7a461e

monitor_event_types -> Monitor Event Types

FF: updates to getDeviceConfig

c201a4b

- labels are now the full iohub setting path. - hints are read from a builder_hints.yaml in the device folder, it it exists (only did hints for GP3 so far). fixes psychopy#3686

isolver requested a review from mdcutone March 18, 2021 15:37

FF: iohub don't return allowedVals if they are None

af2a890

was still returning allowedVals: None in some cases.

isolver removed the request for review from mdcutone March 19, 2021 07:21

isolver merged commit 349c99a into psychopy:dev Mar 19, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: iohub updates #3685

WIP: iohub updates #3685

isolver commented Mar 17, 2021 •

edited

Loading

codecov bot commented Mar 17, 2021 •

edited

Loading

coveralls commented Mar 17, 2021 •

edited

Loading

lgtm-com bot commented Mar 17, 2021

lgtm-com bot commented Mar 17, 2021

lgtm-com bot commented Mar 17, 2021

lgtm-com bot commented Mar 17, 2021

lgtm-com bot commented Mar 18, 2021

lgtm-com bot commented Mar 18, 2021

isolver commented Mar 18, 2021

lgtm-com bot commented Mar 18, 2021

WIP: iohub updates #3685

WIP: iohub updates #3685

Conversation

isolver commented Mar 17, 2021 • edited Loading

codecov bot commented Mar 17, 2021 • edited Loading

Codecov Report

coveralls commented Mar 17, 2021 • edited Loading

lgtm-com bot commented Mar 17, 2021

lgtm-com bot commented Mar 17, 2021

lgtm-com bot commented Mar 17, 2021

lgtm-com bot commented Mar 17, 2021

lgtm-com bot commented Mar 18, 2021

lgtm-com bot commented Mar 18, 2021

isolver commented Mar 18, 2021

lgtm-com bot commented Mar 18, 2021

isolver commented Mar 17, 2021 •

edited

Loading

codecov bot commented Mar 17, 2021 •

edited

Loading

coveralls commented Mar 17, 2021 •

edited

Loading