adding tutorial

tutorial/config.toml

@@ -0,0 +1,22 @@
+baseURL = "https://w3c.github.io/automotive-viss2/"
+languageCode = "en-us"
+title = "W3C VISSv2 Reference Implementation"
+theme = "learn"
+publishDir = "../tutorial"
+[params]
+  # Change default color scheme with a variant one. Can be "red", "blue", "green".
+  themeVariant = "blue"
+  disableInlineCopyToClipBoard = true
+  editURL = "https://github.com/w3c/automotive-viss2/edit/master/tutorial/content/"
+  disableLandingPageButton = true
+
+
+[[menu.shortcuts]]
+name = "<i class='fab fa-github'></i> Github repo"
+identifier = "ds"
+url = "https://github.com/w3c/automotive-viss2"
+weight = 10
+
+# Generation of JSON index to allow search
+[outputs]
+home = [ "HTML", "RSS", "JSON"]

tutorial/content/_index.md

@@ -0,0 +1,25 @@
+---
+title: "W3C Vehicle Information Signal Specification ver 2, VISSv2 Tutorial"
+---
+# W3C Vehicle Information Signal Specification ver 2
+
+This W3C specification, soon to become a W3C standard, is developed at the [W3C/automotive github](https://github.com/w3c/automotive),
+and this Github contains a reference implementation in the form of a server that exposes an interface according to the specification.
+
+Also found on this Github are implementations of other components that are needed to realize a communication tech stack, from clients to the underlying vehicle system.
+These components can be categorized as follows:
+* server
+* client
+* data storage
+* feeder
+
+## Server
+
+
+## Client
+
+
+## Data storage
+
+
+## Feeder

tutorial/content/build-system/_index.md

@@ -0,0 +1,11 @@
+---
+title: "VISSv2 Build System"
+---
+
+Most of the code at this repository is written in Golang, so in order to use this repo Golang must be installed on the computer.
+
+## Installing Golang on Ubuntu
+
+
+## Installing Golang on Mac
+

tutorial/content/client/_index.md

@@ -0,0 +1,10 @@
+---
+title: "VISSv2 Clients"
+---
+
+There is a number of different clients avaliable on this repo undr the directory Clients.
+
+## Java based clients
+
+
+## Golang based clients

tutorial/content/datastore/_index.md

@@ -0,0 +1,6 @@
+---
+title: "VISSv2 Data Storage"
+---
+
+Two realizations of data storage are available on the [COVESA/CCS-components Github](https://github.com/COVESA/ccs-components),
+one using an SQLite database, and the other a Redis database.

tutorial/content/feeder/_index.md

@@ -0,0 +1,8 @@
+---
+title: "VISSv2 Feeder"
+---
+
+A feeder is a Sw component that has three purposes:
+* Implement an interface to the data storage
+* Implement an interface to the underlying vehicle interface
+* Translate data from the format used in the "VSS domain" to te format used in the "Vehicle domain".

tutorial/content/pocs/_index.md

@@ -0,0 +1,6 @@
+---
+title: "VISSv2 POCs"
+---
+
+The communication tech stack architecture can be realized in different "flavors", and here a few different are presented.
+

tutorial/content/pocs/poc1/_index.md

@@ -0,0 +1,5 @@
+---
+title: "VISSv2 (POC1, replace by more expressive name)"
+---
+
+The presentation...

tutorial/content/server/_index.md

@@ -0,0 +1,6 @@
+---
+title: "VISSv2 Server"
+---
+
+The VISSv2 server is the Sw component that implements the interface that is exposed to the clients, and that must conform to the W3C VISSv2 specification.
+

tutorial/data/units.yaml

@@ -0,0 +1,226 @@
+# This file defines units supported in the VSS standard catalog
+units:
+  mm:
+    label: millimeter
+    description: Distance measured in millimeters
+    domain: distance
+  cm:
+    label: centimeter
+    description: Distance measured in centimeters
+    domain: distance
+  m:
+    label: meter
+    description: Distance measured in meters
+    domain: distance
+  km:
+    label: kilometer
+    description: Distance measured in kilometers
+    domain: distance
+  inch:
+    label: inch
+    description: Distance measured in inches
+    domain: distance
+  km/h:
+    label: kilometer per hour
+    description: Speed measured in kilometers per hours
+    domain: speed
+  m/s:
+    label: meters per second
+    description: Speed measured in meters per second
+    domain: speed
+  m/s^2:
+    label: meters per second squared
+    description: Acceleration measured in meters per second squared
+    domain: acceleration
+  cm/s^2:
+    label: centimeters per second squared
+    description: Acceleration measured in centimeters per second squared
+    domain: acceleration
+  ml:
+    label: milliliter
+    description: Volume measured in milliliters
+    domain: volume
+  l:
+    label: liter
+    description: Volume measured in liters
+    domain: volume
+  cm^3:
+    label: cubic centimeters
+    description: Volume measured in cubic centimeters
+    domain: volume
+  celsius:
+    label: degree celsius
+    description: Temperature measured in degree celsius
+    domain: temperature
+  degrees:
+    label: degree
+    description: Angle measured in degrees
+    domain: angle
+  degrees/s:
+    label: degree per second
+    description: Angular speed measured in degrees per second
+    domain: angular speed
+  W:
+    label: watt
+    description: Power measured in watts
+    domain: power
+  kW:
+    label: kilowatt
+    description: Power measured in kilowatts
+    domain: power
+  PS:
+    label: horsepower
+    description: Power measured in horsepower
+    domain: power
+  kWh:
+    label: kilowatt hours
+    description: Energy consumption measured in kilowatt hours
+    domain: energy consumption
+  g:
+    label: gram
+    description: Mass measured in grams
+    domain: mass
+  kg:
+    label: kilogram
+    description: Mass measured in kilograms
+    domain: mass
+  lbs:
+    label: pound
+    description: Mass measured in pounds
+    domain: mass
+  V:
+    label: volt
+    description: Electric potential measured in volts
+    domain: electric potential
+  A:
+    label: ampere
+    description: Electric current measured in amperes
+    domain: electric current
+  Ah:
+    label: ampere hours
+    description: Electric charge measured in ampere hours
+    domain: electric charge
+  ms:
+    label: millisecond
+    description: Time measured in milliseconds
+    domain: time
+  s:
+    label: second
+    description: Time measured in seconds
+    domain: time
+  min:
+    label: minute
+    description: Time measured in minutes
+    domain: time
+  h:
+    label: hour
+    description: Time measured in hours
+    domain: time
+  day:
+    label: days
+    description: Time measured in days
+    domain: time
+  weeks:
+    label: weeks
+    description: Time measured in weeks
+    domain: time
+  months:
+    label: months
+    description: Time measured in months
+    domain: time
+  years:
+    label: years
+    description: Time measured in years
+    domain: time
+  UNIX Timestamp:
+    label: UNIX Timestamp
+    description: Unix time is a system for describing a point in time. It is the number of seconds that have elapsed since the Unix epoch, excluding leap seconds.
+    domain: point in time
+  mbar:
+    label: millibar
+    description: Pressure measured in millibars
+    domain: pressure
+  Pa:
+    label: pascal
+    description: Pressure measured in pascal
+    domain: pressure
+  kPa:
+    label: kilopascal
+    description: Pressure measured in kilopascal
+    domain: pressure
+  stars:
+    label: stars
+    description: Rating measured in stars
+    domain: rating
+  g/s:
+    label: grams per second
+    description: Mass per time measured in grams per second
+    domain: mass per time
+  g/km:
+    label: grams per kilometer
+    description: Mass per distance measured in grams per kilometers
+    domain: mass per distance
+  kWh/100km:
+    label: kilowatt hours per 100 kilometers
+    description: Energy consumption per distance measured in kilowatt hours per 100 kilometers
+    domain: energy consumption per distance
+  ml/100km:
+    label: milliliter per 100 kilometers
+    description: Volume per distance measured in milliliters per 100 kilometers
+    domain: volume per distance
+  l/100km:
+    label: liter per 100 kilometers
+    description: Volume per distance measured in liters per 100 kilometers
+    domain: volume per distance
+  l/h:
+    label: liter per hour
+    description: Flow measured in liters per hour
+    domain: flow
+  mpg:
+    label: miles per gallon
+    description: Distance per volume measured in miles per gallon
+    domain: distance per volume
+  N:
+    label: newton
+    description: Force measured in newton
+    domain: force
+  Nm:
+    label: newton meter
+    description: Torque measured in newton meters
+    domain: torque
+  rpm:
+    label: revolutions per minute
+    description: Rotational speed measured in revolutions per minute
+    domain: rotational speed
+  Hz:
+    label: frequency
+    description: Frequency measured in hertz
+    domain: frequency
+  ratio:
+    label: ratio
+    description: Relation measured as ratio
+    domain: relation
+  percent:
+    label: percent
+    description: Relation measured in percent
+    domain: relation
+  nm/km:
+    label: nano meter per kilometer
+    description: nm/km
+    domain: nm/km
+  dBm:
+    label: decibel milliwatt
+    description: Power level expressed in decibels with reference to one milliwatt
+    domain: relation
+  kN:
+    label: kilo newton
+    description: Force measured in kilo newton
+    domain: force
+  cpm:
+    label: cycles per minute
+    description: Number of cycles per minute
+    domain: frequency
+  bpm:
+    label: beats per minute
+    description: Number of human heart beats per minute
+    domain: frequency

tutorial/layouts/partials/favicon.html

@@ -0,0 +1 @@
+<link rel="shortcut icon" href="/hierarchical_information_model/images/fav.png" type="image/x-icon" />

tutorial/layouts/partials/logo.html

@@ -0,0 +1,3 @@
+<a id="logo" href="{{ .Site.BaseURL }}">
+  <img src="/hierarchical_information_model/images/him.png">
+</a>

tutorial/themes/learn/.grenrc.yml

@@ -0,0 +1,25 @@
+---
+  dataSource: "prs"
+  prefix: "v"
+  onlyMilestones: false
+  changelogFilename: "CHANGELOG.md"
+  includeMessages: "all"
+  ignoreIssuesWith:
+    - "support"
+  ignoreLabels:
+    - "duplicate"
+    - "invalid"
+    - "wontfix"
+  groupBy:
+    New features:
+      - "feature"
+    Bug Fixes:
+      - "bug"
+    Enhancements:
+      - "enhancement"
+    Internationalisation:
+      - "i18n"
+    Theme Meta:
+      - "meta"
+    Uncategorised:
+      - "closed"