document generated automatically
Global description: A Data Model for Solar Energy generation.
version: 0.0.1
[*] If there is not a type in an attribute is because it could have several types or different formats/patterns
activePower[object]: The actual values will beconveyed by subproperties which names will be equal to the name of each of the alternating current phases: L1, L2, L3. . Model: http://schema.org/StructuredValueL1:L2:
address[object]: The mailing address . Model: https://schema.org/addressaddressCountry[string]: The country. For example, Spain . Model: https://schema.org/addressCountryaddressLocality[string]: The locality in which the street address is, and which is in the region . Model: https://schema.org/addressLocalityaddressRegion[string]: The region in which the locality is, and which is in the country . Model: https://schema.org/addressRegiondistrict[string]: A district is a type of administrative division that, in some countries, is managed by the local governmentpostOfficeBoxNumber[string]: The post office box number for PO box addresses. For example, 03578 . Model: https://schema.org/postOfficeBoxNumberpostalCode[string]: The postal code. For example, 24004 . Model: https://schema.org/https://schema.org/postalCodestreetAddress[string]: The street address . Model: https://schema.org/streetAddress
alternateName[string]: An alternative name for this itemareaServed[string]: The geographic area where a service or offered item is provided . Model: https://schema.org/Textcurrent[object]: Electrical current. The actual values will be conveyed by one subproperty per alternating current phase and the neutral wire: L1, L2, L3 and N . Model: http://schema.org/StructuredValueL1:L2:L3:
dataDescriptor[string]: URI pointing to the data-descriptor entitydataProvider[string]: A sequence of characters identifying the provider of the harmonised data entitydateCreated[date-time]: Entity creation timestamp. This will usually be allocated by the storage platformdateModified[date-time]: Timestamp of the last modification of the entity. This will usually be allocated by the storage platformdescription[string]: A description of this itemenergyGenerated[number]: Energy generated over a specific time range from the energy resource corresponding to this observationfrequency[number]: Frequency observed from the entity corresponding to this observationid[*]: Unique identifier of the entitylocation[*]: Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygonmaxSolarPowerMeasure[number]: A measure of maximum solar energy that can be generatedname[string]: The name of this itemobservationDateTime[date-time]: Last reported time of observationowner[array]: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)phaseCurrent[object]: Current per phase. Ordered triple comprising of active power from three phases in the following order: [R Y B]L1:L2:
phaseVoltage[object]: The voltage between each phase and neutral conductor. The actual values will be conveyed by one subproperty per alternating current phase: L1, L2 and L3 . Model: http://schema.org/StructuredValueL1:L2:
powerFactor[object]: Power factor for each phase. The actual values will be conveyed by one subproperty per alternating current phase: L1, L2 and L3 . Model: http://schema.org/StructuredValueL1:L2:
reactivePower[object]: Fundamental frequency reactive power. The actual values will be conveyed by subproperties whose names will be equal to the name of each of the alternating current phases: L1, L2, L3 . Model: http://schema.org/StructuredValueL1:L2:
seeAlso[*]: list of uri pointing to additional resources about the itemsource[string]: A sequence of characters giving the original source of the entity data as a URL. Recommended to be the fully qualified domain name of the source provider, or the URL to the source objecttotalActivePower[number]: Total active power consumed by all phasestotalEnergyGenerated[number]: Total energy generated by the energy resource corresponding to this observationtotalReactivePower[number]: Total reactive power for all phasestype[string]: NGSI Entity type. It has to be SolarEnergyvoltage[number]: The value of Voltage in the entity corresponding to this observation
Required properties
idtype
Sorted alphabetically (click for details)
full yaml details
SolarEnergy:
description: A Data Model for Solar Energy generation.
properties:
activePower:
description: 'The actual values will beconveyed by subproperties which names will be equal to the name of each of the alternating current phases: L1, L2, L3. '
properties:
L1:
type: number
L2:
type: number
L3:
type: number
type: object
x-ngsi:
model: http://schema.org/StructuredValue
type: Property
units: watt (W).Active power consumed per phase
address:
description: The mailing address
properties:
addressCountry:
description: 'The country. For example, Spain'
type: string
x-ngsi:
model: https://schema.org/addressCountry
type: Property
addressLocality:
description: 'The locality in which the street address is, and which is in the region'
type: string
x-ngsi:
model: https://schema.org/addressLocality
type: Property
addressRegion:
description: 'The region in which the locality is, and which is in the country'
type: string
x-ngsi:
model: https://schema.org/addressRegion
type: Property
district:
description: 'A district is a type of administrative division that, in some countries, is managed by the local government'
type: string
x-ngsi:
type: Property
postOfficeBoxNumber:
description: 'The post office box number for PO box addresses. For example, 03578'
type: string
x-ngsi:
model: https://schema.org/postOfficeBoxNumber
type: Property
postalCode:
description: 'The postal code. For example, 24004'
type: string
x-ngsi:
model: https://schema.org/https://schema.org/postalCode
type: Property
streetAddress:
description: The street address
type: string
x-ngsi:
model: https://schema.org/streetAddress
type: Property
streetNr:
description: Number identifying a specific property on a public street
type: string
x-ngsi:
type: Property
type: object
x-ngsi:
model: https://schema.org/address
type: Property
alternateName:
description: An alternative name for this item
type: string
x-ngsi:
type: Property
areaServed:
description: The geographic area where a service or offered item is provided
type: string
x-ngsi:
model: https://schema.org/Text
type: Property
current:
description: 'Electrical current. The actual values will be conveyed by one subproperty per alternating current phase and the neutral wire: L1, L2, L3 and N'
properties:
L1:
type: number
L2:
type: number
L3:
type: number
N:
type: number
type: object
x-ngsi:
model: http://schema.org/StructuredValue
type: Property
units: Ampers (A)
dataDescriptor:
description: URI pointing to the data-descriptor entity
type: string
x-ngsi:
type: Relationship
dataProvider:
description: A sequence of characters identifying the provider of the harmonised data entity
type: string
x-ngsi:
type: Property
dateCreated:
description: Entity creation timestamp. This will usually be allocated by the storage platform
format: date-time
type: string
x-ngsi:
type: Property
dateModified:
description: Timestamp of the last modification of the entity. This will usually be allocated by the storage platform
format: date-time
type: string
x-ngsi:
type: Property
description:
description: A description of this item
type: string
x-ngsi:
type: Property
energyGenerated:
description: Energy generated over a specific time range from the energy resource corresponding to this observation
type: number
x-ngsi:
type: Property
frequency:
description: Frequency observed from the entity corresponding to this observation
type: number
x-ngsi:
type: Property
id:
anyOf:
- description: Identifier format of any NGSI entity
maxLength: 256
minLength: 1
pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$
type: string
x-ngsi:
type: Property
- description: Identifier format of any NGSI entity
format: uri
type: string
x-ngsi:
type: Property
description: Unique identifier of the entity
x-ngsi:
type: Property
location:
description: 'Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon'
oneOf:
- description: Geojson reference to the item. Point
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
type: number
minItems: 2
type: array
type:
enum:
- Point
type: string
required:
- type
- coordinates
title: GeoJSON Point
type: object
x-ngsi:
type: GeoProperty
- description: Geojson reference to the item. LineString
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
type: number
minItems: 2
type: array
minItems: 2
type: array
type:
enum:
- LineString
type: string
required:
- type
- coordinates
title: GeoJSON LineString
type: object
x-ngsi:
type: GeoProperty
- description: Geojson reference to the item. Polygon
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
items:
type: number
minItems: 2
type: array
minItems: 4
type: array
type: array
type:
enum:
- Polygon
type: string
required:
- type
- coordinates
title: GeoJSON Polygon
type: object
x-ngsi:
type: GeoProperty
- description: Geojson reference to the item. MultiPoint
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
type: number
minItems: 2
type: array
type: array
type:
enum:
- MultiPoint
type: string
required:
- type
- coordinates
title: GeoJSON MultiPoint
type: object
x-ngsi:
type: GeoProperty
- description: Geojson reference to the item. MultiLineString
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
items:
type: number
minItems: 2
type: array
minItems: 2
type: array
type: array
type:
enum:
- MultiLineString
type: string
required:
- type
- coordinates
title: GeoJSON MultiLineString
type: object
x-ngsi:
type: GeoProperty
- description: Geojson reference to the item. MultiLineString
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
items:
items:
type: number
minItems: 2
type: array
minItems: 4
type: array
type: array
type: array
type:
enum:
- MultiPolygon
type: string
required:
- type
- coordinates
title: GeoJSON MultiPolygon
type: object
x-ngsi:
type: GeoProperty
x-ngsi:
type: GeoProperty
maxSolarPowerMeasure:
description: A measure of maximum solar energy that can be generated
type: number
x-ngsi:
type: Property
name:
description: The name of this item
type: string
x-ngsi:
type: Property
observationDateTime:
description: Last reported time of observation
format: date-time
type: string
x-ngsi:
type: Property
owner:
description: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)
items:
anyOf:
- description: Identifier format of any NGSI entity
maxLength: 256
minLength: 1
pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$
type: string
x-ngsi:
type: Property
- description: Identifier format of any NGSI entity
format: uri
type: string
x-ngsi:
type: Property
description: Unique identifier of the entity
x-ngsi:
type: Property
type: array
x-ngsi:
type: Property
phaseCurrent:
description: 'Current per phase. Ordered triple comprising of active power from three phases in the following order: [R Y B]'
properties:
L1:
type: number
L2:
type: number
L3:
type: number
type: object
x-ngsi:
type: Property
phaseVoltage:
description: 'The voltage between each phase and neutral conductor. The actual values will be conveyed by one subproperty per alternating current phase: L1, L2 and L3'
properties:
L1:
minimum: 0
type: number
L2:
minimum: 0
type: number
L3:
minimum: 0
type: number
type: object
x-ngsi:
model: http://schema.org/StructuredValue
type: Property
units: Volts (V)
powerFactor:
description: 'Power factor for each phase. The actual values will be conveyed by one subproperty per alternating current phase: L1, L2 and L3'
properties:
L1:
maximum: 1
minimum: -1
type: number
L2:
maximum: 1
minimum: -1
type: number
L3:
maximum: 1
minimum: -1
type: number
type: object
x-ngsi:
model: http://schema.org/StructuredValue
type: Property
units: -1 to +1
reactivePower:
description: 'Fundamental frequency reactive power. The actual values will be conveyed by subproperties whose names will be equal to the name of each of the alternating current phases: L1, L2, L3'
properties:
L1:
type: number
L2:
type: number
L3:
type: number
type: object
x-ngsi:
model: http://schema.org/StructuredValue
type: Property
units: volts-ampere-reactive (VAr)
seeAlso:
description: list of uri pointing to additional resources about the item
oneOf:
- items:
format: uri
type: string
minItems: 1
type: array
- format: uri
type: string
x-ngsi:
type: Property
source:
description: 'A sequence of characters giving the original source of the entity data as a URL. Recommended to be the fully qualified domain name of the source provider, or the URL to the source object'
type: string
x-ngsi:
type: Property
totalActivePower:
description: Total active power consumed by all phases
type: number
x-ngsi:
type: Property
totalEnergyGenerated:
description: Total energy generated by the energy resource corresponding to this observation
type: number
x-ngsi:
type: Property
totalReactivePower:
description: Total reactive power for all phases
type: number
x-ngsi:
type: Property
type:
description: NGSI Entity type. It has to be SolarEnergy
enum:
- SolarEnergy
type: string
x-ngsi:
type: Property
voltage:
description: The value of Voltage in the entity corresponding to this observation
type: number
x-ngsi:
type: Property
required:
- id
- type
type: object
x-derived-from: https://voc.iudx.org.in/SolarEnergy
x-disclaimer: 'Redistribution and use in source and binary forms, with or without modification, are permitted provided that the license conditions are met. Copyleft (c) 2022 Contributors to Smart Data Models Program'
x-license-url: https://github.com/smart-data-models/dataModel.Energy/blob/master/SolarEnergy/LICENSE.md
x-model-schema: https://smart-data-models.github.io/dataModel.Energy/SolarEnergy/schema.json
x-model-tags: IUDX
x-version: 0.0.1 Here is an example of a SolarEnergy in JSON-LD format as key-values. This is compatible with NGSI-v2 when using options=keyValues and returns the context data of an individual entity.
show/hide example
{
"id": "urn:ngsi-ld:SolarEnergy:id:BHDU:88967916",
"type": "SolarEnergy",
"activePower": {
"L1": 36,
"L2": 35.1,
"L3": 35.6
},
"address": {
"addressCountry": "India",
"addressLocality": "New Delhi",
"addressRegion": "Delhi",
"postOfficeBoxNumber": "",
"postalCode": "110001",
"streetAddress": "Jai Singh Marg, Hanuman Road Area, Connaught Place"
},
"alternateName": "Solar energy source 1",
"areaServed": "",
"current": {
"L1": 1.2,
"L2": 1.2,
"L3": 1.3,
"N": 0.7
},
"dataDescriptor": "urn:ngsi-ld:SolarEnergy:dataDescriptor:TTTK:11491249",
"dataProvider": "",
"dateCreated": "2022-01-10T01:49:09Z",
"dateModified": "2022-01-10T01:50:52Z",
"description": "Solar energy source 1",
"energyGenerated": 766.1,
"frequency": 50,
"location": {
"coordinates": [
-35.589575,
-78.339812
],
"type": "Point"
},
"maxSolarPowerMeasure": 989.8,
"name": "Solar Energy measured at resource 1",
"observationDateTime": "2022-01-20T20:02:52Z",
"owner": [
"urn:ngsi-ld:SolarEnergy:items:DACI:25767721",
"urn:ngsi-ld:SolarEnergy:items:YVQJ:55840840"
],
"phaseCurrent": {
"L1": 111.5,
"L2": 109.3,
"L3": 111.0
},
"phaseVoltage": {
"L1": 120.5,
"L2": 116.4,
"L3": 119.8
},
"powerFactor": {
"L1": 0.7,
"L2": 0.7,
"L3": 0.5
},
"reactivePower": {
"L1": 108.1,
"L2": 107.0,
"L3": 106.5
},
"seeAlso": [
"urn:ngsi-ld:SolarEnergy:items:XREG:08856151"
],
"source": "",
"totalActivePower": 873.9,
"totalEnergyGenerated": 527.6,
"totalReactivePower": 8690,
"voltage": 122.0
} Here is an example of a SolarEnergy in JSON-LD format as normalized. This is compatible with NGSI-v2 when not using options and returns the context data of an individual entity.
show/hide example
{
"id": "urn:ngsi-ld:SolarEnergy:id:BHDU:88967916",
"type": "SolarEnergy",
"location": {
"type": "geo:json",
"value": {
"type": "Point",
"coordinates": [
-35.589575,
-78.339812
]
}
},
"address": {
"type": "StructuredValue",
"value": {
"streetAddress": "Jai Singh Marg, Hanuman Road Area, Connaught Place",
"addressLocality": "New Delhi",
"addressRegion": "Delhi",
"addressCountry": "India",
"postalCode": "110001",
"postOfficeBoxNumber": ""
}
},
"areaServed": {
"type": "Text",
"value": ""
},
"dateCreated": {
"type": "DateTime",
"value": "2022-01-10T01:49:09Z"
},
"dateModified": {
"type": "DateTime",
"value": "2022-01-10T01:50:52Z"
},
"source": {
"type": "Text",
"value": ""
},
"name": {
"type": "Text",
"value": "Solar Energy measured at resource 1"
},
"alternateName": {
"type": "Text",
"value": "Solar energy source 1"
},
"description": {
"type": "Text",
"value": "Solar energy source 1"
},
"dataProvider": {
"type": "Text",
"value": ""
},
"owner": {
"type": "StructuredValue",
"value": [
"urn:ngsi-ld:SolarEnergy:items:DACI:25767721",
"urn:ngsi-ld:SolarEnergy:items:YVQJ:55840840"
]
},
"seeAlso": {
"type": "StructuredValue",
"value": [
"urn:ngsi-ld:SolarEnergy:items:XREG:08856151"
]
},
"totalActivePower": {
"type": "Number",
"value": 873.9
},
"phaseCurrent": {
"type": "StructuredValue",
"value": {
"L1": 111.5,
"L2": 109.3,
"L3": 111.0
}
},
"reactivePower": {
"type": "StructuredValue",
"value": {
"L1": 108.1,
"L2": 107.0,
"L3": 106.5
}
},
"voltage": {
"type": "Number",
"value": 122.0
},
"powerFactor": {
"type": "StructuredValue",
"value": {
"L1": 0.7,
"L2": 0.7,
"L3": 0.5
}
},
"current": {
"type": "StructuredValue",
"value": {
"L1": 1.2,
"L2": 1.2,
"L3": 1.3,
"N": 0.7
}
},
"totalReactivePower": {
"type": "Number",
"value": 110.8
},
"phaseVoltage": {
"type": "StructuredValue",
"value": {
"L1": 120.5,
"L2": 116.4,
"L3": 119.8
}
},
"activePower": {
"type": "StructuredValue",
"value": {
"L1": 17.3,
"L2": 19.5,
"L3": 20.4
}
},
"dataDescriptor": {
"type": "Text",
"value": "urn:ngsi-ld:SolarEnergy:dataDescriptor:TTTK:11491249"
},
"energyGenerated": {
"type": "Number",
"value": 766.1
},
"maxSolarPowerMeasure": {
"type": "Number",
"value": 989.8
},
"frequency": {
"type": "Number",
"value": 50
},
"totalEnergyGenerated": {
"type": "Number",
"value": 527.6
},
"observationDateTime": {
"type": "DateTime",
"value": "2022-01-20T20:02:52Z"
}
} Here is an example of a SolarEnergy in JSON-LD format as key-values. This is compatible with NGSI-LD when using options=keyValues and returns the context data of an individual entity.
show/hide example
{
"id": "urn:ngsi-ld:SolarEnergy:id:BHDU:88967916",
"type": "SolarEnergy",
"activePower": {
"L1": 17.3,
"L2": 19.5,
"L3": 20.4
},
"address": {
"addressCountry": "India",
"addressLocality": "New Delhi",
"addressRegion": "Delhi",
"postOfficeBoxNumber": "",
"postalCode": "110001",
"streetAddress": "Jai Singh Marg, Hanuman Road Area, Connaught Place"
},
"alternateName": "Solar energy source 1",
"areaServed": "",
"current": {
"L1": 1.2,
"L2": 1.2,
"L3": 1.3,
"N": 0.7
},
"dataDescriptor": "urn:ngsi-ld:SolarEnergy:dataDescriptor:TTTK:11491249",
"dataProvider": "",
"dateCreated": "2022-01-10T01:49:09Z",
"dateModified": "2022-01-10T01:50:52Z",
"description": "Solar energy source 1",
"energyGenerated": 766.1,
"frequency": 50,
"location": {
"coordinates": [
-35.589575,
-78.339812
],
"type": "Point"
},
"maxSolarPowerMeasure": 989.8,
"name": "Solar Energy measured at resource 1",
"observationDateTime": "2022-01-20T20:02:52Z",
"owner": [
"urn:ngsi-ld:SolarEnergy:items:DACI:25767721",
"urn:ngsi-ld:SolarEnergy:items:YVQJ:55840840"
],
"phaseCurrent": {
"L1": 111.5,
"L2": 109.3,
"L3": 111.0
},
"phaseVoltage": {
"L1": 120.5,
"L2": 116.4,
"L3": 119.8
},
"powerFactor": {
"L1": 0.7,
"L2": 0.7,
"L3": 0.5
},
"reactivePower": {
"L1": 108.1,
"L2": 107.0,
"L3": 106.5
},
"seeAlso": [
"urn:ngsi-ld:SolarEnergy:items:XREG:08856151"
],
"source": "",
"totalActivePower": 873.9,
"totalEnergyGenerated": 527.6,
"totalReactivePower": 110.8,
"voltage": 122.0,
"@context": [
"https://smart-data-models.github.io/dataModel.Energy/context.jsonld",
"https://raw.githubusercontent.com/smart-data-models/dataModel.Energy/master/context.jsonld"
]
} Here is an example of a SolarEnergy in JSON-LD format as normalized. This is compatible with NGSI-LD when not using options and returns the context data of an individual entity.
show/hide example
{
"id": "urn:ngsi-ld:SolarEnergy:id:BHDU:88967916",
"type": "SolarEnergy",
"location": {
"type": "GeoProperty",
"value": {
"type": "Point",
"coordinates": [[
-35.589575,
-78.339812
]]
}
},
"address": {
"type": "Property",
"value": {
"streetAddress": "Jai Singh Marg, Hanuman Road Area, Connaught Place",
"addressLocality": "New Delhi",
"addressRegion": "Delhi",
"addressCountry": "India",
"postalCode": "110001",
"postOfficeBoxNumber": ""
}
},
"areaServed": {
"type": "Property",
"value": ""
},
"dateCreated": {
"type": "Property",
"value": {
"@type": "DateTime",
"@value": "2022-01-10T01:49:09Z"
}
},
"dateModified": {
"type": "Property",
"value": {
"@type": "DateTime",
"@value": "2022-01-10T01:50:52Z"
}
},
"source": {
"type": "Property",
"value": ""
},
"name": {
"type": "Property",
"value": "Solar Energy measured at resource 1"
},
"alternateName": {
"type": "Property",
"value": "Solar energy source 1"
},
"description": {
"type": "Property",
"value": "Solar energy source 1"
},
"dataProvider": {
"type": "Property",
"value": ""
},
"owner": {
"type": "Property",
"value": [
"urn:ngsi-ld:SolarEnergy:items:DACI:25767721",
"urn:ngsi-ld:SolarEnergy:items:YVQJ:55840840"
]
},
"seeAlso": {
"type": "Property",
"value": [
"urn:ngsi-ld:SolarEnergy:items:XREG:08856151"
]
},
"totalActivePower": {
"type": "Property",
"value": 873.9
},
"phaseCurrent": {
"type": "Property",
"value": {
"L1": 111.5,
"L2": 109.3,
"L3": 111.0
}
},
"reactivePower": {
"type": "Property",
"value": {
"L1": 108.1,
"L2": 107.0,
"L3": 106.5
}
},
"voltage": {
"type": "Property",
"value": 122.0
},
"powerFactor": {
"type": "Property",
"value": {
"L1": 0.7,
"L2": 0.7,
"L3": 0.5
}
},
"current": {
"type": "Property",
"value": {
"L1": 1.2,
"L2": 1.2,
"L3": 1.3,
"N": 0.7
}
},
"totalReactivePower": {
"type": "Property",
"value": 110.8
},
"phaseVoltage": {
"type": "Property",
"value": {
"L1": 120.5,
"L2": 116.4,
"L3": 119.8
}
},
"activePower": {
"type": "Property",
"value": {
"L1": 17.3,
"L2": 19.5,
"L3": 20.4
}
},
"dataDescriptor": {
"type": "Relationship",
"object": "urn:ngsi-ld:SolarEnergy:dataDescriptor:TTTK:11491249"
},
"energyGenerated": {
"type": "Property",
"value": 766.1
},
"maxSolarPowerMeasure": {
"type": "Property",
"value": 989.8
},
"frequency": {
"type": "Property",
"value": 50
},
"totalEnergyGenerated": {
"type": "Property",
"value": 527.6
},
"observationDateTime": {
"type": "Property",
"value": {
"@type": "DateTime",
"@value": "2022-01-20T20:02:52Z"
}
},
"@context": [
"https://smart-data-models.github.io/dataModel.Energy/context.jsonld"
]
} See FAQ 10 to get an answer on how to deal with magnitude units