cmeel-console-bridge

Common errors

• ModuleNotFoundError: No module named 'console_bridge'

  cause The `cmeel-console-bridge` package was either not installed, or the Python environment where it was installed is not active. Sometimes, `pip` might report success but the installation is corrupted, or a `cmeel.pth` file issue.
  fix Ensure the package is installed in the active environment: `pip install cmeel-console-bridge`. If you're using virtual environments, activate the correct one. If the issue persists, try reinstalling with `--no-cache-dir`.

• CMake Error at CMakeLists.txt:2 (project): No CMAKE_C_COMPILER could be found.

  cause During installation, `pip` attempted to build `cmeel-console-bridge` from source because a pre-built wheel was not found for your system. This error indicates that a C++ compiler (like GCC or Clang) is missing or not detectable by CMake.
  fix Install a C++ compiler for your operating system. For Debian/Ubuntu, run `sudo apt-get update && sudo apt-get install build-essential cmake`. For macOS, install Xcode Command Line Tools (`xcode-select --install`). For Windows, install Visual Studio with C++ build tools.

Warnings

• gotcha Direct exposure of C++ logging functions: Unlike standard Python logging, `cmeel-console-bridge` exposes C++-style logging functions (e.g., `logInform`, `logDebug`) directly within the `console_bridge` module. It does not integrate with Python's built-in `logging` module.
  Fix: Use `console_bridge.logInform(...)`, `console_bridge.logDebug(...)` etc., instead of `logging.info(...)` or `logging.debug(...)`. Pass arguments for formatting directly, similar to C-style `printf`.
• breaking Python 3.8 is the minimum required version. Older Python environments will fail installation.
  Fix: Ensure your environment uses Python 3.8 or newer. Upgrade Python if necessary (`python -m pip install --upgrade pip` is also recommended for optimal wheel handling).
• gotcha Source installation requires C++ compilers and CMake: If a pre-built wheel is not available for your specific platform and Python version, `pip` will attempt to build from source. This requires a C++ compiler (e.g., GCC, MSVC) and CMake to be installed and correctly configured in your environment.
  Fix: For common platforms, binary wheels are usually available. If building from source, ensure you have a C++ compiler (e.g., `build-essential` on Debian/Ubuntu, Xcode on macOS, Visual Studio on Windows) and CMake installed. Consult `cmeel` documentation for advanced build-time environment variables if issues persist.

Install

• pip install cmeel-console-bridge Install latest version

Imports

• logInform
  wrong:

  import logging
  logging.info("Hello from standard logging!")

  correct:

  import console_bridge
  console_bridge.logInform("Hello from console_bridge!")

  cmeel-console-bridge exposes logging functions directly under the `console_bridge` module, not through Python's standard `logging` module. It mirrors `rosconsole`'s API (e.g., logDebug, logInform, logWarn, logError).
• logDebug

  import console_bridge
  console_bridge.logDebug("Debugging info.")

  Similar to logInform, other log levels like debug, warn, and error are exposed as direct functions.

Quickstart

This quickstart demonstrates how to import `console_bridge` and use its primary logging functions (`logDebug`, `logInform`, `logWarn`, `logError`) to output messages. The logging levels mirror those found in `rosconsole`. Note the use of C-style format strings for message interpolation.

import console_bridge

# Set the logging level (optional, default might be INFO or higher)
# console_bridge.setLogLevel(console_bridge.CONSOLE_BRIDGE_LOG_DEBUG)

console_bridge.logDebug("This is a debug message.")
console_bridge.logInform("This is an informational message.")
console_bridge.logWarn("This is a warning message.")
console_bridge.logError("This is an error message.")

# Example of using format strings, similar to C-style printf
name = "World"
value = 42
console_bridge.logInform("Hello, %s! The answer is %d.", name, value)