Skip to content

spec.md

Latest commit

 

History

History
124 lines (92 loc) · 4.9 KB

spec.md

File metadata and controls

124 lines (92 loc) · 4.9 KB

Valve

Description

This entity contains an harmonised description of a generic Valve made for the Water Network Management domain. This entity is primarily associated with the water management vertical and related IoT applications.

Data Model

A JSON Schema corresponding to this data model can be found here

NGSI-LD common Properties

  • id: Unique identifier.

  • type: Entity type. It must be equal to Junction.

  • modifiedAt: Last update timestamp of this entity.

    • Attribute type: Property. DateTime
    • Read-Only. Automatically generated.

  • createdAt: Entity's creation timestamp.

    • Attribute type: Property. DateTime
    • Read-Only. Automatically generated.

  • location : Location of Junction represented by a GeoJSON geometry.

Valve Entity Properties

  • tag : An optional text string used to assign the valve to a category, perhaps based on type or location

    • Attribute type: Property.Text
    • Optional

  • description : A free text description

    • Attribute type: Property.Text
    • Optional

  • initialStatus : Valve status at the start of the simulation. If set to OPEN or CLOSED then the control setting of the valve is ignored and the valve behaves as an open or closed link, respectively. If set to NONE, then the valve will behave as intended

    • Attribute type: Property.Text
    • Attribute metadata Properties:
      • Values are resrtricted to: "OPEN","CLOSED","NONE"
    • Mandatory

  • status : Dynamic state of the valve

    • Normative References: {{Add a normative reference}}
    • Attribute type: Property.Text
    • Attribute metadata Properties:
      • Values are resrtricted to: "OPEN","CLOSED","NONE"
    • Optional

  • diameter : The valve diameter

    • Attribute type: Property. Number
    • Attribute unit: All units are accepted in CEFACT code
    • Attribute unit Example: millimetre
    • CEFACT unitCode: MMT
    • Attribute metadata Properties:
      • {{metadata Property name}} : {{Metadata Property Description}}
    • Mandatory

  • valveType : The valve type

    • Attribute type: Property.Text
    • Attribute metadata Properties:
      • Values are resrtricted to: "PRV", "PSV","PBV","FCV","TCV" and"GPV"
    • Mandatory

  • setting : A parameter that describes the valve's operational setting

    • Attribute type: Property. Number
    • Attribute unit: All units are accepted in CEFACT code
    • Attribute unit Example: No unit
    • CEFACT unitCode: C62
    • Attribute metadata Properties:
      • {{metadata Property name}} : {{Metadata Property Description}}
    • Mandatory

  • minorLoss : Unitless minor loss coefficient that applies when the valve is completely opened

    • Attribute type: Property. Number
    • Attribute unit: All units are accepted in CEFACT code,
    • Attribute unit Example: No unit
    • CEFACT unitCode: C62
    • Attribute metadata Properties:
      • {{metadata Property name}} : {{Metadata Property Description}}
    • Mandatory

Valve Entity Relationships

  • startsAt : The ID of the node on the nominal upstream or inflow side of the valve

    • Attribute type: Relationship. Reference to an entity of type Node (Reservoir, Junction, Tank)
    • Attribute metadata Properties:
      • {{metadata Property name}} : {{Metadata Property Description}}
    • Mandatory

  • endsAt : The ID of the node on the nominal downstream or discharge side of the valve

    • Attribute type: Relationship. Reference to an entity of type Node (Reservoir, Junction, Tank) {{Add here the description of the target relationship object}}
    • Attribute metadata Properties:
      • {{metadata Property name}} : {{Metadata Property Description}}
    • Mandatory

  • valveCurve: A relationship to the curve of the setting property. Only required when valveType is GPV

    • Attribute type: Relationship. Reference to an entity of type Curve
    • Attribute metadata Properties:
      • {{metadata Property name}} : {{Metadata Property Description}}
    • Optional

Note: JSON Schemas are intended to capture the data type and associated constraints of the different Attributes, regardless their final representation format in NGSI(v2, LD).

LD Example

A full example is presented here.

Use it with a real service

T.B.D.

Open Issues