def __init__(self, jsap, thingName, client_id):
"""This method is used to initialize the WebThing.
Mandatory parameters are the name of the JSAP file
with the configuration and the name of the WebThing
to create"""
# debug message
logging.debug("Device::__init__() invoked")
# read the jsap provided
logging.debug("Device::__init__() -- Reading configuration file")
self.jsap = JSAPObject(jsap, 40)
# setting a namespace
self.defaultNS = "http://eecs.qmul.ac.uk/wot#"
# store things data
self.clientID = client_id
self.thingName = thingName
self.thingURI = self.getRandomURI()
self.thingID = self.thingURI.split("#")[1]
# initialize an empty dictionary for events, props and actions
# keys are represented by names, values are the related URIs
self.events = {}
self.actions = {}
self.properties = {}
# initialize a list of the custom statements
self.statements = []
# create a KP
logging.debug("Device::__init__() -- Creating a new KP")
self.kp = LowLevelKP(None, 40)
# save the important URIs
self.updateURI = self.jsap.updateUri
self.subscribeURI = self.jsap.subscribeUri
# call TD_INIT
u = self.jsap.getUpdate("ADD_NEW_THING", {
"name": self.thingName,
"thing": self.thingURI
})
self.kp.update(self.updateURI, u)
def setUpClass(cls):
# debug print
print(colored("test::setUpClass> ", "blue", attrs=["bold"]) + "Initializing environment")
# create an instance of the JSAP
cls.jsap = JSAPObject(conf["jsapFile"])
# create an instance of the KP
cls.kp = LowLevelKP(logLevel = 10)
# create an instance of the secure KP
cls.skp = LowLevelKP(jparFile = conf["jparFile"], logLevel = 10)
class Device:
"""This class represents a generic WebThing"""
# constructor
def __init__(self, jsap, thingName):
"""This method is used to initialize the WebThing.
Mandatory parameters are the name of the JSAP file
with the configuration and the name of the WebThing
to create"""
# debug message
logging.debug("Device::__init__() invoked")
# read the jsap provided
logging.debug("Device::__init__() -- Reading configuration file")
self.jsap = JSAPObject(jsap, 40)
# setting a namespace
self.defaultNS = "http://eecs.qmul.ac.uk/wot#"
# store things data
self.thingName = thingName
self.thingURI = self.getRandomURI()
self.thingID = self.thingURI.split("#")[1]
# initialize an empty dictionary for events, props and actions
# keys are represented by names, values are the related URIs
self.events = {}
self.actions = {}
self.properties = {}
# initialize a list of the custom statements
self.statements = []
# create a KP
logging.debug("Device::__init__() -- Creating a new KP")
self.kp = LowLevelKP(None, 40)
# save the important URIs
self.updateURI = self.jsap.updateUri
self.subscribeURI = self.jsap.subscribeUri
# call TD_INIT
u = self.jsap.getUpdate("ADD_NEW_THING", {
"name": self.thingName,
"thing": self.thingURI
})
self.kp.update(self.updateURI, u)
def addProperty(self,
isUri,
propertyName,
propertyValue,
propertyURI=None,
dataschema="-",
writable=True,
stability=0):
"""This method adds a new property to the thing"""
# debug message
logging.debug("Debug::addProperty() invoked")
# generate an URI and store data
if not propertyURI:
self.properties[propertyName] = self.getRandomURI()
else:
self.properties[propertyName] = propertyURI
# add the property
u = None
if isUri:
u = self.jsap.getUpdate(
"ADD_URI_PROPERTY", {
"thing": self.thingURI,
"property": propertyURI,
"newName": propertyName,
"newStability": stability,
"newWritable": writable,
"newDataSchema": dataschema,
"newValue": propertyValue
})
else:
u = self.jsap.getUpdate(
"ADD_PROPERTY", {
"thing": self.thingURI,
"property": propertyURI,
"newName": propertyName,
"newStability": stability,
"newWritable": writable,
"newDataSchema": dataschema,
"newValue": propertyValue
})
self.kp.update(self.updateURI, u)
# add new action
def addAction(self, actionName, actionURI=None, fields=[]):
"""This method is used to put the description of
an action into the SEPA instance. Mandatory is the
name of the action to publish. The eventURI is instead
optional. If not provided, will be automatically generated"""
# debug message
logging.debug("Debug::addAction() invoked")
# generate an URI and store data
self.actions[actionName] = {}
if not actionURI:
self.actions[actionName]["uri"] = self.getRandomURI()
else:
self.actions[actionName]["uri"] = actionURI
# generate an URI for the data schema
dataSchema = self.getRandomURI()
# generate and perform the update
u = self.jsap.getUpdate(
"ADD_NEW_ACTION", {
"thing": self.thingURI,
"action": self.actions[actionName]["uri"],
"newName": actionName,
"newInDataSchema": dataSchema,
"newOutDataSchema": "-"
})
self.kp.update(self.updateURI, u)
print(u)
# add fields to the action
self.actions[actionName]["fields"] = fields
for f in fields:
# generate an URI for the field
fieldURI = self.getRandomURI()
# read field name and type
u = self.jsap.getUpdate(
"ADD_INPUT_FIELD_TO_ACTION", {
"thing": self.thingURI,
"action": self.actions[actionName]["uri"],
"inField": fieldURI,
"fieldType": f["fieldType"],
"fieldName": f["fieldName"]
})
self.kp.update(self.updateURI, u)
print(u)
# add event
def addEvent(self, eventName, eventURI=None):
"""This method is used to put the description of
an event into the SEPA instance. Mandatory is the
name of the event to publish. The eventURI is instead
optional. If not provided, will be automatically generated"""
# debug message
logging.debug("Device::addEvent() invoked")
# generate an URI and store data
if not eventURI:
self.events[eventName] = self.getRandomURI()
else:
self.events[eventName] = eventURI
# generate and perform the update
u = self.jsap.getUpdate(
"ADD_EVENT", {
"event": self.events[eventName],
"thing": self.thingURI,
"eName": eventName,
"outDataSchema": "-"
})
self.kp.update(self.updateURI, u)
def addCustomStatement(self, statement):
"""This method is used to add custom statements not present
in the jsap file used by this class"""
# debug message
logging.debug("Device::addCustomStatement() invoked")
# store and do the update
self.statements.append(statement)
self.kp.update(self.updateURI, "INSERT DATA { %s }" % statement)
def subscribeToAction(self):
logging.error("Device::subscribeToAction yet to implement!")
# delete Web Thing
def deleteWT(self):
"""This method is used to delete a Thing from the KB. It should be
called before shutting down the Thing"""
# debug message
logging.debug("Device::deleteWT() invoked")
# delete properties
logging.debug("Device::deleteWT() -- removing all the properties")
for p in self.properties:
u = self.jsap.getUpdate("DELETE_PROPERTY", {
"thing": self.thingURI,
"property": self.properties[p]
})
self.kp.update(self.updateURI, u)
# delete actions
logging.debug("Device::deleteWT() -- removing all the actions")
for a in self.actions:
# delete fields, then the action
for f in self.actions[a]["fields"]:
print(f)
u = self.jsap.getUpdate(
"DELETE_INPUT_FIELD_FROM_ACTION", {
"thing": self.thingURI,
"action": self.actions[a]["uri"],
"fieldType": f["fieldType"],
"fieldName": f["fieldName"]
})
print(u)
self.kp.update(self.updateURI, u)
u = self.jsap.getUpdate("DELETE_ACTION", {
"thing": self.thingURI,
"action": self.actions[a]["uri"]
})
self.kp.update(self.updateURI, u)
# delete events
logging.debug("Device::deleteWT() -- removing all the events")
for e in self.events:
u = self.jsap.getUpdate("DELETE_EVENT", {
"thing": self.thingURI,
"event": self.events[e]
})
self.kp.update(self.updateURI, u)
# delete thing
logging.debug("Device::deleteWT() -- removing thing")
u = self.jsap.getUpdate("DELETE_THING", {
"thing": self.thingURI,
"name": self.thingName
})
self.kp.update(self.updateURI, u)
# delete custom statements
logging.debug("Device::deleteWT() -- removing custom statements")
for statement in self.statements:
self.kp.update(self.updateURI, "DELETE DATA { %s }" % statement)
def waitForActions(self, handlerClass):
"""This method is used to subscribe to all the actions request
for this Web Thing. The handler is the only parameter required"""
# get subscription
s = self.jsap.getQuery("GET_ACTION_REQUEST", {"thing": self.thingURI})
# subscribe
self.kp.subscribe(self.subscribeURI, s, "actions",
handlerClass(self.kp, self.jsap))
def getRandomURI(self):
"""This method is used to create a random URI"""
# debug message
logging.debug("Device::getRandomURI() invoked")
# return
return self.defaultNS + str(uuid4())
# read config file
myConf = {}
config = configparser.ConfigParser()
logging.debug("Parsing Configuration file")
config.read('tarsier.conf')
# read config file -- section 'server'
try:
myConf["httpPort"] = config.getint('server', 'httpPort')
myConf["host"] = config.get('server', 'host')
myConf["requestURI"] = "http://%s:%s/commands" % (myConf["host"],
myConf["httpPort"])
myConf["jsap"] = config.get('server', 'localJSAP')
except configparser.NoSectionError:
logging.critical("Missing section 'server' in config file")
sys.exit(255)
except configparser.NoOptionError:
logging.critical(
"Section 'server' must include keys 'httpPort' and 'host'")
sys.exit(255)
# create a JSAPObject and a KP
jsap = JSAPObject(myConf["jsap"])
kp = LowLevelKP()
# http interface
threadHTTP = HTTPThread(myConf["httpPort"], "HTTP Interface")
# Start new Threads
threadHTTP.start()
if __name__ == "__main__":
# read jamendo key
config = configparser.ConfigParser()
config.read(CONFIG_FILE)
clientID = config["Jamendo"]["clientId"]
# initialize the logging system
logger = logging.getLogger('jamendoWT')
logging.basicConfig(format='[%(levelname)s] %(message)s',
level=logging.DEBUG)
logging.debug("Logging subsystem initialized")
# 1 - create an instance of the Device and one of the JSAP
wt = Device(JSAP_FILE, "jamendoWT", clientID)
jsap = JSAPObject(JSAP_FILE, 40)
# 2 - specify actions
wt.addAction("searchWithJamendo", None,
[{
"fieldName": "searchPattern",
"fieldType": "http://www.w3.org/2001/XMLSchema#String"
}])
# 3 - subscribe to action requests
wt.waitForActions(ActionHandler)
# 8 - wait, then destroy data
logging.info("WebThing ready! Waiting for actions!")
try:
input("Press <ENTER> to close the WebThing")
# local reqs
from lib.Device import *
from lib.ActionHandler import *
# main
if __name__ == "__main__":
# initialize the logging system
logger = logging.getLogger('annotatorWT')
logging.basicConfig(format='[%(levelname)s] %(message)s',
level=logging.DEBUG)
logging.debug("Logging subsystem initialized")
# 1 - create an instance of the Device and one of the JSAP
wt = Device(CONFIG_FILE, "SonicAnnotatorWT")
jsap = JSAPObject(CONFIG_FILE, 40)
# 2 - specify properties
# NOTE: our thing must expose the list of plugins.
# we do it through an rfd:Bag.. so to addProperty
# we give the URI of a Bag. Then we fill it.
bagUri = wt.getRandomURI()
propUri = wt.getRandomURI()
wt.addProperty(True, "hasPlugin", bagUri, propUri, "rdf:Bag")
for plugin in vamp.list_plugins():
wt.addCustomStatement(" <%s> rdf:li '%s' " % (bagUri, plugin))
break
# 3 - specify events
wt.addEvent("Ping")