Skip to content

Commit

Permalink
onvif docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
elsampsa committed Jan 17, 2024
1 parent c48350c commit 0908ba5
Show file tree
Hide file tree
Showing 43 changed files with 361 additions and 315 deletions.
Binary file modified docs/_build/doctrees/onvif.doctree
Binary file not shown.
18 changes: 9 additions & 9 deletions docs/_build/html/_sources/onvif.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Onvif and discovery come in a `separate python package <https://github.com/elsam

::

pip install valkka-onvif
pip install -U valkka-onvif


Intro
Expand All @@ -38,13 +38,13 @@ You also need this table to get started:
=========================================== ======================== ======================== =================
WSDL Declaration Camera http sub address Wsdl file Subclass
=========================================== ======================== ======================== =================
http://www.onvif.org/ver10/device/wsdl device_service devicemgmt.wsdl DeviceManagement
http://www.onvif.org/ver10/media/wsdl Media media.wsdl Media
http://www.onvif.org/ver10/events/wsdl Events events.wsdl Events
http://www.onvif.org/ver20/ptz/wsdl PTZ ptz.wsdl PTZ
http://www.onvif.org/ver20/imaging/wsdl Imaging imaging.wsdl Imaging
http://www.onvif.org/ver10/deviceIO/wsdl DeviceIO deviceio.wsdl DeviceIO
http://www.onvif.org/ver20/analytics/wsdl Analytics analytics.wsdl Analytics
http://www.onvif.org/ver10/device/wsdl device_service devicemgmt-10.wsdl DeviceManagement
http://www.onvif.org/ver10/media/wsdl Media media-10.wsdl Media
http://www.onvif.org/ver10/events/wsdl Events events-10.wsdl Events
http://www.onvif.org/ver20/ptz/wsdl PTZ ptz-20.wsdl PTZ
http://www.onvif.org/ver20/imaging/wsdl Imaging imaging-20.wsdl Imaging
http://www.onvif.org/ver10/deviceIO/wsdl DeviceIO deviceio-10.wsdl DeviceIO
http://www.onvif.org/ver20/analytics/wsdl Analytics analytics-20.wsdl Analytics
=========================================== ======================== ======================== =================

Here is an example on how to create your own class for an OnVif device service, based on the class ``OnVif``:
Expand All @@ -60,7 +60,7 @@ The things you need for subclassing an OnVif service are:
- The remote control protocol is declared / visualized in the link at the first column. Go to ``http://www.onvif.org/ver10/device/wsdl`` to see the detailed specifications.
- In that specification, we see that the WSDL "port" is ``DeviceBinding``.
- Each SOAP remote control protocol comes with a certain namespace. This is the same as that address in the first column, so we set ``namespace`` to ``http://www.onvif.org/ver10/device/wsdl``.
- We use *local modified versions of the wsdl files.* This can be found in the third column, i.e. set ``wsdl_file`` to ``devicemgmt.wsdl`` (these files are included in `valkka-onvif <https://github.com/elsampsa/valkka-onvif/tree/master/valkka/onvif/wsdl>`_).
- We use *local modified versions of the wsdl files.* This can be found in the third column, i.e. set ``wsdl_file`` to ``devicemgmt-10.wsdl`` (these files are included in `valkka-onvif <https://github.com/elsampsa/valkka-onvif/tree/master/valkka/onvif/wsdl>`_).
- Camera's local http subaddress ``sub_xaddr`` is ``device_service`` (the second column of the table)

Check out for an example subclass in `here <https://github.com/elsampsa/valkka-onvif/blob/master/valkka/onvif/base.py#L135>`_.
Expand Down
23 changes: 14 additions & 9 deletions docs/_build/html/_static/alabaster.css
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,11 @@ div.relations {
}


div.sphinxsidebar {
max-height: 100%;
overflow-y: auto;
}

div.sphinxsidebar a {
color: #444;
text-decoration: none;
Expand Down Expand Up @@ -155,6 +160,14 @@ div.sphinxsidebar input {
font-size: 1em;
}

div.sphinxsidebar #searchbox input[type="text"] {
width: 160px;
}

div.sphinxsidebar .search > div {
display: table-cell;
}

div.sphinxsidebar hr {
border: none;
height: 1px;
Expand Down Expand Up @@ -638,15 +651,7 @@ a:hover tt, a:hover code {
display: none!important;
}

/* Make nested-list/multi-paragraph items look better in Releases changelog
* pages. Without this, docutils' magical list fuckery causes inconsistent
* formatting between different release sub-lists.
*/
div#changelog > div.section > ul > li > p:only-child {
margin-bottom: 0;
}

