MOKA/pqAutomationApp
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
29f7d39fe9c5ff3edc361051c08ae001736009e4
pqAutomationApp/docs/UCD-API文档/content/Examples.html
xinzhu.yin 9371defb6e 添加UCD-API文档
2026-05-13 17:18:50 +08:00

1763 lines
143 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="pdoc 14.1.0"/>
<title>Examples API documentation</title>
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
<style>/*! syntax-highlighting.css */pre{line-height:125%;}span.linenos{color:inherit; background-color:transparent; padding-left:5px; padding-right:20px;}.pdoc-code .hll{background-color:#ffffcc}.pdoc-code{background:#f8f8f8;}.pdoc-code .c{color:#3D7B7B; font-style:italic}.pdoc-code .err{border:1px solid #FF0000}.pdoc-code .k{color:#008000; font-weight:bold}.pdoc-code .o{color:#666666}.pdoc-code .ch{color:#3D7B7B; font-style:italic}.pdoc-code .cm{color:#3D7B7B; font-style:italic}.pdoc-code .cp{color:#9C6500}.pdoc-code .cpf{color:#3D7B7B; font-style:italic}.pdoc-code .c1{color:#3D7B7B; font-style:italic}.pdoc-code .cs{color:#3D7B7B; font-style:italic}.pdoc-code .gd{color:#A00000}.pdoc-code .ge{font-style:italic}.pdoc-code .gr{color:#E40000}.pdoc-code .gh{color:#000080; font-weight:bold}.pdoc-code .gi{color:#008400}.pdoc-code .go{color:#717171}.pdoc-code .gp{color:#000080; font-weight:bold}.pdoc-code .gs{font-weight:bold}.pdoc-code .gu{color:#800080; font-weight:bold}.pdoc-code .gt{color:#0044DD}.pdoc-code .kc{color:#008000; font-weight:bold}.pdoc-code .kd{color:#008000; font-weight:bold}.pdoc-code .kn{color:#008000; font-weight:bold}.pdoc-code .kp{color:#008000}.pdoc-code .kr{color:#008000; font-weight:bold}.pdoc-code .kt{color:#B00040}.pdoc-code .m{color:#666666}.pdoc-code .s{color:#BA2121}.pdoc-code .na{color:#687822}.pdoc-code .nb{color:#008000}.pdoc-code .nc{color:#0000FF; font-weight:bold}.pdoc-code .no{color:#880000}.pdoc-code .nd{color:#AA22FF}.pdoc-code .ni{color:#717171; font-weight:bold}.pdoc-code .ne{color:#CB3F38; font-weight:bold}.pdoc-code .nf{color:#0000FF}.pdoc-code .nl{color:#767600}.pdoc-code .nn{color:#0000FF; font-weight:bold}.pdoc-code .nt{color:#008000; font-weight:bold}.pdoc-code .nv{color:#19177C}.pdoc-code .ow{color:#AA22FF; font-weight:bold}.pdoc-code .w{color:#bbbbbb}.pdoc-code .mb{color:#666666}.pdoc-code .mf{color:#666666}.pdoc-code .mh{color:#666666}.pdoc-code .mi{color:#666666}.pdoc-code .mo{color:#666666}.pdoc-code .sa{color:#BA2121}.pdoc-code .sb{color:#BA2121}.pdoc-code .sc{color:#BA2121}.pdoc-code .dl{color:#BA2121}.pdoc-code .sd{color:#BA2121; font-style:italic}.pdoc-code .s2{color:#BA2121}.pdoc-code .se{color:#AA5D1F; font-weight:bold}.pdoc-code .sh{color:#BA2121}.pdoc-code .si{color:#A45A77; font-weight:bold}.pdoc-code .sx{color:#008000}.pdoc-code .sr{color:#A45A77}.pdoc-code .s1{color:#BA2121}.pdoc-code .ss{color:#19177C}.pdoc-code .bp{color:#008000}.pdoc-code .fm{color:#0000FF}.pdoc-code .vc{color:#19177C}.pdoc-code .vg{color:#19177C}.pdoc-code .vi{color:#19177C}.pdoc-code .vm{color:#19177C}.pdoc-code .il{color:#666666}</style>
<style>/*! theme.css */:root{--pdoc-background:#fff;}.pdoc{--text:#212529;--muted:#6c757d;--link:#3660a5;--link-hover:#1659c5;--code:#f8f8f8;--active:#fff598;--accent:#eee;--accent2:#c1c1c1;--nav-hover:rgba(255, 255, 255, 0.5);--name:#0066BB;--def:#008800;--annotation:#007020;}</style>
<style>/*! layout.css */html, body{width:100%;height:100%;}html, main{scroll-behavior:smooth;}body{background-color:var(--pdoc-background);}@media (max-width:769px){#navtoggle{cursor:pointer;position:absolute;width:50px;height:40px;top:1rem;right:1rem;border-color:var(--text);color:var(--text);display:flex;opacity:0.8;z-index:999;}#navtoggle:hover{opacity:1;}#togglestate + div{display:none;}#togglestate:checked + div{display:inherit;}main, header{padding:2rem 3vw;}header + main{margin-top:-3rem;}.git-button{display:none !important;}nav input[type="search"]{max-width:77%;}nav input[type="search"]:first-child{margin-top:-6px;}nav input[type="search"]:valid ~ *{display:none !important;}}@media (min-width:770px){:root{--sidebar-width:clamp(12.5rem, 28vw, 22rem);}nav{position:fixed;overflow:auto;height:100vh;width:var(--sidebar-width);}main, header{padding:3rem 2rem 3rem calc(var(--sidebar-width) + 3rem);width:calc(54rem + var(--sidebar-width));max-width:100%;}header + main{margin-top:-4rem;}#navtoggle{display:none;}}#togglestate{position:absolute;height:0;opacity:0;}nav.pdoc{--pad:clamp(0.5rem, 2vw, 1.75rem);--indent:1.5rem;background-color:var(--accent);border-right:1px solid var(--accent2);box-shadow:0 0 20px rgba(50, 50, 50, .2) inset;padding:0 0 0 var(--pad);overflow-wrap:anywhere;scrollbar-width:thin; scrollbar-color:var(--accent2) transparent; z-index:1}nav.pdoc::-webkit-scrollbar{width:.4rem; }nav.pdoc::-webkit-scrollbar-thumb{background-color:var(--accent2); }nav.pdoc > div{padding:var(--pad) 0;}nav.pdoc .module-list-button{display:inline-flex;align-items:center;color:var(--text);border-color:var(--muted);margin-bottom:1rem;}nav.pdoc .module-list-button:hover{border-color:var(--text);}nav.pdoc input[type=search]{display:block;outline-offset:0;width:calc(100% - var(--pad));}nav.pdoc .logo{max-width:calc(100% - var(--pad));max-height:35vh;display:block;margin:0 auto 1rem;transform:translate(calc(-.5 * var(--pad)), 0);}nav.pdoc ul{list-style:none;padding-left:0;}nav.pdoc > div > ul{margin-left:calc(0px - var(--pad));}nav.pdoc li a{padding:.2rem 0 .2rem calc(var(--pad) + var(--indent));}nav.pdoc > div > ul > li > a{padding-left:var(--pad);}nav.pdoc li{transition:all 100ms;}nav.pdoc li:hover{background-color:var(--nav-hover);}nav.pdoc a, nav.pdoc a:hover{color:var(--text);}nav.pdoc a{display:block;}nav.pdoc > h2:first-of-type{margin-top:1.5rem;}nav.pdoc .class:before{content:"class ";color:var(--muted);}nav.pdoc .function:after{content:"()";color:var(--muted);}nav.pdoc footer:before{content:"";display:block;width:calc(100% - var(--pad));border-top:solid var(--accent2) 1px;margin-top:1.5rem;padding-top:.5rem;}nav.pdoc footer{font-size:small;}</style>
<style>/*! content.css */.pdoc{color:var(--text);box-sizing:border-box;line-height:1.5;background:none;}.pdoc .pdoc-button{cursor:pointer;display:inline-block;border:solid black 1px;border-radius:2px;font-size:.75rem;padding:calc(0.5em - 1px) 1em;transition:100ms all;}.pdoc .pdoc-alert{padding:1rem 1rem 1rem calc(1.5rem + 24px);border:1px solid transparent;border-radius:.25rem;background-repeat:no-repeat;background-position:1rem center;margin-bottom:1rem;}.pdoc .pdoc-alert > *:last-child{margin-bottom:0;}.pdoc .pdoc-alert-note {color:#084298;background-color:#cfe2ff;border-color:#b6d4fe;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23084298%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M8%2016A8%208%200%201%200%208%200a8%208%200%200%200%200%2016zm.93-9.412-1%204.705c-.07.34.029.533.304.533.194%200%20.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703%200-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381%202.29-.287zM8%205.5a1%201%200%201%201%200-2%201%201%200%200%201%200%202z%22/%3E%3C/svg%3E");}.pdoc .pdoc-alert-warning{color:#664d03;background-color:#fff3cd;border-color:#ffecb5;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23664d03%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M8.982%201.566a1.13%201.13%200%200%200-1.96%200L.165%2013.233c-.457.778.091%201.767.98%201.767h13.713c.889%200%201.438-.99.98-1.767L8.982%201.566zM8%205c.535%200%20.954.462.9.995l-.35%203.507a.552.552%200%200%201-1.1%200L7.1%205.995A.905.905%200%200%201%208%205zm.002%206a1%201%200%201%201%200%202%201%201%200%200%201%200-2z%22/%3E%3C/svg%3E");}.pdoc .pdoc-alert-danger{color:#842029;background-color:#f8d7da;border-color:#f5c2c7;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23842029%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M5.52.359A.5.5%200%200%201%206%200h4a.5.5%200%200%201%20.474.658L8.694%206H12.5a.5.5%200%200%201%20.395.807l-7%209a.5.5%200%200%201-.873-.454L6.823%209.5H3.5a.5.5%200%200%201-.48-.641l2.5-8.5z%22/%3E%3C/svg%3E");}.pdoc .visually-hidden{position:absolute !important;width:1px !important;height:1px !important;padding:0 !important;margin:-1px !important;overflow:hidden !important;clip:rect(0, 0, 0, 0) !important;white-space:nowrap !important;border:0 !important;}.pdoc h1, .pdoc h2, .pdoc h3{font-weight:300;margin:.3em 0;padding:.2em 0;}.pdoc > section:not(.module-info) h1{font-size:1.5rem;font-weight:500;}.pdoc > section:not(.module-info) h2{font-size:1.4rem;font-weight:500;}.pdoc > section:not(.module-info) h3{font-size:1.3rem;font-weight:500;}.pdoc > section:not(.module-info) h4{font-size:1.2rem;}.pdoc > section:not(.module-info) h5{font-size:1.1rem;}.pdoc a{text-decoration:none;color:var(--link);}.pdoc a:hover{color:var(--link-hover);}.pdoc blockquote{margin-left:2rem;}.pdoc pre{border-top:1px solid var(--accent2);border-bottom:1px solid var(--accent2);margin-top:0;margin-bottom:1em;padding:.5rem 0 .5rem .5rem;overflow-x:auto;background-color:var(--code);}.pdoc code{color:var(--text);padding:.2em .4em;margin:0;font-size:85%;background-color:var(--accent);border-radius:6px;}.pdoc a > code{color:inherit;}.pdoc pre > code{display:inline-block;font-size:inherit;background:none;border:none;padding:0;}.pdoc > section:not(.module-info){margin-bottom:1.5rem;}.pdoc .modulename{margin-top:0;font-weight:bold;}.pdoc .modulename a{color:var(--link);transition:100ms all;}.pdoc .git-button{float:right;border:solid var(--link) 1px;}.pdoc .git-button:hover{background-color:var(--link);color:var(--pdoc-background);}.view-source-toggle-state,.view-source-toggle-state ~ .pdoc-code{display:none;}.view-source-toggle-state:checked ~ .pdoc-code{display:block;}.view-source-button{display:inline-block;float:right;font-size:.75rem;line-height:1.5rem;color:var(--muted);padding:0 .4rem 0 1.3rem;cursor:pointer;text-indent:-2px;}.view-source-button > span{visibility:hidden;}.module-info .view-source-button{float:none;display:flex;justify-content:flex-end;margin:-1.2rem .4rem -.2rem 0;}.view-source-button::before{position:absolute;content:"View Source";display:list-item;list-style-type:disclosure-closed;}.view-source-toggle-state:checked ~ .attr .view-source-button::before,.view-source-toggle-state:checked ~ .view-source-button::before{list-style-type:disclosure-open;}.pdoc .docstring{margin-bottom:1.5rem;}.pdoc section:not(.module-info) .docstring{margin-left:clamp(0rem, 5vw - 2rem, 1rem);}.pdoc .docstring .pdoc-code{margin-left:1em;margin-right:1em;}.pdoc h1:target,.pdoc h2:target,.pdoc h3:target,.pdoc h4:target,.pdoc h5:target,.pdoc h6:target,.pdoc .pdoc-code > pre > span:target{background-color:var(--active);box-shadow:-1rem 0 0 0 var(--active);}.pdoc .pdoc-code > pre > span:target{display:block;}.pdoc div:target > .attr,.pdoc section:target > .attr,.pdoc dd:target > a{background-color:var(--active);}.pdoc *{scroll-margin:2rem;}.pdoc .pdoc-code .linenos{user-select:none;}.pdoc .attr:hover{filter:contrast(0.95);}.pdoc section, .pdoc .classattr{position:relative;}.pdoc .headerlink{--width:clamp(1rem, 3vw, 2rem);position:absolute;top:0;left:calc(0rem - var(--width));transition:all 100ms ease-in-out;opacity:0;}.pdoc .headerlink::before{content:"#";display:block;text-align:center;width:var(--width);height:2.3rem;line-height:2.3rem;font-size:1.5rem;}.pdoc .attr:hover ~ .headerlink,.pdoc *:target > .headerlink,.pdoc .headerlink:hover{opacity:1;}.pdoc .attr{display:block;margin:.5rem 0 .5rem;padding:.4rem .4rem .4rem 1rem;background-color:var(--accent);overflow-x:auto;}.pdoc .classattr{margin-left:2rem;}.pdoc .name{color:var(--name);font-weight:bold;}.pdoc .def{color:var(--def);font-weight:bold;}.pdoc .signature{background-color:transparent;}.pdoc .param, .pdoc .return-annotation{white-space:pre;}.pdoc .signature.multiline .param{display:block;}.pdoc .signature.condensed .param{display:inline-block;}.pdoc .annotation{color:var(--annotation);}.pdoc .view-value-toggle-state,.pdoc .view-value-toggle-state ~ .default_value{display:none;}.pdoc .view-value-toggle-state:checked ~ .default_value{display:inherit;}.pdoc .view-value-button{font-size:.5rem;vertical-align:middle;border-style:dashed;margin-top:-0.1rem;}.pdoc .view-value-button:hover{background:white;}.pdoc .view-value-button::before{content:"show";text-align:center;width:2.2em;display:inline-block;}.pdoc .view-value-toggle-state:checked ~ .view-value-button::before{content:"hide";}.pdoc .inherited{margin-left:2rem;}.pdoc .inherited dt{font-weight:700;}.pdoc .inherited dt, .pdoc .inherited dd{display:inline;margin-left:0;margin-bottom:.5rem;}.pdoc .inherited dd:not(:last-child):after{content:", ";}.pdoc .inherited .class:before{content:"class ";}.pdoc .inherited .function a:after{content:"()";}.pdoc .search-result .docstring{overflow:auto;max-height:25vh;}.pdoc .search-result.focused > .attr{background-color:var(--active);}.pdoc .attribution{margin-top:2rem;display:block;opacity:0.5;transition:all 200ms;filter:grayscale(100%);}.pdoc .attribution:hover{opacity:1;filter:grayscale(0%);}.pdoc .attribution img{margin-left:5px;height:35px;vertical-align:middle;width:70px;transition:all 200ms;}.pdoc table{display:block;width:max-content;max-width:100%;overflow:auto;margin-bottom:1rem;}.pdoc table th{font-weight:600;}.pdoc table th, .pdoc table td{padding:6px 13px;border:1px solid var(--accent2);}</style>
<style>/*! custom.css */</style></head>
<body>
<nav class="pdoc">
<label id="navtoggle" for="togglestate" class="pdoc-button"><svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 30 30'><path stroke-linecap='round' stroke="currentColor" stroke-miterlimit='10' stroke-width='2' d='M4 7h22M4 15h22M4 23h22'/></svg></label>
<input id="togglestate" type="checkbox" aria-hidden="true" tabindex="-1">
<div> <a class="pdoc-button module-list-button" href="index.html">
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-box-arrow-in-left" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M10 3.5a.5.5 0 0 0-.5-.5h-8a.5.5 0 0 0-.5.5v9a.5.5 0 0 0 .5.5h8a.5.5 0 0 0 .5-.5v-2a.5.5 0 0 1 1 0v2A1.5 1.5 0 0 1 9.5 14h-8A1.5 1.5 0 0 1 0 12.5v-9A1.5 1.5 0 0 1 1.5 2h8A1.5 1.5 0 0 1 11 3.5v2a.5.5 0 0 1-1 0v-2z"/>
<path fill-rule="evenodd" d="M4.146 8.354a.5.5 0 0 1 0-.708l3-3a.5.5 0 1 1 .708.708L5.707 7.5H14.5a.5.5 0 0 1 0 1H5.707l2.147 2.146a.5.5 0 0 1-.708.708l-3-3z"/>
</svg> &nbsp;
Module Index
</a>
<img src="https://www.unigraf.fi/app/themes/unigraf-theme/assets/images/unigraf-logo.png" class="logo" alt="project logo"/>
<input type="search" placeholder="Search..." role="searchbox" aria-label="search"
pattern=".+" required>
<a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
built with <span class="visually-hidden">pdoc</span><img
alt="pdoc logo"
src="data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20role%3D%22img%22%20aria-label%3D%22pdoc%20logo%22%20width%3D%22300%22%20height%3D%22150%22%20viewBox%3D%22-1%200%2060%2030%22%3E%3Ctitle%3Epdoc%3C/title%3E%3Cpath%20d%3D%22M29.621%2021.293c-.011-.273-.214-.475-.511-.481a.5.5%200%200%200-.489.503l-.044%201.393c-.097.551-.695%201.215-1.566%201.704-.577.428-1.306.486-2.193.182-1.426-.617-2.467-1.654-3.304-2.487l-.173-.172a3.43%203.43%200%200%200-.365-.306.49.49%200%200%200-.286-.196c-1.718-1.06-4.931-1.47-7.353.191l-.219.15c-1.707%201.187-3.413%202.131-4.328%201.03-.02-.027-.49-.685-.141-1.763.233-.721.546-2.408.772-4.076.042-.09.067-.187.046-.288.166-1.347.277-2.625.241-3.351%201.378-1.008%202.271-2.586%202.271-4.362%200-.976-.272-1.935-.788-2.774-.057-.094-.122-.18-.184-.268.033-.167.052-.339.052-.516%200-1.477-1.202-2.679-2.679-2.679-.791%200-1.496.352-1.987.9a6.3%206.3%200%200%200-1.001.029c-.492-.564-1.207-.929-2.012-.929-1.477%200-2.679%201.202-2.679%202.679A2.65%202.65%200%200%200%20.97%206.554c-.383.747-.595%201.572-.595%202.41%200%202.311%201.507%204.29%203.635%205.107-.037.699-.147%202.27-.423%203.294l-.137.461c-.622%202.042-2.515%208.257%201.727%2010.643%201.614.908%203.06%201.248%204.317%201.248%202.665%200%204.492-1.524%205.322-2.401%201.476-1.559%202.886-1.854%206.491.82%201.877%201.393%203.514%201.753%204.861%201.068%202.223-1.713%202.811-3.867%203.399-6.374.077-.846.056-1.469.054-1.537zm-4.835%204.313c-.054.305-.156.586-.242.629-.034-.007-.131-.022-.307-.157-.145-.111-.314-.478-.456-.908.221.121.432.25.675.355.115.039.219.051.33.081zm-2.251-1.238c-.05.33-.158.648-.252.694-.022.001-.125-.018-.307-.157-.217-.166-.488-.906-.639-1.573.358.344.754.693%201.198%201.036zm-3.887-2.337c-.006-.116-.018-.231-.041-.342.635.145%201.189.368%201.599.625.097.231.166.481.174.642-.03.049-.055.101-.067.158-.046.013-.128.026-.298.004-.278-.037-.901-.57-1.367-1.087zm-1.127-.497c.116.306.176.625.12.71-.019.014-.117.045-.345.016-.206-.027-.604-.332-.986-.695.41-.051.816-.056%201.211-.031zm-4.535%201.535c.209.22.379.47.358.598-.006.041-.088.138-.351.234-.144.055-.539-.063-.979-.259a11.66%2011.66%200%200%200%20.972-.573zm.983-.664c.359-.237.738-.418%201.126-.554.25.237.479.548.457.694-.006.042-.087.138-.351.235-.174.064-.694-.105-1.232-.375zm-3.381%201.794c-.022.145-.061.29-.149.401-.133.166-.358.248-.69.251h-.002c-.133%200-.306-.26-.45-.621.417.091.854.07%201.291-.031zm-2.066-8.077a4.78%204.78%200%200%201-.775-.584c.172-.115.505-.254.88-.378l-.105.962zm-.331%202.302a10.32%2010.32%200%200%201-.828-.502c.202-.143.576-.328.984-.49l-.156.992zm-.45%202.157l-.701-.403c.214-.115.536-.249.891-.376a11.57%2011.57%200%200%201-.19.779zm-.181%201.716c.064.398.194.702.298.893-.194-.051-.435-.162-.736-.398.061-.119.224-.3.438-.495zM8.87%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zm-.735-.389a1.15%201.15%200%200%200-.314.783%201.16%201.16%200%200%200%201.162%201.162c.457%200%20.842-.27%201.032-.653.026.117.042.238.042.362a1.68%201.68%200%200%201-1.679%201.679%201.68%201.68%200%200%201-1.679-1.679c0-.843.626-1.535%201.436-1.654zM5.059%205.406A1.68%201.68%200%200%201%203.38%207.085a1.68%201.68%200%200%201-1.679-1.679c0-.037.009-.072.011-.109.21.3.541.508.935.508a1.16%201.16%200%200%200%201.162-1.162%201.14%201.14%200%200%200-.474-.912c.015%200%20.03-.005.045-.005.926.001%201.679.754%201.679%201.68zM3.198%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zM1.375%208.964c0-.52.103-1.035.288-1.52.466.394%201.06.64%201.717.64%201.144%200%202.116-.725%202.499-1.738.383%201.012%201.355%201.738%202.499%201.738.867%200%201.631-.421%202.121-1.062.307.605.478%201.267.478%201.942%200%202.486-2.153%204.51-4.801%204.51s-4.801-2.023-4.801-4.51zm24.342%2019.349c-.985.498-2.267.168-3.813-.979-3.073-2.281-5.453-3.199-7.813-.705-1.315%201.391-4.163%203.365-8.423.97-3.174-1.786-2.239-6.266-1.261-9.479l.146-.492c.276-1.02.395-2.457.444-3.268a6.11%206.11%200%200%200%201.18.115%206.01%206.01%200%200%200%202.536-.562l-.006.175c-.802.215-1.848.612-2.021%201.25-.079.295.021.601.274.837.219.203.415.364.598.501-.667.304-1.243.698-1.311%201.179-.02.144-.022.507.393.787.213.144.395.26.564.365-1.285.521-1.361.96-1.381%201.126-.018.142-.011.496.427.746l.854.489c-.473.389-.971.914-.999%201.429-.018.278.095.532.316.713.675.556%201.231.721%201.653.721.059%200%20.104-.014.158-.02.207.707.641%201.64%201.513%201.64h.013c.8-.008%201.236-.345%201.462-.626.173-.216.268-.457.325-.692.424.195.93.374%201.372.374.151%200%20.294-.021.423-.068.732-.27.944-.704.993-1.021.009-.061.003-.119.002-.179.266.086.538.147.789.147.15%200%20.294-.021.423-.069.542-.2.797-.489.914-.754.237.147.478.258.704.288.106.014.205.021.296.021.356%200%20.595-.101.767-.229.438.435%201.094.992%201.656%201.067.106.014.205.021.296.021a1.56%201.56%200%200%200%20.323-.035c.17.575.453%201.289.866%201.605.358.273.665.362.914.362a.99.99%200%200%200%20.421-.093%201.03%201.03%200%200%200%20.245-.164c.168.428.39.846.68%201.068.358.273.665.362.913.362a.99.99%200%200%200%20.421-.093c.317-.148.512-.448.639-.762.251.157.495.257.726.257.127%200%20.25-.024.37-.071.427-.17.706-.617.841-1.314.022-.015.047-.022.068-.038.067-.051.133-.104.196-.159-.443%201.486-1.107%202.761-2.086%203.257zM8.66%209.925a.5.5%200%201%200-1%200c0%20.653-.818%201.205-1.787%201.205s-1.787-.552-1.787-1.205a.5.5%200%201%200-1%200c0%201.216%201.25%202.205%202.787%202.205s2.787-.989%202.787-2.205zm4.4%2015.965l-.208.097c-2.661%201.258-4.708%201.436-6.086.527-1.542-1.017-1.88-3.19-1.844-4.198a.4.4%200%200%200-.385-.414c-.242-.029-.406.164-.414.385-.046%201.249.367%203.686%202.202%204.896.708.467%201.547.7%202.51.7%201.248%200%202.706-.392%204.362-1.174l.185-.086a.4.4%200%200%200%20.205-.527c-.089-.204-.326-.291-.527-.206zM9.547%202.292c.093.077.205.114.317.114a.5.5%200%200%200%20.318-.886L8.817.397a.5.5%200%200%200-.703.068.5.5%200%200%200%20.069.703l1.364%201.124zm-7.661-.065c.086%200%20.173-.022.253-.068l1.523-.893a.5.5%200%200%200-.506-.863l-1.523.892a.5.5%200%200%200-.179.685c.094.158.261.247.432.247z%22%20transform%3D%22matrix%28-1%200%200%201%2058%200%29%22%20fill%3D%22%233bb300%22/%3E%3Cpath%20d%3D%22M.3%2021.86V10.18q0-.46.02-.68.04-.22.18-.5.28-.54%201.34-.54%201.06%200%201.42.28.38.26.44.78.76-1.04%202.38-1.04%201.64%200%203.1%201.54%201.46%201.54%201.46%203.58%200%202.04-1.46%203.58-1.44%201.54-3.08%201.54-1.64%200-2.38-.92v4.04q0%20.46-.04.68-.02.22-.18.5-.14.3-.5.42-.36.12-.98.12-.62%200-1-.12-.36-.12-.52-.4-.14-.28-.18-.5-.02-.22-.02-.68zm3.96-9.42q-.46.54-.46%201.18%200%20.64.46%201.18.48.52%201.2.52.74%200%201.24-.52.52-.52.52-1.18%200-.66-.48-1.18-.48-.54-1.26-.54-.76%200-1.22.54zm14.741-8.36q.16-.3.54-.42.38-.12%201-.12.64%200%201.02.12.38.12.52.42.16.3.18.54.04.22.04.68v11.94q0%20.46-.04.7-.02.22-.18.5-.3.54-1.7.54-1.38%200-1.54-.98-.84.96-2.34.96-1.8%200-3.28-1.56-1.48-1.58-1.48-3.66%200-2.1%201.48-3.68%201.5-1.58%203.28-1.58%201.48%200%202.3%201v-4.2q0-.46.02-.68.04-.24.18-.52zm-3.24%2010.86q.52.54%201.26.54.74%200%201.22-.54.5-.54.5-1.18%200-.66-.48-1.22-.46-.56-1.26-.56-.8%200-1.28.56-.48.54-.48%201.2%200%20.66.52%201.2zm7.833-1.2q0-2.4%201.68-3.96%201.68-1.56%203.84-1.56%202.16%200%203.82%201.56%201.66%201.54%201.66%203.94%200%201.66-.86%202.96-.86%201.28-2.1%201.9-1.22.6-2.54.6-1.32%200-2.56-.64-1.24-.66-2.1-1.92-.84-1.28-.84-2.88zm4.18%201.44q.64.48%201.3.48.66%200%201.32-.5.66-.5.66-1.48%200-.98-.62-1.46-.62-.48-1.34-.48-.72%200-1.34.5-.62.5-.62%201.48%200%20.96.64%201.46zm11.412-1.44q0%20.84.56%201.32.56.46%201.18.46.64%200%201.18-.36.56-.38.9-.38.6%200%201.46%201.06.46.58.46%201.04%200%20.76-1.1%201.42-1.14.8-2.8.8-1.86%200-3.58-1.34-.82-.64-1.34-1.7-.52-1.08-.52-2.36%200-1.3.52-2.34.52-1.06%201.34-1.7%201.66-1.32%203.54-1.32.76%200%201.48.22.72.2%201.06.4l.32.2q.36.24.56.38.52.4.52.92%200%20.5-.42%201.14-.72%201.1-1.38%201.1-.38%200-1.08-.44-.36-.34-1.04-.34-.66%200-1.24.48-.58.48-.58%201.34z%22%20fill%3D%22green%22/%3E%3C/svg%3E"/>
</a>
</div>
</nav>
<main class="pdoc">
<section class="module-info">
<h1 class="modulename">
Examples </h1>
<p>Here is a list of API usage examples.<ul>
<li><a href="#HDCP-example">HDCP example</a></li>
<li><a href="#EDID-example">EDID example</a></li>
<li><a href="#Pattern-Generator-example">Pattern Generator example</a></li>
<li><a href="#Audio-Generator-example">Audio Generator example</a></li>
<li><a href="#Adaptive-Sync-and-Scrolling-pattern-example">Adaptive-Sync and Scrolling pattern example</a></li>
<li><a href="#Bulk-Capturer-example">Bulk Capturer example</a></li>
<li><a href="#DP-Link-Sink-example">DP Link Sink example</a></li>
<li><a href="#DP-Link-Source-example">DP Link Source example</a></li>
<li><a href="#DUT-Test-example">DUT Test example</a></li>
<li><a href="#DUT-Test-example">DUT Test example</a></li>
<li><a href="#Event-capturer-example">Event capturer example</a></li>
<li><a href="#PDC-Capabilities-example">PDC Capabilities example</a></li>
<li><a href="#PDC-Controls-example">PDC Controls example</a></li>
<li><a href="#PDC-DP-Alt-mode-example">PDC DP Alt mode example</a></li>
<li><a href="#PDC-PDO-example">PDC PDO example</a></li>
<li><a href="#Video-Capturer">Video Capturer</a></li>
<li><a href="#Panel-Replay">Panel Replay</a></li>
<li><a href="#DSC-Generator">DSC Generator</a></li>
<li><a href="#DSC-Images">DSC Images</a></li>
</ul></p>
<div class="docstring"></br><h3 id="HDCP-example">HDCP example</h3><p>An example of working with a HDCP module.</p>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="c1">#</span>
<span class="c1"># Import UniTAP module.</span>
<span class="c1">#</span>
import<span class="w"> </span><span class="nb">time</span>
import<span class="w"> </span>UniTAP
<span class="c1">#</span>
<span class="c1"># To initialize UniTAP library wrapper user should create UniTAP.TsiLib() object.</span>
<span class="c1">#</span>
<span class="nv">lUniTAP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.TsiLib<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># For opening device, please, put serial number of the device as 8 symbol str or put index of device.</span>
<span class="c1">#</span>
<span class="c1"># dev = lUniTAP.open(&quot;NNNNNNNN&quot;)</span>
<span class="nv">dev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>lUniTAP.open<span class="o">(</span><span class="m">0</span><span class="o">)</span>
<span class="c1"># After opening device as in UCD Console device role should be selected.</span>
<span class="nv">role</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>dev.select_role<span class="o">(</span>UniTAP.dev.UCD400.DPSourceDPSink<span class="o">)</span>
<span class="c1"># role = dev.select_role(UniTAP.dev.UCD500.DPSourceDPSink)</span>
<span class="c1"># Print HDCP 1.4 and 2.3 statuses</span>
<span class="c1"># print(role.dptx.hdcp.status.get(UniTAP.HdcpStatus.Status1x))</span>
print<span class="o">(</span>role.dptx.hdcp.status.get<span class="o">(</span>UniTAP.HdcpStatus.StatusTx2x<span class="o">))</span>
<span class="c1"># print(role.dprx.hdcp.status.get(UniTAP.HdcpStatus.Status1x))</span>
print<span class="o">(</span>role.dprx.hdcp.status.get<span class="o">(</span>UniTAP.HdcpStatus.StatusRx2x<span class="o">))</span>
<span class="c1"># Set config HDCP 1.4 TX</span>
<span class="c1"># config = UniTAP.HdcpTxConfig.Config1x()</span>
<span class="c1"># config.encryption = True</span>
<span class="c1"># config.authenticate = True</span>
<span class="c1"># config.keys = UniTAP.HdcpSource1XKeys.Production</span>
<span class="c1"># role.dptx.hdcp.config.set(config)</span>
<span class="c1"># time.sleep(2)</span>
<span class="c1"># Set config HDCP 1.4 RX</span>
<span class="c1"># config = UniTAP.HdcpRxConfig.Config1x()</span>
<span class="c1"># config.keys = UniTAP.HdcpSink1XKeys.Production</span>
<span class="c1"># config.capable = True</span>
<span class="c1"># print(role.dptx.hdcp.status.get(UniTAP.HdcpStatus.Status1x))</span>
<span class="c1"># print(role.dptx.hdcp.status.get(UniTAP.HdcpStatus.StatusTx2x))</span>
<span class="c1"># print(role.dprx.hdcp.status.get(UniTAP.HdcpStatus.Status1x))</span>
<span class="c1"># print(role.dprx.hdcp.status.get(UniTAP.HdcpStatus.StatusRx2x))</span>
<span class="c1"># Set config HDCP 2.3</span>
<span class="nv">config</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.HdcpTxConfig.Config2x<span class="o">()</span>
config.encryption<span class="w"> </span><span class="o">=</span><span class="w"> </span>True
config.authenticate<span class="w"> </span><span class="o">=</span><span class="w"> </span>True
config.keys<span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.HdcpSource2XKeys.Production
config.store_km<span class="w"> </span><span class="o">=</span><span class="w"> </span>True
config.content_level<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span>
role.dptx.hdcp.config.set<span class="o">(</span>config<span class="o">)</span>
time.sleep<span class="o">(</span><span class="m">2</span><span class="o">)</span>
<span class="c1"># Set config HDCP 2.3 RX</span>
<span class="nv">config</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.HdcpRxConfig.Config2x<span class="o">()</span>
config.keys<span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.HdcpSink2XKeys.Production
config.capable<span class="w"> </span><span class="o">=</span><span class="w"> </span>True
<span class="c1"># print(role.dptx.hdcp.status.get(UniTAP.HdcpStatus.Status1x))</span>
print<span class="o">(</span>role.dptx.hdcp.status.get<span class="o">(</span>UniTAP.HdcpStatus.StatusTx2x<span class="o">))</span>
<span class="c1"># print(role.dprx.hdcp.status.get(UniTAP.HdcpStatus.Status1x))</span>
print<span class="o">(</span>role.dprx.hdcp.status.get<span class="o">(</span>UniTAP.HdcpStatus.StatusRx2x<span class="o">))</span>
<span class="c1"># Get config HDCP 1.4</span>
<span class="c1"># config_14 = role.dptx.hdcp.config.get(UniTAP.HdcpTxConfig.Config1x)</span>
<span class="c1"># Get config HDCP 2.3</span>
<span class="nv">config_23</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dptx.hdcp.config.get<span class="o">(</span>UniTAP.HdcpTxConfig.Config2x<span class="o">)</span>
<span class="c1"># For UCD-323 -&gt; UCD-301</span>
<span class="c1"># role_rx = dev_rx.select_role(UniTAP.dev.UCD301.HDMISink)</span>
<span class="c1"># role_tx = dev_tx.select_role(UniTAP.dev.UCD323.HDMISource)</span>
<span class="c1"># Print HDCP 1.4 and 2.3 statuses</span>
<span class="c1"># print(role_rx.hdrx.hdcp.status.get(UniTAP.HdcpStatus.Status1x))</span>
<span class="c1"># print(role_tx.hdtx.hdcp.status.get(UniTAP.HdcpStatus.Status1x))</span>
<span class="c1"># Set config HDCP 1.4</span>
<span class="c1"># config = UniTAP.HdcpTxConfig.Config1x()</span>
<span class="c1"># config.encryption = True</span>
<span class="c1"># config.authenticate = True</span>
<span class="c1"># config.keys = UniTAP.HdcpSource1XKeys.Production</span>
<span class="c1"># role_tx.hdtx.hdcp.config.set(config)</span>
<span class="c1"># time.sleep(2)</span>
<span class="c1"># print(role_rx.hdrx.hdcp.status.get(UniTAP.HdcpStatus.Status1x))</span>
<span class="c1"># print(role_tx.hdtx.hdcp.status.get(UniTAP.HdcpStatus.Status1x))</span>
<span class="c1">#</span>
<span class="c1"># Since the 3.5 version, TsiLib and TSIDevice objects have the option to be closed earlier.</span>
<span class="c1"># TSIDevice can be closed with the TsiLib method close(). TsiLib can be closed with cleanup().</span>
<span class="c1"># Clean up will close all opened devices and block ability to open any devices</span>
<span class="c1"># with same TsiLib object.</span>
<span class="c1">#</span>
lUniTAP.close<span class="o">(</span>dev<span class="o">)</span>
lUniTAP.cleanup<span class="o">(</span>
</code></pre>
</div>
</br><h3 id="EDID-example">EDID example</h3><p>An example of working with a EDID module.</p>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="c1">#</span>
<span class="c1"># Import UniTAP module.</span>
<span class="c1">#</span>
import<span class="w"> </span>UniTAP
<span class="c1">#</span>
<span class="c1"># To initialize UniTAP library wrapper user should create UniTAP.TsiLib() object.</span>
<span class="c1">#</span>
<span class="nv">lUniTAP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.TsiLib<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># For opening device, please, put serial number of the device as 8 symbol str or put index of device.</span>
<span class="c1">#</span>
<span class="c1"># dev = lUniTAP.open(&quot;NNNNNNNN&quot;)</span>
<span class="nv">dev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>lUniTAP.open<span class="o">(</span><span class="m">0</span><span class="o">)</span>
<span class="c1"># After opening device as in UCD Console device role should be selected.</span>
<span class="c1"># role = dev.select_role(UniTAP.dev.UCD323.DPSource)</span>
<span class="c1"># role = dev.select_role(UniTAP.dev.UCD323.HDMISource)</span>
<span class="nv">role</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>dev.select_role<span class="o">(</span>UniTAP.dev.UCD400.DPSourceDPSink<span class="o">)</span>
<span class="nv">timings_from_edid</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dprx.edid.read_timings<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># Since the 3.5 version, TsiLib and TSIDevice objects have the option to be closed earlier.</span>
<span class="c1"># TSIDevice can be closed with the TsiLib method close(). TsiLib can be closed with cleanup().</span>
<span class="c1"># Clean up will close all opened devices and block ability to open any devices</span>
<span class="c1"># with same TsiLib object.</span>
<span class="c1">#</span>
lUniTAP.close<span class="o">(</span>dev<span class="o">)</span>
lUniTAP.cleanup<span class="o">(</span>
</code></pre>
</div>
</br><h3 id="Pattern-Generator-example">Pattern Generator example</h3><p>An example of working with a Pattern Generator module.</p>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="c1">#</span>
<span class="c1"># Import UniTAP module.</span>
<span class="c1">#</span>
import<span class="w"> </span>UniTAP
import<span class="w"> </span><span class="nb">time</span>
<span class="c1">#</span>
<span class="c1"># To initialize UniTAP library wrapper user should create UniTAP.TsiLib() object.</span>
<span class="c1">#</span>
<span class="nv">lUniTAP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.TsiLib<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># For opening device, please, put serial number of the device as 8 symbol str or put index of device.</span>
<span class="c1">#</span>
<span class="c1"># dev = lUniTAP.open(&quot;NNNNNNNN&quot;)</span>
<span class="nv">dev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>lUniTAP.open<span class="o">(</span><span class="m">0</span><span class="o">)</span>
<span class="c1"># After opening device as in UCD Console device role should be selected.</span>
<span class="nv">role</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>dev.select_role<span class="o">(</span>UniTAP.dev.UCD400.DPSourceDPSink<span class="o">)</span>
<span class="c1"># role = dev.select_role(UniTAP.dev.UCD500.DPSourceDPSink)</span>
<span class="nv">timing_manager</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dptx.pg.timing_manager
<span class="nv">color_mode</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.ColorInfo<span class="o">()</span>
color_mode.color_format<span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.ColorInfo.ColorFormat.CF_RGB
color_mode.bpc<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">8</span>
color_mode.colorimetry<span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.ColorInfo.Colorimetry.CM_sRGB
<span class="nv">timings</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[</span>timing_manager.get_cta<span class="o">(</span><span class="m">16</span><span class="o">)</span>,
<span class="w"> </span>timing_manager.get_cta<span class="o">(</span><span class="m">12</span><span class="o">)</span>,
<span class="w"> </span>timing_manager.get_cta<span class="o">(</span><span class="m">1</span><span class="o">)</span>,
<span class="w"> </span>timing_manager.get_cta<span class="o">(</span><span class="m">19</span><span class="o">)]</span>
<span class="c1"># Also, possible to select timing with using functions: &#39;get_dmt&#39;, &#39;get_cvt&#39;, &#39;get_by_list_index&#39;, &#39;get_all&#39;</span>
<span class="c1"># Print all available timings</span>
print<span class="o">(</span>timing_manager.print_all<span class="o">())</span>
<span class="c1">#</span>
<span class="c1"># If you want to select pattern, you need to use enum &#39;VideoPattern&#39; from UniTAP.</span>
<span class="c1"># Like this: UniTAP.VideoPattern.ColorRamp</span>
<span class="c1">#</span>
<span class="c1"># Iterate for each available streams</span>
<span class="k">for</span><span class="w"> </span>i<span class="w"> </span><span class="k">in</span><span class="w"> </span>range<span class="o">(</span>role.dptx.pg.max_stream_count<span class="o">)</span>:
<span class="w"> </span><span class="nv">video_mode</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.VideoMode<span class="o">(</span><span class="nv">timing</span><span class="o">=</span>timings<span class="o">[</span>i<span class="o">]</span>,<span class="w"> </span><span class="nv">color_info</span><span class="o">=</span>color_mode<span class="o">)</span>
<span class="w"> </span>role.dptx.pg<span class="o">[</span>i<span class="o">]</span>.set_vm<span class="o">(</span><span class="nv">vm</span><span class="o">=</span>video_mode<span class="o">)</span>
<span class="w"> </span>role.dptx.pg<span class="o">[</span>i<span class="o">]</span>.set_pattern<span class="o">(</span><span class="nv">pattern</span><span class="o">=</span>UniTAP.VideoPattern.ColorRamp<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="nv">i</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="m">0</span><span class="w"> </span><span class="k">else</span><span class="w"> </span>UniTAP.VideoPattern.SolidGreen<span class="o">)</span>
<span class="w"> </span>role.dptx.pg<span class="o">[</span>i<span class="o">]</span>.apply<span class="o">()</span>
<span class="w"> </span><span class="nv">res_app</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dptx.pg<span class="o">[</span>i<span class="o">]</span>.status<span class="o">()</span>.error
<span class="w"> </span>print<span class="o">(</span>f<span class="s2">&quot;Stream {i} - Apply {res_app.__str__()}&quot;</span><span class="o">)</span>
<span class="c1">#</span>
<span class="c1"># After configure Pattern Generators, MST should be enabled in link module as well as selected</span>
<span class="c1"># stream count</span>
<span class="c1">#</span>
<span class="nv">cfg</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dptx.link.config.get<span class="o">()</span>
cfg.mst<span class="w"> </span><span class="o">=</span><span class="w"> </span>True
cfg.mst_stream_count<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">4</span>
role.dptx.link.config.set<span class="o">(</span>cfg<span class="o">)</span>
role.dptx.link.start_link_training<span class="o">()</span>
<span class="nv">cfg</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dprx.link.capabilities.link_caps_status<span class="o">()</span>
cfg.mst<span class="w"> </span><span class="o">=</span><span class="w"> </span>True
cfg.dp_128_132_bitrates<span class="w"> </span><span class="o">=</span><span class="w"> </span>None
cfg.override_10g<span class="w"> </span><span class="o">=</span><span class="w"> </span>None
role.dprx.link.capabilities.set<span class="o">(</span>cfg<span class="o">)</span>
role.dprx.link.hpd_pulse<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># Just random sleep, to be sure that Sink get video</span>
<span class="c1">#</span>
time.sleep<span class="o">(</span><span class="m">2</span><span class="o">)</span>
<span class="k">for</span><span class="w"> </span>i<span class="w"> </span><span class="k">in</span><span class="w"> </span>range<span class="o">(</span>role.dptx.pg.max_stream_count<span class="o">)</span>:
<span class="w"> </span><span class="nv">res</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dprx.link.status.stream<span class="o">(</span>i<span class="o">)</span>.video_mode.timing<span class="w"> </span><span class="o">==</span><span class="w"> </span>timings<span class="o">[</span>i<span class="o">]</span>
<span class="w"> </span>print<span class="o">(</span>f<span class="s1">&#39;Stream {i}</span>
<span class="s1">&#39;</span>
<span class="w"> </span>f<span class="s1">&#39;Reference timing: {timings[i]}. &#39;</span>
<span class="w"> </span>f<span class="s1">&#39;Received timing RX: {role.dprx.link.status.stream(i).video_mode.timing}.</span>
<span class="s1">&#39;</span>
<span class="w"> </span>f<span class="s1">&#39;Result: {res}&#39;</span><span class="o">)</span>
<span class="c1">#</span>
<span class="c1"># Since the 3.5 version, TsiLib and TSIDevice objects have the option to be closed earlier.</span>
<span class="c1"># TSIDevice can be closed with the TsiLib method close(). TsiLib can be closed with cleanup().</span>
<span class="c1"># Clean up will close all opened devices and block ability to open any devices</span>
<span class="c1"># with same TsiLib object.</span>
<span class="c1">#</span>
lUniTAP.close<span class="o">(</span>dev<span class="o">)</span>
lUniTAP.cleanup<span class="o">(</span>
</code></pre>
</div>
</br><h3 id="Audio-Generator-example">Audio Generator example</h3><p>An example of working with a Audio Generator module.</p>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="c1">#</span>
<span class="c1"># Import UniTAP module.</span>
<span class="c1">#</span>
import<span class="w"> </span>UniTAP
import<span class="w"> </span><span class="nb">time</span>
<span class="c1">#</span>
<span class="c1"># To initialize UniTAP library wrapper user should create UniTAP.TsiLib() object.</span>
<span class="c1">#</span>
<span class="nv">lUniTAP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.TsiLib<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># For opening device, please, put serial number of the device as 8 symbol str or put index of device.</span>
<span class="c1">#</span>
<span class="c1"># dev_tx = lUniTAP.open(&quot;NNNNNNNN&quot;)</span>
<span class="c1"># dev_rx = lUniTAP.open(&quot;MMMMMMMM&quot;)</span>
<span class="c1"># dev = lUniTAP.open(&quot;NNNNNNNN&quot;)</span>
<span class="c1"># dev_tx = lUniTAP.open(0)</span>
<span class="c1"># dev_rx = lUniTAP.open(1)</span>
<span class="nv">dev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>lUniTAP.open<span class="o">(</span><span class="m">0</span><span class="o">)</span>
<span class="c1"># After opening device as in UCD Console device role should be selected.</span>
<span class="c1"># role_tx = dev_tx.select_role(UniTAP.dev.UCD323.DPSource)</span>
<span class="c1"># role_rx = dev_rx.select_role(UniTAP.dev.UCD323.DPSink)</span>
<span class="nv">roles</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>dev.select_role<span class="o">(</span>UniTAP.dev.UCD400.DPSourceDPSink<span class="o">)</span>
<span class="nv">role_tx</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>roles.dptx
<span class="nv">role_rx</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>roles.dprx
<span class="c1"># For HDMI uncomment following lines, and comment previous lines.</span>
<span class="c1"># role_tx = dev_tx.select_role(UniTAP.dev.UCD323.HDMISource)</span>
<span class="c1"># role_rx = dev_rx.select_role(UniTAP.dev.UCD323.HDMISink)</span>
<span class="c1"># roles = dev.select_role(UniTAP.dev.UCD422.HDMISourceHDMISink)</span>
<span class="c1"># role_tx = roles.hdtx</span>
<span class="c1"># role_rx = roles.hdrx</span>
<span class="c1"># For configure Pattern Generator, you should call function &#39;setup&#39; with parameters:</span>
<span class="c1"># number of stream(for UCD 323 DP TX and HDMI will be 0)</span>
<span class="c1"># Video mode - describe selected Timing and ColorMode</span>
<span class="c1"># Timing contain info about all resolutions (like H and V Total, H and V Active and so on), frame rate,</span>
<span class="c1"># timing standard (CVT, DMT, CTA)</span>
<span class="c1"># ColorMode contain info about colorimetry, color_format(RGB, YCbCr444, YCbCr422 and so on),</span>
<span class="c1"># dynamic_range(VESA or CTA) and bits per color (like 8, 10, 12, 16)</span>
<span class="c1"># content_type - one of the value from enum PGPatternID</span>
<span class="c1"># content_data - path to image or bytearray of image (if selected PGPatternID.ImageFile)</span>
<span class="c1"># For using our predefined device specific timings, you can use &#39;timing manager&#39; with which you can get them.</span>
<span class="c1"># Timing manager available in dptx and hdtx roles.</span>
<span class="c1"># timing_manager = role_tx.dptx.pg.timing_manager</span>
<span class="c1"># For HDMI uncomment following lines, and comment previous lines.</span>
<span class="c1"># timing_manager = role_tx.hdtx.pg.timing_manager</span>
<span class="nv">timing_manager</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role_tx.pg.timing_manager
<span class="c1"># timing_manager allow to get full timing information from device. For example method get_cta(id) will return Timing</span>
<span class="c1"># if there any available CTA timing with VIC=id</span>
<span class="nv">timing</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>timing_manager.get_cta<span class="o">(</span><span class="m">16</span><span class="o">)</span>
<span class="nv">color_mode</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.ColorInfo<span class="o">()</span>
color_mode.color_format<span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.ColorInfo.ColorFormat.CF_RGB
color_mode.bpc<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">8</span>
color_mode.colorimetry<span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.ColorInfo.Colorimetry.CM_sRGB
<span class="nv">video_mode</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.VideoMode<span class="o">(</span><span class="nv">timing</span><span class="o">=</span>timing,<span class="w"> </span><span class="nv">color_info</span><span class="o">=</span>color_mode<span class="o">)</span>
<span class="c1">#</span>
<span class="c1"># Start generate video.</span>
<span class="c1">#</span>
<span class="c1"># If you want to select pattern, you need to use enum &#39;VideoPattern&#39; from UniTAP. </span>
<span class="c1"># Like this: UniTAP.VideoPattern.ColorRamp</span>
<span class="c1"># role_tx.dptx.pg.set_vm(vm=video_mode)</span>
<span class="c1"># role_tx.dptx.pg.set_pattern(pattern=UniTAP.VideoPattern.ColorRamp)</span>
<span class="c1"># res = role_tx.dptx.pg.apply()</span>
<span class="c1"># For HDMI uncomment following lines, and comment previous lines.</span>
<span class="c1"># role_tx.hdtx.pg.set_vm(vm=video_mode)</span>
<span class="c1"># role_tx.hdtx.pg.set_pattern(pattern=UniTAP.VideoPattern.ColorRamp)</span>
<span class="c1"># res = role_tx.hdtx.pg.apply()</span>
role_tx.pg.set_vm<span class="o">(</span><span class="nv">vm</span><span class="o">=</span>video_mode<span class="o">)</span>
role_tx.pg.set_pattern<span class="o">(</span><span class="nv">pattern</span><span class="o">=</span>UniTAP.VideoPattern.ColorRamp<span class="o">)</span>
<span class="nv">res</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role_tx.pg.apply<span class="o">()</span>
<span class="k">if</span><span class="w"> </span>res:
<span class="w"> </span>print<span class="o">(</span><span class="s2">&quot;Pattern generator configure success&quot;</span><span class="o">)</span>
<span class="c1"># HPD Control. For DP Possible to control HPD (assert/deassert) and generate HPD pulse with required length,</span>
<span class="c1"># for HDMI only HPD (assert/deassert)</span>
<span class="c1"># role_rx.dprx.link.set_assert_state(True)</span>
<span class="c1"># role_rx.dprx.link.hpd_pulse()</span>
<span class="c1"># For HDMI uncomment following lines, and comment previous lines.</span>
<span class="c1"># role_rx.hdrx.link.status.set_assert_state(True)</span>
role_rx.link.set_assert_state<span class="o">(</span>True<span class="o">)</span>
role_rx.link.hpd_pulse<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># Start generate audio</span>
<span class="c1">#</span>
<span class="c1"># For starting generate audio, need to config audio generator with following parameters:</span>
<span class="c1"># AudioMode - contain info about sample rate, bits count and channel count</span>
<span class="c1"># audio pattern - value from enum AudioPattern (like UniTAP.AudioPattern.SignalSine)</span>
<span class="nv">audio_mode</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.AudioMode<span class="o">()</span>
audio_mode.channel_count<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">2</span>
audio_mode.bits<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">16</span>
audio_mode.sample_rate<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">44100</span>
<span class="c1"># role_tx.dptx.ag.setup(audio_mode=audio_mode, audio_pattern=UniTAP.AudioPattern.SignalSine,</span>
<span class="c1"># signal_frequency=1000, amplitude=60)</span>
<span class="c1"># res = role_tx.dptx.ag.apply()</span>
<span class="c1"># For HDMI uncomment following lines, and comment previous lines.</span>
<span class="c1"># role_tx.hdtx.ag.setup(audio_mode=audio_mode, audio_pattern=&#39;Sine&#39;, signal_frequency=1000, amplitude=60)</span>
<span class="c1"># res = role_tx.hdtx.ag.apply()</span>
role_tx.ag.setup<span class="o">(</span><span class="nv">audio_mode</span><span class="o">=</span>audio_mode,<span class="w"> </span><span class="nv">audio_pattern</span><span class="o">=</span>UniTAP.AudioPattern.SignalSine,<span class="w"> </span><span class="nv">signal_frequency</span><span class="o">=</span><span class="m">1000</span>,<span class="w"> </span><span class="nv">amplitude</span><span class="o">=</span><span class="m">60</span><span class="o">)</span>
<span class="nv">res</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role_tx.ag.apply<span class="o">()</span>
<span class="k">if</span><span class="w"> </span>res:
<span class="w"> </span>print<span class="o">(</span><span class="s2">&quot;Audio generator configure success&quot;</span><span class="o">)</span>
<span class="c1"># time.sleep(5)</span>
<span class="c1"># role.dptx.ag.stop_generate()</span>
<span class="c1"># role.hdtx.ag.stop_generate()</span>
<span class="c1">#</span>
<span class="c1"># Read current video mode and crc</span>
<span class="c1">#</span>
time.sleep<span class="o">(</span><span class="m">1</span><span class="o">)</span>
<span class="c1"># Sometimes RX need some time to start getting video (will be improved in the future versions).</span>
<span class="c1"># Get current stream status (VM, CRC, DSC CRC)</span>
<span class="c1"># stream = role_rx.dprx.link.status.stream(0)</span>
<span class="c1"># print(stream)</span>
<span class="c1"># For HDMI uncomment following lines, and comment previous lines.</span>
<span class="c1"># stream = role_rx.hdrx.link.status.stream(0)</span>
<span class="c1"># print(stream)</span>
<span class="nv">stream</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role_rx.link.status.stream<span class="o">(</span><span class="m">0</span><span class="o">)</span>
print<span class="o">(</span>stream<span class="o">)</span>
<span class="c1">#</span>
<span class="c1"># Check and capture audio</span>
<span class="c1">#</span>
<span class="c1"># role_rx.dprx.audio_capturer.start(m_sec=5000)</span>
<span class="c1"># audio_capture_result = role_rx.dprx.audio_capturer.capture_result</span>
<span class="c1"># For HDMI uncomment following lines, and comment previous lines.</span>
<span class="c1"># role_rx.hdrx.audio_capturer.start(m_sec=5000)</span>
<span class="c1"># audio_capture_result = role_rx.hdrx.audio_capturer.capture_result</span>
role_rx.audio_capturer.start<span class="o">(</span><span class="nv">m_sec</span><span class="o">=</span><span class="m">5000</span><span class="o">)</span>
<span class="nv">audio_capture_result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role_rx.audio_capturer.capture_result
<span class="c1">#</span>
<span class="c1"># Save captured audio to wav file</span>
<span class="c1">#</span>
print<span class="o">(</span>audio_capture_result.audio_mode.__str__<span class="o">())</span>
audio_capture_result.save_to_file<span class="o">(</span><span class="nv">file_format</span><span class="o">=</span>UniTAP.AudioFileFormat.WAV,<span class="w"> </span><span class="nv">path</span><span class="o">=</span><span class="s2">&quot;example&quot;</span><span class="o">)</span>
<span class="c1">#</span>
<span class="c1"># Run Audio test &#39;Validate audio signal frequency and glitch-free audio reproduction&#39;</span>
<span class="c1">#</span>
<span class="c1"># params = role_rx.dut_tests.default_params_of_group(UniTAP.TestGroupId.AUDIO_TEST)</span>
<span class="nv">group_test</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.TestGroupId.AUDIO_TEST
<span class="c1"># params = role_rx.dut_tests.get_default_parameters(UniTAP.AudioTestParam)</span>
<span class="nv">params</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>roles.dut_tests.get_default_parameters<span class="o">(</span>UniTAP.AudioTestParam<span class="o">)</span>
params.sample_rate<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">44100</span>
params.audio_frequency<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1000</span>
params.frequency_tolerance<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span>
params.save_conditions<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">&#39;All&#39;</span>
params.storage_folder<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;./&quot;</span>
<span class="c1"># role_rx.dut_tests.run(group_test, 3, params)</span>
<span class="c1"># results = role_rx.dut_tests.get_all_tests_results()</span>
roles.dut_tests.run<span class="o">(</span>group_test,<span class="w"> </span><span class="m">3</span>,<span class="w"> </span>params<span class="o">)</span>
<span class="nv">results</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>roles.dut_tests.get_all_tests_results<span class="o">()</span>
print<span class="o">(</span>results.all_test_results<span class="o">()[</span><span class="m">0</span><span class="o">]</span>.test_result<span class="o">)</span>
<span class="c1">#</span>
<span class="c1"># Since the 3.5 version, TsiLib and TSIDevice objects have the option to be closed earlier.</span>
<span class="c1"># TSIDevice can be closed with the TsiLib method close(). TsiLib can be closed with cleanup().</span>
<span class="c1"># Clean up will close all opened devices and block ability to open any devices</span>
<span class="c1"># with same TsiLib object.</span>
<span class="c1">#</span>
lUniTAP.close<span class="o">(</span>dev<span class="o">)</span>
lUniTAP.cleanup<span class="o">()</span>
</code></pre>
</div>
</br><h3 id="Adaptive-Sync-and-Scrolling-pattern-example">Adaptive-Sync and Scrolling pattern example</h3><p>An example of working with a Adaptive-Sync and Scrolling pattern.</p>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="c1">#</span>
<span class="c1"># Import UniTAP module.</span>
<span class="c1">#</span>
import<span class="w"> </span>UniTAP
<span class="c1">#</span>
<span class="c1"># To initialize UniTAP library wrapper user should create UniTAP.TsiLib() object.</span>
<span class="c1">#</span>
<span class="nv">lUniTAP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.TsiLib<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># For opening device, please, put serial number of the device as 8 symbol str or put index of device.</span>
<span class="c1">#</span>
<span class="c1"># dev = lUniTAP.open(&quot;NNNNNNNN&quot;)</span>
<span class="nv">dev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>lUniTAP.open<span class="o">(</span><span class="m">0</span><span class="o">)</span>
<span class="c1"># After opening device as in UCD Console device role should be selected.</span>
<span class="nv">role</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>dev.select_role<span class="o">(</span>UniTAP.dev.UCD400.DPSourceDPSink<span class="o">)</span>
<span class="c1"># role = dev.select_role(UniTAP.dev.UCD500.DPSourceDPSink)</span>
<span class="nv">timing_manager</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dptx.pg.timing_manager
<span class="nv">timings</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>timing_manager.get_all<span class="o">()</span>
<span class="nv">color_mode</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.ColorInfo<span class="o">()</span>
color_mode.color_format<span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.ColorInfo.ColorFormat.CF_RGB
color_mode.bpc<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">8</span>
color_mode.colorimetry<span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.ColorInfo.Colorimetry.CM_sRGB
<span class="nv">video_mode</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.VideoMode<span class="o">(</span><span class="nv">timing</span><span class="o">=</span>timings<span class="o">[</span><span class="m">0</span><span class="o">]</span>,<span class="w"> </span><span class="nv">color_info</span><span class="o">=</span>color_mode<span class="o">)</span>
role.dptx.pg.set_vm<span class="o">(</span><span class="nv">vm</span><span class="o">=</span>video_mode<span class="o">)</span>
role.dptx.pg.set_pattern<span class="o">(</span><span class="nv">pattern</span><span class="o">=</span>UniTAP.VideoPattern.ColorRamp<span class="o">)</span>
<span class="c1"># I case: configure ConstantASParams</span>
role.dptx.pg.set_as_config<span class="o">(</span><span class="nv">as_config</span><span class="o">=</span>UniTAP.ConstantASParams<span class="o">(</span><span class="nv">lines</span><span class="o">=</span><span class="m">20</span><span class="o">))</span>
<span class="c1"># II case: configure SquareASParams</span>
role.dptx.pg.set_as_config<span class="o">(</span><span class="nv">as_config</span><span class="o">=</span>UniTAP.SquareASParams<span class="o">(</span><span class="nv">min_lanes</span><span class="o">=</span><span class="m">0</span>,<span class="w"> </span><span class="nv">max_lanes</span><span class="o">=</span><span class="m">1000</span>,<span class="w"> </span><span class="nv">period_frames</span><span class="o">=</span><span class="m">10</span><span class="o">))</span>
<span class="c1"># III case: configure ZigzagASParams</span>
role.dptx.pg.set_as_config<span class="o">(</span><span class="nv">as_config</span><span class="o">=</span>UniTAP.ZigzagASParams<span class="o">(</span><span class="nv">min_lanes</span><span class="o">=</span><span class="m">0</span>,<span class="w"> </span><span class="nv">max_lanes</span><span class="o">=</span><span class="m">1000</span>,<span class="w"> </span><span class="nv">increase_lines</span><span class="o">=</span><span class="m">100</span>,
<span class="w"> </span><span class="nv">decrease_lines</span><span class="o">=</span><span class="m">100</span><span class="o">))</span>
<span class="c1"># IV case: configure FixedASParams</span>
role.dptx.pg.set_as_config<span class="o">(</span><span class="nv">as_config</span><span class="o">=</span>UniTAP.FixedASParams<span class="o">(</span><span class="nv">refresh_rate</span><span class="o">=</span><span class="m">60</span>,<span class="w"> </span><span class="nv">divide_by_1_001</span><span class="o">=</span>False,<span class="w"> </span><span class="nv">increase_lines</span><span class="o">=</span><span class="m">100</span>,
<span class="w"> </span><span class="nv">decrease_lines</span><span class="o">=</span><span class="m">100</span><span class="o">))</span>
<span class="c1"># Configure Scrolling Pattern Params</span>
role.dptx.pg.set_scrolling_params<span class="o">(</span>UniTAP.StepsScrollingParams<span class="o">(</span><span class="nv">horizontally</span><span class="o">=</span><span class="m">20</span>,<span class="w"> </span><span class="nv">vertically</span><span class="o">=</span><span class="m">20</span>,<span class="w"> </span><span class="nv">frames</span><span class="o">=</span><span class="m">10</span><span class="o">))</span>
role.dptx.pg.apply<span class="o">()</span>
<span class="nv">res_app</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dptx.pg.status<span class="o">()</span>.error
print<span class="o">(</span>f<span class="s2">&quot;Stream 0 - Apply {res_app.__str__()}&quot;</span><span class="o">)</span>
print<span class="o">(</span>role.dptx.pg<span class="o">[</span><span class="m">0</span><span class="o">]</span>.adaptive_sync_status<span class="o">())</span>
<span class="c1">#</span>
<span class="c1"># Since the 3.5 version, TsiLib and TSIDevice objects have the option to be closed earlier.</span>
<span class="c1"># TSIDevice can be closed with the TsiLib method close(). TsiLib can be closed with cleanup().</span>
<span class="c1"># Clean up will close all opened devices and block ability to open any devices</span>
<span class="c1"># with same TsiLib object.</span>
<span class="c1">#</span>
lUniTAP.close<span class="o">(</span>dev<span class="o">)</span>
lUniTAP.cleanup<span class="o">(</span>
</code></pre>
</div>
</br><h3 id="Bulk-Capturer-example">Bulk Capturer example</h3><p>An example of working with a Bulk Capturer module.</p>
<div class="pdoc-code codehilite">
<pre><span></span><code>import<span class="w"> </span>UniTAP
import<span class="w"> </span><span class="nb">time</span>
import<span class="w"> </span>threading
def<span class="w"> </span>link_training<span class="o">(</span>dev_role<span class="o">)</span>:
<span class="w"> </span>time.sleep<span class="o">(</span><span class="m">1</span><span class="o">)</span>
<span class="w"> </span>dev_role.dptx.link.start_link_training<span class="o">()</span>
<span class="nv">lUniTAP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.TsiLib<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># For opening device, please, put serial number of the device as 8 symbol str or put index of device.</span>
<span class="c1">#</span>
<span class="c1"># dev = lUniTAP.open(&quot;NNNNNNNN&quot;)</span>
<span class="nv">dev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>lUniTAP.open<span class="o">(</span><span class="m">0</span><span class="o">)</span>
<span class="c1"># Need to select type of device: UCD-400 or UCD-500</span>
<span class="nv">role</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>dev.select_role<span class="o">(</span>UniTAP.dev.UCD400.DPSourceDPSink<span class="o">)</span>
<span class="c1"># role = dev.select_role(UniTAP.dev.UCD500.DPSourceDPSink)</span>
<span class="c1"># bulk_size - size of data in megabytes</span>
<span class="c1"># trigger_position - available position of trigger. Variants: TP_Start, TP_25, TP_50, TP_75, TP_End</span>
<span class="c1"># trigger_config - one of the variant of active trigger.</span>
<span class="c1"># assume_scrambler - just flag of assume scrambler</span>
<span class="nv">bulk_size</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">100</span>
<span class="c1"># Case without trigger</span>
<span class="c1"># role.dprx.bulk_capturer.start(bulk_size=bulk_size, trigger_position=UniTAP.bulk.TriggerPosition.TP_Start,</span>
<span class="c1"># assume_scrambler=False, gpio=False)</span>
<span class="c1"># Case with trigger</span>
<span class="c1"># In loopback mode we need to use special function for calling &#39;trigger&#39;.</span>
<span class="c1"># In current case we need to call &#39;link training&#39;.</span>
<span class="nv">thread</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>threading.Thread<span class="o">(</span><span class="nv">target</span><span class="o">=</span>link_training,<span class="w"> </span><span class="nv">args</span><span class="o">=(</span>role,<span class="o">))</span>
<span class="nv">trigger_config</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.bulk.TriggerType.U13<span class="o">()</span>
trigger_config.position<span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.bulk.TriggerTypeEnum.SourceTypePosition.InitialLT
thread.start<span class="o">()</span>
role.dprx.bulk_capturer.start<span class="o">(</span><span class="nv">bulk_size</span><span class="o">=</span>bulk_size,<span class="w"> </span><span class="nv">trigger_position</span><span class="o">=</span>UniTAP.bulk.TriggerPosition.TP_Start,
<span class="w"> </span><span class="nv">trigger_config</span><span class="o">=</span>trigger_config,
<span class="w"> </span><span class="nv">assume_scrambler</span><span class="o">=</span>False,<span class="w"> </span><span class="nv">gpio</span><span class="o">=</span>False<span class="o">)</span>
role.dprx.bulk_capturer.stop<span class="o">()</span>
thread.join<span class="o">()</span>
thread.stop_thread<span class="w"> </span><span class="o">=</span><span class="w"> </span>False
<span class="c1"># If you want to get captured data, please, use &#39;capture_result&#39;. It is the object of class &#39;ResultBulkObject&#39;.</span>
<span class="c1"># For saving data in file, please, use &#39;save_to_bin_file&#39;. You need to set &#39;directory_name&#39; - name of directory,</span>
<span class="c1"># where you want to save files. If directory have already existed, is will be clean up.</span>
<span class="c1"># If directory does not exist, it will be created.</span>
<span class="nv">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dprx.bulk_capturer.capture_result
<span class="nv">directory_name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;./BulkData&quot;</span>
result.save_to_bin_file<span class="o">(</span><span class="nv">directory_name</span><span class="o">=</span>directory_name<span class="o">)</span>
<span class="c1">#</span>
<span class="c1"># Since the 3.5 version, TsiLib and TSIDevice objects have the option to be closed earlier.</span>
<span class="c1"># TSIDevice can be closed with the TsiLib method close(). TsiLib can be closed with cleanup().</span>
<span class="c1"># Clean up will close all opened devices and block ability to open any devices</span>
<span class="c1"># with same TsiLib object.</span>
<span class="c1">#</span>
lUniTAP.close<span class="o">(</span>dev<span class="o">)</span>
lUniTAP.cleanup<span class="o">(</span>
</code></pre>
</div>
</br><h3 id="DP-Link-Sink-example">DP Link Sink example</h3><p>An example of working with a DP Link Sink module.</p>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="c1">#</span>
<span class="c1"># Import UniTAP module.</span>
<span class="c1">#</span>
import<span class="w"> </span>UniTAP
<span class="c1">#</span>
<span class="c1"># To initialize UniTAP library wrapper user should create UniTAP.TsiLib() object.</span>
<span class="c1">#</span>
<span class="nv">lUniTAP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.TsiLib<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># For opening device, please, put serial number of the device as 8 symbol str or put index of device.</span>
<span class="c1">#</span>
<span class="c1"># dev = lUniTAP.open(&quot;NNNNNNNN&quot;)</span>
<span class="nv">dev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>lUniTAP.open<span class="o">(</span><span class="m">0</span><span class="o">)</span>
<span class="c1"># After opening device as in UCD Console device role should be selected.</span>
<span class="c1"># role = dev.select_role(UniTAP.dev.UCD400.DPSourceDPSink)</span>
<span class="nv">role</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>dev.select_role<span class="o">(</span>UniTAP.dev.UCD500.DPSourceDPSink<span class="o">)</span>
<span class="c1">#</span>
<span class="c1"># Read current Link Status</span>
<span class="c1">#</span>
print<span class="o">(</span>role.dprx.link.status.cable_state<span class="o">)</span>
<span class="c1"># Read status of lane 0</span>
<span class="nv">lane_status</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dprx.link.status.lane<span class="o">(</span><span class="m">0</span><span class="o">)</span>
print<span class="o">(</span>lane_status<span class="o">)</span>
<span class="c1"># Read status of VCP (stream 0)</span>
<span class="nv">vcp_table_status</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dprx.link.status.vcp<span class="o">(</span><span class="m">0</span><span class="o">)</span>
print<span class="o">(</span>vcp_table_status<span class="o">)</span>
<span class="c1"># Get current stream status (VM, CRC, DSC CRC)</span>
<span class="nv">stream</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dprx.link.status.stream<span class="o">(</span><span class="m">0</span><span class="o">)</span>
print<span class="o">(</span>stream<span class="o">)</span>
<span class="c1"># Also, you can print all status</span>
print<span class="o">(</span>role.dprx.link.status<span class="o">)</span>
<span class="c1"># role.dprx.link.hpd_pulse()</span>
<span class="c1"># # Assert/Deassert</span>
<span class="c1"># print(role.dprx.link.status.hpd_asserted)</span>
<span class="c1"># role.dprx.link.set_assert_state(False)</span>
<span class="c1"># print(role.dprx.link.status.hpd_asserted)</span>
<span class="c1"># role.dprx.link.set_assert_state(True)</span>
<span class="c1"># print(role.dprx.link.status.hpd_asserted)</span>
<span class="c1"># Scrambler Seed</span>
print<span class="o">(</span>role.dprx.link.scrambler_seed<span class="o">)</span>
role.dprx.link.scrambler_seed<span class="w"> </span><span class="o">=</span><span class="w"> </span>0xfffe
print<span class="o">(</span>role.dprx.link.scrambler_seed<span class="o">)</span>
<span class="nv">caps</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.LinkCapabilities<span class="o">()</span>
caps.max_lane<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">4</span>
caps.bit_rate<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">8</span>.1
caps.dp_128_132_bitrates<span class="w"> </span><span class="o">=</span><span class="w"> </span>None
caps.override_10g<span class="w"> </span><span class="o">=</span><span class="w"> </span>None
caps.force_cable_status_to_plugged<span class="w"> </span><span class="o">=</span><span class="w"> </span>False
caps.old_dp_2_0_lt<span class="w"> </span><span class="o">=</span><span class="w"> </span>False
caps.dsc<span class="w"> </span><span class="o">=</span><span class="w"> </span>False
caps.ss_sbm<span class="w"> </span><span class="o">=</span><span class="w"> </span>False
caps.fec<span class="w"> </span><span class="o">=</span><span class="w"> </span>False
caps.tps3<span class="w"> </span><span class="o">=</span><span class="w"> </span>False
caps.tps4<span class="w"> </span><span class="o">=</span><span class="w"> </span>False
caps.mst<span class="w"> </span><span class="o">=</span><span class="w"> </span>True
print<span class="o">(</span>role.dprx.link.capabilities.link_caps_status<span class="o">())</span>
role.dprx.link.capabilities.set<span class="o">(</span>caps<span class="o">)</span>
print<span class="o">(</span>role.dprx.link.capabilities.link_caps_status<span class="o">())</span>
print<span class="o">(</span>role.dprx.link.status.stream<span class="o">(</span><span class="m">0</span><span class="o">)</span>.sdp_crc16<span class="o">)</span>
role.dprx.link.status.reset_sdp_crc16_errors<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># Get eDP caps</span>
<span class="c1">#</span>
<span class="nv">edp_caps</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dprx.link.capabilities.link_caps_status<span class="o">(</span>UniTAP.LinkEDPCapabilities<span class="o">)</span>
print<span class="o">(</span>edp_caps<span class="o">)</span>
edp_caps.max_lane<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">2</span>
edp_caps.eDp_cur_rate<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[</span><span class="m">1</span>.62,<span class="w"> </span><span class="m">2</span>.16,<span class="w"> </span><span class="m">2</span>.43<span class="o">]</span>
<span class="c1">#</span>
<span class="c1"># Since the 3.5 version, TsiLib and TSIDevice objects have the option to be closed earlier.</span>
<span class="c1"># TSIDevice can be closed with the TsiLib method close(). TsiLib can be closed with cleanup().</span>
<span class="c1"># Clean up will close all opened devices and block ability to open any devices</span>
<span class="c1"># with same TsiLib object.</span>
<span class="c1">#</span>
lUniTAP.close<span class="o">(</span>dev<span class="o">)</span>
lUniTAP.cleanup<span class="o">(</span>
</code></pre>
</div>
</br><h3 id="DP-Link-Source-example">DP Link Source example</h3><p>An example of working with a DP Link Source module.</p>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="c1">#</span>
<span class="c1"># Import UniTAP module.</span>
<span class="c1">#</span>
import<span class="w"> </span>UniTAP
<span class="c1">#</span>
<span class="c1"># To initialize UniTAP library wrapper user should create UniTAP.TsiLib() object.</span>
<span class="c1">#</span>
<span class="nv">lUniTAP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.TsiLib<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># For opening device, please, put serial number of the device as 8 symbol str or put index of device.</span>
<span class="c1">#</span>
<span class="c1"># dev = lUniTAP.open(&quot;NNNNNNNN&quot;)</span>
<span class="nv">dev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>lUniTAP.open<span class="o">(</span><span class="m">0</span><span class="o">)</span>
<span class="c1"># After opening device as in UCD Console device role should be selected.</span>
<span class="nv">role</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>dev.select_role<span class="o">(</span>UniTAP.dev.UCD400.DPSourceDPSink<span class="o">)</span>
<span class="c1"># role = dev.select_role(UniTAP.dev.UCD500.DPSourceDPSink)</span>
<span class="c1">#</span>
<span class="c1"># Read current Link Status</span>
<span class="c1">#</span>
<span class="c1"># Read status of lane 0</span>
<span class="nv">lane_status</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dptx.link.status.lane<span class="o">(</span><span class="m">0</span><span class="o">)</span>
print<span class="o">(</span>lane_status<span class="o">)</span>
<span class="c1"># Read status of VCP (stream 0)</span>
<span class="nv">vcp_table_status</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dptx.link.status.vcp<span class="o">(</span><span class="m">0</span><span class="o">)</span>
print<span class="o">(</span>vcp_table_status<span class="o">)</span>
<span class="c1"># Read current status of link configuration</span>
<span class="nv">link_config</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dptx.link.config.get<span class="o">()</span>
print<span class="o">(</span>link_config<span class="o">)</span>
<span class="c1"># Get current stream status (VM, CRC, DSC CRC)</span>
<span class="nv">stream</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dptx.link.status.stream<span class="o">(</span><span class="m">0</span><span class="o">)</span>
print<span class="o">(</span>stream<span class="o">)</span>
<span class="c1"># Also, you can print all status</span>
print<span class="o">(</span>role.dptx.link.status<span class="o">)</span>
<span class="c1"># Configure Link 8b/10b</span>
<span class="nv">config</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.LinkConfig.DP8b10b<span class="o">()</span>
<span class="c1"># Set new lane count and bit rate</span>
config.lane_count<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">2</span>
config.bit_rate<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">6</span>.75
<span class="c1"># Configure Link 128b/132b</span>
<span class="c1"># config = UniTAP.LinkConfig.DP128b132b()</span>
<span class="c1"># Set new lane count and bit rate</span>
<span class="c1"># config.lane_count = 2</span>
<span class="c1"># config.bit_rate = 5</span>
<span class="c1"># config.force_dp_128_132 = True</span>
<span class="c1"># config.try_dp_128_132 = True</span>
<span class="c1"># config.enhanced_framing_mode = True</span>
<span class="c1"># Enable MST mode and configure mst stream count</span>
config.mst<span class="w"> </span><span class="o">=</span><span class="w"> </span>True
config.mst_stream_count<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">2</span>
<span class="c1"># Enable/Disable Enhanced framing mode</span>
config.enhanced_framing_mode<span class="w"> </span><span class="o">=</span><span class="w"> </span>True
<span class="c1"># Configure SSC</span>
<span class="nv">ssc_config</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.SSCConfig<span class="o">()</span>
ssc_config.enabled<span class="w"> </span><span class="o">=</span><span class="w"> </span>True
ssc_config.amplitude<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">34</span>
ssc_config.frequency<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">59000</span>
config.ssc<span class="w"> </span><span class="o">=</span><span class="w"> </span>ssc_config
<span class="c1"># Configure Scrambler Seed</span>
<span class="c1"># If you do not want to setting scrambler seed value, you can activate &#39;auto seed&#39;</span>
<span class="c1"># config.auto_seed = True</span>
<span class="c1"># role.dptx.link.scrambler_seed = 0xFFFF</span>
role.dptx.link.config.set<span class="o">(</span>config<span class="o">)</span>
role.dptx.link.start_link_training<span class="o">()</span>
<span class="nv">edp_conf</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dptx.link.config.get<span class="o">(</span>UniTAP.LinkConfig.eDP<span class="o">)</span>
print<span class="o">(</span>edp_conf<span class="o">)</span>
edp_conf.force_edp<span class="w"> </span><span class="o">=</span><span class="w"> </span>True
edp_conf.lane_count<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">2</span>
edp_conf.eDp_cur_rate<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">2</span>.43
<span class="c1">#</span>
<span class="c1"># Since the 3.5 version, TsiLib and TSIDevice objects have the option to be closed earlier.</span>
<span class="c1"># TSIDevice can be closed with the TsiLib method close(). TsiLib can be closed with cleanup().</span>
<span class="c1"># Clean up will close all opened devices and block ability to open any devices</span>
<span class="c1"># with same TsiLib object.</span>
<span class="c1">#</span>
lUniTAP.close<span class="o">(</span>dev<span class="o">)</span>
lUniTAP.cleanup<span class="o">()</span>
</code></pre>
</div>
</br><h3 id="DUT-Test-example">DUT Test example</h3><p>An example of working with a DUT Test module [manual setting].</p>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="c1">#</span>
<span class="c1"># Import UniTAP module.</span>
<span class="c1">#</span>
import<span class="w"> </span>UniTAP
<span class="c1">#</span>
<span class="c1"># To initialize UniTAP library wrapper user should create UniTAP.TsiLib() object.</span>
<span class="c1">#</span>
<span class="nv">lUniTAP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.TsiLib<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># For opening device, please, put serial number of the device as 8 symbol str or put index of device.</span>
<span class="c1">#</span>
<span class="c1"># dev = lUniTAP.open(&quot;NNNNNNNN&quot;)</span>
<span class="nv">dev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>lUniTAP.open<span class="o">(</span><span class="m">0</span><span class="o">)</span>
<span class="c1"># After opening device as in UCD Console device role should be selected.</span>
<span class="nv">role</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>dev.select_role<span class="o">(</span>UniTAP.dev.UCD400.DPSourceDPSink<span class="o">)</span>
<span class="c1"># role = dev.select_role(UniTAP.dev.UCD500.DPSourceDPSink)</span>
dev.opf_handler<span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.OpfHandlerInternal<span class="o">(</span><span class="nv">port_tx</span><span class="o">=</span>role.dptx,<span class="w"> </span><span class="nv">port_rx</span><span class="o">=</span>role.dprx<span class="o">)</span>
<span class="nv">group_test</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.TestGroupId.DP_TX_LL_CTS
<span class="c1"># You can make a copy of the object, configure it and reassign it or can configure it directly</span>
<span class="c1"># Copy</span>
<span class="nv">params</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dut_tests.get_default_parameters<span class="o">(</span>UniTAP.Dp14SinkTestParam<span class="o">)</span>
<span class="c1"># Configure supported timings for DP DUT Sink tests</span>
params.timings.T_3840_x_2160_60.set_all<span class="o">()</span>
params.timings.T_5120_x_2160_60.set_all<span class="o">()</span>
<span class="c1"># Configure Event Filter from Source side</span>
<span class="nv">event_filter_tx</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dptx.event_capturer.event_filter<span class="o">(</span>UniTAP.EventFilterDpTx<span class="o">)</span><span class="w"> </span><span class="c1"># Get filter object</span>
event_filter_tx.config_hpd_events<span class="o">(</span>True<span class="o">)</span><span class="w"> </span><span class="c1"># Enable capturing HPD events</span>
event_filter_tx.config_aux_events<span class="o">(</span>True<span class="o">)</span><span class="w"> </span><span class="c1"># Enable capturing AUX events</span>
role.dptx.event_capturer.configure_capturer<span class="o">(</span>event_filter_tx<span class="o">)</span><span class="w"> </span><span class="c1"># Transfer updated filter object</span>
<span class="nv">event_filter_rx</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dprx.event_capturer.event_filter<span class="o">(</span>UniTAP.EventFilterDpRx<span class="o">)</span><span class="w"> </span><span class="c1"># Get filter object</span>
event_filter_rx.config_hpd_events<span class="o">(</span>True<span class="o">)</span><span class="w"> </span><span class="c1"># Enable capturing HPD events</span>
event_filter_rx.config_aux_events<span class="o">(</span>True<span class="o">)</span><span class="w"> </span><span class="c1"># Enable capturing AUX events</span>
event_filter_rx.config_sdp_events<span class="o">(</span>True,<span class="w"> </span>UniTAP.EventSDP.CG2<span class="o">)</span><span class="w"> </span><span class="c1"># Enable capturing SDP (CG2) events</span>
role.dprx.event_capturer.configure_capturer<span class="o">(</span>event_filter_rx<span class="o">)</span><span class="w"> </span><span class="c1"># Transfer updated filter object</span>
role.dptx.event_capturer.start<span class="o">()</span><span class="w"> </span><span class="c1"># Start event capturing</span>
role.dut_tests.run<span class="o">(</span><span class="nv">group_id</span><span class="o">=</span>group_test,<span class="w"> </span><span class="nv">test_id</span><span class="o">=</span><span class="m">0</span>,<span class="w"> </span><span class="nv">params</span><span class="o">=</span>params<span class="o">)</span><span class="w"> </span><span class="c1"># Run selected test</span>
<span class="nv">results</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dut_tests.get_all_tests_results<span class="o">()</span><span class="w"> </span><span class="c1"># Get results after testing</span>
role.dptx.event_capturer.stop<span class="o">()</span><span class="w"> </span><span class="c1"># Stop event capturing</span>
<span class="nv">capture_result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dptx.event_capturer.pop_all_elements_as_result_object<span class="o">()</span><span class="w"> </span><span class="c1"># Get all captured events</span>
<span class="nv">event_log_file_path</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;EventData&quot;</span>
<span class="nv">event_log_html_file_path</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;EventDataReport&quot;</span>
<span class="k">if</span><span class="w"> </span>len<span class="o">(</span>capture_result.buffer<span class="o">)</span><span class="w"> </span>&gt;<span class="w"> </span><span class="m">0</span>:
<span class="w"> </span><span class="c1"># Save captured events to BIN file and save HTML report</span>
<span class="w"> </span>capture_result.save_to_file_all_events<span class="o">(</span><span class="nv">file_format</span><span class="o">=</span>UniTAP.EventFileFormat.BIN,<span class="w"> </span><span class="nv">path</span><span class="o">=</span>event_log_file_path<span class="o">)</span>
<span class="w"> </span>capture_result.save_to_file_all_events<span class="o">(</span><span class="nv">file_format</span><span class="o">=</span>UniTAP.EventFileFormat.HTML,<span class="w"> </span><span class="nv">path</span><span class="o">=</span>event_log_html_file_path<span class="o">)</span>
<span class="k">else</span>:
<span class="w"> </span>print<span class="o">(</span><span class="s2">&quot;Buffer is empty.&quot;</span><span class="o">)</span>
<span class="c1"># Save test result to HTML report</span>
role.dut_tests.make_report<span class="o">(</span><span class="s1">&#39;./report&#39;</span>,
<span class="w"> </span><span class="nv">tested_by</span><span class="o">=</span><span class="s2">&quot;Example&quot;</span>,
<span class="w"> </span><span class="nv">remarks</span><span class="o">=</span><span class="s2">&quot;Remarks for test report.&quot;</span><span class="o">)</span>
<span class="c1">#</span>
<span class="c1"># Since the 3.5 version, TsiLib and TSIDevice objects have the option to be closed earlier.</span>
<span class="c1"># TSIDevice can be closed with the TsiLib method close(). TsiLib can be closed with cleanup().</span>
<span class="c1"># Clean up will close all opened devices and block ability to open any devices</span>
<span class="c1"># with same TsiLib object.</span>
<span class="c1">#</span>
lUniTAP.close<span class="o">(</span>dev<span class="o">)</span>
lUniTAP.cleanup<span class="o">()</span>
</code></pre>
</div>
</br><h3 id="DUT-Test-example">DUT Test example</h3><p>An example of working with a DUT Test module [settings from file].</p>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="c1">#</span>
<span class="c1"># Import UniTAP module.</span>
<span class="c1">#</span>
import<span class="w"> </span>UniTAP
<span class="c1">#</span>
<span class="c1"># To initialize UniTAP library wrapper user should create UniTAP.TsiLib() object.</span>
<span class="c1">#</span>
<span class="nv">lUniTAP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.TsiLib<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># For opening device, please, put serial number of the device as 8 symbol str or put index of device.</span>
<span class="c1">#</span>
<span class="c1"># dev = lUniTAP.open(&quot;NNNNNNNN&quot;)</span>
<span class="nv">dev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>lUniTAP.open<span class="o">(</span><span class="m">0</span><span class="o">)</span>
<span class="c1"># After opening device as in UCD Console device role should be selected.</span>
<span class="nv">role</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>dev.select_role<span class="o">(</span>UniTAP.dev.UCD400.DPSourceDPSink<span class="o">)</span>
<span class="c1"># role = dev.select_role(UniTAP.dev.UCD500.DPSourceDPSink)</span>
dev.opf_handler<span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.OpfHandlerInternal<span class="o">(</span><span class="nv">port_tx</span><span class="o">=</span>role.dptx,<span class="w"> </span><span class="nv">port_rx</span><span class="o">=</span>role.dprx<span class="o">)</span>
<span class="nv">file_name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;./config.json&quot;</span>
group_id,<span class="w"> </span>test_id,<span class="w"> </span><span class="nv">params</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dut_tests.get_params_from_file<span class="o">(</span>file_name<span class="o">)</span>
role.dut_tests.run<span class="o">(</span><span class="nv">group_id</span><span class="o">=</span>group_id,<span class="w"> </span><span class="nv">test_id</span><span class="o">=</span>test_id,<span class="w"> </span><span class="nv">params</span><span class="o">=</span>params<span class="o">)</span><span class="w"> </span><span class="c1"># Run selected test</span>
<span class="nv">results</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dut_tests.get_all_tests_results<span class="o">()</span><span class="w"> </span><span class="c1"># Get results after testing</span>
role.dptx.event_capturer.stop<span class="o">()</span><span class="w"> </span><span class="c1"># Stop event capturing</span>
<span class="c1"># Save test result to HTML report</span>
role.dut_tests.make_report<span class="o">(</span><span class="s1">&#39;./report&#39;</span>,
<span class="w"> </span><span class="nv">tested_by</span><span class="o">=</span><span class="s2">&quot;Example&quot;</span>,
<span class="w"> </span><span class="nv">remarks</span><span class="o">=</span><span class="s2">&quot;Remarks for test report.&quot;</span><span class="o">)</span>
<span class="c1">#</span>
<span class="c1"># Since the 3.5 version, TsiLib and TSIDevice objects have the option to be closed earlier.</span>
<span class="c1"># TSIDevice can be closed with the TsiLib method close(). TsiLib can be closed with cleanup().</span>
<span class="c1"># Clean up will close all opened devices and block ability to open any devices</span>
<span class="c1"># with same TsiLib object.</span>
<span class="c1">#</span>
lUniTAP.close<span class="o">(</span>dev<span class="o">)</span>
lUniTAP.cleanup<span class="o">(</span>
</code></pre>
</div>
</br><h3 id="Event-capturer-example">Event capturer example</h3><p>An example of working with a Event capturer.</p>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="c1">#</span>
<span class="c1"># Import UniTAP module.</span>
<span class="c1">#</span>
import<span class="w"> </span>UniTAP
<span class="c1">#</span>
<span class="c1"># To initialize UniTAP library wrapper user should create UniTAP.TsiLib() object.</span>
<span class="c1">#</span>
<span class="nv">lUniTAP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.TsiLib<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># For opening device, please, put serial number of the device as 8 symbol str or put index of device.</span>
<span class="c1">#</span>
<span class="c1"># dev = lUniTAP.open(&quot;NNNNNNNN&quot;)</span>
<span class="nv">dev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>lUniTAP.open<span class="o">(</span><span class="m">0</span><span class="o">)</span>
<span class="c1"># After opening device as in UCD Console device role should be selected.</span>
<span class="c1"># role = dev.select_role(UniTAP.dev.UCD400.DPSourceDPSink)</span>
<span class="nv">role</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>dev.select_role<span class="o">(</span>UniTAP.dev.UCD500.DPSourceDPSink<span class="o">)</span>
dev.opf_handler<span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.OpfHandlerInternal<span class="o">(</span><span class="nv">port_tx</span><span class="o">=</span>role.dptx,<span class="w"> </span><span class="nv">port_rx</span><span class="o">=</span>role.dprx<span class="o">)</span>
<span class="c1"># For getting object of EventFilter, set type of required filter. If filter type is not supported</span>
<span class="c1"># will be print list of available types.</span>
<span class="nv">event_filter</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dprx.event_capturer.event_filter<span class="o">(</span>UniTAP.EventFilterDpRx<span class="o">)</span>
event_filter.config_hpd_events<span class="o">(</span>True<span class="o">)</span>
event_filter.config_aux_events<span class="o">(</span>True<span class="o">)</span>
event_filter.config_sdp_events<span class="o">(</span>True,<span class="w"> </span>UniTAP.EventSDP.CG2<span class="o">)</span>
event_filter.config_vb_id_events<span class="o">(</span>True,<span class="w"> </span>UniTAP.EventVBID.AnyFieldID<span class="o">)</span>
<span class="c1"># For configuration EventLogger, set object of EventFilter to function &#39;configure_capturer&#39;</span>
role.dprx.event_capturer.configure_capturer<span class="o">(</span>event_filter<span class="o">)</span>
role.dprx.link.hpd_pulse<span class="o">()</span>
role.dprx.event_capturer.start<span class="o">(</span><span class="nv">sec</span><span class="o">=</span><span class="m">1</span><span class="o">)</span>
role.dprx.event_capturer.stop<span class="o">()</span>
<span class="nv">capture_result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dprx.event_capturer.capture_result
<span class="nv">file_name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;./EventData&quot;</span>
<span class="k">if</span><span class="w"> </span>len<span class="o">(</span>capture_result.buffer<span class="o">)</span><span class="w"> </span>&gt;<span class="w"> </span><span class="m">0</span>:
<span class="w"> </span>capture_result.save_to_file_all_events<span class="o">(</span><span class="nv">file_format</span><span class="o">=</span>UniTAP.EventFileFormat.HTML,<span class="w"> </span><span class="nv">path</span><span class="o">=</span>file_name<span class="o">)</span>
<span class="c1">#</span>
<span class="c1"># Since the 3.5 version, TsiLib and TSIDevice objects have the option to be closed earlier.</span>
<span class="c1"># TSIDevice can be closed with the TsiLib method close(). TsiLib can be closed with cleanup().</span>
<span class="c1"># Clean up will close all opened devices and block ability to open any devices</span>
<span class="c1"># with same TsiLib object.</span>
<span class="c1">#</span>
lUniTAP.close<span class="o">(</span>dev<span class="o">)</span>
lUniTAP.cleanup<span class="o">(</span>
</code></pre>
</div>
</br><h3 id="PDC-Capabilities-example">PDC Capabilities example</h3><p>An example of working with a PDC Capabilities.</p>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="c1">#</span>
<span class="c1"># Import UniTAP module.</span>
<span class="c1">#</span>
import<span class="w"> </span>UniTAP
<span class="c1">#</span>
<span class="c1"># To initialize UniTAP library wrapper user should create UniTAP.TsiLib() object.</span>
<span class="c1">#</span>
<span class="nv">lUniTAP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.TsiLib<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># For opening device, please, put serial number of the device as 8 symbol str or put index of device.</span>
<span class="c1">#</span>
<span class="c1"># dev = lUniTAP.open(&quot;NNNNNNNN&quot;)</span>
<span class="nv">dev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>lUniTAP.open<span class="o">(</span><span class="m">0</span><span class="o">)</span>
<span class="c1"># After opening device as in UCD Console device role should be selected.</span>
<span class="nv">role</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>dev.select_role<span class="o">(</span>UniTAP.dev.UCD424.USBCSourceUSBCSink<span class="o">)</span>
<span class="c1"># role = dev.select_role(UniTAP.dev.UCD500.USBCSourceUSBCSink)</span>
dev.opf_handler<span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.OpfHandlerInternal<span class="o">(</span><span class="nv">port_tx</span><span class="o">=</span>role.dptx,<span class="w"> </span><span class="nv">port_rx</span><span class="o">=</span>role.dprx<span class="o">)</span>
<span class="c1"># Print current Capabilities status</span>
print<span class="o">(</span>role.pdcrx.capabilities.status<span class="o">)</span>
<span class="c1"># Set Initial role for device</span>
role.pdcrx.capabilities.set_initial_role<span class="o">(</span>UniTAP.pdc.PdcDeviceRole.DFP<span class="o">)</span>
<span class="c1"># Set cable control pull up value (current)</span>
role.pdcrx.capabilities.cc_pull_up<span class="o">(</span>UniTAP.pdc.CCPullUp.Current_3A<span class="o">)</span>
<span class="c1"># Enable PR Swap</span>
role.pdcrx.capabilities.enable_pr_swap<span class="o">(</span>False<span class="o">)</span>
<span class="c1">#</span>
<span class="c1"># Since the 3.5 version, TsiLib and TSIDevice objects have the option to be closed earlier.</span>
<span class="c1"># TSIDevice can be closed with the TsiLib method close(). TsiLib can be closed with cleanup().</span>
<span class="c1"># Clean up will close all opened devices and block ability to open any devices</span>
<span class="c1"># with same TsiLib object.</span>
<span class="c1">#</span>
lUniTAP.close<span class="o">(</span>dev<span class="o">)</span>
lUniTAP.cleanup<span class="o">(</span>
</code></pre>
</div>
</br><h3 id="PDC-Controls-example">PDC Controls example</h3><p>An example of working with a PDC Controls.</p>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="c1">#</span>
<span class="c1"># Import UniTAP module.</span>
<span class="c1">#</span>
import<span class="w"> </span>UniTAP
<span class="c1">#</span>
<span class="c1"># To initialize UniTAP library wrapper user should create UniTAP.TsiLib() object.</span>
<span class="c1">#</span>
<span class="nv">lUniTAP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.TsiLib<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># For opening device, please, put serial number of the device as 8 symbol str or put index of device.</span>
<span class="c1">#</span>
<span class="c1"># dev = lUniTAP.open(&quot;NNNNNNNN&quot;)</span>
<span class="nv">dev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>lUniTAP.open<span class="o">(</span><span class="m">0</span><span class="o">)</span>
<span class="c1"># After opening device as in UCD Console device role should be selected.</span>
<span class="c1"># role = dev.select_role(UniTAP.dev.UCD424.USBCSourceUSBCSink)</span>
<span class="nv">role</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>dev.select_role<span class="o">(</span>UniTAP.dev.UCD500.USBCSourceUSBCSink<span class="o">)</span>
dev.opf_handler<span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.OpfHandlerInternal<span class="o">(</span><span class="nv">port_tx</span><span class="o">=</span>role.dptx,<span class="w"> </span><span class="nv">port_rx</span><span class="o">=</span>role.dprx<span class="o">)</span>
<span class="c1"># Send PR Swap (Also available FR swap, DR swap and Vconn swap)</span>
role.pdcrx.controls.send_pr_swap<span class="o">()</span>
<span class="c1"># Do Reconnect</span>
role.pdcrx.controls.reconnect<span class="o">()</span>
<span class="c1"># Do Attach(True)/DeAttach(False)</span>
role.pdcrx.controls.attach<span class="o">(</span>True<span class="o">)</span>
<span class="c1"># Change cable control orientation</span>
role.pdcrx.controls.orientation<span class="o">(</span>UniTAP.pdc.CableControlOrientation.CC2<span class="o">)</span>
<span class="c1"># Capable communication as PD Source (also available for Sink)</span>
role.pdcrx.controls.communication_capable_as_pd_source<span class="o">(</span><span class="nv">capable</span><span class="o">=</span>True<span class="o">)</span>
<span class="c1">#</span>
<span class="c1"># Since the 3.5 version, TsiLib and TSIDevice objects have the option to be closed earlier.</span>
<span class="c1"># TSIDevice can be closed with the TsiLib method close(). TsiLib can be closed with cleanup().</span>
<span class="c1"># Clean up will close all opened devices and block ability to open any devices</span>
<span class="c1"># with same TsiLib object.</span>
<span class="c1">#</span>
lUniTAP.close<span class="o">(</span>dev<span class="o">)</span>
lUniTAP.cleanup<span class="o">(</span>
</code></pre>
</div>
</br><h3 id="PDC-DP-Alt-mode-example">PDC DP Alt mode example</h3><p>An example of working with a PDC DP Alt mode.</p>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="c1">#</span>
<span class="c1"># Import UniTAP module.</span>
<span class="c1">#</span>
import<span class="w"> </span>UniTAP
<span class="c1">#</span>
<span class="c1"># To initialize UniTAP library wrapper user should create UniTAP.TsiLib() object.</span>
<span class="c1">#</span>
<span class="nv">lUniTAP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.TsiLib<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># For opening device, please, put serial number of the device as 8 symbol str or put index of device.</span>
<span class="c1">#</span>
<span class="c1"># dev = lUniTAP.open(&quot;NNNNNNNN&quot;)</span>
<span class="nv">dev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>lUniTAP.open<span class="o">(</span><span class="m">0</span><span class="o">)</span>
<span class="c1"># After opening device as in UCD Console device role should be selected.</span>
<span class="c1"># role = dev.select_role(UniTAP.dev.UCD424.USBCSourceUSBCSink)</span>
<span class="nv">role</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>dev.select_role<span class="o">(</span>UniTAP.dev.UCD500.USBCSourceUSBCSink<span class="o">)</span>
dev.opf_handler<span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.OpfHandlerInternal<span class="o">(</span><span class="nv">port_tx</span><span class="o">=</span>role.dptx,<span class="w"> </span><span class="nv">port_rx</span><span class="o">=</span>role.dprx<span class="o">)</span>
<span class="c1"># Get and print current DP Alt Mode status</span>
print<span class="o">(</span>role.pdcrx.dp_alt_mode.status<span class="o">)</span>
<span class="c1"># Enter to 4 lane (C and E) DP Alt Mode</span>
role.pdcrx.dp_alt_mode.enter_4_lane<span class="o">()</span>
<span class="c1"># Enable flag DP to Type-C adapter mode</span>
<span class="c1"># role.pdcrx.dp_alt_mode.dp_to_type_c_cable_adapter_mode(enable=True)</span>
<span class="c1"># Get and Set UFP Pin Assignment</span>
<span class="nv">ufp_pin_assignment</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.pdcrx.dp_alt_mode.ufp_caps
<span class="nv">dfp_caps</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.pdcrx.dp_alt_mode.dfp_caps
ufp_pin_assignment.c_4_lanes<span class="w"> </span><span class="o">=</span><span class="w"> </span>True
ufp_pin_assignment.d_2_lanes<span class="w"> </span><span class="o">=</span><span class="w"> </span>False
role.pdcrx.dp_alt_mode.ufp_caps<span class="w"> </span><span class="o">=</span><span class="w"> </span>ufp_pin_assignment
print<span class="o">(</span><span class="s2">&quot;UFP:</span>
<span class="s2">&quot;</span>,<span class="w"> </span>ufp_pin_assignment<span class="o">)</span>
print<span class="o">(</span><span class="s2">&quot;DFP:</span>
<span class="s2">&quot;</span>,<span class="w"> </span>dfp_caps<span class="o">)</span>
<span class="c1"># If was selected UCD-500, may use DP 2.1 DPAM</span>
<span class="c1"># role.pdcrx.dp_alt_mode.enable_dp21(True)</span>
<span class="c1">#</span>
<span class="c1"># Since the 3.5 version, TsiLib and TSIDevice objects have the option to be closed earlier.</span>
<span class="c1"># TSIDevice can be closed with the TsiLib method close(). TsiLib can be closed with cleanup().</span>
<span class="c1"># Clean up will close all opened devices and block ability to open any devices</span>
<span class="c1"># with same TsiLib object.</span>
<span class="c1">#</span>
lUniTAP.close<span class="o">(</span>dev<span class="o">)</span>
lUniTAP.cleanup<span class="o">(</span>
</code></pre>
</div>
</br><h3 id="PDC-PDO-example">PDC PDO example</h3><p>An example of working with a PDC PDO.</p>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="c1">#</span>
<span class="c1"># Import UniTAP module.</span>
<span class="c1">#</span>
import<span class="w"> </span>UniTAP
<span class="c1">#</span>
<span class="c1"># To initialize UniTAP library wrapper user should create UniTAP.TsiLib() object.</span>
<span class="c1">#</span>
<span class="nv">lUniTAP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.TsiLib<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># For opening device, please, put serial number of the device as 8 symbol str or put index of device.</span>
<span class="c1">#</span>
<span class="c1"># dev = lUniTAP.open(&quot;NNNNNNNN&quot;)</span>
<span class="nv">dev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>lUniTAP.open<span class="o">(</span><span class="m">0</span><span class="o">)</span>
<span class="c1"># After opening device as in UCD Console device role should be selected.</span>
<span class="nv">role</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>dev.select_role<span class="o">(</span>UniTAP.dev.UCD424.USBCSourceUSBCSink<span class="o">)</span>
<span class="c1"># role = dev.select_role(UniTAP.dev.UCD500.USBCSourceUSBCSink)</span>
dev.opf_handler<span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.OpfHandlerInternal<span class="o">(</span><span class="nv">port_tx</span><span class="o">=</span>role.dptx,<span class="w"> </span><span class="nv">port_rx</span><span class="o">=</span>role.dprx<span class="o">)</span>
<span class="c1"># Get Source PDO from RX side.</span>
<span class="c1"># If read_from_device = True, PDO will be read directly from device, not from internal buffer</span>
<span class="nv">source_pdo_list</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.pdcrx.power_source.get_pdo_list<span class="o">(</span><span class="nv">read_from_device</span><span class="o">=</span>True<span class="o">)</span>
<span class="k">for</span><span class="w"> </span>item<span class="w"> </span><span class="k">in</span><span class="w"> </span>source_pdo_list:
<span class="w"> </span>print<span class="o">(</span>item<span class="o">)</span>
<span class="c1"># Get current Power Role</span>
<span class="nv">power_role</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.pdcrx.capabilities.status.power_role<span class="o">()</span>
print<span class="o">(</span>power_role.name<span class="o">)</span>
<span class="k">if</span><span class="w"> </span><span class="nv">power_role</span><span class="w"> </span><span class="o">==</span><span class="w"> </span>UniTAP.pdc.PowerRole.Sink:
<span class="w"> </span><span class="c1"># If needed to change power role, use reconnect</span>
<span class="w"> </span>role.pdcrx.controls.reconnect<span class="o">()</span>
<span class="k">if</span><span class="w"> </span><span class="nv">power_role</span><span class="w"> </span><span class="o">==</span><span class="w"> </span>UniTAP.pdc.PowerRole.Source:
<span class="w"> </span><span class="k">for</span><span class="w"> </span>index,<span class="w"> </span>item<span class="w"> </span><span class="k">in</span><span class="w"> </span>enumerate<span class="o">(</span>source_pdo_list<span class="o">)</span>:
<span class="w"> </span><span class="k">if</span><span class="w"> </span>index<span class="w"> </span>&gt;<span class="w"> </span><span class="m">0</span>:
<span class="w"> </span>item.interpret_pdo_as_selected_type<span class="o">(</span>UniTAP.pdc.BatteryPdo<span class="o">)</span>
<span class="w"> </span>role.pdcrx.power_source.set_pdo_list<span class="o">(</span>source_pdo_list<span class="o">)</span>
<span class="w"> </span>role.pdcrx.power_source.send_pdo<span class="o">()</span>
<span class="w"> </span>role.pdcrx.controls.reconnect<span class="o">()</span>
<span class="nv">source_pdo_list</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.pdcrx.power_source.get_pdo_list<span class="o">(</span><span class="nv">read_from_device</span><span class="o">=</span>True<span class="o">)</span>
<span class="k">for</span><span class="w"> </span>item<span class="w"> </span><span class="k">in</span><span class="w"> </span>source_pdo_list:
<span class="w"> </span>print<span class="o">(</span>item<span class="o">)</span>
<span class="c1"># For Sink PDO the same algorythm, but it is also possible to control `Power Contract`</span>
role.pdcrx.power_contract_control.pdo_type_priority<span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.pdc.ContractTypePriority.HigherCurrent
<span class="c1"># Control Internal resistance (only for UCD-340)</span>
<span class="c1"># print(role.pdcrx.power_contract_control.internal_resistance)</span>
<span class="c1"># role.pdcrx.power_contract_control.internal_resistance = UniTAP.pdc.InternalResistance.Resistance_3_5_Ohm</span>
<span class="c1"># print(role.pdcrx.power_contract_control.internal_resistance)</span>
<span class="c1">#</span>
<span class="c1"># Since the 3.5 version, TsiLib and TSIDevice objects have the option to be closed earlier.</span>
<span class="c1"># TSIDevice can be closed with the TsiLib method close(). TsiLib can be closed with cleanup().</span>
<span class="c1"># Clean up will close all opened devices and block ability to open any devices</span>
<span class="c1"># with same TsiLib object.</span>
<span class="c1">#</span>
lUniTAP.close<span class="o">(</span>dev<span class="o">)</span>
lUniTAP.cleanup<span class="o">(</span>
</code></pre>
</div>
</br><h3 id="Video-Capturer">Video Capturer</h3><p>An example of working with a Video Capturer.</p>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="c1">#</span>
<span class="c1"># Import UniTAP module.</span>
<span class="c1">#</span>
import<span class="w"> </span>UniTAP
<span class="c1">#</span>
<span class="c1"># To initialize UniTAP library wrapper user should create UniTAP.TsiLib() object.</span>
<span class="c1">#</span>
<span class="nv">lUniTAP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.TsiLib<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># For opening device, please, put serial number of the device as 8 symbol str or put index of device.</span>
<span class="c1">#</span>
<span class="c1"># dev = lUniTAP.open(&quot;NNNNNNNN&quot;)</span>
<span class="nv">dev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>lUniTAP.open<span class="o">(</span><span class="m">0</span><span class="o">)</span>
<span class="c1"># After opening device as in UCD Console device role should be selected.</span>
<span class="c1"># For UCD-500 available following roles:</span>
<span class="c1"># UniTAP.dev.UCD500.DPSourceDPSink, USBCSourceUSBCSink, DPSourceUSBCSink and USBCSourceDPSink</span>
<span class="nv">role</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>dev.select_role<span class="o">(</span>UniTAP.dev.UCD500.DPSourceDPSink<span class="o">)</span>
<span class="c1"># First variant of capturing = set frame count number</span>
role.dprx.video_capturer.start<span class="o">(</span><span class="nv">frames_count</span><span class="o">=</span><span class="m">1</span>,<span class="w"> </span><span class="nv">stream_number</span><span class="o">=</span><span class="m">1</span><span class="o">)</span>
role.dprx.video_capturer.stop<span class="o">()</span>
<span class="nv">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dprx.video_capturer.capture_result
<span class="c1"># Second variant of capturing = set number of second</span>
<span class="c1"># role.dprx.video_capturer.start(sec=1)</span>
<span class="c1"># role.dprx.video_capturer.stop()</span>
<span class="c1"># result = role.dprx.video_capturer.capture_result</span>
<span class="c1"># Third variant of capturing = capturing with user&#39;s stop command (without predefined number of frames or second)</span>
<span class="c1"># role.dprx.video_capturer.start()</span>
<span class="c1"># result = role.dprx.video_capturer.pop_element_as_result_object()</span>
<span class="c1"># role.dprx.video_capturer.stop()</span>
<span class="c1"># Save captured frames</span>
<span class="c1"># file_format - BIN, PPM and BMP</span>
<span class="c1"># path - full path to save the image</span>
<span class="c1"># index - index of captured image</span>
result.save_image_to_file<span class="o">(</span><span class="nv">file_format</span><span class="o">=</span>UniTAP.PictureFileFormat.BMP,
<span class="w"> </span><span class="nv">path</span><span class="o">=</span><span class="s2">&quot;image.bmp&quot;</span>,
<span class="w"> </span><span class="nv">index</span><span class="o">=</span><span class="m">0</span><span class="o">)</span>
<span class="c1">#</span>
<span class="c1"># Since the 3.5 version, TsiLib and TSIDevice objects have the option to be closed earlier.</span>
<span class="c1"># TSIDevice can be closed with the TsiLib method close(). TsiLib can be closed with cleanup().</span>
<span class="c1"># Clean up will close all opened devices and block ability to open any devices</span>
<span class="c1"># with same TsiLib object.</span>
<span class="c1">#</span>
lUniTAP.close<span class="o">(</span>dev<span class="o">)</span>
lUniTAP.cleanup<span class="o">()</span>
</code></pre>
</div>
</br><h3 id="Panel-Replay">Panel Replay</h3><p>An example of working with a Panel Replay.</p>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="c1">#</span>
<span class="c1"># Import UniTAP module.</span>
<span class="c1">#</span>
import<span class="w"> </span><span class="nb">time</span>
import<span class="w"> </span>UniTAP
<span class="c1">#</span>
<span class="c1"># To initialize UniTAP library wrapper user should create UniTAP.TsiLib() object.</span>
<span class="c1">#</span>
<span class="nv">lUniTAP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.TsiLib<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># For opening device, please, put serial number of the device as 8 symbol str or put index of device.</span>
<span class="c1">#</span>
<span class="c1"># dev = lUniTAP.open(&quot;NNNNNNNN&quot;)</span>
<span class="nv">dev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>lUniTAP.open<span class="o">(</span><span class="m">0</span><span class="o">)</span>
<span class="c1"># After opening device as in UCD Console device role should be selected.</span>
<span class="nv">role</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>dev.select_role<span class="o">(</span>UniTAP.dev.UCD500.DPSourceDPSink<span class="o">)</span>
<span class="c1"># Select PR&#39;Active mode&#39;</span>
role.dptx.pg.panel_replay.active_mode<span class="o">()</span>
time.sleep<span class="o">(</span><span class="m">3</span><span class="o">)</span>
<span class="c1"># Get current panel replay configuration of PR regions</span>
<span class="nv">pr_conf</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dptx.pg.panel_replay.config.get<span class="o">()</span>
<span class="c1"># Set new values for PR Region</span>
pr_conf.regions<span class="o">[</span><span class="m">0</span><span class="o">]</span>.x<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">10</span>
pr_conf.regions<span class="o">[</span><span class="m">0</span><span class="o">]</span>.y<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">20</span>
pr_conf.regions<span class="o">[</span><span class="m">0</span><span class="o">]</span>.width<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">30</span>
pr_conf.regions<span class="o">[</span><span class="m">0</span><span class="o">]</span>.height<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">40</span>
<span class="c1"># PanelReplay config</span>
pr_conf.flags.mode<span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.PRMode.PR
pr_conf.flags.y_granularity<span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.YGranularity.Value_14
pr_conf.flags.early_transport<span class="w"> </span><span class="o">=</span><span class="w"> </span>True
pr_conf.flags.main_link_remain_on<span class="w"> </span><span class="o">=</span><span class="w"> </span>True
pr_conf.flags.hpd_irq_vsc_sdp<span class="w"> </span><span class="o">=</span><span class="w"> </span>True
<span class="c1"># Apply config</span>
role.dptx.pg.panel_replay.config.set<span class="o">(</span>pr_conf<span class="o">)</span>
time.sleep<span class="o">(</span><span class="m">3</span><span class="o">)</span>
<span class="c1"># Read status, command and error</span>
print<span class="o">(</span>role.dptx.pg.panel_replay.status.status<span class="o">()</span>.name<span class="o">)</span>
print<span class="o">(</span>role.dptx.pg.panel_replay.status.command<span class="o">()</span>.name<span class="o">)</span>
print<span class="o">(</span>role.dptx.pg.panel_replay.status.error<span class="o">()</span>.name<span class="o">)</span>
<span class="c1">#</span>
<span class="c1"># Since the 3.5 version, TsiLib and TSIDevice objects have the option to be closed earlier.</span>
<span class="c1"># TSIDevice can be closed with the TsiLib method close(). TsiLib can be closed with cleanup().</span>
<span class="c1"># Clean up will close all opened devices and block ability to open any devices</span>
<span class="c1"># with same TsiLib object.</span>
<span class="c1">#</span>
lUniTAP.close<span class="o">(</span>dev<span class="o">)</span>
lUniTAP.cleanup<span class="o">(</span>
</code></pre>
</div>
</br><h3 id="DSC-Generator">DSC Generator</h3><p>An example of working with a DSC generator.</p>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="c1">#</span>
<span class="c1"># Import UniTAP module.</span>
<span class="c1">#</span>
import<span class="w"> </span>UniTAP
from<span class="w"> </span>UniTAP.utils<span class="w"> </span>import<span class="w"> </span>encode_video_frame,<span class="w"> </span>calculate_dsc_slice_size
from<span class="w"> </span>UniTAP.common<span class="w"> </span>import<span class="w"> </span>get_vf_from_image,<span class="w"> </span>CompressionInfo
<span class="c1">#</span>
<span class="c1"># To initialize UniTAP library wrapper user should create UniTAP.TsiLib() object.</span>
<span class="c1">#</span>
<span class="nv">lUniTAP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.TsiLib<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># For opening device, please, put serial number of the device as 8 symbol str or put index of device.</span>
<span class="c1">#</span>
<span class="c1"># dev = lUniTAP.open(&quot;NNNNNNNN&quot;)</span>
<span class="nv">dev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>lUniTAP.open<span class="o">(</span><span class="m">0</span><span class="o">)</span>
<span class="c1"># After opening device as in UCD Console device role should be selected.</span>
<span class="nv">role</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>dev.select_role<span class="o">(</span>UniTAP.dev.UCD400.DPSourceDPSink<span class="o">)</span>
<span class="c1"># role = dev.select_role(UniTAP.dev.UCD500.DPSourceDPSink)</span>
<span class="c1">#</span>
<span class="c1"># For using our predefined device specific timings, you can use &#39;timing manager&#39; with which you can get them.</span>
<span class="c1">#</span>
<span class="nv">timing_manager</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dptx.pg.timing_manager
<span class="nv">color_mode</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.ColorInfo<span class="o">()</span>
color_mode.color_format<span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.ColorInfo.ColorFormat.CF_RGB
color_mode.bpc<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">8</span>
color_mode.colorimetry<span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.ColorInfo.Colorimetry.CM_sRGB
<span class="nv">target_width</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1920</span>
<span class="nv">target_height</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1080</span>
<span class="nv">path_custom_image</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;Your_Path_To_Image.jpg&quot;</span>
<span class="nv">vf</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>get_vf_from_image<span class="o">(</span>path_custom_image,<span class="w"> </span>target_width,<span class="w"> </span>target_height<span class="o">)</span>
<span class="nv">params</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>CompressionInfo<span class="o">()</span>
params.color_format<span class="w"> </span><span class="o">=</span><span class="w"> </span>CompressionInfo.DscColorFormat.CF_RGB
params.bpp<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">128</span>
params.version<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">(</span><span class="m">1</span>,<span class="w"> </span><span class="m">2</span><span class="o">)</span>
params.v_slice_size<span class="w"> </span><span class="o">=</span><span class="w"> </span>calculate_dsc_slice_size<span class="o">(</span>target_width,<span class="w"> </span><span class="m">4</span><span class="o">)</span>
params.h_slice_size<span class="w"> </span><span class="o">=</span><span class="w"> </span>calculate_dsc_slice_size<span class="o">(</span>target_height,<span class="w"> </span><span class="m">4</span><span class="o">)</span>
params.buffer_bit_depth<span class="w"> </span><span class="o">=</span><span class="w"> </span>vf.color_info.bpc<span class="w"> </span>+<span class="w"> </span><span class="m">1</span>
<span class="nv">dsc_vf</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>encode_video_frame<span class="o">(</span>vf,<span class="w"> </span>params<span class="o">)</span>
<span class="nv">video_mode</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.VideoMode<span class="o">(</span><span class="nv">timing</span><span class="o">=</span>timing_manager.get_cta<span class="o">(</span><span class="m">76</span><span class="o">)</span>,<span class="w"> </span><span class="nv">color_info</span><span class="o">=</span>color_mode<span class="o">)</span>
<span class="nv">caps</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dprx.link.capabilities.link_caps_status<span class="o">()</span>
caps.dsc<span class="w"> </span><span class="o">=</span><span class="w"> </span>True
caps.fec<span class="w"> </span><span class="o">=</span><span class="w"> </span>True
role.dprx.link.capabilities.set<span class="o">(</span>caps<span class="o">)</span>
role.dptx.link.start_link_training<span class="o">()</span>
role.dptx.pg.set_vm<span class="o">(</span>video_mode<span class="o">)</span>
<span class="c1"># Also you can put image path (dsc image path also) to function &#39;set_pattern&#39; as argument.</span>
<span class="c1"># path_custom_image = &quot;Your_Path_To_Image.jpg&quot;</span>
<span class="c1"># role.dptx.pg.set_pattern(path_custom_image)</span>
role.dptx.pg.set_pattern<span class="o">(</span>dsc_vf<span class="o">)</span>
role.dptx.pg.apply<span class="o">()</span>
<span class="nv">res_app</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dptx.pg.status<span class="o">()</span>.error
print<span class="o">(</span>f<span class="s2">&quot;Stream {0} - Apply {res_app.__str__()}&quot;</span><span class="o">)</span>
role.dprx.video_capturer.start<span class="o">()</span>
<span class="nv">dsc_captured_frame</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dprx.video_capturer.pop_element<span class="o">()</span>
role.dprx.video_capturer.stop<span class="o">()</span>
print<span class="o">(</span>dsc_captured_frame.is_compressed<span class="o">())</span>
print<span class="o">(</span>dsc_captured_frame<span class="o">)</span>
role.dptx.pg.set_pattern<span class="o">(</span>UniTAP.VideoPattern.ColorSquares<span class="o">)</span>
role.dptx.pg.apply<span class="o">()</span>
<span class="nv">res_app</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dptx.pg.status<span class="o">()</span>.error
print<span class="o">(</span>f<span class="s2">&quot;Stream {0} - Apply {res_app.__str__()}&quot;</span><span class="o">)</span>
role.dprx.video_capturer.start<span class="o">()</span>
<span class="nv">captured_frame</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dprx.video_capturer.pop_element<span class="o">()</span>
role.dprx.video_capturer.stop<span class="o">()</span>
print<span class="o">(</span>captured_frame.is_compressed<span class="o">())</span>
print<span class="o">(</span>captured_frame<span class="o">)</span>
<span class="c1">#</span>
<span class="c1"># Since the 3.5 version, TsiLib and TSIDevice objects have the option to be closed earlier.</span>
<span class="c1"># TSIDevice can be closed with the TsiLib method close(). TsiLib can be closed with cleanup().</span>
<span class="c1"># Clean up will close all opened devices and block ability to open any devices</span>
<span class="c1"># with same TsiLib object.</span>
<span class="c1">#</span>
lUniTAP.close<span class="o">(</span>dev<span class="o">)</span>
lUniTAP.cleanup<span class="o">(</span>
</code></pre>
</div>
</br><h3 id="DSC-Images">DSC Images</h3><p>An example of working with a DSC images.</p>
<div class="pdoc-code codehilite">
<pre><span></span><code><span class="c1">#</span>
<span class="c1"># Import UniTAP module.</span>
<span class="c1">#</span>
import<span class="w"> </span>UniTAP
from<span class="w"> </span>UniTAP.utils<span class="w"> </span>import<span class="w"> </span>encode_video_frame,<span class="w"> </span>decode_video_frame,<span class="w"> </span>video_frame_save_to_file,<span class="w"> </span>ImageFileFormat
<span class="c1">#</span>
<span class="c1"># To initialize UniTAP library wrapper user should create UniTAP.TsiLib() object.</span>
<span class="c1">#</span>
<span class="nv">lUniTAP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>UniTAP.TsiLib<span class="o">()</span>
<span class="c1">#</span>
<span class="c1"># For opening device, please, put serial number of the device as 8 symbol str or put index of device.</span>
<span class="c1">#</span>
<span class="c1"># dev = lUniTAP.open(&quot;NNNNNNNN&quot;)</span>
<span class="nv">dev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>lUniTAP.open<span class="o">(</span><span class="m">0</span><span class="o">)</span>
<span class="c1"># After opening device as in UCD Console device role should be selected.</span>
<span class="c1"># For UCD-500 available following roles:</span>
<span class="c1"># UniTAP.dev.UCD500.DPSourceDPSink, USBCSourceUSBCSink, DPSourceUSBCSink and USBCSourceDPSink</span>
<span class="nv">role</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>dev.select_role<span class="o">(</span>UniTAP.dev.UCD400.DPSourceDPSink<span class="o">)</span>
<span class="c1"># First variant of capturing = set frame count number</span>
role.dprx.video_capturer.start<span class="o">(</span><span class="nv">stream_number</span><span class="o">=</span><span class="m">0</span><span class="o">)</span>
<span class="nv">frame</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>role.dprx.video_capturer.pop_element<span class="o">()</span>
role.dprx.video_capturer.stop<span class="o">()</span>
<span class="c1"># Decode DSC Video frame and save</span>
<span class="nv">image_path</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;image.bmp&quot;</span>
<span class="nv">decoded_vf</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>decode_video_frame<span class="o">(</span>frame<span class="o">)</span>
video_frame_save_to_file<span class="o">(</span><span class="nv">video_frame</span><span class="o">=</span>decoded_vf,<span class="w"> </span><span class="nv">path</span><span class="o">=</span>image_path,<span class="w"> </span><span class="nv">file_type</span><span class="o">=</span>ImageFileFormat.IFF_BMP<span class="o">)</span>
<span class="c1"># Save raw DSC Video frame</span>
<span class="nv">image_path</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;image.dsc&quot;</span>
video_frame_save_to_file<span class="o">(</span><span class="nv">video_frame</span><span class="o">=</span>frame,<span class="w"> </span><span class="nv">path</span><span class="o">=</span>image_path,<span class="w"> </span><span class="nv">file_type</span><span class="o">=</span>ImageFileFormat.IFF_DSC<span class="o">)</span>
<span class="c1">#</span>
<span class="c1"># Since the 3.5 version, TsiLib and TSIDevice objects have the option to be closed earlier.</span>
<span class="c1"># TSIDevice can be closed with the TsiLib method close(). TsiLib can be closed with cleanup().</span>
<span class="c1"># Clean up will close all opened devices and block ability to open any devices</span>
<span class="c1"># with same TsiLib object.</span>
<span class="c1">#</span>
lUniTAP.close<span class="o">(</span>dev<span class="o">)</span>
lUniTAP.cleanup<span class="o">()</span>
</code></pre>
</div>
</div>
</section>
</main>
<script>
function escapeHTML(html) {
return document.createElement('div').appendChild(document.createTextNode(html)).parentNode.innerHTML;
}
const originalContent = document.querySelector("main.pdoc");
let currentContent = originalContent;
function setContent(innerHTML) {
let elem;
if (innerHTML) {
elem = document.createElement("main");
elem.classList.add("pdoc");
elem.innerHTML = innerHTML;
} else {
elem = originalContent;
}
if (currentContent !== elem) {
currentContent.replaceWith(elem);
currentContent = elem;
}
}
function getSearchTerm() {
return (new URL(window.location)).searchParams.get("search");
}
const searchBox = document.querySelector(".pdoc input[type=search]");
searchBox.addEventListener("input", function () {
let url = new URL(window.location);
if (searchBox.value.trim()) {
url.hash = "";
url.searchParams.set("search", searchBox.value);
} else {
url.searchParams.delete("search");
}
history.replaceState("", "", url.toString());
onInput();
});
window.addEventListener("popstate", onInput);
let search, searchErr;
async function initialize() {
try {
search = await new Promise((resolve, reject) => {
const script = document.createElement("script");
script.type = "text/javascript";
script.async = true;
script.onload = () => resolve(window.pdocSearch);
script.onerror = (e) => reject(e);
script.src = "search.js";
document.getElementsByTagName("head")[0].appendChild(script);
});
} catch (e) {
console.error("Cannot fetch pdoc search index");
searchErr = "Cannot fetch search index.";
}
onInput();
document.querySelector("nav.pdoc").addEventListener("click", e => {
if (e.target.hash) {
searchBox.value = "";
searchBox.dispatchEvent(new Event("input"));
}
});
}
function onInput() {
setContent((() => {
const term = getSearchTerm();
if (!term) {
return null
}
if (searchErr) {
return `<h3>Error: ${searchErr}</h3>`
}
if (!search) {
return "<h3>Searching...</h3>"
}
window.scrollTo({top: 0, left: 0, behavior: 'auto'});
const results = search(term);
let html;
if (results.length === 0) {
html = `No search results for '${escapeHTML(term)}'.`
} else {
html = `<h4>${results.length} search result${results.length > 1 ? "s" : ""} for '${escapeHTML(term)}'.</h4>`;
}
for (let result of results.slice(0, 10)) {
let doc = result.doc;
let url = `${doc.modulename.replaceAll(".", "/")}.html`;
if (doc.qualname) {
url += `#${doc.qualname}`;
}
let heading;
switch (result.doc.kind) {
case "function":
if (doc.fullname.endsWith(".__init__")) {
heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
} else {
heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
}
break;
case "class":
heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
if (doc.bases)
heading += `<wbr>(<span class="base">${doc.bases}</span>)`;
heading += `:`;
break;
case "variable":
heading = `<span class="name">${doc.fullname}</span>`;
if (doc.annotation)
heading += `<span class="annotation">${doc.annotation}</span>`;
if (doc.default_value)
heading += `<span class="default_value"> = ${doc.default_value}</span>`;
break;
default:
heading = `<span class="name">${doc.fullname}</span>`;
break;
}
html += `
<section class="search-result">
<a href="${url}" class="attr ${doc.kind}">${heading}</a>
<div class="docstring">${doc.doc}</div>
</section>
`;
}
return html;
})());
}
if (getSearchTerm()) {
initialize();
searchBox.value = getSearchTerm();
onInput();
} else {
searchBox.addEventListener("focus", initialize, {once: true});
}
searchBox.addEventListener("keydown", e => {
if (["ArrowDown", "ArrowUp", "Enter"].includes(e.key)) {
let focused = currentContent.querySelector(".search-result.focused");
if (!focused) {
currentContent.querySelector(".search-result").classList.add("focused");
} else if (
e.key === "ArrowDown"
&& focused.nextElementSibling
&& focused.nextElementSibling.classList.contains("search-result")
) {
focused.classList.remove("focused");
focused.nextElementSibling.classList.add("focused");
focused.nextElementSibling.scrollIntoView({
behavior: "smooth",
block: "nearest",
inline: "nearest"
});
} else if (
e.key === "ArrowUp"
&& focused.previousElementSibling
&& focused.previousElementSibling.classList.contains("search-result")
) {
focused.classList.remove("focused");
focused.previousElementSibling.classList.add("focused");
focused.previousElementSibling.scrollIntoView({
behavior: "smooth",
block: "nearest",
inline: "nearest"
});
} else if (
e.key === "Enter"
) {
focused.querySelector("a").click();
}
}
});
</script></body>
</html>
Reference in New Issue View Git Blame Copy Permalink