Discover action types and pass Sensor through action call #109

dboulware · 2024-01-15T18:54:50Z

This (in conjunction with the associated scos-sensor PR) fixes an architectural issue in scos sensor and enables loading of actions from a scos sensor config directory. The main changes within this PR are:

Reverts scos-actions repo to purely APIs. All initialization is now performed in scos-sensor (or outside of scos-actions)
Actions are no longer initialized with a signal analyzer and gps. Instead, they are only initialized with their parameters and the signal analyzer, gps, preselector, switches, location, and sensor definition/capabilities are passed into the action call method through a new Sensor class.
Calibration is given a new property is_default to identify that the calibration is the default calibration file rather than one generated from a lab based cal and file_path to indicate where the calibration should be saved.
Removes registration signals.
Modified settings to not use django settings and only load settings from the environment.

While the behavior is not enforced within the code in this repo, the readme has also been updated to reflect that the discover module used by scos-sensor plugins should expose an actions and/or action_types dictionary. Finally, because of these changes, this increments the version of scos-actions to 8.0.0.

…ions to have sigan and gps properties. Expose action_types in discover.

…tions with them.

…ally take calibrations and add calibration properties.

aromanielloNTIA

I made a few commits and left some comments below, mostly for minor cleanup stuff following this major refactor. Looks good but please respond to comments before merging.

scos_actions/actions/interfaces/action.py

scos_actions/actions/acquire_stepped_freq_tdomain_iq.py

scos_actions/actions/monitor_sigan.py

scos_actions/actions/sync_gps.py

scos_actions/discover/__init__.py

scos_actions/hardware/mocks/mock_sigan.py

scos_actions/hardware/sensor.py

scos_actions/settings.py

scos_actions/status/__init__.py

…der.

no longer requires `sensor` parameter

…actions into discover_action_types

…ensor). Remove registration signals to prevent plugins from registering things.

…bration_data

…alAnalyzer.

aromanielloNTIA

Looks good- see minor comments included below. I'm about to test on seadog01 in the meantime.

scos_actions/hardware/sensor.py

scos_actions/hardware/mocks/mock_sigan.py

…ocstrings and test cases. Modify has_configurable_preselector to return True if the sensor definition includes a preselector with multiple rf_paths or if the preselector has multiple rf_paths.

aromanielloNTIA

Looks good!

dboulware added 30 commits January 8, 2024 13:34

sigan monitor

5e28250

Move sigan monitor to status.

bb42996

fix signal_analyzer_monitor.

588fb6f

Create core module to initialize the StatusMonitor and SiganMonitor

eba51a9

typo fix.

8a3b2c2

rename initialization import.

71da125

add test for sigan registration.

b2022e4

Increment version.

9a7309c

Restore functionality. Add gps registration and tests.

5909cd6

Remove sigan and gps registration signals and core module. Update act…

f2bce4c

…ions to have sigan and gps properties. Expose action_types in discover.

remove register sigan and gps signal use.

5fcb348

fix import of status_monitor

2e489c2

remove old tests and fix test_status_handler.

027e23a

fix test_status_handler

5327022

remove register sigan signal refs.

42d2767

pass gps and sigan to actions call method instead of instantiating ac…

023f554

…tions with them.

Remove sigan from discover

d827a57

remove sigan and gps from action constructors.

a9b0b78

remove erroneous ref to sigan in logger action.

46ff311

remove sigan and gps from sea action init.

ace3525

remove gps/sigan ref from action inits.

faba66f

fix tests.

af98a15

run pre-commit

3960349

fixed tests.

a727559

add missing sensor class.

6843b97

add initialization code.

eec0a47

move initialization utilities back to scos-sensor.

a054081

remove erroneous self.sensor_definition

fbc3400

comment out preselector settings

f2ce96e

Remove calibration initialization. Update sigan constructor to option…

37b67a7

…ally take calibrations and add calibration properties.

aromanielloNTIA added 4 commits January 16, 2024 13:30

update type hints and run isort

71a2007

more specific type hint for power_cycle_sigan

62ed6a2

remove redundant call to Path()

489f829

update type hints

fb3e310

aromanielloNTIA approved these changes Jan 16, 2024

View reviewed changes

dboulware and others added 18 commits January 16, 2024 12:12

Remove sensor parameter from configure_preselector and get_sigmf_buil…

5d32721

…der.

remove dead code.

a562915

fix get_sigmf_builder call in test action

cd1a205

no longer requires `sensor` parameter

Remove sensor from call to get_sigmf_builder.

cd74577

Merge branch 'discover_action_types' of https://github.com/NTIA/scos-…

fabccfe

…actions into discover_action_types

Remove StatusMonitor (functionality replaced with singleton in scos-s…

8a4f69e

…ensor). Remove registration signals to prevent plugins from registering things.

Remove status package and move start_time into Sensor.

e35274f

Fix tests.

e5f5ac2

Use property setters in Sensor init.

83f7dc9

Add test_sensor. Remove dead code.

d8d45e4

Revert unnecessary change in MockSignalAnalyzer recompute_sensor_cali…

ee5ebb4

…bration_data

Remove DEFAULT_CALIBRATION_FILE from settings.

d3c169d

Add optional switches dictionary to SignalAnalyzerInterface

027fde8

update type hint in SignalAnalyzerInterface

4d3e5b5

pass switches to power cycle sigan.

acfdb8f

add load_switches

46c9f61

Remove load switches.

0e82996

Default signal_analyzer to None and add optional switches to MockSign…

0581b95

…alAnalyzer.

dboulware requested a review from aromanielloNTIA January 23, 2024 15:37

aromanielloNTIA requested changes Jan 23, 2024

View reviewed changes

scos_actions/hardware/sensor.py Show resolved Hide resolved

scos_actions/hardware/sensor.py Show resolved Hide resolved

scos_actions/hardware/sensor.py Outdated Show resolved Hide resolved

scos_actions/hardware/sensor.py Outdated Show resolved Hide resolved

aromanielloNTIA reviewed Jan 23, 2024

View reviewed changes

scos_actions/hardware/mocks/mock_sigan.py Outdated Show resolved Hide resolved

Require signal analyzer and capabilities in Sensor constructor. Add d…

74b3760

…ocstrings and test cases. Modify has_configurable_preselector to return True if the sensor definition includes a preselector with multiple rf_paths or if the preselector has multiple rf_paths.

aromanielloNTIA approved these changes Jan 26, 2024

View reviewed changes

dboulware merged commit b0dd42b into master Jan 27, 2024
4 checks passed

dboulware deleted the discover_action_types branch January 27, 2024 20:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Discover action types and pass Sensor through action call #109

Discover action types and pass Sensor through action call #109

dboulware commented Jan 15, 2024 •

edited

Loading

aromanielloNTIA left a comment

aromanielloNTIA left a comment

aromanielloNTIA left a comment

Discover action types and pass Sensor through action call #109

Discover action types and pass Sensor through action call #109

Conversation

dboulware commented Jan 15, 2024 • edited Loading

aromanielloNTIA left a comment

Choose a reason for hiding this comment

aromanielloNTIA left a comment

Choose a reason for hiding this comment

aromanielloNTIA left a comment

Choose a reason for hiding this comment

dboulware commented Jan 15, 2024 •

edited

Loading