utils.py

import logging
import exceptions
import json

stateSet = {"core:ClosureState","core:OpenClosedState","core:LuminanceState"} #list of states that trigger domoticz widget update

def filter_devices(Data):
    logging.debug("start filter devices")

    if (not "uiClass" in json.dumps(Data)):
        logging.error("filter_devices: missing uiClass in response")
        logging.debug(str(Data))
        return

    filtered_devices = list()
    for device in Data:
        logging.debug("filter_devices: Device name: "+device["label"]+" Device class: "+device["definition"]["uiClass"])
        if (((device["definition"]["uiClass"] == "RollerShutter") 
            or (device["definition"]["uiClass"] == "LightSensor") 
            or (device["definition"]["uiClass"] == "ExteriorScreen") 
            or (device["definition"]["uiClass"] == "Screen") 
            or (device["definition"]["uiClass"] == "Awning") 
            or (device["definition"]["uiClass"] == "Pergola") 
            or (device["definition"]["uiClass"] == "GarageDoor") 
            or (device["definition"]["uiClass"] == "Window") 
            or (device["definition"]["uiClass"] == "VenetianBlind") 
            or (device["definition"]["uiClass"] == "ExteriorVenetianBlind")) 
            and ((device["deviceURL"].startswith("io://")) or (device["deviceURL"].startswith("rts://"))) 
            or (device["definition"]["uiClass"] == "Pod" and device["deviceURL"].startswith("internal://"))):
            filtered_devices.append(device)
            logging.debug("supported device found: "+ str(device))
        else:
            logging.debug("unsupported device found: "+ str(device))

    logging.debug("finished filter devices")
    return filtered_devices

def filter_events(Data):
    """filters relevant (DeviceStateChangedEvent) out of a events list"""
    logging.debug("start filter events")
    filtered_events = list()

    for event in Data:
        if (event["name"] == "DeviceStateChangedEvent" or event["name"] == "DeviceState"):
            logging.debug("get_events: add event: URL: '"+event["deviceURL"]+"' num states: '"+str(len(event["deviceStates"]))+"'")
            for event_state in event["deviceStates"]:
                logging.debug("   get_events: eventname: '"+event_state["name"]+"' with value: '"+str(event_state["value"])+"'")
            filtered_events.append(event)

    logging.debug("finished filter events")
    return filtered_events

def filter_states(Data):
    """filters relevant state data from a device setup API reply"""
    logging.debug("start filter states")
    filtered_states = list()
    deviceURL = ""
    
    for device in Data:
        stateList = list()
        deviceURL = device["deviceURL"]
        if not "states" in device:
            continue
        for state in device["states"]:
            if state["name"] in stateSet:
                stateList.append(state)
        if len(stateList)>0:
            stateToAdd = {"deviceURL":deviceURL, 
                "deviceStates":stateList,
                "name":"DeviceState"}
            filtered_states.append(stateToAdd)
    return filtered_states

def handle_response(response, action):
    """handle faulty responses"""
    if response.status_code >= 300 and response.status_code < 400:
        logging.error("status code " + str(response.status_code) + " this is likely a bug")
        raise exceptions.TahomaException("failed request during "+ action + ": " + str(response.status_code))
    elif response.status_code == 400:
        logging.error("status code " + str(response.status_code) + " this is a bug, bad request made, url or body needs to be checked")
        raise exceptions.TahomaException("failed request during "+ action + ", check url or body: " + str(response.status_code))
    elif response.status_code == 401:
        logging.error("status code " + str(response.status_code) + " authorisation failed, check credentials")
        raise exceptions.TahomaException("failed request during "+ action + ", check credentials: " + str(response.status_code))
    elif response.status_code == 404:
        logging.error("status code " + str(response.status_code) + " server not found")
        raise exceptions.TahomaException("failed request during "+ action + ", server not found: " + str(response.status_code))
    elif response.status_code >= 500:
        logging.error("status code " + str(response.status_code) + " a server sided problem")
        raise exceptions.TahomaException("failed request during "+ action + ": " + str(response.status_code))
    else:
        logging.error("status code " + str(response.status_code))
        raise exceptions.TahomaException("failed request during "+ action + ": " + str(response.status_code))        
    return