summaryrefslogtreecommitdiff
path: root/sleekxmpp/plugins/xep_0325/device.py
diff options
context:
space:
mode:
authorMike Taylor <bear42@gmail.com>2015-04-11 20:12:19 -0400
committerMike Taylor <bear42@gmail.com>2015-04-11 20:12:19 -0400
commit86e85f98357b40941fddb7a2dbf8fbe16f96032e (patch)
tree65a86c0378c5e59f1822dfba8ed484f77ff5ebeb /sleekxmpp/plugins/xep_0325/device.py
parentcc145d20b077442b7d4118d4d2f4c27e1b0faf0c (diff)
parent073e85381a86069e931369bb5353cab2a2e3682d (diff)
downloadslixmpp-86e85f98357b40941fddb7a2dbf8fbe16f96032e.tar.gz
slixmpp-86e85f98357b40941fddb7a2dbf8fbe16f96032e.tar.bz2
slixmpp-86e85f98357b40941fddb7a2dbf8fbe16f96032e.tar.xz
slixmpp-86e85f98357b40941fddb7a2dbf8fbe16f96032e.zip
Merge pull request #313 from mayflower/develop
Proposing #310 again in fixed version
Diffstat (limited to 'sleekxmpp/plugins/xep_0325/device.py')
-rw-r--r--sleekxmpp/plugins/xep_0325/device.py46
1 files changed, 23 insertions, 23 deletions
diff --git a/sleekxmpp/plugins/xep_0325/device.py b/sleekxmpp/plugins/xep_0325/device.py
index a60d5f9a..f1ed0733 100644
--- a/sleekxmpp/plugins/xep_0325/device.py
+++ b/sleekxmpp/plugins/xep_0325/device.py
@@ -13,16 +13,16 @@ import datetime
class Device(object):
"""
Example implementation of a device control object.
-
- The device object may by any custom implementation to support
+
+ The device object may by any custom implementation to support
specific devices, but it must implement the functions:
has_control_field
set_control_fields
"""
def __init__(self, nodeId):
- self.nodeId = nodeId;
- self.control_fields = {};
+ self.nodeId = nodeId
+ self.control_fields = {}
def has_control_field(self, field, typename):
"""
@@ -30,12 +30,12 @@ class Device(object):
and the type matches for control in this device.
Arguments:
- field -- The field name
+ field -- The field name
typename -- The expected type
"""
if field in self.control_fields and self.control_fields[field]["type"] == typename:
- return True;
- return False;
+ return True
+ return False
def set_control_fields(self, fields, session, callback):
"""
@@ -43,22 +43,22 @@ class Device(object):
sets the data and (if needed) and calls the callback.
Arguments:
- fields -- List of control fields in tuple format:
+ fields -- List of control fields in tuple format:
(name, typename, value)
session -- Session id, only used in the callback as identifier
callback -- Callback function to call when control set is complete.
The callback function must support the following arguments:
- session -- Session id, as supplied in the
+ session -- Session id, as supplied in the
request_fields call
nodeId -- Identifier for this device
- result -- The current result status of the readout.
+ result -- The current result status of the readout.
Valid values are:
"error" - Set fields failed.
"ok" - All fields were set.
- error_field -- [optional] Only applies when result == "error"
- The field name that failed
+ error_field -- [optional] Only applies when result == "error"
+ The field name that failed
(usually means it is missing)
error_msg -- [optional] Only applies when result == "error".
Error details when a request failed.
@@ -69,12 +69,12 @@ class Device(object):
for name, typename, value in fields:
if not self.has_control_field(name, typename):
self._send_control_reject(session, name, "NotFound", callback)
- return False;
+ return False
for name, typename, value in fields:
self._set_field_value(name, value)
- callback(session, result="ok", nodeId=self.nodeId);
+ callback(session, result="ok", nodeId=self.nodeId)
return True
def _send_control_reject(self, session, field, message, callback):
@@ -82,12 +82,12 @@ class Device(object):
Sends a reject to the caller
Arguments:
- session -- Session id, see definition in
+ session -- Session id, see definition in
set_control_fields function
- callback -- Callback function, see definition in
+ callback -- Callback function, see definition in
set_control_fields function
"""
- callback(session, result="error", nodeId=self.nodeId, error_field=field, error_msg=message);
+ callback(session, result="error", nodeId=self.nodeId, error_field=field, error_msg=message)
def _add_control_field(self, name, typename, value):
"""
@@ -95,12 +95,12 @@ class Device(object):
Arguments:
name -- Name of the field
- typename -- Type of the field, one of:
- (boolean, color, string, date, dateTime,
+ typename -- Type of the field, one of:
+ (boolean, color, string, date, dateTime,
double, duration, int, long, time)
value -- Field value
"""
- self.control_fields[name] = {"type": typename, "value": value};
+ self.control_fields[name] = {"type": typename, "value": value}
def _set_field_value(self, name, value):
"""
@@ -111,7 +111,7 @@ class Device(object):
value -- New value for the field
"""
if name in self.control_fields:
- self.control_fields[name]["value"] = value;
+ self.control_fields[name]["value"] = value
def _get_field_value(self, name):
"""
@@ -121,5 +121,5 @@ class Device(object):
name -- Name of the field
"""
if name in self.control_fields:
- return self.control_fields[name]["value"];
- return None;
+ return self.control_fields[name]["value"]
+ return None