<< return to Vizycam.com

User Tools

Site Tools


wiki:api_vizypowerboard

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
wiki:api_vizypowerboard [2021/10/07 16:47]
vizycam
wiki:api_vizypowerboard [2022/02/18 23:14] (current)
freed clarify intro, add heading for API docs section
Line 1: Line 1:
 ====== Vizy Power Board API ====== ====== Vizy Power Board API ======
  
-Just quickie ​note -- you can play with the API from a Python interpreter. ​ Turn on your Vizy and point your browser to it.  (Please refer to the [[wiki:​vizy_getting_started|getting started guide]] if you need help with connecting to your Vizy, etc.)  Bring up a Python interpreter by clicking on the ☰ icon in the upper right corner and selecting ​''​%%Python%%''​.  ​+The full API documentation is below, but just quick note that you can play around ​with the API from a Python interpreter. ​ Turn on your Vizy and point your browser to it.  (Please refer to the [[wiki:​vizy_getting_started|getting started guide]] if you need help with connecting to your Vizy, etc.)  Bring up a Python interpreter by clicking on the ☰ icon in the upper right corner and selecting ​**Python**.  ​
  
 {{wiki:​image_249.jpg?​250}} {{wiki:​image_249.jpg?​250}}
Line 37: Line 37:
 will programmatically initiate a safe power-off of your Vizy. will programmatically initiate a safe power-off of your Vizy.
  
 +
 +
 +
 +===== API Documentation =====
  
 <​HTML>​ <​HTML>​
