Commit d2d9d68f authored by Raul Garcia-Castro's avatar Raul Garcia-Castro
Browse files

Merge branch 'issue-5' into 'develop-v2.1.1' 

Do not use deprecated terms

Closes #5

See merge request !8
parents 7462d8de 32822a11

documentation/description.html

+8 −8
Original line number Diff line number Diff line
@@ -6,8 +6,8 @@ 
<p><a href="#Figure_1">Figure 1</a> and <a href="#Figure_2">Figure 2</a> present an overview of the classes and the properties included in the SAREF4WATR extension.</p>



<figure>

  <a href="diagrams/SAREF4WATR Overview 1.png"><img src="diagrams/SAREF4WATR Overview 1.png" alt="SAREF4WATR overview. Measurements and KPIs"/></a>

  <figcaption id="Figure_1">Figure 1: SAREF4WATR overview. Measurements and KPIs</figcaption>

  <a href="diagrams/SAREF4WATR Overview 1.png"><img src="diagrams/SAREF4WATR Overview 1.png" alt="SAREF4WATR overview. Observations and KPIs"/></a>

  <figcaption id="Figure_1">Figure 1: SAREF4WATR overview. Observations and KPIs</figcaption>

</figure>



<figure>
@@ -16,17 +16,17 @@ 
</figure>





<h3>Measurement</h3>

<h3>Observation</h3>



<p>As it can be observed in <a href="#Figure_3">Figure 3</a>, the modelling of measurements in the SAREF4WATR ontology mostly relies on the measurement model proposed in SAREF.</p>

<p>As it appears in <a href="#Figure_3">Figure 3</a>, the modelling of observations in the SAREF4WATR ontology mostly relies on the observation model proposed in SAREF.</p>



<p>SAREF allows to define the temporal extent of a measurement by defining the timestamp for it (using the <a href="https://saref.etsi.org/core/hasResultTime">saref:hasResultTime</a> property) and to define the temporal interval to which a measurement applies, apart from the temporal instant defined by the timestamp (using the <a href="#saref:hasPhenomenonTime">saref:hasPhenomenonTime</a> property).</p>

<p>SAREF allows to define the temporal extent of an observation by defining the timestamp for it (using the <a href="https://saref.etsi.org/core/hasResultTime">saref:hasResultTime</a> property) and to define the temporal interval to which an observation applies, apart from the temporal instant defined by the timestamp (using the <a href="#saref:hasPhenomenonTime">saref:hasPhenomenonTime</a> property).</p>

 

<p>Besides, the extension requires to be able to represent those devices that measure a certain feature of interest (and those features of interest that are measured by a device) independently of having measures from which this relationship could be inferred. This can be represented with two properties of SAREF that relate <a href="https://saref.etsi.org/core/Device">saref:Device</a> and <a href="https://saref.etsi.org/core/FeatureOfInterest">saref:FeatureOfInterest</a>: <a href="https://saref.etsi.org/core/actsUpon">saref:actsUpon</a> and <a href="https://saref.etsi.org/core/isActedUponBy">saref:isActedUponBy</a>.</p>



<figure>

  <a href="diagrams/SAREF4WATR Measurement.png"><img src="diagrams/SAREF4WATR Measurement.png" alt="Measurement model"/></a>

  <figcaption id="Figure_3">Figure 3: Measurement model</figcaption>

  <a href="diagrams/SAREF4WATR Observation.png"><img src="diagrams/SAREF4WATR Observation.png" alt="Observation model"/></a>

  <figcaption id="Figure_3">Figure 3: Observation model</figcaption>

</figure>
@@ -36,7 +36,7 @@ 


<p>A water meter may be defined by the properties inherited from SAREF (e.g., <a href="https://saref.etsi.org/core/hasManufacturer">saref:hasManufacturer</a> or <a href="https://saref.etsi.org/core/hasModel">saref:hasModel</a>) and also by a set of properties defined in SAREF4WATR to indicate: its fabrication number (<a href="#s4watr:hasFabricationNumber">s4watr:hasFabricationNumber</a>), its firmware version (<a href="#s4watr:hasFirmwareVersion">s4watr:hasFirmwareVersion</a>), its hardware version (<a href="#s4watr:hasHardwareVersion">s4watr:hasHardwareVersion</a>), its version (<a href="#s4watr:hasVersion">s4watr:hasVersion</a>), the radio frequency in which it operates (<a href="#s4watr:operatesAtRadioFrequency">s4watr:operatesAtRadioFrequency</a>), and its required power (<a href="#s4watr:requiresPower">s4watr:requiresPower</a>).</p>



