woob.capabilities.gauge

class Gauge(id='', url=NotLoaded, backend=None)[source]

Bases: BaseObject

Gauge class.

Variables:

  • url – (str) url

  • 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 GaugeSensor(id='', url=NotLoaded, backend=None)[source]

Bases: BaseObject

GaugeSensor class.

Variables:

  • url – (str) url

  • 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
class GaugeMeasure(id='', url=NotLoaded, backend=None)[source]

Bases: BaseObject

Measure of a gauge sensor.

Variables:

  • url – (str) url

  • level – (Decimal) Level of measure

  • date – (date, datetime) Date of measure

  • alarm – (str) Alarm level

class CapGauge[source]

Bases: Capability

iter_gauges(pattern=None)[source]

Iter gauges.

Parameters:

pattern (str) – if specified, used to search gauges. (default: None)

Return type:

iter[Gauge]

iter_sensors(id, pattern=None)[source]

Iter instrument of a gauge.

Param:

ID of the gauge

Parameters:

pattern (str) – if specified, used to search sensors. (default: None)

Return type:

iter[GaugeSensor]

iter_gauge_history(id)[source]

Get history of a gauge sensor.

Parameters:

id (str) – ID of the gauge sensor

Return type:

iter[GaugeMeasure]

get_last_measure(id)[source]

Get last measures of a sensor.

Parameters:

id (str) – ID of the sensor.

Return type:

GaugeMeasure

exception SensorNotFound[source]

Bases: UserError

Not found a sensor