Skip to content
This repository was archived by the owner on Oct 5, 2021. It is now read-only.

Commit 68c3489

Browse files
author
Tomas Verhelst
committedSep 7, 2018
Updated license and readme
1 parent e3ec0e8 commit 68c3489

File tree

2 files changed

+389
-0
lines changed

2 files changed

+389
-0
lines changed
 

‎LICENSE.txt

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [2018] [TELETASK BVBA]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md

+187
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,187 @@
1+
# ONVIF-Java
2+
---
3+
4+
<p align="center">
5+
<img src="https://botw-pd.s3.amazonaws.com/styles/logo-thumbnail/s3/112012/onvif-converted.png?itok=yqR6_a6G">
6+
</p>
7+
8+
ONVIF is an open industry forum that provides and promotes standardized interfaces for effective interoperability of IP-based physical security products. ONVIF was created to make a standard way of how IP products within CCTV and other security areas can communicate with each other.
9+
10+
11+
## Features
12+
13+
- **ONVIF & UPnP discovery**
14+
- ONVIF device management (Services, device information, media profiles, raw media stream uri,...)
15+
- UPnP device information
16+
- Easily extendable with your own requests
17+
- **Android supported!**
18+
19+
## Discovery
20+
---
21+
The OnvifDiscovery class uses the **Web Services Dynamic Discovery (WS-Discovery)**. This is a technical specification that defines a multicast discovery protocol to locate services on a local network. It operates over TCP and UDP port ```3702``` and uses IP multicast address ```239.255.255.250```. As the name suggests, the actual communication between nodes is done using web services standards, notably **SOAP-over-UDP**.
22+
23+
With WS-Discovery, the discovery tool puts SSDP queries on the network from its unicast address to ```239.255.255.250``` multicast address, sending them to the well-known UDP port 3702. The device receives the query, and answers to the discovery tool's unicast IP address from its unicast IP address. The reply contains information about the Web Services (WS) available on the device.
24+
25+
**UPnP** works in a very similar way, but on a different UDP port (```1900```).
26+
Compared to the WS-Discovery, the UPnP is intended for a general use (data sharing, communication, entertainment).
27+
28+
```java
29+
DiscoveryManager manager = new DiscoveryManager();
30+
manager.setDiscoveryTimeout(10000);
31+
manager.discover(new DiscoveryListener() {
32+
@Override
33+
public void onDiscoveryStarted() {
34+
System.out.println("Discovery started");
35+
}
36+
37+
@Override
38+
public void onDevicesFound(List<Device> devices) {
39+
for (Device device : devices)
40+
System.out.println("Devices found: " + device.getHostName());
41+
}
42+
});
43+
```
44+
45+
## ONVIF
46+
---
47+
48+
With the ```OnvifManager``` class it is possible to send requests to an ONVIF-supported device. All requests are sent asynchronously and you can use the ```OnvifResponseListener``` for errors and custom response handling. It is possible to create your own ```OnvifDevice``` or retrieve a list from the ```discover``` method in the ```DiscoveryManager```
49+
50+
```java
51+
onvifManager = new OnvifManager();
52+
onvifManager.setOnvifResponseListener(this);
53+
OnvifDevice device = new OnvifDevice("192.168.0.131", "username", "password");
54+
```
55+
56+
### Services
57+
Returns information about services on the device.
58+
59+
```java
60+
onvifManager.getServices(device, new OnvifServicesListener() {
61+
@Override
62+
public void onServicesReceived(@Nonnull OnvifDevice onvifDevice, OnvifServices services) {
63+
64+
}
65+
});
66+
```
67+
68+
### Device information
69+
Returns basic device information from the device. This includes the manufacturer, serial number, hardwareId, ...
70+
71+
```java
72+
onvifManager.getDeviceInformation(device, new OnvifDeviceInformationListener() {
73+
@Override
74+
public void onDeviceInformationReceived(@Nonnull OnvifDevice device,
75+
@Nonnull OnvifDeviceInformation deviceInformation) {
76+
77+
}
78+
});
79+
```
80+
81+
### Media Profiles
82+
Returns pre-configured or dynamically configured profiles. This command lists all configured profiles in a device. The client does not need to know the media profile in order to use the command.
83+
84+
```java
85+
onvifManager.getMediaProfiles(device, new OnvifMediaProfilesListener() {
86+
@Override
87+
public void onMediaProfilesReceived(@Nonnull OnvifDevice device,
88+
@Nonnull List<OnvifMediaProfile> mediaProfiles) {
89+
90+
}
91+
});
92+
```
93+
94+
### Media Stream URI
95+
Returns a raw media stream URI that remains valid indefinitely even if the profile is changed.
96+
97+
```java
98+
onvifManager.getMediaStreamURI(device, mediaProfiles.get(0), new OnvifMediaStreamURIListener() {
99+
@Override
100+
public void onMediaStreamURIReceived(@Nonnull OnvifDevice device,
101+
@Nonnull OnvifMediaProfile profile, @Nonnull String uri) {
102+
103+
}
104+
});
105+
```
106+
107+
## Custom requests
108+
---
109+
110+
It is possible to implement your custom ONVIF request by creating a new class and implementing the ```OnvifRequest``` interface and overriding the ```getXml()``` and ```getType()``` methods.
111+
112+
```java
113+
public class PTZRequest implements OnvifRequest {
114+
@Override
115+
public String getXml() {
116+
return "<GetServices xmlns=\"http://www.onvif.org/ver10/device/wsdl\">" +
117+
"<IncludeCapability>false</IncludeCapability>" +
118+
"</GetServices>";
119+
}
120+
@Override
121+
public OnvifType getType() {
122+
return OnvifType.CUSTOM;
123+
}
124+
}
125+
```
126+
127+
and send it to the appropriate ```OnvifDevice```:
128+
129+
```java
130+
onvifManager.sendOnvifRequest(device, new PTZRequest());
131+
```
132+
133+
## Android
134+
---
135+
In order to receive multicasts packets on your Android device, you'll have to acquire a lock on your WifiManager before making a discovery. Make sure to release the lock once the discovery is completed. More information can be found here: https://developer.android.com/reference/android/net/wifi/WifiManager.MulticastLock
136+
137+
```java
138+
private void lockMulticast() {
139+
WifiManager wifi = (WifiManager) getApplicationContext().getSystemService(Context.WIFI_SERVICE);
140+
if (wifi == null)
141+
return;
142+
143+
WifiManager.MulticastLock lock = wifi.createMulticastLock("ONVIF");
144+
lock.acquire();
145+
}
146+
```
147+
148+
Download
149+
--------
150+
151+
Download [the latest JAR][2] or grab via Maven:
152+
```xml
153+
<dependency>
154+
<groupId>be.teletask.onvif</groupId>
155+
<artifactId>onvif</artifactId>
156+
<version>1.0.0</version>
157+
</dependency>
158+
```
159+
or Gradle:
160+
```groovy
161+
compile 'be.teletask.onvif:onvif:1.0.0'
162+
```
163+
164+
## Todos
165+
166+
- Implementation ONVIF version management
167+
- Implementation PTZ
168+
169+
License
170+
=======
171+
172+
Copyright 2018 TELETASK BVBA.
173+
174+
Licensed under the Apache License, Version 2.0 (the "License");
175+
you may not use this file except in compliance with the License.
176+
You may obtain a copy of the License at
177+
178+
http://www.apache.org/licenses/LICENSE-2.0
179+
180+
Unless required by applicable law or agreed to in writing, software
181+
distributed under the License is distributed on an "AS IS" BASIS,
182+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
183+
See the License for the specific language governing permissions and
184+
limitations under the License.
185+
186+
[2]: https://search.maven.org/remote_content?g=com.squareup.retrofit2&a=retrofit&v=LATEST
187+

0 commit comments

Comments
 (0)
This repository has been archived.