ROS index logo ROS Index
  1. Home
  2. Packages
  3. cx_config_plugin
 
No version for distro humble. Known supported distros are highlighted in the buttons above.

cx_config_plugin package from clips_executive repo

clips_executive cx_bringup cx_clips_env_manager cx_msgs cx_plugin cx_ament_index_plugin cx_config_plugin cx_example_plugin cx_executive_plugin cx_file_load_plugin cx_protobuf_plugin cx_ros_msgs_plugin cx_tf2_pose_tracker_plugin cx_ros_comm_gen cx_tutorial_agents cx_utils

API Docs
Browse Code

Package Summary

Tags No category tags.
Version 0.1.0
License Apache-2.0
Build type AMENT_CMAKE
Use RECOMMENDED

Repository Summary

Description
Checkout URI https://github.com/carologistics/clips_executive.git
VCS Type git
VCS Version master
Last Updated 2025-06-24
Dev Status MAINTAINED
CI status No Continuous Integration
Released UNRELEASED
Tags No category tags.
Contributing Help Wanted (0)
Good First Issues (0)
Pull Requests to Review (0)

Package Description

CX plugin to parse yaml files and provide the values to CLIPS

Additional Links

No additional links.

Maintainers

  • Tarik Viehmann

Authors

No additional authors.
cx_plugins/config_plugin/README.md

cx_config_plugin

This package offers the cx::ConfigPlugin CLIPS plugin to read config values from yaml.

Usage

Register this plugin with the plugin manager. It requires no additional configuration, an example setup is shown below:

clips_manager:
  ros__parameters:
    environments: ["main"]
    main:
      plugins: ["config"]

    config:
      plugin: "cx::ConfigPlugin"

CLIPS Features

This plugin adds deftemplates and deffunctions as listed below:

Deftemplates

; Asserted by the config-load function for each configuration value in the parsed yaml file.
(deftemplate confval
  (slot path (type STRING))
  (slot type (type SYMBOL) (allowed-values FLOAT UINT INT BOOL STRING))
  (slot value)
  (slot is-list (type SYMBOL) (allowed-values TRUE FALSE) (default FALSE))
  (multislot list-value)
)

Functions

; Load all config values from a file (absolute path) given a prefix and store tjhem into (confval) facts.
; The prefix determines tha resulting path in the confval facts.
(config-load ?file ?prefix)

Example

Assuming a yaml file at path /home/<user>/test.yaml:

root:
  branch:
        val1: true
        val2: [test1, test2]
  branch2:
        val1: false

Calling the function with different prefixes yields the following results:

Parsing Everyting

(config-load "/home/<user>/test.yaml" "/")
(confval
  (path "/root/branch/val1")
  (type BOOL)
  (value TRUE)
  (is-list FALSE)
  (list-value)
)
(confval
  (path "/root/branch/val2")
  (type STRING)
  (value nil)
  (is-list TRUE)
  (list-value "test1" "test2")
)
(confval
  (path "/root/branch2/val1")
  (type BOOL)
  (value FALSE)
  (is-list FLASE)
  (list-value)
)

Parsing Only “branch”

(config-load "/home/<user>/test.yaml" "/root/branch")
(confval
  (path "/root/branch/val1")
  (type BOOL)
  (value TRUE)
  (is-list FALSE)
  (list-value)
)
(confval
  (path "/root/branch/val2")
  (type STRING)
  (value nil)
  (is-list TRUE)
  (list-value "test1" "test2")
)
CHANGELOG
No CHANGELOG found.

Wiki Tutorials

This package does not provide any links to tutorials in it's rosindex metadata. You can check on the ROS Wiki Tutorials page for the package.

Package Dependencies

Deps Name
ament_cmake
ament_index_cpp
cx_plugin
cx_utils
pluginlib
yaml_cpp_vendor
clips_vendor

System Dependencies

No direct system dependencies.

Dependant Packages

Name Deps
clips_executive
cx_bringup

Launch files

No launch files found

Messages

No message files found.

Services

No service files found

Plugins

Recent questions tagged cx_config_plugin at Robotics Stack Exchange

cx_config_plugin package from clips_executive repo

clips_executive cx_bringup cx_clips_env_manager cx_msgs cx_plugin cx_ament_index_plugin cx_config_plugin cx_example_plugin cx_executive_plugin cx_file_load_plugin cx_protobuf_plugin cx_ros_msgs_plugin cx_tf2_pose_tracker_plugin cx_ros_comm_gen cx_tutorial_agents cx_utils

API Docs
Browse Code

Package Summary

Tags No category tags.
Version 0.1.0
License Apache-2.0
Build type AMENT_CMAKE
Use RECOMMENDED

Repository Summary

Description
Checkout URI https://github.com/carologistics/clips_executive.git
VCS Type git
VCS Version master
Last Updated 2025-06-24
Dev Status MAINTAINED
CI status No Continuous Integration
Released UNRELEASED
Tags No category tags.
Contributing Help Wanted (0)
Good First Issues (0)
Pull Requests to Review (0)

Package Description

CX plugin to parse yaml files and provide the values to CLIPS

Additional Links

No additional links.

Maintainers

  • Tarik Viehmann

Authors

No additional authors.
cx_plugins/config_plugin/README.md

cx_config_plugin

This package offers the cx::ConfigPlugin CLIPS plugin to read config values from yaml.

Usage

Register this plugin with the plugin manager. It requires no additional configuration, an example setup is shown below:

clips_manager:
  ros__parameters:
    environments: ["main"]
    main:
      plugins: ["config"]

    config:
      plugin: "cx::ConfigPlugin"

CLIPS Features

This plugin adds deftemplates and deffunctions as listed below:

Deftemplates

; Asserted by the config-load function for each configuration value in the parsed yaml file.
(deftemplate confval
  (slot path (type STRING))
  (slot type (type SYMBOL) (allowed-values FLOAT UINT INT BOOL STRING))
  (slot value)
  (slot is-list (type SYMBOL) (allowed-values TRUE FALSE) (default FALSE))
  (multislot list-value)
)

Functions

; Load all config values from a file (absolute path) given a prefix and store tjhem into (confval) facts.
; The prefix determines tha resulting path in the confval facts.
(config-load ?file ?prefix)

Example

Assuming a yaml file at path /home/<user>/test.yaml:

root:
  branch:
        val1: true
        val2: [test1, test2]
  branch2:
        val1: false

Calling the function with different prefixes yields the following results:

Parsing Everyting

(config-load "/home/<user>/test.yaml" "/")
(confval
  (path "/root/branch/val1")
  (type BOOL)
  (value TRUE)
  (is-list FALSE)
  (list-value)
)
(confval
  (path "/root/branch/val2")
  (type STRING)
  (value nil)
  (is-list TRUE)
  (list-value "test1" "test2")
)
(confval
  (path "/root/branch2/val1")
  (type BOOL)
  (value FALSE)
  (is-list FLASE)
  (list-value)
)

Parsing Only “branch”

(config-load "/home/<user>/test.yaml" "/root/branch")
(confval
  (path "/root/branch/val1")
  (type BOOL)
  (value TRUE)
  (is-list FALSE)
  (list-value)
)
(confval
  (path "/root/branch/val2")
  (type STRING)
  (value nil)
  (is-list TRUE)
  (list-value "test1" "test2")
)
CHANGELOG
No CHANGELOG found.

Wiki Tutorials

This package does not provide any links to tutorials in it's rosindex metadata. You can check on the ROS Wiki Tutorials page for the package.

Package Dependencies

Deps Name
ament_cmake
ament_index_cpp
cx_plugin
cx_utils
pluginlib
yaml_cpp_vendor
clips_vendor

System Dependencies

No direct system dependencies.

Dependant Packages

Name Deps
clips_executive
cx_bringup

Launch files

No launch files found

Messages

No message files found.

Services

No service files found

Plugins

Recent questions tagged cx_config_plugin at Robotics Stack Exchange

cx_config_plugin package from clips_executive repo

