From fda135ae68559bc2d44c8cbc6a70157481a2c1ee Mon Sep 17 00:00:00 2001 From: Benjamin Morgan Date: Mon, 15 Jul 2024 12:43:50 +0200 Subject: [PATCH] docs: Update documentation for 0.25.0 release --- cli/pyproject.toml | 2 +- docs/changelog.rst | 65 +++++ docs/contributing/creating-a-new-release.rst | 2 +- docs/news.rst | 22 ++ docs/news/release-0.25.0.md | 222 ++++++++++++++++++ docs/reference/plugins/basic.yaml | 2 +- docs/reference/plugins/basic_schema.json | 2 +- docs/reference/plugins/clothoid_fit.yaml | 2 +- .../plugins/clothoid_fit_schema.json | 2 +- docs/reference/plugins/demo_printer.yaml | 2 +- .../plugins/demo_printer_schema.json | 2 +- docs/reference/plugins/demo_stuck.yaml | 2 +- docs/reference/plugins/demo_stuck_schema.json | 2 +- docs/reference/plugins/esmini.rst | 1 + docs/reference/plugins/esmini.yaml | 2 +- docs/reference/plugins/esmini_schema.json | 2 +- .../plugins/frustum_culling_lanes.yaml | 2 +- .../plugins/frustum_culling_lanes_schema.json | 2 +- .../plugins/frustum_culling_objects.yaml | 2 +- .../frustum_culling_objects_schema.json | 2 +- .../reference/plugins/gndtruth_extractor.yaml | 2 +- .../plugins/gndtruth_extractor_schema.json | 2 +- docs/reference/plugins/minimator.yaml | 2 +- docs/reference/plugins/minimator_schema.json | 2 +- docs/reference/plugins/noisy_lane_sensor.yaml | 2 +- .../plugins/noisy_lane_sensor_schema.json | 2 +- .../plugins/noisy_object_sensor.yaml | 2 +- .../plugins/noisy_object_sensor_schema.json | 2 +- docs/reference/plugins/speedometer.yaml | 2 +- .../reference/plugins/speedometer_schema.json | 2 +- docs/reference/plugins/virtue.yaml | 2 +- docs/reference/plugins/virtue_schema.json | 2 +- docs/reference/plugins/vtd.rst | 1 + engine/src/main_usage.cpp | 10 + ui/package.json | 2 +- ui/server/package.json | 2 +- 36 files changed, 351 insertions(+), 30 deletions(-) create mode 100644 docs/news/release-0.25.0.md diff --git a/cli/pyproject.toml b/cli/pyproject.toml index d96ec744e..b016acb95 100644 --- a/cli/pyproject.toml +++ b/cli/pyproject.toml @@ -6,7 +6,7 @@ [project] name = "cloe-launch" -version = "0.24.0" +version = "0.25.0" description = "Launch cloe-engine with Conan profiles." license = { text = "Apache-2.0" } authors = [ diff --git a/docs/changelog.rst b/docs/changelog.rst index b8eb6229f..2554fc653 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -58,6 +58,71 @@ readable perspective on new releases. Note that the most recent release is at the *top* of the document. + +0.25.0 (2024-07-15) +------------------- + +This is the first Cloe release that contains the Lua and DataBroker integration. +Read all about the changes :doc:`here `. + +**Engine:** + +- engine: Make probe output trigger schema `[6c6c71cb] `_ +- engine: Add probe subcommand `[4be46cb1] `_ +- engine: Fix some findings from clang-tidy `[58382a67] `_ +- engine: Add --output-path to cloe-engine `[4fc65ac9] `_ +- engine: Replace boost::filesystem with std::filesystem `[71844110] `_ +- engine: Replace boost::optional with std::optional `[8b0acb2f] `_ +- engine: Add LRDB debugging support `[c60a3ef9] `_ +- engine: Add Lua scripting support `[d182d035] `_ +- engine: Vendor linenoise library `[12fb330c] `_ +- engine: Restructure code for better compilation times `[a1137367] `_ +- engine: Extract SimulationProgress into simulation_progress.hpp `[30b05f5f] `_ +- engine: Set stack options in own scope `[5e3d4efe] `_ +- engine: Remove --distinct option from check command `[fa7d2586] `_ +- tests: Add test for cloe-engine --write-output and --output-path `[d9fcd704] `_ + +**Core Libraries:** + +- all: Improve DataBroker interface for common types `[0d9509cc] `_ +- all: Add DataBroker and Signals concepts `[34fcf16d] `_ + +- fable: Implement clang-tidy suggestions `[3f017f36] `_ + +- runtime: Fix duplicate definitions in set_action.hpp `[1cf804f6] `_ +- runtime: Replace boost::filesystem with std::filesystem `[aec4bce1] `_ +- runtime: Add CallbackResult return value to all action operator() `[51f3c0ae] `_ + +- stack: Refactor stack into its own library `[55dc93e5] `_ + +- osi: Fix compatiblity with protobuf > v25 `[3b7bf9d7] `_ + +**Plugins:** + +- basic: Replace boost::optional with std::optional `[e59a6360] `_ + +- speedometer: Implement data broker `[a29afa6a] `_ + +- mocks: Add delay action to demo_stuck `[984fda42] `_ + +**Tooling & Dependencies:** + +- tests: Add (disabled) test combining cloe with external package `[e401c0f7] `_ + +- ci: Reduce number of jobs run for branches `[906a6a21] `_ +- ci: Enable Github workflows for important branches `[dbfefddd] `_ + +- tooling: Add Bazel support `[73d24a43] `_ +- tooling: Disable dependabot for the UI `[c22e9d74] `_ +- tooling: Improve grep-uuids to better show duplicates `[e58c48fe] `_ +- tooling: Add VS Code project configuration `[6c03bd5f] `_ +- tooling: Update deploy-all to simply call cloe-launch deploy `[29eed02f] `_ +- tooling: Fix interspersed $() and ${} in Makefiles `[a2494825] `_ +- tooling: Move tests into project root tests directory `[1a9436dd] `_ +- tooling: Make cloe a super-build of all packages `[65a4aef8] `_ + +- vendor/open-simulation-interface: Add full_package_mode `[d5f33148] `_ + 0.24.0 (2024-05-06) ------------------- diff --git a/docs/contributing/creating-a-new-release.rst b/docs/contributing/creating-a-new-release.rst index 1b006bb56..4a0f0fb65 100644 --- a/docs/contributing/creating-a-new-release.rst +++ b/docs/contributing/creating-a-new-release.rst @@ -72,7 +72,7 @@ Run ``conan search`` to check that your cache only has the expected packages. Then, compile the entire project locally:: - make purge-all export-vendor export smoketest-deps smoketest + make purge-all export-cli export-vendor export-all smoketest-deps smoketest This should run through without errors. Then make sure to do the same with the optional packages:: diff --git a/docs/news.rst b/docs/news.rst index 1544188ae..ca6f2577f 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -23,6 +23,7 @@ News :hidden: :maxdepth: 1 + news/release-0.25.0 news/release-0.24.0 news/release-0.23.0 news/release-0.22.0 @@ -30,6 +31,27 @@ News news/release-0.20.0 news/release-0.19.0 +:doc:`Version 0.25.0 Release ` +--------------------------------------------------- + +This release contains the initial implementation of Lua support with the new +DataBroker and Signals concept. + +- New command ``shell`` for cloe-engine allows running Lua scripts and/or + provides an interactive shell prompt (similar to the ``lua`` command). +- New command ``probe`` for cloe-engine dumps available triggers, signals, and + other metadata for a simulation without running the simulation in its entirety. + +The Cloe build has been streamlined and simplified: + +- Discontinue `cloe` meta-package. It was not possible to continue using this + with Conan 1 due to technical limitations. + (The `conanfile.py` in the repo root is now a superbuild of cloe for + development purposes only.) +- Move tests from various sub-directories into a single unified tests directory. +- Add experimental Bazel build tooling configuration. + +Read more about these changes and more :doc:`here `. :doc:`Version 0.24.0 Release ` --------------------------------------------------- diff --git a/docs/news/release-0.25.0.md b/docs/news/release-0.25.0.md new file mode 100644 index 000000000..5099acb1a --- /dev/null +++ b/docs/news/release-0.25.0.md @@ -0,0 +1,222 @@ +# Version 0.25.0 Release + +This release contains the initial implementation of Lua support with the new +DataBroker and Signals concept. + +## Add Lua support + +Lua is a lightweight embedded language that can now be used to define simulation +configuration and test execution and evaluation. + +For example: + +```lua +cloe = require("cloe") +proj = require("project") +cloe.load_stackfile("existing_configuration.json") +cloe.schedule_test { + id = "e03fc31f-586b-4e57-80fa-ff2cba5ff9dd", + on = events.start(), + run = function(test, sync) + cloe.log("info", "Entering test") + test:wait_duration("1s") + + -- Enable Cruise Control + proj.enable_hmi() + test:wait_duration("4s") + + -- Set speed and increase + local speed = cloe.signal(proj.Signals.VehicleSpeed).kmph() + proj.buttons.plus.push("1500ms") + test:wait_duration("4s") + + -- Check that new speed is higher than before but lower than + -- the speed-limit. + local new_speed = cloe.signal(proj.Signals.VehicleSpeed).kmph() + test:assert_gt(new_speed, speed) + test:assert_le(new_speed, proj.scenario.speed_limit) + test:succeed() + end +} +``` + +The above test-case is a hypothetical, yet realistic way that such a test can +be written. The results are written to an output file and the terminal output +in JSON format, so they can be easily processed. + +The engine comes with a new `shell` command, which allows you to launch an +interactive Lua session or just run Lua files. + +A simulation with or without Lua can be run as before with the `run` command. +The JSON stackfile interface is still supported and can be mixed with Lua. +In particular, all the features in the stackfiles can be now used from Lua +in a backwards-compatible way. Your existing test files do not need to be +rewritten, but you can achieve better results by adding Lua or switching +completely. + +See {doc}`the usage documentation <../usage/lua-introduction>` for more! + +## New probe sub-command + +The new `probe` sub-command of `cloe-engine` allows you to probe a simulation +configuration with merged stack files. + +In this mode, a simulation is set up and all the participants are connected, +probed, and then disconnected. That means: + +- the simulation must be fully configured, +- failures may occur during connection phase, and +- scripts included must be correct. + +The output of the probe is a JSON written to stdout: + +```json +{ + "http_endpoints": [ "/endpoints", ... ], + "plugins": { + "PLUGIN_NAME": "PLUGIN_PATH", + ... + }, + "signals": { + "SIGNAL_NAME": "DESCRIPTION", + ... + }, + "tests": { + } + "trigger_actions": [ "ACTION1", "..." ], + "trigger_events": [ "EVENT1", ... ], + "uuid": "UUID", + "vehicles": { + "NAME": [ "COMPONENT1", ... ] + } +} +``` + +The tests section is only defined if the simulation configuration +contains Lua that defines tests (via `cloe.schedule_test()` API). +You can use tools like `jq` to further filter and refine the output. + +Examples: + + cloe-engine probe tests/test_nop_smoketest.json + cloe-engine probe my_lua_test.lua | jq -r '.tests | keys | .[]' + +## Engine changes + +- Add `--output-path` option to ``run`` command. + + This allows you to specify where output files should be written without having + to configure it in the stackfile. + +- Remove `--distinct` flag from ``check`` command. + + It wasn't used much and complicated the code. This old behavior can be easily + achieved with outside tooling, such as `xargs` and `find`, so there is no loss + in functionality overall. + +## Tooling changes + +The `cloe` Conan package was previously a meta-package containing all packages +created from this repository. + +This package is being discontinued from this version of Cloe. +It was primarily meant for testing purposes, and thanks to new dependencies +in our project and the limitations of Conan 1, it no longer fulfills this role. + +**Migration:** +> If you have been using the `cloe` package as a first-level dependency, then +> you will need to specify all the packages individually that you need. +> +> It is highly recommended to split your build Conanfile from your deployment +> Conanfile. For your controller build Conanfile, you generally only need: +> +> def requirements(self): +> def cloe_requires(dep): +> self.requires(f"{dep}/0.25.0@cloe/develop") +> +> cloe_requires("cloe-runtime") +> cloe_requires("cloe-models") +> +> And for your deployment Conanfile you should only include the plugins you +> actually use: +> +> def requirements(self): +> def cloe_requires(dep): +> self.requires(f"{dep}/0.25.0@cloe/develop") +> +> cloe_requires("cloe-engine") +> cloe_requires("cloe-plugin-clothoid-fit") +> cloe_requires("cloe-plugin-frustum-culling") +> cloe_requires("cloe-plugin-gndtruth-extractor") +> cloe_requires("cloe-plugin-noisy-sensor") +> cloe_requires("cloe-plugin-esmini") +> self.requires("your-plugin") +> self.requires("esmini-data/2.37.4@cloe/stable") +> +> # Override as needed: +> self.requires("esmini/2.37.4@cloe/stable", override=True) +> self.requires("fmt/9.1.0", override=True) +> self.requires("inja/3.4.0", override=True) +> self.requires("nlohmann_json/3.11.3", override=True) +> self.requires("incbin/cci.20211107", override=True) +> self.requires("boost/1.74.0", override=True) +> self.requires("zlib/1.2.13", override=True) +> self.requires("protobuf/3.21.12", override=True) + +For developing Cloe, the root Conanfile is now a super-build of Cloe, which +provides a vastly simplified workflow for editing Cloe code: + + echo "0.26.0-nightly" > VERSION + make editable + +And then iterate changes and (re-)builds with + + make all + +This is a boon to development, as we make `cloe` editable and only have to work +with a single package. It also massively speeds up compilation: + +- Conan and CMake configuration is only performed once. +- All cores can now be utilized much more effectively during the build process. + +The main Makefile has been adjusted for this: + +- `status` is now `status-all` +- `deploy` is now `deploy-all` +- `clean` is now `clean-all` +- `purge` is now `purge-all` + +The following top-level Make targets just refer to `cloe` super-build package: + +- `package` +- `smoketest` +- `smoketest-deps` +- `status` +- `export` + +Finally, we moved all tests into project root tests directory. +We still support multiple profiles, but this makes it easier to support the +cloe super-build and should also make it easier to develop and maintain tests. + +## Bazel Build + +We have added experimental support for Bazel builds. Bazel is a promising +build system for enterprises, as it radically simplifies the build tooling +required. We have a single tool Bazel, instead of three or four layers of tools; +in our case: Make -> Conan -> CMake -> Make/Ninja. + +The `.bazelrc.user` file needs to be configured in order for certain third-party +modules to be found (see repository `README.md`) + +- `bazel build //...` builds everything in the project. +- `bazel test //...` runs all tests. +- `bazel run :cloe_shell` launches a shell wherein `cloe-engine` is available. + +Full feature parity with Conan is not yet achieved. For example, there is +no Bazel build for VTD or ESmini yet. Contributions are welcomed! :-) + +## Library changes + +At various places, `boost::optional` and `boost::filesystem` types and methods are +replaced by their C++17 counterparts. This makes our libraries more lightweight +by reducing their dependence on Boost. diff --git a/docs/reference/plugins/basic.yaml b/docs/reference/plugins/basic.yaml index 9c5af63a2..c0af2fd5a 100644 --- a/docs/reference/plugins/basic.yaml +++ b/docs/reference/plugins/basic.yaml @@ -1,6 +1,6 @@ Name: basic Type: controller -Path: ~/.conan/data/cloe-plugin-basic/0.24.0/cloe/develop/package/b604e04f9a20730e6de510c8305e28e783869866/lib/cloe/controller_basic.so +Path: ~/.conan/data/cloe-plugin-basic/0.25.0/cloe/develop/package/722452d8f3bfc1eef1fc5de534638769b66120b8/lib/cloe/controller_basic.so Usage: { "acc": "object :: ACC configuration", "aeb": "object :: AEB configuration", diff --git a/docs/reference/plugins/basic_schema.json b/docs/reference/plugins/basic_schema.json index 9db744f18..8b3f3927e 100644 --- a/docs/reference/plugins/basic_schema.json +++ b/docs/reference/plugins/basic_schema.json @@ -1,5 +1,5 @@ { - "$id": "~/.conan/data/cloe-plugin-basic/0.24.0/cloe/develop/package/b604e04f9a20730e6de510c8305e28e783869866/lib/cloe/controller_basic.so", + "$id": "~/.conan/data/cloe-plugin-basic/0.25.0/cloe/develop/package/722452d8f3bfc1eef1fc5de534638769b66120b8/lib/cloe/controller_basic.so", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "description": "very basic vehicle controller", diff --git a/docs/reference/plugins/clothoid_fit.yaml b/docs/reference/plugins/clothoid_fit.yaml index 15ac40e41..247c9aa36 100644 --- a/docs/reference/plugins/clothoid_fit.yaml +++ b/docs/reference/plugins/clothoid_fit.yaml @@ -1,6 +1,6 @@ Name: clothoid_fit Type: component -Path: ~/.conan/data/cloe-plugin-clothoid-fit/0.24.0/cloe/develop/package/8f9ac47c1ba762e10f909572a2501bc20131849f/lib/cloe/component_clothoid_fit.so +Path: ~/.conan/data/cloe-plugin-clothoid-fit/0.25.0/cloe/develop/package/8bbe28227abbfb1588c2b6b2f814b6f165c9c063/lib/cloe/component_clothoid_fit.so Usage: { "enable": "boolean :: enable or disable component", "frustum_culling": "boolean :: enable or disable frustum culling" diff --git a/docs/reference/plugins/clothoid_fit_schema.json b/docs/reference/plugins/clothoid_fit_schema.json index 5073ec430..7cf0997c0 100644 --- a/docs/reference/plugins/clothoid_fit_schema.json +++ b/docs/reference/plugins/clothoid_fit_schema.json @@ -1,5 +1,5 @@ { - "$id": "~/.conan/data/cloe-plugin-clothoid-fit/0.24.0/cloe/develop/package/8f9ac47c1ba762e10f909572a2501bc20131849f/lib/cloe/component_clothoid_fit.so", + "$id": "~/.conan/data/cloe-plugin-clothoid-fit/0.25.0/cloe/develop/package/8bbe28227abbfb1588c2b6b2f814b6f165c9c063/lib/cloe/component_clothoid_fit.so", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "description": "fit clothoids to polylines", diff --git a/docs/reference/plugins/demo_printer.yaml b/docs/reference/plugins/demo_printer.yaml index d7a889393..42ac2b9bc 100644 --- a/docs/reference/plugins/demo_printer.yaml +++ b/docs/reference/plugins/demo_printer.yaml @@ -1,5 +1,5 @@ Name: demo_printer Type: controller -Path: ~/.conan/data/cloe-plugin-mocks/0.24.0/cloe/develop/package/b604e04f9a20730e6de510c8305e28e783869866/lib/cloe/controller_demo_printer.so +Path: ~/.conan/data/cloe-plugin-mocks/0.25.0/cloe/develop/package/722452d8f3bfc1eef1fc5de534638769b66120b8/lib/cloe/controller_demo_printer.so Usage: null Defaults: {} diff --git a/docs/reference/plugins/demo_printer_schema.json b/docs/reference/plugins/demo_printer_schema.json index 446ce8100..e89664adb 100644 --- a/docs/reference/plugins/demo_printer_schema.json +++ b/docs/reference/plugins/demo_printer_schema.json @@ -1,5 +1,5 @@ { - "$id": "~/.conan/data/cloe-plugin-mocks/0.24.0/cloe/develop/package/b604e04f9a20730e6de510c8305e28e783869866/lib/cloe/controller_demo_printer.so", + "$id": "~/.conan/data/cloe-plugin-mocks/0.25.0/cloe/develop/package/722452d8f3bfc1eef1fc5de534638769b66120b8/lib/cloe/controller_demo_printer.so", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "description": "print a lot of information", diff --git a/docs/reference/plugins/demo_stuck.yaml b/docs/reference/plugins/demo_stuck.yaml index 19bbdca6b..737cf2301 100644 --- a/docs/reference/plugins/demo_stuck.yaml +++ b/docs/reference/plugins/demo_stuck.yaml @@ -1,6 +1,6 @@ Name: demo_stuck Type: controller -Path: ~/.conan/data/cloe-plugin-mocks/0.24.0/cloe/develop/package/b604e04f9a20730e6de510c8305e28e783869866/lib/cloe/controller_demo_stuck.so +Path: ~/.conan/data/cloe-plugin-mocks/0.25.0/cloe/develop/package/722452d8f3bfc1eef1fc5de534638769b66120b8/lib/cloe/controller_demo_stuck.so Usage: { "halt_progress_at": "integer :: time in ns at which to halt all progress", "progress_per_step": "integer :: progress to make each step" diff --git a/docs/reference/plugins/demo_stuck_schema.json b/docs/reference/plugins/demo_stuck_schema.json index de0aa9d82..e9c5a68a0 100644 --- a/docs/reference/plugins/demo_stuck_schema.json +++ b/docs/reference/plugins/demo_stuck_schema.json @@ -1,5 +1,5 @@ { - "$id": "~/.conan/data/cloe-plugin-mocks/0.24.0/cloe/develop/package/b604e04f9a20730e6de510c8305e28e783869866/lib/cloe/controller_demo_stuck.so", + "$id": "~/.conan/data/cloe-plugin-mocks/0.25.0/cloe/develop/package/722452d8f3bfc1eef1fc5de534638769b66120b8/lib/cloe/controller_demo_stuck.so", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "description": "slowly progressing demo controller", diff --git a/docs/reference/plugins/esmini.rst b/docs/reference/plugins/esmini.rst index 7e46ed4ee..0b9f0bb32 100644 --- a/docs/reference/plugins/esmini.rst +++ b/docs/reference/plugins/esmini.rst @@ -1,4 +1,5 @@ .. reference-gen: esmini +.. conan-pkg: cloe-plugin-esmini ESMini Simulator ================ diff --git a/docs/reference/plugins/esmini.yaml b/docs/reference/plugins/esmini.yaml index deacbd382..f8235c380 100644 --- a/docs/reference/plugins/esmini.yaml +++ b/docs/reference/plugins/esmini.yaml @@ -1,6 +1,6 @@ Name: esmini Type: simulator -Path: ~/.conan/data/cloe-plugin-esmini/0.24.0/cloe/develop/package/d7a7554cbdefb6329d8ab091c6c8b1679c2bb1be/lib/cloe/simulator_esmini.so +Path: ~/.conan/data/cloe-plugin-esmini/0.25.0/cloe/develop/package/84ccb4ea840b4d87c205641ecb352be3b8054b58/lib/cloe/simulator_esmini.so Usage: { "headless": "boolean :: run esmini without viewer", "scenario": "string :: absolute path to open scenario file", diff --git a/docs/reference/plugins/esmini_schema.json b/docs/reference/plugins/esmini_schema.json index 2ca2e9faf..65a769bd9 100644 --- a/docs/reference/plugins/esmini_schema.json +++ b/docs/reference/plugins/esmini_schema.json @@ -1,5 +1,5 @@ { - "$id": "~/.conan/data/cloe-plugin-esmini/0.24.0/cloe/develop/package/d7a7554cbdefb6329d8ab091c6c8b1679c2bb1be/lib/cloe/simulator_esmini.so", + "$id": "~/.conan/data/cloe-plugin-esmini/0.25.0/cloe/develop/package/84ccb4ea840b4d87c205641ecb352be3b8054b58/lib/cloe/simulator_esmini.so", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "description": "basic OpenScenario player", diff --git a/docs/reference/plugins/frustum_culling_lanes.yaml b/docs/reference/plugins/frustum_culling_lanes.yaml index 3d428e151..d67019e50 100644 --- a/docs/reference/plugins/frustum_culling_lanes.yaml +++ b/docs/reference/plugins/frustum_culling_lanes.yaml @@ -1,6 +1,6 @@ Name: frustum_culling_lanes Type: component -Path: ~/.conan/data/cloe-plugin-frustum-culling/0.24.0/cloe/develop/package/7ecda101666cc57e74197e36a88beb3d4fdbf3be/lib/cloe/component_frustum_culling_lanes.so +Path: ~/.conan/data/cloe-plugin-frustum-culling/0.25.0/cloe/develop/package/91b5125cdd7bd55b869f186e62db770e4e0299fd/lib/cloe/component_frustum_culling_lanes.so Usage: { "frustum": "object! :: sensor frustum", "reference_frame": "object! :: sensor frame of reference" diff --git a/docs/reference/plugins/frustum_culling_lanes_schema.json b/docs/reference/plugins/frustum_culling_lanes_schema.json index 199b92ee8..8f8e20ff0 100644 --- a/docs/reference/plugins/frustum_culling_lanes_schema.json +++ b/docs/reference/plugins/frustum_culling_lanes_schema.json @@ -1,5 +1,5 @@ { - "$id": "~/.conan/data/cloe-plugin-frustum-culling/0.24.0/cloe/develop/package/7ecda101666cc57e74197e36a88beb3d4fdbf3be/lib/cloe/component_frustum_culling_lanes.so", + "$id": "~/.conan/data/cloe-plugin-frustum-culling/0.25.0/cloe/develop/package/91b5125cdd7bd55b869f186e62db770e4e0299fd/lib/cloe/component_frustum_culling_lanes.so", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "description": "transform lane boundaries to given reference frame and apply frustum culling", diff --git a/docs/reference/plugins/frustum_culling_objects.yaml b/docs/reference/plugins/frustum_culling_objects.yaml index efe56270d..a73c6d7a8 100644 --- a/docs/reference/plugins/frustum_culling_objects.yaml +++ b/docs/reference/plugins/frustum_culling_objects.yaml @@ -1,6 +1,6 @@ Name: frustum_culling_objects Type: component -Path: ~/.conan/data/cloe-plugin-frustum-culling/0.24.0/cloe/develop/package/7ecda101666cc57e74197e36a88beb3d4fdbf3be/lib/cloe/component_frustum_culling_objects.so +Path: ~/.conan/data/cloe-plugin-frustum-culling/0.25.0/cloe/develop/package/91b5125cdd7bd55b869f186e62db770e4e0299fd/lib/cloe/component_frustum_culling_objects.so Usage: { "frustum": "object! :: sensor frustum", "reference_frame": "object! :: sensor frame of reference" diff --git a/docs/reference/plugins/frustum_culling_objects_schema.json b/docs/reference/plugins/frustum_culling_objects_schema.json index a8def01d9..2e4757b29 100644 --- a/docs/reference/plugins/frustum_culling_objects_schema.json +++ b/docs/reference/plugins/frustum_culling_objects_schema.json @@ -1,5 +1,5 @@ { - "$id": "~/.conan/data/cloe-plugin-frustum-culling/0.24.0/cloe/develop/package/7ecda101666cc57e74197e36a88beb3d4fdbf3be/lib/cloe/component_frustum_culling_objects.so", + "$id": "~/.conan/data/cloe-plugin-frustum-culling/0.25.0/cloe/develop/package/91b5125cdd7bd55b869f186e62db770e4e0299fd/lib/cloe/component_frustum_culling_objects.so", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "description": "transform objects to given reference frame and apply frustum culling", diff --git a/docs/reference/plugins/gndtruth_extractor.yaml b/docs/reference/plugins/gndtruth_extractor.yaml index e85b60e60..3bb6bf9f6 100644 --- a/docs/reference/plugins/gndtruth_extractor.yaml +++ b/docs/reference/plugins/gndtruth_extractor.yaml @@ -1,6 +1,6 @@ Name: gndtruth_extractor Type: controller -Path: ~/.conan/data/cloe-plugin-gndtruth-extractor/0.24.0/cloe/develop/package/b604e04f9a20730e6de510c8305e28e783869866/lib/cloe/controller_gndtruth_extractor.so +Path: ~/.conan/data/cloe-plugin-gndtruth-extractor/0.25.0/cloe/develop/package/722452d8f3bfc1eef1fc5de534638769b66120b8/lib/cloe/controller_gndtruth_extractor.so Usage: { "components": "array of string :: array of components to be extracted", "output_file": "string :: file path to write groundtruth output to", diff --git a/docs/reference/plugins/gndtruth_extractor_schema.json b/docs/reference/plugins/gndtruth_extractor_schema.json index 02eced294..dd469203d 100644 --- a/docs/reference/plugins/gndtruth_extractor_schema.json +++ b/docs/reference/plugins/gndtruth_extractor_schema.json @@ -1,5 +1,5 @@ { - "$id": "~/.conan/data/cloe-plugin-gndtruth-extractor/0.24.0/cloe/develop/package/b604e04f9a20730e6de510c8305e28e783869866/lib/cloe/controller_gndtruth_extractor.so", + "$id": "~/.conan/data/cloe-plugin-gndtruth-extractor/0.25.0/cloe/develop/package/722452d8f3bfc1eef1fc5de534638769b66120b8/lib/cloe/controller_gndtruth_extractor.so", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "description": "extracts information from the simulation", diff --git a/docs/reference/plugins/minimator.yaml b/docs/reference/plugins/minimator.yaml index 23afa2a63..d5a7953a9 100644 --- a/docs/reference/plugins/minimator.yaml +++ b/docs/reference/plugins/minimator.yaml @@ -1,6 +1,6 @@ Name: minimator Type: simulator -Path: ~/.conan/data/cloe-plugin-minimator/0.24.0/cloe/develop/package/b604e04f9a20730e6de510c8305e28e783869866/lib/cloe/simulator_minimator.so +Path: ~/.conan/data/cloe-plugin-minimator/0.25.0/cloe/develop/package/722452d8f3bfc1eef1fc5de534638769b66120b8/lib/cloe/simulator_minimator.so Usage: { "vehicles": "object :: list of vehicle names to make available" } diff --git a/docs/reference/plugins/minimator_schema.json b/docs/reference/plugins/minimator_schema.json index 76e21971a..d0b2fa78f 100644 --- a/docs/reference/plugins/minimator_schema.json +++ b/docs/reference/plugins/minimator_schema.json @@ -1,5 +1,5 @@ { - "$id": "~/.conan/data/cloe-plugin-minimator/0.24.0/cloe/develop/package/b604e04f9a20730e6de510c8305e28e783869866/lib/cloe/simulator_minimator.so", + "$id": "~/.conan/data/cloe-plugin-minimator/0.25.0/cloe/develop/package/722452d8f3bfc1eef1fc5de534638769b66120b8/lib/cloe/simulator_minimator.so", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "description": "minimalistic simulator", diff --git a/docs/reference/plugins/noisy_lane_sensor.yaml b/docs/reference/plugins/noisy_lane_sensor.yaml index 1270d6fe0..c8b3acd3e 100644 --- a/docs/reference/plugins/noisy_lane_sensor.yaml +++ b/docs/reference/plugins/noisy_lane_sensor.yaml @@ -1,6 +1,6 @@ Name: noisy_lane_sensor Type: component -Path: ~/.conan/data/cloe-plugin-noisy-sensor/0.24.0/cloe/develop/package/b604e04f9a20730e6de510c8305e28e783869866/lib/cloe/component_noisy_lane_sensor.so +Path: ~/.conan/data/cloe-plugin-noisy-sensor/0.25.0/cloe/develop/package/722452d8f3bfc1eef1fc5de534638769b66120b8/lib/cloe/component_noisy_lane_sensor.so Usage: { "enable": "boolean :: enable or disable component", "noise": "array of object :: configure noisy parameters", diff --git a/docs/reference/plugins/noisy_lane_sensor_schema.json b/docs/reference/plugins/noisy_lane_sensor_schema.json index 2078f0856..44b00dc90 100644 --- a/docs/reference/plugins/noisy_lane_sensor_schema.json +++ b/docs/reference/plugins/noisy_lane_sensor_schema.json @@ -1,5 +1,5 @@ { - "$id": "~/.conan/data/cloe-plugin-noisy-sensor/0.24.0/cloe/develop/package/b604e04f9a20730e6de510c8305e28e783869866/lib/cloe/component_noisy_lane_sensor.so", + "$id": "~/.conan/data/cloe-plugin-noisy-sensor/0.25.0/cloe/develop/package/722452d8f3bfc1eef1fc5de534638769b66120b8/lib/cloe/component_noisy_lane_sensor.so", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "description": "add gaussian noise to lane sensor output", diff --git a/docs/reference/plugins/noisy_object_sensor.yaml b/docs/reference/plugins/noisy_object_sensor.yaml index ea0e624c9..9491fc841 100644 --- a/docs/reference/plugins/noisy_object_sensor.yaml +++ b/docs/reference/plugins/noisy_object_sensor.yaml @@ -1,6 +1,6 @@ Name: noisy_object_sensor Type: component -Path: ~/.conan/data/cloe-plugin-noisy-sensor/0.24.0/cloe/develop/package/b604e04f9a20730e6de510c8305e28e783869866/lib/cloe/component_noisy_object_sensor.so +Path: ~/.conan/data/cloe-plugin-noisy-sensor/0.25.0/cloe/develop/package/722452d8f3bfc1eef1fc5de534638769b66120b8/lib/cloe/component_noisy_object_sensor.so Usage: { "enable": "boolean :: enable or disable component", "noise": "array of object :: configure noisy parameters", diff --git a/docs/reference/plugins/noisy_object_sensor_schema.json b/docs/reference/plugins/noisy_object_sensor_schema.json index 89dfd863e..84498aed4 100644 --- a/docs/reference/plugins/noisy_object_sensor_schema.json +++ b/docs/reference/plugins/noisy_object_sensor_schema.json @@ -1,5 +1,5 @@ { - "$id": "~/.conan/data/cloe-plugin-noisy-sensor/0.24.0/cloe/develop/package/b604e04f9a20730e6de510c8305e28e783869866/lib/cloe/component_noisy_object_sensor.so", + "$id": "~/.conan/data/cloe-plugin-noisy-sensor/0.25.0/cloe/develop/package/722452d8f3bfc1eef1fc5de534638769b66120b8/lib/cloe/component_noisy_object_sensor.so", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "description": "add gaussian noise to object sensor output", diff --git a/docs/reference/plugins/speedometer.yaml b/docs/reference/plugins/speedometer.yaml index 31f7e4933..87920e4a5 100644 --- a/docs/reference/plugins/speedometer.yaml +++ b/docs/reference/plugins/speedometer.yaml @@ -1,5 +1,5 @@ Name: speedometer Type: component -Path: ~/.conan/data/cloe-plugin-speedometer/0.24.0/cloe/develop/package/b604e04f9a20730e6de510c8305e28e783869866/lib/cloe/component_speedometer.so +Path: ~/.conan/data/cloe-plugin-speedometer/0.25.0/cloe/develop/package/722452d8f3bfc1eef1fc5de534638769b66120b8/lib/cloe/component_speedometer.so Usage: null Defaults: {} diff --git a/docs/reference/plugins/speedometer_schema.json b/docs/reference/plugins/speedometer_schema.json index 54e7e186d..f7c3df65e 100644 --- a/docs/reference/plugins/speedometer_schema.json +++ b/docs/reference/plugins/speedometer_schema.json @@ -1,5 +1,5 @@ { - "$id": "~/.conan/data/cloe-plugin-speedometer/0.24.0/cloe/develop/package/b604e04f9a20730e6de510c8305e28e783869866/lib/cloe/component_speedometer.so", + "$id": "~/.conan/data/cloe-plugin-speedometer/0.25.0/cloe/develop/package/722452d8f3bfc1eef1fc5de534638769b66120b8/lib/cloe/component_speedometer.so", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "description": "provide an event trigger to evaluate speed in km/h", diff --git a/docs/reference/plugins/virtue.yaml b/docs/reference/plugins/virtue.yaml index 58ed4674e..3b5ab2ae9 100644 --- a/docs/reference/plugins/virtue.yaml +++ b/docs/reference/plugins/virtue.yaml @@ -1,6 +1,6 @@ Name: virtue Type: controller -Path: ~/.conan/data/cloe-plugin-virtue/0.24.0/cloe/develop/package/b604e04f9a20730e6de510c8305e28e783869866/lib/cloe/controller_virtue.so +Path: ~/.conan/data/cloe-plugin-virtue/0.25.0/cloe/develop/package/722452d8f3bfc1eef1fc5de534638769b66120b8/lib/cloe/controller_virtue.so Usage: { "init_phase": "integer :: time during which initialization is performed", "lane_sensor_components": "array of string :: array of lane-sensor components to be checked" diff --git a/docs/reference/plugins/virtue_schema.json b/docs/reference/plugins/virtue_schema.json index 87e07df5e..989880c9e 100644 --- a/docs/reference/plugins/virtue_schema.json +++ b/docs/reference/plugins/virtue_schema.json @@ -1,5 +1,5 @@ { - "$id": "~/.conan/data/cloe-plugin-virtue/0.24.0/cloe/develop/package/b604e04f9a20730e6de510c8305e28e783869866/lib/cloe/controller_virtue.so", + "$id": "~/.conan/data/cloe-plugin-virtue/0.25.0/cloe/develop/package/722452d8f3bfc1eef1fc5de534638769b66120b8/lib/cloe/controller_virtue.so", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "description": "performs various quality assurance measures", diff --git a/docs/reference/plugins/vtd.rst b/docs/reference/plugins/vtd.rst index 4de080d55..d20ecc548 100644 --- a/docs/reference/plugins/vtd.rst +++ b/docs/reference/plugins/vtd.rst @@ -1,4 +1,5 @@ .. reference-gen: vtd +.. conan-pkg: cloe-plugin-vtd VTD Simulator Binding ===================== diff --git a/engine/src/main_usage.cpp b/engine/src/main_usage.cpp index 78913dad4..006d9b851 100644 --- a/engine/src/main_usage.cpp +++ b/engine/src/main_usage.cpp @@ -257,6 +257,16 @@ Several subcommands are available: cloe-engine -l trace run cloe-stackfile.json debug-conf.json cloe-engine --no-system-confs -l warn run tests/build_config.json + shell + Launch a Lua interactive shell and/or run Lua scripts. + + A simulation is not started. + + Examples: + cloe-engine shell + cloe-engine shell -c 'cloe.describe(cloe)' + cloe-engine shell -i 'testfile.lua' + Please report any bugs to: cloe-dev@eclipse.org --- diff --git a/ui/package.json b/ui/package.json index e05dc154e..b9ab557f8 100644 --- a/ui/package.json +++ b/ui/package.json @@ -1,6 +1,6 @@ { "name": "cloe-ui", - "version": "0.24.0", + "version": "0.25.0", "cloe-compatibility": "0.16", "license": "Apache-2.0", "private": true, diff --git a/ui/server/package.json b/ui/server/package.json index 738532dfc..a44671fd1 100644 --- a/ui/server/package.json +++ b/ui/server/package.json @@ -1,6 +1,6 @@ { "name": "cloe-ui-server", - "version": "0.24.0", + "version": "0.25.0", "cloe-compatibility": "0.18", "license": "Apache-2.0", "private": true,