feat: Custom LAN Device Name for TCPIP Connections

lekevin678 commented 2 months ago

Proposed changes

Before, TCPIP connections have the LAN device name hard-coded to "'inst0" in the VISA connection string. Not all devices connection on "inst0". For example, some devices connect on High Speed LAN Instrument Protocol (HiSLIP) with the LAN device name of "hislip0". Added lan_device_name as an optional string to DeviceConfigEntry to allow connections on different LAN device names.

Types of changes

What types of changes does your code introduce? Put an x in the boxes that apply

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[x] Functionality update (non-breaking change which updates or changes existing functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] CI/CD update (an update to the CI/CD workflows, scripts, and/or configurations)
[x] Documentation update (an update to enhance the user experience when reading through the docs)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

[x] I have followed the guidelines in the CONTRIBUTING document
[x] I have signed the CLA
[x] I have checked to ensure there aren't other open Pull Requests for the same update/change
[x] I have performed a self-review of my code
[x] My code follows the style guidelines of this project
[x] I have commented my code, particularly in hard-to-understand areas
[x] Basic linting passes locally with my changes
[x] I have added tests that prove my fix is effective or that my feature works
[x] New and existing unit tests pass locally with my changes
[x] I have added necessary documentation (if appropriate)
[x] I have updated the Changelog with a brief description of my changes

nfelt14 commented 2 months ago

[x] The branch needs to be rebased with the latest from main

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (b9f6f96) to head (87b29b0).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #267 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 152 152 Lines 4821 4822 +1 Branches 769 767 -2 ========================================= + Hits 4821 4822 +1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

github-actions[bot] commented 2 months ago

Breaking API Changes

src/tm_devices/helpers/constants_and_dataclasses.py:0: DeviceConfigEntry.__init__(serial_config):
Positional parameter was moved
  Details: position: from 6 to 7 (+1)

src/tm_devices/helpers/constants_and_dataclasses.py:0: DeviceConfigEntry.__init__(device_driver):
Positional parameter was moved
  Details: position: from 7 to 8 (+1)

src/tm_devices/helpers/constants_and_dataclasses.py:0: DeviceConfigEntry.__init__(gpib_board_number):
Positional parameter was moved
  Details: position: from 8 to 9 (+1)

Link to workflow run

github-actions[bot] commented 2 months ago

Test Results (ubuntu)

path	passed	subtotal
tests/test_afgs.py	2	2
tests/test_alias_dict.py	1	1
tests/test_all_device_drivers.py	1	1
tests/test_alternative_connection_addresses.py	19	19
tests/test_awgs.py	4	4
tests/test_config_parser.py	38	38
tests/test_device_manager.py	18	18
tests/test_devices_legacy_tsp_ieee_cmds.py	3	3
tests/test_generate_waveform.py	6	6
tests/test_helpers.py	71	71
tests/test_ieee_scpi_cmds.py	1	1
tests/test_margin_testers.py	5	5
tests/test_pi_device.py	1	1
tests/test_psu.py	1	1
tests/test_rest_api_device.py	10	10
tests/test_scopes.py	7	7
tests/test_singleton.py	1	1
tests/test_smu.py	4	4
tests/test_ss.py	1	1
tests/test_tm_devices.py	4	4
tests/test_unsupported_device_type.py	1	1
TOTAL	199	199

Link to workflow run

github-actions[bot] commented 2 months ago

Test Results (windows)

path	passed	subtotal
tests\test_afgs.py	2	2
tests\test_alias_dict.py	1	1
tests\test_all_device_drivers.py	1	1
tests\test_alternative_connection_addresses.py	19	19
tests\test_awgs.py	4	4
tests\test_config_parser.py	38	38
tests\test_device_manager.py	18	18
tests\test_devices_legacy_tsp_ieee_cmds.py	3	3
tests\test_generate_waveform.py	6	6
tests\test_helpers.py	71	71
tests\test_ieee_scpi_cmds.py	1	1
tests\test_margin_testers.py	5	5
tests\test_pi_device.py	1	1
tests\test_psu.py	1	1
tests\test_rest_api_device.py	10	10
tests\test_scopes.py	7	7
tests\test_singleton.py	1	1
tests\test_smu.py	4	4
tests\test_ss.py	1	1
tests\test_tm_devices.py	4	4
tests\test_unsupported_device_type.py	1	1
TOTAL	199	199

Link to workflow run

github-actions[bot] commented 2 months ago

Test Results (macos)

path	passed	subtotal
tests/test_afgs.py	2	2
tests/test_alias_dict.py	1	1
tests/test_all_device_drivers.py	1	1
tests/test_alternative_connection_addresses.py	19	19
tests/test_awgs.py	4	4
tests/test_config_parser.py	38	38
tests/test_device_manager.py	18	18
tests/test_devices_legacy_tsp_ieee_cmds.py	3	3
tests/test_generate_waveform.py	6	6
tests/test_helpers.py	71	71
tests/test_ieee_scpi_cmds.py	1	1
tests/test_margin_testers.py	5	5
tests/test_pi_device.py	1	1
tests/test_psu.py	1	1
tests/test_rest_api_device.py	10	10
tests/test_scopes.py	7	7
tests/test_singleton.py	1	1
tests/test_smu.py	4	4
tests/test_ss.py	1	1
tests/test_tm_devices.py	4	4
tests/test_unsupported_device_type.py	1	1
TOTAL	199	199

Link to workflow run

tektronix / tm_devices