woob.capabilities.gauge
¶
-
class
woob.capabilities.gauge.
CapGauge
¶ Bases:
woob.capabilities.base.Capability
-
get_last_measure
(id)¶ Get last measures of a sensor.
- Parameters
id (str) – ID of the sensor.
- Return type
-
iter_gauge_history
(id)¶ Get history of a gauge sensor.
- Parameters
id (str) – ID of the gauge sensor
- Return type
iter[
GaugeMeasure
]
-
iter_gauges
(pattern=None)¶ Iter gauges.
- Parameters
pattern (str) – if specified, used to search gauges.
- Return type
iter[
Gauge
]
-
iter_sensors
(id, pattern=None)¶ Iter instrument of a gauge.
- Param
ID of the gauge
- Parameters
pattern (str) – if specified, used to search sensors.
- Return type
iter[
GaugeSensor
]
-
-
class
woob.capabilities.gauge.
Gauge
(id='', url=NotLoaded, backend=None)¶ Bases:
woob.capabilities.base.BaseObject
Gauge class.
-
class
woob.capabilities.gauge.
GaugeMeasure
(id='', url=NotLoaded, backend=None)¶ Bases:
woob.capabilities.base.BaseObject
Measure of a gauge sensor.
- Variables
level – (
Decimal
) Level of measuredate – (
date
,datetime
) Date of measurealarm – (
str
) Alarm level
-
class
woob.capabilities.gauge.
GaugeSensor
(id='', url=NotLoaded, backend=None)¶ Bases:
woob.capabilities.base.BaseObject
GaugeSensor class.
- Variables
name – (
str
) Name of the sensorunit – (
str
) Unit of valuesforecast – (
str
) Forecastlocation – (
PostalAddress
) Address of the sensorgeo – (
GeoCoordinates
) Geo address of the sensorlastvalue – (
GaugeMeasure
) Last valuehistory – (
list
) Value historygaugeid – (
str
) Id of the gauge
-
property
address
¶
-
property
latitude
¶
-
property
longitude
¶
-
exception
woob.capabilities.gauge.
SensorNotFound
¶ Bases:
woob.capabilities.base.UserError
Not found a sensor