dvrip-rs 0.1.0

A Rust library for interacting with DVR-IP devices ported from python-dvr.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170

use crate::constants::{KEY_CODES, OK_CODES};
use crate::dvrip::DVRIPCam;
use crate::error::Result;
use async_trait::async_trait;
use serde_json::json;
use strum_macros::AsRefStr;
use tokio::time::{Duration, sleep};

#[derive(Debug, Clone, Copy, AsRefStr)]
pub enum PTZCommand {
    DirectionUp,
    DirectionDown,
    DirectionLeft,
    DirectionRight,
    DirectionLeftUp,
    DirectionLeftDown,
    DirectionRightUp,
    DirectionRightDown,
    ZoomTile,
    ZoomWide,
    FocusNear,
    FocusFar,
    IrisSmall,
    IrisLarge,
    SetPreset,
    GotoPreset,
    ClearPreset,
    StartTour,
    StopTour,
}

#[async_trait]
pub trait PTZ: Send + Sync {
    /// Control PTZ with continuous command
    async fn ptz(&mut self, cmd: PTZCommand, step: u8, preset: i32, channel: u8) -> Result<bool>;

    /// Control PTZ with single step movement
    async fn ptz_step(&mut self, cmd: PTZCommand, step: u8) -> Result<bool>;

    /// Press a key (keyDown)
    async fn key_down(&mut self, key: &str) -> Result<bool>;

    /// Release a key (keyUp)
    async fn key_up(&mut self, key: &str) -> Result<bool>;

    /// Press and release a key
    async fn key_press(&mut self, key: &str) -> Result<bool>;

    /// Execute a key script
    async fn key_script(&mut self, keys: &str) -> Result<bool>;
}

#[async_trait]
impl PTZ for DVRIPCam {
    async fn ptz(&mut self, cmd: PTZCommand, step: u8, preset: i32, channel: u8) -> Result<bool> {
        let cmd_str = cmd.as_ref().to_string();
        let ptz_param = json!({
            "AUX": {"Number": 0, "Status": "On"},
            "Channel": channel,
            "MenuOpts": "Enter",
            "Pattern": "Start",
            "Preset": preset,
            "Step": step,
            "Tour": if cmd_str.contains("Tour") { 1 } else { 0 },
        });

        let data = json!({
            "Command": cmd_str,
            "Parameter": ptz_param,
        });

        let reply = self.set_command("OPPTZControl", data, None).await?;
        if let Some(ret) = reply.get("Ret").and_then(|r| r.as_u64()) {
            return Ok(OK_CODES.contains(&(ret as u32)));
        }
        Ok(false)
    }

    async fn ptz_step(&mut self, cmd: PTZCommand, step: u8) -> Result<bool> {
        let cmd_str = cmd.as_ref().to_string();

        // Start Movement
        let params_start = json!({
            "AUX": {"Number": 0, "Status": "On"},
            "Channel": 0,
            "MenuOpts": "Enter",
            "POINT": {"bottom": 0, "left": 0, "right": 0, "top": 0},
            "Pattern": "SetBegin",
            "Preset": 65535,
            "Step": step,
            "Tour": 0,
        });

        let data_start = json!({
            "Command": cmd_str,
            "Parameter": params_start,
        });

        self.set_command("OPPTZControl", data_start, None).await?;

        // Stop movement
        let params_end = json!({
            "AUX": {"Number": 0, "Status": "On"},
            "Channel": 0,
            "MenuOpts": "Enter",
            "POINT": {"bottom": 0, "left": 0, "right": 0, "top": 0},
            "Pattern": "SetBegin",
            "Preset": -1,
            "Step": step,
            "Tour": 0,
        });

        let data_end = json!({
            "Command": cmd_str,
            "Parameter": params_end,
        });

        let reply = self.set_command("OPPTZControl", data_end, None).await?;
        if let Some(ret) = reply.get("Ret").and_then(|r| r.as_u64()) {
            return Ok(OK_CODES.contains(&(ret as u32)));
        }
        Ok(false)
    }

    async fn key_down(&mut self, key: &str) -> Result<bool> {
        let data = json!({
            "Status": "KeyDown",
            "Value": key,
        });

        let reply = self.set_command("OPNetKeyboard", data, None).await?;
        if let Some(ret) = reply.get("Ret").and_then(|r| r.as_u64()) {
            return Ok(OK_CODES.contains(&(ret as u32)));
        }
        Ok(false)
    }

    async fn key_up(&mut self, key: &str) -> Result<bool> {
        let data = json!({
            "Status": "KeyUp",
            "Value": key,
        });

        let reply = self.set_command("OPNetKeyboard", data, None).await?;
        if let Some(ret) = reply.get("Ret").and_then(|r| r.as_u64()) {
            return Ok(OK_CODES.contains(&(ret as u32)));
        }
        Ok(false)
    }

    async fn key_press(&mut self, key: &str) -> Result<bool> {
        self.key_down(key).await?;
        sleep(Duration::from_millis(300)).await;
        self.key_up(key).await
    }

    async fn key_script(&mut self, keys: &str) -> Result<bool> {
        for k in keys.chars() {
            if k != ' ' {
                let key_upper = k.to_uppercase().to_string();
                if let Some(key_code) = KEY_CODES.get(key_upper.as_str()) {
                    self.key_press(key_code).await?;
                }
            } else {
                sleep(Duration::from_secs(1)).await;
            }
        }
        Ok(true)
    }
}