Pepperdash.Essentials.Plugins.Birddog.Camera 1.0.0-cmd-queue.2

Birddog Camera Plugin

Birddog X1/MAX API - PTZ

Birddog API - PTZ

Essentials Device Configuration

{
    "key": "camera-1",
    "name": "Camera 1",
    "type": "birddogCamera",
    "group": "plugin",
    "properties": {
        "control": {
            "method": "http",
            "tcpSshProperties": {
                "address": "192.168.1.101",
                "port": 8080
            }
        },
        "presets": [
            {
                "Name": "Preset 1",
                "Id": 1
            },
            {
                "Name": "Preset 2",
                "Id": 2
            },
            {
                "Name": "Preset 3",
                "Id": 3
            }
        ],
        "panSpeed": 25,
        "titlSpeed": 25,
        "zoomSpeed": 25
    }
}

Essentials Bridging

{
    "key": "plugin-bridge-1",
    "name": "Plugin Bridge",
    "group": "api",
    "type": "eiscApiAdvanced",
    "properties": {
        "control": {
            "tcpSshProperties": {
                "address": "127.0.0.2",
                "port": 0
            },
            "ipid": "B2",
            "method": "ipidTcp"
        },
        "devices": [
            {
                "deviceKey": "camera-1",
                "joinStart": 1
            }
        ]
    }
}

Essentials Bridge Join Map

The join map below documents the commands implemented in this plugin.

Digitals

Analogs

Serials

PTZ Control Implementation

This plugin implements PTZ (Pan, Tilt, Zoom) control using Birddog's CGI-based API commands. The implementation provides:

Supported PTZ Functions

• Pan Control: PanLeft(), PanRight(), PanStop()
• Tilt Control: TiltUp(), TiltDown(), TiltStop()
• Zoom Control: ZoomIn(), ZoomOut(), ZoomStop()
• Position Control: PositionHome(), PositionPrivacy()
• Preset Management: Recall and Save presets (1-16)

Error Handling

All PTZ methods include comprehensive error handling:

• HTTP request failures are caught and logged
• Network communication errors are reported via Debug.LogError
• Individual operation failures include descriptive error messages

Speed Configuration

PTZ speeds can be configured through the device properties:

• panSpeed: Range 1-49 (default: 25) - Controls pan movement speed
• tiltSpeed: Range 1-49 (default: 25) - Controls tilt movement speed
• zoomSpeed: Range 1-49 (default: 25) - Controls zoom speed

Note: The RESTful API v2.0 uses different ranges (Pan: 0-21, Tilt: 0-18, Zoom: 0-7), but this plugin uses the CGI-based API with its own speed mapping.

API Compatibility

This plugin uses CGI-based commands (cgi-bin/aw_ptz) for maximum compatibility with existing Birddog camera firmware. While Birddog also offers a newer RESTful API v2.0, the CGI approach ensures backward compatibility across different camera models and firmware versions.

DEVJSON Commands

When using DEVJSON commands update the program index devjson:{programIndex} and deviceKey values to match the testing environment.

devjson:1 {"deviceKey":"camera-1", "methodName":"CameraOn", "params":[]}
devjson:1 {"deviceKey":"camera-1", "methodName":"CameraOff", "params":[]}

devjson:1 {"deviceKey":"camera-1", "methodName":"PanLeft", "params":[]}
devjson:1 {"deviceKey":"camera-1", "methodName":"PanRight", "params":[]}
devjson:1 {"deviceKey":"camera-1", "methodName":"PanStop", "params":[]}

devjson:1 {"deviceKey":"camera-1", "methodName":"TiltUp", "params":[]}
devjson:1 {"deviceKey":"camera-1", "methodName":"TiltDown", "params":[]}
devjson:1 {"deviceKey":"camera-1", "methodName":"TiltStop", "params":[]}

devjson:1 {"deviceKey":"camera-1", "methodName":"ZoomIn", "params":[]}
devjson:1 {"deviceKey":"camera-1", "methodName":"ZoomOut", "params":[]}
devjson:1 {"deviceKey":"camera-1", "methodName":"ZoomStop", "params":[]}

devjson:1 {"deviceKey":"camera-1", "methodName":"PositionHome", "params":[]}
devjson:1 {"deviceKey":"camera-1", "methodName":"PositionPrivacy", "params":[]}

devjson:1 {"deviceKey":"camera-1", "methodName":"RecallPreset", "params":[4]}
devjson:1 {"deviceKey":"camera-1", "methodName":"SavePreset", "params":[9]}

devjson:1 {"deviceKey":"camera-1", "methodName":"SendCustomCommand", "params":["customCommandString"]}