<p>Measurements may be taken from the water meter themselves. To enable the representation of such measurements, water meters are defined as features of interest (<a href="https://saref.etsi.org/core/FeatureOfInterest">saref:FeatureOfInterest</a>) and a non-exhaustive list of properties has been defined based on the M-Bus standard to allow measuring: on time (<a href="#s4watr:MeterOnTime">s4watr:MeterOnTime</a>), operating time (<a href="#s4watr:MeterOperatingTime">s4watr:MeterOperatingTime</a>), battery operating time (<a href="#s4watr:BatteryOperatingTime">s4watr:BatteryOperatingTime</a>), battery last change (<a href="#s4watr:BatteryLastChange">s4watr:BatteryLastChange</a>), and battery remaining time (<a href="#s4watr:BatteryRemainingTime">s4watr:BatteryRemainingTime</a>).</p>

<p>Observations may be taken from the water meter themselves. To enable the representation of such observations, water meters are defined as features of interest (<a href="https://saref.etsi.org/core/FeatureOfInterest">saref:FeatureOfInterest</a>) and a non-exhaustive list of properties has been defined based on the M-Bus standard to allow measuring: on time (<a href="#s4watr:MeterOnTime">s4watr:MeterOnTime</a>), operating time (<a href="#s4watr:MeterOperatingTime">s4watr:MeterOperatingTime</a>), battery operating time (<a href="#s4watr:BatteryOperatingTime">s4watr:BatteryOperatingTime</a>), battery last change (<a href="#s4watr:BatteryLastChange">s4watr:BatteryLastChange</a>), and battery remaining time (<a href="#s4watr:BatteryRemainingTime">s4watr:BatteryRemainingTime</a>).</p>



<figure>

  <a href="diagrams/SAREF4WATR Water meter.png"><img src="diagrams/SAREF4WATR Water meter.png" alt="Water meter model"/></a>

documentation/examples.html

+9 −9
Original line number Diff line number Diff line 
<p>The example presented in <a href="#Figure_13">Figure 13</a> depicts a water meter (ex:Meter4837QW123). It can be described by a set of static properties either reused from SAREF (e.g., <a href="https://saref.etsi.org/core/hasModel">saref:hasModel</a>) or from SAREF4WATR (e.g., <a href="https://saref.etsi.org/saref4watr/hasFirmwareVersion">s4watr:hasFirmwareVersion</a>). The spatial extent of the meter is described by its geometry (ex:MeterGeom) that is represented as a point in space following its WKT representation. SAREF4WATR defines different measurable properties of a water meter, among them the battery remaining time (<a href="https://saref.etsi.org/saref4watr/BatteryRemainingTime">s4watr:BatteryRemainingTime</a>) that is the one used in the example. Measurements of the meter for this property can be represented (ex:WMMeasurement200206) using for example the time instant of the measurement, its value and the unit of measure.</p>

<p>The example presented in <a href="#Figure_13">Figure 13</a> depicts a water meter (ex:Meter4837QW123). It can be described by a set of static properties either reused from SAREF (e.g., <a href="https://saref.etsi.org/core/hasModel">saref:hasModel</a>) or from SAREF4WATR (e.g., <a href="https://saref.etsi.org/saref4watr/hasFirmwareVersion">s4watr:hasFirmwareVersion</a>). The spatial extent of the meter is described by its geometry (ex:MeterGeom) that is represented as a point in space following its WKT representation. SAREF4WATR defines different measurable properties of a water meter, among them the battery remaining time (<a href="https://saref.etsi.org/saref4watr/BatteryRemainingTime">s4watr:BatteryRemainingTime</a>) that is the one used in the example. Observations of the meter for this property can be represented (ex:WMObservation200206) using for example the time instant of the observation, its value and the unit of measure.</p>



