Streetlight control cabinet

This repository is now archived and subsequent works will be carried out the in Smart data models repositories. The latest version of this Data Model can be found at https://github.com/smart-data-models/dataModel.Streetlighting

It represents equipment, usually on street, used to the automated control of a group(s) of streetlights, i.e. one or more circuits.

Data Model

The data model is defined as shown below:

  • id : Entity's unique identifier.

  • type : It must be equal to StreetlightControlCabinet.

  • source : A sequence of characters giving the source of the entity data.

    • Attribute type: Property. Text or URL
    • Optional

  • dataProvider : Specifies the URL to information about the provider of this information

    • Attribute type: Property. URL
    • Optional

  • location : Control cabinet's location represented by a GeoJSON point.

  • address : Civic address where the control cabinet is located.

  • areaServed : Higher level area to which the cabinet belongs to. It can be used to group per responsible, district, neighbourhood, etc.

  • serialNumber : Serial number of the control cabinet.

  • refStreetlightGroup : Streetlight group(s) controlled.

    • Attribute type: Property. List of references to entities of type StreetlightGroup.
    • Mandatory

  • brandName : Name of the cabinet's brand.

  • modelName : Name of the cabinet's model.

  • manufacturerName : Name of the cabinet's manufacturer.

  • cupboardMadeOf : Material the cabinet's cupboard is made of.

    • Attribute type: Property. Text
    • Allowed values: one Of (plastic, metal, concrete, other)
    • Optional

  • features : A list of cabinet controller features.

    • Attribute type: Property. List of Text
    • Allowed Values: Those technical values considered meaningful by applications.
      • astronomicalClock . The control cabinet includes an astronomical clock to deal with switching hours.
      • individualControl. The control cabinet allows to control street lights individually.

  • compliantWith. A list of standards to which the cabinet controller is compliant with (ex. IP54)

    • AttributeType: List of Text.
    • Optional

  • annotations : A field reserved for annotations (incidences, remarks, etc.).

    • Attribute type: Property. List of Text
    • Optional

  • refDevice : Reference to the device(s) used to monitor this control cabinet.

    • Attribute type: Relationship. List of Reference to entity(ies) of type Device
    • Optional

  • dateModified : Last update timestamp of this entity.

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

  • dateServiceStarted : Date at which the cabinet controller started giving service.

    • Attribute type: Property. DateTime
    • Optional

  • dateLastProgramming : Date at which there was a programming operation over the cabinet.

    • Attribute type: Property. DateTime
    • Optional

  • nextActuationDeadline : Deadline for next actuation to be performed (programming, testing, etc.).

    • Attribute type: Property. DateTime
    • Optional

  • responsible : Responsible for the cabinet controller, i.e. entity in charge of actuating (programming, etc.).

    • Attribute type: Property. Text
    • Optional

  • workingMode : Working mode for this cabinet controller.

    • Attribute type: Property. Text
    • Allowed values:
      • automatic : The cabinet controller decides automatically when light groups are switched on and off. Manual operation is not allowed.
      • manual : Human intervention is required for switching on and off.
      • semiautomatic : The same as automatic but in this case manual intervention is allowed.
    • Mandatory

  • maximumPowerAvailable : The maximum power available (by contract) for the circuits controlled by this cabinet.

    • Attribute type: Property. Number
    • Default unit: Kilowatts (kW)
    • Optional

  • energyConsumed : Energy consumed by the circuits controlled since metering started (since dateMeteringStarted).

    • Attribute type: Property. Number
    • Default unit: Kilowatts per hour (kWh).
    • Attribute metadata:
      • timestamp: Timestamp when the last update of the attribute happened.
    • Optional

  • energyCost : Cost of the energy consumed by the circuits controlled since the metering start date (dateMeteringStarted).

    • Attribute type: Property. Number
    • Default currency: Euros. (Other currencies might be expressed using a metadata attribute)
    • Attribute metadata:
      • timestamp: Timestamp when the last update of the attribute happened.
    • Optional

  • reactiveEnergyConsumed : Energy consumed (with regards to reactive power) by circuits since the metering start date (dateMeteringStarted).

    • Attribute type: Property. Number
      • Default unit: KiloVolts-Ampere-Reactive per hour (kVArh).
    • Attribute metadata:
      • timestamp: Timestamp when the last update of the attribute happened.
    • Optional

  • dateMeteringStarted : The starting date for metering energy consumed.

    • Attribute type: Property. DateTime
    • Mandatory if energyConsumed is present.

  • lastMeterReading : Value of the last reading obtained from the energy consumed metering system.

    • Attribute type: Property. Number
    • Default unit: Kilowatts per hour (kWh).
    • Attribute metadata:
      • timestamp: Timestamp which reflects the date and time at which the referred reading was obtained.
    • Optional

  • meterReadingPeriod : The periodicity of energy consumed meter readings in days.

    • Attribute type: Property. Number
    • Optional

  • frequency : The working frequency of the circuit.

    • Attribute type: Property. Number
    • Default unit: Hertz (Hz)
    • Optional

  • totalActivePower : Active power currently consumed (counting all phases).

    • Attribute type: Property. Number
    • Default unit: KiloWatts (kW).
    • Attribute metadata:
      • timestamp: Timestamp when the last update of the attribute happened.
    • Optional

  • totalReactivePower : Reactive power currently consumed (counting all phases).

    • Attribute type: Property. Number
    • Default unit: KiloVolts-Ampere-Reactive (kVArh).
    • Attribute metadata:
      • timestamp: Timestamp when the last update of the attribute happened.
    • Optional

  • activePower : Active power consumed per phase. The actual values will be conveyed by subproperties which name will be equal to the name of each of the alternating current phases, typically R, S, T.

    • Attribute type: Property. StructuredValue
    • Default unit: Kilowatts (kW)
    • Attribute metadata:
      • timestamp: Timestamp when the last update of the attribute happened.
    • Optional

  • reactivePower : Reactive power. The actual values will be conveyed by subproperties which name will be equal to the name of each of the alternating current phases, typically R, S, T.

    • Attribute type: Property. StructuredValue
    • Default unit: KiloVolts-Ampere-Reactive (kVArh)
    • Attribute metadata:
      • timestamp: Timestamp when the last update of the attribute happened.
    • Optional

  • powerFactor : Power factor.

    • Attribute type: Property. Number
    • Allowed values: A number between -1 and 1.
    • Attribute metadata:
      • timestamp: Timestamp when the last update of the attribute happened.
    • Optional

  • cosPhi : "Cosin of phi" parameter.

    • Attribute type: Property. Number
    • Allowed values: A number between -1 and 1.
    • Attribute metadata:
      • timestamp: Timestamp when the last update of the attribute happened.
    • Optional

  • intensity : Electric intensity. The actual values will be conveyed by one subproperty per alternating current phase. The name of each subproperty will be equal to a phase mnemonic. The mnemonic used for denoting phases can vary depending on world regions. In Europe they are typically named as R, S, T.

    • Attribute type: Property. StructuredValue
    • Default unit: Ampers (A)
    • Attribute metadata:
      • timestamp: Timestamp when the last update of the attribute happened.
    • Optional

  • voltage : Electric tension. The actual values will be conveyed by one subproperty alternating current phase. The name of each subproperty will be equal to a phase mnemonic. The mnemonic used for denoting phases can vary depending on world regions. In Europe they are typically named as R, S, T.

    • Attribute type: Property. StructuredValue
    • Default unit: Volts (V)
    • Attribute metadata:
      • timestamp: Timestamp when the last update of the attribute happened.
    • Optional

  • thdrVoltage : Total harmonic distortion (R) of The name of each subproperty will be equal to a phase mnemonic. The mnemonic used for denoting phases can vary depending on world regions. In Europe they are typically named as R, S, T.

    • Attribute type: Property. StructuredValue
    • Allowed values: A number between 0 and 1.
    • Optional

  • thdrIntensity : Total harmonic distortion (R) of intensity. The name of each subproperty will be equal to a phase mnemonic. The mnemonic used for denoting phases can vary depending on world regions. In Europe they are typically named as R, S, T.

    • Attribute type: Property. StructuredValue
    • Allowed values: A number between 0 and 1.
    • 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).

