OToolkit
The OToolkit is a work-in-progress project. Data stored locally may be lost or become invalid during development.
OToolkit is a handy debugging tool that implements key features for OpenTwin development. It runs as an OpenTwin service and requires a port number as a startup argument.
Warning
When running OToolkit in Debug Mode, an assertion may fail indicating the logging service is unreachable. This occurs when a Logging Service URL is set in the environment but the Logger Service isn’t running.
Since OToolkit includes internal logging functionality, the Logger Service is optional. You can safely ignore this assertion.
Configuration
Start Arguments
OToolkit accepts startup arguments passed as the fourth parameter. Alternatively, use the OpenTwin_toolkit script, which properly formats and passes arguments to OToolkit.
Note
Each argument must start with a hyphen - and be separated by at least one space.
Argument |
Description |
|---|---|
|
Automatically starts the Log Visualization tool, connects to the logger service, and exports logs after fetching messages. |
|
Suppresses automatic tool startup when launching OToolkit. Useful if a tool causes issues during startup. |
Features
Output
The output window displays OToolkit’s internal logs. When developing custom tools, use OToolkit’s logging macros instead of OpenTwin ServiceLogger macros.
Log Visualization
The Log Visualization tool displays messages currently buffered in the Logger Service.
Apply filters to improve log message overview:
Message contains: Enter text and press Return to apply the filter
Clear filter: Remove text and press Return to show all messages
Connect to Logger Service
To connect to the Logger Service:
Click the Connect button in the Log Visualization menu bar
Enter the Logger Service URL in the dialog that appears
After successfully connecting, OToolkit retrieves the current log buffer from the Logger Service.
OTerminal
Use OTerminal to send messages to any OpenTwin service using the OpenTwin message API.