The storage battery data model is intended to describe the technical characteristics of the battery and the charging and discharging conditions of the energy. The charging functionalities apply from a power source which can be an ‘on-board system, solar panel, wind turbine, generator, power supply’. Hydraulic sources are not included in this version. The discharge functions apply to all types of the system requiring energy consumption from a storage battery. *Remark* This Data Model can be used directly as the main entity to describe the device *Battery Storage* or as a sub-entity of the Data Model *DEVICE* using a reference by the *refDevice* attribute.
Now you can see the links to the specification in two languages, Spanish y French in the README.md of every data models. German and Japanese are in the queue.
All the specifications (the text descriptions of the data model located in the /doc directory of each daat model) for the different domains and languages (currently French and Spanish besides English) have been updated to the new format. See an example in Spanish and French.
All of them are generated automatically from the json schema (which is the unique source of truth for the data model)
The new version of the smart data models specification is on progress (most of the /doc directories of the data models have a version). If you want to check how this would look like you can have through this API call
dataModel: The name of the entity for the specification
schemaUrl: The link to the RAW version of the json schema (see example)
examplesUrl: the url of where the 4 examples required for a data model are available (named
notesUrl: The url to the yaml for the customization paragraphs (notesHeader, after the title, notesMiddle, after properties’ list and notesFooter by the end)
Output: A markdown text that although the HTML visualization is faulty, the source code of the page can be pasted in any markdown viewer (optimized for github) and you see will see something like this.
We are on the transition to having all the data models compliant.
The schemas to be accepted in the Smart Data Model initiative need to include a description for every property. In order to review your data models before submission, it should pass this test.
Output: A json payload with the list with of properties of the data model including those referenced through $ref and its status of documentation in the schema.
x-ngsi: Boolean. Describes if the description contains property, relationship or geoproperty in the description.
x-ngsi_text: Text. Further explanations about x-ngsi value.
documented: Boolean. If the description is complete enough for its use.
text: Text. complementary information about the documentation (It could be either incomplete or non-existing)
In order to be accepted all the properties have to include a relevant description, and therefore need to have both parameters x-ngsi and documented to True for all the properties.
We are on the transition to having all the data models compliant.