Batch Label Filter Plugin

The foglamp-filter-batch-label plugin is a FogLAMP filter that allows attaching a configurable label to a set of data based on specific events. The label is an incrementing value that changes each time a new label event is detected.

Label Events

The plugin defines two types of label events:

  1. Zero Crossing Event: The value of a datapoint crosses the configured offset value, with the event being qualified by the direction the value is going (rising or falling).

  2. Peak Event: The value of a datapoint reaches a local maximum or minimum, with the event being qualified by the direction the value is going (rising or falling).

Configuration of Batch Label Plugin:

batchlabel_1

Click on Basic .

  • Asset Name Filter: A regular expression to limit the asset names on which this filter operates. The default value is “.*”, which means the filter will apply to all asset names.

  • Datapoint Name Filter: A regular expression to limit the datapoint names on which this filter operates. The default value is “.*”, which means the filter will apply to all datapoint names.

  • Offset: A numeric offset value to be applied to the datapoint value for ‘zero point event’ evaluation. The default value is 0.0. This offset is used to determine the ‘zero point’ for the zero crossing event detection.

  • Enabled: A switch that can be used to enable or disable execution of the filter.

Click on Label Format.

batchlabel_2

  • Label Prefix: The prefix that will be added to the beginning of the batch label. The default value is “batch_”, which means the label will start with the text “batch_” followed by the other components of the label.

  • Label Format: The format of the numeric portion of the batch label, using a printf-style format string. The default is “%05u”, which will result in a 5-digit number that is zero-padded. For example, the first batch label would be “00001”, the second “00002”, and so on.

  • Label Suffix: The suffix that will be added to the end of the batch label. The default value is “_part”, which means the full label will look something like “batch_00001_part”.

Click on Save to save and apply the configuration.