brainframe-apps

Python CLI tool for managing BrainFrame video analytics server via REST APIs.

Installation

pip install brainframe-apps

Usage

brainframe_apps <command> [options]

Commands

• add-stream - Add video stream
• delete-stream - Remove stream
• list-stream - List streams
• start-analyzing - Start stream analysis
• stop-analyzing - Stop stream analysis
• capsule-control - Manage AI capsules
• alarm-control - Manage stream alarms
• zone-control - Manage stream zones
• identity-control - Manage identities
• user-control - Manage users
• license-control - Manage licenses
• get-zone-statuses - Get zone status
• process-image - Process a single image using the server's active capsules and configuration (per-stream or global)
• load-settings - Load configuration
• save-settings - Save configuration

Example

brainframe_apps add-stream --server-url http://localhost --stream-url rtsp://camera.url
brainframe_apps list-stream
brainframe_apps start-analyzing --stream-name "Camera 1"

# Uses the capsules enabled & configured on the server for stream 3:
brainframe_apps process-image --image-path frame.png --stream-id 3
# Omit --stream-id/--stream-url to use the global capsule configuration.

Help

brainframe_apps <command> --help