viewtron 1.0.0

Python SDK for Viewtron IP camera API — parse inbound alarm events and control cameras

Viewtron Python SDK

Python SDK for Viewtron IP camera API. Parse inbound alarm events and control cameras programmatically.

Viewtron IP cameras run AI detection on-camera (license plate recognition, face detection, human/vehicle detection) and send HTTP POST events to your server. This SDK parses those events and provides an API client for camera control.

Install

pip install viewtron

Inbound Events — Parse Camera Alarm Data

Viewtron cameras and NVRs send XML alarm events via HTTP POST. This SDK parses them into Python objects.

from viewtron import LPR, FaceDetection, IntrusionDetection

# In your HTTP server's POST handler:
lpr_event = LPR(request_body)
print(lpr_event.get_plate_number())       # "ABC1234"
print(lpr_event.is_plate_authorized())    # True (plate is on camera whitelist)

# Images are included as base64
if lpr_event.source_image_exists():
    overview = lpr_event.get_source_image()   # base64 JPEG — full scene
if lpr_event.target_image_exists():
    plate_crop = lpr_event.get_target_image() # base64 JPEG — plate closeup

Supported Event Types

Source	Class	Detection
IPC v1.x	LPR	License plate recognition with whitelist/blacklist
IPC v1.x	FaceDetection	Face detection with crop image
IPC v1.x	IntrusionDetection	Perimeter intrusion (person/vehicle)
IPC v1.x	IntrusionEntry	Zone entry
IPC v1.x	IntrusionExit	Zone exit
IPC v1.x	LoiteringDetection	Loitering
IPC v1.x	VideoMetadata	Continuous object detection
NVR v2.0	VehicleLPR	LPR with vehicle brand/color/type
NVR v2.0	FaceDetectionV2	Face detection with age/sex/glasses/mask
NVR v2.0	RegionIntrusion	Perimeter intrusion
NVR v2.0	LineCrossing	Tripwire line crossing
NVR v2.0	TargetCountingByLine	People/vehicle counting by line
NVR v2.0	TargetCountingByArea	People/vehicle counting by area
NVR v2.0	VideoMetadataV2	Continuous object detection

Version detection is automatic — IPC v1.x and NVR v2.0 use different XML structures but the SDK handles both.

Outbound API — Control the Camera

from viewtron import ViewtronCamera

camera = ViewtronCamera("192.168.0.20", "admin", "password")
camera.login()

# Device info
info = camera.get_device_info()
print(info["model"])  # "LPR-IP4"

# Manage the license plate whitelist/blacklist
plates = camera.get_plates()
camera.add_plate("ABC1234", owner="Mike", list_type="whiteList")
camera.delete_plate(key_id=1775415327)

camera.logout()

# Or use as context manager
with ViewtronCamera("192.168.0.20", "admin", "password") as cam:
    plates = cam.get_plates()

Projects Using This SDK

• Viewtron Home Assistant Integration — Camera events as HA sensors via MQTT auto-discovery
• IP Camera API Server — Alarm server with CSV logging and image saving

Documentation

• Viewtron API Developer Guide
• XML Event Examples
• IP Camera Setup Guide
• NVR Setup Guide

Products

• All Viewtron Products
• AI Security Cameras
• LPR Cameras
• Face Recognition Cameras

Author

Mike Haldas — CCTV Camera Pros [e-mail]