Automatic creation of examples

In order to reduce the amount of work in the contribution of data models, we have a script that generates the key-values format of a normalized NGSI LD payload.
It has been operated on 46 data models currently in the repository.

In a close future instead of submitting 4 examples, it will be only necessary to include 2 examples, the normalized payloads for NGSI v2 and NGSI LD (the other two would be generated automatically).

Making examples more consistent

All the repositories have been normalized in the naming of the core examples. So:

  • Key values in NGSI v2 is named example.json
  • Key values in NGSI LD is named example.jsonld
  • Normalized (default) in NGSI v2 is named example-normalized.json
  • Normalized (default) in NGSI LD is named example-normalized.jsonld

It is possible to have more examples in the directory. And in the same directory of every data model, there are other exports (csv) for the use of the data model users.
The goal is that this 4 examples were present in every data model

Automated README for Subjects

As promised the README.md at Subject level explaining the different data models is automated, and therefore there is no need to be contributed by the contributors. See an example here for the weather subject

Thus, the README.md is based on the data models and their descriptions, linking to the current contributors

Soon the README.md for the domain will be also automated.

Best

Automated README.md for data models

Currently, the README.md at data models level (inside every directory in a Subject) explaining the contents of the data models is automated, and therefore there is no need to be contributed by the contributors. See an example here for the weather forecast.

Thus, the README.md is based on the examples provided, the specification and the model.yaml.

Soon the README.md for the Subject will be also automated.

Incubated data models

if you are browsing the repository you can realise that now there are several data models ended with the term ‘_incubated’.
This suffix denotes that there will be ‘soon’ a new data model.
The readme in the folder points to the repository where this data model is being created.

Once finished (all the docs, examples, etc) the _incubated suffix will be removed and the data model will be fully included into the data models.
some examples:

Network_incubated

Node_incubated

Simulation_incubated

Floor_incubated

BuildingType_incubated

PhreaticObserved_incubated

etc

 

Survey to the users of smart data models

This is the first survey to the USERS of the Smart Data Models. We want to know what is more important to you and try to prioritize our efforts. This is an agile initiative, therefore we will take into very consideration your comments. Your survey is anonymous although if you wish you can include your email in comments and we will contact you regarding your comments.

You can answer it here.

    Are you, or your organization, a user of FIWARE platform (any enabler)

    YesNoDo not know

    What elements of the data models are useful for you:

    The json schema. See an example
    Very usefulSomehow usefulNot useful
    The examples of payloads. See an example
    Very usefulSomehow usefulNot useful
    The specification. See an example
    Very usefulSomehow usefulNot useful
    Other elements. Specify Which one/s
    Very usefulSomehow usefulNot useful

    Are you interested on the smart data models?

    YesNoDo not knowOther
    Explain other

    Why don't you use FIWARE platform?

    I do not need itIt is complicatedNot yetOther
    Explain other

    Please choose the more likely (Yes / No)

    Other recommendations or comments about your answers

    How do you describe yourself

    A developerAn end userA project managerA manager

    Soon there will be another survey for the CONTRIBUTORS.

    New data models for Photovoltaic Device

    In the harmonization repository, there is a new model name photovoltaic Device. To be completed previously to be incorporated. You can submit an issue on it if interested.

    The Data Model is intended to describe the mechanical, electrical and thermal characteristics of photo-voltaic panels according to : – STC – Standard Test Condition – Sunshine 1000 Wm² / Radiation 1.5 AM / Temp 25° Celsius / Air Masse 0 m/s. – NOCT – Normal Operating Cell Temperature
    – Sunshine 800 Wm² / Radiation 1.5 AM / Temp 20° Celsius / Air Masse 1 m/s.

    The measures performed for STC and NOCT are – [Pmax] Maximum Nominal Power measured in WTT represents Watt.. – [Umpp] Optimal operating voltage measured in VLT represents Volt. – [Impp] Optimal Operating Current measured in AMP represents Ampere. – [Uoc] Open Circuit Voltage measured in VLT represents Volt. – [Isc] Short Circuit Current measured in AMP represents Ampere.

    Additional Information about Data Model: This Data Model can be used directly as the main entity to describe the device [PHOTOVOLTAIC] or as a sub-entity of the Data Model [DEVICE] using a reference by the refDevice attribute.

    New data models on Energy

    There are two data models coming for the Energy domain (ACMeasurement and InverterDevice). You can submit an issue on it if interested.

    Once harmonized with the contributors and checking the interaction with other data models they will be incorporated into the Energy repository inside the domain of Smart Energy.

    ACMeasurement

    The Data Model intended to measure the electrical energies consumed by an electrical system which uses an Alternating Current (AC) for a three-phase (L1, L2, L3) or single-phase (L) and neutral (N). It integrates the initial version of the data Modem [THREEPHASEMEASUREMENT], extended to also perform single-phase measurements. it includes attributes for various electrical measurements such as power, frequency, current and voltage.

    Additional Information about Attributes : For some attributes such as current and voltage the value is a structured value with properties for the Single-Phase (L) or three different phases (L1, L2 and L3). For some measurements such as the different power types (active, reactive and apparent power) there is an attribute for the total from all phases. The rules are defined as below : – Three Phase – Total = L1 + L2 + L3 – Single Phase – Total = L.

    For most of the attributes, there are various ways they can be actually measured. For this purpose the measurementType Meta Data Attribute can be used. It can have the following values:

    When using the values [average, rms, minimum, maximum], another metadata attribute called measurementInterval should be used to give the length of the measurement period in seconds. Also the Meta Data timestamp attribute should be the end time of the measurement period.

    InverterDevice

    The Data Model is intended to describe the mechanical, electrical characteristics of an Inverter according to DC – Direct Current Information supplied as input and AC – Alternating Current Information returned as output.

    Additional Information about Data Model: This Data Model can be used directly as the main entity to describe the device [INVERTER] or as a sub-entity of the Data Model [DEVICE] using a reference by the refDevice attribute.

    New harmonization repository

    In order to provide a more transparent and participative approach to the creation and maintenance of data models, here you can see the three stages for a usual data model to be part of the official list of data models.

    1.- Pending is the ‘wild’ zone where developers share their thoughts and create their data models. When finished (ready) they can create a PR on the right Subject repository.

    2.- Harmonization is the repository for those new accepted models while they are fine-tuned or completed

    3.- Subject means the repository in which the data model is officially published. Once there they are versioned when necessary.

    Pending Harmonization Subject
    Control of contributions No Yes Yes
    Scripts for checking No Yes (specific) Yes (only acceptance and on update)
    Code inside json schema No Harmonizing Local standard

    Global standard

    Versioning No No Yes
    Managed Each contributor Contributor + SDM control SDM control
    In domain No No Yes
    Accept issues Yes but not managed Yes Yes (Here the open ones)
    First Access Anyone
    1. Anyone previous pending acceptance
    2. Members direct
    N/A

    SDM: Smart Data Models initiative