Examples

Normalized Example

Normalized NGSI response

{
    "id": "streetlightcontrolcabinet:A45HGJK",
    "type": "StreetlightControlCabinet",
    "modelName": {
        "value": "Simatic S7 1200"
    },
    "lastMeterReading": {
        "value": 161237
    },
    "dateMeteringStarted": {
        "type": "DateTime",
        "value": "2013-07-07T15:05:59.408Z"
    },
    "dateLastProgramming": {
        "type": "DateTime",
        "value": "2016-07-08T16:04:30.201Z"
    },
    "refStreetlightGroup": {
        "type": "Relationship",
        "value": ["streetlightgroup:BG678", "streetlightgroup:789"]
    },
    "compliantWith": {
        "value": ["IP54"]
    },
    "intensity": {
        "value": {
            "S": 14.4,
            "R": 20.1,
            "T": 22
        }
    },
    "workingMode": {
        "value": "automatic"
    },
    "energyConsumed": {
        "value": 162456
    },
    "meterReadingPeriod": {
        "value": 60
    },
    "cupboardMadeOf": {
        "value": "plastic"
    },
    "brandName": {
        "value": "Siemens"
    },
    "location": {
        "type": "geo:json",
        "value": {
            "type": "Point",
            "coordinates": [-3.164485591715449, 40.62785133667262]
        }
    },
    "reactivePower": {
        "value": {
            "S": 43.5,
            "R": 45,
            "T": 42
        }
    },
    "maximumPowerAvailable": {
        "value": 10
    }
}

