Skip to content

Latest commit

 

History

History
445 lines (285 loc) · 7.51 KB

operations.rst

File metadata and controls

445 lines (285 loc) · 7.51 KB
Raw
.. py:currentmodule:: sml2mqtt.config.operations

Operations

It's possible to define operations which are used to process the received value

Filters

Change Filter

.. autopydantic_model:: OnChangeFilter
   :exclude-members: get_kwargs_on_change
   :inherited-members: BaseModel
Example
type: change filter

Range filter

.. autopydantic_model:: RangeFilter
   :inherited-members: BaseModel
   :exclude-members: type, get_kwargs_limit
Example
type: range filter
min: 0

Delta Filter

.. autopydantic_model:: DeltaFilter
   :exclude-members: get_kwargs_delta
   :inherited-members: BaseModel
Example
type: delta filter
min: 5
min %: 10
type: delta filter
min: 5
type: delta filter
min %: 10

Throttle Filter

.. autopydantic_model:: ThrottleFilter
   :inherited-members: BaseModel
Example
throttle filter: 60

Actions

Refresh Action

.. autopydantic_model:: RefreshAction
   :inherited-members: BaseModel
Example
refresh action: 01:30:00

Heartbeat Action

.. autopydantic_model:: HeartbeatAction
   :inherited-members: BaseModel
Example
heartbeat action: 30

Math

Factor

.. autopydantic_model:: Factor
   :inherited-members: BaseModel
Example
factor: -1

Offset

.. autopydantic_model:: Offset
   :inherited-members: BaseModel
Example
offset: 10

Round

.. autopydantic_model:: Round
   :inherited-members: BaseModel
Example
round: 2

Workarounds

Negative On Energy Meter Status

.. autopydantic_model:: NegativeOnEnergyMeterWorkaround
   :inherited-members: BaseModel
Example
negative on energy meter status: true

Date time based

Virtual Meter

.. autopydantic_model:: VirtualMeter
   :inherited-members: BaseModel
   :exclude-members: get_kwargs_dt_fields, type
Example
type: meter
start now: False
reset times:
  - 02:00
reset days:
  - 1
  - monday

Max Value

.. autopydantic_model:: MaxValue
   :inherited-members: BaseModel
   :exclude-members: get_kwargs_dt_fields, type
Example
type: max value
start now: True
reset times:
  - 02:00

Min Value

.. autopydantic_model:: MinValue
   :inherited-members: BaseModel
   :exclude-members: get_kwargs_dt_fields, type
Example
type: min value
start now: True
reset times:
  - 02:00

Time series

Max Value

.. autopydantic_model:: MaxOfInterval
   :inherited-members: BaseModel
   :exclude-members: get_kwargs_interval_fields, type
Example
type: max interval
interval: 3600
wait for data: False

Min Value

.. autopydantic_model:: MinOfInterval
   :inherited-members: BaseModel
   :exclude-members: get_kwargs_interval_fields, type
Example
type: min interval
interval: 3600
wait for data: False

Mean Value

.. autopydantic_model:: MeanOfInterval
   :inherited-members: BaseModel
   :exclude-members: get_kwargs_interval_fields, type
Example
type: mean interval
interval: 3600
wait for data: False

Operations

Or

.. autopydantic_model:: Or
   :inherited-members: BaseModel
Example
or:
  - type: change filter
  - heartbeat action: 60

Sequence

.. autopydantic_model:: Sequence
   :inherited-members: BaseModel
Example
sequence:
  - factor: 0.1
  - offset: -50

Examples

.. py:currentmodule:: sml2mqtt.config.device

These are some examples for sml value configurations

Energy consumption today

This will report the power consumption of today. The first reported value every day will be 0 and then it will increase for every day.

obis: '0100010800ff'    # Obis code for the energy meter
mqtt:
  topic: energy_today   # MQTT topic for the meter
operations:
- type: meter
  start now: true       # Start immediately
  reset times:          # Reset at midnight
    - 00:00
- round: 1
- type: change filter      # Only report on changes
- refresh action: 01:00    # ... but refresh every hour

Downsample current power

This will report a power value every max every 30s. The reported value will be the weighted mean value of the last 30s.

obis: '0100100700ff'    # Obis code for the energy meter
mqtt:
  topic: power   # MQTT topic for the meter
operations:
- type: mean interval     # Calculate weighted mean over 30s
  interval: 30
  wait for data: False
- throttle filter: 30     # Let a value pass every 30s
- round: 0                # Round the mean value to the full number
- type: delta filter      # Only report when the value changes at least 10W or 5%
  min: 10
  min %: 5
- refresh action: 01:00   # ... but refresh every hour