<figure>

  <a href="diagrams/SAREF4WATR Example water meter.png"><img src="diagrams/SAREF4WATR Example water meter.png" alt="Example of water meter"/></a>

  <figcaption id="Figure_13">Figure 13: Example of water meter</figcaption>

</figure>



<p>The main function of water meters is to measure water flow. <a href="#Figure_14">Figure 14</a> presents two examples of water flow measurements (ex:WFMeasurement170206 and ex:WFMeasurement643234) for two different water flow properties (<a href="https://saref.etsi.org/saref4watr/FlowVolume">s4watr:FlowVolume</a> and <a href="https://saref.etsi.org/saref4watr/ExternalTemperature">s4watr:ExternalTemperature</a>, respectively). Notice how the flow volume measurement is described with a time instant while the external temperature one is described with a time interval (ex:PT838452).</p>

<p>The main function of water meters is to measure water flow. <a href="#Figure_14">Figure 14</a> presents two examples of water flow observations (ex:WFObservation170206 and ex:WFObservation643234) for two different water flow properties (<a href="https://saref.etsi.org/saref4watr/FlowVolume">s4watr:FlowVolume</a> and <a href="https://saref.etsi.org/saref4watr/ExternalTemperature">s4watr:ExternalTemperature</a>, respectively). Notice how the flow volume observation is described with a time instant while the external temperature one is described with a time interval (ex:PT838452).</p>

 

<figure>

  <a href="diagrams/SAREF4WATR Example meter measurements.png"><img src="diagrams/SAREF4WATR Example meter measurements.png" alt="Example of water meter measurements"/></a>

  <figcaption id="Figure_14">Figure 14: Example of water meter measurements</figcaption>

  <a href="diagrams/SAREF4WATR Example meter observations.png"><img src="diagrams/SAREF4WATR Example meter observations.png" alt="Example of water meter observations"/></a>

  <figcaption id="Figure_14">Figure 14: Example of water meter observations</figcaption>

</figure>



<p>Different tariffs can be applied to water meters. <a href="#Figure_15">Figure 15</a> presents an example of a consumption-based tariff (ex:Meter4837QW123Tariff) for a water meter (ex:Meter4837QW123). Different individuals are defined for describing the duration (ex:FiveYears), period (ex:OneYear) and billing period (ex:OneMonth) of the tariff. SAREF4WATR does not restrict how to define particular conditions of a tariff; in the example, for the consumption description a string literal is used.</p>
@@ -19,21 +19,21 @@ 
  <figcaption id="Figure_15">Figure 15: Example of tariff</figcaption>

</figure>



<p>The measurement of the different properties of the water itself is also of interest. <a href="#Figure_16">Figure 16</a> presents two measurements (ex:DTSMeasurement106 and ex:DTSMeasurement107) of one chemical property (<a href="https://saref.etsi.org/saref4watr/Cadmium">s4watr:Cadmium</a>) and of one bacterial property (<a href="https://saref.etsi.org/saref4watr/EscherichiaColi">s4watr:EscherichiaColi</a>), along with their timestamps, values and units. Even if SAREF4WATR includes a set of predefined water properties, other properties could be defined by instantiating the corresponding <a href="https://saref.etsi.org/saref4watr/WaterProperty">s4watr:WaterProperty</a> subclass.</p>

<p>The observation of the different properties of the water itself is also of interest. <a href="#Figure_16">Figure 16</a> presents two observations (ex:DTSObservation106 and ex:DTSObservation107) of one chemical property (<a href="https://saref.etsi.org/saref4watr/Cadmium">s4watr:Cadmium</a>) and of one bacterial property (<a href="https://saref.etsi.org/saref4watr/EscherichiaColi">s4watr:EscherichiaColi</a>), along with their timestamps, values and units. Even if SAREF4WATR includes a set of predefined water properties, other properties could be defined by instantiating the corresponding <a href="https://saref.etsi.org/saref4watr/WaterProperty">s4watr:WaterProperty</a> subclass.</p>

 

<figure>

  <a href="diagrams/SAREF4WATR Example water measurements.png"><img src="diagrams/SAREF4WATR Example water measurements.png" alt="Example of water measurements"/></a>

  <figcaption id="Figure_16">Figure 16: Example of water measurements</figcaption>

  <a href="diagrams/SAREF4WATR Example water observations.png"><img src="diagrams/SAREF4WATR Example water observations.png" alt="Example of water observations"/></a>

  <figcaption id="Figure_16">Figure 16: Example of water observations</figcaption>

