hikvision 0.1.2

A rust hikvision sdk
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253


### 📄 [中文](docs/README.zh.md)  | 📄  [English](README.md)


# ⚡ what this ?

**This is the Hikvision Camera Rust SDK, which supports universal network cameras, universal USB cameras, IoT cameras, and industrial cameras (USB, network, CamL)**

### Support SDK

<table style="background:#000">
  <tr>
    <th><h3 style="color:#fff"><center>SDK</center></h3></th>
    <th><h3 style="color:#fff"><center>Windows10</center></h3></th>
    <th><h3 style="color:#fff"><center>Unix</center></h3></th>
    <th><h3 style="color:#fff"><center>-</center></h3></th>
  </tr>
  <tr>
    <td><center>MVS</center></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:red"><center>X</center></h4></td>
    <td><h4 style="color:#aaa"><center>Industrial Capture Camera (USB、CamL、GigE)</center></h4></td>
  </tr>
  <tr>
    <td><center>NET</center></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:red"><center>X</center></h4></td>
    <td><h4 style="color:#aaa"><center>Universal Network Camera</center></h4></td>
  </tr>
  <tr>
      <td><center>USB</center></td>
      <td><h4 style="color:red"><center>X</center></h4></td>
      <td><h4 style="color:red"><center>X</center></h4></td>
      <td><h4 style="color:#aaa"><center>USB Camera</center></h4></td>
  </tr>
  <tr>
      <td><center>OTAP</center></td>
      <td><h4 style="color:red"><center>X</center></h4></td>
      <td><h4 style="color:red"><center>X</center></h4></td>
      <td><h4 style="color:#aaa"><center>Open Things Access Protocol</center></h4></td>
  </tr>
</table>

### SDK Support API

<table style="background:#000">
  <tr>
    <th><h3 style="color:#fff"><center>API</center></h3></th>
    <th><h3 style="color:#fff"><center>MVS</center></h3></th>
    <th><h3 style="color:#fff"><center>NET</center></h3></th>
    <th><h3 style="color:#fff"><center>USB</center></h3></th>
    <th><h3 style="color:#fff"><center>OTAP</center></h3></th>
    <th><h3 style="color:#fff"><center>-</center></h3></th>
  </tr>
  <tr>
    <td><center>Init SDK</center></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:#aaa"><center>Init SDK</center></h4></td>
  </tr>
  <tr>
    <td><center>Enumerate</center></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:red"><center>X</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:#aaa"><center>Enumerate Device</center></h4></td>
  </tr>
  <tr>
    <td><center>Login</center></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:#aaa"><center>Login Device</center></h4></td>
  </tr>
  <tr>
    <td><center>Open</center></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:#aaa"><center>Open Device</center></h4></td>
  </tr>
  <tr>
    <td><center>Handle</center></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:#aaa"><center>Crete Device Handle</center></h4></td>
  </tr>
  <tr>
    <td><center>Log</center></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:#aaa"><center>Log output</center></h4></td>
  </tr>
  <tr>
    <td><center>Clean SDK</center></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:#aaa"><center>Clean SDK</center></h4></td>
  </tr>
  <tr>
    <td><center>Clean All</center></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:#aaa"><center>Clean All</center></h4></td>
  </tr>
  <tr>
    <td><center>Destroy All</center></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:#aaa"><center>Destroy All</center></h4></td>
  </tr>
  <tr>
    <td><center>Callback Sream</center></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:#aaa"><center>Callback Sream</center></h4></td>
  </tr>
  <tr>
    <td><center>Sream</center></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:#aaa"><center>Data Sream</center></h4></td>
  </tr>
  <tr>
    <td><center>Fix Network</center></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:red"><center>X</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:#aaa"><center>Fix Network packet size</center></h4></td>
  </tr>
  <tr>
    <td><center>Preview</center></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:#aaa"><center>Display Camera Image</center></h4></td>
  </tr>
  <tr>
    <td><center>Capture Image</center></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:#aaa"><center>Capture Image</center></h4></td>
  </tr>
  </tr>
  <tr>
    <td><center>Save JPEG</center></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:#aaa"><center>Save One JPEG</center></h4></td>
  </tr>
  <tr>
    <td><center>GUI</center></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:green"><center>√</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:white"><center>-</center></h4></td>
    <td><h4 style="color:#aaa"><center>GUI Window</center></h4></td>
  </tr>
</table>

# ✨ Features

```toml
[features]
net = []
mvs = []
default = []
```

# 📖 Example

```toml
[dependencies]
hikvision = {version="0.1", feature=["mvs","net"]}
```

### Examples

[Init Mvs SDK](examples/global_mvs.rs) | [Init Net SDK](examples/global_net.rs) 


## `💡!important：`

1. [Env.json](Examples/Env.json) **The Lib Path of System Env; `{origin}` of init app current path**
```json
{
  "envs": [
    {
      "key": "HCNET_LIB",
      "value": "{origin}/libs/HCNet/lib"
    },
    {
      "key": "HCNET_COM_LIB",
      "value": "{origin}/libs/HCNet/lib/HCNetSDKCom"
    },
    {
      "key": "HCMVS_LIB",
      "value": "{origin}/libs/HCMvs/Win64_x64"
    }
  ]
}
```
2. The Hikvision Camera Lib of hikvision-rs
```
# put the lib to libs/HCMvs OR libs/HCNet 
cargo run --example global_mvs
cargo run --example global_net
```
3. add your Cargo.toml 
```toml
[dependencies]
hikvision = {version="0.1", feature=["mvs","net"]}
```

# 🚀 fast running

```sh
# test global mvs init sdk

cargo run --example global_mvs

# test global net init sdk

cargo run --example global_net
```

# 🦊 Applied Projects

<!-- [E-NetScan](https://github.com/EternalNight996/e-netscan.git): The network scanning project (which supports both command line and cross platform graphical interface) is under development.. -->


# 🔭 why need to hikvision-rs?

<!-- At first, I wanted to complete a cross network scanning project to help me complete some work. I referred to many open source projects, but these projects have some defects that do not meet my needs, so I have e-libscanner.
(process host and port scanning, and support domain name resolution, route tracking, fingerprint scanning, service scanning, asynchronous scanning, scalability and more)
The bottom layer is by calling [npcap]（ https://nmap.org/npcap/ ）And [WinPcap]（ https://www.winpcap.org/ ）Packet capture service;
The service API is [libpnet]（ https://github.com/libpnet/libpnet ); -->


# 🙋 Reference items and materials

<!-- ✨ [RustScan] https://github.com/RustScan/RustScan : Rustlike nmapscan
✨ [netscan] https://github.com/shellrow/netscan : Rust Network Scanner
✨ [libpnet](libpnet) https://github.com/libpnet/libpnet ● The background base of the interplatform network - mainly using captivity services ([npcap]) https://nmap.org/npcap/ with [WinPcap]( https://www.winpcap.org/ ) -->