def __init__(self, database):
self.database = database
self.rooms = {}
self.events = []
self.queue = MyPriorityQueue()
self.listenerManager = ListenerManager()
self.listenerManager.addListener(self.reactToEvent)
self.methodThread = Thread(name="Method Thread", target=self.executeFromQueue)
self.methodThread.daemon = True
self.methodThread.start()
self.pluginManager = PluginManager(self.rooms, self.events, self.queue)
self.listenerManager.addListener(self.pluginManager.notify)
def __init__(self, database):
self.database = database
self.rooms = {}
self.events = []
self.queue = MyPriorityQueue()
self.listenerManager = ListenerManager()
self.listenerManager.addListener(self.reactToEvent)
self.methodThread = Thread(name="Method Thread", target=self.executeFromQueue)
self.methodThread.daemon = True
self.methodThread.start()
self.pluginManager = PluginManager(self.rooms, self.events, self.queue)
self.listenerManager.addListener(self.pluginManager.notify)
class House(object):
"""
Main class to represent the house
"""
def __init__(self, database):
self.database = database
self.rooms = {}
self.events = []
self.queue = MyPriorityQueue()
self.listenerManager = ListenerManager()
self.listenerManager.addListener(self.reactToEvent)
self.methodThread = Thread(name="Method Thread", target=self.executeFromQueue)
self.methodThread.daemon = True
self.methodThread.start()
self.pluginManager = PluginManager(self.rooms, self.events, self.queue)
self.listenerManager.addListener(self.pluginManager.notify)
def initFromDatabase(self):
"""Initialises the house from the database"""
rooms = self.database.room.retrieveAllData()
for room in rooms:
self.rooms[room.id] = room
items = self.database.items.retrieveForRoomId(room)
if len(items) > 0:
for item in items:
self.rooms[room.id].items[item._id] = item
item.listener = self.listenerManager
# a bit of a hack...
self.events = self.database.events.getEvents()
for event in self.events:
if event.room is not None:
event.room = self.rooms[event.room]
event.item = self.getItemById(event.item)
event.conditions = self.database.conditions.getConditionsForEvent(event)
for condition in event.conditions:
condition.item = self.getItemById(condition.item)
event.actions = self.database.actions.getActionsForEvent(event)
for action in event.actions:
if action.room is not None:
action.room = self.rooms[action.room]
action.item = self.getItemById(action.item)
def addRoom(self, name):
"""
Adds a room to the house system and the database
Arguments:
name -- the name of the room
"""
room = Room(None, name)
id = self.database.room.addEntry(room)
if id == -1:
raise Exception("Database error while adding a room")
self.rooms[id] = room
return id
def updateRoom(self, roomId, name):
"""
Updates a specific room
Arguments:
roomId -- the id of the room
name -- new name for the given room
"""
if roomId in self.rooms:
self.rooms[roomId].name = name
self.database.room.updateEntry(self.rooms[roomId])
else:
raise KeyError("Invalid roomId")
def deleteRoom(self, roomId):
"""
Deletes a specific roomId
Arguments:
roomId -- the id of the room to delete
"""
if roomId in self.rooms:
self.database.room.removeEntry(self.rooms[roomId])
del self.rooms[roomId]
else:
raise KeyError("Invalid roomId")
def addItem(self, roomId, name, brand, type, ip):
"""
Adds an item to the house system and the database
Arguments:
roomId -- the id of the room to which the item is added
name -- name of the item
brand -- the brand of the item (e.g. arduino)
type -- the type of the item (e.g. motionSensor)
ip -- the ip of the item
"""
if roomId in self.rooms:
item = data.types[type](None, name, brand, type, ip, self.listenerManager)
itemId = self.database.items.addEntry(item, roomId)
self.rooms[roomId].addItem(itemId, item)
else:
raise KeyError("Invalid roomId")
return itemId
def updateItem(self, roomId, itemId, name, brand, type, ip):
"""
Updates an item to the house system and the database
Arguments:
roomId -- the id of the room in which the item is
itemId -- the id of the room to update
name -- new/current if unchanged name of the item
brand -- new/current if unchanged brand of the item (e.g. arduino)
type -- new/current if unchanged type of the item (e.g. motionSensor)
ip -- tnew/current if unchangedhe ip of the item
"""
if roomId in self.rooms and itemId in self.rooms[roomId].items:
self.rooms[roomId].items[itemId].name = name
self.rooms[roomId].items[itemId].brand = brand
self.rooms[roomId].items[itemId].ip = ip
self.rooms[roomId].items[itemId]._type = type
self.rooms[roomId].items[itemId].roomId = roomId
self.database.items.updateEntry(self.rooms[roomId].items[itemId], roomId)
else:
raise KeyError("Invalid roomId or itemId")
return itemId
def deleteItem(self, roomId, itemId):
"""
Deletes an item
Arguments:
roomId -- the id of the room in which the item is
itemid -- the id of the item to be deleted
"""
if roomId in self.rooms and itemId in self.rooms[roomId].items:
self.database.items.removeEntry(self.rooms[roomId].items[itemId])
del self.rooms[roomId].items[itemId]
else:
raise KeyError("Invalid roomId or itemId")
def getItemById(self, itemId):
"""
Returns the item with the specified id
Arguments:
itemId -- the id of the item
"""
for room in self.rooms:
if itemId in self.rooms[room].items:
return self.rooms[room].items[itemId]
def getItemByIP(self, ip):
"""
Returns the item with the specified IP address
Arguments:
ip -- the IP address of the item
"""
for room in self.rooms:
for item in self.rooms[room].items:
if self.rooms[room].items[item].ip == ip:
return self.rooms[room].items[item]
raise Exception("No sensor found for IP: " + ip)
def getItemsByType(self, _type):
"""
Returns all items in the house of a particular type
Arguments:
type -- the type of the item
"""
items = []
for room in self.rooms:
for item in self.rooms[room].items:
if self.rooms[room].items[item]._type == _type:
items.append(self.rooms[room].items[item])
return items
def getRoomByItemId(self, itemId):
"""
Returns the room which has the item with the specified id
Arguments:
itemId -- the id of the item
"""
for room in self.rooms:
if itemId in self.rooms[room].items:
return self.rooms[room]
def getStructure(self):
"""Returns the overall structure of the house"""
return {"rooms": [self.rooms[r].getStructure() for r in self.rooms]}
def getState(self):
"""
Returns the state of the house
"""
states = []
for r in self.rooms:
states = states + self.rooms[r].getState()
return {"states": states}
def getVersion(self):
"""
Returns the API version that this house is compatible with
"""
methods = self.database.getMethodsWithTypes()
methodList = [[]]
namesList = []
j = 0
for i in range(0, len(methods)):
temp = i + 1
if temp > len(methods) - 1:
temp = 0
if methods[i][0] == methods[temp][0]:
methodList[j].append(methods[i][1])
else:
namesList.append(methods[i][0])
methodList.append([])
methodList[j].append(methods[i][1])
j += 1
methodsJSON = zip(namesList, methodList)
dictVersion = {}
for m in methodsJSON:
dictVersion[m[0]] = {
"name": data.typesNice[m[0]],
"isPassive": data.passive[data.types[m[0]]],
"methods": m[1],
"supportedBrands": data.supportedBrands[m[0]],
"states": data.states[m[0]],
}
finalDict = {}
finalDict["supportedTypes"] = dictVersion
return finalDict
def getRules(self):
"""
Returns ECA Rules in the correct API format
"""
rules = []
for event in self.events:
ruleJSON = {"ruleId": event.id, "ruleName": event.name, "enabled": bool(event.enabled)}
eventJSON = {"itemType": event.type}
value = None
for state in data.states[event.type]:
if state["name"] == event.trigger:
value = state["id"]
break
eventJSON["value"] = value
if not event.item is None:
eventJSON["id"] = event.item._id
eventJSON["scope"] = "item"
elif not event.room is None:
eventJSON["id"] = event.room.id
eventJSON["scope"] = "room"
else:
eventJSON["id"] = None
eventJSON["scope"] = "house"
ruleJSON["event"] = eventJSON
conditionsJSON = []
ruleJSON["conditions"] = conditionsJSON
for c in event.conditions:
conditionsJSON.append(
{
"conditionId": c.id,
"itemId": c.item._id,
"itemType": c.item._type,
"method": c.methodName,
"equivalence": c.equivalence,
"value": c.value,
}
)
actionsJSON = []
ruleJSON["actions"] = actionsJSON
for a in event.actions:
actionJSON = {"actionId": a.id, "method": a.methodName, "itemType": a.type}
if not a.item is None:
actionJSON["id"] = a.item._id
actionJSON["scope"] = "item"
elif not a.room is None:
actionJSON["id"] = a.room.id
actionJSON["scope"] = "room"
else:
actionJSON["id"] = None
actionJSON["scope"] = "house"
actionsJSON.append(actionJSON)
rules.append(ruleJSON)
return {"rules": rules}
def addEvent(self, name, _type, _id, scope, value, enabled):
"""
Adds an event to the house and database
Arguments:
name -- the name of the rule
_type -- the type of the item the event concerns
_id -- the id of the item/room which depends on scope
scope -- the scope of the event ("item"/"room"/"house")
value -- the triggering state of the item
enabled -- whether the rule is enabled (1/0)
"""
trigger = None
for state in data.states[_type]:
if state["id"] == value:
trigger = state["name"]
break
if trigger is None:
raise Exception("Invalid type and value combination")
if scope == "item":
item = self.getItemById(_id)
room = None
elif scope == "room":
item = None
room = self.rooms[_id]
elif scope == "house":
item = None
room = None
else:
raise Exception("Invalid scope parameter")
event = eca.Event(None, name, _type, item, room, trigger, enabled)
self.events.append(event)
self.database.events.addEntry(event)
return event.id
def updateEvent(self, name, _type, _id, scope, value, enabled, eventId):
"""
Updates an event in the house and database
Arguments:
name -- the name of the rule
_type -- the type of the item the event concerns
_id -- the id of the item/room which depends on scope
scope -- the scope of the event ("item"/"room"/"house")
value -- the triggering state of the item
enabled -- whether the rule is enabled (1/0)
"""
trigger = None
for state in data.states[_type]:
if state["id"] == value:
trigger = state["name"]
break
if trigger is None:
raise Exception("Invalid type and value combination")
if scope == "item":
item = self.getItemById(_id)
room = None
elif scope == "room":
item = None
room = self.rooms[_id]
elif scope == "house":
item = None
room = None
else:
raise Exception("Invalid scope parameter")
e = None
for event in self.events:
if event.id == eventId:
event.name = name
event.type = _type
event.item = item
event.room = room
event.trigger = trigger
event.enabled = enabled
e = event
break
if e is None:
raise Exception("Invalid event ID")
self.database.events.updateEntry(e)
def deleteEvent(self, eventId):
"""
Deletes an event from the house and database
Arguments:
eventId -- the id of the event to be deleted
"""
e = None
for event in self.events:
if event.id == eventId:
e = event
self.events.remove(e)
break
if e is None:
raise Exception("Invalid event ID")
self.database.events.removeEntry(e)
# Conditions and Actions for this event will also be deleted by the database
def addCondition(self, itemId, equivalence, value, eventId):
"""
Adds a condition to the correct event and the database
Arguments:
itemId -- the id of the item the condition concerns
equivalence -- the equivalence to use on the item state and the value
value -- the state needed for the equivalence to pass
eventId -- the id of the event this condition is matched to
"""
if equivalence == "is":
equivalence = "="
methodName = self.database.methods.getNiceStateName(itemId)
condition = eca.Condition(None, self.getItemById(itemId), "getState", methodName, equivalence, value)
self.database.conditions.addEntry(condition, eventId)
for e in self.events:
if e.id == eventId:
e.conditions.append(condition)
return condition.id
def updateCondition(self, itemId, equivalence, value, eventId, conditionId):
"""
Updates a condition in the house and database
Arguments:
conditionId -- the id of the condition to be updated
itemId -- the id of the item the condition concerns
equivalence -- the equivalence to use on the item state and the value
value -- the state needed for the equivalence to pass
eventId -- the id of the event this condition is matched to
"""
if equivalence == "is":
equivalence = "="
event = None
for e in self.events:
if e.id == eventId:
event = e
break
if event is None:
raise Exception("Invalid event id")
condition = None
for c in event.conditions:
if c.id == conditionId:
condition = c
break
if condition is None:
raise Exception("Invalid condition id")
methodName = self.database.methods.getNiceStateName(itemId)
condition.item = self.getItemById(itemId)
condition.method = "getState"
condition.methodName = methodName
condition.equivalence = equivalence
condition.value = value
self.database.conditions.updateEntry(condition, eventId)
def deleteCondition(self, eventId, conditionId):
"""
Deletes a condition from the house and database
Arguments:
eventId -- the id of the event this condition is matched to
conditionId -- the id of the condition to be deleted
"""
event = None
for e in self.events:
if e.id == eventId:
event = e
break
if event is None:
raise Exception("Invalid event id")
condition = None
for c in event.conditions:
if c.id == conditionId:
condition = c
break
if condition is None:
raise Exception("Invalid condition id")
self.database.conditions.removeEntry(condition)
event.conditions.remove(condition)
def addAction(self, _id, _type, scope, methodName, eventId):
"""
Adds an action to the house and database
Arguments:
_type -- the type of the item the action concerns
_id -- the id of the item/room which depends on scope
scope -- the scope of the event ("item"/"room"/"house")
methodName -- the action to perform
eventId -- the event the action belongs to
"""
if scope == "item":
item = self.getItemById(_id)
room = None
elif scope == "room":
item = None
room = self.rooms[_id]
elif scope == "house":
item = None
room = None
else:
raise Exception("Invalid scope parameter")
method = self.database.methods.getSignature(methodName, _type)
action = eca.Action(None, item, room, method, methodName, _type)
event = None
for e in self.events:
if e.id == eventId:
e.actions.append(action)
event = e
if event is None:
raise Exception("Invalid event id")
self.database.actions.addEntry(action, event.id)
return action.id
def updateAction(self, _id, _type, scope, methodName, eventId, actionId):
"""
Updates an action in the house and database
Arguments:
_type -- the type of the item the action concerns
_id -- the id of the item/room which depends on scope
scope -- the scope of the action ("item"/"room"/"house")
methodName -- the action to perform
eventId -- the event the action belongs to
actionId -- the id of the action to update
"""
if scope == "item":
item = self.getItemById(_id)
room = None
elif scope == "room":
item = None
room = self.rooms[_id]
elif scope == "house":
item = None
room = None
else:
raise Exception("Invalid scope parameter")
event = None
for e in self.events:
if e.id == eventId:
event = e
break
if event is None:
raise Exception("Invalid event id")
action = None
for a in event.actions:
if a.id == actionId:
action = a
break
if action is None:
raise Exception("Invalid action id")
action.item = item
action.room = room
action.method = self.database.methods.getSignature(methodName, _type)
action.methodName = methodName
action.type = _type
self.database.actions.updateEntry(action, eventId)
def deleteAction(self, eventId, actionId):
"""
Deletes an action from the house and database
Arguments:
eventId -- the id of the event this condition is matched to
actionId -- the id of the action to be deleted
"""
event = None
for e in self.events:
if e.id == eventId:
event = e
break
if event is None:
raise Exception("Invalid event id")
action = None
for a in event.actions:
if a.id == actionId:
action = a
break
if action is None:
raise Exception("Invalid action id")
self.database.actions.removeEntry(action)
event.actions.remove(action)
def getEventsForTrigger(self, item, trigger):
"""
Returns the possible events relating to an item trigger
Arguments:
item -- the item that triggered the event
trigger -- the name of the trigger
"""
possibleEvents = []
for event in self.events:
if (
event.enabled
and event.trigger == trigger
and (item == event.item or (self.getRoomByItemId(item._id) == event.room and item._type == event.type))
):
possibleEvents.append(event)
return possibleEvents
def reactToEvent(self, ip, trigger):
"""
Process a trigger event from a particular IP
Arguments:
ip -- the IP address of the item that sent the trigger
trigger -- the name of the trigger
"""
item = self.getItemByIP(ip)
possibleEvents = self.getEventsForTrigger(item, trigger)
itemsActedOn = []
events = []
for event in possibleEvents:
eventItemsActedOn = []
eventMatch = True
for action in event.actions:
if action.isConflictWithOtherActions(itemsActedOn + eventItemsActedOn):
eventMatch = False
break
else:
eventItemsActedOn.append(action.getItemsActedOn())
if eventMatch == True:
itemsActedOn.extend(eventItemsActedOn)
events.append(event)
for event in events:
conditionsMatched = True
for condition in event.conditions:
if not condition.check():
conditionsMatched = False
break
if not conditionsMatched:
continue
for action in event.actions:
if action.isAllItemsInHouse():
action.doAction(self.getItemsByType(action._type))
else:
action.doAction()
def executeFromQueue(self):
"""Executes method from the queue, run in a seperate thread"""
while True:
if not self.queue.empty():
self.executeMethod(*self.queue.get())
def addToQueue(self, roomId, itemId, method, args=[]):
"""
Adds a method to the queue
Arguments:
roomId -- id of the room
itemId -- id of the item
method -- method to be called
args -- arguments od the method, empty list by detault
"""
self.queue.put(roomId, itemId, method, args)
def executeMethod(self, roomId, itemId, method, args=[]):
"""
Executes a method on a given item
Arguments:
roomId -- the id of the room the item is in
itemId -- the id of the item
method -- the method to be called as a string
args -- the arguments for the method to be called, empty list by default
"""
return getattr(self.rooms[roomId].items[itemId], method)(*args)
def getEnergyByTime(self, startTime, endTime):
"""
Gets list of watts between the given dates
Arguments:
startTime - date string in format %Y_%m_%d_%H_%M_%S
endTime - date string in format %Y_%m_%d_%H_%M_%S
"""
def formatArg(arg):
ls = arg.split("_")
timeStr = ""
# incomplete query
i = 0
if len(ls) < 4:
while i < 3:
if i == 0:
timeStr = ""
elif i < 3:
timeStr += "-"
if i < len(ls):
timeStr += ls[i]
else:
timeStr += "01"
i += 1
return timeStr
else:
while i < len(ls):
if i == 0:
timeStr = timeStr + "" + ls[i]
elif i < 2:
timeStr = timeStr + "-" + ls[i]
elif i == 3:
timeStr = timeStr + " " + ls[i]
elif i < 6:
timeStr = timeStr + ":" + ls[i]
# else do nothing with excessive args
i += 1
return timeStr
# print formatArg(startTime)
# print formatArg(endTime)
dbResults = self.database.energy.getEnergyByTime(formatArg(startTime), formatArg(endTime))
energyList = []
for e in dbResults:
energyList.append({"time": e[0].strftime("%Y-%m-%d %H:%M:%S"), "watts": e[1]})
return {"values": energyList}
def getLatestEnergy(self):
"""
Gets latest energy reading
"""
dbResults = self.database.energy.getLatestEnergy()
energyList = []
for e in dbResults:
energyList.append({"time": e[0].strftime("%Y-%m-%d %H:%M:%S"), "watts": e[1]})
return {"values": energyList}
class House(object):
"""
Main class to represent the house
"""
def __init__(self, database):
self.database = database
self.rooms = {}
self.events = []
self.queue = MyPriorityQueue()
self.listenerManager = ListenerManager()
self.listenerManager.addListener(self.reactToEvent)
self.methodThread = Thread(name="Method Thread", target=self.executeFromQueue)
self.methodThread.daemon = True
self.methodThread.start()
self.pluginManager = PluginManager(self.rooms, self.events, self.queue)
self.listenerManager.addListener(self.pluginManager.notify)
def initFromDatabase(self):
"""Initialises the house from the database"""
rooms = self.database.room.retrieveAllData()
for room in rooms:
self.rooms[room.id] = room
items = self.database.items.retrieveForRoomId(room)
if len(items) > 0:
for item in items:
self.rooms[room.id].items[item._id] = item
item.listener = self.listenerManager
#a bit of a hack...
self.events = self.database.events.getEvents()
for event in self.events:
if event.room is not None:
event.room = self.rooms[event.room]
event.item = self.getItemById(event.item)
event.conditions = self.database.conditions.getConditionsForEvent(event)
for condition in event.conditions:
condition.item = self.getItemById(condition.item)
event.actions = self.database.actions.getActionsForEvent(event)
for action in event.actions:
if action.room is not None:
action.room = self.rooms[action.room]
action.item = self.getItemById(action.item)
def addRoom(self, name):
"""
Adds a room to the house system and the database
Arguments:
name -- the name of the room
"""
room = Room(None, name)
id = self.database.room.addEntry(room)
if id ==-1:
raise Exception("Database error while adding a room")
self.rooms[id] = room
return id
def updateRoom(self, roomId, name):
"""
Updates a specific room
Arguments:
roomId -- the id of the room
name -- new name for the given room
"""
if roomId in self.rooms:
self.rooms[roomId].name = name
self.database.room.updateEntry(self.rooms[roomId])
else:
raise KeyError("Invalid roomId")
def deleteRoom(self, roomId):
"""
Deletes a specific roomId
Arguments:
roomId -- the id of the room to delete
"""
if roomId in self.rooms:
self.database.room.removeEntry(self.rooms[roomId])
del self.rooms[roomId]
else:
raise KeyError("Invalid roomId")
def addItem(self, roomId, name, brand, type, ip):
"""
Adds an item to the house system and the database
Arguments:
roomId -- the id of the room to which the item is added
name -- name of the item
brand -- the brand of the item (e.g. arduino)
type -- the type of the item (e.g. motionSensor)
ip -- the ip of the item
"""
if roomId in self.rooms:
item = data.types[type](None, name, brand, type, ip, self.listenerManager)
itemId = self.database.items.addEntry(item, roomId)
self.rooms[roomId].addItem(itemId, item)
else:
raise KeyError("Invalid roomId")
return itemId
def updateItem(self, roomId, itemId, name, brand, type, ip):
"""
Updates an item to the house system and the database
Arguments:
roomId -- the id of the room in which the item is
itemId -- the id of the room to update
name -- new/current if unchanged name of the item
brand -- new/current if unchanged brand of the item (e.g. arduino)
type -- new/current if unchanged type of the item (e.g. motionSensor)
ip -- tnew/current if unchangedhe ip of the item
"""
if roomId in self.rooms and itemId in self.rooms[roomId].items:
self.rooms[roomId].items[itemId].name = name
self.rooms[roomId].items[itemId].brand = brand
self.rooms[roomId].items[itemId].ip = ip
self.rooms[roomId].items[itemId]._type = type
self.rooms[roomId].items[itemId].roomId = roomId
self.database.items.updateEntry(self.rooms[roomId].items[itemId], roomId)
else:
raise KeyError("Invalid roomId or itemId")
return itemId
def deleteItem(self, roomId, itemId):
"""
Deletes an item
Arguments:
roomId -- the id of the room in which the item is
itemid -- the id of the item to be deleted
"""
if roomId in self.rooms and itemId in self.rooms[roomId].items:
self.database.items.removeEntry(self.rooms[roomId].items[itemId])
del self.rooms[roomId].items[itemId]
else:
raise KeyError("Invalid roomId or itemId")
def getItemById(self, itemId):
"""
Returns the item with the specified id
Arguments:
itemId -- the id of the item
"""
for room in self.rooms:
if itemId in self.rooms[room].items:
return self.rooms[room].items[itemId]
def getItemByIP(self, ip):
"""
Returns the item with the specified IP address
Arguments:
ip -- the IP address of the item
"""
for room in self.rooms:
for item in self.rooms[room].items:
if self.rooms[room].items[item].ip == ip:
return self.rooms[room].items[item]
raise Exception("No sensor found for IP: " + ip)
def getItemsByType(self, _type):
"""
Returns all items in the house of a particular type
Arguments:
type -- the type of the item
"""
items = []
for room in self.rooms:
for item in self.rooms[room].items:
if self.rooms[room].items[item]._type == _type:
items.append(self.rooms[room].items[item])
return items
def getRoomByItemId(self, itemId):
"""
Returns the room which has the item with the specified id
Arguments:
itemId -- the id of the item
"""
for room in self.rooms:
if itemId in self.rooms[room].items:
return self.rooms[room]
def getStructure(self):
"""Returns the overall structure of the house"""
return {'rooms' : [self.rooms[r].getStructure() for r in self.rooms]}
def getState(self):
"""
Returns the state of the house
"""
states = []
for r in self.rooms:
states = states + self.rooms[r].getState()
return {'states' : states}
def getVersion(self):
"""
Returns the API version that this house is compatible with
"""
methods = self.database.getMethodsWithTypes()
methodList = [[]]
namesList = []
j = 0
for i in range(0, len(methods)):
temp = i+1
if temp > len(methods) - 1:
temp = 0
if methods[i][0] == methods[temp][0]:
methodList[j].append(methods[i][1])
else:
namesList.append(methods[i][0])
methodList.append([])
methodList[j].append(methods[i][1])
j +=1
methodsJSON = zip(namesList, methodList)
dictVersion = {}
for m in methodsJSON:
dictVersion[m[0]] = {'name' : data.typesNice[m[0]], 'isPassive' : data.passive[data.types[m[0]]], 'methods': m[1], 'supportedBrands' : data.supportedBrands[m[0]], 'states' : data.states[m[0]]}
finalDict = {}
finalDict['supportedTypes'] = dictVersion
return finalDict
def getRules(self):
"""
Returns ECA Rules in the correct API format
"""
rules = []
for event in self.events:
ruleJSON = {"ruleId": event.id, "ruleName": event.name, "enabled": bool(event.enabled)}
eventJSON = {"itemType": event.type}
value = None
for state in data.states[event.type]:
if state["name"] == event.trigger:
value = state["id"]
break
eventJSON["value"] = value
if not event.item is None:
eventJSON["id"] = event.item._id
eventJSON["scope"] = "item"
elif not event.room is None:
eventJSON["id"] = event.room.id
eventJSON["scope"] = "room"
else:
eventJSON["id"] = None
eventJSON["scope"] = "house"
ruleJSON["event"] = eventJSON
conditionsJSON = []
ruleJSON["conditions"] = conditionsJSON
for c in event.conditions:
conditionsJSON.append({"conditionId": c.id, "itemId": c.item._id, "itemType": c.item._type, "method": c.methodName, "equivalence": c.equivalence, "value": c.value})
actionsJSON = []
ruleJSON["actions"] = actionsJSON
for a in event.actions:
actionJSON = {"actionId": a.id, "method": a.methodName, "itemType": a.type}
if not a.item is None:
actionJSON["id"] = a.item._id
actionJSON["scope"] = "item"
elif not a.room is None:
actionJSON["id"] = a.room.id
actionJSON["scope"] = "room"
else:
actionJSON["id"] = None
actionJSON["scope"] = "house"
actionsJSON.append(actionJSON)
rules.append(ruleJSON)
return {"rules": rules}
def addEvent(self, name, _type, _id, scope, value, enabled):
"""
Adds an event to the house and database
Arguments:
name -- the name of the rule
_type -- the type of the item the event concerns
_id -- the id of the item/room which depends on scope
scope -- the scope of the event ("item"/"room"/"house")
value -- the triggering state of the item
enabled -- whether the rule is enabled (1/0)
"""
trigger = None
for state in data.states[_type]:
if state["id"] == value:
trigger = state["name"]
break
if trigger is None:
raise Exception("Invalid type and value combination")
if scope == "item":
item = self.getItemById(_id)
room = None
elif scope == "room":
item = None
room = self.rooms[_id]
elif scope == "house":
item = None
room = None
else:
raise Exception("Invalid scope parameter")
event = eca.Event(None, name, _type, item, room, trigger, enabled)
self.events.append(event)
self.database.events.addEntry(event)
return event.id
def updateEvent(self, name, _type, _id, scope, value, enabled, eventId):
"""
Updates an event in the house and database
Arguments:
name -- the name of the rule
_type -- the type of the item the event concerns
_id -- the id of the item/room which depends on scope
scope -- the scope of the event ("item"/"room"/"house")
value -- the triggering state of the item
enabled -- whether the rule is enabled (1/0)
"""
trigger = None
for state in data.states[_type]:
if state["id"] == value:
trigger = state["name"]
break
if trigger is None:
raise Exception("Invalid type and value combination")
if scope == "item":
item = self.getItemById(_id)
room = None
elif scope == "room":
item = None
room = self.rooms[_id]
elif scope == "house":
item = None
room = None
else:
raise Exception("Invalid scope parameter")
e = None
for event in self.events:
if event.id == eventId:
event.name = name
event.type = _type
event.item = item
event.room = room
event.trigger = trigger
event.enabled = enabled
e = event
break
if e is None:
raise Exception("Invalid event ID")
self.database.events.updateEntry(e)
def deleteEvent(self, eventId):
"""
Deletes an event from the house and database
Arguments:
eventId -- the id of the event to be deleted
"""
e = None
for event in self.events:
if event.id == eventId:
e = event
self.events.remove(e)
break
if e is None:
raise Exception("Invalid event ID")
self.database.events.removeEntry(e)
# Conditions and Actions for this event will also be deleted by the database
def addCondition(self, itemId, equivalence, value, eventId):
"""
Adds a condition to the correct event and the database
Arguments:
itemId -- the id of the item the condition concerns
equivalence -- the equivalence to use on the item state and the value
value -- the state needed for the equivalence to pass
eventId -- the id of the event this condition is matched to
"""
if equivalence == "is":
equivalence = "="
methodName = self.database.methods.getNiceStateName(itemId)
condition = eca.Condition(None, self.getItemById(itemId), "getState", methodName, equivalence, value)
self.database.conditions.addEntry(condition, eventId)
for e in self.events:
if e.id == eventId:
e.conditions.append(condition)
return condition.id
def updateCondition(self, itemId, equivalence, value, eventId, conditionId):
"""
Updates a condition in the house and database
Arguments:
conditionId -- the id of the condition to be updated
itemId -- the id of the item the condition concerns
equivalence -- the equivalence to use on the item state and the value
value -- the state needed for the equivalence to pass
eventId -- the id of the event this condition is matched to
"""
if equivalence == "is":
equivalence = "="
event = None
for e in self.events:
if e.id == eventId:
event = e
break
if event is None:
raise Exception("Invalid event id")
condition = None
for c in event.conditions:
if c.id == conditionId:
condition = c
break
if condition is None:
raise Exception("Invalid condition id")
methodName = self.database.methods.getNiceStateName(itemId)
condition.item = self.getItemById(itemId)
condition.method = "getState"
condition.methodName = methodName
condition.equivalence = equivalence
condition.value = value
self.database.conditions.updateEntry(condition, eventId)
def deleteCondition(self, eventId, conditionId):
"""
Deletes a condition from the house and database
Arguments:
eventId -- the id of the event this condition is matched to
conditionId -- the id of the condition to be deleted
"""
event = None
for e in self.events:
if e.id == eventId:
event = e
break
if event is None:
raise Exception("Invalid event id")
condition = None
for c in event.conditions:
if c.id == conditionId:
condition = c
break
if condition is None:
raise Exception("Invalid condition id")
self.database.conditions.removeEntry(condition)
event.conditions.remove(condition)
def addAction(self, _id, _type, scope, methodName, eventId):
"""
Adds an action to the house and database
Arguments:
_type -- the type of the item the action concerns
_id -- the id of the item/room which depends on scope
scope -- the scope of the event ("item"/"room"/"house")
methodName -- the action to perform
eventId -- the event the action belongs to
"""
if scope == "item":
item = self.getItemById(_id)
room = None
elif scope == "room":
item = None
room = self.rooms[_id]
elif scope == "house":
item = None
room = None
else:
raise Exception("Invalid scope parameter")
method = self.database.methods.getSignature(methodName, _type)
action = eca.Action(None, item, room, method, methodName, _type)
event = None
for e in self.events:
if e.id == eventId:
e.actions.append(action)
event = e
if event is None:
raise Exception("Invalid event id")
self.database.actions.addEntry(action, event.id)
return action.id
def updateAction(self, _id, _type, scope, methodName, eventId, actionId):
"""
Updates an action in the house and database
Arguments:
_type -- the type of the item the action concerns
_id -- the id of the item/room which depends on scope
scope -- the scope of the action ("item"/"room"/"house")
methodName -- the action to perform
eventId -- the event the action belongs to
actionId -- the id of the action to update
"""
if scope == "item":
item = self.getItemById(_id)
room = None
elif scope == "room":
item = None
room = self.rooms[_id]
elif scope == "house":
item = None
room = None
else:
raise Exception("Invalid scope parameter")
event = None
for e in self.events:
if e.id == eventId:
event = e
break
if event is None:
raise Exception("Invalid event id")
action = None
for a in event.actions:
if a.id == actionId:
action = a
break
if action is None:
raise Exception("Invalid action id")
action.item = item
action.room = room
action.method = self.database.methods.getSignature(methodName, _type)
action.methodName = methodName
action.type = _type
self.database.actions.updateEntry(action, eventId)
def deleteAction(self, eventId, actionId):
"""
Deletes an action from the house and database
Arguments:
eventId -- the id of the event this condition is matched to
actionId -- the id of the action to be deleted
"""
event = None
for e in self.events:
if e.id == eventId:
event = e
break
if event is None:
raise Exception("Invalid event id")
action = None
for a in event.actions:
if a.id == actionId:
action = a
break
if action is None:
raise Exception("Invalid action id")
self.database.actions.removeEntry(action)
event.actions.remove(action)
def getEventsForTrigger(self, item, trigger):
"""
Returns the possible events relating to an item trigger
Arguments:
item -- the item that triggered the event
trigger -- the name of the trigger
"""
possibleEvents = []
for event in self.events:
if event.enabled and event.trigger == trigger and (item == event.item or (self.getRoomByItemId(item._id) == event.room and item._type == event.type)):
possibleEvents.append(event)
return possibleEvents
def reactToEvent(self, ip, trigger):
"""
Process a trigger event from a particular IP
Arguments:
ip -- the IP address of the item that sent the trigger
trigger -- the name of the trigger
"""
item = self.getItemByIP(ip)
possibleEvents = self.getEventsForTrigger(item, trigger)
itemsActedOn = []
events = []
for event in possibleEvents:
eventItemsActedOn = []
eventMatch = True
for action in event.actions:
if action.isConflictWithOtherActions(itemsActedOn + eventItemsActedOn):
eventMatch = False
break
else:
eventItemsActedOn.append(action.getItemsActedOn())
if eventMatch == True:
itemsActedOn.extend(eventItemsActedOn)
events.append(event)
for event in events:
conditionsMatched = True
for condition in event.conditions:
if not condition.check():
conditionsMatched = False
break
if not conditionsMatched:
continue
for action in event.actions:
if action.isAllItemsInHouse():
action.doAction(self.getItemsByType(action._type))
else:
action.doAction()
def executeFromQueue(self):
"""Executes method from the queue, run in a seperate thread"""
while True:
if not self.queue.empty():
self.executeMethod(*self.queue.get())
def addToQueue(self, roomId, itemId, method, args=[]):
"""
Adds a method to the queue
Arguments:
roomId -- id of the room
itemId -- id of the item
method -- method to be called
args -- arguments od the method, empty list by detault
"""
self.queue.put(roomId, itemId, method, args)
def executeMethod(self, roomId, itemId, method, args=[]):
"""
Executes a method on a given item
Arguments:
roomId -- the id of the room the item is in
itemId -- the id of the item
method -- the method to be called as a string
args -- the arguments for the method to be called, empty list by default
"""
return getattr(self.rooms[roomId].items[itemId], method)(*args)
def getEnergyByTime(self, startTime, endTime):
"""
Gets list of watts between the given dates
Arguments:
startTime - date string in format %Y_%m_%d_%H_%M_%S
endTime - date string in format %Y_%m_%d_%H_%M_%S
"""
def formatArg(arg):
ls = arg.split('_')
timeStr = ''
# incomplete query
i = 0
if(len(ls) < 4):
while(i < 3):
if(i == 0):
timeStr = ''
elif(i < 3):
timeStr += '-'
if(i < len(ls)):
timeStr += ls[i]
else:
timeStr += '01'
i += 1
return timeStr
else:
while(i < len(ls)):
if(i == 0):
timeStr = timeStr + '' + ls[i]
elif(i < 2):
timeStr = timeStr + '-' + ls[i]
elif(i == 3):
timeStr = timeStr + ' ' + ls[i]
elif(i < 6):
timeStr = timeStr + ':' + ls[i]
# else do nothing with excessive args
i += 1
return timeStr
# print formatArg(startTime)
# print formatArg(endTime)
dbResults = self.database.energy.getEnergyByTime(formatArg(startTime), formatArg(endTime))
energyList = []
for e in dbResults:
energyList.append({'time': e[0].strftime('%Y-%m-%d %H:%M:%S'), 'watts': e[1]})
return {'values': energyList}
def getLatestEnergy(self):
"""
Gets latest energy reading
"""
dbResults = self.database.energy.getLatestEnergy()
energyList = []
for e in dbResults:
energyList.append({'time': e[0].strftime('%Y-%m-%d %H:%M:%S'), 'watts': e[1]})
return {'values': energyList}