</figure>



<p><a href="#Figure_17">Figure 17</a> depicts a water infrastructure (ex:DowntownDS) that represents a distribution system for drinking water (<a href="https://saref.etsi.org/saref4watr/DrinkingWater">s4watr:DrinkingWater</a>) intended for domestic use (<a href="https://saref.etsi.org/saref4watr/Domestic">s4watr:Domestic</a>). The spatial extent of the infrastructure is described by its geometry (ex:DSGeom) that is represented as a polygon in space following its WKT representation. The water distribution system has different subsystems: a water meter (ex:Meter4837QW123), a tank (ex:Tank38472) and a pump (ex:PumpRT73467). These subsystems can be represented through their geometries, as points in the example (ex:MeterGeom, ex:TankGeom, ex:PumpGeom), and different measures could be made of them such as the one depicted (ex:PMeasurement854306) that measures the flow rate (<a href="https://saref.etsi.org/saref4watr/FlowRate">s4watr:FlowRate</a>) of the pump.</p>

<p><a href="#Figure_17">Figure 17</a> depicts a water infrastructure (ex:DowntownDS) that represents a distribution system for drinking water (<a href="https://saref.etsi.org/saref4watr/DrinkingWater">s4watr:DrinkingWater</a>) intended for domestic use (<a href="https://saref.etsi.org/saref4watr/Domestic">s4watr:Domestic</a>). The spatial extent of the infrastructure is described by its geometry (ex:DSGeom) that is represented as a polygon in space following its WKT representation. The water distribution system has different subsystems: a water meter (ex:Meter4837QW123), a tank (ex:Tank38472) and a pump (ex:PumpRT73467). These subsystems can be represented through their geometries, as points in the example (ex:MeterGeom, ex:TankGeom, ex:PumpGeom), and different measures could be made of them such as the one depicted (ex:PObservation854306) that measures the flow rate (<a href="https://saref.etsi.org/saref4watr/FlowRate">s4watr:FlowRate</a>) of the pump.</p>

 

<figure>

  <a href="diagrams/SAREF4WATR Example water infrastructure.png"><img src="diagrams/SAREF4WATR Example water infrastructure.png" alt="Example of water infrastructure and water assets"/></a>

  <figcaption id="Figure_17">Figure 17: Example of water infrastructure and water assets</figcaption>

</figure>



<p><a href="#Figure_18">Figure 18</a> contains an example of a key performance indicator (ex:MinimumPressureLevel) defined for a water distribution system (ex:DowntownDS). The key performance indicator is defined with its name and calculation period (ex:OneWeek). Besides, an assessment is made for the KPI (ex:MPL2020020723), derived from existing measurements (ex:PLMeasurement56206, ex:PLMeasurement56207 and ex:PLMeasurement56208), indicating the value of the assessment and its temporal properties.</p>

<p><a href="#Figure_18">Figure 18</a> contains an example of a key performance indicator (ex:MinimumPressureLevel) defined for a water distribution system (ex:DowntownDS). The key performance indicator is defined with its name and calculation period (ex:OneWeek). Besides, an assessment is made for the KPI (ex:MPL2020020723), derived from existing observations (ex:PLObservation56206, ex:PLObservation56207 and ex:PLObservation56208), indicating the value of the assessment and its temporal properties.</p>

 

<figure>

  <a href="diagrams/SAREF4WATR Example KPI.png"><img src="diagrams/SAREF4WATR Example KPI.png" alt="Example of key performance indicator"/></a>

requirements/requirements.csv

+15 −15
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ WATR-2;Water infrastructure;A catchment well is a well that has been constructed 
WATR-3;Water infrastructure;A wastewater treatment plant is a facility where contaminants are removed from wastewater or sewage.

WATR-4;Water infrastructure;Which types of sensors are used in water infrastructures? Water quality sensors, capacity sensors, tank level sensors, etc.

WATR-5;Water infrastructure;Which types of actuators are used in water infrastructures? Pressure regulators, pumps, valves, etc.

WATR-6;Water meter;A water meter is a device that measures different aspects of a water infrastructure.

