ni.measurementlink.pinmap.v1.client
Public API for accessing the NI Pin Map Service.
Classes
Client for accessing the NI Pin Map Service via gRPC. |
Package Contents
- class ni.measurementlink.pinmap.v1.client.PinMapClient(*, discovery_client=None, grpc_channel=None, grpc_channel_pool=None)[source]
Bases:
ni.measurementlink.pinmap.v1.client._client_base.GrpcServiceClientBase[ni.measurementlink.pinmap.v1.pin_map_service_pb2_grpc.PinMapServiceStub]Client for accessing the NI Pin Map Service via gRPC.
Initialize the pin map client.
- Parameters:
discovery_client (ni.measurementlink.discovery.v1.client.DiscoveryClient | None) – An optional discovery client (recommended).
grpc_channel (grpc.Channel | None) – An optional pin map gRPC channel.
grpc_channel_pool (ni_grpc_extensions.channelpool.GrpcChannelPool | None) – An optional gRPC channel pool (recommended).
- __slots__ = ()
- update_pin_map(pin_map_path)[source]
Update registered pin map contents.
Create and register a pin map if a pin map resource for the specified pin map id is not found.
- Parameters:
pin_map_path (str | pathlib.Path) – The file path of the pin map to register as a pin map resource.
- Returns:
The resource id of the pin map that is registered to the pin map service.
- Return type: