Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/applications/license-plate-recognition-camera-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ server.on('event', (event, clientIP) => {
server.start();
```

See the [Node.js SDK reference](/docs/category/nodejs-sdk-reference) for all event properties and server options.
See the [Node.js SDK reference](/docs/nodejs-sdk-reference/events) for all event properties and server options.

</TabItem>
<TabItem value="xml-nvr" label="NVR XML (v2.0)">
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/nodejs-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ npm install viewtron-sdk

Requires Node.js 18.0.0+. Installs one dependency: `fast-xml-parser`.

Source code: [github.com/mikehaldas/viewtron-nodejs-sdk](https://github.com/mikehaldas/viewtron-nodejs-sdk) | Full API reference: [Node.js SDK Reference](/docs/category/nodejs-sdk-reference)
Source code: [github.com/mikehaldas/viewtron-nodejs-sdk](https://github.com/mikehaldas/viewtron-nodejs-sdk) | Full API reference: [ViewtronServer](/docs/nodejs-sdk-reference/server), [ViewtronEvent](/docs/nodejs-sdk-reference/events)

## Receiving Events — ViewtronServer

Expand Down
10 changes: 5 additions & 5 deletions docs/getting-started/python-sdk.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Viewtron Python SDK"
title: "Python API for IP Cameras: Viewtron Python SDK"
sidebar_label: "Python SDK"
description: "Python SDK for Viewtron IP cameras. Parse inbound AI detection events (LPR, face, intrusion) and control cameras programmatically. Install with pip install viewtron."
description: "A Python API for IP cameras and NVRs. The Viewtron Python SDK receives and parses AI detection events (LPR, face, intrusion) and controls cameras. Install with pip install viewtron."
keywords:
- viewtron python sdk
- ip camera python library
Expand All @@ -17,9 +17,9 @@ keywords:
sidebar_position: 6
---

# Viewtron Python SDK
# Viewtron Python SDK: Python API for IP Cameras

The Viewtron Python SDK (`pip install viewtron`) is the recommended way to work with the Viewtron IP Camera API. It handles three things:
The Viewtron Python SDK (`pip install viewtron`) is a Python API for IP cameras and NVRs, and the recommended way to work with the Viewtron IP Camera API from Python. It handles three things:

1. **Event server** — built-in HTTP server that receives camera webhook events, handles persistent connections and keepalives
2. **Event parsing** — automatically detects IPC v1.x vs NVR v2.0 format and returns typed Python objects
Expand All @@ -35,7 +35,7 @@ pip install viewtron

Requires Python 3.8+. Dependencies: `requests`, `xmltodict`.

Source code: [github.com/mikehaldas/viewtron-python-sdk](https://github.com/mikehaldas/viewtron-python-sdk) | Full API reference: [Python SDK Reference](/docs/category/python-sdk-reference)
Source code: [github.com/mikehaldas/viewtron-python-sdk](https://github.com/mikehaldas/viewtron-python-sdk) | Full API reference: [ViewtronServer](/docs/python-sdk-reference/server), [ViewtronEvent](/docs/python-sdk-reference/events), [ViewtronCamera](/docs/python-sdk-reference/client)

## Receiving Events — ViewtronServer

Expand Down
10 changes: 5 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ The [API Reference](/docs/category/api-reference) documents every HTTP endpoint

The SDKs wrap the raw API with typed objects, built-in HTTP servers for receiving webhook events, and automatic IPC/NVR version handling.

- **[Python SDK Reference](/docs/category/python-sdk-reference)** — `pip install viewtron` — ViewtronServer receives events, ViewtronEvent parses them, ViewtronCamera manages plate databases
- **[Node.js SDK Reference](/docs/category/nodejs-sdk-reference)** — `npm install viewtron-sdk` — EventEmitter-based server with the same event model
- **[Python SDK](/docs/getting-started/python-sdk)** — `pip install viewtron` — ViewtronServer receives events, ViewtronEvent parses them, ViewtronCamera manages plate databases
- **[Node.js SDK](/docs/getting-started/nodejs-sdk)** — `npm install viewtron-sdk` — EventEmitter-based server with the same event model

Developers who don't use our SDKs need to build their own HTTP servers and XML parsing.

Expand Down Expand Up @@ -85,16 +85,16 @@ All [Viewtron IP cameras](https://www.cctvcamerapros.com/AI-security-cameras-s/1
## Quick Start

1. **Authenticate** — all requests use [Basic Authentication](/docs/getting-started/authentication)
2. **Install an SDK** — `pip install viewtron` ([Python](/docs/category/python-sdk-reference)) or `npm install viewtron-sdk` ([Node.js](/docs/category/nodejs-sdk-reference))
2. **Install an SDK** — `pip install viewtron` ([Python](/docs/getting-started/python-sdk)) or `npm install viewtron-sdk` ([Node.js](/docs/getting-started/nodejs-sdk))
3. **Test connectivity** — send a `GetDeviceInfo` request to verify access
4. **Explore Applications** — browse [solution guides](/docs/category/applications) to see what you can build
5. **Connect to Home Assistant** — set up the [Home Assistant integration](/docs/integrations/home-assistant) for smart home automations
6. **Reference endpoints** — find detailed request/response docs in the [API Reference](/docs/category/api-reference)

## Resources

- **Python SDK** — [`pip install viewtron`](/docs/category/python-sdk-reference) — receive AI detection events and manage plate databases from Python
- **Node.js SDK** — [`npm install viewtron-sdk`](/docs/category/nodejs-sdk-reference) — EventEmitter-based server for receiving camera events in Node.js
- **Python SDK** — [`pip install viewtron`](/docs/getting-started/python-sdk) — receive AI detection events and manage plate databases from Python
- **Node.js SDK** — [`npm install viewtron-sdk`](/docs/getting-started/nodejs-sdk) — EventEmitter-based server for receiving camera events in Node.js
- **Home Assistant Integration** — [connect Viewtron cameras to Home Assistant](/docs/integrations/home-assistant) via MQTT auto-discovery
- **API Server & Examples** — [github.com/mikehaldas/IP-Camera-API](https://github.com/mikehaldas/IP-Camera-API) — working webhook receiver examples
- **Markdown Documentation** — all documentation pages are available as Markdown files in the [GitHub docs directory](https://github.com/mikehaldas/IP-Camera-API/tree/main/docs) for easy integration with AI coding assistants and automated tools
Expand Down
Loading