RESPIRA tool is a command-line program written in Python 3.7 to send configuration and calibration settings to remote RESPIRA stations via FIWARE. We explained in this other section two different calibration strategies: manual factor-offset correction and automatic zero-calibration. The following sections will employ each of these techniques by means of the corresponding command.
Prior to using RESPIRA tool we need to enter our FIWARE service path. Every user of the RESPIRA IoT platform is given a FIWARE service path, a specific region in the FIWARE Context-Broker where all the IoT information is stored. Users can find their FIWARE service path in the profile section.
Once you get your service path simply run this command:
python3 respira_tool.py --set-service-path /my_service_path
The above command will store the service path in a configuration file so we will not need to run the command again unless we want to switch to a different FIWARE service path (a different user). We can then check the current service path with this other command:
python3 respira_tool.py --show-service-path
Which will reply with the FIWARE service path currently configured:
/my_service_path
Assuming that you already calculated your correction values (factor and offset), transmitting them to FIWARE only requires this command:
python3 respira_tool.py --calibrate no2 -d RESPIRA_XXXXXXXXXXXX -f 1.0021 -o -12.687
Where no2 is the reading to be corrected, RESPIRA_XXXXXXXXXXXX is the ID of the RESPIRA station, 1.0021 is the correction factor (or gain) and -12.687 is the correction offset. Supported pollutant by this version are: no2, pm1.0, pm2.5, pm4.0 and pm10 so we can send calibration settings for each individual gas or particulate matter.
python3 respira_tool.py --calibrate pm2.5 -d RESPIRA_XXXXXXXXXXXX -f 1.0016 -o 5.342
RESPIRA stations periodically query the FIWARE Context-Broker for new config settings every hour. Once the new settings have been retrieved, the station will start applying them for the next transmission, one hour later.
This strategy allows the station to subtract a zero-level offset to any reading. This zero-level corresponds to the minimum level detected in a 10-day interval. We can enable this functionality for both the NO2 sensor and the whole particulate matter sensor (SPS30). Please note that we can not enable zero-calibration only for a single particulate mater parameter.
These commands are used to enable automatic zero-calibration for each sensor:
python3 respira_tool.py --enable-zero-calibration no2 -d RESPIRA_XXXXXXXXXXXX
python3 respira_tool.py --enable-zero-calibration pm -d RESPIRA_XXXXXXXXXXXX
or diasble zero calibration:
python3 respira_tool.py --disable-zero-calibration no2 -d RESPIRA_XXXXXXXXXXXX
python3 respira_tool.py --disable-zero-calibration pm -d RESPIRA_XXXXXXXXXXXX
As stated before, these changes take effect starting from the next transmission, one hour later.
Let’s say that we want to revert to the default configuration values, which are:
We can run the following command to set the configuration to factory defaults:
python3 respira_tool.py --reset-calibration -d RESPIRA_XXXXXXXXXXXX
In order to show the current calibration settings from a RESPIRA station, we can use the –read-calibration option:
python3 respira_tool.py --read-calibration -d RESPIRA_XXXXXXXXXXXX
Reply from FIWARE:
Calibration settings for device :RESPIRA:RESPIRA_807D3AF39E18
NO2 automatic zero-calibration: enabled
NO2 correction factor (gain): 1
NO2 correction offset: 0
PM sensor automatic zero-calibration: enabled
PM1.0 correction factor (gain): 1
PM1.0 correction offset: 0
PM2.5 correction factor (gain): 1
PM2.5 correction offset: 0
PM4.0 correction factor (gain): 1
PM4.0 correction offset: 0
PM10 correction factor (gain): 1
PM10 correction offset: 0