/* Hide fugly table cell borders in ..bibliography:: directive output */
/* Hide ugly table cell borders in ..bibliography:: directive output */
table.docutils.citation, table.docutils.citation td, table.docutils.citation th {
border: none;
/* Below needed in some edge cases; if not applied, bottom shadows appear */
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ table.modindextable td {
/* -- general body styles --------------------------------------------------- */

div.body {
min-width: 360px;
min-width: inherit;
max-width: 100%;
}

Expand Down
17 changes: 9 additions & 8 deletions docs/_build/html/authors.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<title>Authors &#8212; Python Media Streaming Framework for Linux documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=1c8f121f" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=e785833e" />
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
Expand All @@ -18,8 +18,9 @@

<link rel="stylesheet" href="_static/custom.css" type="text/css" />




<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head><body>

Expand Down Expand Up @@ -120,11 +121,11 @@ <h3 id="searchlabel">Quick search</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2017-2020 Sampsa Riikonen.
&#169;2017-2020 Sampsa Riikonen.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.2.6</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.15</a>

|
<a href="_sources/authors.rst.txt"
Expand All @@ -134,7 +135,7 @@ <h3 id="searchlabel">Quick search</h3>



<script type="text/javascript">
<script>

var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-123031237-1']);
Expand All @@ -143,8 +144,8 @@ <h3 id="searchlabel">Quick search</h3>
_gaq.push(['_trackPageview']);

(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var ga = document.createElement('script'); ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'https://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();

Expand Down
17 changes: 9 additions & 8 deletions docs/_build/html/benchmarking.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<title>Benchmarking &#8212; Python Media Streaming Framework for Linux documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=1c8f121f" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=e785833e" />
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
Expand All @@ -16,8 +16,9 @@

<link rel="stylesheet" href="_static/custom.css" type="text/css" />




<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head><body>

Expand Down Expand Up @@ -234,11 +235,11 @@ <h3 id="searchlabel">Quick search</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2017-2020 Sampsa Riikonen.
&#169;2017-2020 Sampsa Riikonen.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.2.6</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.15</a>

|
<a href="_sources/benchmarking.rst.txt"
Expand All @@ -248,7 +249,7 @@ <h3 id="searchlabel">Quick search</h3>



<script type="text/javascript">
<script>

var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-123031237-1']);
Expand All @@ -257,8 +258,8 @@ <h3 id="searchlabel">Quick search</h3>
_gaq.push(['_trackPageview']);

(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var ga = document.createElement('script'); ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'https://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();

Expand Down
17 changes: 9 additions & 8 deletions docs/_build/html/cloud.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<title>Cloud Streaming &#8212; Python Media Streaming Framework for Linux documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=1c8f121f" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=e785833e" />
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
Expand All @@ -18,8 +18,9 @@

<link rel="stylesheet" href="_static/custom.css" type="text/css" />




<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head><body>

Expand Down Expand Up @@ -144,11 +145,11 @@ <h3 id="searchlabel">Quick search</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2017-2020 Sampsa Riikonen.
&#169;2017-2020 Sampsa Riikonen.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.2.6</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.15</a>

|
<a href="_sources/cloud.rst.txt"
Expand All @@ -158,7 +159,7 @@ <h3 id="searchlabel">Quick search</h3>



<script type="text/javascript">
<script>

var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-123031237-1']);
Expand All @@ -167,8 +168,8 @@ <h3 id="searchlabel">Quick search</h3>
_gaq.push(['_trackPageview']);

(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var ga = document.createElement('script'); ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'https://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();

Expand Down
17 changes: 9 additions & 8 deletions docs/_build/html/debugging.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<title>Debugging &#8212; Python Media Streaming Framework for Linux documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=1c8f121f" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=e785833e" />
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
Expand All @@ -18,8 +18,9 @@

<link rel="stylesheet" href="_static/custom.css" type="text/css" />




<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head><body>

Expand Down Expand Up @@ -158,11 +159,11 @@ <h3 id="searchlabel">Quick search</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2017-2020 Sampsa Riikonen.
&#169;2017-2020 Sampsa Riikonen.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.2.6</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.15</a>

|
<a href="_sources/debugging.rst.txt"
Expand All @@ -172,7 +173,7 @@ <h3 id="searchlabel">Quick search</h3>



<script type="text/javascript">
<script>

var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-123031237-1']);
Expand All @@ -181,8 +182,8 @@ <h3 id="searchlabel">Quick search</h3>
_gaq.push(['_trackPageview']);

(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var ga = document.createElement('script'); ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'https://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();

Expand Down
17 changes: 9 additions & 8 deletions docs/_build/html/decoding.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<title>Decoding &#8212; Python Media Streaming Framework for Linux documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=1c8f121f" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=e785833e" />
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
Expand All @@ -18,8 +18,9 @@

<link rel="stylesheet" href="_static/custom.css" type="text/css" />




<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head><body>

Expand Down Expand Up @@ -191,11 +192,11 @@ <h3 id="searchlabel">Quick search</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2017-2020 Sampsa Riikonen.
&#169;2017-2020 Sampsa Riikonen.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.2.6</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.15</a>

|
<a href="_sources/decoding.rst.txt"
Expand All @@ -205,7 +206,7 @@ <h3 id="searchlabel">Quick search</h3>



<script type="text/javascript">
<script>

var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-123031237-1']);
Expand All @@ -214,8 +215,8 @@ <h3 id="searchlabel">Quick search</h3>
_gaq.push(['_trackPageview']);

(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var ga = document.createElement('script'); ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'https://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();

Expand Down
Loading

0 comments on commit 0908ba5

Please sign in to comment.