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

GaugeMeasure

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.

Variables
  • name – (str) Name of gauge

  • city – (str) City of the gauge

  • object – (str) What is evaluate

  • sensors – (list) List of sensors on the gauge

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 measure

  • date – (date, datetime) Date of measure

  • alarm – (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 sensor

  • unit – (str) Unit of values

  • forecast – (str) Forecast

  • location – (PostalAddress) Address of the sensor

  • geo – (GeoCoordinates) Geo address of the sensor

  • lastvalue – (GaugeMeasure) Last value

  • history – (list) Value history

  • gaugeid – (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