def request_sensor_list(self, msg):
"""Request the list of sensors.
The list of sensors is sent as a sequence of #sensor-list informs.
Parameters
----------
name : str, optional
Name of the sensor to list (the default is to list all sensors).
If name starts and ends with '/' it is treated as a regular expression and
all sensors whose names contain the regular expression are returned.
Informs
-------
name : str
The name of the sensor being described.
description : str
Description of the named sensor.
units : str
Units for the value of the named sensor.
type : str
Type of the named sensor.
params : list of str, optional
Additional sensor parameters (type dependent). For integer and float
sensors the additional parameters are the minimum and maximum sensor
value. For discrete sensors the additional parameters are the allowed
values. For all other types no additional parameters are sent.
Returns
-------
success : {'ok', 'fail'}
Whether sending the sensor list succeeded.
informs : int
Number of #sensor-list inform messages sent.
Examples
--------
::
?sensor-list
#sensor-list psu.voltage PSU\_voltage. V float 0.0 5.0
#sensor-list cpu.status CPU\_status. \@ discrete on off error
...
!sensor-list ok 5
?sensor-list cpu.power.on
#sensor-list cpu.power.on Whether\_CPU\_hase\_power. \@ boolean
!sensor-list ok 1
"""
exact, name_filter = construct_name_filter(msg.arguments[0]
if msg.arguments else None)
sensors = [(name, sensor) for name, sensor in
sorted(self.factory.sensors.iteritems()) if name_filter(name)]
if exact and not sensors:
return Message.reply(msg.name, "fail", "Unknown sensor name.")
for name, sensor in sensors:
self.send_message(Message.inform(msg.name, name, sensor.description,
sensor.units, sensor.stype,
*sensor.formatted_params))
return Message.reply(msg.name, "ok", len(sensors))
def request_sensor_value(self, msg):
"""Request the value of a sensor or sensors.
A list of sensor values as a sequence of #sensor-value informs.
Parameters
----------
name : str, optional
Name of the sensor to poll (the default is to send values for all sensors).
If name starts and ends with '/' it is treated as a regular expression and
all sensors whose names contain the regular expression are returned.
Informs
-------
timestamp : float
Timestamp of the sensor reading in milliseconds since the Unix epoch.
count : {1}
Number of sensors described in this #sensor-value inform. Will always
be one. It exists to keep this inform compatible with #sensor-status.
name : str
Name of the sensor whose value is being reported.
value : object
Value of the named sensor. Type depends on the type of the sensor.
Returns
-------
success : {'ok', 'fail'}
Whether sending the list of values succeeded.
informs : int
Number of #sensor-value inform messages sent.
Examples
--------
::
?sensor-value
#sensor-value 1244631611415.231 1 psu.voltage 4.5
#sensor-value 1244631611415.200 1 cpu.status off
...
!sensor-value ok 5
?sensor-value cpu.power.on
#sensor-value 1244631611415.231 1 cpu.power.on 0
!sensor-value ok 1
"""
exact, name_filter = construct_name_filter(msg.arguments[0]
if msg.arguments else None)
sensors = [(name, sensor) for name, sensor in
sorted(self.factory.sensors.iteritems()) if name_filter(name)]
if exact and not sensors:
return Message.reply(msg.name, "fail", "Unknown sensor name.")
def one_ok(sensor, timestamp_ms, status, value):
self.send_message(Message.inform(msg.name, timestamp_ms, "1",
sensor.name, status, value))
def one_fail(failure, sensor):
self.send_message(Message.inform(msg.name, sensor.name,
"Sensor reading failed."))
def all_finished(lst):
# XXX write a test where lst is not-empty so we can fail
self.send_message(Message.reply(msg.name, "ok",
len(sensors)))
lst = []
for name, sensor in sensors:
self.read_formatted_from_sensor(sensor, one_ok, one_fail, lst)
DeferredList(lst).addCallback(all_finished)
raise AsyncReply()