WATR-6;Water meter;A water meter is a device that observes different aspects of a water infrastructure.

WATR-7;Water meter;What is the type of the water meter? It is a cold-water meter.

WATR-8;Water meter;What is the fabrication number of the water meter? 4837QW.

WATR-9;Water meter;What are the manufacturer and the model of the water meter? It is a Meterall, model Turion.
@@ -19,20 +19,20 @@ WATR-17;Water meter;What is the remaining battery time of the water meter? 27 mo 
WATR-18;Water meter;What is the power of the water meter? 24 volts.

WATR-19;Water meter;What is the radio frequency level of the water meter? 2.4 GHz.

WATR-20;Water meter;What is the geolocation of the water meter? Latitude 40.4165 and longitude -3.7025.

WATR-21;Meter measurements;What is the volume being measured by water meter 243? 127 liters.

WATR-22;Meter measurements;Which was the flow of water meter 44 on January 15th 2019 at 12:30? 32 liters per hour.

WATR-23;Meter measurements;How many water meters are measuring an external temperature greater than 23ºC? 5 meters.

WATR-24;Meter measurements;The maximum temperature limit of the water meter is of 49ºC.

WATR-25;Meter measurements;Water meters can provide measurements according to different temporal settings: current values, periodical values, set date values, billing date values, minimum values, and maximum values.

WATR-26;Meter measurements;Measurements can be related to a specific date and/or time, to some duration, or to a temporal interval.

WATR-27;Infrastructure measurements;What is the current level of the reservoir? 200 liters.

WATR-28;Infrastructure measurements;What are the inflow/outflow rates of the water reservoir? 500 liters.

WATR-29;Infrastructure measurements;What is the current water flow in water pipe 212? 250 liters per second.

WATR-30;Infrastructure measurements;What is the current water leak rate in water pipe 212? 0.4 liters per second.

WATR-31;Infrastructure measurements;Which systems had the water pressure lower than 100 on August 15th? Pump 123 and pump 145.

WATR-32;Infrastructure measurements;What is the maximum discharge flow of water pump 8? 500 liters per minute.

WATR-33;Water measurements;What are the physical properties of water? Temperature, conductance, turbidity, etc.

WATR-34;Water measurements;What are the chemical properties of water? pH, total hardness, concentration of different chemical components, etc.

WATR-21;Meter observations;What is the volume being observed by water meter 243? 127 liters.

WATR-22;Meter observations;Which was the flow of water meter 44 on January 15th 2019 at 12:30? 32 liters per hour.

WATR-23;Meter observations;How many water meters are observing an external temperature greater than 23ºC? 5 meters.

WATR-24;Meter observations;The maximum temperature limit of the water meter is of 49ºC.

WATR-25;Meter observations;Water meters can provide observations according to different temporal settings: current values, periodical values, set date values, billing date values, minimum values, and maximum values.

WATR-26;Meter observations;Observations can be related to a specific date and/or time, to some duration, or to a temporal interval.

WATR-27;Infrastructure observations;What is the current level of the reservoir? 200 liters.

WATR-28;Infrastructure observations;What are the inflow/outflow rates of the water reservoir? 500 liters.

WATR-29;Infrastructure observations;What is the current water flow in water pipe 212? 250 liters per second.

WATR-30;Infrastructure observations;What is the current water leak rate in water pipe 212? 0.4 liters per second.

WATR-31;Infrastructure observations;Which systems had the water pressure lower than 100 on August 15th? Pump 123 and pump 145.

WATR-32;Infrastructure observations;What is the maximum discharge flow of water pump 8? 500 liters per minute.

WATR-33;Water observations;What are the physical properties of water? Temperature, conductance, turbidity, etc.

WATR-34;Water observations;What are the chemical properties of water? pH, total hardness, concentration of different chemical components, etc.

WATR-35;Indicators;Is the minimum pressure level maintained everywhere the water distribution infrastructure? Yes.

WATR-36;Indicators;What is the capacity of wastewater treatment plants in Madrid? 12 Megaliters per day.

WATR-37;Indicators;Which water indicators are defined for Burgos? Number of connected residential properties, annual maintenance costs, volume of potable water supplied.

tests/tests.csv

+37 −37

File changed.

Preview size limit exceeded, changes collapsed.