Updated .proto files and session management API (#173)

* Updated proto files

* Updated CONTRIBUTING.md

* Updated generate_grpc_stubs.py

* Generated gRPC stubs

* Updated session_management.py

* Updated examples

* Make updated .proto files work with nimi-python (#176)

* generate_grpc_stubs.py: Regenerate test stubs

* ni-measurement-service: Upgrade to protobuf >=4.21

* Update poetry lock

* Regenerate gRPC/protobuf codegen

* generate_grpc_stubs.py: Blacken test code and parameterize functions

* Update mypy/typing packages

* generate_grpc_stubs.py: Fix type annotations

* Update poetry lock

* Regenerate test stubs

* Rerun Black

* Regenerate protobuf/gRPC stubs

* Rerun Black

* ni-measurement-service: Revert session.proto update

* ni-measurement-service: Regenerate session.proto codegen

* generate_grpc_stubs.py: Fix root-import paths in non-root imports

* ni-measurement-service: Update session_pb2 import

* ni-measurement-service: Move session.proto to proto root

* Regenerate protobuf/gRPC stubs.

* session_management.py: Refer to instrument type id constants

* session_management.py: Fix import order

* session_management.py: Rerun black

Co-authored-by: Brad Keryan <brad.keryan@ni.com>

Author: tkrebes

CONTRIBUTING.md

@@ -73,6 +73,8 @@ The `ni_measurement_service\_internal\stubs` directory contains the auto-generat
 - ni/measurementlink/measurement/v1/measurement_service.proto
 - ni/measurementlink/pinmap/v1/pin_map_service.proto
 - ni/measurementlink/sessionmanagement/v1/session_management_service.proto
+- nidevice_grpc/README.md
+- nidevice_grpc/session.proto
 
 The latest .proto files are available in [Azure Repo](https://dev.azure.com/ni/DevCentral/_git/ASW?path=/Source/Protos). From the Azure Repo manually download and overwrite the proto files under the `ni_measurement_service\_internal\stubs\proto` folder.
 

examples/nidcpower_source_dc_voltage/measurement.py

@@ -69,7 +69,7 @@ def measure(
         reservation = stack.enter_context(
             session_management_client.reserve_sessions(
                 context=measurement_service.context.pin_map_context,
-                pin_names=[pin_name],
+                pin_or_relay_names=[pin_name],
                 instrument_type_id=nims.session_management.INSTRUMENT_TYPE_NI_DCPOWER,
                 timeout=-1,
             )

examples/nidcpower_source_dc_voltage/teststand_fixture.py

@@ -60,17 +60,12 @@ def destroy_nidcpower_sessions():
             grpc_channel=grpc_channel_pool.session_management_channel
         )
 
-        with session_management_client.reserve_all_registered_sessions(timeout=-1) as reservation:
-            nidcpower_sessions = [
-                session_info
-                for session_info in reservation.session_info
-                if session_info.instrument_type_id
-                == nims.session_management.INSTRUMENT_TYPE_NI_DCPOWER
-            ]
-
-            session_management_client.unregister_sessions(nidcpower_sessions)
+        with session_management_client.reserve_all_registered_sessions(
+            instrument_type_id=nims.session_management.INSTRUMENT_TYPE_NI_DCPOWER, timeout=-1
+        ) as reservation:
+            session_management_client.unregister_sessions(reservation.session_info)
 
-            for session_info in nidcpower_sessions:
+            for session_info in reservation.session_info:
                 grpc_options = nidcpower.GrpcSessionOptions(
                     grpc_channel_pool.get_grpc_device_channel(
                         nidcpower.GRPC_SERVICE_INTERFACE_NAME

examples/nidcpower_source_dc_voltage_with_labview_ui/measurement.py

@@ -69,7 +69,7 @@ def measure(
         reservation = stack.enter_context(
             session_management_client.reserve_sessions(
                 context=measurement_service.context.pin_map_context,
-                pin_names=pin_names,
+                pin_or_relay_names=pin_names,
                 instrument_type_id=nims.session_management.INSTRUMENT_TYPE_NI_DCPOWER,
                 timeout=-1,
             )

examples/nidcpower_source_dc_voltage_with_labview_ui/teststand_fixture.py

@@ -60,17 +60,12 @@ def destroy_nidcpower_sessions():
             grpc_channel=grpc_channel_pool.session_management_channel
         )
 
-        with session_management_client.reserve_all_registered_sessions(timeout=-1) as reservation:
-            nidcpower_sessions = [
-                session_info
-                for session_info in reservation.session_info
-                if session_info.instrument_type_id
-                == nims.session_management.INSTRUMENT_TYPE_NI_DCPOWER
-            ]
-
-            session_management_client.unregister_sessions(nidcpower_sessions)
+        with session_management_client.reserve_all_registered_sessions(
+            instrument_type_id=nims.session_management.INSTRUMENT_TYPE_NI_DCPOWER, timeout=-1
+        ) as reservation:
+            session_management_client.unregister_sessions(reservation.session_info)
 
-            for session_info in nidcpower_sessions:
+            for session_info in reservation.session_info:
                 grpc_options = nidcpower.GrpcSessionOptions(
                     grpc_channel_pool.get_grpc_device_channel(
                         nidcpower.GRPC_SERVICE_INTERFACE_NAME

examples/nidmm_measurement/measurement.py

@@ -83,7 +83,7 @@ def measure(
         reservation = stack.enter_context(
             session_management_client.reserve_sessions(
                 context=measurement_service.context.pin_map_context,
-                pin_names=[pin_name],
+                pin_or_relay_names=[pin_name],
                 instrument_type_id=nims.session_management.INSTRUMENT_TYPE_NI_DMM,
                 timeout=-1,
             )

examples/nidmm_measurement/teststand_fixture.py

@@ -56,16 +56,12 @@ def destroy_nidmm_sessions():
             grpc_channel=grpc_channel_pool.session_management_channel
         )
 
-        with session_management_client.reserve_all_registered_sessions(timeout=-1) as reservation:
-            nidmm_sessions = [
-                session_info
-                for session_info in reservation.session_info
-                if session_info.instrument_type_id == nims.session_management.INSTRUMENT_TYPE_NI_DMM
-            ]
-
-            session_management_client.unregister_sessions(nidmm_sessions)
+        with session_management_client.reserve_all_registered_sessions(
+            instrument_type_id=nims.session_management.INSTRUMENT_TYPE_NI_DMM, timeout=-1
+        ) as reservation:
+            session_management_client.unregister_sessions(reservation.session_info)
 
-            for session_info in nidmm_sessions:
+            for session_info in reservation.session_info:
                 grpc_options = nidmm.GrpcSessionOptions(
                     grpc_channel_pool.get_grpc_device_channel(nidmm.GRPC_SERVICE_INTERFACE_NAME),
                     session_name=session_info.session_name,

examples/nifgen_standard_function/measurement.py

@@ -90,7 +90,7 @@ def cancel_callback():
         reservation = stack.enter_context(
             session_management_client.reserve_sessions(
                 context=measurement_service.context.pin_map_context,
-                pin_names=[pin_name],
+                pin_or_relay_names=[pin_name],
                 instrument_type_id=nims.session_management.INSTRUMENT_TYPE_NI_FGEN,
                 timeout=-1,
             )

examples/nifgen_standard_function/teststand_fixture.py

@@ -60,17 +60,12 @@ def destroy_nifgen_sessions():
             grpc_channel=grpc_channel_pool.session_management_channel
         )
 
-        with session_management_client.reserve_all_registered_sessions(timeout=-1) as reservation:
-            nifgen_sessions = [
-                session_info
-                for session_info in reservation.session_info
-                if session_info.instrument_type_id
-                == nims.session_management.INSTRUMENT_TYPE_NI_FGEN
-            ]
-
-            session_management_client.unregister_sessions(nifgen_sessions)
+        with session_management_client.reserve_all_registered_sessions(
+            instrument_type_id=nims.session_management.INSTRUMENT_TYPE_NI_FGEN, timeout=-1
+        ) as reservation:
+            session_management_client.unregister_sessions(reservation.session_info)
 
-            for session_info in nifgen_sessions:
+            for session_info in reservation.session_info:
                 grpc_options = nifgen.GrpcSessionOptions(
                     grpc_channel_pool.get_grpc_device_channel(nifgen.GRPC_SERVICE_INTERFACE_NAME),
                     session_name=session_info.session_name,

examples/niscope_acquire_waveform/measurement.py

@@ -92,7 +92,7 @@ def measure(
 ) -> Tuple:
     """Acquire a waveform using an NI oscilloscope."""
     logging.info(
-        "Starting acquisition: pin_names=%s vertical_range=%g trigger_source=%s trigger_level=%g",
+        "Starting acquisition: pin_or_relay_names=%s vertical_range=%g trigger_source=%s trigger_level=%g",
         pin_names,
         vertical_range,
         trigger_source,
@@ -120,7 +120,7 @@ def cancel_callback():
         reservation = stack.enter_context(
             session_management_client.reserve_sessions(
                 context=measurement_service.context.pin_map_context,
-                pin_names=pin_list,
+                pin_or_relay_names=pin_list,
                 instrument_type_id=nims.session_management.INSTRUMENT_TYPE_NI_SCOPE,
                 timeout=-1,
             )