From 12a485e250bff9224a098380d868f04e02dc50c2 Mon Sep 17 00:00:00 2001 From: jdacoello <8550265+jdacoello@users.noreply.github.com> Date: Fri, 10 Feb 2023 10:27:12 +0100 Subject: [PATCH] feat: Improve specification of interior lights. Add generic configurable light spec fix: Correct path feat: Add interactive light bar fix: Change Lights for Light (Singular) Remove obsolete files The release management picture is outdated and not used The structure.txt file does not provide much value Overlay documentation The documentation summarises idea and useage of overlays, as implemented in https://github.com/COVESA/vss-tools/pull/173 Detailed documentation of the CLI will be done in tools. This just serves as an overview and background. Signed-off-by: Daniel Wilms Removed private and fixed typos - removed private branch, as it's now handled by overlays - fixed typos. Signed-off-by: Daniel Wilms feat: Add data point Wheel.Speed Documentation of new keyword `instantiate` (#461) As discussed in #448 and implemented in https://github.com/COVESA/vss-tools/pull/168 it gives more flexibility in defining instances. Signed-off-by: Daniel Wilms Updated logo and color theme (#470) * added the new logo * updated color theme to blue Signed-off-by: Daniel Wilms Add tar-file command to Makefile (#469) Also remove obsolete deploy command and update gitignore Prepare master branch for 3.0 release (#471) Update version to 3.1-develop (#472) Fix link to checklist (#474) Update dds tool Include graphql fix Added vector files of logo Fixes: #451 Signed-off-by: Daniel Wilms Restructured exterior lights to make use of instances. Enables to add addtional values per light. As example an error indicator added Added a flag to indicate defects added further structuring of lights. added files for different types of exterior lights Reduced number of files Feedback integrated: Comments end with '.' and file are renamed Added lights for license-plate and break-lights Changed Break to Brake and fixed wrong filenames. Naming changes due to feedback header updated deleted istances for brake and licence-plates Added changes from comment of erikbosch changed from HasDefect to IsDefect in all new files Buildcheck update Signed-off-by: Erik Jaegervall Add low voltage battery signals Signed-off-by: Erik Jaegervall Improve trunk/hood documentation (#480) Signed-off-by: Erik Jaegervall Signed-off-by: Erik Jaegervall Remove obsolete sensor/actuator properties They have never been used and are not supported in tools. Better to reintroduce them if/when we in VSS specifies recommended additional properties for e.g. security purposes or protocol adoptions. Also improving documentation based on PR review. Fixes #302 Signed-off-by: Erik Jaegervall Improve seat tilt documentation A small error was detected - when tilt is 0 seat is not parallel to X-axis, it is rather seating (seat bottom) that is parallel to Z-axis. Also minor rephrasing. Signed-off-by: Erik Jaegervall Remove pipenv parameter sequential (#496) This parameter was added to solve buildproblems some time ago. But now it has been removed and thus must be removed from our code as well Changed in pipenv v2022.9.20 https://github.com/pypa/pipenv/commit/a38d1538c5fc4a45c95c67452730eec887f0fea5 Extend motorbike profile and include profiles in builds (#487) This PR contains some signals relevant to motorbikes. Some of them might be of general interest and may be moved to "standard vss" later. Signed-off-by: Erik Jaegervall Signed-off-by: Erik Jaegervall Update vss-tools to latest version (#492) Prepare move of vspec2c and vspec2ocf to obsolete (#494) Signed-off-by: Erik Jaegervall Signed-off-by: Erik Jaegervall Enable proper search in generated documentation Previously we did not generate the JSON index required. Also bumping hugo version. Local test succesfull. Signed-off-by: Erik Jaegervall Adapt overlay documentation to implicit branches Signed-off-by: Erik Jaegervall Extend governance and changelog information Signed-off-by: Erik Jaegervall Add tire pressure unit to HMI (#501) * Add tire pressure unit to HMI - It needs to add tire pressure unit to HMI branch because there are three different units related with tire pressure in usual. * Fix syntax error - add ':' into the end of "HMI.TirePressureUnit" * Replace allowed value strings with upper case - Replace allowed value strings with upper case Add PlaybackSpeed into Media.Played (#499) * Add PlaybackSpeed into Media.Played - It needs to add Playback Speed into Media.Played branch because it's important feature to change playback speed on some media services as audio book, youtube video * the restrictions of PlaybackSpeed the restrictions of PlaybackSpeed * Additional descriptions for meaning of the values Add text below for better understanding. comment: 1 means normal speed. <1 means slower playback than normal. >1 means faster playback than normal. * Revised with the meeting result - Aligned work with https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/playbackRate Add mute of navigation branch It is required to add date property for navigation mute. reivsed with all uppper case string Add volume property to Navigation branch (#504) * Add volume property to Navigation branch It need to have a volume property of Navigation to control the navigation guidance volume. * add unit: percent - Added unit: percent to Navigation.Volume and Media.Volume Add SmartphoneMirroring into HMI branch (#500) * Add SmartphoneMirroring into HMI branch It is required to support SmartphoneMirroring into HMI branch. Mirroring service such as AndroidAuto, AppleCarplay, and MirrorLink are broadly used in recent HMI system in the vehicle. The connectivity information for smart device such as android or iOS based phone or tablet is required for VSS. * Resolving the syntax error * Update for resolving comments * Update of naming and allowed values for projection * Reflect the comments from Erik Add HMI signals (#512) Adds two HMI-related signals existing in Android HAL but not existing in VSS FUEL_VOLUME_DISPLAY_UNITS DISPLAY_BRIGHTNESS Fix quotes for TirePressureUnit Add light switches VSS as of today has individual signals controlling/reporting if lights are on, but it does not have any signals representing the controls typically available to the driver. Signed-off-by: Erik Jaegervall Update _index.md Fixed format error in Governance page. Refactor Current Trip signals (#509) * Refactor Current Trip signals * Refactoring based on review comments Use explicit VSS units Add steering angle This adds steering angle for road wheels. Signed-off-by: Erik Jaegervall Add Power Optimize concept This is a power optimization concept based on discussions in the COVESA power optimization project Signed-off-by: Erik Jaegervall Minor editorial change Replaces https://github.com/COVESA/vehicle_signal_specification/pull/529 Signed-off-by: Erik Jaegervall Revert "Update by pulling changes from COVESA VSS master" (#2) * Revert "Minor editorial change" This reverts commit 13a32313e75c2546fb0090761df255f9669f49a7. * Revert "Add Power Optimize concept" This reverts commit 750c4fa992d48a59e4c4eefab0d965985bdadd23. * Revert "Add steering angle" This reverts commit cfbcaffc1637896d800c38983ef36ad7a8e069aa. * Revert "Use explicit VSS units" This reverts commit 64cbe3ac9bd64c382ec794abff7dc4c2340722a9. * Revert "Refactor Current Trip signals (#509)" This reverts commit 503ef90db8b0e7572ed99a7aacb3ce64c861b174. * Revert "Update _index.md" This reverts commit 2431461aaeafef22987071edae689a29744de4c8. * Revert "Add light switches" This reverts commit f19285d2f82789790eb2a3bdb72a9b86e8e5c1d7. * Revert "Fix quotes for TirePressureUnit" This reverts commit fce40fe4134aabecae14563e7f94065485519d79. * Revert "Add HMI signals (#512)" This reverts commit 9680e49b00962748636f6135b348955768ea04f3. * Revert "Add SmartphoneMirroring into HMI branch (#500)" This reverts commit b383c7d4a53bf5900057d870746899c3b0c635fe. * Revert "Add volume property to Navigation branch (#504)" This reverts commit 141b6adefdaf095290fc1b3dee84bb5072f59615. * Revert "reivsed with all uppper case string" This reverts commit 834753b9770addae8d052a8653293a15e2cdb0fc. * Revert "Add mute of navigation branch" This reverts commit ff3ad3484fc84194ffc02757fb3013e48f7d94dd. * Revert "Add PlaybackSpeed into Media.Played (#499)" This reverts commit 65cf0befe6f23edbea1768eec660ec4ddfacb9e7. * Revert "Add tire pressure unit to HMI (#501)" This reverts commit d198cc2fbccd417b1bce0748f67a4972cc57e3bf. * Revert "Extend governance and changelog information" This reverts commit 027efa8d99150f1ad52e7351f2596e6830385855. * Revert "Adapt overlay documentation to implicit branches" This reverts commit fcb9c5cb1fc69db233db859b2cee19faa035912a. * Revert "Enable proper search in generated documentation" This reverts commit 3d0da592b940cb07cbed7bf8ce191cd6d6b12e41. * Revert "Prepare move of vspec2c and vspec2ocf to obsolete (#494)" This reverts commit 73b8e27a208a022e3232a065f4ac724b5423e2ad. * Revert "Update vss-tools to latest version (#492)" This reverts commit 871503cf416686909bac69183ee3fda5265c2272. * Revert "Extend motorbike profile and include profiles in builds (#487)" This reverts commit 3d664060c3a61b746b1f2d4a78a61bbefd4ea179. * Revert "Remove pipenv parameter sequential (#496)" This reverts commit 47c72cd7499f271916a93daa833d08909fed8bd7. * Revert "Improve seat tilt documentation" This reverts commit dc92ba75cca15eb5b73e0f25c365be24bbca56bc. * Revert "Remove obsolete sensor/actuator properties" This reverts commit 1cb32456a64dd8e2bcd4a8fd74a61c53b993aa38. * Revert "Improve trunk/hood documentation (#480)" This reverts commit 354b43bd3fdf2f7a2bda885d979750e9a4f27b3d. * Revert "Add low voltage battery signals" This reverts commit 0a2786ceb649251e3d4be96afed9fa2b25d2b25b. * Revert "Buildcheck update" This reverts commit d76de941619cfe10fda0a9510906b8786cf40778. * Revert "changed from HasDefect to IsDefect in all new files" This reverts commit 4d874c876eadca2118856e00294be7b7b9c234b6. * Revert "Added changes from comment of erikbosch" This reverts commit ca7b84ecd71beb4dca6656bf32b55b465bb35614. * Revert "deleted istances for brake and licence-plates" This reverts commit 1f1a67ad52ebcad123ff278fc04b67b5fa2ccf6f. * Revert "header updated" This reverts commit a10785ea0b46ac6f09e839b86670988fac21cfe3. * Revert "Naming changes due to feedback" This reverts commit 50ba98fd93ffccffdc220a522907f27f6c354e6b. * Revert "Changed Break to Brake and fixed wrong filenames." This reverts commit 3103ea3a09065425f0f025497d64de10c3216ddd. * Revert "Added lights for license-plate and break-lights" This reverts commit 6a6a17a0e9b42a86c11c1803b7f788ee61861b9c. * Revert "Feedback integrated: Comments end with '.' and file are renamed" This reverts commit 6a38da85f05221aa9165ebd38571efb694a38646. * Revert "Reduced number of files" This reverts commit b20f522720644dcf27acf04cc19f0bc481146159. * Revert "added files for different types of exterior lights" This reverts commit ee184b40d3d5ed50bcf0dbde559cdfa31ba2e803. * Revert "added further structuring of lights." This reverts commit 1aacf35a77fa9469bb5265258a0b922b8bf2f6a6. * Revert "Added a flag to indicate defects" This reverts commit 9c146499021fbbaeafa6fc157edcc6adcc3a7661. * Revert "Restructured exterior lights to make use of instances. Enables to add addtional values per light. As example an error indicator added" This reverts commit a3798e6dc8880d1a2a5fc46929068f8036a21113. * Revert "Added vector files of logo" This reverts commit f8f18202cca49acba2ec7eb1931c6b02cb326f20. * Revert "Include graphql fix" This reverts commit e02d8d3687a80fbc62116a83a60db6c6cc45a317. * Revert "Update dds tool" This reverts commit 7a51868f3f6f1418b2294965800c0cf62e2e3136. * Revert "Fix link to checklist (#474)" This reverts commit 162e893431bed4f271b15bf66e8e85f1d2ee745c. * Revert "Update version to 3.1-develop (#472)" This reverts commit 278c0ee86ae5d9391591b657fc88105418b963f0. * Revert "Prepare master branch for 3.0 release (#471)" This reverts commit 2e03275bcfde13c82bb33cc56a12c27cb295d428. * Revert "Add tar-file command to Makefile (#469)" This reverts commit a84b536723c3ec6847a730ea347d96600d74a647. * Revert "Updated logo and color theme (#470)" This reverts commit db6f32b9138743f8253b76988b83d826f4453dc6. * Revert "Documentation of new keyword `instantiate` (#461)" This reverts commit dc35859d283fdfbd085c75cda2b9cd476dfad67e. * Revert "feat: Add data point Wheel.Speed" This reverts commit 93119b0fb980c19d87936b26e0c4a2cfc0ec7e3a. * Revert "Removed private and fixed typos" This reverts commit 4c9cef3ee5820581c654267c5a1c3edf454c5c29. * Revert "Overlay documentation" This reverts commit 14dc4e465809e026f58b916a24ed52c1b20d9b77. * Revert "Remove obsolete files" This reverts commit da4eb08f3a0490d03611acab96c9bfa4a82f13a2. fix: Address PR comments Minor editorial change Replaces https://github.com/COVESA/vehicle_signal_specification/pull/529 Signed-off-by: Erik Jaegervall fix: Remove # from definition Fix: Remove example allowed values from InteractiveLightBar.Effect and add info to the comment field fix: Change to DriverSide and PassengerSide --- docs-gen/content/rule_set/basics.md | 4 +- spec/Body/Body.vspec | 8 ++++ spec/Cabin/Cabin.vspec | 8 ++-- spec/Cabin/InteriorLights.vspec | 55 ++++++++++++------------ spec/Cabin/SingleConfigurableLight.vspec | 30 +++++++++++++ 5 files changed, 72 insertions(+), 33 deletions(-) create mode 100644 spec/Cabin/SingleConfigurableLight.vspec diff --git a/docs-gen/content/rule_set/basics.md b/docs-gen/content/rule_set/basics.md index 3ce400e79..faf1f4f3f 100644 --- a/docs-gen/content/rule_set/basics.md +++ b/docs-gen/content/rule_set/basics.md @@ -13,7 +13,9 @@ Please note that, from a YAML perspective, the include directive is just another The file [VehicleSignalSpecification.vspec](https://github.com/COVESA/vehicle_signal_specification/blob/master/spec/VehicleSignalSpecification.vspec) serves as root and includes other *vspec* files from the [VSS repository](https://github.com/COVESA/vehicle_signal_specification). -The raw specification files can with help of tools in the [vss-tools repository](https://github.com/COVESA/vss-tools) be converted to other formats that are more user friendly to read. Converted representations are also included as release artifacts for each [VSS release](https://github.com/COVESA/vehicle_signal_specification/releases). +The raw specification files can, with help of tools in the [vss-tools repository](https://github.com/COVESA/vss-tools), +be converted to other formats that are more user friendly to read. +Converted representations are also included as release artifacts for each [VSS release](https://github.com/COVESA/vehicle_signal_specification/releases). ## Addressing Nodes diff --git a/spec/Body/Body.vspec b/spec/Body/Body.vspec index fe01ee856..bf0be46ec 100644 --- a/spec/Body/Body.vspec +++ b/spec/Body/Body.vspec @@ -1,4 +1,5 @@ # +# (C) 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) # (C) 2018 Volvo Cars # (C) 2016 Jaguar Land Rover # @@ -58,6 +59,12 @@ Trunk.IsLocked: type: actuator description: Is trunk locked or unlocked. True = Locked. False = Unlocked. +Trunk.IsLightOn: + datatype: boolean + type: actuator + description: Is trunk light on + comment: V4.0 Moved from Vehicle.Cabin.Lights.IsTrunkOn because Trunk is not defined as part of the Cabin. + # # Horn description @@ -224,6 +231,7 @@ Lights.LicensePlate: Lights.Brake: type: branch + description: Brake lights. #include BrakeLights.vspec Lights.Brake Lights.Hazard: diff --git a/spec/Cabin/Cabin.vspec b/spec/Cabin/Cabin.vspec index 846307f40..e7ee86eaa 100644 --- a/spec/Cabin/Cabin.vspec +++ b/spec/Cabin/Cabin.vspec @@ -86,12 +86,12 @@ RearviewMirror.DimmingLevel: ## # Interior lights signals and sensors ## -Lights: +Light: type: branch - description: Interior lights signals and sensors. + description: Light that is part of the Cabin. + comment: V4.0 branch renamed from "Lights" to "Light" to comply with singular naming of entities. Use SingleConfigurableLight.vspec to describe interior lights that can be configured. +#include InteriorLights.vspec Light -# Include the lights specification and attach it under the Lights branch.x -#include InteriorLights.vspec Lights ## # Door signals and attributes diff --git a/spec/Cabin/InteriorLights.vspec b/spec/Cabin/InteriorLights.vspec index f989c5954..bf0b1bb2f 100644 --- a/spec/Cabin/InteriorLights.vspec +++ b/spec/Cabin/InteriorLights.vspec @@ -1,4 +1,5 @@ # +# (C) 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) # (C) 2018 Volvo Cars # (C) 2016 Jaguar Land Rover # @@ -10,57 +11,55 @@ # All interior lights and sensors # +# +# Non-configurable lights +# IsGloveBoxOn: datatype: boolean type: actuator description: Is glove box light on -IsTrunkOn: - datatype: boolean - type: actuator - description: Is trunk light light on - IsDomeOn: datatype: boolean type: actuator description: Is central dome light light on -AmbientLight: - datatype: uint8 - type: sensor - unit: percent - min: 0 - max: 100 - description: How much ambient light is detected in cabin. 0 = No ambient light. 100 = Full brightness - -LightIntensity: +PerceivedAmbientLight: datatype: uint8 type: sensor unit: percent min: 0 max: 100 - description: Intensity of the interior lights. 0 = Off. 100 = Full brightness. + description: The percentage of ambient light that is measured (e.g., by a sensor) inside the cabin. 0 = No ambient light. 100 = Full brightness. + comment: V4.0 named changed from "AmbientLight" to "PerceivedAmbientLight". This is a read-only property that refers to the pre-existing light (e.g., natural light). If you are looking for the in-cabin decorative lights that sometimes are also called "AmbientLights", please refer to the branch Vehicle.Cabin.Light.AmbientLight. # -# First / front row lights +# Configurable lights # Spotlight: type: branch - instances: Row[1,4] + instances: + - Row[1,2] + - ["Driver","Passenger"] description: Spotlight for a specific area in the vehicle. +#include SingleConfigurableLight.vspec Spotlight -Spotlight.IsSharedOn: - datatype: boolean - type: sensor - description: Is a shared light across a specific row on -Spotlight.IsLeftOn: - datatype: boolean - type: actuator - description: Is light on the left side switched on +AmbientLight: + type: branch + instances: + - Row[1,2] + - ["DriverSide","PassengerSide"] + description: Decorative coloured light inside the cabin, usually mounted on the door, cealing, etc. +#include SingleConfigurableLight.vspec AmbientLight +InteractiveLightBar: + type: branch + description: Decorative coloured light bar that supports effects. It is usually mounted on the dashboard (e.g., BMW i7 Interactive bar). +#include SingleConfigurableLight.vspec InteractiveLightBar -Spotlight.IsRightOn: - datatype: boolean +InteractiveLightBar.Effect: type: actuator - description: Is light on the right side switched on + datatype: string + description: Light effect selection from a predefined set of allowed values. + comment: Default and allowed values are OEM-specific and should be defined accordingly (e.g., with the use of overlays). diff --git a/spec/Cabin/SingleConfigurableLight.vspec b/spec/Cabin/SingleConfigurableLight.vspec new file mode 100644 index 000000000..9adb864d6 --- /dev/null +++ b/spec/Cabin/SingleConfigurableLight.vspec @@ -0,0 +1,30 @@ +# +# (C) 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +# +# All files and artifacts in this repository are licensed under the +# provisions of the license provided by the LICENSE file in this repository. +# + +# +# Generic specification for a light whose color and brightness can be configured. +# + +IsLightOn: + type: actuator + datatype: boolean + description: Indicates whether the light is turned on. True = On, False = Off. + +Intensity: + type: actuator + datatype: uint8 + unit: percent + min: 1 + max: 100 + description: How much of the maximum possible brightness of the light is used. 1 = Maximum attenuation, 100 = no attenuation (i.e., full brightness). + comment: Minimum value cannot be zero as on/off is controlled by the actuator IsLightOn. V4.0 moved from Cabin.Lights.AmbientLight.Intensity to enable individual control of lights via the SingleConfigurableLight.vspec. + +Color: + type: actuator + datatype: string + description: Hexadecimal color code represented as a 3-byte RGB (i.e., Red, Green, and Blue) value preceded by a hash symbol "#". Allowed range "#000000" to "#FFFFFF". + comment: For example; "#C0C0C0" = Silver, "#FFD700" = Gold, "#000000" = Black, "#FFFFFF" = White, etc. \ No newline at end of file