nojhan/weboob-devel
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Change ICapWaterLevel to be more generic

Browse source 
1) Rename it to ICapGauge
2) One gauge can have more than one sensor (a flow and
   a level for a river, or temperature and humidity for
   a wetter station)
3) Add/remove/rename fields to be more general
This commit is contained in:
Florent 2012-11-08 17:49:07 +01:00 • committed by Romain Bignon
commit f63c412b2a
1 changed files with 47 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

72
weboob/capabilities/gauge.py
View file

@ -18,40 +18,72 @@
# along with weboob. If not, see <http://www.gnu.org/licenses/>. # along with weboob. If not, see <http://www.gnu.org/licenses/>.
from .base import IBaseCap, CapBaseObject, StringField, FloatField, DateField from .base import IBaseCap, CapBaseObject, StringField, FloatField, DateField, Field
__all__ = ['Gauge', 'GaugeMeasure', 'ICapWaterLevel'] __all__ = ['Gauge', 'GaugeSensor', 'GaugeMeasure', 'ICapGauge']
class Gauge(CapBaseObject): class Gauge(CapBaseObject):
""" """
Gauge class. Gauge class.
""" """
name = StringField('Name of gauge') name = StringField('Name of gauge')
river = StringField('What river') city = StringField('City of the gauge')
level = FloatField('Level of gauge') object = StringField('What is evaluate') # For example, name of a river
flow = FloatField('Flow of gauge') sensors = Field('List of sensors on the gauge', list)
lastdate = DateField('Last measure')
forecast = StringField('Forecast')
class GaugeMeasure(CapBaseObject): class GaugeMeasure(CapBaseObject):
""" """
Measure of a gauge. Measure of a gauge sensor.
""" """
level = FloatField('Level of measure') level = FloatField('Level of measure')
flow = FloatField('Flow of measure')
date = DateField('Date of measure') date = DateField('Date of measure')
alarm = StringField('Alarm level')
def __init__(self): def __init__(self):
CapBaseObject.__init__(self, None) CapBaseObject.__init__(self, None)
class ICapWaterLevel(IBaseCap):
class GaugeSensor(CapBaseObject):
"""
GaugeSensor class.
"""
name = StringField('Name of the sensor')
unit = StringField('Unit of values')
forecast = StringField('Forecast')
lastvalue = Field('Last value', GaugeMeasure)
history = Field('Value history', list) # lastvalue not included
class ICapGauge(IBaseCap):
def iter_gauges(self, pattern=None):
"""
Iter gauges.
:param pattern: if specified, used to search gauges.
:type pattern: str
:rtype: iter[:class:`Gauge`]
"""
raise NotImplementedError()
def iter_sensors(self, id, pattern=None):
"""
Iter instrument of a gauge.
:param: ID of the gauge
:param pattern: if specified, used to search sensors.
:type pattern: str
:rtype: iter[:class:`GaugeSensor`]
"""
raise NotImplementedError()
def iter_gauge_history(self, id): def iter_gauge_history(self, id):
""" """
Get history of a gauge. Get history of a gauge sensor.
:param id: ID of the river :param id: ID of the gauge sensor
:type id: str :type id: str
:rtype: iter[:class:`GaugeMeasure`] :rtype: iter[:class:`GaugeMeasure`]
""" """
@ -59,20 +91,10 @@ class ICapWaterLevel(IBaseCap):
def get_last_measure(self, id): def get_last_measure(self, id):
""" """
Get last measure of the gauge. Get last measure of the gauge sensor.
:param id: ID of the gauge :param id: ID of the gauge sensor.
:type id: str :type id: str
:rtype: :class:`GaugeMeasure` :rtype: :class:`GaugeMeasure`
""" """
raise NotImplementedError() raise NotImplementedError()
def iter_gauges(self, pattern=None):
"""
Iter gauges.
:param pattern: if specified, used to search gauges
:type pattern: str
:rtype: iter[:class:`Gauge`]
"""
raise NotImplementedError()