functions.py

from pyvisa import ResourceManager
from .constants import InstrumentType
from . import models


__all__ = ['get_resource_manager', 'close_resource_manager', 'list_resources', 'list_resources_info', 'resource_info', 'get_instrument_lib']


rm = ResourceManager()


def get_resource_manager():
    """
    Get the pyvisa.ResourceManager instance that is used globally by PyInst.

    :Return type: pyvisa.ResourceManager
    """
    return rm


def close_resource_manager():
    """
    Close the global resource manager session.
    """
    rm.close()


def list_resources():
    """
    List resource names of all connected devices.

    :Return type: tuple(str)
    """
    return rm.list_resources()


def list_resources_info():
    """
    Returns a dictionary mapping resource names to resource extended information of all connected devices.

    :Returns: Mapping of resource name to ResourceInfo

    :Return type: dict{str => pyvisa.highlevel.ResourceInfo}
    """
    return rm.list_resources_info()


def resource_info(resource_name, extended=True):
    """
    Get the (extended) information of a particular resource.

    :Parameters: **resource_name** - Unique symbolic name of a resource.

    :Return type: pyvisa.highlevel.ResourceInfo
    """
    return rm.resource_info(resource_name, extended)

def get_instrument_lib(detailed=True):
    """
    Get instrument model lib classified by type.

    :Returns: (Detailed) model information classified by its type.

    :Return Type:
        - **details = True** - ``dict{instrument_type => list[{"model" => str, "brand" => str, "class_name" => str, "params" => list, "details" => dict}]}``
        - **details = False** - ``dict{instrument_type => list[model_name]}``
    """
    model_lib = {}
    model_dict = models.__dict__
    for i in InstrumentType:
        model_lib[i.name] = []
    for i in model_dict:
        if i.startswith('Model'):
            model_cls = model_dict[i]
            model_str = model_cls.model
            if isinstance(model_str, (tuple, list)):
                model_str = '/'.join(model_cls.model)
            brand = model_cls.brand
            class_name = i
            params = model_cls.params
            details = model_cls.details
            type_str_list = [m.__name__.replace('Type', '') for m in model_cls.mro() if m.__name__.startswith('Type')]
            for type_str in type_str_list:
                if detailed:
                    model_lib[type_str].append({'model': model_str, 'brand': brand, 'class_name': class_name,
                                                'params': params, 'details': details})
                else:
                    model_lib[type_str].append(model_str)
    return model_lib