key-value pairs Example

Sample uses simplified representation for data consumers ?options=keyValues

{
    "id": "streetlightcontrolcabinet:A45HGJK",
    "type": "StreetlightControlCabinet",
    "location": {
        "type": "Point",
        "coordinates": [-3.164485591715449, 40.62785133667262]
    },
    "cupboardMadeOf": "plastic",
    "brandName": "Siemens",
    "modelName": "Simatic S7 1200",
    "refStreetlightGroup": ["streetlightgroup:BG678", "streetlightgroup:789"],
    "compliantWith": ["IP54"],
    "dateLastProgramming": "2016-07-08T16:04:30.201Z",
    "maximumPowerAvailable": 10,
    "energyConsumed": 162456,
    "dateMeteringStarted": "2013-07-07T15:05:59.408Z",
    "lastMeterReading": 161237,
    "meterReadingPeriod": 60,
    "intensity": {
        "R": 20.1,
        "S": 14.4,
        "T": 22
    },
    "reactivePower": {
        "R": 45,
        "S": 43.5,
        "T": 42
    },
    "workingMode": "automatic"
}

LD Example

Sample uses the NGSI-LD representation

{
    "id": "urn:ngsi-ld:StreetlightControlCabinet:streetlightcontrolcabinet:A45HGJK",
    "type": "StreetlightControlCabinet",
    "modelName": {
        "type": "Property",
        "value": "Simatic S7 1200"
    },
    "lastMeterReading": {
        "type": "Property",
        "value": 161237
    },
    "dateMeteringStarted": {
        "type": "Property",
        "value": {
            "@type": "DateTime",
            "@value": "2013-07-07T15:05:59.408Z"
        }
    },
    "dateLastProgramming": {
        "type": "Property",
        "value": {
            "@type": "DateTime",
            "@value": "2016-07-08T16:04:30.201Z"
        }
    },
    "refStreetlightGroup": {
        "type": "Relationship",
        "object": [
            "urn:ngsi-ld:StreetlightGroup:streetlightgroup:BG678",
            "urn:ngsi-ld:StreetlightGroup:streetlightgroup:789"
        ]
    },
    "compliantWith": {
        "type": "Property",
        "value": ["IP54"]
    },
    "intensity": {
        "type": "Property",
        "value": {
            "S": 14.4,
            "R": 20.1,
            "T": 22
        }
    },
    "workingMode": {
        "type": "Property",
        "value": "automatic"
    },
    "energyConsumed": {
        "type": "Property",
        "value": 162456
    },
    "meterReadingPeriod": {
        "type": "Property",
        "value": 60
    },
    "cupboardMadeOf": {
        "type": "Property",
        "value": "plastic"
    },
    "brandName": {
        "type": "Property",
        "value": "Siemens"
    },
    "location": {
        "type": "GeoProperty",
        "value": {
            "type": "Point",
            "coordinates": [-3.164485591715449, 40.62785133667262]
        }
    },
    "reactivePower": {
        "type": "Property",
        "value": {
            "S": 43.5,
            "R": 45,
            "T": 42
        }
    },
    "maximumPowerAvailable": {
        "type": "Property",
        "value": 10
    },
    "@context": [
        "https://schema.lab.fiware.org/ld/context",
        "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld"
    ]
}

Test it with a real service

Open Issues

  • Should we create a StreetlightControlCabinetModel entity type?
  • Should we have the programming parameters as attribute of this entity? Advantage is that if programming is the same for all the controlled cicuits then there is no need to repeat the same parameters over multiple entities.