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.

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

Documentation and trees update. #15

Merged
merged 2 commits into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs-gen/content/bus_tree/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Bus tree
weight: 20
chapter: true
---

# The bus tree
The vspec bus tree is a super tree that contains signal definitions for a large set of different bus models.
The HIM configurator is then used to create a signal tee for a specific bus variant.

The different bus variants that are present in the vspec files are:
* xxx

11 changes: 11 additions & 0 deletions docs-gen/content/him_configurator/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,14 @@ If not used the default is false, i. e. not to save the files.
The -e command line option is used to substitute the external datatype references with the actual enum definitions
from the common Datatypes tree in the tree(s) that the VSS-tools generate.

## Creation of a vehicle variant specific signal tree
The HIM configurator enables a model where a "super tree" covering all variations of a vehicle archetype
(like Truck, Trailer, Bus, etc) can be defined in the vspec files,
then the HIM configurator can be used to create a "variant specific" vehicle signal tree via the input data in the himConfiguration.json file.

## Usage of a vehicle variant specific signal tree
The output from the HIM configurator is the selected parts of the "vspec super tree" in a file with one of the supported formats.
This file can then e. g. be used in a vehicle of the selected variant by a server that is controlling the access to the signals.
The server cn then use the tree to "vet" client request - checking that the signal is present, whether it is read-only or read-write, etc.
An example of a server using it like this is the [VISS reference server](https://github.com/COVESA/vissr).

9 changes: 0 additions & 9 deletions docs-gen/content/tractor_tree/_index.md

This file was deleted.

12 changes: 10 additions & 2 deletions docs-gen/content/trailer_tree/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ weight: 20
chapter: true
---

# Heavyduty trailer tree
# The trailer tree
The vspec trailer tree is a super tree that contains signal definitions for a large set of different trailer models.
The HIM configurator is then used to create a signal tee for a specific trailer variant.

The different variants that are present in the vspec files are:
* Flatbed trailer: This trailer type has an open flat bed cargo unit.
* Box trailer: This trailer type has a cargo unit that is covered by walls and a roof.
* Tanker trailer: This trailer type has a cargo unit that is specicialized for carrying liquid cargos.
* Freezer trailer: This trailer type has a cargo unit that is specicialized for carrying cargos that require cooling.
* Specialized trailer: This trailer type has a cargo unit that does not match with any of the other types...

xxx...
17 changes: 17 additions & 0 deletions docs-gen/content/truck_tree/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Truck tree
weight: 20
chapter: true
---

# The truck tree
The vspec truck tree is a super tree that contains signal definitions for a large set of different truck models.
The HIM configurator is then used to create a signal tee for a specific truck variant.

The different variants that are present in the vspec files are:
* Tow truck: This truck type does not have an integrated cargo unit, but instead it is temporarily connected to a trailer (which defines its own signal tree).
* Flatbed truck: This truck type has an open flat bed cargo unit that is integrated with the rest of the truck.
* Box truck: This truck type has a cargo unit that is covered by walls and a roof that is integrated with the rest of the truck.
* Pickup truck: The model would support pickup trucks to be defined here also...
* Van: The model would support vans to be defined here also...

13 changes: 13 additions & 0 deletions docs-gen/content/truck_tree/driver_tree/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Driver tree
weight: 20
chapter: true
---

# The driver tree
The vspec driver tree is used to represent the truck driver data.
The source for this driver data is the truck dirver recording unit (in europe often named tachograph, in the US xxx).
As the driver recording unit may hold data not only for the current driver but also for previous drivers,
there might be several instances of this driver tree, one for each driver that the driver recording unit has a record on.
The data from these different instances should be accessible via the interface that is exposed by vehicle server managing the access to the driver recording device.

6 changes: 3 additions & 3 deletions docs-gen/themes/learn/static/css/theme.css
Original file line number Diff line number Diff line change
Expand Up @@ -429,14 +429,14 @@ textarea:focus, input[type="email"]:focus, input[type="number"]:focus, input[typ
#chapter h3 {
font-family: "Work Sans", "Helvetica", "Tahoma", "Geneva", "Arial", sans-serif;
font-weight: 300;
text-align: center;
text-align: left;
}
#chapter h1 {
font-size: 5rem;
border-bottom: 4px solid #F0F2F4;
}
#chapter p {
text-align: center;
text-align: left;
font-size: 1.2rem;
}
#footer {
Expand All @@ -462,7 +462,7 @@ h2, h3, h4, h5, h6 {
}
h1 {
font-family: "Novacento Sans Wide", "Helvetica", "Tahoma", "Geneva", "Arial", sans-serif;
text-align: center;
text-align: left;
text-transform: uppercase;
color: #222;
font-weight: 200;
Expand Down
15 changes: 15 additions & 0 deletions spec/trees/Vehicle/Trailer/Cargo/BoxCargo.vspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Copyright (c) 2016 Contributors to COVESA
#
# This program and the accompanying materials are made available under the
# terms of the Mozilla Public License 2.0 which is available at
# https://www.mozilla.org/en-US/MPL/2.0/
#
# SPDX-License-Identifier: MPL-2.0

#
# Box type trailer cargo signals and attributes
#

BoxCargo:
type: branch
description: Box type trailer.
22 changes: 22 additions & 0 deletions spec/trees/Vehicle/Trailer/Cargo/Cargo.vspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Copyright (c) 2016 Contributors to COVESA
#
# This program and the accompanying materials are made available under the
# terms of the Mozilla Public License 2.0 which is available at
# https://www.mozilla.org/en-US/MPL/2.0/
#
# SPDX-License-Identifier: MPL-2.0

#
# Trailer cargo signals and attributes
#

Cargo:
type: branch
description: Trailer cargo types.

VariationPoint: #CargoType
- BOXCARGO #include BoxCargo.vspec Cargo
- FLATBEDCARGO #include FlatbedCargo.vspec Cargo
- TANKERCARGO #include TankerCargo.vspec Cargo
- FREEZERCARGO #include FreezerCargo.vspec Cargo
- SPECIALIZEDCARGO #include SpecializedCargo.vspec Cargo
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
# SPDX-License-Identifier: MPL-2.0

#
# Flatbed truck cargo signals and attributes
# Flatbed trailer type cargo signals and attributes
#

FlatbedCargo:
type: branch
description: Flatbed truck cargo signals.
description: Flatbed trailer type.
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
# SPDX-License-Identifier: MPL-2.0

#
# Freezer truck cargo signals and attributes
# Freezer trailer type cargo signals and attributes
#

FreezerCargo:
type: branch
description: Freezer truck cargo signals.
description: Freezer trailer type.
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
# SPDX-License-Identifier: MPL-2.0

#
# Specialized truck cargo signals and attributes
# Specialized trailr type cargo signals and attributes
#

SpecializedCargo:
type: branch
description: Specialized truck cargo signals.
description: Specialized trailer type.
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
# SPDX-License-Identifier: MPL-2.0

#
# Tanker truck cargo signals and attributes
# Tanker trailer type cargo signals and attributes
#

TankerCargo:
type: branch
description: Tanker truck cargo signals.
description: Tanker trailer type.
9 changes: 5 additions & 4 deletions spec/trees/Vehicle/Trailer/TrailerSignalSpecification.vspec
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,11 @@ Trailer:
#include Chassis/Chassis.vspec Trailer

VariationPoint: #TrailerCargoType
- FLATBED #include Body/Flatbed/FlatbedCargo.vspec Trailer
- TANKER #include Body/Tanker/TankerCargo.vspec Trailer
- FREEZER #include Body/Freezer/FreezerCargo.vspec Trailer
- SPECIALIZED #include Body/Specialized/SpecializedCargo.vspec Trailer
- BOXCARGO #include Cargo/BoxCargo.vspec Trailer
- FLATBEDCARGO #include Cargo/FlatbedCargo.vspec Trailer
- TANKERCARGO #include Cargo/TankerCargo.vspec Trailer
- FREEZERCARGO #include Cargo/FreezerCargo.vspec Trailer
- SPECIALIZEDCARGO #include Cargo/SpecializedCargo.vspec Trailer

##include Exterior/Exterior.vspec Trailer

3 changes: 3 additions & 0 deletions spec/trees/Vehicle/Trailer/Variability.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
{
"FLATBED": "FLATBED"
},
{
"BOX": "BOX"
},
{
"TANKER": "TANKER"
},
Expand Down
4 changes: 2 additions & 2 deletions spec/trees/Vehicle/Truck/Cargo/Boxtruck.vspec
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@
# Boxtruck cargo signals and attributes
#

Boxtruck:
BoxTruck:
type: branch
description: Boxtruck cargo signals.
description: Box truck type cargo.
3 changes: 2 additions & 1 deletion spec/trees/Vehicle/Truck/Cargo/Cargo.vspec
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ Cargo:
description: Truck cargo signals.

VariationPoint: #CargoType
- BOXTRUCK #include Boxtruck.vspec Cargo
- TOWTRUCK #include TowTruck.vspec Cargo
- BOXTRUCK #include Boxtruck.vspec Cargo
- FLATBEDTRUCK #include FlatbedTruck.vspec Cargo
- VAN #include Van.vspec Cargo
- PICKUP #include Pickup.vspec Cargo
15 changes: 15 additions & 0 deletions spec/trees/Vehicle/Truck/Cargo/Flatbedtruck.vspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Copyright (c) 2016 Contributors to COVESA
#
# This program and the accompanying materials are made available under the
# terms of the Mozilla Public License 2.0 which is available at
# https://www.mozilla.org/en-US/MPL/2.0/
#
# SPDX-License-Identifier: MPL-2.0

#
# Flatbed truck cargo signals and attributes
#

FlatbedTruck:
type: branch
description: Flatbed truck cargo type.
3 changes: 3 additions & 0 deletions spec/trees/Vehicle/Truck/Variability.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
{
"BOXTRUCK": "BOXTRUCK"
},
{
"FLATBEDTRUCK": "FLATBEDTRUCK"
},
{
"PICKUP": "PICKUP"
},
Expand Down