Line 53: Line 57:
 <link rel="​stylesheet preload"​ as="​style"​ href="​https://​cdnjs.cloudflare.com/​ajax/​libs/​highlight.js/​10.1.1/​styles/​github.min.css"​ crossorigin>​ <link rel="​stylesheet preload"​ as="​style"​ href="​https://​cdnjs.cloudflare.com/​ajax/​libs/​highlight.js/​10.1.1/​styles/​github.min.css"​ crossorigin>​
 <​style>:​root{--highlight-color:#​fe9}.flex{display:​flex !important}body{line-height:​1.5em}#​content{padding:​20px}#​sidebar{padding:​30px;​overflow:​hidden}#​sidebar > *:​last-child{margin-bottom:​2cm}.http-server-breadcrumbs{font-size:​130%;​margin:​0 0 15px 0}#​footer{font-size:​.75em;​padding:​5px 30px;​border-top:​1px solid #​ddd;​text-align:​right}#​footer p{margin:0 0 0 1em;​display:​inline-block}#​footer p:​last-child{margin-right:​30px}h1,​h2,​h3,​h4,​h5{font-weight:​300}h1{font-size:​2.5em;​line-height:​1.1em}h2{font-size:​1.75em;​margin:​1em 0 .50em 0}h3{font-size:​1.4em;​margin:​25px 0 10px 0}h4{margin:​0;​font-size:​105%}h1:​target,​h2:​target,​h3:​target,​h4:​target,​h5:​target,​h6:​target{background:​var(--highlight-color);​padding:​.2em 0}a{color:#​058;​text-decoration:​none;​transition:​color .3s ease-in-out}a:​hover{color:#​e82}.title code{font-weight:​bold}h2[id^="​header-"​]{margin-top:​2em}.ident{color:#​900}pre code{background:#​f8f8f8;​font-size:​.8em;​line-height:​1.4em}code{background:#​f2f2f1;​padding:​1px 4px;​overflow-wrap:​break-word}h1 code{background:​transparent}pre{background:#​f8f8f8;​border:​0;​border-top:​1px solid #​ccc;​border-bottom:​1px solid #​ccc;​margin:​1em 0;​padding:​1ex}#​http-server-module-list{display:​flex;​flex-flow:​column}#​http-server-module-list div{display:​flex}#​http-server-module-list dt{min-width:​10%}#​http-server-module-list p{margin-top:​0}.toc ul,#​index{list-style-type:​none;​margin:​0;​padding:​0}#​index code{background:​transparent}#​index h3{border-bottom:​1px solid #ddd}#index ul{padding:​0}#​index h4{margin-top:​.6em;​font-weight:​bold}@media (min-width:​200ex){#​index .two-column{column-count:​2}}@media (min-width:​300ex){#​index .two-column{column-count:​3}}dl{margin-bottom:​2em}dl dl:​last-child{margin-bottom:​4em}dd{margin:​0 0 1em 3em}#​header-classes + dl > dd{margin-bottom:​3em}dd dd{margin-left:​2em}dd p{margin:​10px 0}.name{background:#​eee;​font-weight:​bold;​font-size:​.85em;​padding:​5px 10px;​display:​inline-block;​min-width:​40%}.name:​hover{background:#​e0e0e0}dt:​target .name{background:​var(--highlight-color)}.name > span:​first-child{white-space:​nowrap}.name.class > span:​nth-child(2){margin-left:​.4em}.inherited{color:#​999;​border-left:​5px solid #​eee;​padding-left:​1em}.inheritance em{font-style:​normal;​font-weight:​bold}.desc h2{font-weight:​400;​font-size:​1.25em}.desc h3{font-size:​1em}.desc dt code{background:​inherit}.source summary,​.git-link-div{color:#​666;​text-align:​right;​font-weight:​400;​font-size:​.8em;​text-transform:​uppercase}.source summary > *{white-space:​nowrap;​cursor:​pointer}.git-link{color:​inherit;​margin-left:​1em}.source pre{max-height:​500px;​overflow:​auto;​margin:​0}.source pre code{font-size:​12px;​overflow:​visible}.hlist{list-style:​none}.hlist li{display:​inline}.hlist li:​after{content:',​\2002'​}.hlist li:​last-child:​after{content:​none}.hlist .hlist{display:​inline;​padding-left:​1em}img{max-width:​100%}td{padding:​0 .5em}.admonition{padding:​.1em .5em;​margin-bottom:​1em}.admonition-title{font-weight:​bold}.admonition.note,​.admonition.info,​.admonition.important{background:#​aef}.admonition.todo,​.admonition.versionadded,​.admonition.tip,​.admonition.hint{background:#​dfd}.admonition.warning,​.admonition.versionchanged,​.admonition.deprecated{background:#​fd4}.admonition.error,​.admonition.danger,​.admonition.caution{background:​lightpink}</​style>​ <​style>:​root{--highlight-color:#​fe9}.flex{display:​flex !important}body{line-height:​1.5em}#​content{padding:​20px}#​sidebar{padding:​30px;​overflow:​hidden}#​sidebar > *:​last-child{margin-bottom:​2cm}.http-server-breadcrumbs{font-size:​130%;​margin:​0 0 15px 0}#​footer{font-size:​.75em;​padding:​5px 30px;​border-top:​1px solid #​ddd;​text-align:​right}#​footer p{margin:0 0 0 1em;​display:​inline-block}#​footer p:​last-child{margin-right:​30px}h1,​h2,​h3,​h4,​h5{font-weight:​300}h1{font-size:​2.5em;​line-height:​1.1em}h2{font-size:​1.75em;​margin:​1em 0 .50em 0}h3{font-size:​1.4em;​margin:​25px 0 10px 0}h4{margin:​0;​font-size:​105%}h1:​target,​h2:​target,​h3:​target,​h4:​target,​h5:​target,​h6:​target{background:​var(--highlight-color);​padding:​.2em 0}a{color:#​058;​text-decoration:​none;​transition:​color .3s ease-in-out}a:​hover{color:#​e82}.title code{font-weight:​bold}h2[id^="​header-"​]{margin-top:​2em}.ident{color:#​900}pre code{background:#​f8f8f8;​font-size:​.8em;​line-height:​1.4em}code{background:#​f2f2f1;​padding:​1px 4px;​overflow-wrap:​break-word}h1 code{background:​transparent}pre{background:#​f8f8f8;​border:​0;​border-top:​1px solid #​ccc;​border-bottom:​1px solid #​ccc;​margin:​1em 0;​padding:​1ex}#​http-server-module-list{display:​flex;​flex-flow:​column}#​http-server-module-list div{display:​flex}#​http-server-module-list dt{min-width:​10%}#​http-server-module-list p{margin-top:​0}.toc ul,#​index{list-style-type:​none;​margin:​0;​padding:​0}#​index code{background:​transparent}#​index h3{border-bottom:​1px solid #ddd}#index ul{padding:​0}#​index h4{margin-top:​.6em;​font-weight:​bold}@media (min-width:​200ex){#​index .two-column{column-count:​2}}@media (min-width:​300ex){#​index .two-column{column-count:​3}}dl{margin-bottom:​2em}dl dl:​last-child{margin-bottom:​4em}dd{margin:​0 0 1em 3em}#​header-classes + dl > dd{margin-bottom:​3em}dd dd{margin-left:​2em}dd p{margin:​10px 0}.name{background:#​eee;​font-weight:​bold;​font-size:​.85em;​padding:​5px 10px;​display:​inline-block;​min-width:​40%}.name:​hover{background:#​e0e0e0}dt:​target .name{background:​var(--highlight-color)}.name > span:​first-child{white-space:​nowrap}.name.class > span:​nth-child(2){margin-left:​.4em}.inherited{color:#​999;​border-left:​5px solid #​eee;​padding-left:​1em}.inheritance em{font-style:​normal;​font-weight:​bold}.desc h2{font-weight:​400;​font-size:​1.25em}.desc h3{font-size:​1em}.desc dt code{background:​inherit}.source summary,​.git-link-div{color:#​666;​text-align:​right;​font-weight:​400;​font-size:​.8em;​text-transform:​uppercase}.source summary > *{white-space:​nowrap;​cursor:​pointer}.git-link{color:​inherit;​margin-left:​1em}.source pre{max-height:​500px;​overflow:​auto;​margin:​0}.source pre code{font-size:​12px;​overflow:​visible}.hlist{list-style:​none}.hlist li{display:​inline}.hlist li:​after{content:',​\2002'​}.hlist li:​last-child:​after{content:​none}.hlist .hlist{display:​inline;​padding-left:​1em}img{max-width:​100%}td{padding:​0 .5em}.admonition{padding:​.1em .5em;​margin-bottom:​1em}.admonition-title{font-weight:​bold}.admonition.note,​.admonition.info,​.admonition.important{background:#​aef}.admonition.todo,​.admonition.versionadded,​.admonition.tip,​.admonition.hint{background:#​dfd}.admonition.warning,​.admonition.versionchanged,​.admonition.deprecated{background:#​fd4}.admonition.error,​.admonition.danger,​.admonition.caution{background:​lightpink}</​style>​
-<style media="​screen and (min-width: 700px)">​@media screen and (min-width:​700px){#​sidebar{width:​30%;​height:​100vh;​overflow:​auto;​position:​sticky;​top:​0}#​content{width:​70%;​max-width:​100ch;​padding:​3em 4em;​border-left:​1px solid #ddd}pre code{font-size:​1em}.item .name{font-size:​1em}main{display:​flex;​flex-direction:​row-reverse;​justify-content:​flex-end}.toc ul ul,#index ul{padding-left:​1.5em}.toc > ul > li{margin-top:​.5em}}</​style>​+<style media="​screen and (min-width: 700px)">​@media screen and (min-width:​700px){#​sidebar{width:​35%;​position:​sticky;​top:​0}#​content{width:​70%;​max-width:​100ch;​padding:​3em 4em;​border-left:​1px solid #ddd}pre code{font-size:​1em}.item .name{font-size:​1em}main{display:​flex;​flex-direction:​row-reverse;​justify-content:​flex-end}.toc ul ul,#index ul{padding-left:​1.5em}.toc > ul > li{margin-top:​.5em}}</​style>​
 <style media="​print">​@media print{#​sidebar h1{page-break-before:​always}.source{display:​none}}@media print{*{background:​transparent !important;​color:#​000 !important;​box-shadow:​none !important;​text-shadow:​none !important}a[href]:​after{content:"​ (" attr(href) "​)";​font-size:​90%}a[href][title]:​after{content:​none}abbr[title]:​after{content:"​ (" attr(title) "​)"​}.ir a:​after,​a[href^="​javascript:"​]:​after,​a[href^="#"​]:​after{content:""​}pre,​blockquote{border:​1px solid #​999;​page-break-inside:​avoid}thead{display:​table-header-group}tr,​img{page-break-inside:​avoid}img{max-width:​100% !important}@page{margin:​0.5cm}p,​h2,​h3{orphans:​3;​widows:​3}h1,​h2,​h3,​h4,​h5,​h6{page-break-after:​avoid}}</​style>​ <style media="​print">​@media print{#​sidebar h1{page-break-before:​always}.source{display:​none}}@media print{*{background:​transparent !important;​color:#​000 !important;​box-shadow:​none !important;​text-shadow:​none !important}a[href]:​after{content:"​ (" attr(href) "​)";​font-size:​90%}a[href][title]:​after{content:​none}abbr[title]:​after{content:"​ (" attr(title) "​)"​}.ir a:​after,​a[href^="​javascript:"​]:​after,​a[href^="#"​]:​after{content:""​}pre,​blockquote{border:​1px solid #​999;​page-break-inside:​avoid}thead{display:​table-header-group}tr,​img{page-break-inside:​avoid}img{max-width:​100% !important}@page{margin:​0.5cm}p,​h2,​h3{orphans:​3;​widows:​3}h1,​h2,​h3,​h4,​h5,​h6{page-break-after:​avoid}}</​style>​
 <script defer src="​https://​cdnjs.cloudflare.com/​ajax/​libs/​highlight.js/​10.1.1/​highlight.min.js"​ integrity="​sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8="​ crossorigin></​script>​ <script defer src="​https://​cdnjs.cloudflare.com/​ajax/​libs/​highlight.js/​10.1.1/​highlight.min.js"​ integrity="​sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8="​ crossorigin></​script>​
wiki/api_vizypowerboard.1633643234.txt.gz · Last modified: 2021/10/07 16:47 by vizycam