viam.errors

Exceptions

ViamError

Base Viam Error

InsecureConnectionError

Exception raised when establishing an insecure connection

DuplicateResourceError

Exception raised when attempting to register a resource

ViamGRPCError

Exception raised if it could happen as a part of GRPC calls.

ResourceNotFoundError

Exception raised when a resource is not found in the registry

MethodNotImplementedError

Exception raised when specific methods are unimplemented.

NotSupportedError

Exception raised when specific component functionality is not supported

ValidationError

Exception raised when there is an error during module validation

NoCaptureToStoreError

Exception raised in filter module to signal that data capture should not be stored

Module Contents

exception viam.errors.ViamError[source]

Bases: Exception

Base Viam Error

exception viam.errors.InsecureConnectionError(address: str, authenticated: bool = False)[source]

Bases: ViamError

Exception raised when establishing an insecure connection

address

The endpoint of the connection

authenticated

True if the insecure connection provided credentials

message

Explanation of the error

address
authenticated
message
exception viam.errors.DuplicateResourceError(name: str)[source]

Bases: ViamError

Exception raised when attempting to register a resource with the same name as an existing resource already in the registry

name
message
exception viam.errors.ViamGRPCError(message: str = '', grpc_code: grpclib.Status = Status.INTERNAL)[source]

Bases: ViamError

Exception raised if it could happen as a part of GRPC calls.

message
grpc_code
property grpc_error: grpclib.GRPCError
exception viam.errors.ResourceNotFoundError(resource: str, name: str)[source]

Bases: ViamGRPCError

Exception raised when a resource is not found in the registry

resource
name
message
grpc_code
exception viam.errors.MethodNotImplementedError(method_name: str)[source]

Bases: ViamGRPCError

Exception raised when specific methods are unimplemented.

message
grpc_code
exception viam.errors.NotSupportedError(message: str)[source]

Bases: ViamGRPCError

Exception raised when specific component functionality is not supported

message
grpc_code
exception viam.errors.ValidationError(message: str)[source]

Bases: ViamGRPCError

Exception raised when there is an error during module validation

message
grpc_code
exception viam.errors.NoCaptureToStoreError[source]

Bases: ViamGRPCError

Exception raised in filter module to signal that data capture should not be stored

message = 'no capture from filter module'
grpc_code