clips_executive cx_bringup cx_clips_env_manager cx_msgs cx_plugin cx_ament_index_plugin cx_config_plugin cx_example_plugin cx_executive_plugin cx_file_load_plugin cx_protobuf_plugin cx_ros_msgs_plugin cx_tf2_pose_tracker_plugin cx_ros_comm_gen cx_tutorial_agents cx_utils

API Docs
Browse Code

Package Summary

Tags No category tags.
Version 0.1.0
License Apache-2.0
Build type AMENT_CMAKE
Use RECOMMENDED

Repository Summary

Description
Checkout URI https://github.com/carologistics/clips_executive.git
VCS Type git
VCS Version master
Last Updated 2025-06-24
Dev Status MAINTAINED
CI status No Continuous Integration
Released UNRELEASED
Tags No category tags.
Contributing Help Wanted (0)
Good First Issues (0)
Pull Requests to Review (0)

Package Description

CX plugin to parse yaml files and provide the values to CLIPS

Additional Links

No additional links.

Maintainers

  • Tarik Viehmann

Authors

No additional authors.
cx_plugins/config_plugin/README.md

cx_config_plugin

This package offers the cx::ConfigPlugin CLIPS plugin to read config values from yaml.

Usage

Register this plugin with the plugin manager. It requires no additional configuration, an example setup is shown below:

clips_manager:
  ros__parameters:
    environments: ["main"]
    main:
      plugins: ["config"]

    config:
      plugin: "cx::ConfigPlugin"

CLIPS Features

This plugin adds deftemplates and deffunctions as listed below:

Deftemplates

; Asserted by the config-load function for each configuration value in the parsed yaml file.
(deftemplate confval
  (slot path (type STRING))
  (slot type (type SYMBOL) (allowed-values FLOAT UINT INT BOOL STRING))
  (slot value)
  (slot is-list (type SYMBOL) (allowed-values TRUE FALSE) (default FALSE))
  (multislot list-value)
)

Functions

; Load all config values from a file (absolute path) given a prefix and store tjhem into (confval) facts.
; The prefix determines tha resulting path in the confval facts.
(config-load ?file ?prefix)

Example

Assuming a yaml file at path /home/<user>/test.yaml:

root:
  branch:
        val1: true
        val2: [test1, test2]
  branch2:
        val1: false

Calling the function with different prefixes yields the following results:

Parsing Everyting

(config-load "/home/<user>/test.yaml" "/")
(confval
  (path "/root/branch/val1")
  (type BOOL)
  (value TRUE)
  (is-list FALSE)
  (list-value)
)
(confval
  (path "/root/branch/val2")
  (type STRING)
  (value nil)
  (is-list TRUE)
  (list-value "test1" "test2")
)
(confval
  (path "/root/branch2/val1")
  (type BOOL)
  (value FALSE)
  (is-list FLASE)
  (list-value)
)

Parsing Only “branch”

(config-load "/home/<user>/test.yaml" "/root/branch")
(confval
  (path "/root/branch/val1")
  (type BOOL)
  (value TRUE)
  (is-list FALSE)
  (list-value)
)
(confval
  (path "/root/branch/val2")
  (type STRING)
  (value nil)
  (is-list TRUE)
  (list-value "test1" "test2")
)
CHANGELOG
No CHANGELOG found.

Wiki Tutorials

This package does not provide any links to tutorials in it's rosindex metadata. You can check on the ROS Wiki Tutorials page for the package.

Package Dependencies

Deps Name
ament_cmake
ament_index_cpp
cx_plugin
cx_utils
pluginlib
yaml_cpp_vendor
clips_vendor

System Dependencies

No direct system dependencies.

Dependant Packages

Name Deps
clips_executive
cx_bringup

Launch files

No launch files found

Messages

No message files found.

Services

No service files found

Plugins

Recent questions tagged cx_config_plugin at Robotics Stack Exchange

No version for distro github. Known supported distros are highlighted in the buttons above.
No version for distro noetic. Known supported distros are highlighted in the buttons above.
No version for distro galactic. Known supported distros are highlighted in the buttons above.
No version for distro iron. Known supported distros are highlighted in the buttons above.
No version for distro melodic. Known supported distros are highlighted in the buttons above.