Getting started with Kanzi Monitor¶

After you extract the Kanzi Monitor package to <KanziWorkspace>/Engine/plugins/monitor/, the next step is to add Kanzi Monitor to your Kanzi application.

Kanzi Monitor supports two usage modes:

In a Kanzi application project — Integrate Kanzi Monitor into your project build system. This gives full access to all features and is the primary use case.
In Kanzi Studio — Import the Kanzi Monitor DLL directly in Kanzi Studio as a plugin. Some Kanzi Monitor features are not available in the Kanzi Studio Preview.

The rest of this page covers the application project path.

Integrating into your application project¶

To add Kanzi Monitor to your application project, follow the integration steps for your target platform and build system.

See Integrating Kanzi Monitor into existing projects.

When integration is complete, the plugin loads when the application starts and all services run with their default settings.

Accessing the scene graph¶

Kanzi Monitor discovers the application’s scene graph automatically through the Kanzi Domain: it enumerates the host’s view roots with Domain::getScreens(). This covers single-window hosts (desktop, simple Android) and droidfw’s multiple views — including a view root created in application code — with no integration code. You do not need to provide the Application instance or register any node tree; the plugin works out of the box once it is loaded.

Setting permissions¶

Android¶

Kanzi Monitor requires privileges to write files and open TCP sockets. On Android, you must add these permissions to the application manifest and grant them on the device before using Kanzi Monitor.

See Setting permissions on Android.

Serial port communication¶

Communication over serial ports is optional, and the default configuration setting is disabled. If you want to use serial communication, ensure that UART privileges are granted on the device.

See Using the serial console.