SLightliMon documentation

Index

Installation
Usage
Basic principles

Installation

SLightliMon doesn't actually need an "installation" procedure. It needs a python 2.x environment with the right modules and then it can be just downloaded and run. As stated in the README file, the needed modules are:

  • sys
  • argparse
  • json
  • rrdtool (necessary for using RRD databases as input)
  • datetime (only if executed in debug mode)

Usage

In the following you can find a description of the parameters of SLightliMon. If you want to see some usage examples go to the dedicated page.

Period to be analyzed
-ts T_START, --t_start T_START
       start UNIX epoch timestamp [seconds]

-te T_END, --t_end T_END
       end UNIX epoch timestamp [seconds]

Input files and format
-p1 POWER_DATA_PH1, --power_data_ph1 POWER_DATA_PH1
       active power data for phase 1, expressed in Watts

-p2 POWER_DATA_PH2, --power_data_ph2 POWER_DATA_PH2
       active power data for phase 2, expressed in Watts. Do not use if single-phase data.

-p3 POWER_DATA_PH3, --power_data_ph3 POWER_DATA_PH3
       active power data for phase 3, expressed in Watts. Do not use if single-phase data.

-v1 VOLTAGE_DATA_PH1, --voltage_data_ph1 VOLTAGE_DATA_PH1
       voltage data for phase 1, expressed in Volts

-v2 VOLTAGE_DATA_PH2, --voltage_data_ph2 VOLTAGE_DATA_PH2
       voltage data for phase 2, expressed in Volts. Do not use if single-phase data.

-v3 VOLTAGE_DATA_PH3, --voltage_data_ph3 VOLTAGE_DATA_PH3
       voltage data for phase 3, expressed in Volts. Do not use if single-phase data.

-e ENERGY_DATA, --energy_data ENERGY_DATA
       total active energy data. Optional.

-c COSPHI_DATA, --cosphi_data COSPHI_DATA
       cos(phi) data. Optional.

-nor, --no_one_read_meas
       set if measurements are NOT acquired at the same time (e.g., they are obtained through separated MODBUS queries from the registers of an energy meter, instead of an unique query from all registers). Independently from this parameter, power and voltage measurements related to the same phase are assumed to be anyway taken at the same time.

-rf {AVERAGE,MIN,MAX,LAST}, --rrd_function {AVERAGE,MIN,MAX,LAST}
       RRD consolidation function. Default is AVERAGE.

-txt, --text
       set if data are in text format instead of RRD

Base algorithm parameters
-dt DELTA_T, --delta_t DELTA_T
       base analysis time interval [minutes, positive]. Default is 5.

-at AVG_T, --avg_t AVG_T
       average interval [minutes, positive odd number]. Default is 5.

-po1 POFF_PH1, --poff_ph1 POFF_PH1
       maximum power consumption during off state for phase 1 [watts]. Default is 100.

-po2 POFF_PH2, --poff_ph2 POFF_PH2
       maximum power consumption during off state for phase 2 [watts]. Default is 100.

-po3 POFF_PH3, --poff_ph3 POFF_PH3
       maximum power consumption during off state for phase 3 [watts]. Default is 100.

-vm V_MIN, --v_min V_MIN
       minimum value of acceptable voltage [volts]. Default is 210.

-vM V_MAX, --v_max V_MAX
       maximum value of acceptable voltage [volts]. Default is 250.

-vt V_DT, --v_dt V_DT
       maximum total non-consecutive time of non-acceptable voltage allowed [hours]. Default is 3.

-cm COSPHI_MIN, --cosphi_min COSPHI_MIN
       minimum value of acceptable cosphi. Default is 0.9.

-ct COSPHI_DT, --cosphi_dt COSPHI_DT
       maximum total non-consecutive time [hours] of low cosphi allowed during ON state. Default is 3.

-da DATA_MIN_AVAIL, --data_min_avail DATA_MIN_AVAIL
       minimum data availability for running the whole algorithm [percent]. Default is 70.

Comparison with reference parameters
-rd REF_DAYS, --ref_days REF_DAYS
       number of reference days. Default is 0, that is no comparison with past data is performed. If >0 input files must contain also past data.

-aps ANOMALY_ABS_P_SHIFT, --anomaly_abs_p_shift ANOMALY_ABS_P_SHIFT
       minimum absolute power shift for detecting an anomaly [watts]. Default is 200.

-arps ANOMALY_REL_P_SHIFT, --anomaly_rel_p_shift ANOMALY_REL_P_SHIFT
       minimum relative power shift for detecting an anomaly [percent of reference profile]. Default is 2.

-atm ANOMALY_MIN_DT, --anomaly_min_dt ANOMALY_MIN_DT
       minimum duration of an anomaly state [minutes]. Default is 7.

-agt ANOMALY_GUARD_DT, --anomaly_guard_dt ANOMALY_GUARD_DT
       minimum time distance allowed from an on/off event to an anomaly [minutes]. Default is 10.

-ers ENERGY_REL_SHIFT, --energy_rel_shift ENERGY_REL_SHIFT
       minimum relative total energy offset for detecting an anomaly [percent of reference profile total energy]. Default is 15.

-ra REF_MIN_AVAIL, --ref_min_avail REF_MIN_AVAIL
       minimum reference data availability for running the detection of anomalies [percent]. Default is 70.

Other parameters
-d, --debug
       debug mode

-v, --version
       show program's version number and exit

-h, --help
       show help message and exit.

Basic principles

A more detailed description of the input data assumptions and of the processing steps carried out by the SLightliMon profile analyzer can be found in the GitHub repository here. The same document in PDF format can be downloaded here. Read it before using SLightliMon!