utils.py

"""
Supporting utility functions for remote control panel
Written By: Kathryn Cogert
Jan 25 2017
"""
import numpy as np
import http.client
import urllib.error
import urllib.request
from xml.etree import ElementTree
import customerrs

# User will need to ensure that they have the right variable library structure, especially for calibration constants.
#b/c you will need ni.var.psp://cRIO#-WinklerLab/R#Variables/R#CalibrationConstants in calibration constant assignment VI
# TODO: debug Sending cRIO# and Reactor Number to calibration constant setting guy
# >Define Constants
# List of actions you can take on a control Loop
ACTIONS = ['Switch',  # Switch control loop on or off
           'Status',  # Get status of control loop
           'Manual',  # Control Loop Actuators Manually
           'SetParams']  # Set control loop parameters, i.e. gain, set pt, etc.

# ISE Parameter Rules
ISE_RULES = {'Equilibrium': 'Eq',
             'Detection': 'Detect',
             'On?': 'On',
             'Set Point': 'Set',
             'Time': 'Time',
             'Assumed': '',
             'Correction Factor': 'CF',
             'Concentration': 'Conc'}

# TODO: Can I use this?
# Chemical Compounds
CHEMS = {'Sodium': 'Na',
         'Potassium': 'K',
         'Phosphate': 'NH4',
         'Bromide': 'Br',
         'Copper': 'Cu',
         'Mercury': 'Hg',
         'Silver': 'Ag',
         'Cyanide': 'CN',
         'Nitrate': 'NO3',
         'Nitrite': 'NO2',
         'Cadmium': 'Cd',
         'Fluoride': 'Fl',
         'Sulphide': 'S',
         'Calcium': 'Ca',
         'Iodide': 'I',
         'Perchlorate': 'CLO4',
         'Thiocyanate': 'SCN',
         'Chloride': 'Cl',
         'Lead': 'Pb'}

# List of types of on/off actuators that require boolean inputs
BOOL_ACTS = ['Pump', 'Valve', 'Switch', 'On', '?']

TRI_ACTS = ['Steady State?', 'SteadyState?']


# >Utility Functions

# https://stackoverflow.com/questions/20924085/python-conversion-between-coordinates
def cart2pol(x, y):
    rho = np.sqrt(x**2 + y**2)
    phi = np.arctan2(y, x)
    return(rho, phi)


def pol2cart(rho, phi):
    x = rho * np.cos(phi)
    y = rho * np.sin(phi)
    return(x, y)


def convert_to_localvar(labelstr):
    """
    Remove spaces and units from parameter labels for submission to the cRIO
    :param labelstr:
    :return:
    """
    labelstr = labelstr.split(',')[0]
    varstr = labelstr.replace(' ', '')
    return varstr

def convert_to_datatype(xmlarray):
    """
    Take name/value pair in XML tree and convert to boolean if on/off actuator
    :param xmlarray: array of xml elements, name/value pair
    :return: bool or float, converted value (if conversion was required)
    """
    try:
        value = float(xmlarray[1].text)
    except ValueError:
        value = xmlarray[1].text
    # TODO: Get rid of GetOtherConstants and instead use cRIO umber
    name = convert_to_localvar(xmlarray[0].text)
    for actuator in TRI_ACTS:
        if actuator == name[len(name) - len(actuator):len(name)]:
            if value in [0, 1]:
                value = bool(value)
            else:
                value = None
            return value
    for actuator in BOOL_ACTS:
        # If this is a timer (i.e. pH control system, assign as float)
        if actuator + 'Time' in name:
            return value
        if actuator == name[len(name)-len(actuator):len(name)]:
            if value in [0, 1]:
                value = bool(value)
            else:
                raise customerrs.NonBoolean
            return value
    return value


def build_url(ip, port, reactorno, vi_to_run, command=''):
    """
    Builds a GET request url that the cRIO will understand
    :param ip: str, the cRIO IP address
    :param port: int, the port of the webservice
    :param reactorno: int, # of the reactor
    :param vi_to_run: str, the name of the vi in the cRIO webservice
    :param command: str, the command to pass to the GET request
    :return:
    """
    r_name = 'R'+str(reactorno)
    url = 'http://'+ip+':'+str(port)+'/'+r_name+'/'+vi_to_run+command
    #print(url)
    return url


def call_reactor(ip, port, reactorno, url, status=False):
    """

    :param ip: str, the cRIO IP address
    :param port: int, the port to access webservice on
    :param reactorno: int, # of the reactor
    :param url: str, url to be requested
    :param status: if just reading status, this is True
    :return:
    """
    try:
        result = urllib.request.urlopen(url).read()
        root = ElementTree.fromstring(result)
        return root
    except urllib.error.HTTPError:
        if status:
            raise customerrs.UnfoundStatus('Could not access ' + url)
        else:
            raise customerrs.CannotReachReactor(
                'While attempting to access ' + url +
                ', cannot find Reactor #' + str(reactorno))
    except urllib.error.URLError:
        raise customerrs.CannotReachReactor(
            'While attempting to access ' + url +
            ' cRIO could not be found at ' + str(ip) + ':' + str(port))
    except http.client.RemoteDisconnected:
        raise customerrs.CannotReachReactor(
            'While attempting to access ' + url +
            ' cRIO disconnected during query IP:' + str(ip) + ':' + str(port))