baseline - bruno-beloff/scs_analysis GitHub Wiki

docs > software repositories > scs_analysis > commands > estate management

DESCRIPTION

The baseline utility is use to set the baseline of a device's electrochemical and CO2 sensors according to estimated low environmental gas concentrations. It does this by downloading device data, finding minimums, then adjusting the device's baseline offsets by the difference between the estimated and reported values. Any changes in NO2 baselines are incorporated into O3 ('Ox') baselining.

The device must be online during the baselining operation - a number of MQTT messages are passes between the utility and the device. If any changes are made to the device's baseline settings, then the gases_sampler process is restarted. How the restart happens is specified by the --uptake flag.

If the --rehearse flag is used, the baseline utility shows what changes would be made, but does not make the changes.

Operating parameters are specified by the baseline_conf utility, and may be overridden by the baseline utility flags. Any number of named baseline_conf files may be stored.

The --credentials flag is only required where the user wishes to store multiple identities. Setting the credentials is done interactively using the command line interface.

SYNOPSIS

baseline.py [-a] -c NAME -t DEVICE_TAG [{ -r | -u COMMAND }] [-s START] [-e END] [-p AGGREGATION] [-m GAS MINIMUM] [{ -o GAS | -x GAS }] [-v]

Options
--version	show program's version number and exit
-h, --help	show this help message and exit
-a, --aws	Use AWS S3 instead of local storage for configuration
-c CONF_NAME, --conf-name=CONF_NAME	the name of the baseline configuration
-t DEVICE_TAG, --device-tag=DEVICE_TAG	the device to be baselined
-r, --rehearse	show what actions should be performed
-u UPTAKE, --uptake=UPTAKE	{ restart \| reboot \| shutdown }, default 'reboot'
-s START_HOUR, --start-hour=START_HOUR	override the default start hour
-e END_HOUR, --end-hour=END_HOUR	override the default end hour
-p AGGREGATION, --aggregation-period= AGGREGATION	override the default aggregation period
-m MINIMUM, --minimum=MINIMUM	override default minimum for GAS
-o ONLY_GAS, --only-gas=ONLY_GAS	baseline only GAS
-x EXCLUDE_GAS, --exclude-gas=EXCLUDE_GAS	exclude GAS
-v, --verbose	report narrative to stderr

EXAMPLES

baseline.py -c freshfield -t scs-opc-1 -r

FILES