Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

New submodel IoT_sensor_data #83

Merged
merged 11 commits into from
Apr 17, 2023
Merged

New submodel IoT_sensor_data #83

merged 11 commits into from
Apr 17, 2023

Conversation

Cvetanka-ZF
Copy link
Contributor

@Cvetanka-ZF Cvetanka-ZF commented Feb 22, 2023 •
edited by bs-jokri
Loading

Description

A new model IoTSensorDAta required by the product Asset Tracking (BD Sustainability)
-->

Closes #54

MS2 Criteria

(to be filled out by PR reviewer)

  • the model validates with the BAMM SDS SDK in the version specified in the Readme.md of this repository by the time of the MS2 check (e.g., 'java -jar bamm-cli.jar -i <path-to-aspect-model> -v ). The BAMM CLI is available here and in GitHub
  • use Camel-Case (e.g., "MyModelElement" or "TimeDifferenceGmtId", when in doubt follow https://google.github.io/styleguide/javaguide.html#s5.3-camel-case)
  • the identifiers for all model elements start with a capital letter except for properties
  • the identifier for properties starts with a small letter
  • all model elements at least contain the fields "name" and "description" in English language.
  • no duplicate names or preferredNames within an Aspect (e.g. a Property and the referenced Characteristic should not have the same name)
  • the versioning in the URN follows semantic versioning, where minor version bumps are backwards compatible and major version bumps are not backwards compatible.
  • use abbreviations only when necessary and if these are sufficiently common
  • avoid redundant prefixes in property names (consider adding properties to an enclosing Entity or even adapt the namespace of the model elements, e.g., instead of having two properties DismantlerId and DismantlerName use an Entity Dismantler with the properties name and id or use a URN like io.catenax.dismantler:0.0.1)
  • fields preferredName and description are not the same
  • preferredName should be human readable and follow normal orthography (e.g., no camel case but normal word separation)
  • name of aspect is singular except if it only has one property which is a Collection, List or Set. In theses cases, the aspect name is plural.
  • units are referenced from the BAMM unit catalog whenever possible
  • use constraints to make known constraints from the use case explicit in the aspect model
  • when relying on external standards, they are referenced through a "see" element
  • all properties with an simple type have an example value
  • metadata.json exists with status "release"
  • file RELEASE_NOTES.md exists and contains entries for proposed model changes

MS3 Criteria

(to be filled out by semantic modeling team before merge to main-branch)

  • All required reviewers have approved this PR (see reviewers section)
  • The new aspect (version) will be implemented by at least one data provider
  • The new aspect (version) will be consumed by at least one data consumer
  • There exists valid test data
  • In case of a new (incompatible) major version to an existing version, a migration strategy has been developed
  • The model has at least version '1.0.0'

@Cvetanka-ZF Cvetanka-ZF changed the title Cvetanka zf iot sensor data New model IoT_sensor_data Feb 22, 2023
@Cvetanka-ZF Cvetanka-ZF changed the title New model IoT_sensor_data New submodel IoT_sensor_data Feb 22, 2023
bs-jokri
bs-jokri suggested changes Feb 22, 2023
View reviewed changes
Copy link
Contributor

@bs-jokri bs-jokri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Model looks very good overall. Some smaller comments. Would be great if you can consider fixing them

io.catenax.iot_sensor_data/1.0.0/IoTSensorData.ttl Outdated Show resolved Hide resolved
io.catenax.iot_sensor_data/1.0.0/IoTSensorData.ttl Outdated Show resolved Hide resolved
io.catenax.iot_sensor_data/1.0.0/IoTSensorData.ttl Outdated Show resolved Hide resolved
io.catenax.iot_sensor_data/1.0.0/IoTSensorData.ttl Outdated Show resolved Hide resolved
io.catenax.iot_sensor_data/1.0.0/IoTSensorData.ttl Outdated Show resolved Hide resolved
io.catenax.iot_sensor_data/1.0.0/IoTSensorData.ttl Outdated Show resolved Hide resolved
io.catenax.iot_sensor_data/1.0.0/IoTSensorData.ttl Outdated
bamm:dataType xsd:string.
:AnalogSensorCharacteristic a bamm:Characteristic;
bamm:preferredName "Analog Sensor 1-10 Characteristic"@en;
bamm:description "Characteristic that describes the property analog sensor"@en;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this sensor about? I do not fully understand what 1-10 means? Is it that it can be between 1 and 10?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After discussion with the team, there was some misunderstanding here. This attribute should be modeled as a list. Analog Sensor 1-10 means the data is collected from 10 sensors. I have modeled it now in a list.

io.catenax.iot_sensor_data/1.0.0/IoTSensorData.ttl Outdated Show resolved Hide resolved
io.catenax.iot_sensor_data/1.0.0/IoTSensorData.ttl Outdated
:AltitudeCharacteristic a bamm:Characteristic;
bamm:preferredName "Altitude Characteristic"@en;
bamm:dataType xsd:decimal;
bamm:see <http://www.nmea.de/nmea0183datensaetze.html#rmc%C2%A0>.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where is the relation between altitude and the referenced page?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link was wrong. Changed to http://www.nmea.de/nmea0183datensaetze.html#gga.

io.catenax.iot_sensor_data/1.0.0/IoTSensorData.ttl Outdated
:AltitudeCharacteristic a bamm:Characteristic;
bamm:preferredName "Altitude Characteristic"@en;
bamm:dataType xsd:decimal;
bamm:see <http://www.nmea.de/nmea0183datensaetze.html#rmc%C2%A0>.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where is the relation between altitude and the referenced page? Or is it referring this entry for GPS coordinates? ALM - GPS Almanac Data

    1   2   3  4   5  6    7  8    9    10     11     12     13     14  15   16 
    |   |   |  |   |  |    |  |    |    |      |      |      |      |   |    |

$--ALM,x.x,x.x,xx,x.x,hh,hhhh,hh,hhhh,hhhh,hhhhhh,hhhhhh,hhhhhh,hhhhhh,hhh,hhh,*hh

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link was wrong. Changed to http://www.nmea.de/nmea0183datensaetze.html#gga.
The sentence is :
GGA - Global Positioning System Fix Data, Time, Position and fix related data fora GPS receiver.
And it refers to the element 9.

@bs-jokri
Copy link
Contributor

@Cvetanka-ZF here you also need to adjust the file name to fit the aspect name

bs-jokri
bs-jokri approved these changes Feb 28, 2023
View reviewed changes
Copy link
Contributor

@bs-jokri bs-jokri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM check the one comment if applicable. Apart from that we are good to go

io.catenax.iot_sensor_data/1.0.0/IoTSensorData.ttl Outdated
bamm:characteristic :TransmissionMethodCharacteristic;
bamm:exampleValue "LoRaWAN".
:analogSensor a bamm:Property;
bamm:preferredName "Analog Sensor 1-10"@en;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this still the right preferred name?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed.

@bs-jokri bs-jokri added the MS2_Approved Checklist "MS2 Valid Model" is approved. label Feb 28, 2023
catroest
catroest reviewed Mar 23, 2023
View reviewed changes
io.catenax.iot_sensor_data/1.0.0/IotSensorData.ttl
# Copyright (c) 2023 BASF SE
# Copyright (c) 2023 Henkel AG & Co. KGaA
# Copyright (c) 2023 ZF Friedrichshafen AG
#
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copyright (c) 2023 Contributors to the Eclipse Foundation?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added. Thanks! :)

@Cvetanka-ZF
Copy link
Contributor Author

Modeling_Team

@bs-jokri bs-jokri added the MS3_Approved Checklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br label Apr 3, 2023
@bs-jokri bs-jokri merged commit 1a90e82 into eclipse-tractusx:main Apr 17, 2023
@Cvetanka-ZF Cvetanka-ZF deleted the Cvetanka-ZF-IoTSensorData branch November 13, 2023 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@catroest catroest catroest left review comments

@bs-jokri bs-jokri bs-jokri approved these changes

Assignees
No one assigned
Labels
MS2_Approved Checklist "MS2 Valid Model" is approved. MS3_Approved Checklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[New Model]: IoTSensorData
3 participants
@Cvetanka-ZF @bs-jokri @catroest