+
+ Read the Docs
+ v: ${config.versions.current.slug}
+
+
+
+ ${renderLanguages(config)}
+ ${renderVersions(config)}
+ ${renderDownloads(config)}
+
+ On Read the Docs
+
+ Project Home
+
+
+ Builds
+
+
+ Downloads
+
+
+
+ Search
+
+
+
+
+
+
+ Hosted by Read the Docs
+
+
+
+ `;
+
+ // Inject the generated flyout into the body HTML element.
+ document.body.insertAdjacentHTML("beforeend", flyout);
+
+ // Trigger the Read the Docs Addons Search modal when clicking on the "Search docs" input from inside the flyout.
+ document
+ .querySelector("#flyout-search-form")
+ .addEventListener("focusin", () => {
+ const event = new CustomEvent("readthedocs-search-show");
+ document.dispatchEvent(event);
+ });
+ })
+}
+
+if (themeLanguageSelector || themeVersionSelector) {
+ function onSelectorSwitch(event) {
+ const option = event.target.selectedIndex;
+ const item = event.target.options[option];
+ window.location.href = item.dataset.url;
+ }
+
+ document.addEventListener("readthedocs-addons-data-ready", function (event) {
+ const config = event.detail.data();
+
+ const versionSwitch = document.querySelector(
+ "div.switch-menus > div.version-switch",
+ );
+ if (themeVersionSelector) {
+ let versions = config.versions.active;
+ if (config.versions.current.hidden || config.versions.current.type === "external") {
+ versions.unshift(config.versions.current);
+ }
+ const versionSelect = `
+
+ ${versions
+ .map(
+ (version) => `
+
+ ${version.slug}
+ `,
+ )
+ .join("\n")}
+
+ `;
+
+ versionSwitch.innerHTML = versionSelect;
+ versionSwitch.firstElementChild.addEventListener("change", onSelectorSwitch);
+ }
+
+ const languageSwitch = document.querySelector(
+ "div.switch-menus > div.language-switch",
+ );
+
+ if (themeLanguageSelector) {
+ if (config.projects.translations.length) {
+ // Add the current language to the options on the selector
+ let languages = config.projects.translations.concat(
+ config.projects.current,
+ );
+ languages = languages.sort((a, b) =>
+ a.language.name.localeCompare(b.language.name),
+ );
+
+ const languageSelect = `
+
+ ${languages
+ .map(
+ (language) => `
+
+ ${language.language.name}
+ `,
+ )
+ .join("\n")}
+
+ `;
+
+ languageSwitch.innerHTML = languageSelect;
+ languageSwitch.firstElementChild.addEventListener("change", onSelectorSwitch);
+ }
+ else {
+ languageSwitch.remove();
+ }
+ }
+ });
+}
+
+document.addEventListener("readthedocs-addons-data-ready", function (event) {
+ // Trigger the Read the Docs Addons Search modal when clicking on "Search docs" input from the topnav.
+ document
+ .querySelector("[role='search'] input")
+ .addEventListener("focusin", () => {
+ const event = new CustomEvent("readthedocs-search-show");
+ document.dispatchEvent(event);
+ });
+});
\ No newline at end of file
diff --git a/_static/language_data.js b/_static/language_data.js
new file mode 100644
index 00000000..c7fe6c6f
--- /dev/null
+++ b/_static/language_data.js
@@ -0,0 +1,192 @@
+/*
+ * This script contains the language-specific data used by searchtools.js,
+ * namely the list of stopwords, stemmer, scorer and splitter.
+ */
+
+var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
+
+
+/* Non-minified version is copied as a separate JS file, if available */
+
+/**
+ * Porter Stemmer
+ */
+var Stemmer = function() {
+
+ var step2list = {
+ ational: 'ate',
+ tional: 'tion',
+ enci: 'ence',
+ anci: 'ance',
+ izer: 'ize',
+ bli: 'ble',
+ alli: 'al',
+ entli: 'ent',
+ eli: 'e',
+ ousli: 'ous',
+ ization: 'ize',
+ ation: 'ate',
+ ator: 'ate',
+ alism: 'al',
+ iveness: 'ive',
+ fulness: 'ful',
+ ousness: 'ous',
+ aliti: 'al',
+ iviti: 'ive',
+ biliti: 'ble',
+ logi: 'log'
+ };
+
+ var step3list = {
+ icate: 'ic',
+ ative: '',
+ alize: 'al',
+ iciti: 'ic',
+ ical: 'ic',
+ ful: '',
+ ness: ''
+ };
+
+ var c = "[^aeiou]"; // consonant
+ var v = "[aeiouy]"; // vowel
+ var C = c + "[^aeiouy]*"; // consonant sequence
+ var V = v + "[aeiou]*"; // vowel sequence
+
+ var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
+ var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
+ var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
+ var s_v = "^(" + C + ")?" + v; // vowel in stem
+
+ this.stemWord = function (w) {
+ var stem;
+ var suffix;
+ var firstch;
+ var origword = w;
+
+ if (w.length < 3)
+ return w;
+
+ var re;
+ var re2;
+ var re3;
+ var re4;
+
+ firstch = w.substr(0,1);
+ if (firstch == "y")
+ w = firstch.toUpperCase() + w.substr(1);
+
+ // Step 1a
+ re = /^(.+?)(ss|i)es$/;
+ re2 = /^(.+?)([^s])s$/;
+
+ if (re.test(w))
+ w = w.replace(re,"$1$2");
+ else if (re2.test(w))
+ w = w.replace(re2,"$1$2");
+
+ // Step 1b
+ re = /^(.+?)eed$/;
+ re2 = /^(.+?)(ed|ing)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ re = new RegExp(mgr0);
+ if (re.test(fp[1])) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+ }
+ else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1];
+ re2 = new RegExp(s_v);
+ if (re2.test(stem)) {
+ w = stem;
+ re2 = /(at|bl|iz)$/;
+ re3 = new RegExp("([^aeiouylsz])\\1$");
+ re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+ if (re2.test(w))
+ w = w + "e";
+ else if (re3.test(w)) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+ else if (re4.test(w))
+ w = w + "e";
+ }
+ }
+
+ // Step 1c
+ re = /^(.+?)y$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(s_v);
+ if (re.test(stem))
+ w = stem + "i";
+ }
+
+ // Step 2
+ re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = new RegExp(mgr0);
+ if (re.test(stem))
+ w = stem + step2list[suffix];
+ }
+
+ // Step 3
+ re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = new RegExp(mgr0);
+ if (re.test(stem))
+ w = stem + step3list[suffix];
+ }
+
+ // Step 4
+ re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
+ re2 = /^(.+?)(s|t)(ion)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(mgr1);
+ if (re.test(stem))
+ w = stem;
+ }
+ else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1] + fp[2];
+ re2 = new RegExp(mgr1);
+ if (re2.test(stem))
+ w = stem;
+ }
+
+ // Step 5
+ re = /^(.+?)e$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(mgr1);
+ re2 = new RegExp(meq1);
+ re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+ if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
+ w = stem;
+ }
+ re = /ll$/;
+ re2 = new RegExp(mgr1);
+ if (re.test(w) && re2.test(w)) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+
+ // and turn initial Y back to y
+ if (firstch == "y")
+ w = firstch.toLowerCase() + w.substr(1);
+ return w;
+ }
+}
+
diff --git a/_static/minus.png b/_static/minus.png
new file mode 100644
index 00000000..d96755fd
Binary files /dev/null and b/_static/minus.png differ
diff --git a/_static/plus.png b/_static/plus.png
new file mode 100644
index 00000000..7107cec9
Binary files /dev/null and b/_static/plus.png differ
diff --git a/_static/pygments.css b/_static/pygments.css
new file mode 100644
index 00000000..84ab3030
--- /dev/null
+++ b/_static/pygments.css
@@ -0,0 +1,75 @@
+pre { line-height: 125%; }
+td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+.highlight .hll { background-color: #ffffcc }
+.highlight { background: #f8f8f8; }
+.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */
+.highlight .err { border: 1px solid #FF0000 } /* Error */
+.highlight .k { color: #008000; font-weight: bold } /* Keyword */
+.highlight .o { color: #666666 } /* Operator */
+.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */
+.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #9C6500 } /* Comment.Preproc */
+.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */
+.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */
+.highlight .gd { color: #A00000 } /* Generic.Deleted */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
+.highlight .gr { color: #E40000 } /* Generic.Error */
+.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
+.highlight .gi { color: #008400 } /* Generic.Inserted */
+.highlight .go { color: #717171 } /* Generic.Output */
+.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+.highlight .gt { color: #0044DD } /* Generic.Traceback */
+.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
+.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
+.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
+.highlight .kp { color: #008000 } /* Keyword.Pseudo */
+.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #B00040 } /* Keyword.Type */
+.highlight .m { color: #666666 } /* Literal.Number */
+.highlight .s { color: #BA2121 } /* Literal.String */
+.highlight .na { color: #687822 } /* Name.Attribute */
+.highlight .nb { color: #008000 } /* Name.Builtin */
+.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
+.highlight .no { color: #880000 } /* Name.Constant */
+.highlight .nd { color: #AA22FF } /* Name.Decorator */
+.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */
+.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #0000FF } /* Name.Function */
+.highlight .nl { color: #767600 } /* Name.Label */
+.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
+.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
+.highlight .nv { color: #19177C } /* Name.Variable */
+.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mb { color: #666666 } /* Literal.Number.Bin */
+.highlight .mf { color: #666666 } /* Literal.Number.Float */
+.highlight .mh { color: #666666 } /* Literal.Number.Hex */
+.highlight .mi { color: #666666 } /* Literal.Number.Integer */
+.highlight .mo { color: #666666 } /* Literal.Number.Oct */
+.highlight .sa { color: #BA2121 } /* Literal.String.Affix */
+.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
+.highlight .sc { color: #BA2121 } /* Literal.String.Char */
+.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */
+.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
+.highlight .s2 { color: #BA2121 } /* Literal.String.Double */
+.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */
+.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
+.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */
+.highlight .sx { color: #008000 } /* Literal.String.Other */
+.highlight .sr { color: #A45A77 } /* Literal.String.Regex */
+.highlight .s1 { color: #BA2121 } /* Literal.String.Single */
+.highlight .ss { color: #19177C } /* Literal.String.Symbol */
+.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
+.highlight .fm { color: #0000FF } /* Name.Function.Magic */
+.highlight .vc { color: #19177C } /* Name.Variable.Class */
+.highlight .vg { color: #19177C } /* Name.Variable.Global */
+.highlight .vi { color: #19177C } /* Name.Variable.Instance */
+.highlight .vm { color: #19177C } /* Name.Variable.Magic */
+.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */
\ No newline at end of file
diff --git a/_static/searchtools.js b/_static/searchtools.js
new file mode 100644
index 00000000..2c774d17
--- /dev/null
+++ b/_static/searchtools.js
@@ -0,0 +1,632 @@
+/*
+ * Sphinx JavaScript utilities for the full-text search.
+ */
+"use strict";
+
+/**
+ * Simple result scoring code.
+ */
+if (typeof Scorer === "undefined") {
+ var Scorer = {
+ // Implement the following function to further tweak the score for each result
+ // The function takes a result array [docname, title, anchor, descr, score, filename]
+ // and returns the new score.
+ /*
+ score: result => {
+ const [docname, title, anchor, descr, score, filename, kind] = result
+ return score
+ },
+ */
+
+ // query matches the full name of an object
+ objNameMatch: 11,
+ // or matches in the last dotted part of the object name
+ objPartialMatch: 6,
+ // Additive scores depending on the priority of the object
+ objPrio: {
+ 0: 15, // used to be importantResults
+ 1: 5, // used to be objectResults
+ 2: -5, // used to be unimportantResults
+ },
+ // Used when the priority is not in the mapping.
+ objPrioDefault: 0,
+
+ // query found in title
+ title: 15,
+ partialTitle: 7,
+ // query found in terms
+ term: 5,
+ partialTerm: 2,
+ };
+}
+
+// Global search result kind enum, used by themes to style search results.
+class SearchResultKind {
+ static get index() { return "index"; }
+ static get object() { return "object"; }
+ static get text() { return "text"; }
+ static get title() { return "title"; }
+}
+
+const _removeChildren = (element) => {
+ while (element && element.lastChild) element.removeChild(element.lastChild);
+};
+
+/**
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
+ */
+const _escapeRegExp = (string) =>
+ string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
+
+const _displayItem = (item, searchTerms, highlightTerms) => {
+ const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
+ const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
+ const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
+ const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
+ const contentRoot = document.documentElement.dataset.content_root;
+
+ const [docName, title, anchor, descr, score, _filename, kind] = item;
+
+ let listItem = document.createElement("li");
+ // Add a class representing the item's type:
+ // can be used by a theme's CSS selector for styling
+ // See SearchResultKind for the class names.
+ listItem.classList.add(`kind-${kind}`);
+ let requestUrl;
+ let linkUrl;
+ if (docBuilder === "dirhtml") {
+ // dirhtml builder
+ let dirname = docName + "/";
+ if (dirname.match(/\/index\/$/))
+ dirname = dirname.substring(0, dirname.length - 6);
+ else if (dirname === "index/") dirname = "";
+ requestUrl = contentRoot + dirname;
+ linkUrl = requestUrl;
+ } else {
+ // normal html builders
+ requestUrl = contentRoot + docName + docFileSuffix;
+ linkUrl = docName + docLinkSuffix;
+ }
+ let linkEl = listItem.appendChild(document.createElement("a"));
+ linkEl.href = linkUrl + anchor;
+ linkEl.dataset.score = score;
+ linkEl.innerHTML = title;
+ if (descr) {
+ listItem.appendChild(document.createElement("span")).innerHTML =
+ " (" + descr + ")";
+ // highlight search terms in the description
+ if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
+ highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
+ }
+ else if (showSearchSummary)
+ fetch(requestUrl)
+ .then((responseData) => responseData.text())
+ .then((data) => {
+ if (data)
+ listItem.appendChild(
+ Search.makeSearchSummary(data, searchTerms, anchor)
+ );
+ // highlight search terms in the summary
+ if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
+ highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
+ });
+ Search.output.appendChild(listItem);
+};
+const _finishSearch = (resultCount) => {
+ Search.stopPulse();
+ Search.title.innerText = _("Search Results");
+ if (!resultCount)
+ Search.status.innerText = Documentation.gettext(
+ "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
+ );
+ else
+ Search.status.innerText = Documentation.ngettext(
+ "Search finished, found one page matching the search query.",
+ "Search finished, found ${resultCount} pages matching the search query.",
+ resultCount,
+ ).replace('${resultCount}', resultCount);
+};
+const _displayNextItem = (
+ results,
+ resultCount,
+ searchTerms,
+ highlightTerms,
+) => {
+ // results left, load the summary and display it
+ // this is intended to be dynamic (don't sub resultsCount)
+ if (results.length) {
+ _displayItem(results.pop(), searchTerms, highlightTerms);
+ setTimeout(
+ () => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
+ 5
+ );
+ }
+ // search finished, update title and status message
+ else _finishSearch(resultCount);
+};
+// Helper function used by query() to order search results.
+// Each input is an array of [docname, title, anchor, descr, score, filename, kind].
+// Order the results by score (in opposite order of appearance, since the
+// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically.
+const _orderResultsByScoreThenName = (a, b) => {
+ const leftScore = a[4];
+ const rightScore = b[4];
+ if (leftScore === rightScore) {
+ // same score: sort alphabetically
+ const leftTitle = a[1].toLowerCase();
+ const rightTitle = b[1].toLowerCase();
+ if (leftTitle === rightTitle) return 0;
+ return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
+ }
+ return leftScore > rightScore ? 1 : -1;
+};
+
+/**
+ * Default splitQuery function. Can be overridden in ``sphinx.search`` with a
+ * custom function per language.
+ *
+ * The regular expression works by splitting the string on consecutive characters
+ * that are not Unicode letters, numbers, underscores, or emoji characters.
+ * This is the same as ``\W+`` in Python, preserving the surrogate pair area.
+ */
+if (typeof splitQuery === "undefined") {
+ var splitQuery = (query) => query
+ .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu)
+ .filter(term => term) // remove remaining empty strings
+}
+
+/**
+ * Search Module
+ */
+const Search = {
+ _index: null,
+ _queued_query: null,
+ _pulse_status: -1,
+
+ htmlToText: (htmlString, anchor) => {
+ const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
+ for (const removalQuery of [".headerlink", "script", "style"]) {
+ htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
+ }
+ if (anchor) {
+ const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`);
+ if (anchorContent) return anchorContent.textContent;
+
+ console.warn(
+ `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.`
+ );
+ }
+
+ // if anchor not specified or not found, fall back to main content
+ const docContent = htmlElement.querySelector('[role="main"]');
+ if (docContent) return docContent.textContent;
+
+ console.warn(
+ "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template."
+ );
+ return "";
+ },
+
+ init: () => {
+ const query = new URLSearchParams(window.location.search).get("q");
+ document
+ .querySelectorAll('input[name="q"]')
+ .forEach((el) => (el.value = query));
+ if (query) Search.performSearch(query);
+ },
+
+ loadIndex: (url) =>
+ (document.body.appendChild(document.createElement("script")).src = url),
+
+ setIndex: (index) => {
+ Search._index = index;
+ if (Search._queued_query !== null) {
+ const query = Search._queued_query;
+ Search._queued_query = null;
+ Search.query(query);
+ }
+ },
+
+ hasIndex: () => Search._index !== null,
+
+ deferQuery: (query) => (Search._queued_query = query),
+
+ stopPulse: () => (Search._pulse_status = -1),
+
+ startPulse: () => {
+ if (Search._pulse_status >= 0) return;
+
+ const pulse = () => {
+ Search._pulse_status = (Search._pulse_status + 1) % 4;
+ Search.dots.innerText = ".".repeat(Search._pulse_status);
+ if (Search._pulse_status >= 0) window.setTimeout(pulse, 500);
+ };
+ pulse();
+ },
+
+ /**
+ * perform a search for something (or wait until index is loaded)
+ */
+ performSearch: (query) => {
+ // create the required interface elements
+ const searchText = document.createElement("h2");
+ searchText.textContent = _("Searching");
+ const searchSummary = document.createElement("p");
+ searchSummary.classList.add("search-summary");
+ searchSummary.innerText = "";
+ const searchList = document.createElement("ul");
+ searchList.setAttribute("role", "list");
+ searchList.classList.add("search");
+
+ const out = document.getElementById("search-results");
+ Search.title = out.appendChild(searchText);
+ Search.dots = Search.title.appendChild(document.createElement("span"));
+ Search.status = out.appendChild(searchSummary);
+ Search.output = out.appendChild(searchList);
+
+ const searchProgress = document.getElementById("search-progress");
+ // Some themes don't use the search progress node
+ if (searchProgress) {
+ searchProgress.innerText = _("Preparing search...");
+ }
+ Search.startPulse();
+
+ // index already loaded, the browser was quick!
+ if (Search.hasIndex()) Search.query(query);
+ else Search.deferQuery(query);
+ },
+
+ _parseQuery: (query) => {
+ // stem the search terms and add them to the correct list
+ const stemmer = new Stemmer();
+ const searchTerms = new Set();
+ const excludedTerms = new Set();
+ const highlightTerms = new Set();
+ const objectTerms = new Set(splitQuery(query.toLowerCase().trim()));
+ splitQuery(query.trim()).forEach((queryTerm) => {
+ const queryTermLower = queryTerm.toLowerCase();
+
+ // maybe skip this "word"
+ // stopwords array is from language_data.js
+ if (
+ stopwords.indexOf(queryTermLower) !== -1 ||
+ queryTerm.match(/^\d+$/)
+ )
+ return;
+
+ // stem the word
+ let word = stemmer.stemWord(queryTermLower);
+ // select the correct list
+ if (word[0] === "-") excludedTerms.add(word.substr(1));
+ else {
+ searchTerms.add(word);
+ highlightTerms.add(queryTermLower);
+ }
+ });
+
+ if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js
+ localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" "))
+ }
+
+ // console.debug("SEARCH: searching for:");
+ // console.info("required: ", [...searchTerms]);
+ // console.info("excluded: ", [...excludedTerms]);
+
+ return [query, searchTerms, excludedTerms, highlightTerms, objectTerms];
+ },
+
+ /**
+ * execute search (requires search index to be loaded)
+ */
+ _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => {
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const titles = Search._index.titles;
+ const allTitles = Search._index.alltitles;
+ const indexEntries = Search._index.indexentries;
+
+ // Collect multiple result groups to be sorted separately and then ordered.
+ // Each is an array of [docname, title, anchor, descr, score, filename, kind].
+ const normalResults = [];
+ const nonMainIndexResults = [];
+
+ _removeChildren(document.getElementById("search-progress"));
+
+ const queryLower = query.toLowerCase().trim();
+ for (const [title, foundTitles] of Object.entries(allTitles)) {
+ if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
+ for (const [file, id] of foundTitles) {
+ const score = Math.round(Scorer.title * queryLower.length / title.length);
+ const boost = titles[file] === title ? 1 : 0; // add a boost for document titles
+ normalResults.push([
+ docNames[file],
+ titles[file] !== title ? `${titles[file]} > ${title}` : title,
+ id !== null ? "#" + id : "",
+ null,
+ score + boost,
+ filenames[file],
+ SearchResultKind.title,
+ ]);
+ }
+ }
+ }
+
+ // search for explicit entries in index directives
+ for (const [entry, foundEntries] of Object.entries(indexEntries)) {
+ if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
+ for (const [file, id, isMain] of foundEntries) {
+ const score = Math.round(100 * queryLower.length / entry.length);
+ const result = [
+ docNames[file],
+ titles[file],
+ id ? "#" + id : "",
+ null,
+ score,
+ filenames[file],
+ SearchResultKind.index,
+ ];
+ if (isMain) {
+ normalResults.push(result);
+ } else {
+ nonMainIndexResults.push(result);
+ }
+ }
+ }
+ }
+
+ // lookup as object
+ objectTerms.forEach((term) =>
+ normalResults.push(...Search.performObjectSearch(term, objectTerms))
+ );
+
+ // lookup as search terms in fulltext
+ normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms));
+
+ // let the scorer override scores with a custom scoring function
+ if (Scorer.score) {
+ normalResults.forEach((item) => (item[4] = Scorer.score(item)));
+ nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item)));
+ }
+
+ // Sort each group of results by score and then alphabetically by name.
+ normalResults.sort(_orderResultsByScoreThenName);
+ nonMainIndexResults.sort(_orderResultsByScoreThenName);
+
+ // Combine the result groups in (reverse) order.
+ // Non-main index entries are typically arbitrary cross-references,
+ // so display them after other results.
+ let results = [...nonMainIndexResults, ...normalResults];
+
+ // remove duplicate search results
+ // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
+ let seen = new Set();
+ results = results.reverse().reduce((acc, result) => {
+ let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(',');
+ if (!seen.has(resultStr)) {
+ acc.push(result);
+ seen.add(resultStr);
+ }
+ return acc;
+ }, []);
+
+ return results.reverse();
+ },
+
+ query: (query) => {
+ const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query);
+ const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms);
+
+ // for debugging
+ //Search.lastresults = results.slice(); // a copy
+ // console.info("search results:", Search.lastresults);
+
+ // print the results
+ _displayNextItem(results, results.length, searchTerms, highlightTerms);
+ },
+
+ /**
+ * search for object names
+ */
+ performObjectSearch: (object, objectTerms) => {
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const objects = Search._index.objects;
+ const objNames = Search._index.objnames;
+ const titles = Search._index.titles;
+
+ const results = [];
+
+ const objectSearchCallback = (prefix, match) => {
+ const name = match[4]
+ const fullname = (prefix ? prefix + "." : "") + name;
+ const fullnameLower = fullname.toLowerCase();
+ if (fullnameLower.indexOf(object) < 0) return;
+
+ let score = 0;
+ const parts = fullnameLower.split(".");
+
+ // check for different match types: exact matches of full name or
+ // "last name" (i.e. last dotted part)
+ if (fullnameLower === object || parts.slice(-1)[0] === object)
+ score += Scorer.objNameMatch;
+ else if (parts.slice(-1)[0].indexOf(object) > -1)
+ score += Scorer.objPartialMatch; // matches in last name
+
+ const objName = objNames[match[1]][2];
+ const title = titles[match[0]];
+
+ // If more than one term searched for, we require other words to be
+ // found in the name/title/description
+ const otherTerms = new Set(objectTerms);
+ otherTerms.delete(object);
+ if (otherTerms.size > 0) {
+ const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase();
+ if (
+ [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0)
+ )
+ return;
+ }
+
+ let anchor = match[3];
+ if (anchor === "") anchor = fullname;
+ else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname;
+
+ const descr = objName + _(", in ") + title;
+
+ // add custom score for some objects according to scorer
+ if (Scorer.objPrio.hasOwnProperty(match[2]))
+ score += Scorer.objPrio[match[2]];
+ else score += Scorer.objPrioDefault;
+
+ results.push([
+ docNames[match[0]],
+ fullname,
+ "#" + anchor,
+ descr,
+ score,
+ filenames[match[0]],
+ SearchResultKind.object,
+ ]);
+ };
+ Object.keys(objects).forEach((prefix) =>
+ objects[prefix].forEach((array) =>
+ objectSearchCallback(prefix, array)
+ )
+ );
+ return results;
+ },
+
+ /**
+ * search for full-text terms in the index
+ */
+ performTermsSearch: (searchTerms, excludedTerms) => {
+ // prepare search
+ const terms = Search._index.terms;
+ const titleTerms = Search._index.titleterms;
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const titles = Search._index.titles;
+
+ const scoreMap = new Map();
+ const fileMap = new Map();
+
+ // perform the search on the required terms
+ searchTerms.forEach((word) => {
+ const files = [];
+ const arr = [
+ { files: terms[word], score: Scorer.term },
+ { files: titleTerms[word], score: Scorer.title },
+ ];
+ // add support for partial matches
+ if (word.length > 2) {
+ const escapedWord = _escapeRegExp(word);
+ if (!terms.hasOwnProperty(word)) {
+ Object.keys(terms).forEach((term) => {
+ if (term.match(escapedWord))
+ arr.push({ files: terms[term], score: Scorer.partialTerm });
+ });
+ }
+ if (!titleTerms.hasOwnProperty(word)) {
+ Object.keys(titleTerms).forEach((term) => {
+ if (term.match(escapedWord))
+ arr.push({ files: titleTerms[term], score: Scorer.partialTitle });
+ });
+ }
+ }
+
+ // no match but word was a required one
+ if (arr.every((record) => record.files === undefined)) return;
+
+ // found search word in contents
+ arr.forEach((record) => {
+ if (record.files === undefined) return;
+
+ let recordFiles = record.files;
+ if (recordFiles.length === undefined) recordFiles = [recordFiles];
+ files.push(...recordFiles);
+
+ // set score for the word in each file
+ recordFiles.forEach((file) => {
+ if (!scoreMap.has(file)) scoreMap.set(file, {});
+ scoreMap.get(file)[word] = record.score;
+ });
+ });
+
+ // create the mapping
+ files.forEach((file) => {
+ if (!fileMap.has(file)) fileMap.set(file, [word]);
+ else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word);
+ });
+ });
+
+ // now check if the files don't contain excluded terms
+ const results = [];
+ for (const [file, wordList] of fileMap) {
+ // check if all requirements are matched
+
+ // as search terms with length < 3 are discarded
+ const filteredTermCount = [...searchTerms].filter(
+ (term) => term.length > 2
+ ).length;
+ if (
+ wordList.length !== searchTerms.size &&
+ wordList.length !== filteredTermCount
+ )
+ continue;
+
+ // ensure that none of the excluded terms is in the search result
+ if (
+ [...excludedTerms].some(
+ (term) =>
+ terms[term] === file ||
+ titleTerms[term] === file ||
+ (terms[term] || []).includes(file) ||
+ (titleTerms[term] || []).includes(file)
+ )
+ )
+ break;
+
+ // select one (max) score for the file.
+ const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w]));
+ // add result to the result list
+ results.push([
+ docNames[file],
+ titles[file],
+ "",
+ null,
+ score,
+ filenames[file],
+ SearchResultKind.text,
+ ]);
+ }
+ return results;
+ },
+
+ /**
+ * helper function to return a node containing the
+ * search summary for a given text. keywords is a list
+ * of stemmed words.
+ */
+ makeSearchSummary: (htmlText, keywords, anchor) => {
+ const text = Search.htmlToText(htmlText, anchor);
+ if (text === "") return null;
+
+ const textLower = text.toLowerCase();
+ const actualStartPosition = [...keywords]
+ .map((k) => textLower.indexOf(k.toLowerCase()))
+ .filter((i) => i > -1)
+ .slice(-1)[0];
+ const startWithContext = Math.max(actualStartPosition - 120, 0);
+
+ const top = startWithContext === 0 ? "" : "...";
+ const tail = startWithContext + 240 < text.length ? "..." : "";
+
+ let summary = document.createElement("p");
+ summary.classList.add("context");
+ summary.textContent = top + text.substr(startWithContext, 240).trim() + tail;
+
+ return summary;
+ },
+};
+
+_ready(Search.init);
diff --git a/_static/sphinx_highlight.js b/_static/sphinx_highlight.js
new file mode 100644
index 00000000..8a96c69a
--- /dev/null
+++ b/_static/sphinx_highlight.js
@@ -0,0 +1,154 @@
+/* Highlighting utilities for Sphinx HTML documentation. */
+"use strict";
+
+const SPHINX_HIGHLIGHT_ENABLED = true
+
+/**
+ * highlight a given string on a node by wrapping it in
+ * span elements with the given class name.
+ */
+const _highlight = (node, addItems, text, className) => {
+ if (node.nodeType === Node.TEXT_NODE) {
+ const val = node.nodeValue;
+ const parent = node.parentNode;
+ const pos = val.toLowerCase().indexOf(text);
+ if (
+ pos >= 0 &&
+ !parent.classList.contains(className) &&
+ !parent.classList.contains("nohighlight")
+ ) {
+ let span;
+
+ const closestNode = parent.closest("body, svg, foreignObject");
+ const isInSVG = closestNode && closestNode.matches("svg");
+ if (isInSVG) {
+ span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+ } else {
+ span = document.createElement("span");
+ span.classList.add(className);
+ }
+
+ span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+ const rest = document.createTextNode(val.substr(pos + text.length));
+ parent.insertBefore(
+ span,
+ parent.insertBefore(
+ rest,
+ node.nextSibling
+ )
+ );
+ node.nodeValue = val.substr(0, pos);
+ /* There may be more occurrences of search term in this node. So call this
+ * function recursively on the remaining fragment.
+ */
+ _highlight(rest, addItems, text, className);
+
+ if (isInSVG) {
+ const rect = document.createElementNS(
+ "http://www.w3.org/2000/svg",
+ "rect"
+ );
+ const bbox = parent.getBBox();
+ rect.x.baseVal.value = bbox.x;
+ rect.y.baseVal.value = bbox.y;
+ rect.width.baseVal.value = bbox.width;
+ rect.height.baseVal.value = bbox.height;
+ rect.setAttribute("class", className);
+ addItems.push({ parent: parent, target: rect });
+ }
+ }
+ } else if (node.matches && !node.matches("button, select, textarea")) {
+ node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
+ }
+};
+const _highlightText = (thisNode, text, className) => {
+ let addItems = [];
+ _highlight(thisNode, addItems, text, className);
+ addItems.forEach((obj) =>
+ obj.parent.insertAdjacentElement("beforebegin", obj.target)
+ );
+};
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+const SphinxHighlight = {
+
+ /**
+ * highlight the search words provided in localstorage in the text
+ */
+ highlightSearchWords: () => {
+ if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight
+
+ // get and clear terms from localstorage
+ const url = new URL(window.location);
+ const highlight =
+ localStorage.getItem("sphinx_highlight_terms")
+ || url.searchParams.get("highlight")
+ || "";
+ localStorage.removeItem("sphinx_highlight_terms")
+ url.searchParams.delete("highlight");
+ window.history.replaceState({}, "", url);
+
+ // get individual terms from highlight string
+ const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
+ if (terms.length === 0) return; // nothing to do
+
+ // There should never be more than one element matching "div.body"
+ const divBody = document.querySelectorAll("div.body");
+ const body = divBody.length ? divBody[0] : document.querySelector("body");
+ window.setTimeout(() => {
+ terms.forEach((term) => _highlightText(body, term, "highlighted"));
+ }, 10);
+
+ const searchBox = document.getElementById("searchbox");
+ if (searchBox === null) return;
+ searchBox.appendChild(
+ document
+ .createRange()
+ .createContextualFragment(
+ '
' +
+ '' +
+ _("Hide Search Matches") +
+ "
"
+ )
+ );
+ },
+
+ /**
+ * helper function to hide the search marks again
+ */
+ hideSearchWords: () => {
+ document
+ .querySelectorAll("#searchbox .highlight-link")
+ .forEach((el) => el.remove());
+ document
+ .querySelectorAll("span.highlighted")
+ .forEach((el) => el.classList.remove("highlighted"));
+ localStorage.removeItem("sphinx_highlight_terms")
+ },
+
+ initEscapeListener: () => {
+ // only install a listener if it is really needed
+ if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return;
+
+ document.addEventListener("keydown", (event) => {
+ // bail for input elements
+ if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
+ // bail with special keys
+ if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return;
+ if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) {
+ SphinxHighlight.hideSearchWords();
+ event.preventDefault();
+ }
+ });
+ },
+};
+
+_ready(() => {
+ /* Do not call highlightSearchWords() when we are on the search page.
+ * It will highlight words from the *previous* search query.
+ */
+ if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords();
+ SphinxHighlight.initEscapeListener();
+});
diff --git a/genindex.html b/genindex.html
new file mode 100644
index 00000000..eb57bd38
--- /dev/null
+++ b/genindex.html
@@ -0,0 +1,436 @@
+
+
+
+
+
+
+
+
Index — zanzocam-core 1.1.0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ zanzocam-core
+
+
+
+
+
+
+
+
+
+
Index
+
+
+
A
+ |
B
+ |
C
+ |
D
+ |
F
+ |
G
+ |
I
+ |
L
+ |
M
+ |
N
+ |
O
+ |
P
+ |
R
+ |
S
+ |
T
+ |
V
+ |
W
+ |
Z
+
+
+
A
+
+
+
B
+
+
+
C
+
+
+
D
+
+
+
F
+
+
+
G
+
+
+
I
+
+
+
L
+
+
+
M
+
+
+
N
+
+
+
O
+
+
+
P
+
+
+
R
+
+
+
S
+
+
+
T
+
+
+
V
+
+
+
W
+
+
+
Z
+
+
+
+ zanzocam.constants
+
+
+
+ zanzocam.webcam.configuration
+
+
+
+ zanzocam.webcam.errors
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/index.html b/index.html
new file mode 100644
index 00000000..68f3b035
--- /dev/null
+++ b/index.html
@@ -0,0 +1,656 @@
+
+
+
+
+
+
+
+
+
ZanzoCam - Internal documentation — zanzocam-core 1.1.0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ zanzocam-core
+
+
+
+
+
+
+
+
+
+ZanzoCam - Internal documentation
+Internal documentation for zanzocam-core
+Better documentation coming soon.
+
+Constants
+Details of the constants stored in the zanzocam.constants
+
+
+zanzocam.constants. AUTOHOTSPOT_BINARY_PATH = '/usr/bin/autohotspot'
+Path to the autohotspot script
+
+
+
+
+zanzocam.constants. AUTOHOTSPOT_RETRY_TIME = 300
+Interval to wait before retrying the autohotspot script
+
+
+
+
+zanzocam.constants. BACKUP_CRONJOB = PosixPath('/home/runner/work/zanzocam-core/zanzocam-core/zanzocam/data/.crontab.bak')
+Path to the crontab’s backup
+
+
+
+
+zanzocam.constants. BASE_PATH = PosixPath('/home/runner/work/zanzocam-core/zanzocam-core/zanzocam')
+Folder containing the source code
+
+
+
+
+zanzocam.constants. CAMERA_DEFAULTS = {'awb_mode': 'auto', 'background_color': (0, 0, 0, 0), 'date_format': '%d %B %Y', 'extension': 'jpg', 'height': 100, 'hor_flip': False, 'jpeg_quality': 90, 'jpeg_subsampling': 0, 'let_awb_settle_in_dark': False, 'name': 'no-name', 'rotation': 0, 'time_format': '%H:%M', 'use_low_light_algorithm': True, 'ver_flip': False, 'width': 100}
+Fallback values for the camera configuration
+
+
+
+
+zanzocam.constants. CAMERA_LOGS = PosixPath('/home/runner/work/zanzocam-core/zanzocam-core/zanzocam/data/camera')
+Logs produced during the main procedure (will be sent to the server)
+
+
+
+
+zanzocam.constants. CAMERA_WARM_UP_TIME = 5
+Time to allow the firmware to compute the right exposure in normal
+light conditions (AWB requires more)
+
+
+
+
+zanzocam.constants. CHECK_UPLINK_URL = 'http://www.google.com'
+URL to check to ensure Internet is reachable
+
+
+
+
+zanzocam.constants. CONFIGURATION_FILE = PosixPath('/home/runner/work/zanzocam-core/zanzocam-core/zanzocam/data/configuration.json')
+Main configuration file
+
+
+
+
+zanzocam.constants. CRONJOB_FILE = '/etc/cron.d/zanzocam'
+Path to the system crontab
+
+
+
+
+zanzocam.constants. DATA_PATH = PosixPath('/home/runner/work/zanzocam-core/zanzocam-core/zanzocam/data')
+Folder containing the data used by the ZanzoCam for its operations
+
+
+
+
+zanzocam.constants. FAILURE_REPORT_PATH = PosixPath('/home/runner/work/zanzocam-core/zanzocam-core/zanzocam/data/failure_report.txt')
+Logs produced in case of issues with the server
+
+
+
+
+zanzocam.constants. FONT_PATH = '/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf'
+Path to the default font (can be customized if you install another font)
+
+
+
+
+zanzocam.constants. FTP_CONFIG_FILE_ENCODING = 'utf-8'
+Ecoding of the FTP server files
+
+
+
+
+zanzocam.constants. IMAGE_OVERLAYS_PATH = PosixPath('/home/runner/work/zanzocam-core/zanzocam-core/zanzocam/data/overlays')
+Local camera overlays path
+
+
+
+
+zanzocam.constants. INITIAL_LOW_LIGHT_ISO = 400
+Starting ISO level for low light pictures
+
+
+
+
+zanzocam.constants. LOCALE = 'it_IT.utf8'
+Locale
+
+
+
+
+zanzocam.constants. LOG_NAME_FORMAT = 'logs %d-%m-%Y %H:%M:%S.log'
+Used with datetime to format the log name
+
+
+
+
+zanzocam.constants. MAX_SHUTTER_SPEED = 9500000
+Max shutter speed allowed by the camera hardware
+
+
+
+
+zanzocam.constants. MINIMUM_DAYLIGHT_LUMINANCE = 60
+Minimum luminance for the daytime.
+If the detected luminance goes below this value, the night mode kicks in.
+
+
+
+
+zanzocam.constants. MINIMUM_NIGHT_LUMINANCE = 30
+Minimum luminance to target for pictures in low light conditions.
+
+
+
+
+zanzocam.constants. MIN_SHUTTER_SPEED = 30000
+Min shutter speed for low light, the
+max that PiCamera would use with automatic settings
+
+
+
+
+zanzocam.constants. NO_LUMINANCE_SHUTTER_SPEED = 2000000
+What “random” shutter speed to use if the image
+is so black that the equation doesn’t work
+
+
+
+
+zanzocam.constants. NO_LUMINANCE_THRESHOLD = 1
+When to consider the image totally black,
+where the low light estimation doesn’t work well
+
+
+
+
+zanzocam.constants. OVERLAY_DEFAULTS = {'background_color': (255, 255, 255, 0), 'font_color': (0, 0, 0), 'font_size': 30, 'heigth': None, 'image': None, 'over_the_picture': False, 'padding': 10, 'text': '... testo ...', 'width': None}
+Fallback values for the image overlays
+
+
+
+
+zanzocam.constants. PICAMERA_AWB_MODES = ['off', 'auto', 'sunlight', 'cloudy', 'shade', 'tungsten', 'fluorescent', 'incandescent', 'flash', 'horizon']
+White balancing modes from picamera
+
+
+
+
+zanzocam.constants. PICTURE_LOGS = PosixPath('/home/runner/work/zanzocam-core/zanzocam-core/zanzocam/data/picture_logs.txt')
+Temporary camera logs for the web UI
+
+
+
+
+zanzocam.constants. PREVIEW_PICTURE = PosixPath('/home/runner/work/zanzocam-core/zanzocam-core/zanzocam/web_ui/static/previews/zanzocam-preview.jpg')
+Path to the preview picture in the web UI
+
+
+
+
+zanzocam.constants. PREVIEW_PICTURE_URL = 'static/previews/zanzocam-preview.jpg'
+URL to the preview picture in the web UI
+
+
+
+
+zanzocam.constants. REMOTE_IMAGES_PATH = 'configuration/overlays/'
+Remote camera overlays path
+
+
+
+
+zanzocam.constants. REQUEST_TIMEOUT = 60
+Timeout for HTTP requests
+
+
+
+
+zanzocam.constants. SEND_LOGS_FLAG = PosixPath('/home/runner/work/zanzocam-core/zanzocam-core/zanzocam/data/send-logs.flag')
+Whether to send the logs to the server
+
+
+
+
+zanzocam.constants. SERVER_LOG = PosixPath('/home/runner/work/zanzocam-core/zanzocam-core/zanzocam/data/interface.log')
+Logs of the local server (stay on disk and get rotated)
+
+
+
+
+zanzocam.constants. SYSTEM_USER = 'zanzocam-bot'
+Main user of the system, must be able to perform a passwordless sudo
+
+
+
+
+zanzocam.constants. TARGET_LUMINOSITY_MARGIN = 3
+How much tolerance to give to the low light search algorithm
+
+
+
+
+zanzocam.constants. TEMP_CRONJOB = PosixPath('/home/runner/work/zanzocam-core/zanzocam-core/zanzocam/data/.tmp-cronjob-file')
+Temporary crontab path
+
+
+
+
+zanzocam.constants. VERSION = '1.3.4'
+ZanzoCam version
+
+
+
+
+zanzocam.constants. WAIT_AFTER_CAMERA_FAIL = 30
+Time to wait in between failed shots of the camera
+(to overcome colliding crontabs)
+
+
+
+
+zanzocam.constants. ZANZOCAM_EXECUTABLE = '/home/zanzocam-bot/venv/bin/z-webcam'
+Location of the z-webcam executable
+
+
+
+
+Main module
+The zanzocam.webcam.main
+Here is some internal documentation of it.
+
+
+Configuration module
+Details of the zanzocam.webcam.configuration
+
+
+class zanzocam.webcam.configuration. Configuration ( path : Path | None = None )
+Bases: object
+Manages the configurations.
+
+
+backup ( path : str | None = None )
+Creates a backup copy of the configuration file.
+NOTE: we backup from memory and not simply copy the file
+because the file might have been overwritten by a server
+(server.update_configuration()) in the meantime.
+
+
+
+
+static create_from_dictionary ( data : Dict path : Path | None = None ) → Configuration
+Creates a Configuration object starting from a dictionary. Will
+save the configuration file at the specified path.
+
+
+
+
+get_camera_settings ( )
+Return all the information relative to the settings
+used to take and render the picture.
+
+
+
+
+get_server_settings ( )
+Return all the information relative to the settings
+used to connect to the server.
+
+
+
+
+get_start_time ( )
+Return either the start time defined, or 00:00
+
+
+
+
+get_stop_time ( )
+Return either the stop time defined, or 23:59
+
+
+
+
+get_system_settings ( )
+Return all the information relative to the settings
+that should be applied to the system.
+For now is just the time settings.
+
+
+
+
+list_overlays ( ) → List [ str ]
+List all the overlay images that should be downloaded from the server
+
+
+
+
+restore_backup ( ) → bool
+Restores the configuration file from its backup copy.
+Does not try to reload the old config.
+Returns True in case of no errors, False otherwise.
+
+
+
+
+within_active_hours ( ) → bool | None
+Compares the current time with the start-stop times.
+Returns True if inside the interval, False if outside,
+None if an error occured.
+
+
+
+
+
+
+zanzocam.webcam.configuration. load_configuration_from_disk ( path = '/home/runner/work/zanzocam-core/zanzocam-core/zanzocam/data/configuration.json' backup_path = '/home/runner/work/zanzocam-core/zanzocam-core/zanzocam/data/configuration.json.bak' quiet : bool = False ) → Configuration | None
+Load current configuration from disk,
+or try with its backup if the file is not found.
+Returns None if some error occurred.
+
+
+
+
+System module
+Details of the zanzocam.webcam.system
+
+
+Camera module
+Details of the zanzocam.webcam.camera
+
+
+Overlays module
+Details of the zanzocam.webcam.overlays
+
+
+class zanzocam.webcam.overlays. Overlay ( position : str data : Dict photo_width : int photo_height : int date_format : str | None time_format : str | None )
+Bases: object
+Represents one overlay to add to the picture.
+
+
+compute_position ( image_width : int image_height : int border_top : int border_bottom : int ) → Tuple [ int , int ]
+Returns the x,y position in the picture where this overlay
+should be pasted.
+
+
+
+
+create_image_overlay ( ) → Any
+Prepares an overlay containing an image.
+Might return None in case of issues.
+
+
+
+
+create_text_overlay ( photo_width : int photo_height : int ) → Any
+Prepares an overlay containing text.
+In case of issues, self.overlay_image will stay None.
+
+
+
+
+process_text ( font : Any max_line_length : int ) → Tuple [ int , int ]
+Measures and insert returns into the text to make it fit into the image.
+
+
+
+
+
+
+Utils module
+Details of the zanzocam.webcam.utils
+
+
+class zanzocam.webcam.utils. AllStringEncoder ( * skipkeys = False ensure_ascii = True check_circular = True allow_nan = True sort_keys = False indent = None separators = None default = None )
+Bases: JSONEncoder
+To transform every value into a string
+
+
+default ( o )
+Implement this method in a subclass such that it returns
+a serializable object for o TypeError
+For example, to support arbitrary iterators, you could
+implement default like this:
+def default ( self , o ):
+ try :
+ iterable = iter ( o )
+ except TypeError :
+ pass
+ else :
+ return list ( iterable )
+ # Let the base class default method raise the TypeError
+ return JSONEncoder . default ( self , o )
+
+
+
+
+
+
+
+zanzocam.webcam.utils. log ( msg : str ) → None
+Logs the message to the console
+
+
+
+
+zanzocam.webcam.utils. log_error ( msg : str e : Exception | None = None fatal : str | None = None ) → None
+Logs an error to the console
+
+
+
+
+zanzocam.webcam.utils. log_row ( char : str = '=' ) → None
+Logs a row to the console
+
+
+
+
+zanzocam.webcam.utils. retry ( times : int wait_for : float )
+Makes the decorated function try to run without
+exceptions ‘times’ times.
+If an exception occurs, logs it and tries again
+after wait_for seconds.
+Otherwise returns at the first successful attempt.
+Returns None in case there is an exception at the
+last run as well.
+
+
+
+
+Custom Errors
+Details of the zanzocam.webcam.errors
+
+
+exception zanzocam.webcam.errors. ServerError
+Bases: Exception
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/objects.inv b/objects.inv
new file mode 100644
index 00000000..d9c85ef8
Binary files /dev/null and b/objects.inv differ
diff --git a/py-modindex.html b/py-modindex.html
new file mode 100644
index 00000000..fcf13960
--- /dev/null
+++ b/py-modindex.html
@@ -0,0 +1,142 @@
+
+
+
+
+
+
+
+
Python Module Index — zanzocam-core 1.1.0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ zanzocam-core
+
+
+
+
+
+
+ Python Module Index
+
+
+
+
+
+
+
+
+
+
Python Module Index
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/search.html b/search.html
new file mode 100644
index 00000000..f1b32cf7
--- /dev/null
+++ b/search.html
@@ -0,0 +1,117 @@
+
+
+
+
+
+
+
+
Search — zanzocam-core 1.1.0 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ zanzocam-core
+
+
+
+
+
+
+
+
+
+
+
+ Please activate JavaScript to enable the search functionality.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/searchindex.js b/searchindex.js
new file mode 100644
index 00000000..c9695767
--- /dev/null
+++ b/searchindex.js
@@ -0,0 +1 @@
+Search.setIndex({"alltitles": {"Camera module": [[0, "camera-module"]], "Configuration module": [[0, "configuration-module"]], "Constants": [[0, "constants"]], "Custom Errors": [[0, "custom-errors"]], "Main module": [[0, "main-module"]], "Overlays module": [[0, "overlays-module"]], "System module": [[0, "system-module"]], "Utils module": [[0, "utils-module"]], "ZanzoCam - Internal documentation": [[0, null]]}, "docnames": ["index"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["index.rst"], "indexentries": {"allstringencoder (class in zanzocam.webcam.utils)": [[0, "zanzocam.webcam.utils.AllStringEncoder", false]], "autohotspot_binary_path (in module zanzocam.constants)": [[0, "zanzocam.constants.AUTOHOTSPOT_BINARY_PATH", false]], "autohotspot_retry_time (in module zanzocam.constants)": [[0, "zanzocam.constants.AUTOHOTSPOT_RETRY_TIME", false]], "backup() (zanzocam.webcam.configuration.configuration method)": [[0, "zanzocam.webcam.configuration.Configuration.backup", false]], "backup_cronjob (in module zanzocam.constants)": [[0, "zanzocam.constants.BACKUP_CRONJOB", false]], "base_path (in module zanzocam.constants)": [[0, "zanzocam.constants.BASE_PATH", false]], "camera_defaults (in module zanzocam.constants)": [[0, "zanzocam.constants.CAMERA_DEFAULTS", false]], "camera_logs (in module zanzocam.constants)": [[0, "zanzocam.constants.CAMERA_LOGS", false]], "camera_warm_up_time (in module zanzocam.constants)": [[0, "zanzocam.constants.CAMERA_WARM_UP_TIME", false]], "check_uplink_url (in module zanzocam.constants)": [[0, "zanzocam.constants.CHECK_UPLINK_URL", false]], "compute_position() (zanzocam.webcam.overlays.overlay method)": [[0, "zanzocam.webcam.overlays.Overlay.compute_position", false]], "configuration (class in zanzocam.webcam.configuration)": [[0, "zanzocam.webcam.configuration.Configuration", false]], "configuration_file (in module zanzocam.constants)": [[0, "zanzocam.constants.CONFIGURATION_FILE", false]], "create_from_dictionary() (zanzocam.webcam.configuration.configuration static method)": [[0, "zanzocam.webcam.configuration.Configuration.create_from_dictionary", false]], "create_image_overlay() (zanzocam.webcam.overlays.overlay method)": [[0, "zanzocam.webcam.overlays.Overlay.create_image_overlay", false]], "create_text_overlay() (zanzocam.webcam.overlays.overlay method)": [[0, "zanzocam.webcam.overlays.Overlay.create_text_overlay", false]], "cronjob_file (in module zanzocam.constants)": [[0, "zanzocam.constants.CRONJOB_FILE", false]], "data_path (in module zanzocam.constants)": [[0, "zanzocam.constants.DATA_PATH", false]], "default() (zanzocam.webcam.utils.allstringencoder method)": [[0, "zanzocam.webcam.utils.AllStringEncoder.default", false]], "failure_report_path (in module zanzocam.constants)": [[0, "zanzocam.constants.FAILURE_REPORT_PATH", false]], "font_path (in module zanzocam.constants)": [[0, "zanzocam.constants.FONT_PATH", false]], "ftp_config_file_encoding (in module zanzocam.constants)": [[0, "zanzocam.constants.FTP_CONFIG_FILE_ENCODING", false]], "get_camera_settings() (zanzocam.webcam.configuration.configuration method)": [[0, "zanzocam.webcam.configuration.Configuration.get_camera_settings", false]], "get_server_settings() (zanzocam.webcam.configuration.configuration method)": [[0, "zanzocam.webcam.configuration.Configuration.get_server_settings", false]], "get_start_time() (zanzocam.webcam.configuration.configuration method)": [[0, "zanzocam.webcam.configuration.Configuration.get_start_time", false]], "get_stop_time() (zanzocam.webcam.configuration.configuration method)": [[0, "zanzocam.webcam.configuration.Configuration.get_stop_time", false]], "get_system_settings() (zanzocam.webcam.configuration.configuration method)": [[0, "zanzocam.webcam.configuration.Configuration.get_system_settings", false]], "image_overlays_path (in module zanzocam.constants)": [[0, "zanzocam.constants.IMAGE_OVERLAYS_PATH", false]], "initial_low_light_iso (in module zanzocam.constants)": [[0, "zanzocam.constants.INITIAL_LOW_LIGHT_ISO", false]], "list_overlays() (zanzocam.webcam.configuration.configuration method)": [[0, "zanzocam.webcam.configuration.Configuration.list_overlays", false]], "load_configuration_from_disk() (in module zanzocam.webcam.configuration)": [[0, "zanzocam.webcam.configuration.load_configuration_from_disk", false]], "locale (in module zanzocam.constants)": [[0, "zanzocam.constants.LOCALE", false]], "log() (in module zanzocam.webcam.utils)": [[0, "zanzocam.webcam.utils.log", false]], "log_error() (in module zanzocam.webcam.utils)": [[0, "zanzocam.webcam.utils.log_error", false]], "log_name_format (in module zanzocam.constants)": [[0, "zanzocam.constants.LOG_NAME_FORMAT", false]], "log_row() (in module zanzocam.webcam.utils)": [[0, "zanzocam.webcam.utils.log_row", false]], "max_shutter_speed (in module zanzocam.constants)": [[0, "zanzocam.constants.MAX_SHUTTER_SPEED", false]], "min_shutter_speed (in module zanzocam.constants)": [[0, "zanzocam.constants.MIN_SHUTTER_SPEED", false]], "minimum_daylight_luminance (in module zanzocam.constants)": [[0, "zanzocam.constants.MINIMUM_DAYLIGHT_LUMINANCE", false]], "minimum_night_luminance (in module zanzocam.constants)": [[0, "zanzocam.constants.MINIMUM_NIGHT_LUMINANCE", false]], "module": [[0, "module-zanzocam.constants", false], [0, "module-zanzocam.webcam.configuration", false], [0, "module-zanzocam.webcam.errors", false], [0, "module-zanzocam.webcam.overlays", false], [0, "module-zanzocam.webcam.utils", false]], "no_luminance_shutter_speed (in module zanzocam.constants)": [[0, "zanzocam.constants.NO_LUMINANCE_SHUTTER_SPEED", false]], "no_luminance_threshold (in module zanzocam.constants)": [[0, "zanzocam.constants.NO_LUMINANCE_THRESHOLD", false]], "overlay (class in zanzocam.webcam.overlays)": [[0, "zanzocam.webcam.overlays.Overlay", false]], "overlay_defaults (in module zanzocam.constants)": [[0, "zanzocam.constants.OVERLAY_DEFAULTS", false]], "picamera_awb_modes (in module zanzocam.constants)": [[0, "zanzocam.constants.PICAMERA_AWB_MODES", false]], "picture_logs (in module zanzocam.constants)": [[0, "zanzocam.constants.PICTURE_LOGS", false]], "preview_picture (in module zanzocam.constants)": [[0, "zanzocam.constants.PREVIEW_PICTURE", false]], "preview_picture_url (in module zanzocam.constants)": [[0, "zanzocam.constants.PREVIEW_PICTURE_URL", false]], "process_text() (zanzocam.webcam.overlays.overlay method)": [[0, "zanzocam.webcam.overlays.Overlay.process_text", false]], "remote_images_path (in module zanzocam.constants)": [[0, "zanzocam.constants.REMOTE_IMAGES_PATH", false]], "request_timeout (in module zanzocam.constants)": [[0, "zanzocam.constants.REQUEST_TIMEOUT", false]], "restore_backup() (zanzocam.webcam.configuration.configuration method)": [[0, "zanzocam.webcam.configuration.Configuration.restore_backup", false]], "retry() (in module zanzocam.webcam.utils)": [[0, "zanzocam.webcam.utils.retry", false]], "send_logs_flag (in module zanzocam.constants)": [[0, "zanzocam.constants.SEND_LOGS_FLAG", false]], "server_log (in module zanzocam.constants)": [[0, "zanzocam.constants.SERVER_LOG", false]], "servererror": [[0, "zanzocam.webcam.errors.ServerError", false]], "system_user (in module zanzocam.constants)": [[0, "zanzocam.constants.SYSTEM_USER", false]], "target_luminosity_margin (in module zanzocam.constants)": [[0, "zanzocam.constants.TARGET_LUMINOSITY_MARGIN", false]], "temp_cronjob (in module zanzocam.constants)": [[0, "zanzocam.constants.TEMP_CRONJOB", false]], "version (in module zanzocam.constants)": [[0, "zanzocam.constants.VERSION", false]], "wait_after_camera_fail (in module zanzocam.constants)": [[0, "zanzocam.constants.WAIT_AFTER_CAMERA_FAIL", false]], "within_active_hours() (zanzocam.webcam.configuration.configuration method)": [[0, "zanzocam.webcam.configuration.Configuration.within_active_hours", false]], "zanzocam.constants": [[0, "module-zanzocam.constants", false]], "zanzocam.webcam.configuration": [[0, "module-zanzocam.webcam.configuration", false]], "zanzocam.webcam.errors": [[0, "module-zanzocam.webcam.errors", false]], "zanzocam.webcam.overlays": [[0, "module-zanzocam.webcam.overlays", false]], "zanzocam.webcam.utils": [[0, "module-zanzocam.webcam.utils", false]], "zanzocam_executable (in module zanzocam.constants)": [[0, "zanzocam.constants.ZANZOCAM_EXECUTABLE", false]]}, "objects": {"zanzocam": [[0, 0, 0, "-", "constants"]], "zanzocam.constants": [[0, 1, 1, "", "AUTOHOTSPOT_BINARY_PATH"], [0, 1, 1, "", "AUTOHOTSPOT_RETRY_TIME"], [0, 1, 1, "", "BACKUP_CRONJOB"], [0, 1, 1, "", "BASE_PATH"], [0, 1, 1, "", "CAMERA_DEFAULTS"], [0, 1, 1, "", "CAMERA_LOGS"], [0, 1, 1, "", "CAMERA_WARM_UP_TIME"], [0, 1, 1, "", "CHECK_UPLINK_URL"], [0, 1, 1, "", "CONFIGURATION_FILE"], [0, 1, 1, "", "CRONJOB_FILE"], [0, 1, 1, "", "DATA_PATH"], [0, 1, 1, "", "FAILURE_REPORT_PATH"], [0, 1, 1, "", "FONT_PATH"], [0, 1, 1, "", "FTP_CONFIG_FILE_ENCODING"], [0, 1, 1, "", "IMAGE_OVERLAYS_PATH"], [0, 1, 1, "", "INITIAL_LOW_LIGHT_ISO"], [0, 1, 1, "", "LOCALE"], [0, 1, 1, "", "LOG_NAME_FORMAT"], [0, 1, 1, "", "MAX_SHUTTER_SPEED"], [0, 1, 1, "", "MINIMUM_DAYLIGHT_LUMINANCE"], [0, 1, 1, "", "MINIMUM_NIGHT_LUMINANCE"], [0, 1, 1, "", "MIN_SHUTTER_SPEED"], [0, 1, 1, "", "NO_LUMINANCE_SHUTTER_SPEED"], [0, 1, 1, "", "NO_LUMINANCE_THRESHOLD"], [0, 1, 1, "", "OVERLAY_DEFAULTS"], [0, 1, 1, "", "PICAMERA_AWB_MODES"], [0, 1, 1, "", "PICTURE_LOGS"], [0, 1, 1, "", "PREVIEW_PICTURE"], [0, 1, 1, "", "PREVIEW_PICTURE_URL"], [0, 1, 1, "", "REMOTE_IMAGES_PATH"], [0, 1, 1, "", "REQUEST_TIMEOUT"], [0, 1, 1, "", "SEND_LOGS_FLAG"], [0, 1, 1, "", "SERVER_LOG"], [0, 1, 1, "", "SYSTEM_USER"], [0, 1, 1, "", "TARGET_LUMINOSITY_MARGIN"], [0, 1, 1, "", "TEMP_CRONJOB"], [0, 1, 1, "", "VERSION"], [0, 1, 1, "", "WAIT_AFTER_CAMERA_FAIL"], [0, 1, 1, "", "ZANZOCAM_EXECUTABLE"]], "zanzocam.webcam": [[0, 0, 0, "-", "configuration"], [0, 0, 0, "-", "errors"], [0, 0, 0, "-", "overlays"], [0, 0, 0, "-", "utils"]], "zanzocam.webcam.configuration": [[0, 2, 1, "", "Configuration"], [0, 4, 1, "", "load_configuration_from_disk"]], "zanzocam.webcam.configuration.Configuration": [[0, 3, 1, "", "backup"], [0, 3, 1, "", "create_from_dictionary"], [0, 3, 1, "", "get_camera_settings"], [0, 3, 1, "", "get_server_settings"], [0, 3, 1, "", "get_start_time"], [0, 3, 1, "", "get_stop_time"], [0, 3, 1, "", "get_system_settings"], [0, 3, 1, "", "list_overlays"], [0, 3, 1, "", "restore_backup"], [0, 3, 1, "", "within_active_hours"]], "zanzocam.webcam.errors": [[0, 5, 1, "", "ServerError"]], "zanzocam.webcam.overlays": [[0, 2, 1, "", "Overlay"]], "zanzocam.webcam.overlays.Overlay": [[0, 3, 1, "", "compute_position"], [0, 3, 1, "", "create_image_overlay"], [0, 3, 1, "", "create_text_overlay"], [0, 3, 1, "", "process_text"]], "zanzocam.webcam.utils": [[0, 2, 1, "", "AllStringEncoder"], [0, 4, 1, "", "log"], [0, 4, 1, "", "log_error"], [0, 4, 1, "", "log_row"], [0, 4, 1, "", "retry"]], "zanzocam.webcam.utils.AllStringEncoder": [[0, 3, 1, "", "default"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "data", "Python data"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "function", "Python function"], "5": ["py", "exception", "Python exception"]}, "objtypes": {"0": "py:module", "1": "py:data", "2": "py:class", "3": "py:method", "4": "py:function", "5": "py:exception"}, "terms": {"": 0, "0": 0, "00": 0, "1": 0, "10": 0, "100": 0, "2000000": 0, "23": 0, "255": 0, "3": 0, "30": 0, "300": 0, "30000": 0, "4": 0, "400": 0, "5": 0, "59": 0, "60": 0, "8": 0, "90": 0, "9500000": 0, "For": 0, "If": 0, "In": 0, "The": 0, "To": 0, "Will": 0, "abl": 0, "add": 0, "after": 0, "again": 0, "algorithm": 0, "all": 0, "allow": 0, "allow_nan": 0, "allstringencod": 0, "an": 0, "ani": 0, "anoth": 0, "appli": 0, "arbitrari": 0, "attempt": 0, "auto": 0, "autohotspot": 0, "autohotspot_binary_path": 0, "autohotspot_retry_tim": 0, "automat": 0, "awb": 0, "awb_mod": 0, "b": 0, "background_color": 0, "backup": 0, "backup_cronjob": 0, "backup_path": 0, "bak": 0, "balanc": 0, "base": 0, "base_path": 0, "becaus": 0, "been": 0, "befor": 0, "below": 0, "better": 0, "between": 0, "bin": 0, "black": 0, "bool": 0, "border_bottom": 0, "border_top": 0, "bot": 0, "call": 0, "camera_default": 0, "camera_log": 0, "camera_warm_up_tim": 0, "can": 0, "case": 0, "char": 0, "check": 0, "check_circular": 0, "check_uplink_url": 0, "class": 0, "cloudi": 0, "code": 0, "collid": 0, "com": 0, "come": 0, "compar": 0, "comput": 0, "compute_posit": 0, "condit": 0, "config": 0, "configuration_fil": 0, "connect": 0, "consid": 0, "consol": 0, "contain": 0, "copi": 0, "core": 0, "could": 0, "creat": 0, "create_from_dictionari": 0, "create_image_overlai": 0, "create_text_overlai": 0, "cron": 0, "cronjob": 0, "cronjob_fil": 0, "crontab": 0, "current": 0, "d": 0, "data": 0, "data_path": 0, "date_format": 0, "datetim": 0, "daytim": 0, "decor": 0, "def": 0, "default": 0, "defin": 0, "dejavu": 0, "dejavusan": 0, "detail": 0, "detect": 0, "dict": 0, "dictionari": 0, "disk": 0, "doe": 0, "doesn": 0, "download": 0, "dure": 0, "e": 0, "ecod": 0, "either": 0, "els": 0, "ensur": 0, "ensure_ascii": 0, "equat": 0, "estim": 0, "etc": 0, "everi": 0, "exampl": 0, "except": 0, "execut": 0, "exposur": 0, "extens": 0, "fail": 0, "failure_report": 0, "failure_report_path": 0, "fallback": 0, "fals": 0, "fatal": 0, "file": 0, "firmwar": 0, "first": 0, "fit": 0, "flag": 0, "flash": 0, "float": 0, "fluoresc": 0, "folder": 0, "font": 0, "font_color": 0, "font_path": 0, "font_siz": 0, "format": 0, "found": 0, "from": 0, "ftp": 0, "ftp_config_file_encod": 0, "function": 0, "get": 0, "get_camera_set": 0, "get_server_set": 0, "get_start_tim": 0, "get_stop_tim": 0, "get_system_set": 0, "give": 0, "goe": 0, "googl": 0, "h": 0, "hardwar": 0, "have": 0, "height": 0, "heigth": 0, "here": 0, "home": 0, "hor_flip": 0, "horizon": 0, "how": 0, "http": 0, "i": 0, "imag": 0, "image_height": 0, "image_overlays_path": 0, "image_width": 0, "implement": 0, "incandesc": 0, "indent": 0, "inform": 0, "initial_low_light_iso": 0, "insert": 0, "insid": 0, "instal": 0, "int": 0, "interfac": 0, "internet": 0, "interv": 0, "iso": 0, "issu": 0, "it_it": 0, "iter": 0, "its": 0, "jpeg_qual": 0, "jpeg_subsampl": 0, "jpg": 0, "json": 0, "jsonencod": 0, "just": 0, "kick": 0, "last": 0, "let": 0, "let_awb_settle_in_dark": 0, "level": 0, "light": 0, "like": 0, "list": 0, "list_overlai": 0, "load": 0, "load_configuration_from_disk": 0, "local": 0, "locat": 0, "log": 0, "log_error": 0, "log_name_format": 0, "log_row": 0, "low": 0, "lumin": 0, "m": 0, "make": 0, "manag": 0, "max": 0, "max_line_length": 0, "max_shutter_spe": 0, "meantim": 0, "measur": 0, "memori": 0, "messag": 0, "method": 0, "might": 0, "min": 0, "min_shutter_spe": 0, "minimum": 0, "minimum_daylight_lumin": 0, "minimum_night_lumin": 0, "mode": 0, "more": 0, "msg": 0, "much": 0, "must": 0, "name": 0, "night": 0, "no_luminance_shutter_spe": 0, "no_luminance_threshold": 0, "none": 0, "normal": 0, "note": 0, "now": 0, "o": 0, "object": 0, "occur": 0, "off": 0, "old": 0, "one": 0, "oper": 0, "otherwis": 0, "outsid": 0, "over_the_pictur": 0, "overcom": 0, "overlay_default": 0, "overlay_imag": 0, "overwritten": 0, "pad": 0, "pass": 0, "passwordless": 0, "past": 0, "path": 0, "perform": 0, "photo_height": 0, "photo_width": 0, "picamera": 0, "picamera_awb_mod": 0, "pictur": 0, "picture_log": 0, "posit": 0, "posixpath": 0, "prepar": 0, "preview": 0, "preview_pictur": 0, "preview_picture_url": 0, "procedur": 0, "process_text": 0, "produc": 0, "quiet": 0, "rais": 0, "random": 0, "reachabl": 0, "rel": 0, "reload": 0, "remot": 0, "remote_images_path": 0, "render": 0, "repres": 0, "request": 0, "request_timeout": 0, "requir": 0, "restor": 0, "restore_backup": 0, "retri": 0, "return": 0, "right": 0, "rotat": 0, "row": 0, "run": 0, "runner": 0, "save": 0, "script": 0, "search": 0, "second": 0, "self": 0, "send": 0, "send_logs_flag": 0, "sent": 0, "separ": 0, "serializ": 0, "server": 0, "server_log": 0, "servererror": 0, "set": 0, "shade": 0, "share": 0, "shot": 0, "should": 0, "shutter": 0, "simpli": 0, "skipkei": 0, "so": 0, "some": 0, "soon": 0, "sort_kei": 0, "sourc": 0, "specifi": 0, "speed": 0, "stai": 0, "start": 0, "static": 0, "stop": 0, "store": 0, "str": 0, "string": 0, "subclass": 0, "success": 0, "sudo": 0, "sunlight": 0, "support": 0, "system_us": 0, "t": 0, "take": 0, "target": 0, "target_luminosity_margin": 0, "temp_cronjob": 0, "temporari": 0, "testo": 0, "text": 0, "thi": 0, "time": 0, "time_format": 0, "timeout": 0, "tmp": 0, "toler": 0, "total": 0, "transform": 0, "tri": 0, "trigger": 0, "true": 0, "truetyp": 0, "try": 0, "ttf": 0, "tungsten": 0, "tupl": 0, "txt": 0, "typeerror": 0, "ui": 0, "update_configur": 0, "url": 0, "us": 0, "use_low_light_algorithm": 0, "user": 0, "usr": 0, "utf": 0, "utf8": 0, "valu": 0, "venv": 0, "ver_flip": 0, "version": 0, "wait": 0, "wait_after_camera_fail": 0, "wait_for": 0, "we": 0, "web": 0, "web_ui": 0, "webcam": 0, "well": 0, "what": 0, "when": 0, "where": 0, "whether": 0, "white": 0, "width": 0, "within_active_hour": 0, "without": 0, "work": 0, "would": 0, "www": 0, "x": 0, "y": 0, "you": 0, "z": 0, "zanzocam_execut": 0}, "titles": ["ZanzoCam - Internal documentation"], "titleterms": {"camera": 0, "configur": 0, "constant": 0, "custom": 0, "document": 0, "error": 0, "intern": 0, "main": 0, "modul": 0, "overlai": 0, "system": 0, "util": 0, "zanzocam": 0}})
\ No newline at end of file
