/docs/dev/plugins/Recent content in Plugins on KismetHugo -- gohugo.ioSun, 01 Nov 2026 01:00:00 -0400/docs/dev/plugins/plugins/Fri, 11 Nov 2022 14:04:57 -0500/docs/dev/plugins/plugins/Kismet can load additional code dynamically at runtime in the form of a plugin. Plugins are a double-edged sword: In their current implementation, plugins are full first-class citizens in the Kismet ecosystem; a plugin can perform any action Kismet native code can perform, and are given a direct reference to the internal Kismet module system. C++ plugin code # Kismet has long supported C++ plugins which load as .so shared object files./docs/dev/plugins/plugins_manifest/Sun, 01 Nov 2026 01:00:00 -0400/docs/dev/plugins/plugins_manifest/Every plugin has a manifest, manifest.conf, in its directory. The manifest says what the plugin is and what it loads: a shared object, an external helper, web UI modules, and device rules. A plugin with no native code, such as one which only adds to the web UI or ships device rules, needs nothing but the manifest and its files. Plugin directory # A plugin is a directory in one of the plugin locations, named for the plugin:/docs/dev/plugins/uiplugins_intro/Sun, 01 Nov 2026 01:00:00 -0400/docs/dev/plugins/uiplugins_intro/Added: after 2026-10-R1 ⚠️ The new Kismet UI, and its plugin interface, are changing quickly in the nightly builds. The registries and options described here may change before they are in a Kismet release. Come talk to us on the Kismet Discord server if you’re writing a UI plugin! The new Kismet web UI is built from plain JavaScript modules, with no build step. Everything in it, from the device list columns to the Wi-Fi details, is added by a module through the same interface a plugin uses: the built-in parts of the UI (in http_data/js/base/) and each phy’s module (in http_data/js/phy/) are the best examples of how to write one./docs/dev/plugins/uiplugins_devicelist/Sun, 01 Nov 2026 01:00:00 -0400/docs/dev/plugins/uiplugins_devicelist/Added: after 2026-10-R1 ⚠️ The UI plugin interface is changing quickly in the nightly builds, and may change before it is in a Kismet release. The device list is built from the columns, icons, and row highlights modules register. It asks the server only for the fields the visible columns, icon, and highlights list, so each of them says what it reads in fields (see fields). Columns # kismet.ui.deviceColumns holds the columns users can pick from./docs/dev/plugins/uiplugins_details/Sun, 01 Nov 2026 01:00:00 -0400/docs/dev/plugins/uiplugins_details/Added: after 2026-10-R1 ⚠️ The UI plugin interface is changing quickly in the nightly builds, and may change before it is in a Kismet release. Clicking a device opens its details panel, which is made of sections registered by modules: the common details from js/base/details.js, and a section from each phy for its own devices. Sections # kismet.ui.deviceDetails holds the sections. Option id, title, priority The section match(device) Whether the section applies to a device fields The section’s rows, as a list of field entries (below) render(device, el) Or draw the section yourself; called again with fresh data each time the device changes open Start expanded (default true); the user’s choice is remembered A section has fields, render, or both; render draws into its own space below the fields./docs/dev/plugins/uiplugins_page/Sun, 01 Nov 2026 01:00:00 -0400/docs/dev/plugins/uiplugins_page/Added: after 2026-10-R1 ⚠️ The UI plugin interface is changing quickly in the nightly builds, and may change before it is in a Kismet release. The parts of the page around the device list, the tabs, the main menu, the stats across the top, and the settings dialog, are registries too. Tabs # kismet.ui.panes holds the tabs in the page’s two tabbed areas: 'main' (Overview, Devices, SSIDs, Alerts, Map, and so on) and 'bottom' (Messages)./docs/dev/plugins/uiplugins_overview_map/Sun, 01 Nov 2026 01:00:00 -0400/docs/dev/plugins/uiplugins_overview_map/Added: after 2026-10-R1 ⚠️ The UI plugin interface is changing quickly in the nightly builds, and may change before it is in a Kismet release. Overview cards # The Overview tab is a grid of cards from kismet.ui.dashboardCards. Users arrange, resize, hide, and add back cards with Edit layout; the layout is kept per browser. Option id, title, priority The card w, h Its starting size on the 12-column grid, in columns and rows (3 × 5 if not given) needs The shared data it reads (below) loading The outline shown until that data arrives: one or a list of 'stat', 'tabs', 'graph', 'histogram', 'bars', 'list', 'table', 'donut', 'text' (the default), stacked top to bottom create(body, { actions }) Builds the card; returns { update(data), destroy() } onClick(actions) Optional: called when the card is clicked (anywhere but its own buttons and links) actions./docs/dev/plugins/uiplugins_sources/Sun, 01 Nov 2026 01:00:00 -0400/docs/dev/plugins/uiplugins_sources/Added: after 2026-10-R1 ⚠️ The UI plugin interface is changing quickly in the nightly builds, and may change before it is in a Kismet release. The Data sources window shows a card for each source, built from sections like the device panel. The standard sections (js/base/sources.js) work for every source; a phy module adds its own for the capture drivers it knows, such as the Wi-Fi channel layout or a cell modem’s DIAG capture (js/phy/cell./docs/dev/plugins/uiplugins_insights/Sun, 01 Nov 2026 01:00:00 -0400/docs/dev/plugins/uiplugins_insights/Added: after 2026-10-R1 ⚠️ The UI plugin interface is changing quickly in the nightly builds, and may change before it is in a Kismet release. The Insights tab draws a graph of how devices relate, their activity over time, and a list of unusual things. The base code only knows devices; each phy module adds what it knows about how its devices relate (a Wi-Fi client and its access point, a network name and the devices which advertise or probe for it) and what it finds unusual./docs/dev/plugins/uiplugins_core/Sun, 01 Nov 2026 01:00:00 -0400/docs/dev/plugins/uiplugins_core/Added: after 2026-10-R1 ⚠️ The UI plugin interface is changing quickly in the nightly builds, and may change before it is in a Kismet release. Besides the registries in kismet.ui, the kismet object a module’s register() gets holds what modules use to talk to the server and draw their own UI. Each part is a module in http_data/js/core/ or http_data/js/widgets/, and the comments at the top of each file describe it in full.