Merge pull request #39 from UlfBj/master

Example files update

Author: UlfBj

examples/HIM_Service_example.v1.0.0.vspec

@@ -1,44 +1,63 @@
+# The service tree example builds on input from the Capabilities project:
+# https://covesa.atlassian.net/wiki/spaces/WIK4/pages/39059848/Capabilities+Project+-+Seating+Capabilities#CapabilitiesProject-SeatingCapabilities-InformationTypes
+
 VehicleService:
   type: branch
   description: The Vehicle services.
 
-VehicleService.ExteriorLighting:
+VehicleService.Seating:
   type: branch
-  description: The Exterior lighting service.
+  description: The Seating service group.
 
-VehicleService.ExteriorLighting.Properties:
-  type: branch
-  description: The common properties of Exterior lighting service.
+VehicleService.Seating.MoveSeat:
+  type: procedure
+  description: Performs all supported seat movements.
 
-VehicleService.ExteriorLighting.Properties. HeadLampsLayout:
-  type: attribute
+VehicleService.Seating.MoveSeat.Input:
+  type: iostruct
+  description:  Input parameters= (SeatId, MovementType, Position, Credentials).
+
+VehicleService.Seating.MoveSeat.Input.SeatId:
+  type: property
+  datatype: Types.Struct.Seating.SeatId
+  description: Seat identity.
+
+VehicleService.Seating.MoveSeat.Input.MovementType:
+  type: property
   datatype: string
-  default: ["Left", "Right"]
-  description: The head lamp properties.
+  description: Type of movement. Supported types are retrieved via GetPropertiesSeating().
 
-VehicleService.ExteriorLighting.HeadLampsOnOff:
-  type: procedure
-  description: Microservice name=HeadLampsOnOff, Input=Switch, Output=None.
+VehicleService.Seating.MoveSeat.Input.Position:
+  type: property
+  datatype: Types.Common.Percentage
+  description: Final position of the movement, expressed as a percentage.
 
-VehicleService.ExteriorLighting.HeadLampsOnOff.Version:
-  type: attribute
+VehicleService.Seating.MoveSeat.Input.Credentials:
+  type: property
   datatype: string
-  default: 1.0.0
-  description: The HeadLampsOnOff microservice version.
+  description: A token with client credentials. Optional parameter.
 
-VehicleService.ExteriorLighting.HeadLampsOnOff.Input:
+VehicleService.Seating.MoveSeat.Output:
   type: iostruct
-  description: An iostruct type containing the input parameter(s).
+  description:  Output parameters= (Status, Position, ServiceId).
 
-VehicleService.ExteriorLighting.HeadLampsOnOff.Input.Switch:
-  type: symlink
-  path: Vehicle.Body.Lights.IsHighBeamSwitchOn
-  domain: Automotive.Vehicle.Car.ResourceData
-  version: 3.0.0+
-  description: The reference in the VSS data tree is set to the input value.
+VehicleService.Seating.MoveSeat.Output.Status:
+  type: property
+  datatype: Types.Enum.Common.Status
+  description: Status of the MoveSeat service.
 
-VehicleService.Version:
-  type: branch
-  description: Supported Version.
+VehicleService.Seating.MoveSeat.Output.Position:
+  type: property
+  datatype: Types.Common.Percentage
+  description: Final position of the movement, expressed as a percentage.
+
+VehicleService.Seating.MoveSeat.Input.ServiceId:
+  type: property
+  datatype: uint32
+  description: A reference to the service execution session.
 
-# Here follows the mandatory Major, Minor, and Patch nodes with the version of the entire VehicleService file.
+VehicleService.Seating.MoveSeat.Version:
+  type: attribute
+  datatype: string
+  default: 1.0.0
+  description: The MoveSeat service version.

examples/TypeDefinition_example.v1.0.0.vspec

@@ -2,30 +2,63 @@ Types:
   type: branch
   description: Root node for the datatype definition tree.
 
-Types.Location:
+Types.Struct:
+  type: branch
+  description: Struct definitions.
+
+Types.Struct.Seating:
+  type: branch
+  description: Seating related struct definitions.
+
+Types.Struct.Seating.SeatId:
   type: struct
-  description: A struct containing Lat/Long data.
+  description: Identity by position.
 
-Types.Location.Latitude:
-  datatype: double
+Types.Struct.Seating.SeatId.Row:
   type: property
-  min: -90
-  max: 90
-  unit: degrees
-  description: Current latitude of vehicle in WGS 84 geodetic coordinates, as measured at the position of GNSS receiver antenna.
+  datatype: string
+  description: Row name.
 
-Types.Location.Longitude:
-  datatype: double
+Types.Struct.Seating.SeatId.Column:
   type: property
-  min: -180
-  max: 180
-  unit: degrees
-  description: Current longitude of vehicle in WGS 84 geodetic coordinates, as measured at the position of GNSS receiver antenna.
+  datatype: string
+  description: Column name.
+
+Types.Enum:
+  type: branch
+  description: Enum definitions.
+
+Types.Enum.Service:
+  type: branch
+  description: Service enum definitions.
+
+Types.Enum.Service.Status:
+  type: attribute
+  datatype: uint8
+  enum:
+    SUCCESSFUL: 0
+    ONGOING: 1
+    CANCELED: 2
+    FAILED: -1
+  default: 0
+  description: The execution status of a service.
 
 Types.Version:
   type: branch
   description: Supported Version.
 
+Types.Common:
+  type: branch
+  description: Common definitions.
+
+Types.Common.Percentage:
+  type: attribute
+  datatype: float
+  unit: percent
+  min: 0
+  max: 100
+  description: Percent definition.
+
 Types.Version.Major:
   datatype: uint32
   type: attribute