Skip to content

spec.md

Latest commit

 

History

History
139 lines (100 loc) · 5.58 KB

spec.md

File metadata and controls

139 lines (100 loc) · 5.58 KB

Pump

Description

This entity contains an harmonised description of a generic pump 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.

Pump Entity Properties

  • tag : An optional text string used to assign the pump to a category, perhaps based on age, size or location

    • Attribute type: Property.Text
    • Optional

  • description : A free text description

    • Attribute type: Property.Text
    • Optional

  • initialStatus : State of the pump (open or closed) at the start of the simulation period

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

  • status : Dynamic state of the pump

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

  • power : The power supplied by the pump

    • Attribute type: Property. Number
    • Attribute unit: All units are accepted in CEFACT code
    • Attribute unit Example: KiloWatt
    • CEFACT unitCode: KWT
    • Attribute metadata Properties:
      • {{metadata Property name}} : {{Metadata Property Description}}
    • Mandatory if the headCurve attribute does not exist

  • speed : The relative speed setting of the pump

    • Attribute type: Property. Number
    • Attribute unit: All units are accepted in CEFACT code
    • Attribute unit Example: Metre per Second
    • CEFACT unitCode: MTS
    • Attribute metadata Properties:
      • {{metadata Property name}} : {{Metadata Property Description}}
    • Optional

  • energyPrice : The average or nominal price of energy in monetary units per kw-hr

    • 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}}
    • Optional

Pump Entity Relationships

  • startsAt : The ID of the node on the suction side of the pump

    • 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 discharge side of the pump

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

  • headCurve : The ID label of the pump curve used to describe the relationship between the head delivered by the pump and the flow through the pump

    • Attribute type: Relationship. Reference to an entity of type Curve
    • Attribute metadata Properties:
      • {{metadata Property name}} : {{Metadata Property Description}}
    • Mandatory if the power attribute does not exist

  • efficCurve : The ID label of the curve that represents the pump's wire-to-water efficiency as a function of flow rate

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

  • pumpPattern : The ID label of a time pattern used to control the pump's operation. The multipliers of the pattern are equivalent to speed settings. A multiplier of zero implies that the pump will be shut off during the corresponding time period

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

  • energyPattern : The ID label of the time pattern used to describe the variation in energy price throughout the day

    • Attribute type: Relationship. Reference to an entity of type Pattern
    • 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-LD.

LD Example

A full example is presented here.

Use it with a real service

T.B.D.

Open Issues