Getting Started Cameras & Video Detection & Recording Automation & Events Actions Integration & Connectivity Network & Discovery AI & Remote Control MQTT Modbus Pi4J & Raspberry Pi GPIO ZeroMQ System & Administration Comparisons Use Cases Troubleshooting About & Legal
Home / Documentation / Banalytics Modules
📚 Knowledge base

Banalytics Modules

Banalytics is built around a modular architecture. You activate only the capabilities you need, keep the system lean, and pay only for premium features you actually use. Core surveillance functionality is always free.

// Two-part system

Server and web console

Every Banalytics deployment consists of two parts working together:

Banalytics Server
A lightweight application installed on your Windows or Linux PC. It handles all local processing: camera streams, motion detection, recording, and event-driven automation. Your data never leaves your hardware unless you choose to share it.
Web Console
A browser-based control interface accessible from any device. Connect to your servers, manage camera configurations, review event history, and monitor system health remotely without installing anything extra.

Once the server is installed, it registers with your personal account at console.banalytics.live. From that point, the web console gives you full remote access to every paired device.

Banalytics two-part system: a local PC running the Banalytics server connected via secure P2P to the browser-based web console at console.banalytics.live
The Banalytics server runs on your own hardware and processes everything locally. The web console at console.banalytics.live connects to it securely, giving you remote access from any browser without exposing your footage to the cloud.

Modular by design

Each module bundles related Things, Tasks, Actions, events, and—starting with 2.0.0—their matching browser UI resources into one deployable unit. You install only what your use case requires. Module versions remain independently selectable, but a major 2.0.0 upgrade must coordinate the portal and agent because the new console requires agent-supplied UI resources.

2.0.0 architecture: component JavaScript, CSS, icons, translations, and event views now travel with the agent module. See Banalytics 2.0.0 Architecture for compatibility and upgrade details.
Components
Represent connected devices: cameras, microphones, storage units, bots, and other hardware.
Tasks
What the system does with a component: capture video, detect motion, process audio, record continuously.
Actions
What happens when a condition is met: send a Telegram alert, play audio, run a script, set a task state.
Component to Task to Event Manager to Action pipeline, data flow diagram showing how Banalytics processes camera streams and fires automation rules
Data flow inside Banalytics: Components feed streams into Tasks, Tasks generate Events, the Event Manager evaluates rules, and matching rules fire Actions.
// Release numbering

Understanding version numbers

Each module uses a three-part version number in the format A.B.C. This tells you exactly how significant an update is before you apply it.

A

Breaking change

Backward compatibility is lost. A full module reload is required. Plan the update carefully if other modules depend on this one.

B

Library or model update

A third-party library or AI model has been updated. A full module reload is required, but your configuration is preserved.

C

Bug fix

A backward-compatible fix. Only the main library needs to be reloaded. No configuration changes required.

Tip: Use the Version and Module Management page to view installed module versions, check for updates, and control which modules are active on your server.
// Available modules

Module reference

The table below lists every available module with its included components, tasks, and actions.

FREE

Banalytics Core

Foundation infrastructure: system management, storage, integrations, and the full action library.

Actions
Action group Action on task Action on component Command line action Forward event to consumer Play audio Reboot agent Script action Send email Set task state Timeout action
2.0.0

D3JS Charts

Programmable D3.js 7.9.0 visualizations driven by Remote API calls, polling, live events, or a historical load followed by real-time updates.

Components
D3JS Chart
FREE

Basic ONVIF

Full support for ONVIF-compliant cameras, including PTZ control and remote reboot.

Components
ONVIF Camera
Actions
Go to Viewpoint PTZ Gamepad Controller PTZ Axis Reboot ONVIF Device
FREE

Telegram Bot Integration

Send event-triggered notifications with video clips and images directly to Telegram.

Components
Telegram Bot
FREE

Device IP Tracker

Monitor network devices for IP address changes and get alerted when connectivity shifts.

Components
Device IP Tracker
PREMIUM

RC Toys

Experimental module for controlling RC devices through event-driven automation rules.

Status
Components, tasks, and actions in development
// Where to go next

Getting started

New to Banalytics? Start with Install on Windows to get the server running, then use Network Device Discovery to connect your cameras.
Managing updates? See Version and Module Management to control which modules are active and when they are updated.
2.0 Banalytics 2.0.0 Architecture 🪟 Install on Windows 💵 Pricing 🚦 Version and Module Management 📡 Network Device Discovery 📹 ONVIF Camera 🚩 Event Manager 📱 Telegram Bot 🤓 How it works: Makers & Homelabs 🏪 How it works: SMB Operations