",options:{classes:{},disabled:!1,create:null},_createWidget:function(e,s){s=t(s||this.defaultElement||this)[0],this.element=t(s),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=t(),this.hoverable=t(),this.focusable=t(),this.classesElementLookup={},s!==this&&(t.data(s,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===s&&this.destroy()}}),this.document=t(s.style?s.ownerDocument:s.document||s),this.window=t(this.document[0].defaultView||this.document[0].parentWindow)),this.options=t.widget.extend({},this.options,this._getCreateOptions(),e),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:t.noop,_create:t.noop,_init:t.noop,destroy:function(){var e=this;this._destroy(),t.each(this.classesElementLookup,function(t,i){e._removeClass(i,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:t.noop,widget:function(){return this.element},option:function(e,i){var s,n,o,a=e;if(0===arguments.length)return t.widget.extend({},this.options);if("string"==typeof e)if(a={},s=e.split("."),e=s.shift(),s.length){for(n=a[e]=t.widget.extend({},this.options[e]),o=0;s.length-1>o;o++)n[s[o]]=n[s[o]]||{},n=n[s[o]];if(e=s.pop(),1===arguments.length)return void 0===n[e]?null:n[e];n[e]=i}else{if(1===arguments.length)return void 0===this.options[e]?null:this.options[e];a[e]=i}return this._setOptions(a),this},_setOptions:function(t){var e;for(e in t)this._setOption(e,t[e]);return this},_setOption:function(t,e){return"classes"===t&&this._setOptionClasses(e),this.options[t]=e,"disabled"===t&&this._setOptionDisabled(e),this},_setOptionClasses:function(e){var i,s,n;for(i in e)n=this.classesElementLookup[i],e[i]!==this.options.classes[i]&&n&&n.length&&(s=t(n.get()),this._removeClass(n,i),s.addClass(this._classes({element:s,keys:i,classes:e,add:!0})))},_setOptionDisabled:function(t){this._toggleClass(this.widget(),this.widgetFullName+"-disabled",null,!!t),t&&(this._removeClass(this.hoverable,null,"ui-state-hover"),this._removeClass(this.focusable,null,"ui-state-focus"))},enable:function(){return this._setOptions({disabled:!1})},disable:function(){return this._setOptions({disabled:!0})},_classes:function(e){function i(i,o){var a,r;for(r=0;i.length>r;r++)a=n.classesElementLookup[i[r]]||t(),a=e.add?t(t.unique(a.get().concat(e.element.get()))):t(a.not(e.element).get()),n.classesElementLookup[i[r]]=a,s.push(i[r]),o&&e.classes[i[r]]&&s.push(e.classes[i[r]])}var s=[],n=this;return e=t.extend({element:this.element,classes:this.options.classes||{}},e),this._on(e.element,{remove:"_untrackClassesElement"}),e.keys&&i(e.keys.match(/\S+/g)||[],!0),e.extra&&i(e.extra.match(/\S+/g)||[]),s.join(" ")},_untrackClassesElement:function(e){var i=this;t.each(i.classesElementLookup,function(s,n){-1!==t.inArray(e.target,n)&&(i.classesElementLookup[s]=t(n.not(e.target).get()))})},_removeClass:function(t,e,i){return this._toggleClass(t,e,i,!1)},_addClass:function(t,e,i){return this._toggleClass(t,e,i,!0)},_toggleClass:function(t,e,i,s){s="boolean"==typeof s?s:i;var n="string"==typeof t||null===t,o={extra:n?e:i,keys:n?t:e,element:n?this.element:t,add:s};return o.element.toggleClass(this._classes(o),s),this},_on:function(e,i,s){var n,o=this;"boolean"!=typeof e&&(s=i,i=e,e=!1),s?(i=n=t(i),this.bindings=this.bindings.add(i)):(s=i,i=this.element,n=this.widget()),t.each(s,function(s,a){function r(){return e||o.options.disabled!==!0&&!t(this).hasClass("ui-state-disabled")?("string"==typeof a?o[a]:a).apply(o,arguments):void 0}"string"!=typeof a&&(r.guid=a.guid=a.guid||r.guid||t.guid++);var h=s.match(/^([\w:-]*)\s*(.*)$/),l=h[1]+o.eventNamespace,c=h[2];c?n.on(l,c,r):i.on(l,r)})},_off:function(e,i){i=(i||"").split(" ").join(this.eventNamespace+" ")+this.eventNamespace,e.off(i).off(i),this.bindings=t(this.bindings.not(e).get()),this.focusable=t(this.focusable.not(e).get()),this.hoverable=t(this.hoverable.not(e).get())},_delay:function(t,e){function i(){return("string"==typeof t?s[t]:t).apply(s,arguments)}var s=this;return setTimeout(i,e||0)},_hoverable:function(e){this.hoverable=this.hoverable.add(e),this._on(e,{mouseenter:function(e){this._addClass(t(e.currentTarget),null,"ui-state-hover")},mouseleave:function(e){this._removeClass(t(e.currentTarget),null,"ui-state-hover")}})},_focusable:function(e){this.focusable=this.focusable.add(e),this._on(e,{focusin:function(e){this._addClass(t(e.currentTarget),null,"ui-state-focus")},focusout:function(e){this._removeClass(t(e.currentTarget),null,"ui-state-focus")}})},_trigger:function(e,i,s){var n,o,a=this.options[e];if(s=s||{},i=t.Event(i),i.type=(e===this.widgetEventPrefix?e:this.widgetEventPrefix+e).toLowerCase(),i.target=this.element[0],o=i.originalEvent)for(n in o)n in i||(i[n]=o[n]);return this.element.trigger(i,s),!(t.isFunction(a)&&a.apply(this.element[0],[i].concat(s))===!1||i.isDefaultPrevented())}},t.each({show:"fadeIn",hide:"fadeOut"},function(e,i){t.Widget.prototype["_"+e]=function(s,n,o){"string"==typeof n&&(n={effect:n});var a,r=n?n===!0||"number"==typeof n?i:n.effect||i:e;n=n||{},"number"==typeof n&&(n={duration:n}),a=!t.isEmptyObject(n),n.complete=o,n.delay&&s.delay(n.delay),a&&t.effects&&t.effects.effect[r]?s[e](n):r!==e&&s[r]?s[r](n.duration,n.easing,o):s.queue(function(i){t(this)[e](),o&&o.call(s[0]),i()})}}),t.widget,function(){function e(t,e,i){return[parseFloat(t[0])*(u.test(t[0])?e/100:1),parseFloat(t[1])*(u.test(t[1])?i/100:1)]}function i(e,i){return parseInt(t.css(e,i),10)||0}function s(e){var i=e[0];return 9===i.nodeType?{width:e.width(),height:e.height(),offset:{top:0,left:0}}:t.isWindow(i)?{width:e.width(),height:e.height(),offset:{top:e.scrollTop(),left:e.scrollLeft()}}:i.preventDefault?{width:0,height:0,offset:{top:i.pageY,left:i.pageX}}:{width:e.outerWidth(),height:e.outerHeight(),offset:e.offset()}}var n,o=Math.max,a=Math.abs,r=/left|center|right/,h=/top|center|bottom/,l=/[\+\-]\d+(\.[\d]+)?%?/,c=/^\w+/,u=/%$/,d=t.fn.position;t.position={scrollbarWidth:function(){if(void 0!==n)return n;var e,i,s=t("
"),o=s.children()[0];return t("body").append(s),e=o.offsetWidth,s.css("overflow","scroll"),i=o.offsetWidth,e===i&&(i=s[0].clientWidth),s.remove(),n=e-i},getScrollInfo:function(e){var i=e.isWindow||e.isDocument?"":e.element.css("overflow-x"),s=e.isWindow||e.isDocument?"":e.element.css("overflow-y"),n="scroll"===i||"auto"===i&&e.width
i?"left":e>0?"right":"center",vertical:0>r?"top":s>0?"bottom":"middle"};l>p&&p>a(e+i)&&(u.horizontal="center"),c>f&&f>a(s+r)&&(u.vertical="middle"),u.important=o(a(e),a(i))>o(a(s),a(r))?"horizontal":"vertical",n.using.call(this,t,u)}),h.offset(t.extend(D,{using:r}))})},t.ui.position={fit:{left:function(t,e){var i,s=e.within,n=s.isWindow?s.scrollLeft:s.offset.left,a=s.width,r=t.left-e.collisionPosition.marginLeft,h=n-r,l=r+e.collisionWidth-a-n;e.collisionWidth>a?h>0&&0>=l?(i=t.left+h+e.collisionWidth-a-n,t.left+=h-i):t.left=l>0&&0>=h?n:h>l?n+a-e.collisionWidth:n:h>0?t.left+=h:l>0?t.left-=l:t.left=o(t.left-r,t.left)},top:function(t,e){var i,s=e.within,n=s.isWindow?s.scrollTop:s.offset.top,a=e.within.height,r=t.top-e.collisionPosition.marginTop,h=n-r,l=r+e.collisionHeight-a-n;e.collisionHeight>a?h>0&&0>=l?(i=t.top+h+e.collisionHeight-a-n,t.top+=h-i):t.top=l>0&&0>=h?n:h>l?n+a-e.collisionHeight:n:h>0?t.top+=h:l>0?t.top-=l:t.top=o(t.top-r,t.top)}},flip:{left:function(t,e){var i,s,n=e.within,o=n.offset.left+n.scrollLeft,r=n.width,h=n.isWindow?n.scrollLeft:n.offset.left,l=t.left-e.collisionPosition.marginLeft,c=l-h,u=l+e.collisionWidth-r-h,d="left"===e.my[0]?-e.elemWidth:"right"===e.my[0]?e.elemWidth:0,p="left"===e.at[0]?e.targetWidth:"right"===e.at[0]?-e.targetWidth:0,f=-2*e.offset[0];0>c?(i=t.left+d+p+f+e.collisionWidth-r-o,(0>i||a(c)>i)&&(t.left+=d+p+f)):u>0&&(s=t.left-e.collisionPosition.marginLeft+d+p+f-h,(s>0||u>a(s))&&(t.left+=d+p+f))},top:function(t,e){var i,s,n=e.within,o=n.offset.top+n.scrollTop,r=n.height,h=n.isWindow?n.scrollTop:n.offset.top,l=t.top-e.collisionPosition.marginTop,c=l-h,u=l+e.collisionHeight-r-h,d="top"===e.my[1],p=d?-e.elemHeight:"bottom"===e.my[1]?e.elemHeight:0,f="top"===e.at[1]?e.targetHeight:"bottom"===e.at[1]?-e.targetHeight:0,m=-2*e.offset[1];0>c?(s=t.top+p+f+m+e.collisionHeight-r-o,(0>s||a(c)>s)&&(t.top+=p+f+m)):u>0&&(i=t.top-e.collisionPosition.marginTop+p+f+m-h,(i>0||u>a(i))&&(t.top+=p+f+m))}},flipfit:{left:function(){t.ui.position.flip.left.apply(this,arguments),t.ui.position.fit.left.apply(this,arguments)},top:function(){t.ui.position.flip.top.apply(this,arguments),t.ui.position.fit.top.apply(this,arguments)}}}}(),t.ui.position,t.extend(t.expr[":"],{data:t.expr.createPseudo?t.expr.createPseudo(function(e){return function(i){return!!t.data(i,e)}}):function(e,i,s){return!!t.data(e,s[3])}}),t.fn.extend({disableSelection:function(){var t="onselectstart"in document.createElement("div")?"selectstart":"mousedown";return function(){return this.on(t+".ui-disableSelection",function(t){t.preventDefault()})}}(),enableSelection:function(){return this.off(".ui-disableSelection")}}),t.ui.focusable=function(i,s){var n,o,a,r,h,l=i.nodeName.toLowerCase();return"area"===l?(n=i.parentNode,o=n.name,i.href&&o&&"map"===n.nodeName.toLowerCase()?(a=t("img[usemap='#"+o+"']"),a.length>0&&a.is(":visible")):!1):(/^(input|select|textarea|button|object)$/.test(l)?(r=!i.disabled,r&&(h=t(i).closest("fieldset")[0],h&&(r=!h.disabled))):r="a"===l?i.href||s:s,r&&t(i).is(":visible")&&e(t(i)))},t.extend(t.expr[":"],{focusable:function(e){return t.ui.focusable(e,null!=t.attr(e,"tabindex"))}}),t.ui.focusable,t.fn.form=function(){return"string"==typeof this[0].form?this.closest("form"):t(this[0].form)},t.ui.formResetMixin={_formResetHandler:function(){var e=t(this);setTimeout(function(){var i=e.data("ui-form-reset-instances");t.each(i,function(){this.refresh()})})},_bindFormResetHandler:function(){if(this.form=this.element.form(),this.form.length){var t=this.form.data("ui-form-reset-instances")||[];t.length||this.form.on("reset.ui-form-reset",this._formResetHandler),t.push(this),this.form.data("ui-form-reset-instances",t)}},_unbindFormResetHandler:function(){if(this.form.length){var e=this.form.data("ui-form-reset-instances");e.splice(t.inArray(this,e),1),e.length?this.form.data("ui-form-reset-instances",e):this.form.removeData("ui-form-reset-instances").off("reset.ui-form-reset")}}},"1.7"===t.fn.jquery.substring(0,3)&&(t.each(["Width","Height"],function(e,i){function s(e,i,s,o){return t.each(n,function(){i-=parseFloat(t.css(e,"padding"+this))||0,s&&(i-=parseFloat(t.css(e,"border"+this+"Width"))||0),o&&(i-=parseFloat(t.css(e,"margin"+this))||0)}),i}var n="Width"===i?["Left","Right"]:["Top","Bottom"],o=i.toLowerCase(),a={innerWidth:t.fn.innerWidth,innerHeight:t.fn.innerHeight,outerWidth:t.fn.outerWidth,outerHeight:t.fn.outerHeight};t.fn["inner"+i]=function(e){return void 0===e?a["inner"+i].call(this):this.each(function(){t(this).css(o,s(this,e)+"px")})},t.fn["outer"+i]=function(e,n){return"number"!=typeof e?a["outer"+i].call(this,e):this.each(function(){t(this).css(o,s(this,e,!0,n)+"px")})}}),t.fn.addBack=function(t){return this.add(null==t?this.prevObject:this.prevObject.filter(t))}),t.ui.keyCode={BACKSPACE:8,COMMA:188,DELETE:46,DOWN:40,END:35,ENTER:13,ESCAPE:27,HOME:36,LEFT:37,PAGE_DOWN:34,PAGE_UP:33,PERIOD:190,RIGHT:39,SPACE:32,TAB:9,UP:38},t.ui.escapeSelector=function(){var t=/([!"#$%&'()*+,./:;<=>?@[\]^`{|}~])/g;return function(e){return e.replace(t,"\\$1")}}(),t.fn.labels=function(){var e,i,s,n,o;return this[0].labels&&this[0].labels.length?this.pushStack(this[0].labels):(n=this.eq(0).parents("label"),s=this.attr("id"),s&&(e=this.eq(0).parents().last(),o=e.add(e.length?e.siblings():this.siblings()),i="label[for='"+t.ui.escapeSelector(s)+"']",n=n.add(o.find(i).addBack(i))),this.pushStack(n))},t.fn.scrollParent=function(e){var i=this.css("position"),s="absolute"===i,n=e?/(auto|scroll|hidden)/:/(auto|scroll)/,o=this.parents().filter(function(){var e=t(this);return s&&"static"===e.css("position")?!1:n.test(e.css("overflow")+e.css("overflow-y")+e.css("overflow-x"))}).eq(0);return"fixed"!==i&&o.length?o:t(this[0].ownerDocument||document)},t.extend(t.expr[":"],{tabbable:function(e){var i=t.attr(e,"tabindex"),s=null!=i;return(!s||i>=0)&&t.ui.focusable(e,s)}}),t.fn.extend({uniqueId:function(){var t=0;return function(){return this.each(function(){this.id||(this.id="ui-id-"+ ++t)})}}(),removeUniqueId:function(){return this.each(function(){/^ui-id-\d+$/.test(this.id)&&t(this).removeAttr("id")})}}),t.ui.ie=!!/msie [\w.]+/.exec(navigator.userAgent.toLowerCase());var n=!1;t(document).on("mouseup",function(){n=!1}),t.widget("ui.mouse",{version:"1.12.1",options:{cancel:"input, textarea, button, select, option",distance:1,delay:0},_mouseInit:function(){var e=this;this.element.on("mousedown."+this.widgetName,function(t){return e._mouseDown(t)}).on("click."+this.widgetName,function(i){return!0===t.data(i.target,e.widgetName+".preventClickEvent")?(t.removeData(i.target,e.widgetName+".preventClickEvent"),i.stopImmediatePropagation(),!1):void 0}),this.started=!1},_mouseDestroy:function(){this.element.off("."+this.widgetName),this._mouseMoveDelegate&&this.document.off("mousemove."+this.widgetName,this._mouseMoveDelegate).off("mouseup."+this.widgetName,this._mouseUpDelegate)},_mouseDown:function(e){if(!n){this._mouseMoved=!1,this._mouseStarted&&this._mouseUp(e),this._mouseDownEvent=e;var i=this,s=1===e.which,o="string"==typeof this.options.cancel&&e.target.nodeName?t(e.target).closest(this.options.cancel).length:!1;return s&&!o&&this._mouseCapture(e)?(this.mouseDelayMet=!this.options.delay,this.mouseDelayMet||(this._mouseDelayTimer=setTimeout(function(){i.mouseDelayMet=!0},this.options.delay)),this._mouseDistanceMet(e)&&this._mouseDelayMet(e)&&(this._mouseStarted=this._mouseStart(e)!==!1,!this._mouseStarted)?(e.preventDefault(),!0):(!0===t.data(e.target,this.widgetName+".preventClickEvent")&&t.removeData(e.target,this.widgetName+".preventClickEvent"),this._mouseMoveDelegate=function(t){return i._mouseMove(t)},this._mouseUpDelegate=function(t){return i._mouseUp(t)},this.document.on("mousemove."+this.widgetName,this._mouseMoveDelegate).on("mouseup."+this.widgetName,this._mouseUpDelegate),e.preventDefault(),n=!0,!0)):!0}},_mouseMove:function(e){if(this._mouseMoved){if(t.ui.ie&&(!document.documentMode||9>document.documentMode)&&!e.button)return this._mouseUp(e);if(!e.which)if(e.originalEvent.altKey||e.originalEvent.ctrlKey||e.originalEvent.metaKey||e.originalEvent.shiftKey)this.ignoreMissingWhich=!0;else if(!this.ignoreMissingWhich)return this._mouseUp(e)}return(e.which||e.button)&&(this._mouseMoved=!0),this._mouseStarted?(this._mouseDrag(e),e.preventDefault()):(this._mouseDistanceMet(e)&&this._mouseDelayMet(e)&&(this._mouseStarted=this._mouseStart(this._mouseDownEvent,e)!==!1,this._mouseStarted?this._mouseDrag(e):this._mouseUp(e)),!this._mouseStarted)},_mouseUp:function(e){this.document.off("mousemove."+this.widgetName,this._mouseMoveDelegate).off("mouseup."+this.widgetName,this._mouseUpDelegate),this._mouseStarted&&(this._mouseStarted=!1,e.target===this._mouseDownEvent.target&&t.data(e.target,this.widgetName+".preventClickEvent",!0),this._mouseStop(e)),this._mouseDelayTimer&&(clearTimeout(this._mouseDelayTimer),delete this._mouseDelayTimer),this.ignoreMissingWhich=!1,n=!1,e.preventDefault()},_mouseDistanceMet:function(t){return Math.max(Math.abs(this._mouseDownEvent.pageX-t.pageX),Math.abs(this._mouseDownEvent.pageY-t.pageY))>=this.options.distance},_mouseDelayMet:function(){return this.mouseDelayMet},_mouseStart:function(){},_mouseDrag:function(){},_mouseStop:function(){},_mouseCapture:function(){return!0}}),t.ui.plugin={add:function(e,i,s){var n,o=t.ui[e].prototype;for(n in s)o.plugins[n]=o.plugins[n]||[],o.plugins[n].push([i,s[n]])},call:function(t,e,i,s){var n,o=t.plugins[e];if(o&&(s||t.element[0].parentNode&&11!==t.element[0].parentNode.nodeType))for(n=0;o.length>n;n++)t.options[o[n][0]]&&o[n][1].apply(t.element,i)}},t.widget("ui.resizable",t.ui.mouse,{version:"1.12.1",widgetEventPrefix:"resize",options:{alsoResize:!1,animate:!1,animateDuration:"slow",animateEasing:"swing",aspectRatio:!1,autoHide:!1,classes:{"ui-resizable-se":"ui-icon ui-icon-gripsmall-diagonal-se"},containment:!1,ghost:!1,grid:!1,handles:"e,s,se",helper:!1,maxHeight:null,maxWidth:null,minHeight:10,minWidth:10,zIndex:90,resize:null,start:null,stop:null},_num:function(t){return parseFloat(t)||0},_isNumber:function(t){return!isNaN(parseFloat(t))},_hasScroll:function(e,i){if("hidden"===t(e).css("overflow"))return!1;var s=i&&"left"===i?"scrollLeft":"scrollTop",n=!1;return e[s]>0?!0:(e[s]=1,n=e[s]>0,e[s]=0,n)},_create:function(){var e,i=this.options,s=this;this._addClass("ui-resizable"),t.extend(this,{_aspectRatio:!!i.aspectRatio,aspectRatio:i.aspectRatio,originalElement:this.element,_proportionallyResizeElements:[],_helper:i.helper||i.ghost||i.animate?i.helper||"ui-resizable-helper":null}),this.element[0].nodeName.match(/^(canvas|textarea|input|select|button|img)$/i)&&(this.element.wrap(t("
").css({position:this.element.css("position"),width:this.element.outerWidth(),height:this.element.outerHeight(),top:this.element.css("top"),left:this.element.css("left")})),this.element=this.element.parent().data("ui-resizable",this.element.resizable("instance")),this.elementIsWrapper=!0,e={marginTop:this.originalElement.css("marginTop"),marginRight:this.originalElement.css("marginRight"),marginBottom:this.originalElement.css("marginBottom"),marginLeft:this.originalElement.css("marginLeft")},this.element.css(e),this.originalElement.css("margin",0),this.originalResizeStyle=this.originalElement.css("resize"),this.originalElement.css("resize","none"),this._proportionallyResizeElements.push(this.originalElement.css({position:"static",zoom:1,display:"block"})),this.originalElement.css(e),this._proportionallyResize()),this._setupHandles(),i.autoHide&&t(this.element).on("mouseenter",function(){i.disabled||(s._removeClass("ui-resizable-autohide"),s._handles.show())}).on("mouseleave",function(){i.disabled||s.resizing||(s._addClass("ui-resizable-autohide"),s._handles.hide())}),this._mouseInit()},_destroy:function(){this._mouseDestroy();var e,i=function(e){t(e).removeData("resizable").removeData("ui-resizable").off(".resizable").find(".ui-resizable-handle").remove()};return this.elementIsWrapper&&(i(this.element),e=this.element,this.originalElement.css({position:e.css("position"),width:e.outerWidth(),height:e.outerHeight(),top:e.css("top"),left:e.css("left")}).insertAfter(e),e.remove()),this.originalElement.css("resize",this.originalResizeStyle),i(this.originalElement),this},_setOption:function(t,e){switch(this._super(t,e),t){case"handles":this._removeHandles(),this._setupHandles();break;default:}},_setupHandles:function(){var e,i,s,n,o,a=this.options,r=this;if(this.handles=a.handles||(t(".ui-resizable-handle",this.element).length?{n:".ui-resizable-n",e:".ui-resizable-e",s:".ui-resizable-s",w:".ui-resizable-w",se:".ui-resizable-se",sw:".ui-resizable-sw",ne:".ui-resizable-ne",nw:".ui-resizable-nw"}:"e,s,se"),this._handles=t(),this.handles.constructor===String)for("all"===this.handles&&(this.handles="n,e,s,w,se,sw,ne,nw"),s=this.handles.split(","),this.handles={},i=0;s.length>i;i++)e=t.trim(s[i]),n="ui-resizable-"+e,o=t(""),this._addClass(o,"ui-resizable-handle "+n),o.css({zIndex:a.zIndex}),this.handles[e]=".ui-resizable-"+e,this.element.append(o);this._renderAxis=function(e){var i,s,n,o;e=e||this.element;for(i in this.handles)this.handles[i].constructor===String?this.handles[i]=this.element.children(this.handles[i]).first().show():(this.handles[i].jquery||this.handles[i].nodeType)&&(this.handles[i]=t(this.handles[i]),this._on(this.handles[i],{mousedown:r._mouseDown})),this.elementIsWrapper&&this.originalElement[0].nodeName.match(/^(textarea|input|select|button)$/i)&&(s=t(this.handles[i],this.element),o=/sw|ne|nw|se|n|s/.test(i)?s.outerHeight():s.outerWidth(),n=["padding",/ne|nw|n/.test(i)?"Top":/se|sw|s/.test(i)?"Bottom":/^e$/.test(i)?"Right":"Left"].join(""),e.css(n,o),this._proportionallyResize()),this._handles=this._handles.add(this.handles[i])},this._renderAxis(this.element),this._handles=this._handles.add(this.element.find(".ui-resizable-handle")),this._handles.disableSelection(),this._handles.on("mouseover",function(){r.resizing||(this.className&&(o=this.className.match(/ui-resizable-(se|sw|ne|nw|n|e|s|w)/i)),r.axis=o&&o[1]?o[1]:"se")}),a.autoHide&&(this._handles.hide(),this._addClass("ui-resizable-autohide"))},_removeHandles:function(){this._handles.remove()},_mouseCapture:function(e){var i,s,n=!1;for(i in this.handles)s=t(this.handles[i])[0],(s===e.target||t.contains(s,e.target))&&(n=!0);return!this.options.disabled&&n},_mouseStart:function(e){var i,s,n,o=this.options,a=this.element;return this.resizing=!0,this._renderProxy(),i=this._num(this.helper.css("left")),s=this._num(this.helper.css("top")),o.containment&&(i+=t(o.containment).scrollLeft()||0,s+=t(o.containment).scrollTop()||0),this.offset=this.helper.offset(),this.position={left:i,top:s},this.size=this._helper?{width:this.helper.width(),height:this.helper.height()}:{width:a.width(),height:a.height()},this.originalSize=this._helper?{width:a.outerWidth(),height:a.outerHeight()}:{width:a.width(),height:a.height()},this.sizeDiff={width:a.outerWidth()-a.width(),height:a.outerHeight()-a.height()},this.originalPosition={left:i,top:s},this.originalMousePosition={left:e.pageX,top:e.pageY},this.aspectRatio="number"==typeof o.aspectRatio?o.aspectRatio:this.originalSize.width/this.originalSize.height||1,n=t(".ui-resizable-"+this.axis).css("cursor"),t("body").css("cursor","auto"===n?this.axis+"-resize":n),this._addClass("ui-resizable-resizing"),this._propagate("start",e),!0},_mouseDrag:function(e){var i,s,n=this.originalMousePosition,o=this.axis,a=e.pageX-n.left||0,r=e.pageY-n.top||0,h=this._change[o];return this._updatePrevProperties(),h?(i=h.apply(this,[e,a,r]),this._updateVirtualBoundaries(e.shiftKey),(this._aspectRatio||e.shiftKey)&&(i=this._updateRatio(i,e)),i=this._respectSize(i,e),this._updateCache(i),this._propagate("resize",e),s=this._applyChanges(),!this._helper&&this._proportionallyResizeElements.length&&this._proportionallyResize(),t.isEmptyObject(s)||(this._updatePrevProperties(),this._trigger("resize",e,this.ui()),this._applyChanges()),!1):!1},_mouseStop:function(e){this.resizing=!1;var i,s,n,o,a,r,h,l=this.options,c=this;return this._helper&&(i=this._proportionallyResizeElements,s=i.length&&/textarea/i.test(i[0].nodeName),n=s&&this._hasScroll(i[0],"left")?0:c.sizeDiff.height,o=s?0:c.sizeDiff.width,a={width:c.helper.width()-o,height:c.helper.height()-n},r=parseFloat(c.element.css("left"))+(c.position.left-c.originalPosition.left)||null,h=parseFloat(c.element.css("top"))+(c.position.top-c.originalPosition.top)||null,l.animate||this.element.css(t.extend(a,{top:h,left:r})),c.helper.height(c.size.height),c.helper.width(c.size.width),this._helper&&!l.animate&&this._proportionallyResize()),t("body").css("cursor","auto"),this._removeClass("ui-resizable-resizing"),this._propagate("stop",e),this._helper&&this.helper.remove(),!1},_updatePrevProperties:function(){this.prevPosition={top:this.position.top,left:this.position.left},this.prevSize={width:this.size.width,height:this.size.height}},_applyChanges:function(){var t={};return this.position.top!==this.prevPosition.top&&(t.top=this.position.top+"px"),this.position.left!==this.prevPosition.left&&(t.left=this.position.left+"px"),this.size.width!==this.prevSize.width&&(t.width=this.size.width+"px"),this.size.height!==this.prevSize.height&&(t.height=this.size.height+"px"),this.helper.css(t),t},_updateVirtualBoundaries:function(t){var e,i,s,n,o,a=this.options;o={minWidth:this._isNumber(a.minWidth)?a.minWidth:0,maxWidth:this._isNumber(a.maxWidth)?a.maxWidth:1/0,minHeight:this._isNumber(a.minHeight)?a.minHeight:0,maxHeight:this._isNumber(a.maxHeight)?a.maxHeight:1/0},(this._aspectRatio||t)&&(e=o.minHeight*this.aspectRatio,s=o.minWidth/this.aspectRatio,i=o.maxHeight*this.aspectRatio,n=o.maxWidth/this.aspectRatio,e>o.minWidth&&(o.minWidth=e),s>o.minHeight&&(o.minHeight=s),o.maxWidth>i&&(o.maxWidth=i),o.maxHeight>n&&(o.maxHeight=n)),this._vBoundaries=o},_updateCache:function(t){this.offset=this.helper.offset(),this._isNumber(t.left)&&(this.position.left=t.left),this._isNumber(t.top)&&(this.position.top=t.top),this._isNumber(t.height)&&(this.size.height=t.height),this._isNumber(t.width)&&(this.size.width=t.width)},_updateRatio:function(t){var e=this.position,i=this.size,s=this.axis;return this._isNumber(t.height)?t.width=t.height*this.aspectRatio:this._isNumber(t.width)&&(t.height=t.width/this.aspectRatio),"sw"===s&&(t.left=e.left+(i.width-t.width),t.top=null),"nw"===s&&(t.top=e.top+(i.height-t.height),t.left=e.left+(i.width-t.width)),t},_respectSize:function(t){var e=this._vBoundaries,i=this.axis,s=this._isNumber(t.width)&&e.maxWidth&&e.maxWidth
t.width,a=this._isNumber(t.height)&&e.minHeight&&e.minHeight>t.height,r=this.originalPosition.left+this.originalSize.width,h=this.originalPosition.top+this.originalSize.height,l=/sw|nw|w/.test(i),c=/nw|ne|n/.test(i);return o&&(t.width=e.minWidth),a&&(t.height=e.minHeight),s&&(t.width=e.maxWidth),n&&(t.height=e.maxHeight),o&&l&&(t.left=r-e.minWidth),s&&l&&(t.left=r-e.maxWidth),a&&c&&(t.top=h-e.minHeight),n&&c&&(t.top=h-e.maxHeight),t.width||t.height||t.left||!t.top?t.width||t.height||t.top||!t.left||(t.left=null):t.top=null,t},_getPaddingPlusBorderDimensions:function(t){for(var e=0,i=[],s=[t.css("borderTopWidth"),t.css("borderRightWidth"),t.css("borderBottomWidth"),t.css("borderLeftWidth")],n=[t.css("paddingTop"),t.css("paddingRight"),t.css("paddingBottom"),t.css("paddingLeft")];4>e;e++)i[e]=parseFloat(s[e])||0,i[e]+=parseFloat(n[e])||0;return{height:i[0]+i[2],width:i[1]+i[3]}},_proportionallyResize:function(){if(this._proportionallyResizeElements.length)for(var t,e=0,i=this.helper||this.element;this._proportionallyResizeElements.length>e;e++)t=this._proportionallyResizeElements[e],this.outerDimensions||(this.outerDimensions=this._getPaddingPlusBorderDimensions(t)),t.css({height:i.height()-this.outerDimensions.height||0,width:i.width()-this.outerDimensions.width||0})},_renderProxy:function(){var e=this.element,i=this.options;this.elementOffset=e.offset(),this._helper?(this.helper=this.helper||t("
"),this._addClass(this.helper,this._helper),this.helper.css({width:this.element.outerWidth(),height:this.element.outerHeight(),position:"absolute",left:this.elementOffset.left+"px",top:this.elementOffset.top+"px",zIndex:++i.zIndex}),this.helper.appendTo("body").disableSelection()):this.helper=this.element
+},_change:{e:function(t,e){return{width:this.originalSize.width+e}},w:function(t,e){var i=this.originalSize,s=this.originalPosition;return{left:s.left+e,width:i.width-e}},n:function(t,e,i){var s=this.originalSize,n=this.originalPosition;return{top:n.top+i,height:s.height-i}},s:function(t,e,i){return{height:this.originalSize.height+i}},se:function(e,i,s){return t.extend(this._change.s.apply(this,arguments),this._change.e.apply(this,[e,i,s]))},sw:function(e,i,s){return t.extend(this._change.s.apply(this,arguments),this._change.w.apply(this,[e,i,s]))},ne:function(e,i,s){return t.extend(this._change.n.apply(this,arguments),this._change.e.apply(this,[e,i,s]))},nw:function(e,i,s){return t.extend(this._change.n.apply(this,arguments),this._change.w.apply(this,[e,i,s]))}},_propagate:function(e,i){t.ui.plugin.call(this,e,[i,this.ui()]),"resize"!==e&&this._trigger(e,i,this.ui())},plugins:{},ui:function(){return{originalElement:this.originalElement,element:this.element,helper:this.helper,position:this.position,size:this.size,originalSize:this.originalSize,originalPosition:this.originalPosition}}}),t.ui.plugin.add("resizable","animate",{stop:function(e){var i=t(this).resizable("instance"),s=i.options,n=i._proportionallyResizeElements,o=n.length&&/textarea/i.test(n[0].nodeName),a=o&&i._hasScroll(n[0],"left")?0:i.sizeDiff.height,r=o?0:i.sizeDiff.width,h={width:i.size.width-r,height:i.size.height-a},l=parseFloat(i.element.css("left"))+(i.position.left-i.originalPosition.left)||null,c=parseFloat(i.element.css("top"))+(i.position.top-i.originalPosition.top)||null;i.element.animate(t.extend(h,c&&l?{top:c,left:l}:{}),{duration:s.animateDuration,easing:s.animateEasing,step:function(){var s={width:parseFloat(i.element.css("width")),height:parseFloat(i.element.css("height")),top:parseFloat(i.element.css("top")),left:parseFloat(i.element.css("left"))};n&&n.length&&t(n[0]).css({width:s.width,height:s.height}),i._updateCache(s),i._propagate("resize",e)}})}}),t.ui.plugin.add("resizable","containment",{start:function(){var e,i,s,n,o,a,r,h=t(this).resizable("instance"),l=h.options,c=h.element,u=l.containment,d=u instanceof t?u.get(0):/parent/.test(u)?c.parent().get(0):u;d&&(h.containerElement=t(d),/document/.test(u)||u===document?(h.containerOffset={left:0,top:0},h.containerPosition={left:0,top:0},h.parentData={element:t(document),left:0,top:0,width:t(document).width(),height:t(document).height()||document.body.parentNode.scrollHeight}):(e=t(d),i=[],t(["Top","Right","Left","Bottom"]).each(function(t,s){i[t]=h._num(e.css("padding"+s))}),h.containerOffset=e.offset(),h.containerPosition=e.position(),h.containerSize={height:e.innerHeight()-i[3],width:e.innerWidth()-i[1]},s=h.containerOffset,n=h.containerSize.height,o=h.containerSize.width,a=h._hasScroll(d,"left")?d.scrollWidth:o,r=h._hasScroll(d)?d.scrollHeight:n,h.parentData={element:d,left:s.left,top:s.top,width:a,height:r}))},resize:function(e){var i,s,n,o,a=t(this).resizable("instance"),r=a.options,h=a.containerOffset,l=a.position,c=a._aspectRatio||e.shiftKey,u={top:0,left:0},d=a.containerElement,p=!0;d[0]!==document&&/static/.test(d.css("position"))&&(u=h),l.left<(a._helper?h.left:0)&&(a.size.width=a.size.width+(a._helper?a.position.left-h.left:a.position.left-u.left),c&&(a.size.height=a.size.width/a.aspectRatio,p=!1),a.position.left=r.helper?h.left:0),l.top<(a._helper?h.top:0)&&(a.size.height=a.size.height+(a._helper?a.position.top-h.top:a.position.top),c&&(a.size.width=a.size.height*a.aspectRatio,p=!1),a.position.top=a._helper?h.top:0),n=a.containerElement.get(0)===a.element.parent().get(0),o=/relative|absolute/.test(a.containerElement.css("position")),n&&o?(a.offset.left=a.parentData.left+a.position.left,a.offset.top=a.parentData.top+a.position.top):(a.offset.left=a.element.offset().left,a.offset.top=a.element.offset().top),i=Math.abs(a.sizeDiff.width+(a._helper?a.offset.left-u.left:a.offset.left-h.left)),s=Math.abs(a.sizeDiff.height+(a._helper?a.offset.top-u.top:a.offset.top-h.top)),i+a.size.width>=a.parentData.width&&(a.size.width=a.parentData.width-i,c&&(a.size.height=a.size.width/a.aspectRatio,p=!1)),s+a.size.height>=a.parentData.height&&(a.size.height=a.parentData.height-s,c&&(a.size.width=a.size.height*a.aspectRatio,p=!1)),p||(a.position.left=a.prevPosition.left,a.position.top=a.prevPosition.top,a.size.width=a.prevSize.width,a.size.height=a.prevSize.height)},stop:function(){var e=t(this).resizable("instance"),i=e.options,s=e.containerOffset,n=e.containerPosition,o=e.containerElement,a=t(e.helper),r=a.offset(),h=a.outerWidth()-e.sizeDiff.width,l=a.outerHeight()-e.sizeDiff.height;e._helper&&!i.animate&&/relative/.test(o.css("position"))&&t(this).css({left:r.left-n.left-s.left,width:h,height:l}),e._helper&&!i.animate&&/static/.test(o.css("position"))&&t(this).css({left:r.left-n.left-s.left,width:h,height:l})}}),t.ui.plugin.add("resizable","alsoResize",{start:function(){var e=t(this).resizable("instance"),i=e.options;t(i.alsoResize).each(function(){var e=t(this);e.data("ui-resizable-alsoresize",{width:parseFloat(e.width()),height:parseFloat(e.height()),left:parseFloat(e.css("left")),top:parseFloat(e.css("top"))})})},resize:function(e,i){var s=t(this).resizable("instance"),n=s.options,o=s.originalSize,a=s.originalPosition,r={height:s.size.height-o.height||0,width:s.size.width-o.width||0,top:s.position.top-a.top||0,left:s.position.left-a.left||0};t(n.alsoResize).each(function(){var e=t(this),s=t(this).data("ui-resizable-alsoresize"),n={},o=e.parents(i.originalElement[0]).length?["width","height"]:["width","height","top","left"];t.each(o,function(t,e){var i=(s[e]||0)+(r[e]||0);i&&i>=0&&(n[e]=i||null)}),e.css(n)})},stop:function(){t(this).removeData("ui-resizable-alsoresize")}}),t.ui.plugin.add("resizable","ghost",{start:function(){var e=t(this).resizable("instance"),i=e.size;e.ghost=e.originalElement.clone(),e.ghost.css({opacity:.25,display:"block",position:"relative",height:i.height,width:i.width,margin:0,left:0,top:0}),e._addClass(e.ghost,"ui-resizable-ghost"),t.uiBackCompat!==!1&&"string"==typeof e.options.ghost&&e.ghost.addClass(this.options.ghost),e.ghost.appendTo(e.helper)},resize:function(){var e=t(this).resizable("instance");e.ghost&&e.ghost.css({position:"relative",height:e.size.height,width:e.size.width})},stop:function(){var e=t(this).resizable("instance");e.ghost&&e.helper&&e.helper.get(0).removeChild(e.ghost.get(0))}}),t.ui.plugin.add("resizable","grid",{resize:function(){var e,i=t(this).resizable("instance"),s=i.options,n=i.size,o=i.originalSize,a=i.originalPosition,r=i.axis,h="number"==typeof s.grid?[s.grid,s.grid]:s.grid,l=h[0]||1,c=h[1]||1,u=Math.round((n.width-o.width)/l)*l,d=Math.round((n.height-o.height)/c)*c,p=o.width+u,f=o.height+d,m=s.maxWidth&&p>s.maxWidth,g=s.maxHeight&&f>s.maxHeight,_=s.minWidth&&s.minWidth>p,v=s.minHeight&&s.minHeight>f;s.grid=h,_&&(p+=l),v&&(f+=c),m&&(p-=l),g&&(f-=c),/^(se|s|e)$/.test(r)?(i.size.width=p,i.size.height=f):/^(ne)$/.test(r)?(i.size.width=p,i.size.height=f,i.position.top=a.top-d):/^(sw)$/.test(r)?(i.size.width=p,i.size.height=f,i.position.left=a.left-u):((0>=f-c||0>=p-l)&&(e=i._getPaddingPlusBorderDimensions(this)),f-c>0?(i.size.height=f,i.position.top=a.top-d):(f=c-e.height,i.size.height=f,i.position.top=a.top+o.height-f),p-l>0?(i.size.width=p,i.position.left=a.left-u):(p=l-e.width,i.size.width=p,i.position.left=a.left+o.width-p))}}),t.ui.resizable});/**
+ * Copyright (c) 2007 Ariel Flesler - aflesler ○ gmail • com | https://github.com/flesler
+ * Licensed under MIT
+ * @author Ariel Flesler
+ * @version 2.1.2
+ */
+;(function(f){"use strict";"function"===typeof define&&define.amd?define(["jquery"],f):"undefined"!==typeof module&&module.exports?module.exports=f(require("jquery")):f(jQuery)})(function($){"use strict";function n(a){return!a.nodeName||-1!==$.inArray(a.nodeName.toLowerCase(),["iframe","#document","html","body"])}function h(a){return $.isFunction(a)||$.isPlainObject(a)?a:{top:a,left:a}}var p=$.scrollTo=function(a,d,b){return $(window).scrollTo(a,d,b)};p.defaults={axis:"xy",duration:0,limit:!0};$.fn.scrollTo=function(a,d,b){"object"=== typeof d&&(b=d,d=0);"function"===typeof b&&(b={onAfter:b});"max"===a&&(a=9E9);b=$.extend({},p.defaults,b);d=d||b.duration;var u=b.queue&&1=f[g]?0:Math.min(f[g],n));!a&&1-1){targetElements.on(evt+EVENT_NAMESPACE,function elementToggle(event){$.powerTip.toggle(this,event)})}else{targetElements.on(evt+EVENT_NAMESPACE,function elementOpen(event){$.powerTip.show(this,event)})}});$.each(options.closeEvents,function(idx,evt){if($.inArray(evt,options.openEvents)<0){targetElements.on(evt+EVENT_NAMESPACE,function elementClose(event){$.powerTip.hide(this,!isMouseEvent(event))})}});targetElements.on("keydown"+EVENT_NAMESPACE,function elementKeyDown(event){if(event.keyCode===27){$.powerTip.hide(this,true)}})}return targetElements};$.fn.powerTip.defaults={fadeInTime:200,fadeOutTime:100,followMouse:false,popupId:"powerTip",popupClass:null,intentSensitivity:7,intentPollInterval:100,closeDelay:100,placement:"n",smartPlacement:false,offset:10,mouseOnToPopup:false,manual:false,openEvents:["mouseenter","focus"],closeEvents:["mouseleave","blur"]};$.fn.powerTip.smartPlacementLists={n:["n","ne","nw","s"],e:["e","ne","se","w","nw","sw","n","s","e"],s:["s","se","sw","n"],w:["w","nw","sw","e","ne","se","n","s","w"],nw:["nw","w","sw","n","s","se","nw"],ne:["ne","e","se","n","s","sw","ne"],sw:["sw","w","nw","s","n","ne","sw"],se:["se","e","ne","s","n","nw","se"],"nw-alt":["nw-alt","n","ne-alt","sw-alt","s","se-alt","w","e"],"ne-alt":["ne-alt","n","nw-alt","se-alt","s","sw-alt","e","w"],"sw-alt":["sw-alt","s","se-alt","nw-alt","n","ne-alt","w","e"],"se-alt":["se-alt","s","sw-alt","ne-alt","n","nw-alt","e","w"]};$.powerTip={show:function apiShowTip(element,event){if(isMouseEvent(event)){trackMouse(event);session.previousX=event.pageX;session.previousY=event.pageY;$(element).data(DATA_DISPLAYCONTROLLER).show()}else{$(element).first().data(DATA_DISPLAYCONTROLLER).show(true,true)}return element},reposition:function apiResetPosition(element){$(element).first().data(DATA_DISPLAYCONTROLLER).resetPosition();return element},hide:function apiCloseTip(element,immediate){var displayController;immediate=element?immediate:true;if(element){displayController=$(element).first().data(DATA_DISPLAYCONTROLLER)}else if(session.activeHover){displayController=session.activeHover.data(DATA_DISPLAYCONTROLLER)}if(displayController){displayController.hide(immediate)}return element},toggle:function apiToggle(element,event){if(session.activeHover&&session.activeHover.is(element)){$.powerTip.hide(element,!isMouseEvent(event))}else{$.powerTip.show(element,event)}return element}};$.powerTip.showTip=$.powerTip.show;$.powerTip.closeTip=$.powerTip.hide;function CSSCoordinates(){var me=this;me.top="auto";me.left="auto";me.right="auto";me.bottom="auto";me.set=function(property,value){if($.isNumeric(value)){me[property]=Math.round(value)}}}function DisplayController(element,options,tipController){var hoverTimer=null,myCloseDelay=null;function openTooltip(immediate,forceOpen){cancelTimer();if(!element.data(DATA_HASACTIVEHOVER)){if(!immediate){session.tipOpenImminent=true;hoverTimer=setTimeout(function intentDelay(){hoverTimer=null;checkForIntent()},options.intentPollInterval)}else{if(forceOpen){element.data(DATA_FORCEDOPEN,true)}closeAnyDelayed();tipController.showTip(element)}}else{cancelClose()}}function closeTooltip(disableDelay){if(myCloseDelay){myCloseDelay=session.closeDelayTimeout=clearTimeout(myCloseDelay);session.delayInProgress=false}cancelTimer();session.tipOpenImminent=false;if(element.data(DATA_HASACTIVEHOVER)){element.data(DATA_FORCEDOPEN,false);if(!disableDelay){session.delayInProgress=true;session.closeDelayTimeout=setTimeout(function closeDelay(){session.closeDelayTimeout=null;tipController.hideTip(element);session.delayInProgress=false;myCloseDelay=null},options.closeDelay);myCloseDelay=session.closeDelayTimeout}else{tipController.hideTip(element)}}}function checkForIntent(){var xDifference=Math.abs(session.previousX-session.currentX),yDifference=Math.abs(session.previousY-session.currentY),totalDifference=xDifference+yDifference;if(totalDifference",{id:options.popupId});if($body.length===0){$body=$("body")}$body.append(tipElement);session.tooltips=session.tooltips?session.tooltips.add(tipElement):tipElement}if(options.followMouse){if(!tipElement.data(DATA_HASMOUSEMOVE)){$document.on("mousemove"+EVENT_NAMESPACE,positionTipOnCursor);$window.on("scroll"+EVENT_NAMESPACE,positionTipOnCursor);tipElement.data(DATA_HASMOUSEMOVE,true)}}function beginShowTip(element){element.data(DATA_HASACTIVEHOVER,true);tipElement.queue(function queueTipInit(next){showTip(element);next()})}function showTip(element){var tipContent;if(!element.data(DATA_HASACTIVEHOVER)){return}if(session.isTipOpen){if(!session.isClosing){hideTip(session.activeHover)}tipElement.delay(100).queue(function queueTipAgain(next){showTip(element);next()});return}element.trigger("powerTipPreRender");tipContent=getTooltipContent(element);if(tipContent){tipElement.empty().append(tipContent)}else{return}element.trigger("powerTipRender");session.activeHover=element;session.isTipOpen=true;tipElement.data(DATA_MOUSEONTOTIP,options.mouseOnToPopup);tipElement.addClass(options.popupClass);if(!options.followMouse||element.data(DATA_FORCEDOPEN)){positionTipOnElement(element);session.isFixedTipOpen=true}else{positionTipOnCursor()}if(!element.data(DATA_FORCEDOPEN)&&!options.followMouse){$document.on("click"+EVENT_NAMESPACE,function documentClick(event){var target=event.target;if(target!==element[0]){if(options.mouseOnToPopup){if(target!==tipElement[0]&&!$.contains(tipElement[0],target)){$.powerTip.hide()}}else{$.powerTip.hide()}}})}if(options.mouseOnToPopup&&!options.manual){tipElement.on("mouseenter"+EVENT_NAMESPACE,function tipMouseEnter(){if(session.activeHover){session.activeHover.data(DATA_DISPLAYCONTROLLER).cancel()}});tipElement.on("mouseleave"+EVENT_NAMESPACE,function tipMouseLeave(){if(session.activeHover){session.activeHover.data(DATA_DISPLAYCONTROLLER).hide()}})}tipElement.fadeIn(options.fadeInTime,function fadeInCallback(){if(!session.desyncTimeout){session.desyncTimeout=setInterval(closeDesyncedTip,500)}element.trigger("powerTipOpen")})}function hideTip(element){session.isClosing=true;session.isTipOpen=false;session.desyncTimeout=clearInterval(session.desyncTimeout);element.data(DATA_HASACTIVEHOVER,false);element.data(DATA_FORCEDOPEN,false);$document.off("click"+EVENT_NAMESPACE);tipElement.off(EVENT_NAMESPACE);tipElement.fadeOut(options.fadeOutTime,function fadeOutCallback(){var coords=new CSSCoordinates;session.activeHover=null;session.isClosing=false;session.isFixedTipOpen=false;tipElement.removeClass();coords.set("top",session.currentY+options.offset);coords.set("left",session.currentX+options.offset);tipElement.css(coords);element.trigger("powerTipClose")})}function positionTipOnCursor(){var tipWidth,tipHeight,coords,collisions,collisionCount;if(!session.isFixedTipOpen&&(session.isTipOpen||session.tipOpenImminent&&tipElement.data(DATA_HASMOUSEMOVE))){tipWidth=tipElement.outerWidth();tipHeight=tipElement.outerHeight();coords=new CSSCoordinates;coords.set("top",session.currentY+options.offset);coords.set("left",session.currentX+options.offset);collisions=getViewportCollisions(coords,tipWidth,tipHeight);if(collisions!==Collision.none){collisionCount=countFlags(collisions);if(collisionCount===1){if(collisions===Collision.right){coords.set("left",session.scrollLeft+session.windowWidth-tipWidth)}else if(collisions===Collision.bottom){coords.set("top",session.scrollTop+session.windowHeight-tipHeight)}}else{coords.set("left",session.currentX-tipWidth-options.offset);coords.set("top",session.currentY-tipHeight-options.offset)}}tipElement.css(coords)}}function positionTipOnElement(element){var priorityList,finalPlacement;if(options.smartPlacement||options.followMouse&&element.data(DATA_FORCEDOPEN)){priorityList=$.fn.powerTip.smartPlacementLists[options.placement];$.each(priorityList,function(idx,pos){var collisions=getViewportCollisions(placeTooltip(element,pos),tipElement.outerWidth(),tipElement.outerHeight());finalPlacement=pos;return collisions!==Collision.none})}else{placeTooltip(element,options.placement);finalPlacement=options.placement}tipElement.removeClass("w nw sw e ne se n s w se-alt sw-alt ne-alt nw-alt");tipElement.addClass(finalPlacement)}function placeTooltip(element,placement){var iterationCount=0,tipWidth,tipHeight,coords=new CSSCoordinates;coords.set("top",0);coords.set("left",0);tipElement.css(coords);do{tipWidth=tipElement.outerWidth();tipHeight=tipElement.outerHeight();coords=placementCalculator.compute(element,placement,tipWidth,tipHeight,options.offset);tipElement.css(coords)}while(++iterationCount<=5&&(tipWidth!==tipElement.outerWidth()||tipHeight!==tipElement.outerHeight()));return coords}function closeDesyncedTip(){var isDesynced=false,hasDesyncableCloseEvent=$.grep(["mouseleave","mouseout","blur","focusout"],function(eventType){return $.inArray(eventType,options.closeEvents)!==-1}).length>0;if(session.isTipOpen&&!session.isClosing&&!session.delayInProgress&&hasDesyncableCloseEvent){if(session.activeHover.data(DATA_HASACTIVEHOVER)===false||session.activeHover.is(":disabled")){isDesynced=true}else if(!isMouseOver(session.activeHover)&&!session.activeHover.is(":focus")&&!session.activeHover.data(DATA_FORCEDOPEN)){if(tipElement.data(DATA_MOUSEONTOTIP)){if(!isMouseOver(tipElement)){isDesynced=true}}else{isDesynced=true}}if(isDesynced){hideTip(session.activeHover)}}}this.showTip=beginShowTip;this.hideTip=hideTip;this.resetPosition=positionTipOnElement}function isSvgElement(element){return Boolean(window.SVGElement&&element[0]instanceof SVGElement)}function isMouseEvent(event){return Boolean(event&&$.inArray(event.type,MOUSE_EVENTS)>-1&&typeof event.pageX==="number")}function initTracking(){if(!session.mouseTrackingActive){session.mouseTrackingActive=true;getViewportDimensions();$(getViewportDimensions);$document.on("mousemove"+EVENT_NAMESPACE,trackMouse);$window.on("resize"+EVENT_NAMESPACE,trackResize);$window.on("scroll"+EVENT_NAMESPACE,trackScroll)}}function getViewportDimensions(){session.scrollLeft=$window.scrollLeft();session.scrollTop=$window.scrollTop();session.windowWidth=$window.width();session.windowHeight=$window.height()}function trackResize(){session.windowWidth=$window.width();session.windowHeight=$window.height()}function trackScroll(){var x=$window.scrollLeft(),y=$window.scrollTop();if(x!==session.scrollLeft){session.currentX+=x-session.scrollLeft;session.scrollLeft=x}if(y!==session.scrollTop){session.currentY+=y-session.scrollTop;session.scrollTop=y}}function trackMouse(event){session.currentX=event.pageX;session.currentY=event.pageY}function isMouseOver(element){var elementPosition=element.offset(),elementBox=element[0].getBoundingClientRect(),elementWidth=elementBox.right-elementBox.left,elementHeight=elementBox.bottom-elementBox.top;return session.currentX>=elementPosition.left&&session.currentX<=elementPosition.left+elementWidth&&session.currentY>=elementPosition.top&&session.currentY<=elementPosition.top+elementHeight}function getTooltipContent(element){var tipText=element.data(DATA_POWERTIP),tipObject=element.data(DATA_POWERTIPJQ),tipTarget=element.data(DATA_POWERTIPTARGET),targetElement,content;if(tipText){if($.isFunction(tipText)){tipText=tipText.call(element[0])}content=tipText}else if(tipObject){if($.isFunction(tipObject)){tipObject=tipObject.call(element[0])}if(tipObject.length>0){content=tipObject.clone(true,true)}}else if(tipTarget){targetElement=$("#"+tipTarget);if(targetElement.length>0){content=targetElement.html()}}return content}function getViewportCollisions(coords,elementWidth,elementHeight){var viewportTop=session.scrollTop,viewportLeft=session.scrollLeft,viewportBottom=viewportTop+session.windowHeight,viewportRight=viewportLeft+session.windowWidth,collisions=Collision.none;if(coords.topviewportBottom||Math.abs(coords.bottom-session.windowHeight)>viewportBottom){collisions|=Collision.bottom}if(coords.leftviewportRight){collisions|=Collision.left}if(coords.left+elementWidth>viewportRight||coords.right1)){a.preventDefault();var c=a.originalEvent.changedTouches[0],d=document.createEvent("MouseEvents");d.initMouseEvent(b,!0,!0,window,1,c.screenX,c.screenY,c.clientX,c.clientY,!1,!1,!1,!1,0,null),a.target.dispatchEvent(d)}}if(a.support.touch="ontouchend"in document,a.support.touch){var e,b=a.ui.mouse.prototype,c=b._mouseInit,d=b._mouseDestroy;b._touchStart=function(a){var b=this;!e&&b._mouseCapture(a.originalEvent.changedTouches[0])&&(e=!0,b._touchMoved=!1,f(a,"mouseover"),f(a,"mousemove"),f(a,"mousedown"))},b._touchMove=function(a){e&&(this._touchMoved=!0,f(a,"mousemove"))},b._touchEnd=function(a){e&&(f(a,"mouseup"),f(a,"mouseout"),this._touchMoved||f(a,"click"),e=!1)},b._mouseInit=function(){var b=this;b.element.bind({touchstart:a.proxy(b,"_touchStart"),touchmove:a.proxy(b,"_touchMove"),touchend:a.proxy(b,"_touchEnd")}),c.call(b)},b._mouseDestroy=function(){var b=this;b.element.unbind({touchstart:a.proxy(b,"_touchStart"),touchmove:a.proxy(b,"_touchMove"),touchend:a.proxy(b,"_touchEnd")}),d.call(b)}}}(jQuery);/*! SmartMenus jQuery Plugin - v1.1.0 - September 17, 2017
+ * http://www.smartmenus.org/
+ * Copyright Vasil Dinkov, Vadikom Web Ltd. http://vadikom.com; Licensed MIT */(function(t){"function"==typeof define&&define.amd?define(["jquery"],t):"object"==typeof module&&"object"==typeof module.exports?module.exports=t(require("jquery")):t(jQuery)})(function($){function initMouseDetection(t){var e=".smartmenus_mouse";if(mouseDetectionEnabled||t)mouseDetectionEnabled&&t&&($(document).off(e),mouseDetectionEnabled=!1);else{var i=!0,s=null,o={mousemove:function(t){var e={x:t.pageX,y:t.pageY,timeStamp:(new Date).getTime()};if(s){var o=Math.abs(s.x-e.x),a=Math.abs(s.y-e.y);if((o>0||a>0)&&2>=o&&2>=a&&300>=e.timeStamp-s.timeStamp&&(mouse=!0,i)){var n=$(t.target).closest("a");n.is("a")&&$.each(menuTrees,function(){return $.contains(this.$root[0],n[0])?(this.itemEnter({currentTarget:n[0]}),!1):void 0}),i=!1}}s=e}};o[touchEvents?"touchstart":"pointerover pointermove pointerout MSPointerOver MSPointerMove MSPointerOut"]=function(t){isTouchEvent(t.originalEvent)&&(mouse=!1)},$(document).on(getEventsNS(o,e)),mouseDetectionEnabled=!0}}function isTouchEvent(t){return!/^(4|mouse)$/.test(t.pointerType)}function getEventsNS(t,e){e||(e="");var i={};for(var s in t)i[s.split(" ").join(e+" ")+e]=t[s];return i}var menuTrees=[],mouse=!1,touchEvents="ontouchstart"in window,mouseDetectionEnabled=!1,requestAnimationFrame=window.requestAnimationFrame||function(t){return setTimeout(t,1e3/60)},cancelAnimationFrame=window.cancelAnimationFrame||function(t){clearTimeout(t)},canAnimate=!!$.fn.animate;return $.SmartMenus=function(t,e){this.$root=$(t),this.opts=e,this.rootId="",this.accessIdPrefix="",this.$subArrow=null,this.activatedItems=[],this.visibleSubMenus=[],this.showTimeout=0,this.hideTimeout=0,this.scrollTimeout=0,this.clickActivated=!1,this.focusActivated=!1,this.zIndexInc=0,this.idInc=0,this.$firstLink=null,this.$firstSub=null,this.disabled=!1,this.$disableOverlay=null,this.$touchScrollingSub=null,this.cssTransforms3d="perspective"in t.style||"webkitPerspective"in t.style,this.wasCollapsible=!1,this.init()},$.extend($.SmartMenus,{hideAll:function(){$.each(menuTrees,function(){this.menuHideAll()})},destroy:function(){for(;menuTrees.length;)menuTrees[0].destroy();initMouseDetection(!0)},prototype:{init:function(t){var e=this;if(!t){menuTrees.push(this),this.rootId=((new Date).getTime()+Math.random()+"").replace(/\D/g,""),this.accessIdPrefix="sm-"+this.rootId+"-",this.$root.hasClass("sm-rtl")&&(this.opts.rightToLeftSubMenus=!0);var i=".smartmenus";this.$root.data("smartmenus",this).attr("data-smartmenus-id",this.rootId).dataSM("level",1).on(getEventsNS({"mouseover focusin":$.proxy(this.rootOver,this),"mouseout focusout":$.proxy(this.rootOut,this),keydown:$.proxy(this.rootKeyDown,this)},i)).on(getEventsNS({mouseenter:$.proxy(this.itemEnter,this),mouseleave:$.proxy(this.itemLeave,this),mousedown:$.proxy(this.itemDown,this),focus:$.proxy(this.itemFocus,this),blur:$.proxy(this.itemBlur,this),click:$.proxy(this.itemClick,this)},i),"a"),i+=this.rootId,this.opts.hideOnClick&&$(document).on(getEventsNS({touchstart:$.proxy(this.docTouchStart,this),touchmove:$.proxy(this.docTouchMove,this),touchend:$.proxy(this.docTouchEnd,this),click:$.proxy(this.docClick,this)},i)),$(window).on(getEventsNS({"resize orientationchange":$.proxy(this.winResize,this)},i)),this.opts.subIndicators&&(this.$subArrow=$("
').css({position:"absolute",top:e.top,left:e.left,width:this.$root.outerWidth(),height:this.$root.outerHeight(),zIndex:this.getStartZIndex(!0),opacity:0}).appendTo(document.body)}this.disabled=!0}},docClick:function(t){return this.$touchScrollingSub?(this.$touchScrollingSub=null,void 0):((this.visibleSubMenus.length&&!$.contains(this.$root[0],t.target)||$(t.target).closest("a").length)&&this.menuHideAll(),void 0)},docTouchEnd:function(){if(this.lastTouch){if(!(!this.visibleSubMenus.length||void 0!==this.lastTouch.x2&&this.lastTouch.x1!=this.lastTouch.x2||void 0!==this.lastTouch.y2&&this.lastTouch.y1!=this.lastTouch.y2||this.lastTouch.target&&$.contains(this.$root[0],this.lastTouch.target))){this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0);var t=this;this.hideTimeout=setTimeout(function(){t.menuHideAll()},350)}this.lastTouch=null}},docTouchMove:function(t){if(this.lastTouch){var e=t.originalEvent.touches[0];this.lastTouch.x2=e.pageX,this.lastTouch.y2=e.pageY}},docTouchStart:function(t){var e=t.originalEvent.touches[0];this.lastTouch={x1:e.pageX,y1:e.pageY,target:e.target}},enable:function(){this.disabled&&(this.$disableOverlay&&(this.$disableOverlay.remove(),this.$disableOverlay=null),this.disabled=!1)},getClosestMenu:function(t){for(var e=$(t).closest("ul");e.dataSM("in-mega");)e=e.parent().closest("ul");return e[0]||null},getHeight:function(t){return this.getOffset(t,!0)},getOffset:function(t,e){var i;"none"==t.css("display")&&(i={position:t[0].style.position,visibility:t[0].style.visibility},t.css({position:"absolute",visibility:"hidden"}).show());var s=t[0].getBoundingClientRect&&t[0].getBoundingClientRect(),o=s&&(e?s.height||s.bottom-s.top:s.width||s.right-s.left);return o||0===o||(o=e?t[0].offsetHeight:t[0].offsetWidth),i&&t.hide().css(i),o},getStartZIndex:function(t){var e=parseInt(this[t?"$root":"$firstSub"].css("z-index"));return!t&&isNaN(e)&&(e=parseInt(this.$root.css("z-index"))),isNaN(e)?1:e},getTouchPoint:function(t){return t.touches&&t.touches[0]||t.changedTouches&&t.changedTouches[0]||t},getViewport:function(t){var e=t?"Height":"Width",i=document.documentElement["client"+e],s=window["inner"+e];return s&&(i=Math.min(i,s)),i},getViewportHeight:function(){return this.getViewport(!0)},getViewportWidth:function(){return this.getViewport()},getWidth:function(t){return this.getOffset(t)},handleEvents:function(){return!this.disabled&&this.isCSSOn()},handleItemEvents:function(t){return this.handleEvents()&&!this.isLinkInMegaMenu(t)},isCollapsible:function(){return"static"==this.$firstSub.css("position")},isCSSOn:function(){return"inline"!=this.$firstLink.css("display")},isFixed:function(){var t="fixed"==this.$root.css("position");return t||this.$root.parentsUntil("body").each(function(){return"fixed"==$(this).css("position")?(t=!0,!1):void 0}),t},isLinkInMegaMenu:function(t){return $(this.getClosestMenu(t[0])).hasClass("mega-menu")},isTouchMode:function(){return!mouse||this.opts.noMouseOver||this.isCollapsible()},itemActivate:function(t,e){var i=t.closest("ul"),s=i.dataSM("level");if(s>1&&(!this.activatedItems[s-2]||this.activatedItems[s-2][0]!=i.dataSM("parent-a")[0])){var o=this;$(i.parentsUntil("[data-smartmenus-id]","ul").get().reverse()).add(i).each(function(){o.itemActivate($(this).dataSM("parent-a"))})}if((!this.isCollapsible()||e)&&this.menuHideSubMenus(this.activatedItems[s-1]&&this.activatedItems[s-1][0]==t[0]?s:s-1),this.activatedItems[s-1]=t,this.$root.triggerHandler("activate.smapi",t[0])!==!1){var a=t.dataSM("sub");a&&(this.isTouchMode()||!this.opts.showOnClick||this.clickActivated)&&this.menuShow(a)}},itemBlur:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&this.$root.triggerHandler("blur.smapi",e[0])},itemClick:function(t){var e=$(t.currentTarget);if(this.handleItemEvents(e)){if(this.$touchScrollingSub&&this.$touchScrollingSub[0]==e.closest("ul")[0])return this.$touchScrollingSub=null,t.stopPropagation(),!1;if(this.$root.triggerHandler("click.smapi",e[0])===!1)return!1;var i=$(t.target).is(".sub-arrow"),s=e.dataSM("sub"),o=s?2==s.dataSM("level"):!1,a=this.isCollapsible(),n=/toggle$/.test(this.opts.collapsibleBehavior),r=/link$/.test(this.opts.collapsibleBehavior),h=/^accordion/.test(this.opts.collapsibleBehavior);if(s&&!s.is(":visible")){if((!r||!a||i)&&(this.opts.showOnClick&&o&&(this.clickActivated=!0),this.itemActivate(e,h),s.is(":visible")))return this.focusActivated=!0,!1}else if(a&&(n||i))return this.itemActivate(e,h),this.menuHide(s),n&&(this.focusActivated=!1),!1;return this.opts.showOnClick&&o||e.hasClass("disabled")||this.$root.triggerHandler("select.smapi",e[0])===!1?!1:void 0}},itemDown:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&e.dataSM("mousedown",!0)},itemEnter:function(t){var e=$(t.currentTarget);if(this.handleItemEvents(e)){if(!this.isTouchMode()){this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0);var i=this;this.showTimeout=setTimeout(function(){i.itemActivate(e)},this.opts.showOnClick&&1==e.closest("ul").dataSM("level")?1:this.opts.showTimeout)}this.$root.triggerHandler("mouseenter.smapi",e[0])}},itemFocus:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&(!this.focusActivated||this.isTouchMode()&&e.dataSM("mousedown")||this.activatedItems.length&&this.activatedItems[this.activatedItems.length-1][0]==e[0]||this.itemActivate(e,!0),this.$root.triggerHandler("focus.smapi",e[0]))},itemLeave:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&(this.isTouchMode()||(e[0].blur(),this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0)),e.removeDataSM("mousedown"),this.$root.triggerHandler("mouseleave.smapi",e[0]))},menuHide:function(t){if(this.$root.triggerHandler("beforehide.smapi",t[0])!==!1&&(canAnimate&&t.stop(!0,!0),"none"!=t.css("display"))){var e=function(){t.css("z-index","")};this.isCollapsible()?canAnimate&&this.opts.collapsibleHideFunction?this.opts.collapsibleHideFunction.call(this,t,e):t.hide(this.opts.collapsibleHideDuration,e):canAnimate&&this.opts.hideFunction?this.opts.hideFunction.call(this,t,e):t.hide(this.opts.hideDuration,e),t.dataSM("scroll")&&(this.menuScrollStop(t),t.css({"touch-action":"","-ms-touch-action":"","-webkit-transform":"",transform:""}).off(".smartmenus_scroll").removeDataSM("scroll").dataSM("scroll-arrows").hide()),t.dataSM("parent-a").removeClass("highlighted").attr("aria-expanded","false"),t.attr({"aria-expanded":"false","aria-hidden":"true"});var i=t.dataSM("level");this.activatedItems.splice(i-1,1),this.visibleSubMenus.splice($.inArray(t,this.visibleSubMenus),1),this.$root.triggerHandler("hide.smapi",t[0])}},menuHideAll:function(){this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0);for(var t=this.opts.isPopup?1:0,e=this.visibleSubMenus.length-1;e>=t;e--)this.menuHide(this.visibleSubMenus[e]);this.opts.isPopup&&(canAnimate&&this.$root.stop(!0,!0),this.$root.is(":visible")&&(canAnimate&&this.opts.hideFunction?this.opts.hideFunction.call(this,this.$root):this.$root.hide(this.opts.hideDuration))),this.activatedItems=[],this.visibleSubMenus=[],this.clickActivated=!1,this.focusActivated=!1,this.zIndexInc=0,this.$root.triggerHandler("hideAll.smapi")},menuHideSubMenus:function(t){for(var e=this.activatedItems.length-1;e>=t;e--){var i=this.activatedItems[e].dataSM("sub");i&&this.menuHide(i)}},menuInit:function(t){if(!t.dataSM("in-mega")){t.hasClass("mega-menu")&&t.find("ul").dataSM("in-mega",!0);for(var e=2,i=t[0];(i=i.parentNode.parentNode)!=this.$root[0];)e++;var s=t.prevAll("a").eq(-1);s.length||(s=t.prevAll().find("a").eq(-1)),s.addClass("has-submenu").dataSM("sub",t),t.dataSM("parent-a",s).dataSM("level",e).parent().dataSM("sub",t);var o=s.attr("id")||this.accessIdPrefix+ ++this.idInc,a=t.attr("id")||this.accessIdPrefix+ ++this.idInc;s.attr({id:o,"aria-haspopup":"true","aria-controls":a,"aria-expanded":"false"}),t.attr({id:a,role:"group","aria-hidden":"true","aria-labelledby":o,"aria-expanded":"false"}),this.opts.subIndicators&&s[this.opts.subIndicatorsPos](this.$subArrow.clone())}},menuPosition:function(t){var e,i,s=t.dataSM("parent-a"),o=s.closest("li"),a=o.parent(),n=t.dataSM("level"),r=this.getWidth(t),h=this.getHeight(t),u=s.offset(),l=u.left,c=u.top,d=this.getWidth(s),m=this.getHeight(s),p=$(window),f=p.scrollLeft(),v=p.scrollTop(),b=this.getViewportWidth(),S=this.getViewportHeight(),g=a.parent().is("[data-sm-horizontal-sub]")||2==n&&!a.hasClass("sm-vertical"),M=this.opts.rightToLeftSubMenus&&!o.is("[data-sm-reverse]")||!this.opts.rightToLeftSubMenus&&o.is("[data-sm-reverse]"),w=2==n?this.opts.mainMenuSubOffsetX:this.opts.subMenusSubOffsetX,T=2==n?this.opts.mainMenuSubOffsetY:this.opts.subMenusSubOffsetY;if(g?(e=M?d-r-w:w,i=this.opts.bottomToTopSubMenus?-h-T:m+T):(e=M?w-r:d-w,i=this.opts.bottomToTopSubMenus?m-T-h:T),this.opts.keepInViewport){var y=l+e,I=c+i;if(M&&f>y?e=g?f-y+e:d-w:!M&&y+r>f+b&&(e=g?f+b-r-y+e:w-r),g||(S>h&&I+h>v+S?i+=v+S-h-I:(h>=S||v>I)&&(i+=v-I)),g&&(I+h>v+S+.49||v>I)||!g&&h>S+.49){var x=this;t.dataSM("scroll-arrows")||t.dataSM("scroll-arrows",$([$('0;t.dataSM("scroll-arrows").eq(i?0:1).is(":visible")&&(t.dataSM("scroll").up=i,this.menuScroll(t,!0))}e.preventDefault()},menuScrollOut:function(t,e){mouse&&(/^scroll-(up|down)/.test((e.relatedTarget||"").className)||(t[0]==e.relatedTarget||$.contains(t[0],e.relatedTarget))&&this.getClosestMenu(e.relatedTarget)==t[0]||t.dataSM("scroll-arrows").css("visibility","hidden"))},menuScrollOver:function(t,e){if(mouse&&!/^scroll-(up|down)/.test(e.target.className)&&this.getClosestMenu(e.target)==t[0]){this.menuScrollRefreshData(t);var i=t.dataSM("scroll"),s=$(window).scrollTop()-t.dataSM("parent-a").offset().top-i.itemH;t.dataSM("scroll-arrows").eq(0).css("margin-top",s).end().eq(1).css("margin-top",s+this.getViewportHeight()-i.arrowDownH).end().css("visibility","visible")}},menuScrollRefreshData:function(t){var e=t.dataSM("scroll"),i=$(window).scrollTop()-t.dataSM("parent-a").offset().top-e.itemH;this.cssTransforms3d&&(i=-(parseFloat(t.css("margin-top"))-i)),$.extend(e,{upEnd:i,downEnd:i+this.getViewportHeight()-e.subH})},menuScrollStop:function(t){return this.scrollTimeout?(cancelAnimationFrame(this.scrollTimeout),this.scrollTimeout=0,t.dataSM("scroll").step=1,!0):void 0},menuScrollTouch:function(t,e){if(e=e.originalEvent,isTouchEvent(e)){var i=this.getTouchPoint(e);if(this.getClosestMenu(i.target)==t[0]){var s=t.dataSM("scroll");if(/(start|down)$/i.test(e.type))this.menuScrollStop(t)?(e.preventDefault(),this.$touchScrollingSub=t):this.$touchScrollingSub=null,this.menuScrollRefreshData(t),$.extend(s,{touchStartY:i.pageY,touchStartTime:e.timeStamp});else if(/move$/i.test(e.type)){var o=void 0!==s.touchY?s.touchY:s.touchStartY;if(void 0!==o&&o!=i.pageY){this.$touchScrollingSub=t;var a=i.pageY>o;void 0!==s.up&&s.up!=a&&$.extend(s,{touchStartY:i.pageY,touchStartTime:e.timeStamp}),$.extend(s,{up:a,touchY:i.pageY}),this.menuScroll(t,!0,Math.abs(i.pageY-o))}e.preventDefault()}else void 0!==s.touchY&&((s.momentum=15*Math.pow(Math.abs(i.pageY-s.touchStartY)/(e.timeStamp-s.touchStartTime),2))&&(this.menuScrollStop(t),this.menuScroll(t),e.preventDefault()),delete s.touchY)}}},menuShow:function(t){if((t.dataSM("beforefirstshowfired")||(t.dataSM("beforefirstshowfired",!0),this.$root.triggerHandler("beforefirstshow.smapi",t[0])!==!1))&&this.$root.triggerHandler("beforeshow.smapi",t[0])!==!1&&(t.dataSM("shown-before",!0),canAnimate&&t.stop(!0,!0),!t.is(":visible"))){var e=t.dataSM("parent-a"),i=this.isCollapsible();if((this.opts.keepHighlighted||i)&&e.addClass("highlighted"),i)t.removeClass("sm-nowrap").css({zIndex:"",width:"auto",minWidth:"",maxWidth:"",top:"",left:"",marginLeft:"",marginTop:""});else{if(t.css("z-index",this.zIndexInc=(this.zIndexInc||this.getStartZIndex())+1),(this.opts.subMenusMinWidth||this.opts.subMenusMaxWidth)&&(t.css({width:"auto",minWidth:"",maxWidth:""}).addClass("sm-nowrap"),this.opts.subMenusMinWidth&&t.css("min-width",this.opts.subMenusMinWidth),this.opts.subMenusMaxWidth)){var s=this.getWidth(t);t.css("max-width",this.opts.subMenusMaxWidth),s>this.getWidth(t)&&t.removeClass("sm-nowrap").css("width",this.opts.subMenusMaxWidth)}this.menuPosition(t)}var o=function(){t.css("overflow","")};i?canAnimate&&this.opts.collapsibleShowFunction?this.opts.collapsibleShowFunction.call(this,t,o):t.show(this.opts.collapsibleShowDuration,o):canAnimate&&this.opts.showFunction?this.opts.showFunction.call(this,t,o):t.show(this.opts.showDuration,o),e.attr("aria-expanded","true"),t.attr({"aria-expanded":"true","aria-hidden":"false"}),this.visibleSubMenus.push(t),this.$root.triggerHandler("show.smapi",t[0])}},popupHide:function(t){this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0);var e=this;this.hideTimeout=setTimeout(function(){e.menuHideAll()},t?1:this.opts.hideTimeout)},popupShow:function(t,e){if(!this.opts.isPopup)return alert('SmartMenus jQuery Error:\n\nIf you want to show this menu via the "popupShow" method, set the isPopup:true option.'),void 0;if(this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0),this.$root.dataSM("shown-before",!0),canAnimate&&this.$root.stop(!0,!0),!this.$root.is(":visible")){this.$root.css({left:t,top:e});var i=this,s=function(){i.$root.css("overflow","")};canAnimate&&this.opts.showFunction?this.opts.showFunction.call(this,this.$root,s):this.$root.show(this.opts.showDuration,s),this.visibleSubMenus[0]=this.$root}},refresh:function(){this.destroy(!0),this.init(!0)},rootKeyDown:function(t){if(this.handleEvents())switch(t.keyCode){case 27:var e=this.activatedItems[0];if(e){this.menuHideAll(),e[0].focus();var i=e.dataSM("sub");i&&this.menuHide(i)}break;case 32:var s=$(t.target);if(s.is("a")&&this.handleItemEvents(s)){var i=s.dataSM("sub");i&&!i.is(":visible")&&(this.itemClick({currentTarget:t.target}),t.preventDefault())}}},rootOut:function(t){if(this.handleEvents()&&!this.isTouchMode()&&t.target!=this.$root[0]&&(this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0),!this.opts.showOnClick||!this.opts.hideOnClick)){var e=this;this.hideTimeout=setTimeout(function(){e.menuHideAll()},this.opts.hideTimeout)}},rootOver:function(t){this.handleEvents()&&!this.isTouchMode()&&t.target!=this.$root[0]&&this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0)},winResize:function(t){if(this.handleEvents()){if(!("onorientationchange"in window)||"orientationchange"==t.type){var e=this.isCollapsible();this.wasCollapsible&&e||(this.activatedItems.length&&this.activatedItems[this.activatedItems.length-1][0].blur(),this.menuHideAll()),this.wasCollapsible=e}}else if(this.$disableOverlay){var i=this.$root.offset();this.$disableOverlay.css({top:i.top,left:i.left,width:this.$root.outerWidth(),height:this.$root.outerHeight()})}}}}),$.fn.dataSM=function(t,e){return e?this.data(t+"_smartmenus",e):this.data(t+"_smartmenus")},$.fn.removeDataSM=function(t){return this.removeData(t+"_smartmenus")},$.fn.smartmenus=function(options){if("string"==typeof options){var args=arguments,method=options;return Array.prototype.shift.call(args),this.each(function(){var t=$(this).data("smartmenus");t&&t[method]&&t[method].apply(t,args)})}return this.each(function(){var dataOpts=$(this).data("sm-options")||null;if(dataOpts)try{dataOpts=eval("("+dataOpts+")")}catch(e){dataOpts=null,alert('ERROR\n\nSmartMenus jQuery init:\nInvalid "data-sm-options" attribute value syntax.')}new $.SmartMenus(this,$.extend({},$.fn.smartmenus.defaults,options,dataOpts))})},$.fn.smartmenus.defaults={isPopup:!1,mainMenuSubOffsetX:0,mainMenuSubOffsetY:0,subMenusSubOffsetX:0,subMenusSubOffsetY:0,subMenusMinWidth:"10em",subMenusMaxWidth:"20em",subIndicators:!0,subIndicatorsPos:"append",subIndicatorsText:"",scrollStep:30,scrollAccelerate:!0,showTimeout:250,hideTimeout:500,showDuration:0,showFunction:null,hideDuration:0,hideFunction:function(t,e){t.fadeOut(200,e)},collapsibleShowDuration:0,collapsibleShowFunction:function(t,e){t.slideDown(200,e)},collapsibleHideDuration:0,collapsibleHideFunction:function(t,e){t.slideUp(200,e)},showOnClick:!1,hideOnClick:!0,noMouseOver:!1,keepInViewport:!0,keepHighlighted:!0,markCurrentItem:!1,markCurrentTree:!0,rightToLeftSubMenus:!1,bottomToTopSubMenus:!1,collapsibleBehavior:"default"},$});
\ No newline at end of file
diff --git a/docs/doxygen/html/md_CONTRIBUTING.html b/docs/doxygen/html/md_CONTRIBUTING.html
new file mode 100644
index 0000000..317807c
--- /dev/null
+++ b/docs/doxygen/html/md_CONTRIBUTING.html
@@ -0,0 +1,94 @@
+
+
+
+python_raft: Contributing
+
+
+
+
+
+
+ python_raft
+
+ Rapid Application Framework for Testing
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
First-time users are requested to agree to the license .
+
+
The following flow is expected for all code submissons:
+Create a branch with a name following the guidelines: gh(x)_(synopsis)
+where x is the ticket number
+where synopsis is a short synopsis for the reason for the branch.
+
+
+Create a pull request https://github.com/rdkcentral/python_raft/compare when the code changes are ready for review.
+The team will review, and if accepted your changes will be merged to the mainline.
+
+
All changes must be submitted for review with a corresponding issue, python_raft/issues .
+
If an issue does not exist for the change you wish to contribute, please create one with a detailed description of the reason for your change.
+
+
python_raft: README
+
+
+
+
+
+
+ python_raft
+
+ Rapid Application Framework for Testing
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
**R**apid **A**pplication **F**ramework for **T**esting.
+
RAFT is a Python based testing framework for writing engineering tests.
+
+
+
+
+
+
+Python (=3.11.8)
+Pyenv can be used to manage multiple versions of Python (please refer to the documentation ).
+
+
+All the packages listed in requirements.txt
+Can be installed using $ pip install -r requirements.txt
+
+
+
+
+
Clone the repository and ensure that all requirements are met.
+
+
WIP
+
+
WIP
+
+
See contributing file: CONTRIBUTING.md
+
+
See license file: LICENSE
+
+
python_raft: Related Pages
+
+
+
+
+
+
+ python_raft
+
+ Rapid Application Framework for Testing
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all related documentation pages:
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
do a search
+ {
+ this.Search();
+ }
+ }
+
+ this.OnSearchSelectKey = function(evt)
+ {
+ var e = (evt) ? evt : window.event; // for IE
+ if (e.keyCode==40 && this.searchIndex0) // Up
+ {
+ this.searchIndex--;
+ this.OnSelectItem(this.searchIndex);
+ }
+ else if (e.keyCode==13 || e.keyCode==27)
+ {
+ this.OnSelectItem(this.searchIndex);
+ this.CloseSelectionWindow();
+ this.DOMSearchField().focus();
+ }
+ return false;
+ }
+
+ // --------- Actions
+
+ // Closes the results window.
+ this.CloseResultsWindow = function()
+ {
+ this.DOMPopupSearchResultsWindow().style.display = 'none';
+ this.DOMSearchClose().style.display = 'none';
+ this.Activate(false);
+ }
+
+ this.CloseSelectionWindow = function()
+ {
+ this.DOMSearchSelectWindow().style.display = 'none';
+ }
+
+ // Performs a search.
+ this.Search = function()
+ {
+ this.keyTimeout = 0;
+
+ // strip leading whitespace
+ var searchValue = this.DOMSearchField().value.replace(/^ +/, "");
+
+ var code = searchValue.toLowerCase().charCodeAt(0);
+ var idxChar = searchValue.substr(0, 1).toLowerCase();
+ if ( 0xD800 <= code && code <= 0xDBFF && searchValue > 1) // surrogate pair
+ {
+ idxChar = searchValue.substr(0, 2);
+ }
+
+ var resultsPage;
+ var resultsPageWithSearch;
+ var hasResultsPage;
+
+ var idx = indexSectionsWithContent[this.searchIndex].indexOf(idxChar);
+ if (idx!=-1)
+ {
+ var hexCode=idx.toString(16);
+ resultsPage = this.resultsPath + '/' + indexSectionNames[this.searchIndex] + '_' + hexCode + '.html';
+ resultsPageWithSearch = resultsPage+'?'+escape(searchValue);
+ hasResultsPage = true;
+ }
+ else // nothing available for this search term
+ {
+ resultsPage = this.resultsPath + '/nomatches.html';
+ resultsPageWithSearch = resultsPage;
+ hasResultsPage = false;
+ }
+
+ window.frames.MSearchResults.location = resultsPageWithSearch;
+ var domPopupSearchResultsWindow = this.DOMPopupSearchResultsWindow();
+
+ if (domPopupSearchResultsWindow.style.display!='block')
+ {
+ var domSearchBox = this.DOMSearchBox();
+ this.DOMSearchClose().style.display = 'inline';
+ if (this.insideFrame)
+ {
+ var domPopupSearchResults = this.DOMPopupSearchResults();
+ domPopupSearchResultsWindow.style.position = 'relative';
+ domPopupSearchResultsWindow.style.display = 'block';
+ var width = document.body.clientWidth - 8; // the -8 is for IE :-(
+ domPopupSearchResultsWindow.style.width = width + 'px';
+ domPopupSearchResults.style.width = width + 'px';
+ }
+ else
+ {
+ var domPopupSearchResults = this.DOMPopupSearchResults();
+ var left = getXPos(domSearchBox) + 150; // domSearchBox.offsetWidth;
+ var top = getYPos(domSearchBox) + 20; // domSearchBox.offsetHeight + 1;
+ domPopupSearchResultsWindow.style.display = 'block';
+ left -= domPopupSearchResults.offsetWidth;
+ domPopupSearchResultsWindow.style.top = top + 'px';
+ domPopupSearchResultsWindow.style.left = left + 'px';
+ }
+ }
+
+ this.lastSearchValue = searchValue;
+ this.lastResultsPage = resultsPage;
+ }
+
+ // -------- Activation Functions
+
+ // Activates or deactivates the search panel, resetting things to
+ // their default values if necessary.
+ this.Activate = function(isActive)
+ {
+ if (isActive || // open it
+ this.DOMPopupSearchResultsWindow().style.display == 'block'
+ )
+ {
+ this.DOMSearchBox().className = 'MSearchBoxActive';
+
+ var searchField = this.DOMSearchField();
+
+ if (searchField.value == this.searchLabel) // clear "Search" term upon entry
+ {
+ searchField.value = '';
+ this.searchActive = true;
+ }
+ }
+ else if (!isActive) // directly remove the panel
+ {
+ this.DOMSearchBox().className = 'MSearchBoxInactive';
+ this.DOMSearchField().value = this.searchLabel;
+ this.searchActive = false;
+ this.lastSearchValue = ''
+ this.lastResultsPage = '';
+ }
+ }
+}
+
+// -----------------------------------------------------------------------
+
+// The class that handles everything on the search results page.
+function SearchResults(name)
+{
+ // The number of matches from the last run of .
+ this.lastMatchCount = 0;
+ this.lastKey = 0;
+ this.repeatOn = false;
+
+ // Toggles the visibility of the passed element ID.
+ this.FindChildElement = function(id)
+ {
+ var parentElement = document.getElementById(id);
+ var element = parentElement.firstChild;
+
+ while (element && element!=parentElement)
+ {
+ if (element.nodeName == 'DIV' && element.className == 'SRChildren')
+ {
+ return element;
+ }
+
+ if (element.nodeName == 'DIV' && element.hasChildNodes())
+ {
+ element = element.firstChild;
+ }
+ else if (element.nextSibling)
+ {
+ element = element.nextSibling;
+ }
+ else
+ {
+ do
+ {
+ element = element.parentNode;
+ }
+ while (element && element!=parentElement && !element.nextSibling);
+
+ if (element && element!=parentElement)
+ {
+ element = element.nextSibling;
+ }
+ }
+ }
+ }
+
+ this.Toggle = function(id)
+ {
+ var element = this.FindChildElement(id);
+ if (element)
+ {
+ if (element.style.display == 'block')
+ {
+ element.style.display = 'none';
+ }
+ else
+ {
+ element.style.display = 'block';
+ }
+ }
+ }
+
+ // Searches for the passed string. If there is no parameter,
+ // it takes it from the URL query.
+ //
+ // Always returns true, since other documents may try to call it
+ // and that may or may not be possible.
+ this.Search = function(search)
+ {
+ if (!search) // get search word from URL
+ {
+ search = window.location.search;
+ search = search.substring(1); // Remove the leading '?'
+ search = unescape(search);
+ }
+
+ search = search.replace(/^ +/, ""); // strip leading spaces
+ search = search.replace(/ +$/, ""); // strip trailing spaces
+ search = search.toLowerCase();
+ search = convertToId(search);
+
+ var resultRows = document.getElementsByTagName("div");
+ var matches = 0;
+
+ var i = 0;
+ while (i < resultRows.length)
+ {
+ var row = resultRows.item(i);
+ if (row.className == "SRResult")
+ {
+ var rowMatchName = row.id.toLowerCase();
+ rowMatchName = rowMatchName.replace(/^sr\d*_/, ''); // strip 'sr123_'
+
+ if (search.length<=rowMatchName.length &&
+ rowMatchName.substr(0, search.length)==search)
+ {
+ row.style.display = 'block';
+ matches++;
+ }
+ else
+ {
+ row.style.display = 'none';
+ }
+ }
+ i++;
+ }
+ document.getElementById("Searching").style.display='none';
+ if (matches == 0) // no results
+ {
+ document.getElementById("NoMatches").style.display='block';
+ }
+ else // at least one result
+ {
+ document.getElementById("NoMatches").style.display='none';
+ }
+ this.lastMatchCount = matches;
+ return true;
+ }
+
+ // return the first item with index index or higher that is visible
+ this.NavNext = function(index)
+ {
+ var focusItem;
+ while (1)
+ {
+ var focusName = 'Item'+index;
+ focusItem = document.getElementById(focusName);
+ if (focusItem && focusItem.parentNode.parentNode.style.display=='block')
+ {
+ break;
+ }
+ else if (!focusItem) // last element
+ {
+ break;
+ }
+ focusItem=null;
+ index++;
+ }
+ return focusItem;
+ }
+
+ this.NavPrev = function(index)
+ {
+ var focusItem;
+ while (1)
+ {
+ var focusName = 'Item'+index;
+ focusItem = document.getElementById(focusName);
+ if (focusItem && focusItem.parentNode.parentNode.style.display=='block')
+ {
+ break;
+ }
+ else if (!focusItem) // last element
+ {
+ break;
+ }
+ focusItem=null;
+ index--;
+ }
+ return focusItem;
+ }
+
+ this.ProcessKeys = function(e)
+ {
+ if (e.type == "keydown")
+ {
+ this.repeatOn = false;
+ this.lastKey = e.keyCode;
+ }
+ else if (e.type == "keypress")
+ {
+ if (!this.repeatOn)
+ {
+ if (this.lastKey) this.repeatOn = true;
+ return false; // ignore first keypress after keydown
+ }
+ }
+ else if (e.type == "keyup")
+ {
+ this.lastKey = 0;
+ this.repeatOn = false;
+ }
+ return this.lastKey!=0;
+ }
+
+ this.Nav = function(evt,itemIndex)
+ {
+ var e = (evt) ? evt : window.event; // for IE
+ if (e.keyCode==13) return true;
+ if (!this.ProcessKeys(e)) return false;
+
+ if (this.lastKey==38) // Up
+ {
+ var newIndex = itemIndex-1;
+ var focusItem = this.NavPrev(newIndex);
+ if (focusItem)
+ {
+ var child = this.FindChildElement(focusItem.parentNode.parentNode.id);
+ if (child && child.style.display == 'block') // children visible
+ {
+ var n=0;
+ var tmpElem;
+ while (1) // search for last child
+ {
+ tmpElem = document.getElementById('Item'+newIndex+'_c'+n);
+ if (tmpElem)
+ {
+ focusItem = tmpElem;
+ }
+ else // found it!
+ {
+ break;
+ }
+ n++;
+ }
+ }
+ }
+ if (focusItem)
+ {
+ focusItem.focus();
+ }
+ else // return focus to search field
+ {
+ parent.document.getElementById("MSearchField").focus();
+ }
+ }
+ else if (this.lastKey==40) // Down
+ {
+ var newIndex = itemIndex+1;
+ var focusItem;
+ var item = document.getElementById('Item'+itemIndex);
+ var elem = this.FindChildElement(item.parentNode.parentNode.id);
+ if (elem && elem.style.display == 'block') // children visible
+ {
+ focusItem = document.getElementById('Item'+itemIndex+'_c0');
+ }
+ if (!focusItem) focusItem = this.NavNext(newIndex);
+ if (focusItem) focusItem.focus();
+ }
+ else if (this.lastKey==39) // Right
+ {
+ var item = document.getElementById('Item'+itemIndex);
+ var elem = this.FindChildElement(item.parentNode.parentNode.id);
+ if (elem) elem.style.display = 'block';
+ }
+ else if (this.lastKey==37) // Left
+ {
+ var item = document.getElementById('Item'+itemIndex);
+ var elem = this.FindChildElement(item.parentNode.parentNode.id);
+ if (elem) elem.style.display = 'none';
+ }
+ else if (this.lastKey==27) // Escape
+ {
+ parent.searchBox.CloseResultsWindow();
+ parent.document.getElementById("MSearchField").focus();
+ }
+ else if (this.lastKey==13) // Enter
+ {
+ return true;
+ }
+ return false;
+ }
+
+ this.NavChild = function(evt,itemIndex,childIndex)
+ {
+ var e = (evt) ? evt : window.event; // for IE
+ if (e.keyCode==13) return true;
+ if (!this.ProcessKeys(e)) return false;
+
+ if (this.lastKey==38) // Up
+ {
+ if (childIndex>0)
+ {
+ var newIndex = childIndex-1;
+ document.getElementById('Item'+itemIndex+'_c'+newIndex).focus();
+ }
+ else // already at first child, jump to parent
+ {
+ document.getElementById('Item'+itemIndex).focus();
+ }
+ }
+ else if (this.lastKey==40) // Down
+ {
+ var newIndex = childIndex+1;
+ var elem = document.getElementById('Item'+itemIndex+'_c'+newIndex);
+ if (!elem) // last child, jump to parent next parent
+ {
+ elem = this.NavNext(itemIndex+1);
+ }
+ if (elem)
+ {
+ elem.focus();
+ }
+ }
+ else if (this.lastKey==27) // Escape
+ {
+ parent.searchBox.CloseResultsWindow();
+ parent.document.getElementById("MSearchField").focus();
+ }
+ else if (this.lastKey==13) // Enter
+ {
+ return true;
+ }
+ return false;
+ }
+}
+
+function setKeyActions(elem,action)
+{
+ elem.setAttribute('onkeydown',action);
+ elem.setAttribute('onkeypress',action);
+ elem.setAttribute('onkeyup',action);
+}
+
+function setClassAttr(elem,attr)
+{
+ elem.setAttribute('class',attr);
+ elem.setAttribute('className',attr);
+}
+
+function createResults()
+{
+ var results = document.getElementById("SRResults");
+ for (var e=0; eli>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0px/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sm-dox{background-image:url("tab_b.png")}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0px 12px;padding-right:43px;font-family:"Lucida Grande","Geneva","Helvetica",Arial,sans-serif;font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:0px 1px 1px rgba(255,255,255,0.9);color:#283A5D;outline:none}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:#fff;text-shadow:0px 1px 1px #000}.sm-dox a.current{color:#D23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:rgba(255,255,255,0.5);border-radius:5px}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{border-radius:0}.sm-dox ul{background:rgba(162,162,162,0.1)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:white;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:#fff;text-shadow:0px 1px 1px #000}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media (min-width: 768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:url("tab_b.png");line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:#283A5D transparent transparent transparent;background:transparent;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0px 12px;background-image:url("tab_s.png");background-repeat:no-repeat;background-position:right;border-radius:0 !important}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:#fff;text-shadow:0px 1px 1px #000}.sm-dox a:hover span.sub-arrow{border-color:#fff transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent #fff transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:#fff;border-radius:5px !important;box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent #555;border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:#555;background-image:none;border:0 !important;color:#555;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:#fff;text-shadow:0px 1px 1px #000}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent #fff}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:#fff;height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #D23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#D23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent #555 transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:#555 transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:url("tab_b.png")}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:#fff}}
diff --git a/docs/doxygen/images/RAFT_Logo.png b/docs/doxygen/images/RAFT_Logo.png
new file mode 100644
index 0000000..088227a
Binary files /dev/null and b/docs/doxygen/images/RAFT_Logo.png differ
diff --git a/docs/doxygen/xml/CONTRIBUTING_8md.xml b/docs/doxygen/xml/CONTRIBUTING_8md.xml
new file mode 100644
index 0000000..610a01d
--- /dev/null
+++ b/docs/doxygen/xml/CONTRIBUTING_8md.xml
@@ -0,0 +1,32 @@
+
+
+
+ CONTRIBUTING.md
+
+
+
+
+
+# ## First-time ## The - - - **All *If
+
+
diff --git a/docs/doxygen/xml/README_8md.xml b/docs/doxygen/xml/README_8md.xml
new file mode 100644
index 0000000..87dcc8d
--- /dev/null
+++ b/docs/doxygen/xml/README_8md.xml
@@ -0,0 +1,57 @@
+
+
+
+ README.md
+
+
+
+
+
+ # **R**apid RAFT RAFT’s ## * * * * * --- ## ### - - ### Clone ## WIP ## WIP ## See ## See
+
+
diff --git a/docs/doxygen/xml/S20control_8py.xml b/docs/doxygen/xml/S20control_8py.xml
new file mode 100644
index 0000000..32e08d6
--- /dev/null
+++ b/docs/doxygen/xml/S20control_8py.xml
@@ -0,0 +1,455 @@
+
+
+
+ S20control.py
+ core::powerModules::S20control::UnknownPacket
+ core::powerModules::S20control::powerOrviboS20
+ core::powerModules::S20control::OrviboS20
+ core::powerModules::S20control
+
+
+
+
+
+import import import import import def usage(): "Usage:" , "\t%s "\t\t[ , "\t%s "\t%s "\t%s "\t%s "\t%s "\t%s "\t%s class [UnknownPacket](Exception):pass class powerOrviboS20: def __init__(self, if is not None : def powerOn(self): "powerSwitchNone().powerOn" ) return True def powerOff(self): "powerSwitchNone().powerOff" ) return True def reboot(self): "powerSwitchNone().reboot" ) if True : return class [OrviboS20]:""" def __enter__(self): return def __exit__(self, [close]()def __init__(self, [subscribed]None [exitontimeout]False [sock][sock].setsockopt(socket.SOL_SOCKET,[sock].bind(('' , def close(self): try : [sock].close()except as def _settimeout(self, [sock].settimeout(timeout)def _sendpacket(self, [sock].sendto(b'' .join([struct.pack( 'B' , for in def _listendiscover(self): 'exit' : True , 'timeout' : False , 'detail' : if [exitontimeout]:'exit' ] False try : [sock].recvfrom(1024)if 'hd' : return None 'address' ], 'port' ] 'detail' ][ 'length' ] '>H' , 'detail' ][ 'commandid' ] '>H' , if 'detail' ][ 'length' ] and 'detail' ][ 'commandid' ] 'command' ] 'Global 'exit' ] False elif 'detail' ][ 'length' ] and 'detail' ][ 'commandid' ] 'command' ] 'Discovery' 'exit' ] False 'detail' ][ 'dstmac' ] '6B' , 'detail' ][ 'srcmac' ] '6B' , elif 'detail' ][ 'length' ] and 'detail' ][ 'commandid' ] or 'detail' ][ 'commandid' ] 'command' ] 'Discovery '>B' , if "WARNING: 'detail' ][ 'dstmac' ] '6B' , 'detail' ][ 'srcmac' ] '6B' , '6B' , '6B' , 'detail' ][ 'soc' ] 'detail' ][ 'timer' ] 'I' , 'state' ] 'B' , elif 'detail' ][ 'length' ] and 'detail' ][ 'commandid' ] 'detail' ][ 'dstmac' ] '6B' , 'detail' ][ 'srcmac' ] '6B' , '>5B' , for in if "WARNING: .format(i, 'state' ] elif 'detail' ][ 'length' ] and 'detail' ][ 'commandid' ] 'detail' ][ 'dstmac' ] '6B' , 'detail' ][ 'srcmac' ] '6B' , 'detail' ][ 'peercount' ] '>4B' , for in if "WARNING: else : raise except 'timeout' ] True if [exitontimeout]:'exit' ] True except as if [DEBUG]:"Error: .format(exc), "Unknown , for in '{:d}B' .format(len(data)), "* if 'detail' in if 'dstmac' in 'detail' ]: 'dstmachex' ] ':' .join([ '%02x' for in 'detail' ][ 'dstmac' ]]) if 'srcmac' in 'detail' ]: 'srcmachex' ] ':' .join([ '%02x' for in 'detail' ][ 'srcmac' ]]) return def listen(self): [_settimeout](None ) [exitontimeout]False return [_listendiscover]()def discover(self, [_settimeout](2)[exitontimeout]True for in ':' )]) [_sendpacket](data,while True : [_listendiscover]()if 'exit' ]: break return def globaldiscover(self, [_settimeout](2)[exitontimeout]True [_sendpacket]([0x71,while True : [_listendiscover]()if 'exit' ]: break return def subscribe(self, [_settimeout](2)[exitontimeout]True for in ':' )]) for in ':' ))]) [_sendpacket](data,[_listendiscover]()if 'address' not in return None [subscribed]'address' ], '' .join([struct.pack( 'B' , for in 'detail' ][ 'dstmac' ]]), for in 'detail' ][ 'dstmac' ]] return def _subscribeifneeded(self, if is None and [subscribed]is not None : pass elif is not None and is not None : '' .join([struct.pack( 'B' , for in ':' )]) if [subscribed]is None or [subscribed][1][subscribe](ip,if [subscribed]is None or [subscribed][1]raise 'self.subscribe [subscribed])def poweron(self, [_subscribeifneeded](ip,[subscribed][2])[_sendpacket](data,[subscribed][0])[_listendiscover]()return def poweroff(self, [_subscribeifneeded](ip,[subscribed][2])[_sendpacket](data,[subscribed][0])[_listendiscover]()return def main(): if if 'connect' : if elif in 'discover' , '_subscribe' , 'getstate' , 'poweron' , 'poweroff' ]: if elif 'globaldiscover' : if elif 'listen' : if else : else : if 'connect' : 'HF-A11ASSISTHREAD' , ',' ) '+ok' , "AT+WSSSID=%s\r" if '+ok' : 'FATAL 'Enter "AT+WSKEY=WPA2PSK,AES,%s\r" if '+ok' : 'FATAL "AT+WMODE=STA\r" , if '+ok' : 'FATAL "AT+Z\r" , "connect elif 'listen' : "listen" ) with [OrviboS20]()as while True : if 'exit' ]: break elif 'discover' : with [OrviboS20]()as elif 'globaldiscover' : with [OrviboS20]()as elif '_subscribe' : with [OrviboS20]()as elif 'getstate' : with [OrviboS20]()as if not if 'state' ] else elif 'poweron' : with [OrviboS20]()as elif 'poweroff' : with [OrviboS20]()as if "__main__" :
+
+
diff --git a/docs/doxygen/xml/SLP_8py.xml b/docs/doxygen/xml/SLP_8py.xml
new file mode 100644
index 0000000..6821e36
--- /dev/null
+++ b/docs/doxygen/xml/SLP_8py.xml
@@ -0,0 +1,78 @@
+
+
+
+ SLP.py
+ core::powerModules::SLP::powerSLP
+ core::powerModules::SLP
+
+
+
+
+
+from import class [powerSLP]():def __init__(self, [log][ip][username][password][outlet][port]if [port][telnet][log],'{}:{}' .format(self.[ip],[port]), [username],[password])def command(self, True if [telnet].connect(username_prompt='Username: , 'Password: ) is False : raise 'Cannot ) [telnet].read_very_eager()if [telnet].write(cmd):if "Command not in [telnet].read_until("Command ): False else : False [telnet].disconnect()return def powerOff(self): [command]('OFF .format(self.[outlet])) if True : [log].error(" ) return def powerOn(self): [command]('ON .format(self.[outlet])) if True : [log].error(" ) return def reboot(self): [powerOff]()if is True : [powerOn]()return
+
+
diff --git a/docs/doxygen/xml/accessElementsTests_8py.xml b/docs/doxygen/xml/accessElementsTests_8py.xml
new file mode 100644
index 0000000..73f36ec
--- /dev/null
+++ b/docs/doxygen/xml/accessElementsTests_8py.xml
@@ -0,0 +1,81 @@
+
+
+
+ accessElementsTests.py
+ accessElementsTests::accessElementsTest
+ accessElementsTests
+
+
+
+
+
+import import dir_path sys.path.append(dir_path+ "/../../../" ) from import class [accessElementsTest](testController):def __init__(self, def testFunction(self): "./unitTests/framework/webControlTests/webPageTest.yml" ) "https://testpages.herokuapp.com/styled" , "test_locator" ) "Get ) "paragraph_a_XPATH" ) if "This : False , "Text ) else : True , "Text ) "Get ) "paragraph_a_ID" ) if "This : False , "Text ) else : True , "Text ) "Get ) "paragraph_a_NAME" ) if "This : False , "Text ) else : True , "Text ) "Get ) "paragraph_a_CLASS_NAME" ) if "This : False , "Text ) else : True , "Text ) "Get ) "paragraph_a_TAG_NAME" ) if "This : False , "Text ) else : True , "Text ) if "__main__" : [accessElementsTest]()
+
+
diff --git a/docs/doxygen/xml/alertTest_8py.xml b/docs/doxygen/xml/alertTest_8py.xml
new file mode 100644
index 0000000..fab58dd
--- /dev/null
+++ b/docs/doxygen/xml/alertTest_8py.xml
@@ -0,0 +1,103 @@
+
+
+
+ alertTest.py
+ alertTest::alertTest
+ alertTest
+
+
+
+
+
+import import dir_path sys.path.append(dir_path+ "/../../../" ) from import class [alertTest](testController):def __init__(self, def testFunction(self): "./unitTests/framework/webControlTests/webPageTest.yml" ) "https://testpages.herokuapp.com/styled" , "alerts_page" ) "Creating ) "create_alert" ) True , "Alert ) "Reading ) if "I : True , "Alert ) else : False , "Alert ) "Confirming ) "confirm_alert" ) True , "Alert ) "Creating ) "create_confirm_alert" ) True , "Alert ) "Reading ) if "I : True , "Alert ) else : False , "Alert ) "Confirming ) "confirm_alert" ) True , "Alert ) "Checking ) if "confirm_result" ) "true" : True , "Alert ) else : False , "Alert ) "Creating ) "create_confirm_alert" ) True , "Alert ) "Reading ) if "I : True , "Alert ) else : False , "Alert ) "Dismissing ) "dismiss_alert" ) True , "Alert ) "Checking ) if "confirm_result" ) "false" : True , "Alert ) else : False , "Alert ) if "__main__" : [alertTest]()
+
+
diff --git a/docs/doxygen/xml/apcAos_8py.xml b/docs/doxygen/xml/apcAos_8py.xml
new file mode 100644
index 0000000..ce3db76
--- /dev/null
+++ b/docs/doxygen/xml/apcAos_8py.xml
@@ -0,0 +1,88 @@
+
+
+
+ apcAos.py
+ core::powerModules::apcAos::powerApcAos
+ core::powerModules::apcAos
+
+
+
+
+
+import from import CMD_PROMPT "apc>" POWER_ON "olOn" POWER_OFF "olOff" REBOOT "olReboot" REBOOT_WAIT class [powerApcAos]():"""Power def __init__(self, [hostName][userName][password][port][outletNumber][log][telnet]None def open(self): [telnet][log],"" ,[hostName],[userName],[password],[port]) [telnet].connect("User , "Password ) [waitForPrompt]()def close(self): [telnet].disconnect()def waitForPrompt(self): [telnet].read_until(CMD_PROMPT)[log].info(data)def sendCommand(self, [open]()[telnet].write(cmd)[waitForPrompt]()[close]()def powerOn(self): [log].debug("powerApcAos().powerOn" ) [sendCommand](POWER_ON" [outletNumber]))return True def powerOff(self): [log].debug("powerApcAos().powerOff" ) [sendCommand](POWER_OFF" [outletNumber]))return True def reboot(self): [powerOff]()if True : [log].error(" ) [powerOn]()if True : [log].error(" ) return
+
+
diff --git a/docs/doxygen/xml/apc_8py.xml b/docs/doxygen/xml/apc_8py.xml
new file mode 100644
index 0000000..05a43b2
--- /dev/null
+++ b/docs/doxygen/xml/apc_8py.xml
@@ -0,0 +1,190 @@
+
+
+
+ apc.py
+ core::powerModules::apc::powerAPC
+ core::powerModules::apc
+
+
+
+
+
+import from import import CONNECT_MSG "Communication POWER_ON "1" POWER_OFF "2" REBOOT "3" REBOOT_WAIT class [powerAPC]():"""Power def __init__(self, [hostName][userName][password][outletNumber][log][telnet]None def pduPowerSetting(self, if not [open]():[log].error("Unable ) return False if not [configurePDU]():[log].error("Unable ) return False [selectPDUOutlet](self.[outletNumber])if [log].info("Powering ) [sendPowerON]()elif [log].info("Powering ) [sendPowerOFF]()elif [log].info("Rebooting ) [sendPowerOFF]()[sendPowerON]()else : [log].info("Invalid ) return False [close]()return True def checkConnection(self): [log].info("Checking [telnet].read_until(CONNECT_MSG)if return True else : [log].error(str(data))return False def open(self): [telnet][log],"" ,[hostName],[userName],[password]) [telnet].connect(username_prompt="User , "Password ) if [checkConnection]():[log].info("Successfully ) return True [log].error("Failed ) return False def close(self): [telnet].write(chr(27))[telnet].write(chr(27))[telnet].write(chr(27))[telnet].write(chr(27))[telnet].write(chr(27))[telnet].read_very_eager()[telnet].write("4" ) [telnet].read_some()[telnet].write("" ) [log].info("Disconnected ) def waitAPCNextline(self): [telnet].read_until('> ) [log].debug(data)[telnet].read_eager()def configurePDU(self): [log].info("configuring ) [telnet].read_until('Console' ) if not "Console" , [log].info('Failed ) [close]()return False [log].info("PDU ) [waitAPCNextline]()[log].info('Opening ) [telnet].write("1" ) [waitAPCNextline]()[log].info('Opening ) [telnet].write("2" ) [waitAPCNextline]()[log].info('Entering ) [telnet].write("1" ) [waitAPCNextline]()return True def selectPDUOutlet(self, [log].info("Selecting [telnet].write(outletNumber)[telnet].read_until(outletNumber)[waitAPCNextline]()def sendPowerON(self): [telnet].write(POWER_ON)[log].debug(self.[telnet].read_until("Immediate )) [log].info('Immediate ) [log].debug(self.[telnet].read_until('cancel' )) [telnet].write("YES" ) [log].info("Turned ) [telnet].read_some()[telnet].write("" ) def sendPowerOFF(self): [telnet].write(POWER_OFF)[log].debug(self.[telnet].read_until("Immediate )) [log].info("Immediate ) [log].debug(self.[telnet].read_until('cancel' )) [telnet].write("YES" ) [log].info("Turned ) [telnet].read_some()[telnet].write("" ) def powerOff(self): [pduPowerSetting](POWER_OFF)return def powerOn(self): [pduPowerSetting](POWER_ON)return def reboot(self): [powerOff]()if True : [log].error(" ) [powerOn]()if True : [log].error(" ) return
+
+
diff --git a/docs/doxygen/xml/arduino_8py.xml b/docs/doxygen/xml/arduino_8py.xml
new file mode 100644
index 0000000..93063fa
--- /dev/null
+++ b/docs/doxygen/xml/arduino_8py.xml
@@ -0,0 +1,63 @@
+
+
+
+ arduino.py
+ arduino::remoteArduino
+ arduino
+
+
+
+
+
+import import from import class [remoteArduino]():def [__init__]("""intialise [log][remoteConfig][arduino][remoteConfig].get("port" ),[remoteConfig].get( "baudrate" ), [firstKeyPressInTc]True def [sendKey](self,"""Send if [firstKeyPressInTc]:[firstKeyPressInTc]False for in [arduino].write(key.encode())return True
+
+
diff --git a/docs/doxygen/xml/capture_8py.xml b/docs/doxygen/xml/capture_8py.xml
new file mode 100644
index 0000000..07f1a11
--- /dev/null
+++ b/docs/doxygen/xml/capture_8py.xml
@@ -0,0 +1,223 @@
+
+
+
+ capture.py
+ core::capture::capture
+ core::capture
+
+
+
+
+
+import from import from import from import from import as from import class [capture](utils):def [__init__](self,"""Initialise [log][resolution][captureImagesPath][ocrEnginePath][captureInput][captureImagesCount][videoApi]None [regionDetails]None [screenRegions]None def [setRegions]("""Set [screenRegions]def [start](self):"""Initialise [log].info("capture.initaliseVideoCapture" ) try : [log].step("Initializing ) r"{}" .format(self.[ocrEnginePath]) [videoApi][captureInput]))except as [log].error(e)raise 'Failed ) if [resolution]'1080p' : [videoApi].set(cv2.CAP_PROP_FRAME_WIDTH,[videoApi].set(cv2.CAP_PROP_FRAME_HEIGHT,elif [resolution]'720p' : [videoApi].set(cv2.CAP_PROP_FRAME_WIDTH,[videoApi].set(cv2.CAP_PROP_FRAME_HEIGHT,else : [log].error('UNSUPPORTED ) [log].info("Frame [videoApi].get(cv2.CAP_PROP_FRAME_WIDTH))+" [videoApi].get(cv2.CAP_PROP_FRAME_HEIGHT)))return True def [stop](self):"""Stop [videoApi].release()[log].info("Successfully ) return True def [startImageCapture](self):"""Capture [log].info("capture.startImageCapture" ) [videoApi].read()[captureImagesPath],"image{}.png" .format(self.[captureImagesCount])) [captureImagesCount]return def [getRegionCoords](self,"""Get [log].info("capture.getRegionCoords .format(regionName)) for in [screenRegions].items():if for in if 'co_ords' : else : return def [applyOcrImageFilter](self,"""Applied [log].info('capture.applyOcrImageFilter .format(filterName)) if 'edge_enhance' : elif 'gaussian_blur' : elif 'smooth' : elif 'edge_enhance_more' : elif 'None' : return else : [log].info('Invalid .format(filterName)) return def [__getOCRText__](self,"""Get [log].info("capture.getOCRText" ) [startImageCapture]()[regionDetails][getRegionCoords](regionName)[regionDetails]['co_ords' ]) if [regionDetails]['filters' ] 'None' : [applyOcrImageFilter](croppedImage,[regionDetails]['filters' ]) [log].info(ocrText)return def [checkOcrText](self,"""Check [log].info("capture.checkOcrText" ) [__getOCRText__](regionName)if "" : if [regionDetails]['ocr_text' ]: [regionDetails]['ocr_text' ] if "" : [log].error('Please .format(regionName)) raise 'ExpectedText ) return def [waitForDisplayedScreen](self,"""Wait [log].info("capture.waitForDisplayedScreen .format(regionName)) False [log].info("Waiting .format(waitUntil)) while [checkOcrText](regionName)if break 'Screen if 'Screen .format(currentTime) [log].info(resultLog)return
+
+
diff --git a/docs/doxygen/xml/classaccessElementsTests_1_1accessElementsTest.xml b/docs/doxygen/xml/classaccessElementsTests_1_1accessElementsTest.xml
new file mode 100644
index 0000000..a23d0c4
--- /dev/null
+++ b/docs/doxygen/xml/classaccessElementsTests_1_1accessElementsTest.xml
@@ -0,0 +1,84 @@
+
+
+
+ accessElementsTests::accessElementsTest
+ testController
+
+
+ def
+ def accessElementsTests.accessElementsTest.__init__
+ (self, testName="accessElementsTest", log=None)
+ __init__
+ self
+ self
+
+ testName
+ testName
+ "accessElementsTest"
+
+ log
+ log
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def accessElementsTests.accessElementsTest.testFunction
+ (self)
+ testFunction
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ accessElementsTests.accessElementsTest
+
+
+
+
+ testController
+
+
+
+
+ accessElementsTests.accessElementsTest
+
+
+
+
+ testController
+
+
+
+ accessElementsTests::accessElementsTest __init__ accessElementsTests::accessElementsTest testFunction
+
+
diff --git a/docs/doxygen/xml/classalertTest_1_1alertTest.xml b/docs/doxygen/xml/classalertTest_1_1alertTest.xml
new file mode 100644
index 0000000..21c9b3e
--- /dev/null
+++ b/docs/doxygen/xml/classalertTest_1_1alertTest.xml
@@ -0,0 +1,84 @@
+
+
+
+ alertTest::alertTest
+ testController
+
+
+ def
+ def alertTest.alertTest.__init__
+ (self, testName="alertTest", log=None)
+ __init__
+ self
+ self
+
+ testName
+ testName
+ "alertTest"
+
+ log
+ log
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def alertTest.alertTest.testFunction
+ (self)
+ testFunction
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testController
+
+
+ alertTest.alertTest
+
+
+
+
+
+
+ testController
+
+
+ alertTest.alertTest
+
+
+
+
+
+ alertTest::alertTest __init__ alertTest::alertTest testFunction
+
+
diff --git a/docs/doxygen/xml/classarduino_1_1remoteArduino.xml b/docs/doxygen/xml/classarduino_1_1remoteArduino.xml
new file mode 100644
index 0000000..fdff9c1
--- /dev/null
+++ b/docs/doxygen/xml/classarduino_1_1remoteArduino.xml
@@ -0,0 +1,144 @@
+
+
+
+ arduino::remoteArduino
+
+
+ arduino.remoteArduino::log
+ log
+
+
+
+
+
+
+
+
+ arduino.remoteArduino::remoteConfig
+ remoteConfig
+
+
+
+
+
+
+
+
+ arduino.remoteArduino::arduino
+ arduino
+
+
+
+
+
+
+
+
+ arduino.remoteArduino::firstKeyPressInTc
+ firstKeyPressInTc
+
+
+
+
+
+
+
+
+
+
+ def
+ def arduino.remoteArduino.__init__
+ (self, logModule log, dict() remoteConfig)
+ __init__
+ self
+ self
+
+ logModule
+ log
+
+ dict()
+ remoteConfig
+
+
+
+
+intialise the arduino module
+
+Args:
+ log (logModule): log class
+ remoteConfig (dict): remote configuration
+
+
+
+
+
+ def
+ def arduino.remoteArduino.sendKey
+ (self, key, repeat=1, delay=1)
+ sendKey
+ self
+ self
+
+ key
+ key
+
+ repeat
+ repeat
+ 1
+
+ delay
+ delay
+ 1
+
+
+
+
+Send IR key using arduino module
+
+Args:
+ key (str) - Key to be sent to device#
+ repeat (int) - Number of times the key has to be pressed. Defaults to 1
+ delay (int) - wait time after pressing the key
+
+
+
+
+
+
+
+
+
+
+ arduino::remoteArduino __init__ arduino::remoteArduino arduino arduino::remoteArduino firstKeyPressInTc arduino::remoteArduino log arduino::remoteArduino remoteConfig arduino::remoteArduino sendKey
+
+
diff --git a/docs/doxygen/xml/classcore_1_1capture_1_1capture.xml b/docs/doxygen/xml/classcore_1_1capture_1_1capture.xml
new file mode 100644
index 0000000..c9754e5
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1capture_1_1capture.xml
@@ -0,0 +1,479 @@
+
+
+
+ core::capture::capture
+ utils
+
+
+ core.capture.capture::log
+ log
+
+
+
+
+
+
+
+
+ core.capture.capture::resolution
+ resolution
+
+
+
+
+
+
+
+
+ core.capture.capture::captureImagesPath
+ captureImagesPath
+
+
+
+
+
+
+
+
+ core.capture.capture::ocrEnginePath
+ ocrEnginePath
+
+
+
+
+
+
+
+
+ core.capture.capture::captureInput
+ captureInput
+
+
+
+
+
+
+
+
+ core.capture.capture::captureImagesCount
+ captureImagesCount
+
+
+
+
+
+
+
+
+ core.capture.capture::videoApi
+ videoApi
+
+
+
+
+
+
+
+
+ core.capture.capture::regionDetails
+ regionDetails
+
+
+
+
+
+
+
+
+ core.capture.capture::screenRegions
+ screenRegions
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.capture.capture.__init__
+ (self, logModule log, str captureImagesPath, str ocrEnginePath, str resolution, str input, **dict kwargs)
+ __init__
+ self
+ self
+
+ logModule
+ log
+
+ str
+ captureImagesPath
+
+ str
+ ocrEnginePath
+
+ str
+ resolution
+
+ str
+ input
+
+ **dict
+ kwargs
+
+
+
+
+Initialise the OCR capture engine
+
+Args:
+ log (logModule): logging module
+ captureImagesPath (str): output capture images path
+ ocrEnginePath (str): ocr binary path
+ resolution (str): input resolution
+ input (str): input number for capture
+
+
+
+
+
+ def
+ def core.capture.capture.setRegions
+ (self, dict regionsConfig)
+ setRegions
+ self
+ self
+
+ dict
+ regionsConfig
+
+
+
+
+Set the capture regions dictionary to operate with
+
+Args:
+ regionsConfig (dict): capture regions dictionary
+
+
+
+
+
+ def
+ def core.capture.capture.start
+ (self)
+ start
+ self
+ self
+
+
+
+
+Initialise capturing video output from capture card
+
+
+
+
+
+ def
+ def core.capture.capture.stop
+ (self)
+ stop
+ self
+ self
+
+
+
+
+Stop videocapture and release the resources
+
+
+
+
+
+ def
+ def core.capture.capture.startImageCapture
+ (self)
+ startImageCapture
+ self
+ self
+
+
+
+
+Capture current video frame from video input and return a PIL Image
+
+
+
+
+
+ def
+ def core.capture.capture.getRegionCoords
+ (self, regionName)
+ getRegionCoords
+ self
+ self
+
+ regionName
+ regionName
+
+
+
+
+Get region co ordinates and ocr filters for the given region name
+
+Args:
+ regionName (str) - Name of the region
+
+Returns:
+ regionsDict (dict) - Dictionary of region co-ordinates and filters
+ Ex: regionsDict = {co_ords: (730, 410, 1155, 650), filters: "None"}
+
+
+
+
+
+ def
+ def core.capture.capture.applyOcrImageFilter
+ (self, inputImage, filterName)
+ applyOcrImageFilter
+ self
+ self
+
+ inputImage
+ inputImage
+
+ filterName
+ filterName
+
+
+
+
+Applied ocr filters on the input image
+
+Args:
+ inputImage (PIL Image)
+ filterName (str) - Filter to be applied on the image
+
+Returns:
+ outputImage (PIL Image)
+
+
+
+
+
+ def
+ def core.capture.capture.__getOCRText__
+ (self, regionName)
+ __getOCRText__
+ self
+ self
+
+ regionName
+ regionName
+
+
+
+
+Get text from device screen video output
+
+Args:
+ regionName (str) - refer screen_regions.yml
+
+Returns:
+ ocrText (str) - Text extracted from the screen region
+
+
+
+
+
+ def
+ def core.capture.capture.checkOcrText
+ (self, regionName, expectedText="")
+ checkOcrText
+ self
+ self
+
+ regionName
+ regionName
+
+ expectedText
+ expectedText
+ ""
+
+
+
+
+Check expected text against the OCRed text from screen for given region and return the result
+
+Args:
+ expectedText (str) - Expected text on the screen
+ regionName (str) - stb screen region (refer screen_regions.yml)
+
+Returns:
+ result (boolean)
+
+
+
+
+
+ def
+ def core.capture.capture.waitForDisplayedScreen
+ (self, regionName, waitBetweenChecks=1, maxWaitTime=10)
+ waitForDisplayedScreen
+ self
+ self
+
+ regionName
+ regionName
+
+ waitBetweenChecks
+ waitBetweenChecks
+ 1
+
+ maxWaitTime
+ maxWaitTime
+ 10
+
+
+
+
+Wait until a screen is displayed on the device
+
+Args:
+ regionName (str) - Region where text is expected on the screen
+ expectedText (str) - Expected text on the screen. If empty, uses ocr_text of regionName from xx.xx.screen_regions.yml
+ waitBetweenChecks (int) - Wait in secs after every check
+ maxWaitTime (int) - Maximum wait time to check for the expected screen
+
+Returns:
+ result (bool)
+
+
+
+
+
+
+
+
+
+
+
+ utils
+
+
+ core.capture.capture
+
+
+
+
+
+
+ utils
+
+
+ core.capture.capture
+
+
+
+
+
+ core::capture::capture __getOCRText__ core::capture::capture __init__ core::capture::capture applyOcrImageFilter core::capture::capture captureImagesCount core::capture::capture captureImagesPath core::capture::capture captureInput core::capture::capture checkOcrText core::capture::capture getRegionCoords core::capture::capture log core::capture::capture ocrEnginePath core::capture::capture regionDetails core::capture::capture resolution core::capture::capture screenRegions core::capture::capture setRegions core::capture::capture start core::capture::capture startImageCapture core::capture::capture stop core::capture::capture videoApi core::capture::capture waitForDisplayedScreen
+
+
diff --git a/docs/doxygen/xml/classcore_1_1commandModules_1_1consoleInterface_1_1consoleInterface.xml b/docs/doxygen/xml/classcore_1_1commandModules_1_1consoleInterface_1_1consoleInterface.xml
new file mode 100644
index 0000000..413d0ce
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1commandModules_1_1consoleInterface_1_1consoleInterface.xml
@@ -0,0 +1,190 @@
+
+
+
+ core::commandModules::consoleInterface::consoleInterface
+ metaclass
+ ABCMeta
+ core.commandModules.sshConsole.sshConsole
+ core.commandModules.telnetClass.telnet
+
+
+ def
+ def core.commandModules.consoleInterface.consoleInterface.write
+ (self, message)
+ write
+ write
+ write
+ self
+ self
+
+ message
+ message
+
+
+
+
+Abstract method. Define how to write to the console.
+
+Args:
+ message (str): Message to write into the console.
+
+
+
+
+
+ def
+ def core.commandModules.consoleInterface.consoleInterface.open
+ (self)
+ open
+ open
+ open
+ self
+ self
+
+
+
+
+Abstract method. Define how to open the console session.
+
+
+
+
+
+ def
+ def core.commandModules.consoleInterface.consoleInterface.read_all
+ (self)
+ read_all
+ read_all
+ read_all
+ self
+ self
+
+
+
+
+Abstract method. Define how to read all information displayed in the console.
+ Should return the data read.
+
+
+
+
+
+ def
+ def core.commandModules.consoleInterface.consoleInterface.read_until
+ (self, value)
+ read_until
+ read_until
+ read_until
+ self
+ self
+
+ value
+ value
+
+
+
+
+Abstract method. Define how to read all the information displayed in the console,
+ upto the point a defined string appears.
+ Should return the data read.
+
+Args:
+ value (str): Message to wait for in the console.
+
+
+
+
+
+ def
+ def core.commandModules.consoleInterface.consoleInterface.close
+ (self)
+ close
+ close
+ close
+ self
+ self
+
+
+
+
+Close the console session.
+
+
+
+
+
+
+
+
+
+
+
+ core.commandModules.telnetClass.telnet
+
+
+
+
+ core.commandModules.consoleInterface.consoleInterface
+
+
+
+
+
+
+ ABCMeta
+
+
+ core.commandModules.sshConsole.sshConsole
+
+
+
+
+ metaclass
+
+
+
+
+ core.commandModules.consoleInterface.consoleInterface
+
+
+
+
+
+
+ ABCMeta
+
+
+ metaclass
+
+
+
+ core::commandModules::consoleInterface::consoleInterface close core::commandModules::consoleInterface::consoleInterface open core::commandModules::consoleInterface::consoleInterface read_all core::commandModules::consoleInterface::consoleInterface read_until core::commandModules::consoleInterface::consoleInterface write
+
+
diff --git a/docs/doxygen/xml/classcore_1_1commandModules_1_1serialClass_1_1serialSession.xml b/docs/doxygen/xml/classcore_1_1commandModules_1_1serialClass_1_1serialSession.xml
new file mode 100644
index 0000000..afd55b9
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1commandModules_1_1serialClass_1_1serialSession.xml
@@ -0,0 +1,366 @@
+
+
+
+ core::commandModules::serialClass::serialSession
+ consoleInterface
+
+
+ core.commandModules.serialClass.serialSession::log
+ log
+
+
+
+
+
+
+
+
+ core.commandModules.serialClass.serialSession::workspacePath
+ workspacePath
+
+
+
+
+
+
+
+
+ core.commandModules.serialClass.serialSession::serialPort
+ serialPort
+
+
+
+
+
+
+
+
+ core.commandModules.serialClass.serialSession::serialFile
+ serialFile
+
+
+
+
+
+
+
+
+ core.commandModules.serialClass.serialSession::timeout
+ timeout
+
+
+
+
+
+
+
+
+ core.commandModules.serialClass.serialSession::baudRate
+ baudRate
+
+
+
+
+
+
+
+
+ core.commandModules.serialClass.serialSession::type
+ type
+
+
+
+
+
+
+
+
+ core.commandModules.serialClass.serialSession::serialCon
+ serialCon
+
+
+
+
+
+
+
+
+ core.commandModules.serialClass.serialSession::serialFileHandler
+ serialFileHandler
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.commandModules.serialClass.serialSession.__init__
+ (self, log, workspacePath, serialPort, baudRate=115200)
+ __init__
+ self
+ self
+
+ log
+ log
+
+ workspacePath
+ workspacePath
+
+ serialPort
+ serialPort
+
+ baudRate
+ baudRate
+ 115200
+
+
+
+
+
+
+
+
+
+ def
+ def core.commandModules.serialClass.serialSession.open
+ (self)
+ open
+ self
+ self
+
+
+
+
+Starts serial session and serial file logger.
+
+
+
+
+
+ def
+ def core.commandModules.serialClass.serialSession.close
+ (self)
+ close
+ self
+ self
+
+
+
+
+Closes the serial session and serial file logger.
+
+
+
+
+
+ def
+ def core.commandModules.serialClass.serialSession.write
+ (self, message)
+ write
+ self
+ self
+
+ message
+ message
+
+
+
+
+Write to serial console.
+
+Args:
+ message (Str) - message to write to serial console.
+
+
+
+
+
+ def
+ def core.commandModules.serialClass.serialSession.writeLines
+ (self, message)
+ writeLines
+ self
+ self
+
+ message
+ message
+
+
+
+
+Write to serial console.
+
+Args:
+ message (Str) - message to write to serial console.
+
+
+
+
+
+ def
+ def core.commandModules.serialClass.serialSession.read_until
+ (self, value)
+ read_until
+ self
+ self
+
+ value
+ value
+
+
+
+
+Read serial output until a specified value is found.
+
+
+
+
+
+ def
+ def core.commandModules.serialClass.serialSession.read_all
+ (self)
+ read_all
+ self
+ self
+
+
+
+
+Read all lines from serial output available in the buffer.
+
+
+
+
+
+ def
+ def core.commandModules.serialClass.serialSession.flush
+ (self)
+ flush
+ self
+ self
+
+
+
+
+Clear the console.
+
+
+
+
+
+
+
+
+Handle device serial connection operation
+
+Args:
+ log (logModule): Log module to be used.
+ workspacePath (str): Path of the tests worksapce to create the sesson.log file.
+ serialPort (str): Serial port to use.
+ baudRate (int, option): Baud rate to use. Default's to 115200.
+
+
+ core.commandModules.serialClass.serialSession
+
+
+
+
+ consoleInterface
+
+
+
+
+ core.commandModules.serialClass.serialSession
+
+
+
+
+ consoleInterface
+
+
+
+ core::commandModules::serialClass::serialSession __init__ core::commandModules::serialClass::serialSession baudRate core::commandModules::serialClass::serialSession close core::commandModules::serialClass::serialSession flush core::commandModules::serialClass::serialSession log core::commandModules::serialClass::serialSession open core::commandModules::serialClass::serialSession read_all core::commandModules::serialClass::serialSession read_until core::commandModules::serialClass::serialSession serialCon core::commandModules::serialClass::serialSession serialFile core::commandModules::serialClass::serialSession serialFileHandler core::commandModules::serialClass::serialSession serialPort core::commandModules::serialClass::serialSession timeout core::commandModules::serialClass::serialSession type core::commandModules::serialClass::serialSession workspacePath core::commandModules::serialClass::serialSession write core::commandModules::serialClass::serialSession writeLines
+
+
diff --git a/docs/doxygen/xml/classcore_1_1commandModules_1_1sshConsole_1_1sshConsole.xml b/docs/doxygen/xml/classcore_1_1commandModules_1_1sshConsole_1_1sshConsole.xml
new file mode 100644
index 0000000..f53e0fb
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1commandModules_1_1sshConsole_1_1sshConsole.xml
@@ -0,0 +1,362 @@
+
+
+
+ core::commandModules::sshConsole::sshConsole
+ core.commandModules.consoleInterface.consoleInterface
+
+
+ core.commandModules.sshConsole.sshConsole::address
+ address
+
+
+
+
+
+
+
+
+ core.commandModules.sshConsole.sshConsole::username
+ username
+
+
+
+
+
+
+
+
+ core.commandModules.sshConsole.sshConsole::password
+ password
+
+
+
+
+
+
+
+
+ core.commandModules.sshConsole.sshConsole::key
+ key
+
+
+
+
+
+
+
+
+ core.commandModules.sshConsole.sshConsole::console
+ console
+
+
+
+
+
+
+
+
+ core.commandModules.sshConsole.sshConsole::buffer
+ buffer
+
+
+
+
+
+
+
+
+ core.commandModules.sshConsole.sshConsole::stdout
+ stdout
+
+
+
+
+
+
+
+
+ core.commandModules.sshConsole.sshConsole::type
+ type
+
+
+
+
+
+
+
+
+ core.commandModules.sshConsole.sshConsole::stderr
+ stderr
+
+
+
+
+
+
+
+
+
+
+ None
+ None core.commandModules.sshConsole.sshConsole.__init__
+ (self, address, username, password, key=None, known_hosts=None)
+ __init__
+ self
+ self
+
+ address
+ address
+
+ username
+ username
+
+ password
+ password
+
+ key
+ key
+ None
+
+ known_hosts
+ known_hosts
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def core.commandModules.sshConsole.sshConsole.open
+ (self)
+ open
+ open
+ self
+ self
+
+
+
+
+Open the SSH session.
+
+
+
+
+
+ def
+ def core.commandModules.sshConsole.sshConsole.write
+ (self, message)
+ write
+ write
+ self
+ self
+
+ message
+ message
+
+
+
+
+Write a message into the console.
+
+Args:
+ message (str): String to write into the console.
+
+
+
+
+
+ def
+ def core.commandModules.sshConsole.sshConsole.read_all
+ (self)
+ read_all
+ read_all
+ self
+ self
+
+
+
+
+Capture all lines that are displayed in the console.
+
+Returns:
+ List: List of strings, with each being a line displayed in the console.
+
+
+
+
+
+ def
+ def core.commandModules.sshConsole.sshConsole.read_until
+ (self, value)
+ read_until
+ read_until
+ self
+ self
+
+ value
+ value
+
+
+
+
+Read the console until a message appears.
+
+Args:
+ value (str): The message to wait for in the console.
+
+Returns:
+ List: List of string, with each being a line displayed in the console up to the value entered.
+
+
+
+
+
+ def
+ def core.commandModules.sshConsole.sshConsole.close
+ (self)
+ close
+ close
+ self
+ self
+
+
+
+
+Close the SSH session
+
+
+
+
+
+
+
+
+sshConsole is a consoleInterface class to interface with SSH console sessions
+
+Args:
+ address (str): IP address of the host to connect to.
+ username (str): Username for logging into the host.
+ password (str): Password for logging into the host.
+ key (str, optional): Filepath of ssh key to use.
+ known_hosts (str, optional): Filepath of known_hosts file to use.
+
+
+
+ core.commandModules.consoleInterface.consoleInterface
+
+
+
+
+
+
+ ABCMeta
+
+
+ core.commandModules.sshConsole.sshConsole
+
+
+
+
+ metaclass
+
+
+
+
+ core.commandModules.consoleInterface.consoleInterface
+
+
+
+
+
+
+ ABCMeta
+
+
+ core.commandModules.sshConsole.sshConsole
+
+
+
+
+ metaclass
+
+
+
+ core::commandModules::sshConsole::sshConsole __init__ core::commandModules::sshConsole::sshConsole address core::commandModules::sshConsole::sshConsole buffer core::commandModules::sshConsole::sshConsole close core::commandModules::sshConsole::sshConsole console core::commandModules::sshConsole::sshConsole key core::commandModules::sshConsole::sshConsole open core::commandModules::sshConsole::sshConsole password core::commandModules::sshConsole::sshConsole read_all core::commandModules::sshConsole::sshConsole read_until core::commandModules::sshConsole::sshConsole stderr core::commandModules::sshConsole::sshConsole stdout core::commandModules::sshConsole::sshConsole type core::commandModules::sshConsole::sshConsole username core::commandModules::sshConsole::sshConsole write
+
+
diff --git a/docs/doxygen/xml/classcore_1_1commandModules_1_1telnetClass_1_1telnet.xml b/docs/doxygen/xml/classcore_1_1commandModules_1_1telnetClass_1_1telnet.xml
new file mode 100644
index 0000000..388d187
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1commandModules_1_1telnetClass_1_1telnet.xml
@@ -0,0 +1,512 @@
+
+
+
+ core::commandModules::telnetClass::telnet
+ core.commandModules.consoleInterface.consoleInterface
+
+
+ core.commandModules.telnetClass.telnet::tn
+ tn
+
+
+
+
+
+
+
+
+ core.commandModules.telnetClass.telnet::username
+ username
+
+
+
+
+
+
+
+
+ core.commandModules.telnetClass.telnet::password
+ password
+
+
+
+
+
+
+
+
+ core.commandModules.telnetClass.telnet::type
+ type
+
+
+
+
+
+
+
+
+ core.commandModules.telnetClass.telnet::host
+ host
+
+
+
+
+
+
+
+
+ core.commandModules.telnetClass.telnet::port
+ port
+
+
+
+
+
+
+
+
+ core.commandModules.telnetClass.telnet::timeout
+ timeout
+
+
+
+
+
+
+
+
+ core.commandModules.telnetClass.telnet::log
+ log
+
+
+
+
+
+
+
+
+ core.commandModules.telnetClass.telnet::sessionLogFile
+ sessionLogFile
+
+
+
+
+
+
+
+
+ core.commandModules.telnetClass.telnet::sessionLogHand
+ sessionLogHand
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.commandModules.telnetClass.telnet.__init__
+ (self, log, workspacePath, host, username, password, port=23)
+ __init__
+ self
+ self
+
+ log
+ log
+
+ workspacePath
+ workspacePath
+
+ host
+ host
+
+ username
+ username
+
+ password
+ password
+
+ port
+ port
+ 23
+
+
+
+
+
+
+
+
+
+ def
+ def core.commandModules.telnetClass.telnet.open
+ (self)
+ open
+ open
+ self
+ self
+
+
+
+
+Open the telnet session.
+
+
+
+
+
+ def
+ def core.commandModules.telnetClass.telnet.close
+ (self)
+ close
+ close
+ self
+ self
+
+
+
+
+Close the telnet session
+
+
+
+
+
+ def
+ def core.commandModules.telnetClass.telnet.connect
+ (self, username_prompt="login: ", password_prompt="Password: ")
+ connect
+ self
+ self
+
+ username_prompt
+ username_prompt
+ "login: "
+
+ password_prompt
+ password_prompt
+ "Password: "
+
+
+
+
+Open the telnet session
+
+Args:
+ username_prompt (str, optional): Expected prompt shown for entering the username.
+ password_prompt (str, optional): Expected prompt shown for entering the password.
+
+Returns:
+ bool: True if session opened successfully.
+
+
+
+
+
+ def
+ def core.commandModules.telnetClass.telnet.disconnect
+ (self)
+ disconnect
+ self
+ self
+
+
+
+
+Close the telnet session
+
+Returns:
+ bool: True
+
+
+
+
+
+ def
+ def core.commandModules.telnetClass.telnet.write
+ (self, message)
+ write
+ write
+ self
+ self
+
+ message
+ message
+
+
+
+
+Write a message into the session console.
+
+Args:
+ message (str): Message to write into the console.
+
+Returns:
+ bool: True when the message is successfully written to the console.
+
+
+
+
+
+ def
+ def core.commandModules.telnetClass.telnet.read_until
+ (self, value)
+ read_until
+ read_until
+ self
+ self
+
+ value
+ value
+
+
+
+
+Read the console until a message appears.
+
+Args:
+ value (str): The message to wait for in the console.
+
+Returns:
+ str: Information displayed in the console up to the value entered.
+
+
+
+
+
+ def
+ def core.commandModules.telnetClass.telnet.read_eager
+ (self)
+ read_eager
+ self
+ self
+
+
+
+
+Read all readily available information displayed in the console.
+
+Returns:
+ str: Information currently displayed in the console.
+
+
+
+
+
+ def
+ def core.commandModules.telnetClass.telnet.read_very_eager
+ (self)
+ read_very_eager
+ self
+ self
+
+
+
+
+Read all readily available information displayed in the console, without blocking I/O.
+
+Returns:
+ str: Information currently displayed in the console.
+
+
+
+
+
+ def
+ def core.commandModules.telnetClass.telnet.read_some
+ (self)
+ read_some
+ self
+ self
+
+
+
+
+Read information displayed in the console until EOF hit.
+
+Returns:
+ str: Information currently displayed in the console.
+
+
+
+
+
+ def
+ def core.commandModules.telnetClass.telnet.read_all
+ (self)
+ read_all
+ read_all
+ self
+ self
+
+
+
+
+Read all readily available information displayed in the console.
+
+Returns:
+ str: Information currently displayed in the console.
+
+
+
+
+
+
+
+
+telnet is a consoleInterface class to interface with telnet console sessions.
+
+Args:
+ log (logModule): Log module to be used.
+ workspacePath (str): Path of the tests worksapce to create the sesson.log file.
+ host (str): IP address of the host to open a session with.
+ username (str): Username to login to the session with.
+ password (str): Password to login to the session with.
+ port (int, optional): Listening telnet port on host. Defaults to 23.
+
+
+
+ core.commandModules.telnetClass.telnet
+
+
+
+
+ core.commandModules.consoleInterface.consoleInterface
+
+
+
+
+
+
+ ABCMeta
+
+
+ metaclass
+
+
+
+
+ core.commandModules.telnetClass.telnet
+
+
+
+
+ core.commandModules.consoleInterface.consoleInterface
+
+
+
+
+
+
+ ABCMeta
+
+
+ metaclass
+
+
+
+ core::commandModules::telnetClass::telnet __init__ core::commandModules::telnetClass::telnet close core::commandModules::telnetClass::telnet connect core::commandModules::telnetClass::telnet disconnect core::commandModules::telnetClass::telnet host core::commandModules::telnetClass::telnet log core::commandModules::telnetClass::telnet open core::commandModules::telnetClass::telnet password core::commandModules::telnetClass::telnet port core::commandModules::telnetClass::telnet read_all core::commandModules::telnetClass::telnet read_eager core::commandModules::telnetClass::telnet read_some core::commandModules::telnetClass::telnet read_until core::commandModules::telnetClass::telnet read_very_eager core::commandModules::telnetClass::telnet sessionLogFile core::commandModules::telnetClass::telnet sessionLogHand core::commandModules::telnetClass::telnet timeout core::commandModules::telnetClass::telnet tn core::commandModules::telnetClass::telnet type core::commandModules::telnetClass::telnet username core::commandModules::telnetClass::telnet write
+
+
diff --git a/docs/doxygen/xml/classcore_1_1commonRemote_1_1commonRemoteClass.xml b/docs/doxygen/xml/classcore_1_1commonRemote_1_1commonRemoteClass.xml
new file mode 100644
index 0000000..1d0c261
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1commonRemote_1_1commonRemoteClass.xml
@@ -0,0 +1,237 @@
+
+
+
+ core::commonRemote::commonRemoteClass
+
+
+ core.commonRemote.commonRemoteClass::log
+ log
+
+
+
+
+
+
+
+
+ core.commonRemote.commonRemoteClass::remoteConfig
+ remoteConfig
+
+
+
+
+
+
+
+
+ core.commonRemote.commonRemoteClass::remoteMap
+ remoteMap
+
+
+
+
+
+
+
+
+ core.commonRemote.commonRemoteClass::type
+ type
+
+
+
+
+
+
+
+
+ core.commonRemote.commonRemoteClass::remoteController
+ remoteController
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.commonRemote.commonRemoteClass.__init__
+ (self, logModule log, dict remoteConfig, **dict kwargs)
+ __init__
+ self
+ self
+
+ logModule
+ log
+
+ dict
+ remoteConfig
+
+ **dict
+ kwargs
+
+
+
+
+Intialise a commonRemote
+
+Args:
+ log (logModule): log module.
+ remoteConfig (dict): configuration file
+
+
+
+
+
+ def
+ def core.commonRemote.commonRemoteClass.sendKey
+ (self, dict keycode, int delay=1, int repeat=1, int randomRepeat=0)
+ sendKey
+ self
+ self
+
+ dict
+ keycode
+
+ int
+ delay
+ 1
+
+ int
+ repeat
+ 1
+
+ int
+ randomRepeat
+ 0
+
+
+
+
+send a key to the remoteCommander
+
+Args:
+ keycode (dict): key value pair
+ delay (int, optional): delay in seconds between repeats. Defaults to 1.
+ repeat (int, optional): how many key repeats. Defaults to 1.
+ randomRepeat (int, optional): random Key repeat value. Defaults to 0.
+
+
+
+
+
+ def
+ def core.commonRemote.commonRemoteClass.setKeyMap
+ (self, dict name)
+ setKeyMap
+ self
+ self
+
+ dict
+ name
+
+
+
+
+set the Key Translation Map
+
+Args:
+ name (dict): translation dictionary
+
+
+
+
+
+ def
+ def core.commonRemote.commonRemoteClass.getKeyMap
+ (self)
+ getKeyMap
+ self
+ self
+
+
+
+
+get the Key Translation Map
+
+
+
+
+
+
+
+ def
+ def core.commonRemote.commonRemoteClass.__decodeRemoteMapConfig
+ (self)
+ __decodeRemoteMapConfig
+ self
+ self
+
+
+
+
+decode the remote map configuration file
+
+
+
+
+
+
+
+
+
+
+ core::commonRemote::commonRemoteClass __decodeRemoteMapConfig core::commonRemote::commonRemoteClass __init__ core::commonRemote::commonRemoteClass getKeyMap core::commonRemote::commonRemoteClass log core::commonRemote::commonRemoteClass remoteConfig core::commonRemote::commonRemoteClass remoteController core::commonRemote::commonRemoteClass remoteMap core::commonRemote::commonRemoteClass sendKey core::commonRemote::commonRemoteClass setKeyMap core::commonRemote::commonRemoteClass type
+
+
diff --git a/docs/doxygen/xml/classcore_1_1commonRemote_1_1remoteControllerMapping.xml b/docs/doxygen/xml/classcore_1_1commonRemote_1_1remoteControllerMapping.xml
new file mode 100644
index 0000000..d15d7a6
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1commonRemote_1_1remoteControllerMapping.xml
@@ -0,0 +1,174 @@
+
+
+
+ core::commonRemote::remoteControllerMapping
+
+
+ core.commonRemote.remoteControllerMapping::log
+ log
+
+
+
+
+
+
+
+
+ core.commonRemote.remoteControllerMapping::currentMap
+ currentMap
+
+
+
+
+
+
+
+
+ core.commonRemote.remoteControllerMapping::maps
+ maps
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.commonRemote.remoteControllerMapping.__init__
+ (self, logModule log, dict mappingConfig)
+ __init__
+ self
+ self
+
+ logModule
+ log
+
+ dict
+ mappingConfig
+
+
+
+
+Initialise the remote controller key mapping class
+
+Args:
+ log (logModule): log class
+ mappingConfig (dict): mapping dictionary
+
+
+
+
+
+ def
+ def core.commonRemote.remoteControllerMapping.getMappedKey
+ (self, str key)
+ getMappedKey
+ self
+ self
+
+ str
+ key
+
+
+
+
+get the mapped key
+
+Args:
+ key (str): key to translate
+
+Returns:
+ str: key translated key via map or none on failure
+
+
+
+
+
+ def
+ def core.commonRemote.remoteControllerMapping.getKeyMap
+ (self)
+ getKeyMap
+ self
+ self
+
+
+
+
+get key Map
+
+Returns:
+ dict: active key map
+
+
+
+
+
+ def
+ def core.commonRemote.remoteControllerMapping.setKeyMap
+ (self, dict newMapName)
+ setKeyMap
+ self
+ self
+
+ dict
+ newMapName
+
+
+
+
+set the key map
+
+Args:
+ newMapName (dict): key map dictionary
+
+Returns:
+ bool: True on success, or False if failure
+
+
+
+
+
+
+
+
+
+
+ core::commonRemote::remoteControllerMapping __init__ core::commonRemote::remoteControllerMapping currentMap core::commonRemote::remoteControllerMapping getKeyMap core::commonRemote::remoteControllerMapping getMappedKey core::commonRemote::remoteControllerMapping log core::commonRemote::remoteControllerMapping maps core::commonRemote::remoteControllerMapping setKeyMap
+
+
diff --git a/docs/doxygen/xml/classcore_1_1configParserBase_1_1configParserBase.xml b/docs/doxygen/xml/classcore_1_1configParserBase_1_1configParserBase.xml
new file mode 100644
index 0000000..484eec2
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1configParserBase_1_1configParserBase.xml
@@ -0,0 +1,167 @@
+
+
+
+ core::configParserBase::configParserBase
+
+
+ core.configParserBase.configParserBase::log
+ log
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.configParserBase.configParserBase.__init__
+ (self, config, log=None)
+ __init__
+ self
+ self
+
+ config
+ config
+
+ log
+ log
+ None
+
+
+
+
+Class: configParser
+Args:
+ config (dict): [dict of the decoded class]
+ log ([class], optional): [parent log class if required]. Defaults to None.
+
+
+
+
+
+ def
+ def core.configParserBase.configParserBase.decodeTable
+ (self, parent, config)
+ decodeTable
+ self
+ self
+
+ parent
+ parent
+
+ config
+ config
+
+
+
+
+decode parent table
+
+Args:
+ parent ([dict]): parent]
+ config ([dict]): config to decode]
+
+
+
+
+
+ def
+ def core.configParserBase.configParserBase.decodeParam
+ (self, parent, name, value)
+ decodeParam
+ self
+ self
+
+ parent
+ parent
+
+ name
+ name
+
+ value
+ value
+
+
+
+
+Decode a single param
+
+Args:
+ parent ([dict]): [parent string to fill out]
+ name ([string]): [name]
+ value ([string]): [value]
+
+
+
+
+
+ def
+ def core.configParserBase.configParserBase.__getFieldValue__
+ (self, fieldDict, fieldName)
+ __getFieldValue__
+ self
+ self
+
+ fieldDict
+ fieldDict
+
+ fieldName
+ fieldName
+
+
+
+
+Get the value from the group field, also confirm
+
+Args:
+ fieldDict ([object]): [field dictionary]
+ fieldName ([string]): [field name]
+
+Returns:
+ [string]: [field value if present, otherwise None]
+
+
+
+
+
+
+
+
+
+
+ core::configParserBase::configParserBase __getFieldValue__ core::configParserBase::configParserBase __init__ core::configParserBase::configParserBase decodeParam core::configParserBase::configParserBase decodeTable core::configParserBase::configParserBase log
+
+
diff --git a/docs/doxygen/xml/classcore_1_1configParser_1_1configParser.xml b/docs/doxygen/xml/classcore_1_1configParser_1_1configParser.xml
new file mode 100644
index 0000000..a6a77b2
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1configParser_1_1configParser.xml
@@ -0,0 +1,481 @@
+
+
+
+ core::configParser::configParser
+ configParserBase
+
+
+ core.configParser.configParser::log
+ log
+
+
+
+
+
+
+
+
+ core.configParser.configParser::local
+ local
+
+
+
+
+
+
+
+
+ core.configParser.configParser::cpe
+ cpe
+
+
+
+
+
+
+
+
+ core.configParser.configParser::memoryMap
+ memoryMap
+
+
+
+
+
+
+
+
+ core.configParser.configParser::validImages
+ validImages
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.configParser.configParser.__init__
+ (self, config=None, log=None)
+ __init__
+ self
+ self
+
+ config
+ config
+ None
+
+ log
+ log
+ None
+
+
+
+
+Class: configParser
+Args:
+ config (dict): [dict of the decoded class]
+ log ([class], optional): [parent log class if required]. Defaults to None.
+
+
+
+
+
+ def
+ def core.configParser.configParser.decodeConfig
+ (self, config)
+ decodeConfig
+ self
+ self
+
+ config
+ config
+
+
+
+
+decode the test config section top level
+ local: - Local config
+ cpe: - cpe device configuration
+ memoryMap: - memoryMap configuration
+
+Args:
+ config ([dict]): [config dictionary]
+
+
+
+
+
+ def
+ def core.configParser.configParser.__decodeMemoryMapConfig__
+ (self, parent, config)
+ __decodeMemoryMapConfig__
+ self
+ self
+
+ parent
+ parent
+
+ config
+ config
+
+
+
+
+decode the memory map config
+
+Args:
+ config ([dict]): [config for the memory map sections]
+
+
+
+
+
+ def
+ def core.configParser.configParser.updateCPEConfig
+ (self, config)
+ updateCPEConfig
+ self
+ self
+
+ config
+ config
+
+
+
+
+update the CPE config
+
+Args:
+ config ([dict]): [config for the cpe section]
+
+
+
+
+
+ def
+ def core.configParser.configParser.createCpeConfig
+ (self, imageLocationDict, platform)
+ createCpeConfig
+ self
+ self
+
+ imageLocationDict
+ imageLocationDict
+
+ platform
+ platform
+
+
+
+
+Creates template of deviceConfig cpe entry
+
+Args:
+ imageLocationDict (dict)
+ Ex: {PCI1: "http://testwebsite.com/image.bin"}
+
+ platform (str) - platorm of the device (Ex: ada.sr300)
+
+Returns:
+ cpeConfig (dict)
+ Ex:{
+ {platform: "test_platform",
+ validImage:
+ {PCI1: "http://testwebsite.com/image.bin"}
+ }
+}
+
+
+
+
+
+ def
+ def core.configParser.configParser.__decodeCPEConfig__
+ (self, parent, config)
+ __decodeCPEConfig__
+ self
+ self
+
+ parent
+ parent
+
+ config
+ config
+
+
+
+
+decode the CPE config
+
+Args:
+ config ([dict]): [config for the cpe section]
+
+
+
+
+
+ def
+ def core.configParser.configParser.getCPEEntryViaPlatform
+ (self, platform)
+ getCPEEntryViaPlatform
+ self
+ self
+
+ platform
+ platform
+
+
+
+
+[find the cpe entry via the platform ]
+
+Args:
+ platform ([string]): [platform name e.g. "xione.de"]
+
+Returns:
+ [dict]: [cpe dict entry, or None if not found]
+
+
+
+
+
+ def
+ def core.configParser.configParser.getCPEFieldViaPlatform
+ (self, platform, field)
+ getCPEFieldViaPlatform
+ self
+ self
+
+ platform
+ platform
+
+ field
+ field
+
+
+
+
+[find the cpe entry via the platform ]
+
+Args:
+ platform ([string]): [platform name e.g. "xione.de"]
+
+Returns:
+ [dict]: [cpe dict entry, or None if not found]
+
+
+
+
+
+ def
+ def core.configParser.configParser.getMemoryMapViaPlatform
+ (self, platform)
+ getMemoryMapViaPlatform
+ self
+ self
+
+ platform
+ platform
+
+
+
+
+[find the Memory Map entry via the platform ]
+
+Args:
+ platform ([string]): [platform name e.g. "xione.de"]
+
+Returns:
+ [dict]: [memory map dict entry, or None if not found]
+
+
+
+
+
+ def
+ def core.configParser.configParser.getMemoryMapValueViaPlatform
+ (self, platform, name)
+ getMemoryMapValueViaPlatform
+ self
+ self
+
+ platform
+ platform
+
+ name
+ name
+
+
+
+
+[find the Memory Map item via the platform ]
+
+Args:
+ platform ([string]): [platform name e.g. "xione.de"]
+ name ([string]): [name of the section like "BL1Offset"]
+
+Returns:
+ [dict]: [memory map dict entry, or None if not found]
+
+
+
+
+
+ def
+ def core.configParser.configParser.getWorkspaceDirectory
+ (self)
+ getWorkspaceDirectory
+ self
+ self
+
+
+
+
+[get the workspace directory]
+
+Returns:
+ [string]: [workspace directory]
+
+
+
+
+
+ def
+ def core.configParser.configParser.getAlternativePlatform
+ (self, platform)
+ getAlternativePlatform
+ self
+ self
+
+ platform
+ platform
+
+
+
+
+Get the alternative platform from device config
+
+
+
+
+
+
+
+
+
+
+
+ configParserBase
+
+
+ core.configParser.configParser
+
+
+
+
+
+
+ configParserBase
+
+
+ core.configParser.configParser
+
+
+
+
+
+ core::configParser::configParser __decodeCPEConfig__ core::configParser::configParser __decodeMemoryMapConfig__ core::configParser::configParser __init__ core::configParser::configParser cpe core::configParser::configParser createCpeConfig core::configParser::configParser decodeConfig core::configParser::configParser getAlternativePlatform core::configParser::configParser getCPEEntryViaPlatform core::configParser::configParser getCPEFieldViaPlatform core::configParser::configParser getMemoryMapValueViaPlatform core::configParser::configParser getMemoryMapViaPlatform core::configParser::configParser getWorkspaceDirectory core::configParser::configParser local core::configParser::configParser log core::configParser::configParser memoryMap core::configParser::configParser updateCPEConfig core::configParser::configParser validImages
+
+
diff --git a/docs/doxygen/xml/classcore_1_1decodeParams_1_1decodeParams.xml b/docs/doxygen/xml/classcore_1_1decodeParams_1_1decodeParams.xml
new file mode 100644
index 0000000..3e9f103
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1decodeParams_1_1decodeParams.xml
@@ -0,0 +1,235 @@
+
+
+
+ core::decodeParams::decodeParams
+
+
+ core.decodeParams.decodeParams::jobId
+ jobId
+
+
+
+
+
+
+
+
+ core.decodeParams.decodeParams::rackJobExecutionId
+ rackJobExecutionId
+
+
+
+
+
+
+
+
+ core.decodeParams.decodeParams::testMode
+ testMode
+
+
+
+
+
+
+
+
+ core.decodeParams.decodeParams::debug
+ debug
+
+
+
+
+
+
+
+
+ core.decodeParams.decodeParams::loop
+ loop
+
+
+
+
+
+
+
+
+ core.decodeParams.decodeParams::log
+ log
+
+
+
+
+
+
+
+
+ core.decodeParams.decodeParams::buildConfig
+ buildConfig
+
+
+
+
+
+
+
+
+ core.decodeParams.decodeParams::overrideCpeConfig
+ overrideCpeConfig
+
+
+
+
+
+
+
+
+ core.decodeParams.decodeParams::args
+ args
+
+
+
+
+
+
+
+
+ core.decodeParams.decodeParams::rackConfig
+ rackConfig
+
+
+
+
+
+
+
+
+ core.decodeParams.decodeParams::deviceConfig
+ deviceConfig
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.decodeParams.decodeParams.__init__
+ (self, log)
+ __init__
+ self
+ self
+
+ log
+ log
+
+
+
+
+
+
+
+
+
+ def
+ def core.decodeParams.decodeParams.decodeDeviceConfig
+ (self)
+ decodeDeviceConfig
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.decodeParams.decodeParams.decodeConfigIntoDictionary
+ (self, configFile)
+ decodeConfigIntoDictionary
+ self
+ self
+
+ configFile
+ configFile
+
+
+
+
+
+
+
+
+
+
+
+
+Decodes the input arguments and sets the slot details
+
+
+ core::decodeParams::decodeParams __init__ core::decodeParams::decodeParams args core::decodeParams::decodeParams buildConfig core::decodeParams::decodeParams debug core::decodeParams::decodeParams decodeConfigIntoDictionary core::decodeParams::decodeParams decodeDeviceConfig core::decodeParams::decodeParams deviceConfig core::decodeParams::decodeParams jobId core::decodeParams::decodeParams log core::decodeParams::decodeParams loop core::decodeParams::decodeParams overrideCpeConfig core::decodeParams::decodeParams rackConfig core::decodeParams::decodeParams rackJobExecutionId core::decodeParams::decodeParams testMode
+
+
diff --git a/docs/doxygen/xml/classcore_1_1deviceManager_1_1consoleClass.xml b/docs/doxygen/xml/classcore_1_1deviceManager_1_1consoleClass.xml
new file mode 100644
index 0000000..ce18a75
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1deviceManager_1_1consoleClass.xml
@@ -0,0 +1,90 @@
+
+
+
+ core::deviceManager::consoleClass
+
+
+ core.deviceManager.consoleClass::session
+ session
+ = None
+
+
+
+
+
+
+
+
+
+
+ core.deviceManager.consoleClass::type
+ type
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.deviceManager.consoleClass.__init__
+ (self, logModule log, str logPath, dict configElements)
+ __init__
+ self
+ self
+
+ logModule
+ log
+
+ str
+ logPath
+
+ dict
+ configElements
+
+
+
+
+createConsole instance based on the params
+
+if a console is already active for the same device, it will be returned
+
+Args:
+ log (logModule): console name
+ logPath (str): path to write workspace files
+ configElements (dict): dictionary for configuration
+
+Returns:
+ class: console class
+
+
+
+
+
+
+
+
+
+
+ core::deviceManager::consoleClass __init__ core::deviceManager::consoleClass session core::deviceManager::consoleClass type
+
+
diff --git a/docs/doxygen/xml/classcore_1_1deviceManager_1_1deviceClass.xml b/docs/doxygen/xml/classcore_1_1deviceManager_1_1deviceClass.xml
new file mode 100644
index 0000000..8de7dd7
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1deviceManager_1_1deviceClass.xml
@@ -0,0 +1,213 @@
+
+
+
+ core::deviceManager::deviceClass
+
+
+ core.deviceManager.deviceClass::consoles
+ consoles
+
+
+
+
+
+
+
+
+ core.deviceManager.deviceClass::powerControl
+ powerControl
+
+
+
+
+
+
+
+
+ core.deviceManager.deviceClass::outBoundClient
+ outBoundClient
+
+
+
+
+
+
+
+
+ core.deviceManager.deviceClass::remoteController
+ remoteController
+
+
+
+
+
+
+
+
+ core.deviceManager.deviceClass::rawConfig
+ rawConfig
+
+
+
+
+
+
+
+
+ core.deviceManager.deviceClass::deviceName
+ deviceName
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.deviceManager.deviceClass.__init__
+ (self, logModule log, str logPath, dict devices)
+ __init__
+ self
+ self
+
+ logModule
+ log
+
+ str
+ logPath
+
+ dict
+ devices
+
+
+
+
+Intialise a single decode from the config
+
+Args:
+ log (logModule): log Module class
+ logPath (str): path to write workspace files
+ devices (dict): devices to initialise
+
+
+
+
+
+ def
+ def core.deviceManager.deviceClass.getField
+ (self, str fieldName, dict itemsList=None)
+ getField
+ self
+ self
+
+ str
+ fieldName
+
+ dict
+ itemsList
+ None
+
+
+
+
+get a named field from the device
+
+Args:
+ fieldName (str): name of the field to return
+ itemsList (dict): get field from the items list, or None to start at the top
+
+Returns:
+ str: field value, None on error
+
+
+
+
+
+ def
+ def core.deviceManager.deviceClass.getConsoleSession
+ (self, str consoleName="default")
+ getConsoleSession
+ self
+ self
+
+ str
+ consoleName
+ "default"
+
+
+
+
+get the device console
+
+Args:
+ consoleName (str, optional): console name. Defaults to "default".
+
+Returns:
+ consoleClass: console class, or None on failure
+
+
+
+
+
+
+
+
+Single device with all controllers
+
+Raises:
+ exception: none
+
+Returns:
+ class: device class
+
+
+ core::deviceManager::deviceClass __init__ core::deviceManager::deviceClass consoles core::deviceManager::deviceClass deviceName core::deviceManager::deviceClass getConsoleSession core::deviceManager::deviceClass getField core::deviceManager::deviceClass outBoundClient core::deviceManager::deviceClass powerControl core::deviceManager::deviceClass rawConfig core::deviceManager::deviceClass remoteController
+
+
diff --git a/docs/doxygen/xml/classcore_1_1deviceManager_1_1deviceManager.xml b/docs/doxygen/xml/classcore_1_1deviceManager_1_1deviceManager.xml
new file mode 100644
index 0000000..3c19a6d
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1deviceManager_1_1deviceManager.xml
@@ -0,0 +1,145 @@
+
+
+
+ core::deviceManager::deviceManager
+
+
+ core.deviceManager.deviceManager::rawConfig
+ rawConfig
+ = dict()
+
+
+
+
+
+
+
+
+ core.deviceManager.deviceManager::devices
+ devices
+ = dict()
+
+
+
+
+
+
+
+
+
+
+ core.deviceManager.deviceManager::log
+ log
+
+
+
+
+
+
+
+
+ core.deviceManager.deviceManager::logPath
+ logPath
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.deviceManager.deviceManager.__init__
+ (self, dict deviceConfig, logModule log, str logPath="")
+ __init__
+ self
+ self
+
+ dict
+ deviceConfig
+
+ logModule
+ log
+
+ str
+ logPath
+ ""
+
+
+
+
+Initalise the device Managers
+
+Args:
+ deviceConfig (dict): device list
+ log (logModule): upper device module class
+
+
+
+
+
+ def
+ def core.deviceManager.deviceManager.getDevice
+ (self, str deviceName="dut")
+ getDevice
+ self
+ self
+
+ str
+ deviceName
+ "dut"
+
+
+
+
+Get an individual device configuration
+
+Args:
+ deviceName (str, optional): device name. Defaults to "dut".
+
+Returns:
+ dict: device dictionary, or None on failure
+
+
+
+
+
+
+
+
+
+
+ core::deviceManager::deviceManager __init__ core::deviceManager::deviceManager devices core::deviceManager::deviceManager getDevice core::deviceManager::deviceManager log core::deviceManager::deviceManager logPath core::deviceManager::deviceManager rawConfig
+
+
diff --git a/docs/doxygen/xml/classcore_1_1logModule_1_1logModule.xml b/docs/doxygen/xml/classcore_1_1logModule_1_1logModule.xml
new file mode 100644
index 0000000..c5f8edc
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1logModule_1_1logModule.xml
@@ -0,0 +1,1459 @@
+
+
+
+ core::logModule::logModule
+
+
+ int
+ int core.logModule.logModule::TEST_RESULT
+ TEST_RESULT
+ = 99
+
+
+
+
+
+
+
+
+ int
+ int core.logModule.logModule::FATAL
+ FATAL
+ = 100
+
+
+
+
+
+
+
+
+ string
+ string core.logModule.logModule::moduleName
+ moduleName
+ = ""
+
+
+
+
+
+
+
+
+ string
+ string core.logModule.logModule::SEPERATOR
+ SEPERATOR
+ = " ---- "
+
+
+
+
+
+
+
+
+ string
+ string core.logModule.logModule::SEPERATOR_STAR
+ SEPERATOR_STAR
+ = " **** "
+
+
+
+
+
+
+
+
+ string
+ string core.logModule.logModule::LARGE_SEPERATOR
+ LARGE_SEPERATOR
+ = "=================================================="
+
+
+
+
+
+
+
+
+ string
+ string core.logModule.logModule::INDENT_DEFAULT
+ INDENT_DEFAULT
+ = " "
+
+
+
+
+
+
+
+
+ string
+ string core.logModule.logModule::indentString
+ indentString
+ = ""
+
+
+
+
+
+
+
+
+ core.logModule.logModule::DEBUG
+ DEBUG
+ = DEBUG
+
+
+
+
+
+
+
+
+ core.logModule.logModule::INFO
+ INFO
+ = logging.INFO
+
+
+
+
+
+
+
+
+ core.logModule.logModule::WARNING
+ WARNING
+ = WARNING
+
+
+
+
+
+
+
+
+ core.logModule.logModule::ERROR
+ ERROR
+ = ERROR
+
+
+
+
+
+
+
+
+ core.logModule.logModule::CRITICAL
+ CRITICAL
+ = CRITICAL
+
+
+
+
+
+
+
+
+ int
+ int core.logModule.logModule::STEP
+ STEP
+ = INFO+1
+
+
+
+
+
+
+
+
+ int
+ int core.logModule.logModule::STEP_START
+ STEP_START
+ = INFO+2
+
+
+
+
+
+
+
+
+ int
+ int core.logModule.logModule::TEST_START
+ TEST_START
+ = INFO+3
+
+
+
+
+
+
+
+
+ int
+ int core.logModule.logModule::STEP_RESULT
+ STEP_RESULT
+ = INFO+4
+
+
+
+
+
+
+
+
+ int
+ int core.logModule.logModule::TEST_SUMMARY
+ TEST_SUMMARY
+ = INFO+6
+
+
+
+
+
+
+
+
+ int
+ int core.logModule.logModule::RESULT
+ RESULT
+ = STEP_RESULT
+
+
+
+
+
+
+
+
+
+
+ core.logModule.logModule::log
+ log
+
+
+
+
+
+
+
+
+ core.logModule.logModule::moduleName
+ moduleName
+
+
+
+
+
+
+
+
+ core.logModule.logModule::format
+ format
+
+
+
+
+
+
+
+
+ core.logModule.logModule::logConsole
+ logConsole
+
+
+
+
+
+
+
+
+ core.logModule.logModule::csvLogger
+ csvLogger
+
+
+
+
+
+
+
+
+ core.logModule.logModule::stepNum
+ stepNum
+
+
+
+
+
+
+
+
+ core.logModule.logModule::summaryQcID
+ summaryQcID
+
+
+
+
+
+
+
+
+ core.logModule.logModule::summaryTestName
+ summaryTestName
+
+
+
+
+
+
+
+
+ core.logModule.logModule::summaryTestTotal
+ summaryTestTotal
+
+
+
+
+
+
+
+
+ core.logModule.logModule::summaryTestsFailed
+ summaryTestsFailed
+
+
+
+
+
+
+
+
+ core.logModule.logModule::summaryTestsPassed
+ summaryTestsPassed
+
+
+
+
+
+
+
+
+ core.logModule.logModule::totalStepsFailed
+ totalStepsFailed
+
+
+
+
+
+
+
+
+ core.logModule.logModule::totalStepsPassed
+ totalStepsPassed
+
+
+
+
+
+
+
+
+ core.logModule.logModule::totalSteps
+ totalSteps
+
+
+
+
+
+
+
+
+ core.logModule.logModule::testDuration
+ testDuration
+
+
+
+
+
+
+
+
+ core.logModule.logModule::testCountActive
+ testCountActive
+
+
+
+
+
+
+
+
+ core.logModule.logModule::path
+ path
+
+
+
+
+
+
+
+
+ core.logModule.logModule::logFile
+ logFile
+
+
+
+
+
+
+
+
+ core.logModule.logModule::csvLogFile
+ csvLogFile
+
+
+
+
+
+
+
+
+ core.logModule.logModule::logPath
+ logPath
+
+
+
+
+
+
+
+
+ core.logModule.logModule::indentString
+ indentString
+
+
+
+
+
+
+
+
+ core.logModule.logModule::testName
+ testName
+
+
+
+
+
+
+
+
+ core.logModule.logModule::qcId
+ qcId
+
+
+
+
+
+
+
+
+ core.logModule.logModule::loopCount
+ loopCount
+
+
+
+
+
+
+
+
+ core.logModule.logModule::maxRunTime
+ maxRunTime
+
+
+
+
+
+
+
+
+ core.logModule.logModule::failedSteps
+ failedSteps
+
+
+
+
+
+
+
+
+ core.logModule.logModule::start_time
+ start_time
+
+
+
+
+
+
+
+
+ core.logModule.logModule::end_time
+ end_time
+
+
+
+
+
+
+
+
+ core.logModule.logModule::timeFormat
+ timeFormat
+
+
+
+
+
+
+
+
+ core.logModule.logModule::testStartTime
+ testStartTime
+
+
+
+
+
+
+
+
+ core.logModule.logModule::testActive
+ testActive
+
+
+
+
+
+
+
+
+ core.logModule.logModule::loopStartTime
+ loopStartTime
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.__init__
+ (self, moduleName, level=INFO)
+ __init__
+ self
+ self
+
+ moduleName
+ moduleName
+
+ level
+ level
+ INFO
+
+
+
+
+[init for the log module]
+
+Args:
+ moduleName ([string]): [name of hte module]
+ level ([level], optional): [DEBUG, INFO, STEP, STEP_START, STEP_RESULT, WARNING, ERROR, CRITICAL, FATAL]. Defaults to INFO.
+
+
+
+
+
+ def
+ def core.logModule.logModule.__del__
+ (self)
+ __del__
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.setFilename
+ (self, logPath, logFileName)
+ setFilename
+ self
+ self
+
+ logPath
+ logPath
+
+ logFileName
+ logFileName
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.fatal
+ (self, message, *args, **kws)
+ fatal
+ self
+ self
+
+ message
+ message
+
+ *
+ args
+
+ **
+ kws
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.warn
+ (self, message, extra=None)
+ warn
+ self
+ self
+
+ message
+ message
+
+ extra
+ extra
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.error
+ (self, message, extra=None)
+ error
+ self
+ self
+
+ message
+ message
+
+ extra
+ extra
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.critical
+ (self, message, extra=None)
+ critical
+ self
+ self
+
+ message
+ message
+
+ extra
+ extra
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.debug
+ (self, message, extra=None)
+ debug
+ self
+ self
+
+ message
+ message
+
+ extra
+ extra
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.info
+ (self, message, extra=None)
+ info
+ self
+ self
+
+ message
+ message
+
+ extra
+ extra
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.stepMessage
+ (self, message, *args, **kws)
+ stepMessage
+ self
+ self
+
+ message
+ message
+
+ *
+ args
+
+ **
+ kws
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.stepStartMessage
+ (self, message, *args, **kws)
+ stepStartMessage
+ self
+ self
+
+ message
+ message
+
+ *
+ args
+
+ **
+ kws
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.stepResultMessage
+ (self, message, *args, **kws)
+ stepResultMessage
+ self
+ self
+
+ message
+ message
+
+ *
+ args
+
+ **
+ kws
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.testStartMessage
+ (self, message, *args, **kws)
+ testStartMessage
+ self
+ self
+
+ message
+ message
+
+ *
+ args
+
+ **
+ kws
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.testResultMessage
+ (self, message, *args, **kws)
+ testResultMessage
+ self
+ self
+
+ message
+ message
+
+ *
+ args
+
+ **
+ kws
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.testSummaryMessage
+ (self, message, *args, **kws)
+ testSummaryMessage
+ self
+ self
+
+ message
+ message
+
+ *
+ args
+
+ **
+ kws
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.setLevel
+ (self, level)
+ setLevel
+ self
+ self
+
+ level
+ level
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.message
+ (self, level, output, extra=None)
+ message
+ self
+ self
+
+ level
+ level
+
+ output
+ output
+
+ extra
+ extra
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.indent
+ (self, string=INDENT_DEFAULT)
+ indent
+ self
+ self
+
+ string
+ string
+ INDENT_DEFAULT
+
+
+
+
+push an indent prefix
+
+
+
+
+
+ def
+ def core.logModule.logModule.outdent
+ (self, string=INDENT_DEFAULT)
+ outdent
+ self
+ self
+
+ string
+ string
+ INDENT_DEFAULT
+
+
+
+
+pop an indent
+
+
+
+
+
+ def
+ def core.logModule.logModule.testStart
+ (self, testName, qcId, loops=1, maxRunTime=(60 *24))
+ testStart
+ self
+ self
+
+ testName
+ testName
+
+ qcId
+ qcId
+
+ loops
+ loops
+ 1
+
+ maxRunTime
+ maxRunTime
+ (60 *24)
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.testLoop
+ (self, loopIndex)
+ testLoop
+ self
+ self
+
+ loopIndex
+ loopIndex
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.testLoopComplete
+ (self, loopIndex)
+ testLoopComplete
+ self
+ self
+
+ loopIndex
+ loopIndex
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.testResult
+ (self, message)
+ testResult
+ self
+ self
+
+ message
+ message
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.stepStart
+ (self, message, expected=None)
+ stepStart
+ self
+ self
+
+ message
+ message
+
+ expected
+ expected
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.step
+ (self, message, showStepNumber=True)
+ step
+ self
+ self
+
+ message
+ message
+
+ showStepNumber
+ showStepNumber
+ True
+
+
+
+
+
+
+
+
+
+ def
+ def core.logModule.logModule.stepResult
+ (self, result, message)
+ stepResult
+ self
+ self
+
+ result
+ result
+
+ message
+ message
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ core::logModule::logModule __del__ core::logModule::logModule __init__ core::logModule::logModule CRITICAL core::logModule::logModule critical core::logModule::logModule csvLogFile core::logModule::logModule csvLogger core::logModule::logModule DEBUG core::logModule::logModule debug core::logModule::logModule end_time core::logModule::logModule ERROR core::logModule::logModule error core::logModule::logModule failedSteps core::logModule::logModule FATAL core::logModule::logModule fatal core::logModule::logModule format core::logModule::logModule indent core::logModule::logModule INDENT_DEFAULT core::logModule::logModule indentString core::logModule::logModule indentString core::logModule::logModule INFO core::logModule::logModule info core::logModule::logModule LARGE_SEPERATOR core::logModule::logModule log core::logModule::logModule logConsole core::logModule::logModule logFile core::logModule::logModule logPath core::logModule::logModule loopCount core::logModule::logModule loopStartTime core::logModule::logModule maxRunTime core::logModule::logModule message core::logModule::logModule moduleName core::logModule::logModule moduleName core::logModule::logModule outdent core::logModule::logModule path core::logModule::logModule qcId core::logModule::logModule RESULT core::logModule::logModule SEPERATOR core::logModule::logModule SEPERATOR_STAR core::logModule::logModule setFilename core::logModule::logModule setLevel core::logModule::logModule start_time core::logModule::logModule STEP core::logModule::logModule step core::logModule::logModule STEP_RESULT core::logModule::logModule STEP_START core::logModule::logModule stepMessage core::logModule::logModule stepNum core::logModule::logModule stepResult core::logModule::logModule stepResultMessage core::logModule::logModule stepStart core::logModule::logModule stepStartMessage core::logModule::logModule summaryQcID core::logModule::logModule summaryTestName core::logModule::logModule summaryTestsFailed core::logModule::logModule summaryTestsPassed core::logModule::logModule summaryTestTotal core::logModule::logModule TEST_RESULT core::logModule::logModule TEST_START core::logModule::logModule TEST_SUMMARY core::logModule::logModule testActive core::logModule::logModule testCountActive core::logModule::logModule testDuration core::logModule::logModule testLoop core::logModule::logModule testLoopComplete core::logModule::logModule testName core::logModule::logModule testResult core::logModule::logModule testResultMessage core::logModule::logModule testStart core::logModule::logModule testStartMessage core::logModule::logModule testStartTime core::logModule::logModule testSummaryMessage core::logModule::logModule timeFormat core::logModule::logModule totalSteps core::logModule::logModule totalStepsFailed core::logModule::logModule totalStepsPassed core::logModule::logModule warn core::logModule::logModule WARNING
+
+
diff --git a/docs/doxygen/xml/classcore_1_1outboundClient_1_1outboundClientClass.xml b/docs/doxygen/xml/classcore_1_1outboundClient_1_1outboundClientClass.xml
new file mode 100644
index 0000000..16caf0b
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1outboundClient_1_1outboundClientClass.xml
@@ -0,0 +1,576 @@
+
+
+
+ core::outboundClient::outboundClientClass
+
+
+ core.outboundClient.outboundClientClass::log
+ log
+
+
+
+
+
+
+
+
+ core.outboundClient.outboundClientClass::logBase
+ logBase
+
+
+
+
+
+
+
+
+ core.outboundClient.outboundClientClass::workspaceDirectory
+ workspaceDirectory
+
+
+
+
+
+
+
+
+ core.outboundClient.outboundClientClass::upload_url
+ upload_url
+
+
+
+
+
+
+
+
+ core.outboundClient.outboundClientClass::uploadPath
+ uploadPath
+
+
+
+
+
+
+
+
+ core.outboundClient.outboundClientClass::httpProxy
+ httpProxy
+
+
+
+
+
+
+
+
+ core.outboundClient.outboundClientClass::uploadPort
+ uploadPort
+
+
+
+
+
+
+
+
+ core.outboundClient.outboundClientClass::uploadAddress
+ uploadAddress
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.outboundClient.outboundClientClass.__init__
+ (self, logModule log=None, str workspaceDirectory=None, str upload_url=None, str httpProxy="", **kwargs)
+ __init__
+ self
+ self
+
+ logModule
+ log
+ None
+
+ str
+ workspaceDirectory
+ None
+
+ str
+ upload_url
+ None
+
+ str
+ httpProxy
+ ""
+
+ **
+ kwargs
+
+
+
+
+Intialise class
+
+Args:
+ log ([logModule], optional): [logging class from parent if required]. Defaults to None.
+ workspaceDirectory ([str]): [local workspace folder to download files too]
+ upload_url ([str], optional): [description]. Defaults to None.
+ httpProxy (str, optional): [httpProxy if required, used for downloading via http]. Defaults to "".
+
+
+
+
+
+ def
+ def core.outboundClient.outboundClientClass.__del__
+ (self)
+ __del__
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.outboundClient.outboundClientClass.__configureUploadProtocol__
+ (self, str upload_url)
+ __configureUploadProtocol__
+ self
+ self
+
+ str
+ upload_url
+
+
+
+
+configure the TFTP client if required
+
+Args:
+ upload_url ([str]): [upload folder including the TFTP requirements]
+
+Returns:
+ [bool]: [True - on success, otherwise False]
+
+
+
+
+
+ def
+ def core.outboundClient.outboundClientClass.downloadFile
+ (self, str url, str filename=None)
+ downloadFile
+ self
+ self
+
+ str
+ url
+
+ str
+ filename
+ None
+
+
+
+
+[downloadFile a file from the url and save to the workspace]
+
+Args:
+ url ([str]): [url of the file to be downloadeds]
+ filename ([str]): [optional name of the download file]
+
+Returns:
+ [bool]: [True - on success, otherwise False]
+
+
+
+
+
+ def
+ def core.outboundClient.outboundClientClass.prepareOutboundWithImageFromUrl
+ (self, str imageType, str url)
+ prepareOutboundWithImageFromUrl
+ self
+ self
+
+ str
+ imageType
+
+ str
+ url
+
+
+
+
+program the given image name , from the url given
+
+Args:
+ imageType ([str]): [image, PCI1, PCI2, etc. as required]
+ url ([str]): [url for the source image, http://, or sftp:// ]
+
+
+
+
+
+ def
+ def core.outboundClient.outboundClientClass.translateImageTypeToImageFilename
+ (self, str imageType)
+ translateImageTypeToImageFilename
+ self
+ self
+
+ str
+ imageType
+
+
+
+
+Convert imageType to imageFilename
+
+ TODO: This function will need extending to read the imageType translations to filename translations
+
+Args:
+ imageType ([str]): [imageType, PCI1, PCI2, PDRI, BDRI etc.]
+Returns:
+ imageFilename ([str]): [Filename returned with extension]
+
+
+
+
+
+ def
+ def core.outboundClient.outboundClientClass.getSizeInHumanReadable
+ (self, int size)
+ getSizeInHumanReadable
+ self
+ self
+
+ int
+ size
+
+
+
+
+get size in Human Readable form
+
+Args:
+ size ([int]): [size in bytes]
+
+Returns:
+ [int]: [size string]
+
+
+
+
+
+ def
+ def core.outboundClient.outboundClientClass.__downloadSFTP__
+ (self, str url, str filename=None)
+ __downloadSFTP__
+ self
+ self
+
+ str
+ url
+
+ str
+ filename
+ None
+
+
+
+
+Download the given url via SFTP protocol
+
+Args:
+ url ([str]): [source url]
+ filename ([str]): [optional destination filename]
+
+Returns:
+ [bool]: [True - on success, otherwise False]
+
+
+
+
+
+ def
+ def core.outboundClient.outboundClientClass.cleanWorkspace
+ (self)
+ cleanWorkspace
+ self
+ self
+
+
+
+
+Clean the workspace folder
+
+
+
+
+
+ def
+ def core.outboundClient.outboundClientClass.__uploadSFTP__
+ (self, str filename)
+ __uploadSFTP__
+ self
+ self
+
+ str
+ filename
+
+
+
+
+Upload the specified file via sftp protocol
+ Note: This function will create directories as required
+
+Args:
+ filename ([str]): [filename from workspace]
+
+Returns:
+ [bool]: [True - on success, otherwise False]
+
+
+
+
+
+ def
+ def core.outboundClient.outboundClientClass.progressSFTP
+ (self, str filename, int size, int sent)
+ progressSFTP
+ self
+ self
+
+ str
+ filename
+
+ int
+ size
+
+ int
+ sent
+
+
+
+
+SSH Progress callback
+
+Args:
+ filename ([str]): [filename]
+ size ([int]): [total size]
+ sent ([int]): [current sent]
+
+
+
+
+
+ def
+ def core.outboundClient.outboundClientClass.__downloadHTTP__
+ (self, str url, str filename=None)
+ __downloadHTTP__
+ self
+ self
+
+ str
+ url
+
+ str
+ filename
+ None
+
+
+
+
+Download the given url via HTTP protocol
+
+Args:
+ url ([str]): [source url]
+ filename ([str]): [optional destination filename]
+
+Returns:
+ [bool]: [True - on success, otherwise False]
+
+
+
+
+
+ def
+ def core.outboundClient.outboundClientClass.uploadFile
+ (self, str filename)
+ uploadFile
+ self
+ self
+
+ str
+ filename
+
+
+
+
+[upload the file specified from the workspace to the outputfolder ]
+
+Args:
+ file ([str]): [file to be uploaded]
+
+Returns:
+ [bool]: [True - on success, otherwise False]
+
+
+
+
+
+ def
+ def core.outboundClient.outboundClientClass.retrieveListofFilenamesFromUrl
+ (self, str inputUrl)
+ retrieveListofFilenamesFromUrl
+ self
+ self
+
+ str
+ inputUrl
+
+
+
+
+Retrieves list of build\image names using the input url
+
+Args:
+ inputUrl ([str]) - Url of the build binaries
+
+Returns:
+ imagesList (list) - List of image names available in the binaries folder
+
+
+
+
+
+
+
+
+
+
+ core::outboundClient::outboundClientClass __configureUploadProtocol__ core::outboundClient::outboundClientClass __del__ core::outboundClient::outboundClientClass __downloadHTTP__ core::outboundClient::outboundClientClass __downloadSFTP__ core::outboundClient::outboundClientClass __init__ core::outboundClient::outboundClientClass __uploadSFTP__ core::outboundClient::outboundClientClass cleanWorkspace core::outboundClient::outboundClientClass downloadFile core::outboundClient::outboundClientClass getSizeInHumanReadable core::outboundClient::outboundClientClass httpProxy core::outboundClient::outboundClientClass log core::outboundClient::outboundClientClass logBase core::outboundClient::outboundClientClass prepareOutboundWithImageFromUrl core::outboundClient::outboundClientClass progressSFTP core::outboundClient::outboundClientClass retrieveListofFilenamesFromUrl core::outboundClient::outboundClientClass translateImageTypeToImageFilename core::outboundClient::outboundClientClass upload_url core::outboundClient::outboundClientClass uploadAddress core::outboundClient::outboundClientClass uploadFile core::outboundClient::outboundClientClass uploadPath core::outboundClient::outboundClientClass uploadPort core::outboundClient::outboundClientClass workspaceDirectory
+
+
diff --git a/docs/doxygen/xml/classcore_1_1powerControl_1_1powerControlClass.xml b/docs/doxygen/xml/classcore_1_1powerControl_1_1powerControlClass.xml
new file mode 100644
index 0000000..5c851f4
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1powerControl_1_1powerControlClass.xml
@@ -0,0 +1,248 @@
+
+
+
+ core::powerControl::powerControlClass
+
+
+ core.powerControl.powerControlClass::log
+ log
+
+
+
+
+
+
+
+
+ core.powerControl.powerControlClass::utils
+ utils
+
+
+
+
+
+
+
+
+ core.powerControl.powerControlClass::ip
+ ip
+
+
+
+
+
+
+
+
+ core.powerControl.powerControlClass::name
+ name
+
+
+
+
+
+
+
+
+ core.powerControl.powerControlClass::retryCount
+ retryCount
+
+
+
+
+
+
+
+
+ core.powerControl.powerControlClass::retryDelay
+ retryDelay
+
+
+
+
+
+
+
+
+ core.powerControl.powerControlClass::powerOnState
+ powerOnState
+
+
+
+
+
+
+
+
+ core.powerControl.powerControlClass::powerSwitch
+ powerSwitch
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerControl.powerControlClass.__init__
+ (self, logModule log, dict config)
+ __init__
+ self
+ self
+
+ logModule
+ log
+
+ dict
+ config
+
+
+
+
+Initalise the power controller
+
+Args:
+ log (logModule): log module class
+ config (dict): configuration from the .yml file
+
+
+
+
+
+ def
+ def core.powerControl.powerControlClass.powerOn
+ (self)
+ powerOn
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerControl.powerControlClass.powerOff
+ (self)
+ powerOff
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerControl.powerControlClass.reboot
+ (self)
+ reboot
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerControl.powerControlClass.powerRetry
+ (self, powerMethod)
+ powerRetry
+ self
+ self
+
+ powerMethod
+ powerMethod
+
+
+
+
+Performs the passed powerMethod and retries it if it fails
+
+Args:
+ powerMethod (Method): The powerMethod to perform
+
+Raises:
+ e: Exception for if the powerMethod fails after all of the retries
+
+Returns:
+ boolean: Whether the powerMethod was successfully performed
+
+
+
+
+
+
+
+
+
+
+ core::powerControl::powerControlClass __init__ core::powerControl::powerControlClass ip core::powerControl::powerControlClass log core::powerControl::powerControlClass name core::powerControl::powerControlClass powerOff core::powerControl::powerControlClass powerOn core::powerControl::powerControlClass powerOnState core::powerControl::powerControlClass powerRetry core::powerControl::powerControlClass powerSwitch core::powerControl::powerControlClass reboot core::powerControl::powerControlClass retryCount core::powerControl::powerControlClass retryDelay core::powerControl::powerControlClass utils
+
+
diff --git a/docs/doxygen/xml/classcore_1_1powerModules_1_1S20control_1_1OrviboS20.xml b/docs/doxygen/xml/classcore_1_1powerModules_1_1S20control_1_1OrviboS20.xml
new file mode 100644
index 0000000..f09f6b2
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1powerModules_1_1S20control_1_1OrviboS20.xml
@@ -0,0 +1,410 @@
+
+
+
+ core::powerModules::S20control::OrviboS20
+
+
+ int
+ int core.powerModules.S20control.OrviboS20::DEBUG
+ DEBUG
+ = 0
+
+
+
+
+
+
+
+
+
+
+ core.powerModules.S20control.OrviboS20::subscribed
+ subscribed
+
+
+
+
+
+
+
+
+ core.powerModules.S20control.OrviboS20::exitontimeout
+ exitontimeout
+
+
+
+
+
+
+
+
+ core.powerModules.S20control.OrviboS20::sock
+ sock
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.S20control.OrviboS20.__enter__
+ (self)
+ __enter__
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.S20control.OrviboS20.__exit__
+ (self, exc_type, exc_val, exc_tb)
+ __exit__
+ self
+ self
+
+ exc_type
+ exc_type
+
+ exc_val
+ exc_val
+
+ exc_tb
+ exc_tb
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.S20control.OrviboS20.__init__
+ (self, port=10000)
+ __init__
+ self
+ self
+
+ port
+ port
+ 10000
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.S20control.OrviboS20.close
+ (self)
+ close
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.S20control.OrviboS20.listen
+ (self)
+ listen
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.S20control.OrviboS20.discover
+ (self, ip, mac)
+ discover
+ self
+ self
+
+ ip
+ ip
+
+ mac
+ mac
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.S20control.OrviboS20.globaldiscover
+ (self, ip)
+ globaldiscover
+ self
+ self
+
+ ip
+ ip
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.S20control.OrviboS20.subscribe
+ (self, ip, mac)
+ subscribe
+ self
+ self
+
+ ip
+ ip
+
+ mac
+ mac
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.S20control.OrviboS20.poweron
+ (self, ip=None, mac=None)
+ poweron
+ self
+ self
+
+ ip
+ ip
+ None
+
+ mac
+ mac
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.S20control.OrviboS20.poweroff
+ (self, ip=None, mac=None)
+ poweroff
+ self
+ self
+
+ ip
+ ip
+ None
+
+ mac
+ mac
+ None
+
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.S20control.OrviboS20._settimeout
+ (self, timeout=None)
+ _settimeout
+ self
+ self
+
+ timeout
+ timeout
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.S20control.OrviboS20._sendpacket
+ (self, payload, ip)
+ _sendpacket
+ self
+ self
+
+ payload
+ payload
+
+ ip
+ ip
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.S20control.OrviboS20._listendiscover
+ (self)
+ _listendiscover
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.S20control.OrviboS20._subscribeifneeded
+ (self, ip, mac)
+ _subscribeifneeded
+ self
+ self
+
+ ip
+ ip
+
+ mac
+ mac
+
+
+
+
+
+
+
+
+
+
+
+
+main class for Orvibo S20
+
+
+ core::powerModules::S20control::OrviboS20 __enter__ core::powerModules::S20control::OrviboS20 __exit__ core::powerModules::S20control::OrviboS20 __init__ core::powerModules::S20control::OrviboS20 _listendiscover core::powerModules::S20control::OrviboS20 _sendpacket core::powerModules::S20control::OrviboS20 _settimeout core::powerModules::S20control::OrviboS20 _subscribeifneeded core::powerModules::S20control::OrviboS20 close core::powerModules::S20control::OrviboS20 DEBUG core::powerModules::S20control::OrviboS20 discover core::powerModules::S20control::OrviboS20 exitontimeout core::powerModules::S20control::OrviboS20 globaldiscover core::powerModules::S20control::OrviboS20 listen core::powerModules::S20control::OrviboS20 poweroff core::powerModules::S20control::OrviboS20 poweron core::powerModules::S20control::OrviboS20 sock core::powerModules::S20control::OrviboS20 subscribe core::powerModules::S20control::OrviboS20 subscribed
+
+
diff --git a/docs/doxygen/xml/classcore_1_1powerModules_1_1S20control_1_1UnknownPacket.xml b/docs/doxygen/xml/classcore_1_1powerModules_1_1S20control_1_1UnknownPacket.xml
new file mode 100644
index 0000000..23b0ff4
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1powerModules_1_1S20control_1_1UnknownPacket.xml
@@ -0,0 +1,36 @@
+
+
+
+ core::powerModules::S20control::UnknownPacket
+ Exception
+
+
+
+
+
+
+ Exception
+
+
+ core.powerModules.S20control.UnknownPacket
+
+
+
+
+
+
+ Exception
+
+
+ core.powerModules.S20control.UnknownPacket
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/classcore_1_1powerModules_1_1S20control_1_1powerOrviboS20.xml b/docs/doxygen/xml/classcore_1_1powerModules_1_1S20control_1_1powerOrviboS20.xml
new file mode 100644
index 0000000..8c13c5d
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1powerModules_1_1S20control_1_1powerOrviboS20.xml
@@ -0,0 +1,175 @@
+
+
+
+ core::powerModules::S20control::powerOrviboS20
+
+
+ core.powerModules.S20control.powerOrviboS20::log
+ log
+
+
+
+
+
+
+
+
+ core.powerModules.S20control.powerOrviboS20::ip
+ ip
+
+
+
+
+
+
+
+
+ core.powerModules.S20control.powerOrviboS20::mac
+ mac
+
+
+
+
+
+
+
+
+ core.powerModules.S20control.powerOrviboS20::port
+ port
+
+
+
+
+
+
+
+
+ core.powerModules.S20control.powerOrviboS20::switch
+ switch
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.S20control.powerOrviboS20.__init__
+ (self, log, ip, mac, port)
+ __init__
+ self
+ self
+
+ log
+ log
+
+ ip
+ ip
+
+ mac
+ mac
+
+ port
+ port
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.S20control.powerOrviboS20.powerOn
+ (self)
+ powerOn
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.S20control.powerOrviboS20.powerOff
+ (self)
+ powerOff
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.S20control.powerOrviboS20.reboot
+ (self)
+ reboot
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ core::powerModules::S20control::powerOrviboS20 __init__ core::powerModules::S20control::powerOrviboS20 ip core::powerModules::S20control::powerOrviboS20 log core::powerModules::S20control::powerOrviboS20 mac core::powerModules::S20control::powerOrviboS20 port core::powerModules::S20control::powerOrviboS20 powerOff core::powerModules::S20control::powerOrviboS20 powerOn core::powerModules::S20control::powerOrviboS20 reboot core::powerModules::S20control::powerOrviboS20 switch
+
+
diff --git a/docs/doxygen/xml/classcore_1_1powerModules_1_1SLP_1_1powerSLP.xml b/docs/doxygen/xml/classcore_1_1powerModules_1_1SLP_1_1powerSLP.xml
new file mode 100644
index 0000000..7b68494
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1powerModules_1_1SLP_1_1powerSLP.xml
@@ -0,0 +1,234 @@
+
+
+
+ core::powerModules::SLP::powerSLP
+
+
+ core.powerModules.SLP.powerSLP::log
+ log
+
+
+
+
+
+
+
+
+ core.powerModules.SLP.powerSLP::ip
+ ip
+
+
+
+
+
+
+
+
+ core.powerModules.SLP.powerSLP::username
+ username
+
+
+
+
+
+
+
+
+ core.powerModules.SLP.powerSLP::password
+ password
+
+
+
+
+
+
+
+
+ core.powerModules.SLP.powerSLP::outlet
+ outlet
+
+
+
+
+
+
+
+
+ core.powerModules.SLP.powerSLP::port
+ port
+
+
+
+
+
+
+
+
+ core.powerModules.SLP.powerSLP::telnet
+ telnet
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.SLP.powerSLP.__init__
+ (self, log, ip, username, password, outlet_id, port=None)
+ __init__
+ self
+ self
+
+ log
+ log
+
+ ip
+ ip
+
+ username
+ username
+
+ password
+ password
+
+ outlet_id
+ outlet_id
+
+ port
+ port
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.SLP.powerSLP.command
+ (self, cmd)
+ command
+ self
+ self
+
+ cmd
+ cmd
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.SLP.powerSLP.powerOff
+ (self)
+ powerOff
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.SLP.powerSLP.powerOn
+ (self)
+ powerOn
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.SLP.powerSLP.reboot
+ (self)
+ reboot
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ core::powerModules::SLP::powerSLP __init__ core::powerModules::SLP::powerSLP command core::powerModules::SLP::powerSLP ip core::powerModules::SLP::powerSLP log core::powerModules::SLP::powerSLP outlet core::powerModules::SLP::powerSLP password core::powerModules::SLP::powerSLP port core::powerModules::SLP::powerSLP powerOff core::powerModules::SLP::powerSLP powerOn core::powerModules::SLP::powerSLP reboot core::powerModules::SLP::powerSLP telnet core::powerModules::SLP::powerSLP username
+
+
diff --git a/docs/doxygen/xml/classcore_1_1powerModules_1_1apcAos_1_1powerApcAos.xml b/docs/doxygen/xml/classcore_1_1powerModules_1_1apcAos_1_1powerApcAos.xml
new file mode 100644
index 0000000..d504d86
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1powerModules_1_1apcAos_1_1powerApcAos.xml
@@ -0,0 +1,291 @@
+
+
+
+ core::powerModules::apcAos::powerApcAos
+
+
+ core.powerModules.apcAos.powerApcAos::hostName
+ hostName
+
+
+
+
+
+
+
+
+ core.powerModules.apcAos.powerApcAos::userName
+ userName
+
+
+
+
+
+
+
+
+ core.powerModules.apcAos.powerApcAos::password
+ password
+
+
+
+
+
+
+
+
+ core.powerModules.apcAos.powerApcAos::port
+ port
+
+
+
+
+
+
+
+
+ core.powerModules.apcAos.powerApcAos::outletNumber
+ outletNumber
+
+
+
+
+
+
+
+
+ core.powerModules.apcAos.powerApcAos::log
+ log
+
+
+
+
+
+
+
+
+ core.powerModules.apcAos.powerApcAos::telnet
+ telnet
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.apcAos.powerApcAos.__init__
+ (self, log, hostName, userName, password, port=23, outletNumber=1)
+ __init__
+ self
+ self
+
+ log
+ log
+
+ hostName
+ hostName
+
+ userName
+ userName
+
+ password
+ password
+
+ port
+ port
+ 23
+
+ outletNumber
+ outletNumber
+ 1
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.apcAos.powerApcAos.open
+ (self)
+ open
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.apcAos.powerApcAos.close
+ (self)
+ close
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.apcAos.powerApcAos.waitForPrompt
+ (self)
+ waitForPrompt
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.apcAos.powerApcAos.sendCommand
+ (self, cmd)
+ sendCommand
+ self
+ self
+
+ cmd
+ cmd
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.apcAos.powerApcAos.powerOn
+ (self)
+ powerOn
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.apcAos.powerApcAos.powerOff
+ (self)
+ powerOff
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.apcAos.powerApcAos.reboot
+ (self)
+ reboot
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+Power Control module for the APC power switches
+
+
+ core::powerModules::apcAos::powerApcAos __init__ core::powerModules::apcAos::powerApcAos close core::powerModules::apcAos::powerApcAos hostName core::powerModules::apcAos::powerApcAos log core::powerModules::apcAos::powerApcAos open core::powerModules::apcAos::powerApcAos outletNumber core::powerModules::apcAos::powerApcAos password core::powerModules::apcAos::powerApcAos port core::powerModules::apcAos::powerApcAos powerOff core::powerModules::apcAos::powerApcAos powerOn core::powerModules::apcAos::powerApcAos reboot core::powerModules::apcAos::powerApcAos sendCommand core::powerModules::apcAos::powerApcAos telnet core::powerModules::apcAos::powerApcAos userName core::powerModules::apcAos::powerApcAos waitForPrompt
+
+
diff --git a/docs/doxygen/xml/classcore_1_1powerModules_1_1apc_1_1powerAPC.xml b/docs/doxygen/xml/classcore_1_1powerModules_1_1apc_1_1powerAPC.xml
new file mode 100644
index 0000000..ee5983f
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1powerModules_1_1apc_1_1powerAPC.xml
@@ -0,0 +1,366 @@
+
+
+
+ core::powerModules::apc::powerAPC
+
+
+ core.powerModules.apc.powerAPC::hostName
+ hostName
+
+
+
+
+
+
+
+
+ core.powerModules.apc.powerAPC::userName
+ userName
+
+
+
+
+
+
+
+
+ core.powerModules.apc.powerAPC::password
+ password
+
+
+
+
+
+
+
+
+ core.powerModules.apc.powerAPC::outletNumber
+ outletNumber
+
+
+
+
+
+
+
+
+ core.powerModules.apc.powerAPC::log
+ log
+
+
+
+
+
+
+
+
+ core.powerModules.apc.powerAPC::telnet
+ telnet
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.apc.powerAPC.__init__
+ (self, log, hostName, userName, password, outletNumber=1)
+ __init__
+ self
+ self
+
+ log
+ log
+
+ hostName
+ hostName
+
+ userName
+ userName
+
+ password
+ password
+
+ outletNumber
+ outletNumber
+ 1
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.apc.powerAPC.pduPowerSetting
+ (self, powerMode)
+ pduPowerSetting
+ self
+ self
+
+ powerMode
+ powerMode
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.apc.powerAPC.checkConnection
+ (self)
+ checkConnection
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.apc.powerAPC.open
+ (self)
+ open
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.apc.powerAPC.close
+ (self)
+ close
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.apc.powerAPC.waitAPCNextline
+ (self)
+ waitAPCNextline
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.apc.powerAPC.configurePDU
+ (self)
+ configurePDU
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.apc.powerAPC.selectPDUOutlet
+ (self, outletNumber)
+ selectPDUOutlet
+ self
+ self
+
+ outletNumber
+ outletNumber
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.apc.powerAPC.sendPowerON
+ (self)
+ sendPowerON
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.apc.powerAPC.sendPowerOFF
+ (self)
+ sendPowerOFF
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.apc.powerAPC.powerOff
+ (self)
+ powerOff
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.apc.powerAPC.powerOn
+ (self)
+ powerOn
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.apc.powerAPC.reboot
+ (self)
+ reboot
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+Power Control module for the APC power switches
+
+
+ core::powerModules::apc::powerAPC __init__ core::powerModules::apc::powerAPC checkConnection core::powerModules::apc::powerAPC close core::powerModules::apc::powerAPC configurePDU core::powerModules::apc::powerAPC hostName core::powerModules::apc::powerAPC log core::powerModules::apc::powerAPC open core::powerModules::apc::powerAPC outletNumber core::powerModules::apc::powerAPC password core::powerModules::apc::powerAPC pduPowerSetting core::powerModules::apc::powerAPC powerOff core::powerModules::apc::powerAPC powerOn core::powerModules::apc::powerAPC reboot core::powerModules::apc::powerAPC selectPDUOutlet core::powerModules::apc::powerAPC sendPowerOFF core::powerModules::apc::powerAPC sendPowerON core::powerModules::apc::powerAPC telnet core::powerModules::apc::powerAPC userName core::powerModules::apc::powerAPC waitAPCNextline
+
+
diff --git a/docs/doxygen/xml/classcore_1_1powerModules_1_1hs100_1_1powerHS100.xml b/docs/doxygen/xml/classcore_1_1powerModules_1_1hs100_1_1powerHS100.xml
new file mode 100644
index 0000000..9665537
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1powerModules_1_1hs100_1_1powerHS100.xml
@@ -0,0 +1,262 @@
+
+
+
+ core::powerModules::hs100::powerHS100
+
+
+ core.powerModules.hs100.powerHS100::ip
+ ip
+
+
+
+
+
+
+
+
+ core.powerModules.hs100.powerHS100::port
+ port
+
+
+
+
+
+
+
+
+ core.powerModules.hs100.powerHS100::log
+ log
+
+
+
+
+
+
+
+
+ core.powerModules.hs100.powerHS100::commands
+ commands
+
+
+
+
+
+
+
+
+ core.powerModules.hs100.powerHS100::powerOnState
+ powerOnState
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.hs100.powerHS100.__init__
+ (self, log, ip, port)
+ __init__
+ self
+ self
+
+ log
+ log
+
+ ip
+ ip
+
+ port
+ port
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.hs100.powerHS100.encrypt
+ (self, string)
+ encrypt
+ self
+ self
+
+ string
+ string
+
+
+
+
+Encryption of TP-Link Smart Home Protocol. XOR Autokey Cipher with starting key = 171
+
+
+
+
+ def
+ def core.powerModules.hs100.powerHS100.decrypt
+ (self, string)
+ decrypt
+ self
+ self
+
+ string
+ string
+
+
+
+
+Decryption of TP-Link Smart Home Protocol. XOR Autokey Cipher with starting key = 171
+
+
+
+
+ def
+ def core.powerModules.hs100.powerHS100.switchCommand
+ (self, key)
+ switchCommand
+ self
+ self
+
+ key
+ key
+
+
+
+
+send key command to switch
+
+Args:
+ key (str) - 'on'\'off'\'reboot'. Refer self.commands
+
+
+
+
+
+ def
+ def core.powerModules.hs100.powerHS100.powerOff
+ (self)
+ powerOff
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.hs100.powerHS100.powerOn
+ (self)
+ powerOn
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.hs100.powerHS100.switchReboot
+ (self)
+ switchReboot
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.hs100.powerHS100.reboot
+ (self)
+ reboot
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ core::powerModules::hs100::powerHS100 __init__ core::powerModules::hs100::powerHS100 commands core::powerModules::hs100::powerHS100 decrypt core::powerModules::hs100::powerHS100 encrypt core::powerModules::hs100::powerHS100 ip core::powerModules::hs100::powerHS100 log core::powerModules::hs100::powerHS100 port core::powerModules::hs100::powerHS100 powerOff core::powerModules::hs100::powerHS100 powerOn core::powerModules::hs100::powerHS100 powerOnState core::powerModules::hs100::powerHS100 reboot core::powerModules::hs100::powerHS100 switchCommand core::powerModules::hs100::powerHS100 switchReboot
+
+
diff --git a/docs/doxygen/xml/classcore_1_1powerModules_1_1kasaControl_1_1powerKasa.xml b/docs/doxygen/xml/classcore_1_1powerModules_1_1kasaControl_1_1powerKasa.xml
new file mode 100644
index 0000000..2f0861c
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1powerModules_1_1kasaControl_1_1powerKasa.xml
@@ -0,0 +1,320 @@
+
+
+
+ core::powerModules::kasaControl::powerKasa
+
+
+ core.powerModules.kasaControl.powerKasa::log
+ log
+
+
+
+
+
+
+
+
+ core.powerModules.kasaControl.powerKasa::is_on
+ is_on
+
+
+
+
+
+
+
+
+ core.powerModules.kasaControl.powerKasa::is_off
+ is_off
+
+
+
+
+
+
+
+
+ core.powerModules.kasaControl.powerKasa::slotIndex
+ slotIndex
+
+
+
+
+
+
+
+
+ core.powerModules.kasaControl.powerKasa::ip
+ ip
+
+
+
+
+
+
+
+
+ core.powerModules.kasaControl.powerKasa::options
+ options
+
+
+
+
+
+
+
+
+ core.powerModules.kasaControl.powerKasa::args
+ args
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.kasaControl.powerKasa.__init__
+ (self, logModule log, str ip, str args=None, str options=None, **kwargs)
+ __init__
+ self
+ self
+
+ logModule
+ log
+
+ str
+ ip
+
+ str
+ args
+ None
+
+ str
+ options
+ None
+
+ **
+ kwargs
+
+
+
+
+[init the kasa module]
+
+ kasa [OPTIONS] COMMAND [ARGS]...\n
+ Examples:-\n
+ kasa --strip --host 192.168.88.39 on --name "Plug 3"\n
+ kasa --strip --host 192.168.88.39 on --index 0 # Complete strip overall, index 1 is the first socket\n
+ kasa --plug --host 192.168.88.39 on\n
+
+Args:
+ log ([logModule]): [log module]
+ ip ([str]): [ip]
+ args ([str], optional): [args]. Defaults to None.
+ options ([str], optional): [options]. Defaults to None, which translates to "--plug"
+ kwargs ([dict]): [any other args]
+
+
+
+
+
+ def
+ def core.powerModules.kasaControl.powerKasa.split_with_quotes
+ (self, inputString)
+ split_with_quotes
+ self
+ self
+
+ inputString
+ inputString
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.kasaControl.powerKasa.remove_empty_strings
+ (self, inputList)
+ remove_empty_strings
+ self
+ self
+
+ inputList
+ inputList
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.kasaControl.powerKasa.performCommand
+ (self, command, noOptions=False, noArgs=False)
+ performCommand
+ self
+ self
+
+ command
+ command
+
+ noOptions
+ noOptions
+ False
+
+ noArgs
+ noArgs
+ False
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.kasaControl.powerKasa.powerOff
+ (self)
+ powerOff
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.kasaControl.powerKasa.powerOn
+ (self)
+ powerOn
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.kasaControl.powerKasa.__getstate__
+ (self)
+ __getstate__
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.kasaControl.powerKasa.reboot
+ (self)
+ reboot
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+Kasa power switch controller supports
+
+
+ core::powerModules::kasaControl::powerKasa __getstate__ core::powerModules::kasaControl::powerKasa __init__ core::powerModules::kasaControl::powerKasa args core::powerModules::kasaControl::powerKasa ip core::powerModules::kasaControl::powerKasa is_off core::powerModules::kasaControl::powerKasa is_on core::powerModules::kasaControl::powerKasa log core::powerModules::kasaControl::powerKasa options core::powerModules::kasaControl::powerKasa performCommand core::powerModules::kasaControl::powerKasa powerOff core::powerModules::kasaControl::powerKasa powerOn core::powerModules::kasaControl::powerKasa reboot core::powerModules::kasaControl::powerKasa remove_empty_strings core::powerModules::kasaControl::powerKasa slotIndex core::powerModules::kasaControl::powerKasa split_with_quotes
+
+
diff --git a/docs/doxygen/xml/classcore_1_1powerModules_1_1none_1_1powerNone.xml b/docs/doxygen/xml/classcore_1_1powerModules_1_1none_1_1powerNone.xml
new file mode 100644
index 0000000..d88c5c7
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1powerModules_1_1none_1_1powerNone.xml
@@ -0,0 +1,107 @@
+
+
+
+ core::powerModules::none::powerNone
+
+
+ core.powerModules.none.powerNone::log
+ log
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.none.powerNone.__init__
+ (self, log)
+ __init__
+ self
+ self
+
+ log
+ log
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.none.powerNone.powerOn
+ (self)
+ powerOn
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.none.powerNone.powerOff
+ (self)
+ powerOff
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.none.powerNone.reboot
+ (self)
+ reboot
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ core::powerModules::none::powerNone __init__ core::powerModules::none::powerNone log core::powerModules::none::powerNone powerOff core::powerModules::none::powerNone powerOn core::powerModules::none::powerNone reboot
+
+
diff --git a/docs/doxygen/xml/classcore_1_1powerModules_1_1olimex_1_1powerOlimex.xml b/docs/doxygen/xml/classcore_1_1powerModules_1_1olimex_1_1powerOlimex.xml
new file mode 100644
index 0000000..86b80a1
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1powerModules_1_1olimex_1_1powerOlimex.xml
@@ -0,0 +1,197 @@
+
+
+
+ core::powerModules::olimex::powerOlimex
+
+
+ core.powerModules.olimex.powerOlimex::log
+ log
+
+
+
+
+
+
+
+
+ core.powerModules.olimex.powerOlimex::ip
+ ip
+
+
+
+
+
+
+
+
+ core.powerModules.olimex.powerOlimex::port
+ port
+
+
+
+
+
+
+
+
+ core.powerModules.olimex.powerOlimex::relay
+ relay
+
+
+
+
+
+
+
+
+ core.powerModules.olimex.powerOlimex::telnet
+ telnet
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.olimex.powerOlimex.__init__
+ (self, log, ip, port, relay)
+ __init__
+ self
+ self
+
+ log
+ log
+
+ ip
+ ip
+
+ port
+ port
+
+ relay
+ relay
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.olimex.powerOlimex.command
+ (self, cmd)
+ command
+ self
+ self
+
+ cmd
+ cmd
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.olimex.powerOlimex.powerOff
+ (self)
+ powerOff
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.olimex.powerOlimex.powerOn
+ (self)
+ powerOn
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.olimex.powerOlimex.reboot
+ (self)
+ reboot
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ core::powerModules::olimex::powerOlimex __init__ core::powerModules::olimex::powerOlimex command core::powerModules::olimex::powerOlimex ip core::powerModules::olimex::powerOlimex log core::powerModules::olimex::powerOlimex port core::powerModules::olimex::powerOlimex powerOff core::powerModules::olimex::powerOlimex powerOn core::powerModules::olimex::powerOlimex reboot core::powerModules::olimex::powerOlimex relay core::powerModules::olimex::powerOlimex telnet
+
+
diff --git a/docs/doxygen/xml/classcore_1_1rackController_1_1configDecoderClass.xml b/docs/doxygen/xml/classcore_1_1rackController_1_1configDecoderClass.xml
new file mode 100644
index 0000000..f1fda50
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1rackController_1_1configDecoderClass.xml
@@ -0,0 +1,157 @@
+
+
+
+ core::rackController::configDecoderClass
+ core.rackController.rack
+ core.rackController.rackSlot
+
+
+ def
+ def core.rackController.configDecoderClass.__init__
+ (self)
+ __init__
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.configDecoderClass.checkRequiredField
+ (self, config, name)
+ checkRequiredField
+ self
+ self
+
+ config
+ config
+
+ name
+ name
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.configDecoderClass.decodeConfigItem
+ (self, config, value, nameTable)
+ decodeConfigItem
+ self
+ self
+
+ config
+ config
+
+ value
+ value
+
+ nameTable
+ nameTable
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.configDecoderClass.setConfigValue
+ (self, name, value)
+ setConfigValue
+ self
+ self
+
+ name
+ name
+
+ value
+ value
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.configDecoderClass.dumpValue
+ (self, x)
+ dumpValue
+ self
+ self
+
+ x
+ x
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ core.rackController.rack
+
+
+
+
+ core.rackController.rackSlot
+
+
+
+
+ core.rackController.configDecoderClass
+
+
+
+ core::rackController::configDecoderClass __init__ core::rackController::configDecoderClass checkRequiredField core::rackController::configDecoderClass decodeConfigItem core::rackController::configDecoderClass dumpValue core::rackController::configDecoderClass setConfigValue
+
+
diff --git a/docs/doxygen/xml/classcore_1_1rackController_1_1rack.xml b/docs/doxygen/xml/classcore_1_1rackController_1_1rack.xml
new file mode 100644
index 0000000..5a7ed60
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1rackController_1_1rack.xml
@@ -0,0 +1,167 @@
+
+
+
+ core::rackController::rack
+ core.rackController.configDecoderClass
+
+
+ list
+ list core.rackController.rack::slot
+ slot
+ = []
+
+
+
+
+
+
+
+
+
+
+ core.rackController.rack::log
+ log
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rack.__init__
+ (self, log=None)
+ __init__
+ self
+ self
+
+ log
+ log
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rack.addSlot
+ (self, rackSlot)
+ addSlot
+ self
+ self
+
+ [rackSlot]rackSlot
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rack.getSlot
+ (self, slotIndex)
+ getSlot
+ self
+ self
+
+ slotIndex
+ slotIndex
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rack.getSlotByName
+ (self, slotName)
+ getSlotByName
+ self
+ self
+
+ slotName
+ slotName
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ core.rackController.rack
+
+
+
+
+ core.rackController.configDecoderClass
+
+
+
+
+ core.rackController.rack
+
+
+
+
+ core.rackController.configDecoderClass
+
+
+
+ core::rackController::rack __init__ core::rackController::rack __init__ core::rackController::rack addSlot core::rackController::rack checkRequiredField core::rackController::rack decodeConfigItem core::rackController::rack dumpValue core::rackController::rack getSlot core::rackController::rack getSlotByName core::rackController::rack log core::rackController::rack setConfigValue core::rackController::rack slot
+
+
diff --git a/docs/doxygen/xml/classcore_1_1rackController_1_1rackController.xml b/docs/doxygen/xml/classcore_1_1rackController_1_1rackController.xml
new file mode 100644
index 0000000..ef24941
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1rackController_1_1rackController.xml
@@ -0,0 +1,195 @@
+
+
+
+ core::rackController::rackController
+
+
+ list
+ list core.rackController.rackController::racks
+ racks
+ = []
+
+
+
+
+
+
+
+
+ string
+ string core.rackController.rackController::description
+ description
+ = ""
+
+
+
+
+
+
+
+
+
+
+ core.rackController.rackController::log
+ log
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rackController.decodeRackConfig
+ (self, rackConfig)
+ decodeRackConfig
+ self
+ self
+
+ rackConfig
+ rackConfig
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rackController.__init__
+ (self, config)
+ __init__
+ self
+ self
+
+ config
+ config
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rackController.getRackByName
+ (self, rackName)
+ getRackByName
+ self
+ self
+
+ rackName
+ rackName
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rackController.getRackByIndex
+ (self, rackIndex)
+ getRackByIndex
+ self
+ self
+
+ rackIndex
+ rackIndex
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rackController.getRackServerHostname
+ (self, name)
+ getRackServerHostname
+ self
+ self
+
+ name
+ name
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rackController.getRackDescription
+ (self, name)
+ getRackDescription
+ self
+ self
+
+ name
+ name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ core::rackController::rackController __init__ core::rackController::rackController decodeRackConfig core::rackController::rackController description core::rackController::rackController getRackByIndex core::rackController::rackController getRackByName core::rackController::rackController getRackDescription core::rackController::rackController getRackServerHostname core::rackController::rackController log core::rackController::rackController racks
+
+
diff --git a/docs/doxygen/xml/classcore_1_1rackController_1_1rackSlot.xml b/docs/doxygen/xml/classcore_1_1rackController_1_1rackSlot.xml
new file mode 100644
index 0000000..1e1fba8
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1rackController_1_1rackSlot.xml
@@ -0,0 +1,385 @@
+
+
+
+ core::rackController::rackSlot
+ core.rackController.configDecoderClass
+
+
+ core.rackController.rackSlot::config
+ config
+ = dict()
+
+
+
+
+
+
+
+
+
+
+ core.rackController.rackSlot::log
+ log
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rackSlot.__init__
+ (self, dict config, logModule log=None)
+ __init__
+ self
+ self
+
+ dict
+ config
+
+ logModule
+ log
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rackSlot.getDevice
+ (self, deviceName)
+ getDevice
+ self
+ self
+
+ deviceName
+ deviceName
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rackSlot.find_name
+ (self, table, name)
+ find_name
+ self
+ self
+
+ table
+ table
+
+ name
+ name
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rackSlot.get
+ (self)
+ get
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rackSlot.getName
+ (self)
+ getName
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rackSlot.getRackName
+ (self)
+ getRackName
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rackSlot.setRackName
+ (self, rackName)
+ setRackName
+ self
+ self
+
+ rackName
+ rackName
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rackSlot.getRemoteKeyType
+ (self, deviceName="dut")
+ getRemoteKeyType
+ self
+ self
+
+ deviceName
+ deviceName
+ "dut"
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rackSlot.getDeviceAddress
+ (self, deviceName="dut")
+ getDeviceAddress
+ self
+ self
+
+ deviceName
+ deviceName
+ "dut"
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rackSlot.getDeviceIp
+ (self, deviceName="dut")
+ getDeviceIp
+ self
+ self
+
+ deviceName
+ deviceName
+ "dut"
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rackSlot.getPlatform
+ (self, deviceName="dut")
+ getPlatform
+ self
+ self
+
+ deviceName
+ deviceName
+ "dut"
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rackSlot.getOutboundUploadDirectory
+ (self, deviceName="dut")
+ getOutboundUploadDirectory
+ self
+ self
+
+ deviceName
+ deviceName
+ "dut"
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rackSlot.getOutboundDownloadDirectory
+ (self, deviceName="dut")
+ getOutboundDownloadDirectory
+ self
+ self
+
+ deviceName
+ deviceName
+ "dut"
+
+
+
+
+
+
+
+
+
+ def
+ def core.rackController.rackSlot.show
+ (self)
+ show
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ core.rackController.rackSlot
+
+
+
+
+ core.rackController.configDecoderClass
+
+
+
+
+ core.rackController.rackSlot
+
+
+
+
+ core.rackController.configDecoderClass
+
+
+
+ core::rackController::rackSlot __init__ core::rackController::rackSlot __init__ core::rackController::rackSlot checkRequiredField core::rackController::rackSlot config core::rackController::rackSlot decodeConfigItem core::rackController::rackSlot dumpValue core::rackController::rackSlot find_name core::rackController::rackSlot get core::rackController::rackSlot getDevice core::rackController::rackSlot getDeviceAddress core::rackController::rackSlot getDeviceIp core::rackController::rackSlot getName core::rackController::rackSlot getOutboundDownloadDirectory core::rackController::rackSlot getOutboundUploadDirectory core::rackController::rackSlot getPlatform core::rackController::rackSlot getRackName core::rackController::rackSlot getRemoteKeyType core::rackController::rackSlot log core::rackController::rackSlot setConfigValue core::rackController::rackSlot setRackName core::rackController::rackSlot show
+
+
diff --git a/docs/doxygen/xml/classcore_1_1rcCodes_1_1rcCode.xml b/docs/doxygen/xml/classcore_1_1rcCodes_1_1rcCode.xml
new file mode 100644
index 0000000..a7bb2f2
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1rcCodes_1_1rcCode.xml
@@ -0,0 +1,1313 @@
+
+
+
+ core::rcCodes::rcCode
+ Enum
+
+
+ string
+ string core.rcCodes.rcCode::NUM_0
+ NUM_0
+ = "0x00"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::NUM_1
+ NUM_1
+ = "0x01"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::NUM_2
+ NUM_2
+ = "0x02"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::NUM_3
+ NUM_3
+ = "0x03"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::NUM_4
+ NUM_4
+ = "0x04"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::NUM_5
+ NUM_5
+ = "0x05"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::NUM_6
+ NUM_6
+ = "0x06"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::NUM_7
+ NUM_7
+ = "0x07"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::NUM_8
+ NUM_8
+ = "0x08"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::NUM_9
+ NUM_9
+ = "0x09"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::POWER
+ POWER
+ = "0x0C"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::MUTE
+ MUTE
+ = "0x0D"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::VOL_UP
+ VOL_UP
+ = "0x10"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::VOL_DOWN
+ VOL_DOWN
+ = "0x11"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::CHANNEL_UP
+ CHANNEL_UP
+ = "0x20"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::CHANNEL_DOWN
+ CHANNEL_DOWN
+ = "0x21"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::PAUSE
+ PAUSE
+ = "0x24"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::FFWD
+ FFWD
+ = "0x28"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::FORWARD
+ FORWARD
+ = "0x28"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::FFORWARD
+ FFORWARD
+ = "0x28"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::AUDDESC
+ AUDDESC
+ = "0x2D"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::SUBT
+ SUBT
+ = "0x2E"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::REWIND
+ REWIND
+ = "0x3D"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::PLAY
+ PLAY
+ = "0x3E"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::STOP
+ STOP
+ = "0x3F"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::RECORD
+ RECORD
+ = "0x40"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::LOBATT
+ LOBATT
+ = "0x47"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::UP
+ UP
+ = "0x58"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::DOWN
+ DOWN
+ = "0x59"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::LEFT
+ LEFT
+ = "0x5A"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::RIGHT
+ RIGHT
+ = "0x5B"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::SELECT
+ SELECT
+ = "0x5C"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::RED
+ RED
+ = "0x6D"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::GREEN
+ GREEN
+ = "0x6E"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::YELLOW
+ YELLOW
+ = "0x6F"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::BLUE
+ BLUE
+ = "0x70"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::SEARCH
+ SEARCH
+ = "0x7E"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::SKY
+ SKY
+ = "0x80"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::HELP
+ HELP
+ = "0x81"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::BACKUP
+ BACKUP
+ = "0x83"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::EXIT
+ EXIT
+ = "0xCE"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::HOME
+ HOME
+ = "0xCC"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::APPS
+ APPS
+ = "0xF5"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::BACK
+ BACK
+ = "BACK"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::CROSS
+ CROSS
+ = "CROSS"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::MIC
+ MIC
+ = "MIC"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::RGYB
+ RGYB
+ = "RGYB"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::PICK_UP
+ PICK_UP
+ = "PICK_UP"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::TEST
+ TEST
+ = "TEST"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::RST
+ RST
+ = "RST"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::FAC
+ FAC
+ = "FAC"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::CSM
+ CSM
+ = "CSM"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::PATTERN
+ PATTERN
+ = "PATTERN"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::ANTENNA_CABLE
+ ANTENNA_CABLE
+ = "ANTENNA_CABLE"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::PRE_CH
+ PRE_CH
+ = "PRE_CH"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::VOL_MAX
+ VOL_MAX
+ = "VOL_MAX"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::CTC
+ CTC
+ = "CTC"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::VOL_BUZZ
+ VOL_BUZZ
+ = "VOL_BUZZ"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::MENU
+ MENU
+ = "MENU"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::BI
+ BI
+ = "BI"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::CH_SCAN
+ CH_SCAN
+ = "CH_SCAN"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::CCTT
+ CCTT
+ = "CCTT"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::PIC
+ PIC
+ = "PIC"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::LOG_LED
+ LOG_LED
+ = "LOG_LED"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::AUDIO
+ AUDIO
+ = "AUDIO"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::D2D3
+ D2D3
+ = "D2D3"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::ARC
+ ARC
+ = "ARC"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::CIP
+ CIP
+ = "CIP"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::VIRGIN
+ VIRGIN
+ = "VIRGIN"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::CVBS
+ CVBS
+ = "CVBS"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::YPBPR_SCART
+ YPBPR_SCART
+ = "YPBPR_SCART"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::HDMI
+ HDMI
+ = "HDMI"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::VGA
+ VGA
+ = "VGA"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::REGIN
+ REGIN
+ = "REGIN"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::CLONE
+ CLONE
+ = "CLONE"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::RESERVE1
+ RESERVE1
+ = "RESERVE1"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::DCR
+ DCR
+ = "DCR"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::WIFI_SSID
+ WIFI_SSID
+ = "WIFI_SSID"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::BLK
+ BLK
+ = "BLK"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::WP
+ WP
+ = "WP"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::LIGHT_SENSOR
+ LIGHT_SENSOR
+ = "LIGHT_SENSOR"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::USB
+ USB
+ = "USB"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::RJ45
+ RJ45
+ = "RJ45"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::RS232
+ RS232
+ = "RS232"
+
+
+
+
+
+
+
+
+ string
+ string core.rcCodes.rcCode::RESERVE2
+ RESERVE2
+ = "RESERVE2"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ core.rcCodes.rcCode
+
+
+
+
+ Enum
+
+
+
+
+ core.rcCodes.rcCode
+
+
+
+
+ Enum
+
+
+
+ core::rcCodes::rcCode ANTENNA_CABLE core::rcCodes::rcCode APPS core::rcCodes::rcCode ARC core::rcCodes::rcCode AUDDESC core::rcCodes::rcCode AUDIO core::rcCodes::rcCode BACK core::rcCodes::rcCode BACKUP core::rcCodes::rcCode BI core::rcCodes::rcCode BLK core::rcCodes::rcCode BLUE core::rcCodes::rcCode CCTT core::rcCodes::rcCode CH_SCAN core::rcCodes::rcCode CHANNEL_DOWN core::rcCodes::rcCode CHANNEL_UP core::rcCodes::rcCode CIP core::rcCodes::rcCode CLONE core::rcCodes::rcCode CROSS core::rcCodes::rcCode CSM core::rcCodes::rcCode CTC core::rcCodes::rcCode CVBS core::rcCodes::rcCode D2D3 core::rcCodes::rcCode DCR core::rcCodes::rcCode DOWN core::rcCodes::rcCode EXIT core::rcCodes::rcCode FAC core::rcCodes::rcCode FFORWARD core::rcCodes::rcCode FFWD core::rcCodes::rcCode FORWARD core::rcCodes::rcCode GREEN core::rcCodes::rcCode HDMI core::rcCodes::rcCode HELP core::rcCodes::rcCode HOME core::rcCodes::rcCode LEFT core::rcCodes::rcCode LIGHT_SENSOR core::rcCodes::rcCode LOBATT core::rcCodes::rcCode LOG_LED core::rcCodes::rcCode MENU core::rcCodes::rcCode MIC core::rcCodes::rcCode MUTE core::rcCodes::rcCode NUM_0 core::rcCodes::rcCode NUM_1 core::rcCodes::rcCode NUM_2 core::rcCodes::rcCode NUM_3 core::rcCodes::rcCode NUM_4 core::rcCodes::rcCode NUM_5 core::rcCodes::rcCode NUM_6 core::rcCodes::rcCode NUM_7 core::rcCodes::rcCode NUM_8 core::rcCodes::rcCode NUM_9 core::rcCodes::rcCode PATTERN core::rcCodes::rcCode PAUSE core::rcCodes::rcCode PIC core::rcCodes::rcCode PICK_UP core::rcCodes::rcCode PLAY core::rcCodes::rcCode POWER core::rcCodes::rcCode PRE_CH core::rcCodes::rcCode RECORD core::rcCodes::rcCode RED core::rcCodes::rcCode REGIN core::rcCodes::rcCode RESERVE1 core::rcCodes::rcCode RESERVE2 core::rcCodes::rcCode REWIND core::rcCodes::rcCode RGYB core::rcCodes::rcCode RIGHT core::rcCodes::rcCode RJ45 core::rcCodes::rcCode RS232 core::rcCodes::rcCode RST core::rcCodes::rcCode SEARCH core::rcCodes::rcCode SELECT core::rcCodes::rcCode SKY core::rcCodes::rcCode STOP core::rcCodes::rcCode SUBT core::rcCodes::rcCode TEST core::rcCodes::rcCode UP core::rcCodes::rcCode USB core::rcCodes::rcCode VGA core::rcCodes::rcCode VIRGIN core::rcCodes::rcCode VOL_BUZZ core::rcCodes::rcCode VOL_DOWN core::rcCodes::rcCode VOL_MAX core::rcCodes::rcCode VOL_UP core::rcCodes::rcCode WIFI_SSID core::rcCodes::rcCode WP core::rcCodes::rcCode YELLOW core::rcCodes::rcCode YPBPR_SCART
+
+
diff --git a/docs/doxygen/xml/classcore_1_1testControl_1_1testController.xml b/docs/doxygen/xml/classcore_1_1testControl_1_1testController.xml
new file mode 100644
index 0000000..e1918a7
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1testControl_1_1testController.xml
@@ -0,0 +1,1313 @@
+
+
+
+ core::testControl::testController
+
+
+ core.testControl.testController::slotInfo
+ slotInfo
+ = None
+
+
+
+
+
+
+
+
+ core.testControl.testController::log
+ log
+ = None
+
+
+
+
+
+
+
+
+ core.testControl.testController::session
+ session
+ = None
+
+
+
+
+
+
+
+
+ core.testControl.testController::fullPath
+ fullPath
+ = None
+
+
+
+
+
+
+
+
+ bool
+ bool core.testControl.testController::testMode
+ testMode
+ = False
+
+
+
+
+
+
+
+
+ int
+ int core.testControl.testController::loopCount
+ loopCount
+ = 0
+
+
+
+
+
+
+
+
+ tuple
+ tuple core.testControl.testController::TEST_MAX_RUN_TIME
+ TEST_MAX_RUN_TIME
+ = (60*60*24*30)
+
+
+
+
+
+
+
+
+ core.testControl.testController::pingStartTime
+ pingStartTime
+ = time.time()
+
+
+
+
+
+
+
+
+ core.testControl.testController::timeString
+ timeString
+ = time.strftime("%H:%M:%S",time.gmtime(pingStartTime))
+
+
+
+
+
+
+
+
+ core.testControl.testController::alive
+ alive
+
+
+
+
+
+
+
+
+ core.testControl.testController::elapsed_time
+ elapsed_time
+ = time.time() - pingStartTime
+
+
+
+
+
+
+
+
+ core.testControl.testController::elasped_string
+ elasped_string
+ = time.strftime( "%H:%M:%S", time.gmtime(elapsed_time))
+
+
+
+
+
+
+
+
+
+
+ core.testControl.testController::testStartTime
+ testStartTime
+
+
+
+
+
+
+
+
+ core.testControl.testController::summaryLog
+ summaryLog
+
+
+
+
+
+
+
+
+ core.testControl.testController::summaryLogCreated
+ summaryLogCreated
+
+
+
+
+
+
+
+
+ core.testControl.testController::maxRunTime
+ maxRunTime
+
+
+
+
+
+
+
+
+ core.testControl.testController::loopCount
+ loopCount
+
+
+
+
+
+
+
+
+ core.testControl.testController::result
+ result
+
+
+
+
+
+
+
+
+ core.testControl.testController::testName
+ testName
+
+
+
+
+
+
+
+
+ core.testControl.testController::qcId
+ qcId
+
+
+
+
+
+
+
+
+ core.testControl.testController::capture
+ capture
+
+
+
+
+
+
+
+
+ core.testControl.testController::webpageController
+ webpageController
+
+
+
+
+
+
+
+
+ core.testControl.testController::config
+ config
+
+
+
+
+
+
+
+
+ core.testControl.testController::rackControl
+ rackControl
+
+
+
+
+
+
+
+
+ core.testControl.testController::deviceConfig
+ deviceConfig
+
+
+
+
+
+
+
+
+ core.testControl.testController::testMode
+ testMode
+
+
+
+
+
+
+
+
+ core.testControl.testController::logConfig
+ logConfig
+
+
+
+
+
+
+
+
+ core.testControl.testController::logPath
+ logPath
+
+
+
+
+
+
+
+
+ core.testControl.testController::testLogPath
+ testLogPath
+
+
+
+
+
+
+
+
+ core.testControl.testController::devices
+ devices
+
+
+
+
+
+
+
+
+ core.testControl.testController::dut
+ dut
+
+
+
+
+
+
+
+
+ core.testControl.testController::outboundClient
+ outboundClient
+
+
+
+
+
+
+
+
+ core.testControl.testController::powerControl
+ powerControl
+
+
+
+
+
+
+
+
+ core.testControl.testController::commonRemote
+ commonRemote
+
+
+
+
+
+
+
+
+ core.testControl.testController::utils
+ utils
+
+
+
+
+
+
+
+
+ core.testControl.testController::cpe
+ cpe
+
+
+
+
+
+
+
+
+ core.testControl.testController::webDriverConfig
+ webDriverConfig
+
+
+
+
+
+
+
+
+ core.testControl.testController::buildConfig
+ buildConfig
+
+
+
+
+
+
+
+
+ core.testControl.testController::overrideCpeConfig
+ overrideCpeConfig
+
+
+
+
+
+
+
+
+ core.testControl.testController::output
+ output
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.testControl.testController.__init__
+ (self, testName="", qcId="", maxRunTime=TEST_MAX_RUN_TIME, level=logModule.STEP, loop=1, log=None)
+ __init__
+ self
+ self
+
+ testName
+ testName
+ ""
+
+ qcId
+ qcId
+ ""
+
+ maxRunTime
+ maxRunTime
+ TEST_MAX_RUN_TIME
+
+ level
+ level
+ logModule.STEP
+
+ loop
+ loop
+ 1
+
+ log
+ log
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def core.testControl.testController.addDelimiter
+ (self, path)
+ addDelimiter
+ self
+ self
+
+ path
+ path
+
+
+
+
+
+
+
+
+
+ def
+ def core.testControl.testController.constructLogPath
+ (self, rackName, slotName)
+ constructLogPath
+ self
+ self
+
+ rackName
+ rackName
+
+ slotName
+ slotName
+
+
+
+
+Construct the path required for all Logs
+
+ localLogs/
+ └── rackName
+└── slotName
+ └── 210629-10:00:00.0000 -> logPath
+ since the directory has the time in it to the second it's unique
+
+Args:
+Returns:
+ [string]: [string with added delimiter if required]
+
+
+
+
+
+ def
+ def core.testControl.testController.constructTestPath
+ (self)
+ constructTestPath
+ self
+ self
+
+
+
+
+Construst the path required for all Logs
+
+ localLogs/
+ └── rackName
+└── slotName -> logPath
+ └── 210629-10:00:00.0000 -> logPath
+ └── testName:xx-testId:xx -> testPath
+ ├── serial.log
+ └── test.log
+ since the directory has the time in it to the second it's unique
+
+Args:
+Returns:
+ [string]: [string with added delimiter if required]
+
+
+
+
+
+ def
+ def core.testControl.testController.waitForBoot
+ (self)
+ waitForBoot
+ self
+ self
+
+
+
+
+[wait for the system to boot]
+ Actual functionality is depending on the parent class
+Returns:
+ [bool]: [True if system booted]
+
+
+
+
+
+ def
+ def core.testControl.testController.testFunction
+ (self)
+ testFunction
+ self
+ self
+
+
+
+
+Executes the main actions for performing the test.
+
+Should be overloaded in the test script to contain the main actions executed during the rest. Is run in stressTest.run()
+
+Returns:
+ True / False
+
+
+
+
+
+ def
+ def core.testControl.testController.testPrepareFunction
+ (self)
+ testPrepareFunction
+ self
+ self
+
+
+
+
+Executes the pre-test setup
+
+Should be overloaded in the test scrip to execute all necessary pre-test setup. Is run in stressTest.run() and is not part of the main test loop.
+
+Returns:
+ True / False
+
+
+
+
+
+ def
+ def core.testControl.testController.testEndFunction
+ (self, powerOff=True)
+ testEndFunction
+ self
+ self
+
+ powerOff
+ powerOff
+ True
+
+
+
+
+Close device sessions and release the resources used for test execution
+Args:
+ powerOff( bool ): Default True, power off after test
+
+
+
+
+
+ def
+ def core.testControl.testController.testExceptionCleanUp
+ (self)
+ testExceptionCleanUp
+ self
+ self
+
+
+
+
+Cleans up a test if required by the test
+
+
+
+
+
+ def
+ def core.testControl.testController.waitSeconds
+ (self, seconds, startMessage=True, endMessage=False)
+ waitSeconds
+ self
+ self
+
+ seconds
+ seconds
+
+ startMessage
+ startMessage
+ True
+
+ endMessage
+ endMessage
+ False
+
+
+
+
+Sleep the test for a number of seconds
+
+Args:
+ seconds (_type_): number of sections to wait
+ startMessage (bool, optional): display a start message. Defaults to False.
+ endMessage (bool, optional): display an end message. Defaults to False.
+
+
+
+
+
+ def
+ def core.testControl.testController.waitForSessionMessage
+ (self, message)
+ waitForSessionMessage
+ self
+ self
+
+ message
+ message
+
+
+
+
+User friendly function to Wait for the given message or timeout as required
+
+Args:
+ message ([string): [message to wait for]
+
+Returns:
+ result (boolean)
+
+
+
+
+
+ def
+ def core.testControl.testController.writeMessageToSession
+ (self, message)
+ writeMessageToSession
+ self
+ self
+
+ message
+ message
+
+
+
+
+User friendly function to write a message to the current session
+
+Args:
+ message ([string]): [Write to the session]
+
+
+
+
+
+ def
+ def core.testControl.testController.programOutboundWithValidImage
+ (self, sourceImageType, destinationImageType=None)
+ programOutboundWithValidImage
+ self
+ self
+
+ sourceImageType
+ sourceImageType
+
+ destinationImageType
+ destinationImageType
+ None
+
+
+
+
+program an image from the valid list based on platform
+
+Args:
+ sourceImageType ([string]): [PCI1, PCI2, PDRI, BDRI etc. based on test_config.yml image types ]
+ destinationImageType ([string]): [PCI1, PCI2, PDRI, BDRI etc.]
+
+
+
+
+
+ def
+ def core.testControl.testController.processBuildConfiguration
+ (self, inputUrl)
+ processBuildConfiguration
+ self
+ self
+
+ inputUrl
+ inputUrl
+
+
+
+
+Downloads and retrives information from config file at inputUrl
+
+Args:
+ inputUrl (url) - location of config file
+
+Returns:
+ outputDict (dict) - dictionary decoded from config file
+
+
+
+
+
+ def
+ def core.testControl.testController.validatePlatform
+ (self, platform)
+ validatePlatform
+ self
+ self
+
+ platform
+ platform
+
+
+
+
+Validate the platform by comparing it against platform and alternative platform
+
+Args:
+ platform (str)
+
+Returns:
+ result (boolean)
+
+
+
+
+
+ def
+ def core.testControl.testController.run
+ (self, powerOff=True)
+ run
+ self
+ self
+
+ powerOff
+ powerOff
+ True
+
+
+
+
+Run the test
+Check if the box is alive, before we start our testing. If the box hasn't responded at this point we, cannot run the test.
+Args:
+ powerOff (bool, optional): don't turn off the power after the test completes. Defaults to True.
+
+Returns:
+ _type_: TRUE - on test pass, otherwise failure
+
+
+
+
+
+ def
+ def core.testControl.testController.parseException
+ (self, exception)
+ parseException
+ self
+ self
+
+ exception
+ exception
+
+
+
+
+Parses an exception into the a dictionary to get the, exception thrown and the file, line and method it was thrown on
+
+Args:
+ exception (String): An exception as generated by traceback.format_exc()
+
+Returns:
+ dict: _description_
+
+
+
+
+
+ def
+ def core.testControl.testController.signal_handler
+ (self, signal, frame)
+ signal_handler
+ self
+ self
+
+ signal
+ signal
+
+ frame
+ frame
+
+
+
+
+Signal handler support for CTRL-C
+
+Args:
+ signal (_type_): signal input
+ frame (_type_): signal frame
+
+
+
+
+
+ def
+ def core.testControl.testController.runHostCommand
+ (self, command, supressErrors=False, supressOutput=False, supress=False)
+ runHostCommand
+ self
+ self
+
+ command
+ command
+
+ supressErrors
+ supressErrors
+ False
+
+ supressOutput
+ supressOutput
+ False
+
+ supress
+ supress
+ False
+
+
+
+
+Run a host command
+
+Args:
+ command (_type_): command to run
+ supressErrors (bool, optional): suppress all errors. Defaults to False.
+ supressOutput (bool, optional): suppress the output. Defaults to False.
+ supress (bool, optional): suppre. Defaults to False.
+
+Returns:
+ _type_: anyh errors listed
+
+
+
+
+
+ def
+ def core.testControl.testController.syscmd
+ (self, cmd, encoding='', returnCode=False)
+ syscmd
+ self
+ self
+
+ cmd
+ cmd
+
+ encoding
+ encoding
+ ''
+
+ returnCode
+ returnCode
+ False
+
+
+
+
+Runs a command on the system, waits for the command to finish, and then
+ returns the text output of the command. If the command produces no text
+ output, the command's return code will be returned instead.
+
+Args:
+ cmd (string): command
+ encoding (str, optional): encoding required. Defaults to ''.
+ returnCode (bool, optional): check for return codes. Defaults to False.
+
+Returns:
+ string: command result
+
+
+
+
+
+ def
+ def core.testControl.testController.pingTest
+ (self, deviceName="dut", logPingTime=False)
+ pingTest
+ self
+ self
+
+ deviceName
+ deviceName
+ "dut"
+
+ logPingTime
+ logPingTime
+ False
+
+
+
+
+
+
+
+
+
+ def
+ def core.testControl.testController.waitForPrompt
+ (self, prompt=None)
+ waitForPrompt
+ self
+ self
+
+ prompt
+ prompt
+ None
+
+
+
+
+ This function must wait for the first log prompt to denote that the target is booted.
+ Try for every 10 seconds and read the console for the prompt. If a prompt presents, the box booted successfully, if not retry
+ maximum time limit is 2 minutes and the reports box is not in proper state.
+
+
+
+
+
+
+
+ def
+ def core.testControl.testController._pingTestOnly
+ (self, deviceName="dut")
+ _pingTestOnly
+ self
+ self
+
+ deviceName
+ deviceName
+ "dut"
+
+
+
+
+perform a ping test against the given device
+
+Args:
+ deviceName (string): device from the configuration to ping
+
+Returns:
+ bool: TRUE - host is up, otherwise host is down
+
+
+
+
+
+
+
+
+
+
+ core::testControl::testController __init__ core::testControl::testController _pingTestOnly core::testControl::testController addDelimiter core::testControl::testController alive core::testControl::testController buildConfig core::testControl::testController capture core::testControl::testController commonRemote core::testControl::testController config core::testControl::testController constructLogPath core::testControl::testController constructTestPath core::testControl::testController cpe core::testControl::testController deviceConfig core::testControl::testController devices core::testControl::testController dut core::testControl::testController elapsed_time core::testControl::testController elasped_string core::testControl::testController fullPath core::testControl::testController log core::testControl::testController logConfig core::testControl::testController logPath core::testControl::testController loopCount core::testControl::testController loopCount core::testControl::testController maxRunTime core::testControl::testController outboundClient core::testControl::testController output core::testControl::testController overrideCpeConfig core::testControl::testController parseException core::testControl::testController pingStartTime core::testControl::testController pingTest core::testControl::testController powerControl core::testControl::testController processBuildConfiguration core::testControl::testController programOutboundWithValidImage core::testControl::testController qcId core::testControl::testController rackControl core::testControl::testController result core::testControl::testController run core::testControl::testController runHostCommand core::testControl::testController session core::testControl::testController signal_handler core::testControl::testController slotInfo core::testControl::testController summaryLog core::testControl::testController summaryLogCreated core::testControl::testController syscmd core::testControl::testController TEST_MAX_RUN_TIME core::testControl::testController testEndFunction core::testControl::testController testExceptionCleanUp core::testControl::testController testFunction core::testControl::testController testLogPath core::testControl::testController testMode core::testControl::testController testMode core::testControl::testController testName core::testControl::testController testPrepareFunction core::testControl::testController testStartTime core::testControl::testController timeString core::testControl::testController utils core::testControl::testController validatePlatform core::testControl::testController waitForBoot core::testControl::testController waitForPrompt core::testControl::testController waitForSessionMessage core::testControl::testController waitSeconds core::testControl::testController webDriverConfig core::testControl::testController webpageController core::testControl::testController writeMessageToSession
+
+
diff --git a/docs/doxygen/xml/classcore_1_1utilities_1_1utilities.xml b/docs/doxygen/xml/classcore_1_1utilities_1_1utilities.xml
new file mode 100644
index 0000000..51736a2
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1utilities_1_1utilities.xml
@@ -0,0 +1,150 @@
+
+
+
+ core::utilities::utilities
+
+
+ core.utilities.utilities::log
+ log
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.utilities.utilities.__init__
+ (self, log)
+ __init__
+ self
+ self
+
+ log
+ log
+
+
+
+
+
+
+
+
+
+ def
+ def core.utilities.utilities.wait
+ (self, seconds, minutes=0, hours=0)
+ wait
+ self
+ self
+
+ seconds
+ seconds
+
+ minutes
+ minutes
+ 0
+
+ hours
+ hours
+ 0
+
+
+
+
+
+
+
+
+
+ def
+ def core.utilities.utilities.fuzzyCompareText
+ (self, expText, actualText, exactMatch=False)
+ fuzzyCompareText
+ self
+ self
+
+ expText
+ expText
+
+ actualText
+ actualText
+
+ exactMatch
+ exactMatch
+ False
+
+
+
+
+
+
+
+
+
+ def
+ def core.utilities.utilities.value1HigherThanValue2
+ (self, value1, value2)
+ value1HigherThanValue2
+ self
+ self
+
+ value1
+ value1
+
+ value2
+ value2
+
+
+
+
+Compares input values and returns result
+
+Args:
+ value1 and value 2 (str) - values to be compared
+
+Returns:
+ result (bool) - True if value1 is higher than value 2 else False
+
+
+
+
+
+
+
+
+
+
+ core::utilities::utilities __init__ core::utilities::utilities fuzzyCompareText core::utilities::utilities log core::utilities::utilities value1HigherThanValue2 core::utilities::utilities wait
+
+
diff --git a/docs/doxygen/xml/classcore_1_1webpageController_1_1webpageController.xml b/docs/doxygen/xml/classcore_1_1webpageController_1_1webpageController.xml
new file mode 100644
index 0000000..9186856
--- /dev/null
+++ b/docs/doxygen/xml/classcore_1_1webpageController_1_1webpageController.xml
@@ -0,0 +1,1407 @@
+
+
+
+ core::webpageController::webpageController
+
+
+ core.webpageController.webpageController::_pages
+ _pages
+
+
+
+
+
+
+
+
+
+
+ core.webpageController.webpageController::webDriver
+ webDriver
+
+
+
+
+
+
+
+
+ core.webpageController.webpageController::log
+ log
+
+
+
+
+
+
+
+
+ core.webpageController.webpageController::currentTab
+ currentTab
+
+
+
+
+
+
+
+
+ core.webpageController.webpageController::currentPage
+ currentPage
+
+
+
+
+
+
+
+
+ core.webpageController.webpageController::currentPageName
+ currentPageName
+
+
+
+
+
+
+
+
+ core.webpageController.webpageController::currentView
+ currentView
+
+
+
+
+
+
+
+
+ core.webpageController.webpageController::defaultView
+ defaultView
+
+
+
+
+
+
+
+
+ core.webpageController.webpageController::tabs
+ tabs
+
+
+
+
+
+
+
+
+ core.webpageController.webpageController::url
+ url
+
+
+
+
+
+
+
+
+ core.webpageController.webpageController::webpageConfig
+ webpageConfig
+
+
+
+
+
+
+
+
+ core.webpageController.webpageController::globalActions
+ globalActions
+
+
+
+
+
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.__init__
+ (self, log, webDriverConfig, baseUrl=None, webpageConfig=None)
+ __init__
+ self
+ self
+
+ log
+ log
+
+ webDriverConfig
+ webDriverConfig
+
+ baseUrl
+ baseUrl
+ None
+
+ webpageConfig
+ webpageConfig
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.configureWebpages
+ (self, baseUrl, webpageConfig)
+ configureWebpages
+ self
+ self
+
+ baseUrl
+ baseUrl
+
+ webpageConfig
+ webpageConfig
+
+
+
+
+Sets the webpage base url as well as the webpage config if they were not set in the constructor
+
+Args:
+ base_url (str): Base url to navigate to the pages
+ webpageConfig (dict): Dictionary config containing the pages
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.setWebpage
+ (self, pageName)
+ setWebpage
+ self
+ self
+
+ pageName
+ pageName
+
+
+
+
+Tells the controller that the browser is on a different page than what is set in the controller. For use after a redirect
+
+Args:
+ pageName (str): Name of the page that the browser is now on
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.navigateTo
+ (self, pageName)
+ navigateTo
+ self
+ self
+
+ pageName
+ pageName
+
+
+
+
+Navigates the the pageName specified based on the pages config. Then checks the expected elements are present
+
+Args:
+ pageName (str): Name of the page to navigate to based on a key in the pages config
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.pages
+ (self)
+ pages
+ self
+ self
+
+
+
+
+Gets the dictionary of the pages that the webpage config has provided
+
+Returns:
+ dict: Dictionary of the pages that the webpage config has provided
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.performAction
+ (self, actionName, **kwargs)
+ performAction
+ self
+ self
+
+ actionName
+ actionName
+
+ **
+ kwargs
+
+
+
+
+Performs the action that is passed in action name, any additional arguments are subbed into any args values starting with $
+
+Args:
+ actionName (str): The name of the action to perform
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.getTextOfElement
+ (self, elementName)
+ getTextOfElement
+ self
+ self
+
+ elementName
+ elementName
+
+
+
+
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.performInteraction
+ (self, interactionName, elementName=None, args=None)
+ performInteraction
+ self
+ self
+
+ interactionName
+ interactionName
+
+ elementName
+ elementName
+ None
+
+ args
+ args
+ None
+
+
+
+
+Performs a single interaction with the browser based on the type passed
+
+Args:
+ interaction (str): The interaction to perform
+ args (dict): Any arguments to substitute into the interaction
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.performGlobalAction
+ (self, globalActionName, **kwargs)
+ performGlobalAction
+ self
+ self
+
+ globalActionName
+ globalActionName
+
+ **
+ kwargs
+
+
+
+
+Performs a global action
+
+Args:
+ globalActionName (String): Name of the action to perform
+ kwargs: Variable number of optional arguments for the actions
+
+Raises:
+ Exception: If webpage config does not contain any global action
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.getElementAttribute
+ (self, elementName, attributeName)
+ getElementAttribute
+ self
+ self
+
+ elementName
+ elementName
+
+ attributeName
+ attributeName
+
+
+
+
+Gets the value of the element attribute specified
+
+Args:
+ elementName (String): Name of element
+ attributeName (String): Name of attribute
+
+Returns:
+ String: Value of attribute
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.isElementSelected
+ (self, elementName)
+ isElementSelected
+ self
+ self
+
+ elementName
+ elementName
+
+
+
+
+Returns whether the element is selected or not
+
+Args:
+ elementName (String): Name of element
+
+Returns:
+ Boolean: Whether the element is selected or not
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.getSelectedOptions
+ (self, elementName)
+ getSelectedOptions
+ self
+ self
+
+ elementName
+ elementName
+
+
+
+
+Gets all of the options of the select element that are currently selected
+
+Args:
+ elementName (String): Name of element
+
+Returns:
+ List of Strings: Text content of the elements that are selected
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.getFirstSelectedOption
+ (self, elementName)
+ getFirstSelectedOption
+ self
+ self
+
+ elementName
+ elementName
+
+
+
+
+Gets the first option that is selected
+
+Args:
+ elementName (String): Name of element
+
+Returns:
+ Strings: Text content of the first element selected
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.getSelectAvailableOptions
+ (self, elementName)
+ getSelectAvailableOptions
+ self
+ self
+
+ elementName
+ elementName
+
+
+
+
+Gets the list of all of the available options that could be selected
+
+Args:
+ elementName (String): Name of element
+
+Returns:
+ List of Strings: Text content of all elements that could be selected
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.getUrl
+ (self)
+ getUrl
+ self
+ self
+
+
+
+
+Gets the url of the current webpage open
+
+Returns:
+ String: Url of the webpage that is open
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.getAlertText
+ (self)
+ getAlertText
+ self
+ self
+
+
+
+
+Gets the text of an open web alert box
+
+Returns:
+ String: Content of the alert box if it is open, None otherwise
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.closeBrowser
+ (self)
+ closeBrowser
+ self
+ self
+
+
+
+
+Ends webdriver session and closes browser
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.saveScreenshot
+ (self, fileName)
+ saveScreenshot
+ self
+ self
+
+ fileName
+ fileName
+
+
+
+
+Saves a screenshot of the current browser view to the fileName specified the tests log folder
+
+Args:
+ fileName (String): The fileName to save the screenshot to. It will be saved as a .png file
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.saveHtmlSnapshot
+ (self, fileName)
+ saveHtmlSnapshot
+ self
+ self
+
+ fileName
+ fileName
+
+
+
+
+Saves a copy of the html of the current page the webpageController is on to the test log folder
+
+Args:
+ fileName (String): The fileName to save the html to
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.getDynamicTable
+ (self, elementName, text=None)
+ getDynamicTable
+ self
+ self
+
+ elementName
+ elementName
+
+ text
+ text
+ None
+
+
+
+
+Gets the elements of the table as a list of lists
+
+Args:
+ elementName (String): dynamic table name
+ text(bool): Text attribute indicator of the web element. Set to True to retreive text attribute of the webelement, defaults to None
+Returns:
+ list: list of list of dictionaries with element details
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.getDynamicTableText
+ (self, elementName)
+ getDynamicTableText
+ self
+ self
+
+ elementName
+ elementName
+
+
+
+
+Gets the text of elements in the table as a list of list of dictionaries, with corresponding element details
+
+Args:
+ elementName (String): dynamic table name
+
+Returns:
+ list: list of list of dictionaries with element details - type, value, text, elementName
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.removeTemporaryWebElements
+ (self)
+ removeTemporaryWebElements
+ self
+ self
+
+
+
+
+Removes list of temporary elements added to page's elements dictionary
+
+
+
+
+ def
+ def core.webpageController.webpageController.createNewTab
+ (self, tabName, baseUrl, webpageConfig)
+ createNewTab
+ self
+ self
+
+ tabName
+ tabName
+
+ baseUrl
+ baseUrl
+
+ webpageConfig
+ webpageConfig
+
+
+
+
+Creates a new tab and switches the webpageController to that tab
+
+Args:
+ tabName (String): Name of the tab to create. Will be used to switch back to it
+ baseUrl (String): Base url for the webpage config
+ webpageConfig (Dict): A dictionary of the webpage config ymls
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.switchTab
+ (self, tabName)
+ switchTab
+ self
+ self
+
+ tabName
+ tabName
+
+
+
+
+Switches the browser and webpageController to the tab specified. The original tab is named `default`
+
+Args:
+ tabName (String): Name of the tab to switch to
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.getTabs
+ (self)
+ getTabs
+ self
+ self
+
+
+
+
+Returns a list of the tab names that have been created
+
+Returns:
+ List(String): A list of tab names that have been created
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.getTab
+ (self, tabName)
+ getTab
+ self
+ self
+
+ tabName
+ tabName
+
+
+
+
+Gets a dictionary of the pageName and windowId of the tab specified by name
+
+Args:
+ tabName (String): Name of tab
+
+Returns:
+ Dict: A dictionary with `pageName` and `windowId` keys
+
+
+
+
+
+ def
+ def core.webpageController.webpageController.getSubElements
+ (self, elementName)
+ getSubElements
+ self
+ self
+
+ elementName
+ elementName
+
+
+
+
+Returns a list of elementNames for the subElements of the element passed
+
+Args:
+ elementName (String): Name of element
+
+Returns:
+ list: A list of element names that will now be included in as temporary elements in the webpageControllers config
+
+
+
+
+
+
+ def
+ def core.webpageController.webpageController._setBaseUrl
+ (self, baseUrl)
+ _setBaseUrl
+ self
+ self
+
+ baseUrl
+ baseUrl
+
+
+
+
+Sets the base url for the controller to use
+
+Args:
+ base_url (str): Base url to navigate to the pages
+
+
+
+
+
+ def
+ def core.webpageController.webpageController._setWebpageConfig
+ (self, webpageConfig)
+ _setWebpageConfig
+ self
+ self
+
+ webpageConfig
+ webpageConfig
+
+
+
+
+Sets the pages that the webpage controller has access to from the webpage config
+
+Args:
+ webpageConfig (dict): Dictionary config containing the pages
+
+
+
+
+
+ def
+ def core.webpageController.webpageController._isConfigured
+ (self)
+ _isConfigured
+ self
+ self
+
+
+
+
+Checks that the controller is configured with a url and dict of pages
+
+Raises:
+ Exception: If not configured
+
+
+
+
+
+ def
+ def core.webpageController.webpageController._isOnPage
+ (self)
+ _isOnPage
+ self
+ self
+
+
+
+
+Checks that the controller is on a page
+
+Raises:
+ Exception: If not on a page
+
+
+
+
+
+ def
+ def core.webpageController.webpageController._navigateSequence
+ (self, sequence)
+ _navigateSequence
+ self
+ self
+
+ sequence
+ sequence
+
+
+
+
+Navigates through a sequence that is passed in
+
+Args:
+ sequence (dict): A dictionary containing the webpage to navigate to and sequence of interactions within that webpage to perform
+
+
+
+
+
+ def
+ def core.webpageController.webpageController._checkElements
+ (self, elements)
+ _checkElements
+ self
+ self
+
+ elements
+ elements
+
+
+
+
+Checks that the browser has all of the elements expected based on the current page
+
+Raises:
+ Exception: If the webpageController does not have a current page
+
+
+
+
+
+ def
+ def core.webpageController.webpageController._validateView
+ (self, viewName="default")
+ _validateView
+ self
+ self
+
+ viewName
+ viewName
+ "default"
+
+
+
+
+Validates all the elements in the view. If no views exist will validate all elements on page
+
+Args:
+ viewName (str, optional): The name of the view to validate. Defaults to "default".
+
+Raises:
+ Exception: If the view doesn't exist for the page
+
+
+
+
+
+ def
+ def core.webpageController.webpageController._getPage
+ (self, pageName)
+ _getPage
+ self
+ self
+
+ pageName
+ pageName
+
+
+
+
+Gets the page based on the page name
+
+Args:
+ pageName (str): Page name based on a webpage config keys
+
+Raises:
+ Exception: If page name does not match any of those in the associated webpage config
+
+Returns:
+ dict: A dictionary representing the page
+
+
+
+
+
+ def
+ def core.webpageController.webpageController._getElement
+ (self, elementName)
+ _getElement
+ self
+ self
+
+ elementName
+ elementName
+
+
+
+
+Gets an element based on the element name from the current page
+
+Args:
+ elementName (str): Name of the element to get
+
+Raises:
+ Exception: If the element name does not match any of those for the current page
+
+Returns:
+ dict: A dictionary representing the element
+
+
+
+
+
+ def
+ def core.webpageController.webpageController._getViewForElement
+ (self, elementName)
+ _getViewForElement
+ self
+ self
+
+ elementName
+ elementName
+
+
+
+
+Gets the name of the first view that the element belongs to
+
+Args:
+ elementName (str): Name of element
+
+Raises:
+ Exception: If element does not belong to any view
+
+Returns:
+ str: Name of view
+
+
+
+
+
+ def
+ def core.webpageController.webpageController._getView
+ (self, viewName)
+ _getView
+ self
+ self
+
+ viewName
+ viewName
+
+
+
+
+Returns the config for the view
+
+Args:
+ viewName (str): Name of view from the config
+
+Raises:
+ Exception: If page contains no views
+ Exception: If view does not exist for page
+
+Returns:
+ dict: Dictionary of the views elements and sequence to activate it
+
+
+
+
+
+ def
+ def core.webpageController.webpageController._activateView
+ (self, viewName)
+ _activateView
+ self
+ self
+
+ viewName
+ viewName
+
+
+
+
+Activates a view based on the view name passed
+
+Args:
+ viewName (str): Name of view from config
+
+
+
+
+
+ def
+ def core.webpageController.webpageController._getAction
+ (self, actionName)
+ _getAction
+ self
+ self
+
+ actionName
+ actionName
+
+
+
+
+Gets an action based on the action name from the current page
+
+Args:
+ actionName (str): Name of the action to get
+
+Raises:
+ Exception: If the action name does not match any of those for the current page
+
+Returns:
+ dict: A dictionary representing the action
+
+
+
+
+
+ def
+ def core.webpageController.webpageController._interactionArgsSub
+ (self, interactionArgs, args)
+ _interactionArgsSub
+ self
+ self
+
+ interactionArgs
+ interactionArgs
+
+ args
+ args
+
+
+
+
+Substitutes in any arguments passed in args into interactionArgs based on any args in interactionArgs starting with $.
+
+Example:
+interactionArgs = ["admin","$password"]
+args = {password:"superSecretPassword98"}
+
+returns = ["admin","superSecretPassword98"]
+
+Args:
+ interactionArgs (dict): Dictionary of arguments with potential arguments needing to be substituted
+ args (dict): _description_
+
+Returns:
+ list: List of arguments
+
+
+
+
+
+ def
+ def core.webpageController.webpageController._getwindowId
+ (self)
+ _getwindowId
+ self
+ self
+
+
+
+
+Gets the window handle from the webDriver
+
+Returns:
+ String: windowId of the current window
+
+
+
+
+
+
+
+
+
+
+ core::webpageController::webpageController __init__ core::webpageController::webpageController _activateView core::webpageController::webpageController _checkElements core::webpageController::webpageController _getAction core::webpageController::webpageController _getElement core::webpageController::webpageController _getPage core::webpageController::webpageController _getView core::webpageController::webpageController _getViewForElement core::webpageController::webpageController _getwindowId core::webpageController::webpageController _interactionArgsSub core::webpageController::webpageController _isConfigured core::webpageController::webpageController _isOnPage core::webpageController::webpageController _navigateSequence core::webpageController::webpageController _pages core::webpageController::webpageController _setBaseUrl core::webpageController::webpageController _setWebpageConfig core::webpageController::webpageController _validateView core::webpageController::webpageController closeBrowser core::webpageController::webpageController configureWebpages core::webpageController::webpageController createNewTab core::webpageController::webpageController currentPage core::webpageController::webpageController currentPageName core::webpageController::webpageController currentTab core::webpageController::webpageController currentView core::webpageController::webpageController defaultView core::webpageController::webpageController getAlertText core::webpageController::webpageController getDynamicTable core::webpageController::webpageController getDynamicTableText core::webpageController::webpageController getElementAttribute core::webpageController::webpageController getFirstSelectedOption core::webpageController::webpageController getSelectAvailableOptions core::webpageController::webpageController getSelectedOptions core::webpageController::webpageController getSubElements core::webpageController::webpageController getTab core::webpageController::webpageController getTabs core::webpageController::webpageController getTextOfElement core::webpageController::webpageController getUrl core::webpageController::webpageController globalActions core::webpageController::webpageController isElementSelected core::webpageController::webpageController log core::webpageController::webpageController navigateTo core::webpageController::webpageController pages core::webpageController::webpageController performAction core::webpageController::webpageController performGlobalAction core::webpageController::webpageController performInteraction core::webpageController::webpageController removeTemporaryWebElements core::webpageController::webpageController saveHtmlSnapshot core::webpageController::webpageController saveScreenshot core::webpageController::webpageController setWebpage core::webpageController::webpageController switchTab core::webpageController::webpageController tabs core::webpageController::webpageController url core::webpageController::webpageController webDriver core::webpageController::webpageController webpageConfig
+
+
diff --git a/docs/doxygen/xml/classdownloadTest_1_1downloadTest.xml b/docs/doxygen/xml/classdownloadTest_1_1downloadTest.xml
new file mode 100644
index 0000000..02c5bb4
--- /dev/null
+++ b/docs/doxygen/xml/classdownloadTest_1_1downloadTest.xml
@@ -0,0 +1,84 @@
+
+
+
+ downloadTest::downloadTest
+ testController
+
+
+ def
+ def downloadTest.downloadTest.__init__
+ (self, testName="downloadTest", log=None)
+ __init__
+ self
+ self
+
+ testName
+ testName
+ "downloadTest"
+
+ log
+ log
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def downloadTest.downloadTest.testFunction
+ (self)
+ testFunction
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ downloadTest.downloadTest
+
+
+
+
+ testController
+
+
+
+
+ downloadTest.downloadTest
+
+
+
+
+ testController
+
+
+
+ downloadTest::downloadTest __init__ downloadTest::downloadTest testFunction
+
+
diff --git a/docs/doxygen/xml/classdynamicButtonsTest_1_1dynamicButtonsTest.xml b/docs/doxygen/xml/classdynamicButtonsTest_1_1dynamicButtonsTest.xml
new file mode 100644
index 0000000..2360855
--- /dev/null
+++ b/docs/doxygen/xml/classdynamicButtonsTest_1_1dynamicButtonsTest.xml
@@ -0,0 +1,84 @@
+
+
+
+ dynamicButtonsTest::dynamicButtonsTest
+ testController
+
+
+ def
+ def dynamicButtonsTest.dynamicButtonsTest.__init__
+ (self, testName="dynamicButtonsTest", log=None)
+ __init__
+ self
+ self
+
+ testName
+ testName
+ "dynamicButtonsTest"
+
+ log
+ log
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def dynamicButtonsTest.dynamicButtonsTest.testFunction
+ (self)
+ testFunction
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ dynamicButtonsTest.dynamicButtonsTest
+
+
+
+
+ testController
+
+
+
+
+ dynamicButtonsTest.dynamicButtonsTest
+
+
+
+
+ testController
+
+
+
+ dynamicButtonsTest::dynamicButtonsTest __init__ dynamicButtonsTest::dynamicButtonsTest testFunction
+
+
diff --git a/docs/doxygen/xml/classdynamicTablesTest_1_1dynamicTablesTest.xml b/docs/doxygen/xml/classdynamicTablesTest_1_1dynamicTablesTest.xml
new file mode 100644
index 0000000..353da15
--- /dev/null
+++ b/docs/doxygen/xml/classdynamicTablesTest_1_1dynamicTablesTest.xml
@@ -0,0 +1,106 @@
+
+
+
+ dynamicTablesTest::dynamicTablesTest
+ testController
+
+
+ def
+ def dynamicTablesTest.dynamicTablesTest.__init__
+ (self, testName="dynamicTablesTest", log=None)
+ __init__
+ self
+ self
+
+ testName
+ testName
+ "dynamicTablesTest"
+
+ log
+ log
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def dynamicTablesTest.dynamicTablesTest.testFunction
+ (self)
+ testFunction
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def dynamicTablesTest.dynamicTablesTest.getTemporaryElementList
+ (self, pageElementDict)
+ getTemporaryElementList
+ self
+ self
+
+ pageElementDict
+ pageElementDict
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ dynamicTablesTest.dynamicTablesTest
+
+
+
+
+ testController
+
+
+
+
+ dynamicTablesTest.dynamicTablesTest
+
+
+
+
+ testController
+
+
+
+ dynamicTablesTest::dynamicTablesTest __init__ dynamicTablesTest::dynamicTablesTest getTemporaryElementList dynamicTablesTest::dynamicTablesTest testFunction
+
+
diff --git a/docs/doxygen/xml/classelementAttributeTest_1_1elementAttributeTest.xml b/docs/doxygen/xml/classelementAttributeTest_1_1elementAttributeTest.xml
new file mode 100644
index 0000000..ccdd632
--- /dev/null
+++ b/docs/doxygen/xml/classelementAttributeTest_1_1elementAttributeTest.xml
@@ -0,0 +1,84 @@
+
+
+
+ elementAttributeTest::elementAttributeTest
+ testController
+
+
+ def
+ def elementAttributeTest.elementAttributeTest.__init__
+ (self, testName="elementAttributeTest", log=None)
+ __init__
+ self
+ self
+
+ testName
+ testName
+ "elementAttributeTest"
+
+ log
+ log
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def elementAttributeTest.elementAttributeTest.testFunction
+ (self)
+ testFunction
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ elementAttributeTest.elementAttributeTest
+
+
+
+
+ testController
+
+
+
+
+ elementAttributeTest.elementAttributeTest
+
+
+
+
+ testController
+
+
+
+ elementAttributeTest::elementAttributeTest __init__ elementAttributeTest::elementAttributeTest testFunction
+
+
diff --git a/docs/doxygen/xml/classframework_1_1exceptionTests_1_1framework__test1.xml b/docs/doxygen/xml/classframework_1_1exceptionTests_1_1framework__test1.xml
new file mode 100644
index 0000000..32045a9
--- /dev/null
+++ b/docs/doxygen/xml/classframework_1_1exceptionTests_1_1framework__test1.xml
@@ -0,0 +1,136 @@
+
+
+
+ framework::exceptionTests::framework_test1
+ testController
+
+
+ framework.exceptionTests.framework_test1::exitOnError
+ exitOnError
+
+
+
+
+
+
+
+
+
+
+ def
+ def framework.exceptionTests.framework_test1.__init__
+ (self, log=None, exitOnError=False)
+ __init__
+ self
+ self
+
+ log
+ log
+ None
+
+ exitOnError
+ exitOnError
+ False
+
+
+
+
+
+
+
+
+
+ def
+ def framework.exceptionTests.framework_test1.waitForBoot
+ (self)
+ waitForBoot
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def framework.exceptionTests.framework_test1.testFunction
+ (self)
+ testFunction
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def framework.exceptionTests.framework_test1.testExceptionCleanUp
+ (self)
+ testExceptionCleanUp
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ framework.exceptionTests.framework_test1
+
+
+
+
+ testController
+
+
+
+
+ framework.exceptionTests.framework_test1
+
+
+
+
+ testController
+
+
+
+ framework::exceptionTests::framework_test1 __init__ framework::exceptionTests::framework_test1 exitOnError framework::exceptionTests::framework_test1 testExceptionCleanUp framework::exceptionTests::framework_test1 testFunction framework::exceptionTests::framework_test1 waitForBoot
+
+
diff --git a/docs/doxygen/xml/classframework_1_1remoteController__test_1_1demoClass.xml b/docs/doxygen/xml/classframework_1_1remoteController__test_1_1demoClass.xml
new file mode 100644
index 0000000..fc9eadc
--- /dev/null
+++ b/docs/doxygen/xml/classframework_1_1remoteController__test_1_1demoClass.xml
@@ -0,0 +1,36 @@
+
+
+
+ framework::remoteController_test::demoClass
+ testController
+
+
+
+
+
+
+ framework.remoteController_test.demoClass
+
+
+
+
+ testController
+
+
+
+
+ framework.remoteController_test.demoClass
+
+
+
+
+ testController
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/classframework_1_1startup_1_1framework__test1.xml b/docs/doxygen/xml/classframework_1_1startup_1_1framework__test1.xml
new file mode 100644
index 0000000..aa2f13a
--- /dev/null
+++ b/docs/doxygen/xml/classframework_1_1startup_1_1framework__test1.xml
@@ -0,0 +1,74 @@
+
+
+
+ framework::startup::framework_test1
+ testController
+
+
+ def
+ def framework.startup.framework_test1.__init__
+ (self)
+ __init__
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def framework.startup.framework_test1.testFunction
+ (self)
+ testFunction
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ framework.startup.framework_test1
+
+
+
+
+ testController
+
+
+
+
+ framework.startup.framework_test1
+
+
+
+
+ testController
+
+
+
+ framework::startup::framework_test1 __init__ framework::startup::framework_test1 testFunction
+
+
diff --git a/docs/doxygen/xml/classglobalActionTest_1_1globalActionTest.xml b/docs/doxygen/xml/classglobalActionTest_1_1globalActionTest.xml
new file mode 100644
index 0000000..628eed1
--- /dev/null
+++ b/docs/doxygen/xml/classglobalActionTest_1_1globalActionTest.xml
@@ -0,0 +1,84 @@
+
+
+
+ globalActionTest::globalActionTest
+ testController
+
+
+ def
+ def globalActionTest.globalActionTest.__init__
+ (self, testName="globalActionTest", log=None)
+ __init__
+ self
+ self
+
+ testName
+ testName
+ "globalActionTest"
+
+ log
+ log
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def globalActionTest.globalActionTest.testFunction
+ (self)
+ testFunction
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ globalActionTest.globalActionTest
+
+
+
+
+ testController
+
+
+
+
+ globalActionTest.globalActionTest
+
+
+
+
+ testController
+
+
+
+ globalActionTest::globalActionTest __init__ globalActionTest::globalActionTest testFunction
+
+
diff --git a/docs/doxygen/xml/classnone_1_1remoteNone.xml b/docs/doxygen/xml/classnone_1_1remoteNone.xml
new file mode 100644
index 0000000..6c3b9a4
--- /dev/null
+++ b/docs/doxygen/xml/classnone_1_1remoteNone.xml
@@ -0,0 +1,103 @@
+
+
+
+ none::remoteNone
+
+
+ none.remoteNone::log
+ log
+
+
+
+
+
+
+
+
+
+
+ def
+ def none.remoteNone.__init__
+ (self, logModule log, dict remoteConfig)
+ __init__
+ self
+ self
+
+ logModule
+ log
+
+ dict
+ remoteConfig
+
+
+
+
+Initalise a remoteNone class
+
+Args:
+ log (logModule): logging module
+ remoteConfig (dict): remote controller configuration
+
+
+
+
+
+ def
+ def none.remoteNone.sendKey
+ (self, str code, int repeat, int delay)
+ sendKey
+ self
+ self
+
+ str
+ code
+
+ int
+ repeat
+
+ int
+ delay
+
+
+
+
+Send a key
+
+Args:
+ code (str): keycode
+ repeat (int): number of repeats required
+ delay (int): delay in seconds between repeats
+
+Returns:
+ bool: true on success otherwise failure
+
+
+
+
+
+
+
+
+
+
+ none::remoteNone __init__ none::remoteNone log none::remoteNone sendKey
+
+
diff --git a/docs/doxygen/xml/classolimex_1_1remoteOlimex.xml b/docs/doxygen/xml/classolimex_1_1remoteOlimex.xml
new file mode 100644
index 0000000..3356f61
--- /dev/null
+++ b/docs/doxygen/xml/classolimex_1_1remoteOlimex.xml
@@ -0,0 +1,137 @@
+
+
+
+ olimex::remoteOlimex
+
+
+ olimex.remoteOlimex::log
+ log
+
+
+
+
+
+
+
+
+ olimex.remoteOlimex::remoteController
+ remoteController
+
+
+
+
+
+
+
+
+ olimex.remoteOlimex::telnet
+ telnet
+
+
+
+
+
+
+
+
+
+
+ def
+ def olimex.remoteOlimex.__init__
+ (self, logModule log, dict remoteController)
+ __init__
+ self
+ self
+
+ logModule
+ log
+
+ dict
+ remoteController
+
+
+
+
+
+
+
+
+
+ def
+ def olimex.remoteOlimex.command
+ (self, str cmd)
+ command
+ self
+ self
+
+ str
+ cmd
+
+
+
+
+
+
+
+
+
+ def
+ def olimex.remoteOlimex.sendKey
+ (self, str code, int repeat, int delay)
+ sendKey
+ self
+ self
+
+ str
+ code
+
+ int
+ repeat
+
+ int
+ delay
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ olimex::remoteOlimex __init__ olimex::remoteOlimex command olimex::remoteOlimex log olimex::remoteOlimex remoteController olimex::remoteOlimex sendKey olimex::remoteOlimex telnet
+
+
diff --git a/docs/doxygen/xml/classperformActionsTests_1_1performActionsTests.xml b/docs/doxygen/xml/classperformActionsTests_1_1performActionsTests.xml
new file mode 100644
index 0000000..8af72be
--- /dev/null
+++ b/docs/doxygen/xml/classperformActionsTests_1_1performActionsTests.xml
@@ -0,0 +1,84 @@
+
+
+
+ performActionsTests::performActionsTests
+ testController
+
+
+ def
+ def performActionsTests.performActionsTests.__init__
+ (self, testName="performActionTests", log=None)
+ __init__
+ self
+ self
+
+ testName
+ testName
+ "performActionTests"
+
+ log
+ log
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def performActionsTests.performActionsTests.testFunction
+ (self)
+ testFunction
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ performActionsTests.performActionsTests
+
+
+
+
+ testController
+
+
+
+
+ performActionsTests.performActionsTests
+
+
+
+
+ testController
+
+
+
+ performActionsTests::performActionsTests __init__ performActionsTests::performActionsTests testFunction
+
+
diff --git a/docs/doxygen/xml/classsaveScreenshotTest_1_1saveScreenshotTest.xml b/docs/doxygen/xml/classsaveScreenshotTest_1_1saveScreenshotTest.xml
new file mode 100644
index 0000000..e5115f8
--- /dev/null
+++ b/docs/doxygen/xml/classsaveScreenshotTest_1_1saveScreenshotTest.xml
@@ -0,0 +1,84 @@
+
+
+
+ saveScreenshotTest::saveScreenshotTest
+ testController
+
+
+ def
+ def saveScreenshotTest.saveScreenshotTest.__init__
+ (self, testName="saveScreenshotTest", log=None)
+ __init__
+ self
+ self
+
+ testName
+ testName
+ "saveScreenshotTest"
+
+ log
+ log
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def saveScreenshotTest.saveScreenshotTest.testFunction
+ (self)
+ testFunction
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ testController
+
+
+ saveScreenshotTest.saveScreenshotTest
+
+
+
+
+
+
+ testController
+
+
+ saveScreenshotTest.saveScreenshotTest
+
+
+
+
+
+ saveScreenshotTest::saveScreenshotTest __init__ saveScreenshotTest::saveScreenshotTest testFunction
+
+
diff --git a/docs/doxygen/xml/classselectOptionsTests_1_1selectOptionsTests.xml b/docs/doxygen/xml/classselectOptionsTests_1_1selectOptionsTests.xml
new file mode 100644
index 0000000..fe75da9
--- /dev/null
+++ b/docs/doxygen/xml/classselectOptionsTests_1_1selectOptionsTests.xml
@@ -0,0 +1,84 @@
+
+
+
+ selectOptionsTests::selectOptionsTests
+ testController
+
+
+ def
+ def selectOptionsTests.selectOptionsTests.__init__
+ (self, testName="selectOptionsTests", log=None)
+ __init__
+ self
+ self
+
+ testName
+ testName
+ "selectOptionsTests"
+
+ log
+ log
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def selectOptionsTests.selectOptionsTests.testFunction
+ (self)
+ testFunction
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ selectOptionsTests.selectOptionsTests
+
+
+
+
+ testController
+
+
+
+
+ selectOptionsTests.selectOptionsTests
+
+
+
+
+ testController
+
+
+
+ selectOptionsTests::selectOptionsTests __init__ selectOptionsTests::selectOptionsTests testFunction
+
+
diff --git a/docs/doxygen/xml/classseleniumDriver_1_1seleniumDriver.xml b/docs/doxygen/xml/classseleniumDriver_1_1seleniumDriver.xml
new file mode 100644
index 0000000..b4f2aa3
--- /dev/null
+++ b/docs/doxygen/xml/classseleniumDriver_1_1seleniumDriver.xml
@@ -0,0 +1,803 @@
+
+
+
+ seleniumDriver::seleniumDriver
+
+
+ seleniumDriver.seleniumDriver::log
+ log
+
+
+
+
+
+
+
+
+ seleniumDriver.seleniumDriver::browser
+ browser
+
+
+
+
+
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.__init__
+ (self, log, webDriverConfig)
+ __init__
+ self
+ self
+
+ log
+ log
+
+ webDriverConfig
+ webDriverConfig
+
+
+
+
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.navigateTo
+ (self, url)
+ navigateTo
+ self
+ self
+
+ url
+ url
+
+
+
+
+Naviagates to the url
+
+Args:
+ url (str): The url to be navigated to
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.getElementType
+ (self, str elementType)
+ getElementType
+ self
+ self
+
+ str
+ elementType
+
+
+
+
+Gives the selenium element type based on the config type passed
+
+Args:
+ elementType (str): The type of element in the config
+
+Returns:
+ Selenium Element Type: _description_
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.waitForElement
+ (self, element, timeout=10)
+ waitForElement
+ self
+ self
+
+ element
+ element
+
+ timeout
+ timeout
+ 10
+
+
+
+
+Wait for presence of element in the webpage
+
+Args:
+ element ({type: str, value: str}): A dictionary containing a type and value, which can be used to determine the element in the webpage
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.sendKeys
+ (self, element, keys)
+ sendKeys
+ self
+ self
+
+ element
+ element
+
+ keys
+ keys
+
+
+
+
+Send keys to an element on the webpage
+
+Args:
+ element ({type: str, value: str}): A dictionary containing a type and value, which can be used to determine the element in the webpage
+ keys (str): The keys to be sent to the element
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.click
+ (self, element)
+ click
+ self
+ self
+
+ element
+ element
+
+
+
+
+Click an element on the webpage (Ex: button, hyperlink)
+
+Args:
+ element ({type: str, value: str}): A dictionary containing a type and value, which can be used to determine the element in the webpage
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.selectFromDropdown
+ (self, element, value)
+ selectFromDropdown
+ self
+ self
+
+ element
+ element
+
+ value
+ value
+
+
+
+
+Selects a value from a element which represents a dropdown list
+
+Args:
+ element ({type: str, value: str}): A dictionary containing a type and value, which can be used to determine the element in the webpage
+ value (str): The option to select
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.getText
+ (self, element)
+ getText
+ self
+ self
+
+ element
+ element
+
+
+
+
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.clear
+ (self, element)
+ clear
+ self
+ self
+
+ element
+ element
+
+
+
+
+Resets the content of an element
+
+Args:
+ element ({type: str, value: str}): A dictionary containing a type and value, which can be used to determine the element in the webpage
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.acceptAlert
+ (self)
+ acceptAlert
+ self
+ self
+
+
+
+
+Accepts an alert if one is present on the webpage
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.refresh
+ (self)
+ refresh
+ self
+ self
+
+
+
+
+Refreshes the webpage
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.getElementAttribute
+ (self, element, attribute)
+ getElementAttribute
+ self
+ self
+
+ element
+ element
+
+ attribute
+ attribute
+
+
+
+
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.isElementSelected
+ (self, element)
+ isElementSelected
+ self
+ self
+
+ element
+ element
+
+
+
+
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.getSelectedOptions
+ (self, element)
+ getSelectedOptions
+ self
+ self
+
+ element
+ element
+
+
+
+
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.getFirstSelectedOption
+ (self, element)
+ getFirstSelectedOption
+ self
+ self
+
+ element
+ element
+
+
+
+
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.getSelectAvailableOptions
+ (self, element)
+ getSelectAvailableOptions
+ self
+ self
+
+ element
+ element
+
+
+
+
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.getAlertText
+ (self)
+ getAlertText
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.dismissAlert
+ (self)
+ dismissAlert
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.saveScreenshot
+ (self, directory, fileName)
+ saveScreenshot
+ self
+ self
+
+ directory
+ directory
+
+ fileName
+ fileName
+
+
+
+
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.getHtml
+ (self)
+ getHtml
+ self
+ self
+
+
+
+
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.getTableElements
+ (self, element, elementName, text=None)
+ getTableElements
+ self
+ self
+
+ element
+ element
+
+ elementName
+ elementName
+
+ text
+ text
+ None
+
+
+
+
+Gets the elements of dynamic table as a list of list of dictionaries
+
+Args:
+ element (dictionary): A dictionary representing the dynamic element
+ elementName (string): Name of the dynamic element
+ text (bool, optional): Text attribute indicator of the web element. Set to True to retreive text attribute of the webelement. Defaults to None.
+
+Returns:
+ list: list of list of dictionaries with element details - element locator type, element locator value , text (if text=true)
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.getXpath
+ (self, element)
+ getXpath
+ self
+ self
+
+ element
+ element
+
+
+
+
+Returns the xpath of a webelement
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.newTab
+ (self)
+ newTab
+ self
+ self
+
+
+
+
+Creates a new tab on the selenium driver
+
+Returns:
+ (String, String): A tuple of the original tab and the new tab window handles
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.switchTab
+ (self, tab)
+ switchTab
+ self
+ self
+
+ tab
+ tab
+
+
+
+
+Switchs tab on the selenium driver
+
+Args:
+ tab (String): Window handle for tab
+
+Returns:
+ (String, String): A tuple of the original tab and the new tab window handles
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.getWindowId
+ (self)
+ getWindowId
+ self
+ self
+
+
+
+
+Gets the current window handle of the browser
+
+Returns:
+ String: Window handle of the current tab/window
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver.getSubElements
+ (self, element, elementName)
+ getSubElements
+ self
+ self
+
+ element
+ element
+
+ elementName
+ elementName
+
+
+
+
+
+
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver._setWebdriver
+ (self, webDriverConfig)
+ _setWebdriver
+ self
+ self
+
+ webDriverConfig
+ webDriverConfig
+
+
+
+
+Provides the webDriver config to properly configure the selenium webdriver
+
+Args:
+ webDriverConfig (dict): Dictionary containing appropriate config for selenium webdriver
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver._getElement
+ (self, element)
+ _getElement
+ self
+ self
+
+ element
+ element
+
+
+
+
+Gets an element object from the selenium webdriver based on the dict passed
+
+Args:
+ element ({type: str, value: str}): A dictionary containing a type and value, which can be used to determine the element in the webpage
+
+Returns:
+ WebElement
+
+
+
+
+
+ def
+ def seleniumDriver.seleniumDriver._createElementsDictionary
+ (self, elementName, elementLocatorType, elementLocatorValue, **kwargs)
+ _createElementsDictionary
+ self
+ self
+
+ elementName
+ elementName
+
+ elementLocatorType
+ elementLocatorType
+
+ elementLocatorValue
+ elementLocatorValue
+
+ **
+ kwargs
+
+
+
+
+Creates a dictonary of element's details
+
+Args:
+ elementName (String): The name of the web element
+ elementLocatorType (String): The locator type for the web element (Eg: XPATH, ID, TAG etc)
+ elementLocatorValue (String): Actual value of the locator for the web element
+ text (bool, optional): Text attribute indicator of the web element. Set to True to retreive text attribute of the webelement. Defaults to None.
+ temporaryFlag(bool, optional) : Indicates if the webelement is temporary or not. Set to True for temporary element. Defaults to False.
+Returns:
+ dict: A dictionary representing the attributes of element
+
+
+
+
+
+
+
+
+
+
+ seleniumDriver::seleniumDriver __init__ seleniumDriver::seleniumDriver _createElementsDictionary seleniumDriver::seleniumDriver _getElement seleniumDriver::seleniumDriver _setWebdriver seleniumDriver::seleniumDriver acceptAlert seleniumDriver::seleniumDriver browser seleniumDriver::seleniumDriver clear seleniumDriver::seleniumDriver click seleniumDriver::seleniumDriver dismissAlert seleniumDriver::seleniumDriver getAlertText seleniumDriver::seleniumDriver getElementAttribute seleniumDriver::seleniumDriver getElementType seleniumDriver::seleniumDriver getFirstSelectedOption seleniumDriver::seleniumDriver getHtml seleniumDriver::seleniumDriver getSelectAvailableOptions seleniumDriver::seleniumDriver getSelectedOptions seleniumDriver::seleniumDriver getSubElements seleniumDriver::seleniumDriver getTableElements seleniumDriver::seleniumDriver getText seleniumDriver::seleniumDriver getWindowId seleniumDriver::seleniumDriver getXpath seleniumDriver::seleniumDriver isElementSelected seleniumDriver::seleniumDriver log seleniumDriver::seleniumDriver navigateTo seleniumDriver::seleniumDriver newTab seleniumDriver::seleniumDriver refresh seleniumDriver::seleniumDriver saveScreenshot seleniumDriver::seleniumDriver selectFromDropdown seleniumDriver::seleniumDriver sendKeys seleniumDriver::seleniumDriver switchTab seleniumDriver::seleniumDriver waitForElement
+
+
diff --git a/docs/doxygen/xml/classsequenceTest_1_1sequenceTest.xml b/docs/doxygen/xml/classsequenceTest_1_1sequenceTest.xml
new file mode 100644
index 0000000..1f27db6
--- /dev/null
+++ b/docs/doxygen/xml/classsequenceTest_1_1sequenceTest.xml
@@ -0,0 +1,84 @@
+
+
+
+ sequenceTest::sequenceTest
+ testController
+
+
+ def
+ def sequenceTest.sequenceTest.__init__
+ (self, testName="sequenceTest", log=None)
+ __init__
+ self
+ self
+
+ testName
+ testName
+ "sequenceTest"
+
+ log
+ log
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def sequenceTest.sequenceTest.testFunction
+ (self)
+ testFunction
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ sequenceTest.sequenceTest
+
+
+
+
+ testController
+
+
+
+
+ sequenceTest.sequenceTest
+
+
+
+
+ testController
+
+
+
+ sequenceTest::sequenceTest __init__ sequenceTest::sequenceTest testFunction
+
+
diff --git a/docs/doxygen/xml/classskyProc_1_1remoteSkyProc.xml b/docs/doxygen/xml/classskyProc_1_1remoteSkyProc.xml
new file mode 100644
index 0000000..5512108
--- /dev/null
+++ b/docs/doxygen/xml/classskyProc_1_1remoteSkyProc.xml
@@ -0,0 +1,151 @@
+
+
+
+ skyProc::remoteSkyProc
+
+
+ skyProc.remoteSkyProc::log
+ log
+
+
+
+
+
+
+
+
+ skyProc.remoteSkyProc::ip
+ ip
+
+
+
+
+
+
+
+
+ skyProc.remoteSkyProc::port
+ port
+
+
+
+
+
+
+
+
+ skyProc.remoteSkyProc::telnet
+ telnet
+
+
+
+
+
+
+
+
+
+
+ def
+ def skyProc.remoteSkyProc.__init__
+ (self, log, remoteController)
+ __init__
+ self
+ self
+
+ log
+ log
+
+ remoteController
+ remoteController
+
+
+
+
+
+
+
+
+
+ def
+ def skyProc.remoteSkyProc.command
+ (self, cmd)
+ command
+ self
+ self
+
+ cmd
+ cmd
+
+
+
+
+
+
+
+
+
+ def
+ def skyProc.remoteSkyProc.sendKey
+ (self, code, repeat, delay)
+ sendKey
+ self
+ self
+
+ code
+ code
+
+ repeat
+ repeat
+
+ delay
+ delay
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ skyProc::remoteSkyProc __init__ skyProc::remoteSkyProc command skyProc::remoteSkyProc ip skyProc::remoteSkyProc log skyProc::remoteSkyProc port skyProc::remoteSkyProc sendKey skyProc::remoteSkyProc telnet
+
+
diff --git a/docs/doxygen/xml/classtabsTest_1_1tabsTest.xml b/docs/doxygen/xml/classtabsTest_1_1tabsTest.xml
new file mode 100644
index 0000000..efa8180
--- /dev/null
+++ b/docs/doxygen/xml/classtabsTest_1_1tabsTest.xml
@@ -0,0 +1,84 @@
+
+
+
+ tabsTest::tabsTest
+ testController
+
+
+ def
+ def tabsTest.tabsTest.__init__
+ (self, testName="tabsTest", log=None)
+ __init__
+ self
+ self
+
+ testName
+ testName
+ "tabsTest"
+
+ log
+ log
+ None
+
+
+
+
+
+
+
+
+
+ def
+ def tabsTest.tabsTest.testFunction
+ (self)
+ testFunction
+ self
+ self
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ tabsTest.tabsTest
+
+
+
+
+ testController
+
+
+
+
+ tabsTest.tabsTest
+
+
+
+
+ testController
+
+
+
+ tabsTest::tabsTest __init__ tabsTest::tabsTest testFunction
+
+
diff --git a/docs/doxygen/xml/combine.xslt b/docs/doxygen/xml/combine.xslt
new file mode 100644
index 0000000..f0ee1fd
--- /dev/null
+++ b/docs/doxygen/xml/combine.xslt
@@ -0,0 +1,15 @@
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/commonRemote_8py.xml b/docs/doxygen/xml/commonRemote_8py.xml
new file mode 100644
index 0000000..efdc452
--- /dev/null
+++ b/docs/doxygen/xml/commonRemote_8py.xml
@@ -0,0 +1,195 @@
+
+
+
+ commonRemote.py
+ core::commonRemote::remoteControllerMapping
+ core::commonRemote::commonRemoteClass
+ core::commonRemote
+
+
+
+
+
+import import import from import from import as from import from import from import from import class [remoteControllerMapping]():def [__init__](self,"""Initialise [log][currentMap]None [maps]try : "name" ] except : None [setKeyMap](def [getMappedKey](self,"""get if [currentMap]None : return if not in [currentMap]["codes" ]: [log].error("remoteControllerMapping.get() .format(self.[currentMap][ "name" ])) return None [currentMap].get("prefix" ) [currentMap]["codes" ].get(key) if return def [getKeyMap](self):"""get return [currentMap]def [setKeyMap](self,"""set if None : return False if [maps]None : [log].error("RemoteController .format(newMapName)) return False False for in [maps]:if "name" ] [currentMap]True break if False : [log].warn(" .format(newMapName)) return False return True class [commonRemoteClass]():def [__init__](self,"""Intialise [log][remoteConfig][__decodeRemoteMapConfig]()"map" ) [remoteMap][remoteControllerMapping]([setKeyMap]([type]"type" ) if [type]"olimex" : [remoteController][log],elif [type]"sky_proc" : [remoteController][log],elif [type]"arduino" : [remoteController][log],else : [remoteController][log],def __decodeRemoteMapConfig(self): """decode [remoteConfig].get("config" ) if None : return if "." ): if False : "config: .format(fullPath)) with as for in if for in else : return def [sendKey](self,"""send if import [log].info("sendKey[" "] "] +str(randomRepeat)+ "] +str(repeat)+ "]" else : if [log].info("sendKey[" "] "] +str(repeat)+ "]" else : [log].info("sendKey[" "] "]" [remoteMap].getMappedKey([remoteController].[sendKey](def [setKeyMap]("""set [remoteMap].[setKeyMap](def [getKeyMap]("""get [remoteMap].[getKeyMap]()
+
+
diff --git a/docs/doxygen/xml/compound.xsd b/docs/doxygen/xml/compound.xsd
new file mode 100644
index 0000000..083df15
--- /dev/null
+++ b/docs/doxygen/xml/compound.xsd
@@ -0,0 +1,1187 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/configParserBase_8py.xml b/docs/doxygen/xml/configParserBase_8py.xml
new file mode 100644
index 0000000..6ba0d6c
--- /dev/null
+++ b/docs/doxygen/xml/configParserBase_8py.xml
@@ -0,0 +1,81 @@
+
+
+
+ configParserBase.py
+ core::configParserBase::configParserBase
+ core::configParserBase
+
+
+
+
+
+from import class [configParserBase]():def [__init__](self,"""Class: [log]if None : [log]"configParserBase" def [decodeTable](self,"""decode for in [decodeParam](def [decodeParam](self,"""Decode [log].debug("[" +str(name)+ "]:[" +str(value)+ "]" ) def [__getFieldValue__]("""Get try : except : [log].error("Field .format(fieldName)) return None return
+
+
diff --git a/docs/doxygen/xml/configParser_8py.xml b/docs/doxygen/xml/configParser_8py.xml
new file mode 100644
index 0000000..eca78dd
--- /dev/null
+++ b/docs/doxygen/xml/configParser_8py.xml
@@ -0,0 +1,337 @@
+
+
+
+ configParser.py
+ core::configParser::configParser
+ core::configParser
+
+
+
+
+
+import from import from import as from import class [configParser](configParserBase):def [__init__](self,"""Class: [log]if None : [log]"configParser" [local][cpe][memoryMap][validImages]if is not None : [decodeConfig](def [decodeConfig](self,"""decode for in if "local" ): [local],if "cpe" ): [__decodeCPEConfig__](if 'memoryMap' ): [__decodeMemoryMapConfig__](def [__decodeMemoryMapConfig__](self,"""decode [memoryMap][parent][memoryMap][parent]for in if "offsets" ): else : def [updateCPEConfig](self,"""update for in [cpe]:[cpe][x]["platform" ] if "platform" ] [cpe][x]for in if "validImage" ): "validImage" ], "validImage" ] else : break def [createCpeConfig](self,"""Creates 'platform' : 'validImage' : return def [__decodeCPEConfig__](self,"""decode [cpe][parent][cpe][parent]for in if "validImage" ): else : def [getCPEEntryViaPlatform](self,"""[find for in [cpe]:[cpe][cpeParent]if "platform" ] return [log].error("CPE .format(platform)) return None def [getCPEFieldViaPlatform](self,"""[find [log].debug("configParser.getCPEFieldViaPlatform([{}][{}])" .format(platform,field)) for in [cpe]:[cpe][cpeParent]if "platform" ] try : except : raise "CPE .format(platform,field)) return None return [log].error("CPE .format(platform,field)) return None def [getMemoryMapViaPlatform](self,"""[find [getCPEEntryViaPlatform](if None : return None "memoryMap" ) if None : return None for in [memoryMap]:[memoryMap][x]if "platform" ] return [log].error("Memory .format(platform)) return None def [getMemoryMapValueViaPlatform](self,"""[find [getMemoryMapViaPlatform](try : "offsets" ][name] except : raise "getMemoryMapValue[{}] .format(name)) return None return def [getWorkspaceDirectory](self):"""[get [local],"workspaceDirectory" if is None : raise "[workspaceDirectory] ) return None if return if '~' and '/' : return def [getAlternativePlatform](self,"""Get [getCPEEntryViaPlatform](if None : return None "alternative_platform" ) return def getImageField( """Search [log].debug("getImageField([{}] .format( for in [cpe]:[cpe][cpeParent]if try : "validImage" ] except : [log].error("validImage ) return None for in if try : "baseLocation" ] except : "" if for in if "" : else : else : if "" : return return None def getNegativeImageUrlViaPlatform(self, """Get [getCPEFieldViaPlatform]("negativeImageLocation" return def getValidImageUrlViaPlatform(self, """[gets [log].debug("getValidImageUrlViaPlatform([{}] .format( "platform" , return "platform" , def getValidImages(self, """For for in [cpe]:[cpe][cpeParent]if 'platform' ] try : "validImage" ] except : [log].error("validImage ) return None for in if in and "_" not in return
+
+
diff --git a/docs/doxygen/xml/consoleInterface_8py.xml b/docs/doxygen/xml/consoleInterface_8py.xml
new file mode 100644
index 0000000..56883ce
--- /dev/null
+++ b/docs/doxygen/xml/consoleInterface_8py.xml
@@ -0,0 +1,72 @@
+
+
+
+ consoleInterface.py
+ core::commandModules::consoleInterface::consoleInterface
+ core::commandModules::consoleInterface
+
+
+
+
+
+from import class [consoleInterface](metaclass=ABCMeta):def [write](self,"""Abstract raise 'users ) def [open](self):"""Abstract raise 'users ) def [read_all](self):"""Abstract raise 'users ) def [read_until](self,"""Abstract raise 'users ) def [close](self):"""Close raise 'users )
+
+
diff --git a/docs/doxygen/xml/decodeParams_8py.xml b/docs/doxygen/xml/decodeParams_8py.xml
new file mode 100644
index 0000000..05afda4
--- /dev/null
+++ b/docs/doxygen/xml/decodeParams_8py.xml
@@ -0,0 +1,132 @@
+
+
+
+ decodeParams.py
+ core::decodeParams::decodeParams
+ core::decodeParams
+
+
+
+
+
+import import from import from import import import import class [decodeParams]():"""Decodes def __init__(self, [jobId]None [rackJobExecutionId]None [testMode]False [debug]False [loop]None [log][buildConfig]None [overrideCpeConfig]None '--config' , '-config' , "config , "store" , "configFile" ) '--deviceConfig' , '-deviceConfig' , '--deviceConfig' , '-testConfig' , "--testConfig" , "testconfig , "store" , "deviceConfigFile" ) '--buildInfo' , 'Build , 'store' , 'buildInfo' ) '--overrideDeviceConfig' , 'cpe , 'store' , 'overrideCpeConfig' ) '--rack' , "rack , "store" , "rackName" ) '--slot' , "slot , "store" , "slotNumber" , '--slotName' , "slot , "store" , "slotName" ) '--job_id' , "job , "store" , "jobId" ) '--rack_job_execution_id' , "rack , "store" , "rackJobExecutionId" ) '--loop' , "device , "store" , "loop" ) '--test' , '-test' , "test , "store_const" , "testMode" , True ) '--debug' , '-debug' , "set , "store_const" , "debug" , True ) [args]if [args].configFileNone : "Config ) [rackConfig][decodeConfigIntoDictionary]([args].configFile[decodeDeviceConfig]()if [args],'buildInfo' , None ): [buildConfig][args].buildInfoif [args],'overrideCpeConfig' , None ): [overrideCpeConfig][args].overrideCpeConfigif [args].debugNone : [debug]True if [args].testModeNone ): [testMode]True if [args].loopNone ): [loop][args].loopdef decodeDeviceConfig( [deviceConfig]None [args].deviceConfigFileif None : try : [rackConfig].get("includes" ).get( "deviceConfig" ) except : [log].warn("No ) return [deviceConfig][decodeConfigIntoDictionary](deviceConfigFile)def decodeConfigIntoDictionary(self, if "." ): if False : "config: .format(fullPath)) with as for in if for in else : return
+
+
diff --git a/docs/doxygen/xml/deviceManager_8py.xml b/docs/doxygen/xml/deviceManager_8py.xml
new file mode 100644
index 0000000..f61a649
--- /dev/null
+++ b/docs/doxygen/xml/deviceManager_8py.xml
@@ -0,0 +1,230 @@
+
+
+
+ deviceManager.py
+ core::deviceManager::consoleClass
+ core::deviceManager::deviceClass
+ core::deviceManager::deviceManager
+ core::deviceManager
+
+
+
+
+
+from import import from import from import from import from import from import from import from import dir_path class [consoleClass]():None def [__init__](self,"""createConsole for in [type]"type" ) if [type]"ssh" : "address" ) if None "ip" ) "username" ) "password" ) "known_hosts" ) if not "ssh ) if not "ssh ) [session]elif [type]"serial" : "port" ) "baudRate" ) "parity" ) "dataBits" ) "stopBits" ) "flowControl" ) if not "Serial ) if not if not if not "None" if not if not False [session]elif [type]"telnet" : "address" ) if None "ip" ) "username" ) "password" ) "port" ,23) if not "Telnet ) if not "Telnet ) if not "Telnet ) [session]"" , else : raise "Unknown .format(self.[type])) class [deviceClass]():"""Single def [__init__](self,"""Intialise [consoles][powerControl]None [outBoundClient]None [remoteController]None [rawConfig]for in [deviceName]"powerSwitch" ) if None : [powerControl]"consoles" ) for in for in [consoles][name][consoleClass](log,"outbound" ) if None : [outBoundClient]"remoteController" ) if None : [remoteController]def [getField](self,None ): """get if None : [rawConfig]for in if [getField](if None : return else : if return return None def [getConsoleSession](self,"default" """get [consoles][consoleName]if None : "Invalid .format(consoleName)) return class [deviceManager]():def [__init__](self,"" ): """Initalise [log][logPath][rawConfig]for in for in [devices][name][deviceClass](def [getDevice](self,"dut" ): """Get [devices].get(deviceName)if None : [log].error("Invalid .format(deviceName)) return
+
+
diff --git a/docs/doxygen/xml/dir_4f83fc4e7000500481bc2234a29e5a13.xml b/docs/doxygen/xml/dir_4f83fc4e7000500481bc2234a29e5a13.xml
new file mode 100644
index 0000000..01931df
--- /dev/null
+++ b/docs/doxygen/xml/dir_4f83fc4e7000500481bc2234a29e5a13.xml
@@ -0,0 +1,12 @@
+
+
+
+ unitTests
+ unitTests/framework
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/dir_62afcf8aa2ca4125a5b338a899a08dc3.xml b/docs/doxygen/xml/dir_62afcf8aa2ca4125a5b338a899a08dc3.xml
new file mode 100644
index 0000000..b587303
--- /dev/null
+++ b/docs/doxygen/xml/dir_62afcf8aa2ca4125a5b338a899a08dc3.xml
@@ -0,0 +1,18 @@
+
+
+
+ unitTests/framework
+ unitTests/framework/webControlTests
+ __init__.py
+ exceptionTests.py
+ logging_tests.py
+ powerSwitch_tests.py
+ remoteController_test.py
+ startup.py
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/dir_644e041c3a6521da7b27eba0e4eb2b95.xml b/docs/doxygen/xml/dir_644e041c3a6521da7b27eba0e4eb2b95.xml
new file mode 100644
index 0000000..e56875e
--- /dev/null
+++ b/docs/doxygen/xml/dir_644e041c3a6521da7b27eba0e4eb2b95.xml
@@ -0,0 +1,12 @@
+
+
+
+ framework
+ framework/core
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/dir_7a725b7f06931a19d20816064cbe79d7.xml b/docs/doxygen/xml/dir_7a725b7f06931a19d20816064cbe79d7.xml
new file mode 100644
index 0000000..aed8ad4
--- /dev/null
+++ b/docs/doxygen/xml/dir_7a725b7f06931a19d20816064cbe79d7.xml
@@ -0,0 +1,11 @@
+
+
+
+ installation
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/dir_7c3866b21eca5596ae21bf63a2e2d995.xml b/docs/doxygen/xml/dir_7c3866b21eca5596ae21bf63a2e2d995.xml
new file mode 100644
index 0000000..8bcaa66
--- /dev/null
+++ b/docs/doxygen/xml/dir_7c3866b21eca5596ae21bf63a2e2d995.xml
@@ -0,0 +1,30 @@
+
+
+
+ framework/core
+ framework/core/commandModules
+ framework/core/powerModules
+ framework/core/remoteControllerModules
+ framework/core/webpageModules
+ __init__.py
+ capture.py
+ commonRemote.py
+ configParser.py
+ configParserBase.py
+ decodeParams.py
+ deviceManager.py
+ logModule.py
+ outboundClient.py
+ powerControl.py
+ rackController.py
+ rcCodes.py
+ testControl.py
+ utilities.py
+ webpageController.py
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/dir_8a371890c7df54832bedf6136b86116e.xml b/docs/doxygen/xml/dir_8a371890c7df54832bedf6136b86116e.xml
new file mode 100644
index 0000000..c80a026
--- /dev/null
+++ b/docs/doxygen/xml/dir_8a371890c7df54832bedf6136b86116e.xml
@@ -0,0 +1,24 @@
+
+
+
+ unitTests/framework/webControlTests
+ accessElementsTests.py
+ alertTest.py
+ downloadTest.py
+ dynamicButtonsTest.py
+ dynamicTablesTest.py
+ elementAttributeTest.py
+ globalActionTest.py
+ performActionsTests.py
+ saveScreenshotTest.py
+ selectOptionsTests.py
+ sequenceTest.py
+ tabsTest.py
+ webpageControlTests.py
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/dir_8cdaaede5e395ce5a2b7dcd448eefcc0.xml b/docs/doxygen/xml/dir_8cdaaede5e395ce5a2b7dcd448eefcc0.xml
new file mode 100644
index 0000000..c19e1a3
--- /dev/null
+++ b/docs/doxygen/xml/dir_8cdaaede5e395ce5a2b7dcd448eefcc0.xml
@@ -0,0 +1,15 @@
+
+
+
+ framework/core/remoteControllerModules
+ arduino.py
+ none.py
+ olimex.py
+ skyProc.py
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/dir_8f7813a2e1199496bc4aeee3a1228541.xml b/docs/doxygen/xml/dir_8f7813a2e1199496bc4aeee3a1228541.xml
new file mode 100644
index 0000000..d818932
--- /dev/null
+++ b/docs/doxygen/xml/dir_8f7813a2e1199496bc4aeee3a1228541.xml
@@ -0,0 +1,12 @@
+
+
+
+ framework/core/webpageModules
+ seleniumDriver.py
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/dir_e36ba64977d65a0761a291213aecd3cd.xml b/docs/doxygen/xml/dir_e36ba64977d65a0761a291213aecd3cd.xml
new file mode 100644
index 0000000..feccfc7
--- /dev/null
+++ b/docs/doxygen/xml/dir_e36ba64977d65a0761a291213aecd3cd.xml
@@ -0,0 +1,20 @@
+
+
+
+ framework/core/powerModules
+ __init__.py
+ apc.py
+ apcAos.py
+ hs100.py
+ kasaControl.py
+ none.py
+ olimex.py
+ S20control.py
+ SLP.py
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/dir_ed446ba2d365ada0ebb676416d76edde.xml b/docs/doxygen/xml/dir_ed446ba2d365ada0ebb676416d76edde.xml
new file mode 100644
index 0000000..35acd97
--- /dev/null
+++ b/docs/doxygen/xml/dir_ed446ba2d365ada0ebb676416d76edde.xml
@@ -0,0 +1,16 @@
+
+
+
+ framework/core/commandModules
+ __init__.py
+ consoleInterface.py
+ serialClass.py
+ sshConsole.py
+ telnetClass.py
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/downloadTest_8py.xml b/docs/doxygen/xml/downloadTest_8py.xml
new file mode 100644
index 0000000..7634975
--- /dev/null
+++ b/docs/doxygen/xml/downloadTest_8py.xml
@@ -0,0 +1,73 @@
+
+
+
+ downloadTest.py
+ downloadTest::downloadTest
+ downloadTest
+
+
+
+
+
+import import dir_path sys.path.append(dir_path+ "/../../../" ) from import class [downloadTest](testController):def __init__(self, def testFunction(self): "./unitTests/framework/webControlTests/webPageTest.yml" ) "https://testpages.herokuapp.com/styled" , "download_page" ) "Downloading ) "download" ) "downloads/textfile.txt" ) if True , "File ) else : False , "File ) return "Checking ) """This Downloaded Remember """ with as if True , "Content ) else : False , "Content ) if "__main__" : [downloadTest]()
+
+
diff --git a/docs/doxygen/xml/dynamicButtonsTest_8py.xml b/docs/doxygen/xml/dynamicButtonsTest_8py.xml
new file mode 100644
index 0000000..8fcd8ab
--- /dev/null
+++ b/docs/doxygen/xml/dynamicButtonsTest_8py.xml
@@ -0,0 +1,67 @@
+
+
+
+ dynamicButtonsTest.py
+ dynamicButtonsTest::dynamicButtonsTest
+ dynamicButtonsTest
+
+
+
+
+
+import import dir_path sys.path.append(dir_path+ "/../../../" ) from import class [dynamicButtonsTest](testController):def __init__(self, def testFunction(self): "./unitTests/framework/webControlTests/webPageTest.yml" ) "https://testpages.herokuapp.com/styled" , "dynamic_buttons_page" ) "Getting ) "button1" ) if 'One' : False , "Button ) else : True , "Button ) "Getting ) "button2" ) if 'Two' : False , "Button ) else : True , "Button ) "Getting ) "button3" ) if 'Three' : False , "Button ) else : True , "Button ) if "__main__" : [dynamicButtonsTest]()
+
+
diff --git a/docs/doxygen/xml/dynamicTablesTest_8py.xml b/docs/doxygen/xml/dynamicTablesTest_8py.xml
new file mode 100644
index 0000000..f2d890a
--- /dev/null
+++ b/docs/doxygen/xml/dynamicTablesTest_8py.xml
@@ -0,0 +1,167 @@
+
+
+
+ dynamicTablesTest.py
+ dynamicTablesTest::dynamicTablesTest
+ dynamicTablesTest
+
+
+
+
+
+import import import dir_path sys.path.append(dir_path+ "/../../../" ) from import class [dynamicTablesTest](testController):def __init__(self, def testFunction(self): "./unitTests/framework/webControlTests/webPageTest.yml" ) "https://testpages.herokuapp.com/styled" , "dynamic_tables_page" ) "Display ) "dynamic_table" ) for in for in "text" ]) if True , "Table ) else : False , "Table ) "Verify ) "dynamic_table" ) if "text" ] "George" : True , "George ) else : False , "George ) "Add ) "name" ] "Zara" "age" ] "text_area" , "value" )) "update_table" , "dynamic_table" ) if True , "New ) else : False , "New ) "Verify ) "dynamic_table" ) if "text" ] "Zara" : True , "Zara ) else : False , "Zara ) "Verify ) "page_refresh" ) "dynamic_table" ) if True , "Table ) else : False , " ) "Check ) "dynamic_table" ) [getTemporaryElementList](webpageControl._getPage("dynamic_tables_page" )[ "elements" ]) "dynamic_buttons_page" ) [getTemporaryElementList](webpageControl._getPage("dynamic_tables_page" )[ "elements" ]) if and True , "Temporary ) else : False , "Temporary ) "Check ) "dynamic_tables_page" ) "dynamic_table" ) [getTemporaryElementList](webpageControl._getPage("dynamic_tables_page" )[ "elements" ]) "return_to_index_page" ) "index_page" ) [getTemporaryElementList](webpageControl._getPage("dynamic_tables_page" )[ "elements" ]) if and True , "Temporary ) else : False , "Temporary ) "Check ) "dynamic_tables_page" ) "update_table" , "dynamic_table" ) [getTemporaryElementList](webpageControl._getPage("dynamic_tables_page" )[ "elements" ]) "page_refresh" ) "dynamic_table" ) [getTemporaryElementList](webpageControl._getPage("dynamic_tables_page" )[ "elements" ]) if True , "Temporary ) else : False , "Temporary ) def getTemporaryElementList(self, for in if "temporaryFlag" ): return if "__main__" : [dynamicTablesTest]()
+
+
diff --git a/docs/doxygen/xml/elementAttributeTest_8py.xml b/docs/doxygen/xml/elementAttributeTest_8py.xml
new file mode 100644
index 0000000..32d21d4
--- /dev/null
+++ b/docs/doxygen/xml/elementAttributeTest_8py.xml
@@ -0,0 +1,54 @@
+
+
+
+ elementAttributeTest.py
+ elementAttributeTest::elementAttributeTest
+ elementAttributeTest
+
+
+
+
+
+import import dir_path sys.path.append(dir_path+ "/../../../" ) from import class [elementAttributeTest](testController):def __init__(self, def testFunction(self): "./unitTests/framework/webControlTests/webPageTest.yml" ) "https://testpages.herokuapp.com/styled" , "attributes_page" ) "Getting ) "paragraph" , "title" ) if "a : True , "Attribute ) else : False , "Attribute ) if "__main__" : [elementAttributeTest]()
+
+
diff --git a/docs/doxygen/xml/exceptionTests_8py.xml b/docs/doxygen/xml/exceptionTests_8py.xml
new file mode 100644
index 0000000..59d608a
--- /dev/null
+++ b/docs/doxygen/xml/exceptionTests_8py.xml
@@ -0,0 +1,86 @@
+
+
+
+ exceptionTests.py
+ framework::exceptionTests::framework_test1
+ framework::exceptionTests
+
+
+
+
+
+import import dir_path sys.path.append(dir_path+ "/../../" ) from import from import class [framework_test1](testController):def __init__(self, [exitOnError]"framework_test" , "1" , def waitForBoot(self): "waitForBoot ) return True def testFunction(self): if [exitOnError]True : "UnitTest , "This ) raise "I ) return False "UnitTest , "This ) "unit_test2 ) True , "Happy ) return True def testExceptionCleanUp(self): "testExceptionCleanUp()-> ) if '__main__' : "GroupTest1" , "GroupTest1" , "1234" [framework_test1](summary,True ) [framework_test1](summary)[framework_test1](summary,True ) "GroupTest1 ) [framework_test1]()
+
+
diff --git a/docs/doxygen/xml/framework_2core_2____init_____8py.xml b/docs/doxygen/xml/framework_2core_2____init_____8py.xml
new file mode 100644
index 0000000..d924dbb
--- /dev/null
+++ b/docs/doxygen/xml/framework_2core_2____init_____8py.xml
@@ -0,0 +1,41 @@
+
+
+
+ __init__.py
+ core
+
+
+
+
+
+from import from import from import from import from import from import from import from import as from import
+
+
diff --git a/docs/doxygen/xml/framework_2core_2commandModules_2____init_____8py.xml b/docs/doxygen/xml/framework_2core_2commandModules_2____init_____8py.xml
new file mode 100644
index 0000000..f165334
--- /dev/null
+++ b/docs/doxygen/xml/framework_2core_2commandModules_2____init_____8py.xml
@@ -0,0 +1,23 @@
+
+
+
+ __init__.py
+ core::commandModules
+
+
+
+
+
+import import dir_path sys.path.append(
+
+
diff --git a/docs/doxygen/xml/framework_2core_2powerModules_2____init_____8py.xml b/docs/doxygen/xml/framework_2core_2powerModules_2____init_____8py.xml
new file mode 100644
index 0000000..483e76b
--- /dev/null
+++ b/docs/doxygen/xml/framework_2core_2powerModules_2____init_____8py.xml
@@ -0,0 +1,23 @@
+
+
+
+ __init__.py
+ core::powerModules
+
+
+
+
+
+import import dir_path sys.path.append(
+
+
diff --git a/docs/doxygen/xml/globalActionTest_8py.xml b/docs/doxygen/xml/globalActionTest_8py.xml
new file mode 100644
index 0000000..5d470f3
--- /dev/null
+++ b/docs/doxygen/xml/globalActionTest_8py.xml
@@ -0,0 +1,116 @@
+
+
+
+ globalActionTest.py
+ globalActionTest::globalActionTest
+ globalActionTest
+
+
+
+
+
+import import dir_path sys.path.append(dir_path+ "/../../../" ) from import class [globalActionTest](testController):def __init__(self, def testFunction(self): "./unitTests/framework/webControlTests/webPageTest.yml" ) "https://testpages.herokuapp.com/styled" , "alert_action" , "password123" , "unitTests/framework/webControlTests/mockUploadFile.txt" ), "Selection , "Selection , "Drop ) "form_results_page" ) "Checking ) "username_value" ) if 'admin' : False , "Username ) else : True , "Username ) "Checking ) "password_value" ) if 'password123' : False , "Password ) else : True , "Password ) "Checking ) "filename_value" ) if 'mockUploadFile.txt' : False , "Filename ) else : True , "Filename ) "Checking ) "checkbox_1_value" ) if 'cb2' : False , "Checkbox ) else : True , "Checkbox ) "Checking ) "checkbox_2_value" ) if 'cb3' : False , "Checkbox ) else : True , "Checkbox ) "Checking ) "radio_button_value" ) if 'rd3' : False , "Radio ) else : True , "Radio ) "Checking ) "multiselect_1_value" ) if 'ms2' : False , "Multiselect ) else : True , "Multiselect ) "Checking ) "multiselect_2_value" ) if 'ms4' : False , "Multiselect ) else : True , "Multiselect ) "Checking ) "dropdown_value" ) if 'dd6' : False , "Dropdown ) else : True , "Dropdown ) if "__main__" : [globalActionTest]()
+
+
diff --git a/docs/doxygen/xml/hs100_8py.xml b/docs/doxygen/xml/hs100_8py.xml
new file mode 100644
index 0000000..bdd66f9
--- /dev/null
+++ b/docs/doxygen/xml/hs100_8py.xml
@@ -0,0 +1,135 @@
+
+
+
+ hs100.py
+ core::powerModules::hs100::powerHS100
+ core::powerModules::hs100
+
+
+
+
+
+import import import from import import class [powerHS100]():def __init__( [ip]if is None : [port][log][commands]'info' '{"system":{"get_sysinfo":{}}}' , 'on' '{"system":{"set_relay_state":{"state":1}}}' , 'off' '{"system":{"set_relay_state":{"state":0}}}' , 'ledoff' '{"system":{"set_led_off":{"off":1}}}' , 'ledon' '{"system":{"set_led_off":{"off":0}}}' , 'cloudinfo' : '{"cnCloud":{"get_info":{}}}' , 'wlanscan' '{"netif":{"get_scaninfo":{"refresh":0}}}' , 'time' '{"time":{"get_time":{}}}' , 'schedule' '{"schedule":{"get_rules":{}}}' , 'countdown' : '{"count_down":{"get_rules":{}}}' , 'antitheft' : '{"anti_theft":{"get_rules":{}}}' , 'reboot' '{"system":{"reboot":{"delay":1}}}' , 'reset' '{"system":{"reset":{"delay":1}}}' , 'energy' '{"emeter":{"get_realtime":{}}}' def [encrypt](self,"""Encryption '>I' , for in return def [decrypt](self,"""Decryption "" for in return def [switchCommand](self,"""send False while try : [ip],[port]))None ) [encrypt](self.[commands][key]))[decrypt](data[4:])[log].debug("Sent: .format(key)) [log].debug("Received: .format(decrypted)) if 'on' : [powerOnState]True True break except as [log].error("PowerControl return def powerOff(self): [switchCommand]('off' ) return def powerOn(self): [switchCommand]('on' ) return def switchReboot(self): [switchCommand]('reboot' ) return def reboot(self): [powerOff]()if True : [log].error(" ) [powerOn]()if True : [log].error(" ) return
+
+
diff --git a/docs/doxygen/xml/index.xml b/docs/doxygen/xml/index.xml
new file mode 100644
index 0000000..8cae20d
--- /dev/null
+++ b/docs/doxygen/xml/index.xml
@@ -0,0 +1,1133 @@
+
+
+ accessElementsTests::accessElementsTest
+ __init__ testFunction alertTest::alertTest
+ __init__ testFunction core::capture::capture
+ log resolution captureImagesPath ocrEnginePath captureInput captureImagesCount videoApi regionDetails screenRegions __init__ setRegions start stop startImageCapture getRegionCoords applyOcrImageFilter __getOCRText__ checkOcrText waitForDisplayedScreen core::commonRemote::commonRemoteClass
+ log remoteConfig remoteMap type remoteController __init__ sendKey setKeyMap getKeyMap __decodeRemoteMapConfig core::rackController::configDecoderClass
+ __init__ checkRequiredField decodeConfigItem setConfigValue dumpValue core::configParser::configParser
+ log local cpe memoryMap validImages __init__ decodeConfig __decodeMemoryMapConfig__ updateCPEConfig createCpeConfig __decodeCPEConfig__ getCPEEntryViaPlatform getCPEFieldViaPlatform getMemoryMapViaPlatform getMemoryMapValueViaPlatform getWorkspaceDirectory getAlternativePlatform core::configParserBase::configParserBase
+ log __init__ decodeTable decodeParam __getFieldValue__ core::deviceManager::consoleClass
+ session type __init__ core::commandModules::consoleInterface::consoleInterface
+ write open read_all read_until close core::decodeParams::decodeParams
+ jobId rackJobExecutionId testMode debug loop log buildConfig overrideCpeConfig args rackConfig deviceConfig __init__ decodeDeviceConfig decodeConfigIntoDictionary framework::remoteController_test::demoClass
+ core::deviceManager::deviceClass
+ consoles powerControl outBoundClient remoteController rawConfig deviceName __init__ getField getConsoleSession core::deviceManager::deviceManager
+ rawConfig devices log logPath __init__ getDevice downloadTest::downloadTest
+ __init__ testFunction dynamicButtonsTest::dynamicButtonsTest
+ __init__ testFunction dynamicTablesTest::dynamicTablesTest
+ __init__ testFunction getTemporaryElementList elementAttributeTest::elementAttributeTest
+ __init__ testFunction framework::exceptionTests::framework_test1
+ exitOnError __init__ waitForBoot testFunction testExceptionCleanUp framework::startup::framework_test1
+ __init__ testFunction globalActionTest::globalActionTest
+ __init__ testFunction core::logModule::logModule
+ TEST_RESULT FATAL moduleName SEPERATOR SEPERATOR_STAR LARGE_SEPERATOR INDENT_DEFAULT indentString DEBUG INFO WARNING ERROR CRITICAL STEP STEP_START TEST_START STEP_RESULT TEST_SUMMARY RESULT log moduleName format logConsole csvLogger stepNum summaryQcID summaryTestName summaryTestTotal summaryTestsFailed summaryTestsPassed totalStepsFailed totalStepsPassed totalSteps testDuration testCountActive path logFile csvLogFile logPath indentString testName qcId loopCount maxRunTime failedSteps start_time end_time timeFormat testStartTime testActive loopStartTime __init__ __del__ setFilename fatal warn error critical debug info stepMessage stepStartMessage stepResultMessage testStartMessage testResultMessage testSummaryMessage setLevel message indent outdent testStart testLoop testLoopComplete testResult stepStart step stepResult core::powerModules::S20control::OrviboS20
+ DEBUG subscribed exitontimeout sock __enter__ __exit__ __init__ close listen discover globaldiscover subscribe poweron poweroff _settimeout _sendpacket _listendiscover _subscribeifneeded core::outboundClient::outboundClientClass
+ log logBase workspaceDirectory upload_url uploadPath httpProxy uploadPort uploadAddress __init__ __del__ __configureUploadProtocol__ downloadFile prepareOutboundWithImageFromUrl translateImageTypeToImageFilename getSizeInHumanReadable __downloadSFTP__ cleanWorkspace __uploadSFTP__ progressSFTP __downloadHTTP__ uploadFile retrieveListofFilenamesFromUrl performActionsTests::performActionsTests
+ __init__ testFunction core::powerModules::apc::powerAPC
+ hostName userName password outletNumber log telnet __init__ pduPowerSetting checkConnection open close waitAPCNextline configurePDU selectPDUOutlet sendPowerON sendPowerOFF powerOff powerOn reboot core::powerModules::apcAos::powerApcAos
+ hostName userName password port outletNumber log telnet __init__ open close waitForPrompt sendCommand powerOn powerOff reboot core::powerControl::powerControlClass
+ log utils ip name retryCount retryDelay powerOnState powerSwitch __init__ powerOn powerOff reboot powerRetry core::powerModules::hs100::powerHS100
+ ip port log commands powerOnState __init__ encrypt decrypt switchCommand powerOff powerOn switchReboot reboot core::powerModules::kasaControl::powerKasa
+ log is_on is_off slotIndex ip options args __init__ split_with_quotes remove_empty_strings performCommand powerOff powerOn __getstate__ reboot core::powerModules::none::powerNone
+ log __init__ powerOn powerOff reboot core::powerModules::olimex::powerOlimex
+ log ip port relay telnet __init__ command powerOff powerOn reboot core::powerModules::S20control::powerOrviboS20
+ log ip mac port switch __init__ powerOn powerOff reboot core::powerModules::SLP::powerSLP
+ log ip username password outlet port telnet __init__ command powerOff powerOn reboot core::rackController::rack
+ slot log __init__ addSlot getSlot getSlotByName core::rackController::rackController
+ racks description log decodeRackConfig __init__ getRackByName getRackByIndex getRackServerHostname getRackDescription core::rackController::rackSlot
+ config log __init__ getDevice find_name get getName getRackName setRackName getRemoteKeyType getDeviceAddress getDeviceIp getPlatform getOutboundUploadDirectory getOutboundDownloadDirectory show core::rcCodes::rcCode
+ NUM_0 NUM_1 NUM_2 NUM_3 NUM_4 NUM_5 NUM_6 NUM_7 NUM_8 NUM_9 POWER MUTE VOL_UP VOL_DOWN CHANNEL_UP CHANNEL_DOWN PAUSE FFWD FORWARD FFORWARD AUDDESC SUBT REWIND PLAY STOP RECORD LOBATT UP DOWN LEFT RIGHT SELECT RED GREEN YELLOW BLUE SEARCH SKY HELP BACKUP EXIT HOME APPS BACK CROSS MIC RGYB PICK_UP TEST RST FAC CSM PATTERN ANTENNA_CABLE PRE_CH VOL_MAX CTC VOL_BUZZ MENU BI CH_SCAN CCTT PIC LOG_LED AUDIO D2D3 ARC CIP VIRGIN CVBS YPBPR_SCART HDMI VGA REGIN CLONE RESERVE1 DCR WIFI_SSID BLK WP LIGHT_SENSOR USB RJ45 RS232 RESERVE2 arduino::remoteArduino
+ log remoteConfig arduino firstKeyPressInTc __init__ sendKey core::commonRemote::remoteControllerMapping
+ log currentMap maps __init__ getMappedKey getKeyMap setKeyMap none::remoteNone
+ log __init__ sendKey olimex::remoteOlimex
+ log remoteController telnet __init__ command sendKey skyProc::remoteSkyProc
+ log ip port telnet __init__ command sendKey saveScreenshotTest::saveScreenshotTest
+ __init__ testFunction selectOptionsTests::selectOptionsTests
+ __init__ testFunction seleniumDriver::seleniumDriver
+ log browser __init__ navigateTo getElementType waitForElement sendKeys click selectFromDropdown getText clear acceptAlert refresh getElementAttribute isElementSelected getSelectedOptions getFirstSelectedOption getSelectAvailableOptions getAlertText dismissAlert saveScreenshot getHtml getTableElements getXpath newTab switchTab getWindowId getSubElements _setWebdriver _getElement _createElementsDictionary sequenceTest::sequenceTest
+ __init__ testFunction core::commandModules::serialClass::serialSession
+ log workspacePath serialPort serialFile timeout baudRate type serialCon serialFileHandler __init__ open close write writeLines read_until read_all flush core::commandModules::sshConsole::sshConsole
+ address username password key console buffer stdout type stderr __init__ open write read_all read_until close tabsTest::tabsTest
+ __init__ testFunction core::commandModules::telnetClass::telnet
+ tn username password type host port timeout log sessionLogFile sessionLogHand __init__ open close connect disconnect write read_until read_eager read_very_eager read_some read_all core::testControl::testController
+ slotInfo log session fullPath testMode loopCount TEST_MAX_RUN_TIME pingStartTime timeString alive elapsed_time elasped_string testStartTime summaryLog summaryLogCreated maxRunTime loopCount result testName qcId capture webpageController config rackControl deviceConfig testMode logConfig logPath testLogPath devices dut outboundClient powerControl commonRemote utils cpe webDriverConfig buildConfig overrideCpeConfig output __init__ addDelimiter constructLogPath constructTestPath waitForBoot testFunction testPrepareFunction testEndFunction testExceptionCleanUp waitSeconds waitForSessionMessage writeMessageToSession programOutboundWithValidImage processBuildConfiguration validatePlatform run parseException signal_handler runHostCommand syscmd pingTest waitForPrompt _pingTestOnly core::powerModules::S20control::UnknownPacket
+ core::utilities::utilities
+ log __init__ wait fuzzyCompareText value1HigherThanValue2 core::webpageController::webpageController
+ _pages webDriver log currentTab currentPage currentPageName currentView defaultView tabs url webpageConfig globalActions __init__ configureWebpages setWebpage navigateTo pages performAction getTextOfElement performInteraction performGlobalAction getElementAttribute isElementSelected getSelectedOptions getFirstSelectedOption getSelectAvailableOptions getUrl getAlertText closeBrowser saveScreenshot saveHtmlSnapshot getDynamicTable getDynamicTableText removeTemporaryWebElements createNewTab switchTab getTabs getTab getSubElements _setBaseUrl _setWebpageConfig _isConfigured _isOnPage _navigateSequence _checkElements _validateView _getPage _getElement _getViewForElement _getView _activateView _getAction _interactionArgsSub _getwindowId accessElementsTests
+ dir_path test alertTest
+ dir_path test arduino
+ core
+ core::capture
+ core::commandModules
+ dir_path core::commandModules::consoleInterface
+ core::commandModules::serialClass
+ core::commandModules::sshConsole
+ core::commandModules::telnetClass
+ core::commonRemote
+ core::configParser
+ getImageField getNegativeImageUrlViaPlatform getValidImageUrlViaPlatform getValidImages core::configParserBase
+ core::decodeParams
+ core::deviceManager
+ dir_path core::logModule
+ core::outboundClient
+ core::powerControl
+ core::powerModules
+ dir_path core::powerModules::apc
+ CONNECT_MSG POWER_ON POWER_OFF REBOOT REBOOT_WAIT core::powerModules::apcAos
+ CMD_PROMPT POWER_ON POWER_OFF REBOOT REBOOT_WAIT core::powerModules::hs100
+ core::powerModules::kasaControl
+ core::powerModules::none
+ core::powerModules::olimex
+ core::powerModules::S20control
+ usage main core::powerModules::SLP
+ core::rackController
+ core::rcCodes
+ core::testControl
+ dir_path core::utilities
+ core::webpageController
+ dir_path downloadTest
+ dir_path test dynamicButtonsTest
+ dir_path test dynamicTablesTest
+ dir_path test elementAttributeTest
+ dir_path test framework
+ dir_path framework::exceptionTests
+ dir_path summary qcId exitOnError framework::logging_tests
+ dir_path log moduleLog end_time loopCount framework::powerSwitch_tests
+ dir_path log utils config rackControl rack slot devices dut power framework::remoteController_test
+ dir_path demo framework::startup
+ dir_path test globalActionTest
+ dir_path test none
+ olimex
+ performActionsTests
+ dir_path test saveScreenshotTest
+ dir_path test selectOptionsTests
+ dir_path test seleniumDriver
+ sequenceTest
+ dir_path test skyProc
+ tabsTest
+ dir_path test webpageControlTests
+ dir_path summary log CONTRIBUTING.md
+ __init__.py
+ __init__.py
+ __init__.py
+ __init__.py
+ capture.py
+ consoleInterface.py
+ serialClass.py
+ sshConsole.py
+ telnetClass.py
+ commonRemote.py
+ configParser.py
+ configParserBase.py
+ decodeParams.py
+ deviceManager.py
+ logModule.py
+ outboundClient.py
+ powerControl.py
+ apc.py
+ apcAos.py
+ hs100.py
+ kasaControl.py
+ none.py
+ none.py
+ olimex.py
+ olimex.py
+ S20control.py
+ SLP.py
+ rackController.py
+ rcCodes.py
+ arduino.py
+ skyProc.py
+ testControl.py
+ utilities.py
+ webpageController.py
+ seleniumDriver.py
+ requirements.txt
+ requirements.txt
+ README.md
+ exceptionTests.py
+ logging_tests.py
+ powerSwitch_tests.py
+ remoteController_test.py
+ startup.py
+ accessElementsTests.py
+ alertTest.py
+ downloadTest.py
+ dynamicButtonsTest.py
+ dynamicTablesTest.py
+ elementAttributeTest.py
+ globalActionTest.py
+ mockUploadFile.txt
+ performActionsTests.py
+ saveScreenshotTest.py
+ selectOptionsTests.py
+ sequenceTest.py
+ tabsTest.py
+ webpageControlTests.py
+ md_CONTRIBUTING
+ md_README
+ framework/core/commandModules
+ framework/core
+ framework
+ unitTests/framework
+ installation
+ framework/core/powerModules
+ framework/core/remoteControllerModules
+ unitTests
+ unitTests/framework/webControlTests
+ framework/core/webpageModules
+
diff --git a/docs/doxygen/xml/index.xsd b/docs/doxygen/xml/index.xsd
new file mode 100644
index 0000000..04cb2f1
--- /dev/null
+++ b/docs/doxygen/xml/index.xsd
@@ -0,0 +1,67 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/installation_2requirements_8txt.xml b/docs/doxygen/xml/installation_2requirements_8txt.xml
new file mode 100644
index 0000000..933fd8e
--- /dev/null
+++ b/docs/doxygen/xml/installation_2requirements_8txt.xml
@@ -0,0 +1,29 @@
+
+
+
+ requirements.txt
+
+
+
+
+
+opencv-python requests requests[socks] paramiko fabric python-kasa pyserial asyncio pyyaml beautifulsoup4 opencv-python pytesseract pillow selenium boto3 cdrouter
+
+
diff --git a/docs/doxygen/xml/kasaControl_8py.xml b/docs/doxygen/xml/kasaControl_8py.xml
new file mode 100644
index 0000000..d357824
--- /dev/null
+++ b/docs/doxygen/xml/kasaControl_8py.xml
@@ -0,0 +1,202 @@
+
+
+
+ kasaControl.py
+ core::powerModules::kasaControl::powerKasa
+ core::powerModules::kasaControl
+
+
+
+
+
+import import import from import class [powerKasa]():"""Kasa def [__init__](None , None , """[init [log][is_on]False [is_off]False [slotIndex]=0[ip]if None : "--plug" if None : "" else : [slotIndex]=int(args.split("--index )[1]) [options][args]def split_with_quotes(self, False for in '"' ): if not else : not return def remove_empty_strings(self, for in if "" ): return def performCommand(self, "" "--host .format(self.[ip]) if False : "{} .format([options] "{}" .format(command) if False : " .format(self.[args]) [split_with_quotes]("kasa [log].debug("Command: .format(command)) True ) [log].debug(data.stdout)return def powerOff(self): [__getstate__]()if [is_off]:return True [performCommand]("off" ) [__getstate__]()if [is_off]False : [log].error(" ) return [is_off]def powerOn(self): [__getstate__]()if [is_on]:return True [performCommand]("on" ) [__getstate__]()if [is_on]False : [log].error(" ) return [is_on]def __getstate__(self): if "strip" in [options]:[performCommand]("state" , True ) "state: ) for in if "ON" : "ON" ) elif "OFF" : "OFF" ) if [log].debug(powerState)if "OFF" : [is_on]False [is_off]True [log].debug("Device ) return if [slotIndex]+1]"OFF" : [is_on]False [is_off]True [log].debug("Slot ) else : [is_on]True [is_off]False [log].debug("Slot ) else : [performCommand]("state" ) if "Device in [is_on]False [is_off]True [log].debug("Device ) else : [is_on]True [is_off]False [log].debug("Device ) def reboot(self): [powerOff]()if True : [powerOn]()return
+
+
diff --git a/docs/doxygen/xml/logModule_8py.xml b/docs/doxygen/xml/logModule_8py.xml
new file mode 100644
index 0000000..3e23ce8
--- /dev/null
+++ b/docs/doxygen/xml/logModule_8py.xml
@@ -0,0 +1,313 @@
+
+
+
+ logModule.py
+ core::logModule::logModule
+ core::logModule
+
+
+
+
+
+import import import import from import from import from import class [logModule]():"" " " "==================================================" " "" def [__init__](self,"""[init [log][moduleName][format]'%(asctime)-15s, , '%Y-%m-%d [logConsole][logConsole].setFormatter([format][log].addHandler([logConsole][log].setLevel(level)[csvLogger][moduleName]+"csv" ) [csvLogger].setLevel([TEST_START],"TEST_START" [TEST_RESULT],"TEST_RESULT" [TEST_SUMMARY],"TEST_SUMMARY" [STEP],"STEP" [STEP_START],"STEP_START" [STEP_RESULT],"STEP_RESULT" [FATAL],"FATAL" [log].debug('logModule: +moduleName) [stepNum][summaryQcID]"" [summaryTestName]"" [summaryTestTotal][summaryTestsFailed][summaryTestsPassed][totalStepsFailed][totalStepsPassed][totalSteps][testDuration][stepNum][testCountActive][path]None [logFile]None [csvLogFile]None def __del__(self): while [log].hasHandlers():[log].removeHandler(self.[log].handlers[0])def setFilename( if [logFile]None : return [logPath][logFile][logFile].setFormatter([format][log].addHandler([logFile][csvLogFile]".csv" [csvLogger].addHandler([csvLogFile][csvLogger].info("QcId, ) [log].info("Log .format(logFileName) def fatal(self, [log]._log(self.[FATAL],[indentString]+str(message),def warn(self,message,extra=None): [log].warning(self.[indentString]+str(message),extra=extra)def error(self,message,extra=None): [log].error(self.[indentString]+str(message),extra=extra)def critical(self,message,extra=None): [log].critical(self.[indentString]+str(message),extra=extra)def debug(self,message,extra=None): [log].debug(self.[indentString]+str(message),extra=extra)def info(self,message,extra=None): [log].info(self.[indentString]+str(message),extra=extra)def stepMessage(self,message,*args, [log]._log(self.[STEP],def stepStartMessage(self,message,*args, [log]._log(self.[STEP_START],def stepResultMessage(self,message,*args, [log]._log(self.[STEP_RESULT],def testStartMessage(self,message,*args, [log]._log(self.[TEST_START],def testResultMessage(self,message,*args, [log]._log(self.[TEST_RESULT],def testSummaryMessage(self,message,*args, [log]._log(self.[TEST_SUMMARY],def setLevel( [log].setLevel(def message( [debug],[info],[step],[error],[fatal],[critical]return def [indent](""" [indentString]=self.[indentString]+stringreturn False def [outdent](self,""" [indentString])if [indentString]="" return False [indentString]=self.[indentString][0:indentLength-stringLength][indentString])return True def testStart(self, [testName]=testName[qcId][loopCount][maxRunTime][stepNum]=0[failedSteps]"" : "" } if [testCountActive][summaryTestTotal][summaryTestsPassed][summaryTestsFailed][summaryTestName][summaryQcID][testCountActive][summaryTestTotal][totalSteps][totalStepsPassed][totalStepsFailed][start_time][end_time][start_time][maxRunTime])[end_time][start_time][timeFormat]"%Y-%m-%d "Run [testName]"], [qcId]"] +str(self.[maxRunTime])+ "]:[" +str(durationTime)+ "], +str(self.[loopCount])+ "]" +logModule.SEPERATOR [testStartMessage](if [maxRunTime][log].info("Start +[start_time].strftime(self.[timeFormat]) "], +[end_time].strftime(self.[timeFormat]) "]" +logModule.SEPERATOR else : [log].info("Start +[start_time].strftime(self.[timeFormat]) "]" +logModule.SEPERATOR [testStartTime][testActive]True return [end_time]def testLoop(self, [step](logModule.SEPERATOR_STAR+"Test "], +self.[testStartTime].strftime(self.[timeFormat])+ "]" def testLoopComplete(self, [testStartTime]"Completed +str(loopIndex)+ "], +[timeFormat]) "], +str(loopDuration)+ "]" [step]([loopStartTime]None def testResult(self, if [testCountActive][testCountActive][testStartTime][testDuration][step]("====================Result====================" , False ) if [totalStepsFailed]"FAILED" [summaryTestsFailed]else : "PASSED" [summaryTestsPassed]"[{}]: .format(resultMessage,message) [testResultMessage](message)if [testCountActive]if [summaryTestsFailed][summaryTestsPassed][summaryTestTotal]-1:[summaryTestTotal]"testName: .format(self.[summaryTestName],[summaryQcID],[summaryTestTotal],self.[summaryTestsPassed],self.[summaryTestsFailed], [testSummaryMessage](message)[step]("====================End , False ) [testCountActive][csvLogger].info("{},{},{},{},{},{}" .[summaryQcID],[summaryTestName],[failedSteps].keys())[-1],[failedSteps].values())[-1], else : [csvLogger].info("{},{},{},{},{},{}" .[qcId],[testName],[failedSteps].keys())[-1],[failedSteps].values())[-1], def stepStart(self, [totalSteps][stepNum][step]("====================Step , False ) [stepStartMessage]("[{}]: .format(self.[stepNum], if is not None : [step]("EXPECTED .format(expected)) [step](self.[LARGE_SEPERATOR],False ) def step(self, "[{}]: .format(self.[stepNum],[indentString], if False : "{}{}" .format(self.[indentString],message) [stepMessage](def stepResult(self, if True : "PASSED" [totalStepsPassed]else : "FAILED" [totalStepsFailed][failedSteps][self.[stepNum]]"[{}]: .format(self.[stepNum],resultMessage, [step]("=====================Step ,showStepNumber= False ) [stepResultMessage](message)
+
+
diff --git a/docs/doxygen/xml/logging__tests_8py.xml b/docs/doxygen/xml/logging__tests_8py.xml
new file mode 100644
index 0000000..6019639
--- /dev/null
+++ b/docs/doxygen/xml/logging__tests_8py.xml
@@ -0,0 +1,117 @@
+
+
+
+ logging_tests.py
+ framework::logging_tests
+
+
+
+
+
+import import dir_path sys.path.append(dir_path+ "/../../" ) import as if "__main__" : "logging_tests.py" ) "module" ) "testLog.log" "pythonLogTest" , "PLT-0001" , "end_time:" +str(end_time)) "Test "pythonLogTest" , "PLT-0002" , for in "loop , "all ) "in1" "in2" "in3" "in4" "in5" True , "Loop .format(int(loop))) "Test "pythonLogTest" , "PLT-0003" , "Starting , "Something ) "I ) "I ) "I ) "in1" "in2" "in3" "in4" "in5" True , "out1" "Starting , "really ) "in2" "in1" "in2" "in3" "in4" False , "out2" "Starting , "something ) "in3" "in1" "in2" "in3" "in4" True , "out3" "Starting , "lots ) "in99" False , "out4" "Test "debug "debug "Info "Warning "Info "Error "Critical "FATAL "Message ) "Error )
+
+
diff --git a/docs/doxygen/xml/md_CONTRIBUTING.xml b/docs/doxygen/xml/md_CONTRIBUTING.xml
new file mode 100644
index 0000000..191d75f
--- /dev/null
+++ b/docs/doxygen/xml/md_CONTRIBUTING.xml
@@ -0,0 +1,30 @@
+
+
+
+ md_CONTRIBUTING
+ Contributing
+
+
+
+
+First-Time Contributors
+First-time users are requested to agree to the license .
+
+
+Contribution Workflow
+The following flow is expected for all code submissons:
+Create a branch with a name following the guidelines: gh(x)_(synopsis)
+where x is the ticket number
+where synopsis is a short synopsis for the reason for the branch.
+
+
+Create a pull request https://github.com/rdkcentral/python_raft/compare when the code changes are ready for review.
+The team will review, and if accepted your changes will be merged to the mainline.
+
+
+All changes must be submitted for review with a corresponding issue, python_raft/issues . If an issue does not exist for the change you wish to contribute, please create one with a detailed description of the reason for your change.
+
+
+
diff --git a/docs/doxygen/xml/md_README.xml b/docs/doxygen/xml/md_README.xml
new file mode 100644
index 0000000..fa43846
--- /dev/null
+++ b/docs/doxygen/xml/md_README.xml
@@ -0,0 +1,70 @@
+
+
+
+ md_README
+ README
+
+
+
+
+RAFT
+**R**apid **A**pplication **F**ramework for **T**esting.
+RAFT is a Python based testing framework for writing engineering tests.
+
+Contents
+
+Installation Getting Started Documentation Contributing
+
+
+* <a href="#license">License</a>
+
+
+Installation
+
+Requirements
+
+Python (=3.11.8)
+Pyenv can be used to manage multiple versions of Python (please refer to the documentation ).
+
+
+All the packages listed in requirements.txt
+Can be installed using $ pip install -r requirements.txt
+
+
+
+
+
+User Installation
+Clone the repository and ensure that all requirements are met.
+
+
+
+Getting Started
+WIP
+
+
+Documentation
+WIP
+
+
+Contributing
+See contributing file: [CONTRIBUTING.md]
+
+
+License
+See license file: LICENSE
+
+
+
+
+
diff --git a/docs/doxygen/xml/mockUploadFile_8txt.xml b/docs/doxygen/xml/mockUploadFile_8txt.xml
new file mode 100644
index 0000000..3b6ae8b
--- /dev/null
+++ b/docs/doxygen/xml/mockUploadFile_8txt.xml
@@ -0,0 +1,13 @@
+
+
+
+ mockUploadFile.txt
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespaceaccessElementsTests.xml b/docs/doxygen/xml/namespaceaccessElementsTests.xml
new file mode 100644
index 0000000..8e35a4b
--- /dev/null
+++ b/docs/doxygen/xml/namespaceaccessElementsTests.xml
@@ -0,0 +1,42 @@
+
+
+
+ accessElementsTests
+ accessElementsTests::accessElementsTest
+
+
+ accessElementsTests.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+ accessElementsTests.test
+ test
+ = [accessElementsTest]()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacealertTest.xml b/docs/doxygen/xml/namespacealertTest.xml
new file mode 100644
index 0000000..8c2336e
--- /dev/null
+++ b/docs/doxygen/xml/namespacealertTest.xml
@@ -0,0 +1,42 @@
+
+
+
+ alertTest
+ alertTest::alertTest
+
+
+ alertTest.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+ alertTest.test
+ test
+ = [alertTest]()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacearduino.xml b/docs/doxygen/xml/namespacearduino.xml
new file mode 100644
index 0000000..57d5b2c
--- /dev/null
+++ b/docs/doxygen/xml/namespacearduino.xml
@@ -0,0 +1,12 @@
+
+
+
+ arduino
+ arduino::remoteArduino
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore.xml b/docs/doxygen/xml/namespacecore.xml
new file mode 100644
index 0000000..44c232a
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore.xml
@@ -0,0 +1,27 @@
+
+
+
+ core
+ core::capture
+ core::commandModules
+ core::commonRemote
+ core::configParser
+ core::configParserBase
+ core::decodeParams
+ core::deviceManager
+ core::logModule
+ core::outboundClient
+ core::powerControl
+ core::powerModules
+ core::rackController
+ core::rcCodes
+ core::testControl
+ core::utilities
+ core::webpageController
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1capture.xml b/docs/doxygen/xml/namespacecore_1_1capture.xml
new file mode 100644
index 0000000..159f918
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1capture.xml
@@ -0,0 +1,12 @@
+
+
+
+ core::capture
+ core::capture::capture
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1commandModules.xml b/docs/doxygen/xml/namespacecore_1_1commandModules.xml
new file mode 100644
index 0000000..8752780
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1commandModules.xml
@@ -0,0 +1,31 @@
+
+
+
+ core::commandModules
+ core::commandModules::consoleInterface
+ core::commandModules::serialClass
+ core::commandModules::sshConsole
+ core::commandModules::telnetClass
+
+
+ core::commandModules.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1commandModules_1_1consoleInterface.xml b/docs/doxygen/xml/namespacecore_1_1commandModules_1_1consoleInterface.xml
new file mode 100644
index 0000000..ef12772
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1commandModules_1_1consoleInterface.xml
@@ -0,0 +1,12 @@
+
+
+
+ core::commandModules::consoleInterface
+ core::commandModules::consoleInterface::consoleInterface
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1commandModules_1_1serialClass.xml b/docs/doxygen/xml/namespacecore_1_1commandModules_1_1serialClass.xml
new file mode 100644
index 0000000..d4bc5e2
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1commandModules_1_1serialClass.xml
@@ -0,0 +1,12 @@
+
+
+
+ core::commandModules::serialClass
+ core::commandModules::serialClass::serialSession
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1commandModules_1_1sshConsole.xml b/docs/doxygen/xml/namespacecore_1_1commandModules_1_1sshConsole.xml
new file mode 100644
index 0000000..9de8dc4
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1commandModules_1_1sshConsole.xml
@@ -0,0 +1,12 @@
+
+
+
+ core::commandModules::sshConsole
+ core::commandModules::sshConsole::sshConsole
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1commandModules_1_1telnetClass.xml b/docs/doxygen/xml/namespacecore_1_1commandModules_1_1telnetClass.xml
new file mode 100644
index 0000000..9af8dc6
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1commandModules_1_1telnetClass.xml
@@ -0,0 +1,12 @@
+
+
+
+ core::commandModules::telnetClass
+ core::commandModules::telnetClass::telnet
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1commonRemote.xml b/docs/doxygen/xml/namespacecore_1_1commonRemote.xml
new file mode 100644
index 0000000..7bf5f53
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1commonRemote.xml
@@ -0,0 +1,13 @@
+
+
+
+ core::commonRemote
+ core::commonRemote::commonRemoteClass
+ core::commonRemote::remoteControllerMapping
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1configParser.xml b/docs/doxygen/xml/namespacecore_1_1configParser.xml
new file mode 100644
index 0000000..78c5be5
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1configParser.xml
@@ -0,0 +1,149 @@
+
+
+
+ core::configParser
+ core::configParser::configParser
+
+
+ def
+ def core.configParser.getImageField
+ (self, imageName, fieldName, fieldValue)
+ getImageField
+ self
+ self
+
+ imageName
+ imageName
+
+ fieldName
+ fieldName
+
+ fieldValue
+ fieldValue
+
+
+Debate on these functions should they.
+
+
+Search and return the image field specified
+
+Args:
+ imageName ([string]): [image name to search for]
+ fieldName ([string]): [field to search for]
+ fieldValue ([string]): [pattern to match the field]
+
+Returns:
+ [string]: [url]
+
+
+
+
+
+ def
+ def core.configParser.getNegativeImageUrlViaPlatform
+ (self, platform)
+ getNegativeImageUrlViaPlatform
+ self
+ self
+
+ platform
+ platform
+
+
+
+
+Get the negative image location via the platform
+
+Args:
+ platform ([string]): [platform string e.g. xione.de, llama.uk]
+Returns:
+ [string]: [url or none if not found]
+
+
+
+
+
+ def
+ def core.configParser.getValidImageUrlViaPlatform
+ (self, imageName, platform)
+ getValidImageUrlViaPlatform
+ self
+ self
+
+ imageName
+ imageName
+
+ platform
+ platform
+
+
+
+
+[gets a valid image from the specified platform name]
+
+Args:
+ imageName ([string]): [image name , "PCI1, PCI2, PDRI, BDRI etc" from the config]
+ platform ([string]): [platform name e.g. "xione.de"]
+Returns:
+ [string]: [url]
+
+
+
+
+
+ def
+ def core.configParser.getValidImages
+ (self, platform, filterString)
+ getValidImages
+ self
+ self
+
+ platform
+ platform
+
+ filterString
+ filterString
+
+
+
+
+For the given platform, gets valid image names for the imageType in the testConfig
+
+Args:
+ filterString (str) - To filter the matching valid image names Ex: PCI \ DRI etc.,
+ platform (str) - device platform. Ex: ada.sr300 or xione.de etc.,
+
+Returns:
+ validNames (list) - List of matching image names in testConfig (Ex: For DRI, it returns BDRI\PDRI)
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1configParserBase.xml b/docs/doxygen/xml/namespacecore_1_1configParserBase.xml
new file mode 100644
index 0000000..2140006
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1configParserBase.xml
@@ -0,0 +1,12 @@
+
+
+
+ core::configParserBase
+ core::configParserBase::configParserBase
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1decodeParams.xml b/docs/doxygen/xml/namespacecore_1_1decodeParams.xml
new file mode 100644
index 0000000..dddaa43
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1decodeParams.xml
@@ -0,0 +1,12 @@
+
+
+
+ core::decodeParams
+ core::decodeParams::decodeParams
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1deviceManager.xml b/docs/doxygen/xml/namespacecore_1_1deviceManager.xml
new file mode 100644
index 0000000..fdd08be
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1deviceManager.xml
@@ -0,0 +1,30 @@
+
+
+
+ core::deviceManager
+ core::deviceManager::consoleClass
+ core::deviceManager::deviceClass
+ core::deviceManager::deviceManager
+
+
+ core::deviceManager.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1logModule.xml b/docs/doxygen/xml/namespacecore_1_1logModule.xml
new file mode 100644
index 0000000..33241ca
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1logModule.xml
@@ -0,0 +1,12 @@
+
+
+
+ core::logModule
+ core::logModule::logModule
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1outboundClient.xml b/docs/doxygen/xml/namespacecore_1_1outboundClient.xml
new file mode 100644
index 0000000..b43c94a
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1outboundClient.xml
@@ -0,0 +1,12 @@
+
+
+
+ core::outboundClient
+ core::outboundClient::outboundClientClass
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1powerControl.xml b/docs/doxygen/xml/namespacecore_1_1powerControl.xml
new file mode 100644
index 0000000..dbf3eef
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1powerControl.xml
@@ -0,0 +1,12 @@
+
+
+
+ core::powerControl
+ core::powerControl::powerControlClass
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1powerModules.xml b/docs/doxygen/xml/namespacecore_1_1powerModules.xml
new file mode 100644
index 0000000..27f7839
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1powerModules.xml
@@ -0,0 +1,35 @@
+
+
+
+ core::powerModules
+ core::powerModules::apc
+ core::powerModules::apcAos
+ core::powerModules::hs100
+ core::powerModules::kasaControl
+ core::powerModules::none
+ core::powerModules::olimex
+ core::powerModules::S20control
+ core::powerModules::SLP
+
+
+ core::powerModules.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1powerModules_1_1S20control.xml b/docs/doxygen/xml/namespacecore_1_1powerModules_1_1S20control.xml
new file mode 100644
index 0000000..7dcffa8
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1powerModules_1_1S20control.xml
@@ -0,0 +1,42 @@
+
+
+
+ core::powerModules::S20control
+ core::powerModules::S20control::OrviboS20
+ core::powerModules::S20control::powerOrviboS20
+ core::powerModules::S20control::UnknownPacket
+
+
+ def
+ def core.powerModules.S20control.usage
+ ()
+ usage
+
+
+
+
+
+
+
+
+ def
+ def core.powerModules.S20control.main
+ ()
+ main
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1powerModules_1_1SLP.xml b/docs/doxygen/xml/namespacecore_1_1powerModules_1_1SLP.xml
new file mode 100644
index 0000000..4e17174
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1powerModules_1_1SLP.xml
@@ -0,0 +1,12 @@
+
+
+
+ core::powerModules::SLP
+ core::powerModules::SLP::powerSLP
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1powerModules_1_1apc.xml b/docs/doxygen/xml/namespacecore_1_1powerModules_1_1apc.xml
new file mode 100644
index 0000000..a4f627d
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1powerModules_1_1apc.xml
@@ -0,0 +1,84 @@
+
+
+
+ core::powerModules::apc
+ core::powerModules::apc::powerAPC
+
+
+ string
+ string core::powerModules::apc.CONNECT_MSG
+ CONNECT_MSG
+ = "Communication Established"
+
+
+
+
+
+
+
+
+ string
+ string core::powerModules::apc.POWER_ON
+ POWER_ON
+ = "1"
+
+
+
+
+
+
+
+
+ string
+ string core::powerModules::apc.POWER_OFF
+ POWER_OFF
+ = "2"
+
+
+
+
+
+
+
+
+ string
+ string core::powerModules::apc.REBOOT
+ REBOOT
+ = "3"
+
+
+
+
+
+
+
+
+ int
+ int core::powerModules::apc.REBOOT_WAIT
+ REBOOT_WAIT
+ = 60
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1powerModules_1_1apcAos.xml b/docs/doxygen/xml/namespacecore_1_1powerModules_1_1apcAos.xml
new file mode 100644
index 0000000..4cdcb6c
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1powerModules_1_1apcAos.xml
@@ -0,0 +1,84 @@
+
+
+
+ core::powerModules::apcAos
+ core::powerModules::apcAos::powerApcAos
+
+
+ string
+ string core::powerModules::apcAos.CMD_PROMPT
+ CMD_PROMPT
+ = "apc>"
+
+
+
+
+
+
+
+
+ string
+ string core::powerModules::apcAos.POWER_ON
+ POWER_ON
+ = "olOn"
+
+
+
+
+
+
+
+
+ string
+ string core::powerModules::apcAos.POWER_OFF
+ POWER_OFF
+ = "olOff"
+
+
+
+
+
+
+
+
+ string
+ string core::powerModules::apcAos.REBOOT
+ REBOOT
+ = "olReboot"
+
+
+
+
+
+
+
+
+ int
+ int core::powerModules::apcAos.REBOOT_WAIT
+ REBOOT_WAIT
+ = 60
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1powerModules_1_1hs100.xml b/docs/doxygen/xml/namespacecore_1_1powerModules_1_1hs100.xml
new file mode 100644
index 0000000..568e247
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1powerModules_1_1hs100.xml
@@ -0,0 +1,12 @@
+
+
+
+ core::powerModules::hs100
+ core::powerModules::hs100::powerHS100
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1powerModules_1_1kasaControl.xml b/docs/doxygen/xml/namespacecore_1_1powerModules_1_1kasaControl.xml
new file mode 100644
index 0000000..a23299b
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1powerModules_1_1kasaControl.xml
@@ -0,0 +1,12 @@
+
+
+
+ core::powerModules::kasaControl
+ core::powerModules::kasaControl::powerKasa
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1powerModules_1_1none.xml b/docs/doxygen/xml/namespacecore_1_1powerModules_1_1none.xml
new file mode 100644
index 0000000..0e46e7f
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1powerModules_1_1none.xml
@@ -0,0 +1,12 @@
+
+
+
+ core::powerModules::none
+ core::powerModules::none::powerNone
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1powerModules_1_1olimex.xml b/docs/doxygen/xml/namespacecore_1_1powerModules_1_1olimex.xml
new file mode 100644
index 0000000..65a316a
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1powerModules_1_1olimex.xml
@@ -0,0 +1,12 @@
+
+
+
+ core::powerModules::olimex
+ core::powerModules::olimex::powerOlimex
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1rackController.xml b/docs/doxygen/xml/namespacecore_1_1rackController.xml
new file mode 100644
index 0000000..8977ece
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1rackController.xml
@@ -0,0 +1,15 @@
+
+
+
+ core::rackController
+ core::rackController::configDecoderClass
+ core::rackController::rack
+ core::rackController::rackController
+ core::rackController::rackSlot
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1rcCodes.xml b/docs/doxygen/xml/namespacecore_1_1rcCodes.xml
new file mode 100644
index 0000000..993184c
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1rcCodes.xml
@@ -0,0 +1,12 @@
+
+
+
+ core::rcCodes
+ core::rcCodes::rcCode
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1testControl.xml b/docs/doxygen/xml/namespacecore_1_1testControl.xml
new file mode 100644
index 0000000..c9c0e01
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1testControl.xml
@@ -0,0 +1,28 @@
+
+
+
+ core::testControl
+ core::testControl::testController
+
+
+ core::testControl.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1utilities.xml b/docs/doxygen/xml/namespacecore_1_1utilities.xml
new file mode 100644
index 0000000..ed35d11
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1utilities.xml
@@ -0,0 +1,12 @@
+
+
+
+ core::utilities
+ core::utilities::utilities
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacecore_1_1webpageController.xml b/docs/doxygen/xml/namespacecore_1_1webpageController.xml
new file mode 100644
index 0000000..cd402a2
--- /dev/null
+++ b/docs/doxygen/xml/namespacecore_1_1webpageController.xml
@@ -0,0 +1,28 @@
+
+
+
+ core::webpageController
+ core::webpageController::webpageController
+
+
+ core::webpageController.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacedownloadTest.xml b/docs/doxygen/xml/namespacedownloadTest.xml
new file mode 100644
index 0000000..75b968b
--- /dev/null
+++ b/docs/doxygen/xml/namespacedownloadTest.xml
@@ -0,0 +1,42 @@
+
+
+
+ downloadTest
+ downloadTest::downloadTest
+
+
+ downloadTest.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+ downloadTest.test
+ test
+ = [downloadTest]()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacedynamicButtonsTest.xml b/docs/doxygen/xml/namespacedynamicButtonsTest.xml
new file mode 100644
index 0000000..b3860c9
--- /dev/null
+++ b/docs/doxygen/xml/namespacedynamicButtonsTest.xml
@@ -0,0 +1,42 @@
+
+
+
+ dynamicButtonsTest
+ dynamicButtonsTest::dynamicButtonsTest
+
+
+ dynamicButtonsTest.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+ dynamicButtonsTest.test
+ test
+ = [dynamicButtonsTest]()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacedynamicTablesTest.xml b/docs/doxygen/xml/namespacedynamicTablesTest.xml
new file mode 100644
index 0000000..6bc1367
--- /dev/null
+++ b/docs/doxygen/xml/namespacedynamicTablesTest.xml
@@ -0,0 +1,42 @@
+
+
+
+ dynamicTablesTest
+ dynamicTablesTest::dynamicTablesTest
+
+
+ dynamicTablesTest.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+ dynamicTablesTest.test
+ test
+ = [dynamicTablesTest]()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespaceelementAttributeTest.xml b/docs/doxygen/xml/namespaceelementAttributeTest.xml
new file mode 100644
index 0000000..168e81f
--- /dev/null
+++ b/docs/doxygen/xml/namespaceelementAttributeTest.xml
@@ -0,0 +1,42 @@
+
+
+
+ elementAttributeTest
+ elementAttributeTest::elementAttributeTest
+
+
+ elementAttributeTest.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+ elementAttributeTest.test
+ test
+ = [elementAttributeTest]()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespaceframework.xml b/docs/doxygen/xml/namespaceframework.xml
new file mode 100644
index 0000000..f0d1fb4
--- /dev/null
+++ b/docs/doxygen/xml/namespaceframework.xml
@@ -0,0 +1,32 @@
+
+
+
+ framework
+ framework::exceptionTests
+ framework::logging_tests
+ framework::powerSwitch_tests
+ framework::remoteController_test
+ framework::startup
+
+
+ framework.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespaceframework_1_1exceptionTests.xml b/docs/doxygen/xml/namespaceframework_1_1exceptionTests.xml
new file mode 100644
index 0000000..419bcf2
--- /dev/null
+++ b/docs/doxygen/xml/namespaceframework_1_1exceptionTests.xml
@@ -0,0 +1,68 @@
+
+
+
+ framework::exceptionTests
+ framework::exceptionTests::framework_test1
+
+
+ framework::exceptionTests.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+ framework::exceptionTests.summary
+ summary
+ = logModule("GroupTest1", level=logModule.INFO)
+
+
+
+
+
+
+
+
+ framework::exceptionTests.qcId
+ qcId
+
+
+
+
+
+
+
+
+ framework::exceptionTests.exitOnError
+ exitOnError
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespaceframework_1_1logging__tests.xml b/docs/doxygen/xml/namespaceframework_1_1logging__tests.xml
new file mode 100644
index 0000000..a84526d
--- /dev/null
+++ b/docs/doxygen/xml/namespaceframework_1_1logging__tests.xml
@@ -0,0 +1,83 @@
+
+
+
+ framework::logging_tests
+
+
+ framework::logging_tests.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+ framework::logging_tests.log
+ log
+ = logModule("logging_tests.py")
+
+
+
+
+
+
+
+
+ framework::logging_tests.moduleLog
+ moduleLog
+ = logModule("module")
+
+
+
+
+
+
+
+
+ framework::logging_tests.end_time
+ end_time
+ = log.testStart( "pythonLogTest", "PLT-0001", 1, 60 )
+
+
+
+
+
+
+
+
+ int
+ int framework::logging_tests.loopCount
+ loopCount
+ = 5
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespaceframework_1_1powerSwitch__tests.xml b/docs/doxygen/xml/namespaceframework_1_1powerSwitch__tests.xml
new file mode 100644
index 0000000..cf1b553
--- /dev/null
+++ b/docs/doxygen/xml/namespaceframework_1_1powerSwitch__tests.xml
@@ -0,0 +1,153 @@
+
+
+
+ framework::powerSwitch_tests
+
+
+ framework::powerSwitch_tests.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+ framework::powerSwitch_tests.log
+ log
+ = logModule("powerSwitchTest")
+
+
+
+
+
+
+
+
+ framework::powerSwitch_tests.utils
+ utils
+ = utilities( log )
+
+
+
+
+
+
+
+
+ framework::powerSwitch_tests.config
+ config
+ = decodeParams(log)
+
+
+
+
+
+
+
+
+ framework::powerSwitch_tests.rackControl
+ rackControl
+ = rackController( config.rackConfig )
+
+
+
+
+
+
+
+
+ framework::powerSwitch_tests.rack
+ rack
+ = rackControl.getRackByIndex( 0 )
+
+
+
+
+
+
+
+
+ framework::powerSwitch_tests.slot
+ slot
+ = rack.getSlot(config.args.slotNumber )
+
+
+
+
+
+
+
+
+ framework::powerSwitch_tests.devices
+ devices
+ = deviceManager( slot.config.get("devices"), log, "./logs" )
+
+
+
+
+
+
+
+
+ framework::powerSwitch_tests.dut
+ dut
+ = devices.getDevice("dut")
+
+
+
+
+
+
+
+
+ framework::powerSwitch_tests.power
+ power
+ = dut.powerControl
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespaceframework_1_1remoteController__test.xml b/docs/doxygen/xml/namespaceframework_1_1remoteController__test.xml
new file mode 100644
index 0000000..9b81d67
--- /dev/null
+++ b/docs/doxygen/xml/namespaceframework_1_1remoteController__test.xml
@@ -0,0 +1,42 @@
+
+
+
+ framework::remoteController_test
+ framework::remoteController_test::demoClass
+
+
+ framework::remoteController_test.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+ framework::remoteController_test.demo
+ demo
+ = [demoClass]( testName = "remoteDemo", level=logModule.INFO )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespaceframework_1_1startup.xml b/docs/doxygen/xml/namespaceframework_1_1startup.xml
new file mode 100644
index 0000000..f116755
--- /dev/null
+++ b/docs/doxygen/xml/namespaceframework_1_1startup.xml
@@ -0,0 +1,42 @@
+
+
+
+ framework::startup
+ framework::startup::framework_test1
+
+
+ framework::startup.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+ framework::startup.test
+ test
+ = [framework_test1]()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespaceglobalActionTest.xml b/docs/doxygen/xml/namespaceglobalActionTest.xml
new file mode 100644
index 0000000..b98a1c5
--- /dev/null
+++ b/docs/doxygen/xml/namespaceglobalActionTest.xml
@@ -0,0 +1,42 @@
+
+
+
+ globalActionTest
+ globalActionTest::globalActionTest
+
+
+ globalActionTest.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+ globalActionTest.test
+ test
+ = [globalActionTest]()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacenone.xml b/docs/doxygen/xml/namespacenone.xml
new file mode 100644
index 0000000..f6b5e9b
--- /dev/null
+++ b/docs/doxygen/xml/namespacenone.xml
@@ -0,0 +1,12 @@
+
+
+
+ none
+ none::remoteNone
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespaceolimex.xml b/docs/doxygen/xml/namespaceolimex.xml
new file mode 100644
index 0000000..92a60ee
--- /dev/null
+++ b/docs/doxygen/xml/namespaceolimex.xml
@@ -0,0 +1,12 @@
+
+
+
+ olimex
+ olimex::remoteOlimex
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespaceperformActionsTests.xml b/docs/doxygen/xml/namespaceperformActionsTests.xml
new file mode 100644
index 0000000..eeff331
--- /dev/null
+++ b/docs/doxygen/xml/namespaceperformActionsTests.xml
@@ -0,0 +1,42 @@
+
+
+
+ performActionsTests
+ performActionsTests::performActionsTests
+
+
+ performActionsTests.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+ performActionsTests.test
+ test
+ = [performActionsTests]()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacesaveScreenshotTest.xml b/docs/doxygen/xml/namespacesaveScreenshotTest.xml
new file mode 100644
index 0000000..69fbae9
--- /dev/null
+++ b/docs/doxygen/xml/namespacesaveScreenshotTest.xml
@@ -0,0 +1,42 @@
+
+
+
+ saveScreenshotTest
+ saveScreenshotTest::saveScreenshotTest
+
+
+ saveScreenshotTest.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+ saveScreenshotTest.test
+ test
+ = [saveScreenshotTest]()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespaceselectOptionsTests.xml b/docs/doxygen/xml/namespaceselectOptionsTests.xml
new file mode 100644
index 0000000..4a98783
--- /dev/null
+++ b/docs/doxygen/xml/namespaceselectOptionsTests.xml
@@ -0,0 +1,42 @@
+
+
+
+ selectOptionsTests
+ selectOptionsTests::selectOptionsTests
+
+
+ selectOptionsTests.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+ selectOptionsTests.test
+ test
+ = [selectOptionsTests]()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespaceseleniumDriver.xml b/docs/doxygen/xml/namespaceseleniumDriver.xml
new file mode 100644
index 0000000..4711b7b
--- /dev/null
+++ b/docs/doxygen/xml/namespaceseleniumDriver.xml
@@ -0,0 +1,12 @@
+
+
+
+ seleniumDriver
+ seleniumDriver::seleniumDriver
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacesequenceTest.xml b/docs/doxygen/xml/namespacesequenceTest.xml
new file mode 100644
index 0000000..658cedf
--- /dev/null
+++ b/docs/doxygen/xml/namespacesequenceTest.xml
@@ -0,0 +1,42 @@
+
+
+
+ sequenceTest
+ sequenceTest::sequenceTest
+
+
+ sequenceTest.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+ sequenceTest.test
+ test
+ = [sequenceTest]()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespaceskyProc.xml b/docs/doxygen/xml/namespaceskyProc.xml
new file mode 100644
index 0000000..0118c65
--- /dev/null
+++ b/docs/doxygen/xml/namespaceskyProc.xml
@@ -0,0 +1,12 @@
+
+
+
+ skyProc
+ skyProc::remoteSkyProc
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacetabsTest.xml b/docs/doxygen/xml/namespacetabsTest.xml
new file mode 100644
index 0000000..94da599
--- /dev/null
+++ b/docs/doxygen/xml/namespacetabsTest.xml
@@ -0,0 +1,42 @@
+
+
+
+ tabsTest
+ tabsTest::tabsTest
+
+
+ tabsTest.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+ tabsTest.test
+ test
+ = [tabsTest]()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/namespacewebpageControlTests.xml b/docs/doxygen/xml/namespacewebpageControlTests.xml
new file mode 100644
index 0000000..c85d969
--- /dev/null
+++ b/docs/doxygen/xml/namespacewebpageControlTests.xml
@@ -0,0 +1,54 @@
+
+
+
+ webpageControlTests
+
+
+ webpageControlTests.dir_path
+ dir_path
+ = os.path.dirname(os.path.realpath(__file__))
+
+
+
+
+
+
+
+
+ webpageControlTests.summary
+ summary
+ = logModule("WebpageControlTests", level=logModule.INFO)
+
+
+
+
+
+
+
+
+ webpageControlTests.log
+ log
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/doxygen/xml/outboundClient_8py.xml b/docs/doxygen/xml/outboundClient_8py.xml
new file mode 100644
index 0000000..ff88b43
--- /dev/null
+++ b/docs/doxygen/xml/outboundClient_8py.xml
@@ -0,0 +1,347 @@
+
+
+
+ outboundClient.py
+ core::outboundClient::outboundClientClass
+ core::outboundClient
+
+
+
+
+
+import import import import import from import from import from import from import as from import as class [outboundClientClass]():def [__init__](self,None , None , None , "" , """Intialise [log][logBase]False if None : [log]"outboundClientClass" [logBase]True [workspaceDirectory]if not [log].info('creating .format(workspaceDirectory)) [upload_url][uploadPath]"" [httpProxy][__configureUploadProtocol__](def __del__(self): if [logBase]True : [log].log.removeHandler(self.[log].log.handlers[0])def [__configureUploadProtocol__](self,"""configure if "sftp" : [uploadPort]else : [log].error("Unsupported .format(parse.scheme)) return False [uploadAddress]if None : [uploadPort][uploadPath]def [downloadFile](self,None ): """[downloadFile if not [workspaceDirectory]):[workspaceDirectory])if None : [workspaceDirectory],if "http://" ) True : return [__downloadHTTP__](if "sftp://" ) True : return [__downloadSFTP__]([log].error("Unsupported , return False def [prepareOutboundWithImageFromUrl]("""program try : [translateImageTypeToImageFilename](if [downloadFile](False : [log].error("Error .format(imageFilename)) return False return [uploadFile](except as [log].error('Exception ) [log].error(e)raise 'Failed .format(imageType, def [translateImageTypeToImageFilename](self,"""Convert ".bin" return def [getSizeInHumanReadable](self,"""get 'B' , 'KB' , 'MB' , 'GB' ] while return '{size} def [__downloadSFTP__](self,None """Download if None : try : except as [log].error(str(e))return False [workspaceDirectory]if None : [log].info("SFTP .format(url, try : except as [log].error(str(e))return False return True def [cleanWorkspace](self):"""Clean [log].info("Clean ) def [__uploadSFTP__](self,"""Upload [getSizeInHumanReadable](fileSize)if [log].info("SFTP .format(filename,[uploadPath])) return False [log].info("SFTP .format(filename,[uploadPath])) try : [uploadAddress],[uploadPort])except as [log].error(str(e))return False try : "mkdir .format(self.[uploadPath]) except as [log].error(str(e))return False try : [uploadPath])except as [log].error(str(e))return False return True def [progressSFTP](self,"""SSH "\r[%s%s]" '=' ' def [__downloadHTTP__](self,None """Download None if [httpProxy]'None' : 'http' :self.[httpProxy], 'https' :self.[httpProxy] if None : "/" ) [workspaceDirectory],with 'wb' ) as try : True ) except as [log].error(str(e))return 'content-length' ) [getSizeInHumanReadable](totalLength)[log].info("HTTP .format(url, if is None : [log].error("File .format(filePath)) raise "File ) else : for in "\r[%s%s]" '=' ' "\n" ) return def [uploadFile](self,filename:str):"""[upload [workspaceDirectory],if False : [log].error("File .format(sourceFilename)) raise "File ) return False if [upload_url].startswith("sftp://" ) True : return [__uploadSFTP__]([log].error("File .format(filename)) raise "File ) return False def [retrieveListofFilenamesFromUrl](self,"""Retrieves [log].step("outboundClient.retrieveListofFilenamesFromUrl" ) if "http://" ) or "https://" ): try : 'http' :[httpProxy], 'https' :[httpProxy] True ) 'html.parser' ) for in 'a' ): 'href' )) except as raise "outboundClient.retrieveListofFilenamesFromUrl .format(e)) else : raise 'UNSUPPORTED ) return
+
+
diff --git a/docs/doxygen/xml/performActionsTests_8py.xml b/docs/doxygen/xml/performActionsTests_8py.xml
new file mode 100644
index 0000000..b6307dc
--- /dev/null
+++ b/docs/doxygen/xml/performActionsTests_8py.xml
@@ -0,0 +1,120 @@
+
+
+
+ performActionsTests.py
+ performActionsTests::performActionsTests
+ performActionsTests
+
+
+
+
+
+import import dir_path sys.path.append(dir_path+ "/../../../" ) from import class [performActionsTests](testController):def __init__(self, def testFunction(self): "./unitTests/framework/webControlTests/webPageTest.yml" ) "https://testpages.herokuapp.com/styled" , "form_page" ) "Starting ) "fill_form" , "password123" , "unitTests/framework/webControlTests/mockUploadFile.txt" ), "Selection , "Selection , "Drop ) True , "Finished ) "form_results_page" ) "Checking ) "username_value" ) if 'admin' : False , "Username ) else : True , "Username ) "Checking ) "password_value" ) if 'password123' : False , "Password ) else : True , "Password ) "Checking ) "filename_value" ) if 'mockUploadFile.txt' : False , "Filename ) else : True , "Filename ) "Checking ) "checkbox_1_value" ) if 'cb2' : False , "Checkbox ) else : True , "Checkbox ) "Checking ) "checkbox_2_value" ) if 'cb3' : False , "Checkbox ) else : True , "Checkbox ) "Checking ) "radio_button_value" ) if 'rd3' : False , "Radio ) else : True , "Radio ) "Checking ) "multiselect_1_value" ) if 'ms2' : False , "Multiselect ) else : True , "Multiselect ) "Checking ) "multiselect_2_value" ) if 'ms4' : False , "Multiselect ) else : True , "Multiselect ) "Checking ) "dropdown_value" ) if 'dd6' : False , "Dropdown ) else : True , "Dropdown ) if "__main__" : [performActionsTests]()
+
+
diff --git a/docs/doxygen/xml/powerControl_8py.xml b/docs/doxygen/xml/powerControl_8py.xml
new file mode 100644
index 0000000..f9c5c41
--- /dev/null
+++ b/docs/doxygen/xml/powerControl_8py.xml
@@ -0,0 +1,141 @@
+
+
+
+ powerControl.py
+ core::powerControl::powerControlClass
+ core::powerControl
+
+
+
+
+
+from import from import from import from import from import from import from import from import from import from import class [powerControlClass]():def [__init__](self,"""Initalise [log][utils][ip]"ip" ) [name]"name" ) [retryCount]"retryCount" , [retryDelay]"retryDelay" , if [name]None [name][ip][powerOnState]False "type" ) if None : [powerSwitch]elif "orviboS20" : [powerSwitch][ip],"mac" ), "port" )) elif "hs100" : [powerSwitch][ip],"port" )) elif "apc" : [powerSwitch][ip],"username" ), "password" ), "outlet" )) elif "apcAos" : [powerSwitch][ip],"username" ), "password" ), "port" ,23), "outlet" )) elif "olimex" : [powerSwitch][ip],"port" ), "relay" )) elif "kasa" : [powerSwitch]elif "SLP" : [powerSwitch][ip],"username" ), "password" ), "outlet_id" ),config.get( 'port' ,23)) elif "none" : [powerSwitch]else : [log].error("Power .format(type)) return def powerOn(self): [log].info("powerOn .format([name] [powerRetry](self.[powerSwitch].powerOn)if True : [powerOnState]True return def powerOff(self): [log].info("powerOff .format([name] [powerRetry](self.[powerSwitch].powerOff)if True : [powerOnState]False return def reboot(self): [log].info("reboot" ) return [powerRetry](self.[powerSwitch].reboot)def [powerRetry](self,""" for in [retryCount]+1):try : break except as [log].info(f"Could ) if [retryCount]:raise [utils].wait(self.[retryDelay])return
+
+
diff --git a/docs/doxygen/xml/powerModules_2none_8py.xml b/docs/doxygen/xml/powerModules_2none_8py.xml
new file mode 100644
index 0000000..0cdc1ab
--- /dev/null
+++ b/docs/doxygen/xml/powerModules_2none_8py.xml
@@ -0,0 +1,53 @@
+
+
+
+ none.py
+ core::powerModules::none::powerNone
+ core::powerModules::none
+
+
+
+
+
+import class [powerNone]():def __init__(self, [log][log].info("PowerSwitchNone()" ) pass def powerOn(self): [log].info("powerSwitchNone().powerOn" ) return True def powerOff(self): [log].info("powerSwitchNone().powerOff" ) return True def reboot(self): [powerOff]()if True : [log].error(" ) [powerOn]()if True : [log].error(" ) return
+
+
diff --git a/docs/doxygen/xml/powerModules_2olimex_8py.xml b/docs/doxygen/xml/powerModules_2olimex_8py.xml
new file mode 100644
index 0000000..eeadd72
--- /dev/null
+++ b/docs/doxygen/xml/powerModules_2olimex_8py.xml
@@ -0,0 +1,71 @@
+
+
+
+ olimex.py
+ core::powerModules::olimex::powerOlimex
+ core::powerModules::olimex
+
+
+
+
+
+from import class [powerOlimex]():def __init__( [log][ip][port]if is None : [port][relay][telnet]None def command(self, [telnet]=telnet(self.[log],'{}:{}' .format(self.[ip],self.[port]), None , None ) if False ==self.[telnet].connect(): return False [telnet].read_very_eager()if False ==self.[telnet].write(cmd): return False if not "(OK)" in [telnet].read_until("(OK)" ): return False [telnet].disconnect()return True def powerOff(self): [command]('REL{}=0\n' .format(self.[relay])) if True : [log].error(" ) return def powerOn(self): [command]('REL{}=1\n' .format(self.[relay])) if True : [log].error(" ) return def reboot(self): [powerOff]()if True : [powerOn]()return
+
+
diff --git a/docs/doxygen/xml/powerSwitch__tests_8py.xml b/docs/doxygen/xml/powerSwitch__tests_8py.xml
new file mode 100644
index 0000000..1f981d0
--- /dev/null
+++ b/docs/doxygen/xml/powerSwitch__tests_8py.xml
@@ -0,0 +1,75 @@
+
+
+
+ powerSwitch_tests.py
+ framework::powerSwitch_tests
+
+
+
+
+
+import import dir_path sys.path.append(dir_path+ "/../../" ) from import from import from import from import from import from import if "__main__" : "powerSwitchTest" ) if None : else : "devices" ), "./logs" "dut" ) "Testing ) "Testing ) "Testing ) "Testing ) "Testing ) "Test )
+
+
diff --git a/docs/doxygen/xml/rackController_8py.xml b/docs/doxygen/xml/rackController_8py.xml
new file mode 100644
index 0000000..835329e
--- /dev/null
+++ b/docs/doxygen/xml/rackController_8py.xml
@@ -0,0 +1,230 @@
+
+
+
+ rackController.py
+ core::rackController::configDecoderClass
+ core::rackController::rackSlot
+ core::rackController::rack
+ core::rackController::rackController
+ core::rackController
+
+
+
+
+
+from import from import import from import as class [configDecoderClass]():def __init__( pass def checkRequiredField(self, try : if "" : return except : "Field +str(name)+ "] ) def decodeConfigItem( "nothandled" ) if "nothandled" : "Not ,str(config), "]" return def setConfigValue(self, "[" +str(name)+ "]:[" +str(value)+ "]" ) def dumpValue(self, "[" +x+ "]:[" +str(x.value)+ "]" class [rackSlot]([configDecoderClass]):def __init__(self, None if None "RackSlot" ) [log][config]def getDevice( return [find_name]([config].get("devices" ), def find_name(self, for in try : if return except : continue return None def get(self): return def getName(self): return [config].get("name" ) def getRackName(self): return [config].get("rackName" ) def setRackName( [config]["rackName" def getRemoteKeyType(self, [getDevice]("remoteController" ) "type" ) return def getDeviceAddress(self, [getDevice]("address" ) if None : "ip" ) return def getDeviceIp(self, [getDevice]("ip" ) return def getPlatform(self, [getDevice]("platform" ) return def getOutboundUploadDirectory(self, [getDevice]("outbound" ).get( "upload_url" ) return def getOutboundDownloadDirectory(self, [getDevice]("outbound" ).get( "download_url" ) return def show( [log].info("config[ .format(self.[config])) class [rack]([configDecoderClass]):def __init__(self, if None "rack" ) [log]def addSlot( [slot].append(def getSlot( if [log].error("Slot ) try : return [slot][slotIndex-1]except [log].error("getSlot(" +str(slotIndex)+ ") ) return None def getSlotByName( for in if return [log].error("getSlot(" +slotName+ ") ) return None class [rackController]:"" def decodeRackConfig( [rack](self.[log])"name" ) for in if "slot" ): [rackSlot](slotConfig,self.[log])return def __init__(self, [log]"rackController" for in if "rack" ): [decodeRackConfig]([racks].append(def getRackByName(self, for in [racks]:if "name" ] return [log].error("getRack(" +str(rackName)+ ") ) return None def getRackByIndex(self, try : [racks][rackIndex]except : [log].error("Rack ) [log].error("getRackByIndex(" +str(rackIndex)+ ") ) return def getRackServerHostname( for in [racks]:if return return None def getRackDescription( for in [racks]:if return return None
+
+
diff --git a/docs/doxygen/xml/rcCodes_8py.xml b/docs/doxygen/xml/rcCodes_8py.xml
new file mode 100644
index 0000000..d98f599
--- /dev/null
+++ b/docs/doxygen/xml/rcCodes_8py.xml
@@ -0,0 +1,132 @@
+
+
+
+ rcCodes.py
+ core::rcCodes::rcCode
+ core::rcCodes
+
+
+
+
+
+from import class [rcCode](Enum):"0x00" "0x01" "0x02" "0x03" "0x04" "0x05" "0x06" "0x07" "0x08" "0x09" "0x0C" "0x0D" "0x10" "0x11" "0x20" "0x21" "0x24" "0x28" "0x28" "0x28" "0x2D" "0x2E" "0x3D" "0x3E" "0x3F" "0x40" "0x47" "0x58" "0x59" "0x5A" "0x5B" "0x5C" "0x6D" "0x6E" "0x6F" "0x70" "0x7E" "0x80" "0x81" "0x83" "0xCE" "0xCC" "0xF5" "BACK" "CROSS" "MIC" "RGYB" "PICK_UP" "TEST" "RST" "FAC" "CSM" "PATTERN" "ANTENNA_CABLE" "PRE_CH" "VOL_MAX" "CTC" "VOL_BUZZ" "MENU" "BI" "CH_SCAN" "CCTT" "PIC" "LOG_LED" "AUDIO" "D2D3" "ARC" "CIP" "VIRGIN" "CVBS" "YPBPR_SCART" "HDMI" "VGA" "REGIN" "CLONE" "RESERVE1" "DCR" "WIFI_SSID" "BLK" "WP" "LIGHT_SENSOR" "USB" "RJ45" "RS232" "RESERVE2"
+
+
diff --git a/docs/doxygen/xml/remoteControllerModules_2none_8py.xml b/docs/doxygen/xml/remoteControllerModules_2none_8py.xml
new file mode 100644
index 0000000..5523c0d
--- /dev/null
+++ b/docs/doxygen/xml/remoteControllerModules_2none_8py.xml
@@ -0,0 +1,61 @@
+
+
+
+ none.py
+ none::remoteNone
+ none
+
+
+
+
+
+import from import class [remoteNone]():def [__init__]("""Initalise [log]def [sendKey](self,"""Send if None : return False for in [log].info("remoteNone: .format( return True
+
+
diff --git a/docs/doxygen/xml/remoteControllerModules_2olimex_8py.xml b/docs/doxygen/xml/remoteControllerModules_2olimex_8py.xml
new file mode 100644
index 0000000..c92b72c
--- /dev/null
+++ b/docs/doxygen/xml/remoteControllerModules_2olimex_8py.xml
@@ -0,0 +1,64 @@
+
+
+
+ olimex.py
+ olimex::remoteOlimex
+ olimex
+
+
+
+
+
+import from import as from import from import import class [remoteOlimex]():def __init__( [log][remoteController]def command(self, [telnet]=telnet(self.[log],'{}:{}' .format([remoteController][ "ip" ],[remoteController][ "port" ] None , None ) if False ==self.[telnet].connect(): return False [telnet].read_very_eager()if False ==self.[telnet].write(cmd): return False if not "(OK)" in [telnet].read_until("(OK)" ): return False [telnet].disconnect()return True def sendKey(self, if None : return False for in if True [command]('{}\n' .format( [log].error("sendKey(), .format( return False return True
+
+
diff --git a/docs/doxygen/xml/remoteController__test_8py.xml b/docs/doxygen/xml/remoteController__test_8py.xml
new file mode 100644
index 0000000..7f98872
--- /dev/null
+++ b/docs/doxygen/xml/remoteController__test_8py.xml
@@ -0,0 +1,52 @@
+
+
+
+ remoteController_test.py
+ framework::remoteController_test::demoClass
+ framework::remoteController_test
+
+
+
+
+
+import import dir_path sys.path.append(dir_path+ "/../../" ) from import as from import from import class [demoClass](testController):pass if "__main__" : [demoClass]("remoteDemo" , "Testing ) "Testing ) "Testing ) "llama_rc6" ) "llama_tpv" ) "Testing )
+
+
diff --git a/docs/doxygen/xml/requirements_8txt.xml b/docs/doxygen/xml/requirements_8txt.xml
new file mode 100644
index 0000000..1e642f9
--- /dev/null
+++ b/docs/doxygen/xml/requirements_8txt.xml
@@ -0,0 +1,73 @@
+
+
+
+ requirements.txt
+
+
+
+
+
+aiohttp==3.9.3 aiosignal==1.3.1 annotated-types==0.6.0 anyio==4.3.0 async-timeout==4.0.3 asyncclick==8.1.7.2 asyncio==3.4.3 attrs==23.2.0 bcrypt==4.1.2 beautifulsoup4==4.12.3 boto3==1.34.70 botocore==1.34.70 cdrouter==0.9.7 certifi==2024.2.2 cffi==1.16.0 charset-normalizer==3.3.2 cryptography==42.0.5 decorator==5.1.1 Deprecated==1.2.14 fabric==3.2.2 frozenlist==1.4.1 future==1.0.0 h11==0.14.0 idna==3.6 invoke==2.2.0 jmespath==1.0.1 marshmallow==3.21.1 multidict==6.0.5 numpy==1.26.4 opencv-python==4.9.0.80 outcome==1.3.0.post0 packaging==24.0 paramiko==3.4.0 pillow==10.2.0 pipdeptree==2.16.2 pycparser==2.21 pydantic==2.6.4 pydantic_core==2.16.3 PyNaCl==1.5.0 pyserial==3.5 PySocks==1.7.1 pytesseract==0.3.10 python-dateutil==2.9.0.post0 python-kasa==0.6.2.1 PyYAML==6.0.1 requests==2.31.0 requests-toolbelt==1.0.0 s3transfer==0.10.1 selenium==4.18.1 six==1.16.0 sniffio==1.3.1 sortedcontainers==2.4.0 soupsieve==2.5 trio==0.25.0 trio-websocket==0.11.1 typing_extensions==4.10.0 urllib3==1.26.18 wrapt==1.16.0 wsproto==1.2.0 yarl==1.9.4
+
+
diff --git a/docs/doxygen/xml/saveScreenshotTest_8py.xml b/docs/doxygen/xml/saveScreenshotTest_8py.xml
new file mode 100644
index 0000000..4b1c43d
--- /dev/null
+++ b/docs/doxygen/xml/saveScreenshotTest_8py.xml
@@ -0,0 +1,61 @@
+
+
+
+ saveScreenshotTest.py
+ saveScreenshotTest::saveScreenshotTest
+ saveScreenshotTest
+
+
+
+
+
+import import dir_path sys.path.append(dir_path+ "/../../../" ) from import class [saveScreenshotTest](testController):def __init__(self, def testFunction(self): "./unitTests/framework/webControlTests/webPageTest.yml" ) "https://testpages.herokuapp.com/styled" , "form_page" ) "Attempting ) "formPage" ) "{self.log.logPath}browser/formPage.html" if True , "Snapshot ) else : False , "Snapshot ) "Attempting ) "formPage" ) "{self.log.logPath}browser/formPage.png" if True , "Screenshot ) else : False , "Screenshot ) if "__main__" : [saveScreenshotTest]()
+
+
diff --git a/docs/doxygen/xml/selectOptionsTests_8py.xml b/docs/doxygen/xml/selectOptionsTests_8py.xml
new file mode 100644
index 0000000..0eda89f
--- /dev/null
+++ b/docs/doxygen/xml/selectOptionsTests_8py.xml
@@ -0,0 +1,80 @@
+
+
+
+ selectOptionsTests.py
+ selectOptionsTests::selectOptionsTests
+ selectOptionsTests
+
+
+
+
+
+import import dir_path sys.path.append(dir_path+ "/../../../" ) from import class [selectOptionsTests](testController):def __init__(self, def testFunction(self): "./unitTests/framework/webControlTests/webPageTest.yml" ) "https://testpages.herokuapp.com/styled" , "form_page" ) "Getting ) "dropdown_select" ) if "Drop and True , "First ) else : False , "First " "Getting ) "dropdown_select" ) if True , "Options ) else : False , "Options ) "select" , "multi_select" , "selectVal" : "Selection }) "select" , "multi_select" , "selectVal" : "Selection }) "Getting ) "multi_select" ) if "Selection and "Selection and "Selection and True , "Selected ) else : False , "Selected "Seeing ) if "checkbox_3" ): True , "Checkbox ) else : False , "Checkbox ) "Seeing ) if "radio_button_3" ): False , "Radio ) else : True , "Radio ) if "__main__" : [selectOptionsTests]()
+
+
diff --git a/docs/doxygen/xml/seleniumDriver_8py.xml b/docs/doxygen/xml/seleniumDriver_8py.xml
new file mode 100644
index 0000000..2e59e15
--- /dev/null
+++ b/docs/doxygen/xml/seleniumDriver_8py.xml
@@ -0,0 +1,374 @@
+
+
+
+ seleniumDriver.py
+ seleniumDriver::seleniumDriver
+ seleniumDriver
+
+
+
+
+
+import from import from import from import from import as from import from import from import from import class [seleniumDriver]():def __init__(self, [log][_setWebdriver](webDriverConfig)def _setWebdriver(self, """Provides True "windowSize" ) if None : [log].info("windowSize ) "1920x1080" 'window-size={windowSize}' ) "webdriverDownloadPath" ) if [log].logPath,if not "download.default_directory" : "prefs" ] [log].info(f"Set ) else : [log].warn("No ) if 'supportedBrowser' ) 'chrome' : "webdriverLocation" ) if [browser]else : [browser]return def [navigateTo](self,"""Naviagates [browser].get(url)def [getElementType](self,"""Gives 'LINK_TEXT' 'XPATH' 'CLASS_NAME' 'NAME' 'ID' 'TAG_NAME' 'PARTIAL_LINK_TEXT' if return [log].error('routerPage.UNSUPPORTED .format(elementType)) def [waitForElement](self,"""Wait [getElementType](element.get("type" )) "value" ) try : [browser],except : [log].error("Element ) raise "Element ) def [sendKeys](self,"""Send [_getElement](element).send_keys(keys)def [click](self,"""Click [_getElement](element).[click]()return True def [selectFromDropdown](self,"""Selects [_getElement](element))def _getElement(self, """Gets [getElementType](element.get("type" )) "value" ) return [browser].find_element(elementType,def getText(self, return [_getElement](element).textdef [clear](self,""" [_getElement](element).[clear]()def [acceptAlert](self):"""Accepts [browser])try : except : "Attempted [log].error(error)raise def [refresh](self):"""Refreshes [browser].[refresh]()def getElementAttribute(self, return [_getElement](element).get_attribute(attribute)def isElementSelected(self, return [_getElement](element).is_selected()def getSelectedOptions(self, [_getElement](element))for in return def getFirstSelectedOption(self, [_getElement](element))return def getSelectAvailableOptions(self, [_getElement](element))for in return def getAlertText(self): [browser])try : return except : "Attempted [log].error(error)return None def dismissAlert(self): [browser])try : return except : "Attempted [log].error(error)raise def saveScreenshot(self, [browser].save_screenshot(f"{directory}/{fileName}.png" ) def getHtml(self): return [browser].page_sourcedef [getTableElements](self,"""Gets [_getElement](element)".//tr" ) for in "th" ) "td" ) for in "{elementName}_r{rowCount}_c{columnCount}" "XPATH" True [getXpath](cell)[_createElementsDictionary](elementNamereturn def [getXpath](self,"""Returns [browser].execute_script("""function , return def _createElementsDictionary( """Creates "elementName" ] "type" ] "value" ] for in if 'text' : "text" ][getText](elementsDictionary) else : return def [newTab](self):"""Creates [browser].current_window_handle[browser].switch_to.new_window("tab" ) [browser].current_window_handlereturn def [switchTab](self,"""Switchs [browser].current_window_handle[browser].switch_to.window(tab)[browser].current_window_handlereturn def [getWindowId](self):"""Gets return [browser].current_window_handledef getSubElements(self, [_getElement](element)"./child::*" ) for in "{elementName}_e{count}" [getXpath](subElement)[_createElementsDictionary](subElementName,"XPATH" , True )) return
+
+
diff --git a/docs/doxygen/xml/sequenceTest_8py.xml b/docs/doxygen/xml/sequenceTest_8py.xml
new file mode 100644
index 0000000..9b2355b
--- /dev/null
+++ b/docs/doxygen/xml/sequenceTest_8py.xml
@@ -0,0 +1,56 @@
+
+
+
+ sequenceTest.py
+ sequenceTest::sequenceTest
+ sequenceTest
+
+
+
+
+
+import import dir_path sys.path.append(dir_path+ "/../../../" ) from import class [sequenceTest](testController):def __init__(self, def testFunction(self): "./unitTests/framework/webControlTests/webPageTest.yml" ) "https://testpages.herokuapp.com/styled" , "Navigating ) "sequence_page" ) "content" ) if "You : True , "Text ) else : False , "Text ) if "__main__" : [sequenceTest]()
+
+
diff --git a/docs/doxygen/xml/serialClass_8py.xml b/docs/doxygen/xml/serialClass_8py.xml
new file mode 100644
index 0000000..db1495e
--- /dev/null
+++ b/docs/doxygen/xml/serialClass_8py.xml
@@ -0,0 +1,152 @@
+
+
+
+ serialClass.py
+ core::commandModules::serialClass::serialSession
+ core::commandModules::serialClass
+
+
+
+
+
+import as from import class [serialSession](consoleInterface):"""Handle def __init__(self, [log][workspacePath][serialPort][serialFile]"session.log" [timeout][baudRate][type]="serial" try : [serialCon][serialPort],[baudRate],except as [log].error('Failed .format(e)) raise 'Failed ) def [open](self):"""Starts try : if not [serialCon].is_open:[serialCon].[open]()except as [log].error('Failed try : [serialFileHandler][open](self.[serialFile],"w+" ) except as [log].error('Failed [serialCon].is_openreturn def [close](self):"""Closes if [serialFileHandler]:[log].debug("Successfully ) try : [serialFileHandler].[close]()except as [log].error('Failed ) [log].error(e)[log].debug("Successfully ) try : [serialCon].[close]()except as [log].error('Failed ) [log].error(e)return True def [write](self,"""Write [log].debug("Writing .format(message.strip())) try : [serialCon].[write](message.encode('utf-8' )) except as [log].error('Failed return False return True def [writeLines](self,"""Write try : [serialCon].writelines(message.encode('utf-8' )) except as [log].error('Failed return True def [read_until](self,"""Read 'utf-8' ) [serialCon].[read_until]("utf-8" , 'ignore' ) try : [serialFileHandler].writelines(writeString)except as [log].error('Failed return def [read_all](self):"""Read [serialCon].[read_all]()if '' : return "" "utf-8" , 'ignore' ) try : [serialFileHandler].writelines(writeString)except as [log].error('Failed return def [flush](self):"""Clear [log].info("Clearing ) [serialCon].flushInput()return True
+
+
diff --git a/docs/doxygen/xml/skyProc_8py.xml b/docs/doxygen/xml/skyProc_8py.xml
new file mode 100644
index 0000000..2106be7
--- /dev/null
+++ b/docs/doxygen/xml/skyProc_8py.xml
@@ -0,0 +1,57 @@
+
+
+
+ skyProc.py
+ skyProc::remoteSkyProc
+ skyProc
+
+
+
+
+
+import from import class [remoteSkyProc]():def __init__( [log][ip]"ip" ] [port]"port" ] def command(self, [telnet]=telnet(self.[log],'{}:{}' .format([ip],[port] None , None ) if False ==self.[telnet].connect(): return False [telnet].read_very_eager()if False ==self.[telnet].write(cmd): return False if not "(OK)" in [telnet].read_until("(OK)" ): return False [telnet].disconnect()return True def sendKey(self, "echo " for in return True
+
+
diff --git a/docs/doxygen/xml/sshConsole_8py.xml b/docs/doxygen/xml/sshConsole_8py.xml
new file mode 100644
index 0000000..735cced
--- /dev/null
+++ b/docs/doxygen/xml/sshConsole_8py.xml
@@ -0,0 +1,107 @@
+
+
+
+ sshConsole.py
+ core::commandModules::sshConsole::sshConsole
+ core::commandModules::sshConsole
+
+
+
+
+
+from import from import class [sshConsole]([consoleInterface]):"""sshConsole def __init__(self, [address][username][password][key][console][console].load_system_host_keys(known_hosts)[buffer][stdout]None [type]="ssh" def [open](self):"""Open [console].connect(self.[address],[username],[password],[key])def [write](self,"""Write if [stdout]:[buffer].extend(self.[stdout].readlines())[stdout],[stderr][console].exec_command(message,True ) def [read_all](self):"""Capture "" [buffer].extend(self.[stdout].readlines())[stdout]None while [buffer].__len__()[buffer].pop(0)return def [read_until](self,"""Read "" [buffer].extend(self.[stdout].readlines())[stdout]None while [buffer].__len__()[buffer].pop(0)if in break return def [close](self):"""Close [console].[close]()
+
+
diff --git a/docs/doxygen/xml/startup_8py.xml b/docs/doxygen/xml/startup_8py.xml
new file mode 100644
index 0000000..dd13b68
--- /dev/null
+++ b/docs/doxygen/xml/startup_8py.xml
@@ -0,0 +1,42 @@
+
+
+
+ startup.py
+ framework::startup::framework_test1
+ framework::startup
+
+
+
+
+
+import import dir_path sys.path.append(dir_path+ "/../../" ) from import class [framework_test1](testController):def __init__(self): 'unit2 ) "framework_test" , "1" ) def testFunction(self): "unit_test2 ) return True if '__main__' : [framework_test1]()
+
+
diff --git a/docs/doxygen/xml/tabsTest_8py.xml b/docs/doxygen/xml/tabsTest_8py.xml
new file mode 100644
index 0000000..bef3e6b
--- /dev/null
+++ b/docs/doxygen/xml/tabsTest_8py.xml
@@ -0,0 +1,112 @@
+
+
+
+ tabsTest.py
+ tabsTest::tabsTest
+ tabsTest
+
+
+
+
+
+import import dir_path sys.path.append(dir_path+ "/../../../" ) from import class [tabsTest](testController):def __init__(self, def testFunction(self): "./unitTests/framework/webControlTests/webPageTest.yml" ) "https://testpages.herokuapp.com/styled" , "Navigating ) "test_locator" ) "paragraph_a_XPATH" ) if "This : True , "Content ) else : False , "Content ) "Creating ) "./unitTests/framework/webControlTests/webPageTestAlternative.yml" ) "tab2" , "https://testpages.herokuapp.com" , "attributes_page" ) "paragraph" ) if "This : True , "Content ) else : False , "Content ) "Returning ) "default" ) "paragraph_a_XPATH" ) if "This : True , "Content ) else : False , "Content ) "Navigating ) "index_page" ) "link_to_redirect_page" ) if "Redirect : True , "Content ) else : False , "Content ) "Switching ) "tab2" ) "paragraph" ) if "This : True , "Content ) else : False , "Content ) "Checking ) if "default" , "tab2" ]: True , "Tabs ) else : False , "Tabs ) if "__main__" : [tabsTest]()
+
+
diff --git a/docs/doxygen/xml/telnetClass_8py.xml b/docs/doxygen/xml/telnetClass_8py.xml
new file mode 100644
index 0000000..9cf08fb
--- /dev/null
+++ b/docs/doxygen/xml/telnetClass_8py.xml
@@ -0,0 +1,189 @@
+
+
+
+ telnetClass.py
+ core::commandModules::telnetClass::telnet
+ core::commandModules::telnetClass
+
+
+
+
+
+import import from import class [telnet]([consoleInterface]):"""telnet def __init__(self,log, [tn]None [username][password][type]="telnet" try : ':' ) if [host]=xhost[0][port]=xhost[1]else : raise except : [host][port][timeout][log][sessionLogFile]"session.log" try : [sessionLogHand][open](self.[sessionLogFile],"w+" ) except as [log].error('Failed def [open](self):"""Open [connect]()def [close](self):"""Close [disconnect]()def [connect](self,", Password: "): try [log].info("Host .format(self.[host])) [tn][host],[port],[timeout])except [log].error("telnet.connect() ) return False except [log].error("telnet.connect() ) return False if [username]is None : return True [log].info("Username .format([username])) [read_until](username_prompt)if return False [write](self.[username])if [password]is None : return True [log].info("Password .format([password])) [read_until](password_prompt)if return False [write](self.[password])return True def [disconnect](self):"""Close [tn].[close]()return True def [write](self,message):"""Write try : [tn].[write](message"\r\n" ) except [log].error("telnet.write() ) return False return True def [read_until](self,value):"""Read [tn].[read_until](message,self.[timeout])return def [read_eager](self):"""Read [tn].[read_eager]()return def [read_very_eager](self):"""Read [tn].[read_very_eager]()return def [read_some](self):"""Read [tn].[read_some]()return def [read_all](self):"""Read return [read_eager]()
+
+
diff --git a/docs/doxygen/xml/testControl_8py.xml b/docs/doxygen/xml/testControl_8py.xml
new file mode 100644
index 0000000..ad5e563
--- /dev/null
+++ b/docs/doxygen/xml/testControl_8py.xml
@@ -0,0 +1,657 @@
+
+
+
+ testControl.py
+ core::testControl::testController
+ core::testControl
+
+
+
+
+
+import import import import import import import import import import import import import import dir_path from import from import from import from import from import from import from import from import from import class [testController]():None None None None False def __init__(self, [testStartTime]'' [log][log].setLevel(level)False [summaryLog]if [summaryLog]None : [summaryLog]"-summary" [summaryLogCreated]True [maxRunTime][loopCount][result]False [testName][qcId][capture]None [webpageController]None [signal_handler])[config][log])if [config].debugTrue : [log].setLevel(self.[log].DEBUG)[rackControl][config].rackConfig[deviceConfig][config].deviceConfig[deviceConfig].decodeConfig([config].rackConfig[config].args.rackNameif None : [rackControl].getRackByIndex(else : [rackControl].getRackByName(if [config].args.slotNumberNone : [config].args.slotNumberelse : [config].args.slotNameif None : else : [slotInfo]if [config].testModeNone [testMode][config].testModeif [config].loopNone [loopCount][config].loop)[logConfig][config].rackConfig.get("local" ).get( "log" ) [logPath][constructLogPath](rack.name,self.[slotInfo].config["name" [testLogPath][constructTestPath]()"test-{}.log" .format(self.[summaryLog].summaryTestTotal) [log].setFilename([testLogPath],[logPath]if None : [testLogPath][summaryLog].setFilename("test_summary.log" ) [devices][slotInfo].config.get("devices" ),[log],[testLogPath]) [dut][devices].getDevice("dut" [session][dut].getConsoleSession()[outboundClient][dut].outBoundClient[powerControl][dut].powerControl[commonRemote][dut].remoteController[utils][log])[slotInfo].getPlatform()[cpe][deviceConfig].getCPEEntryViaPlatform(cpePlatform)if [cpe]None : [log].warn("CPE .format(cpePlatform)) [config].rackConfig.get("capture" ) if None : [testLogPath],"captureImages" ) [capture][log],[capture].start()else : [log].warn("capture ) if [cpe]None and None and 'screenRegions' in [cpe]:[deviceConfig].getCPEFieldViaPlatform(cpePlatform,"screenRegions" ) [config].decodeConfigIntoDictionary("./{}" .format(captureRegionsFile)) [capture].setRegions(else : [log].warn("screenRegions ) [webDriverConfig][config].rackConfig.get("webpageDriver" ) if [webDriverConfig]None : [webpageController][log],[webDriverConfig])else : [log].warn("webpageController ) if [config].buildConfig:[buildConfig][processBuildConfiguration](self.[config].buildConfig)if [config].overrideCpeConfig:[overrideCpeConfig][processBuildConfiguration](self.[config].overrideCpeConfig)def addDelimiter( [logConfig].get("delimiter" ) if return return def [constructLogPath](self,"""Construct if [summaryLog].pathNone : [summaryLog].pathreturn "%Y%m%d-%H-%M-%S" ) [addDelimiter]([logConfig].get("directory" ) [addDelimiter]([addDelimiter]([addDelimiter]([summaryLog].pathtry : True [log].debug("Directory .format(logPath)) except as [log].error("Directory .format(logPath)) return def [constructTestPath](self):"""Construst [addDelimiter]([logPath][testName]"-" [qcId]try : True [log].debug("Directory .format(testPath)) [addDelimiter]("screenImages" ) True except as [log].error("Directory .format(testPath)) return def [waitForBoot](self):"""[wait return True def [testFunction](self):"""Executes return True def [testPrepareFunction](self):"""Executes return True def [testEndFunction](self,"""Close [session].close()if [powerControl].powerOff()if [webpageController]is not None : [webpageController].closeBrowser()if [capture]is not None : [capture].stop()return True def [testExceptionCleanUp](self):"""Cleans return def [waitSeconds](self,"""Sleep if True "waitSeconds[" +str(seconds)+ "]" ) if if True "Waited:[" "]" ) def [waitForSessionMessage](self,"""User "testControl.waitForSessionMessage(" +message+ ")" try : if "Could .format(message)) raise " ) return False except as raise 'Waitfor .format(message)) return True def [writeMessageToSession](self,message):"""User "testControl.writeMessageToSession({})" .format(message.strip()) def [programOutboundWithValidImage]("""program if None : return def [processBuildConfiguration](self,"""Downloads "testControl.processBuildConfiguration" ) try : except as raise "testControl.processBuildConfiguration .format(e)) return def [validatePlatform](self,"""Validate "validatePlatform .format(platform)) if 'platform' ]: return True if in return True return False def [run](self,""" if False "could return False "testPrepareFunction()" +logModule.SEPERATOR True if False if True ): False while False : if if break if try : except as 'testControl ) try : except as 'Exception ) "************************" ) False , "Exception .format(exceptionDict.get( "exception" ), "method" ), "file" ), "line" ))) break if False : break if if if break "[{}] .format(self.testName) "[{}] .format(self.testName) return def [parseException](self,"""Parses "\n" ) None for in if "File in "exception" ] " ) try : 'File' )+1 "file" ] "," , "" ) except raise "Incorrect ) try : 'line' )+1 "line" ] "," , "" ) except raise "Incorrect ) try : 'in' )+1 "method" ] except raise "Incorrect ) return def [signal_handler](self,"""Signal "signal_handler .format(frame) def [runHostCommand](self,"""Run None None if True True True if True if True try : except : " +str(errs)+ "]" ) return def [syscmd](self,""" "command: +str(cmd)+ "]" ) True , True ) if True if "command: +str(self.output)+ "], +str(p.returncode)+ "]" ) return if if return else : return return def pingTest(self, "waitForBoot( .format(self.slotInfo.getDeviceAddress())) "%H:%M:%S" ,time.gmtime(pingStartTime)) "ping .format(timeString) "%H:%M:%S" ,time.gmtime(time.time())) "ping .format(timeString) "%H:%M:%S" , "Time +elasped_string+ "]" ) if False "ping +elasped_string+ "]" ) raise " ) return def _pingTestOnly(self, """perform False if 'windows' ) or 'cygwin' in " " else : " " "ping" "1" True if "ping ) return True for in "pingTest +str(x)+ "]" ) "ping" "10" True if if ", in True "pingTest ) break "pingTest ) return def [waitForPrompt](self,""" if None : "prompt" ) "\n" ) return
+
+
diff --git a/docs/doxygen/xml/unitTests_2framework_2____init_____8py.xml b/docs/doxygen/xml/unitTests_2framework_2____init_____8py.xml
new file mode 100644
index 0000000..82c37d4
--- /dev/null
+++ b/docs/doxygen/xml/unitTests_2framework_2____init_____8py.xml
@@ -0,0 +1,27 @@
+
+
+
+ __init__.py
+ framework
+
+
+
+
+
+import import dir_path sys.path.append(dir_path+ "../../../" ) print(sys.path)
+
+
diff --git a/docs/doxygen/xml/utilities_8py.xml b/docs/doxygen/xml/utilities_8py.xml
new file mode 100644
index 0000000..3ed565c
--- /dev/null
+++ b/docs/doxygen/xml/utilities_8py.xml
@@ -0,0 +1,92 @@
+
+
+
+ utilities.py
+ core::utilities::utilities
+ core::utilities
+
+
+
+
+
+import import class [utilities]():def __init__(self, [log]def wait(self, [log].info("Wait .format(seconds, if if [log].info('Wait ) return def fuzzyCompareText(self, [log].info('fuzzyCompareText: .format(expText, False ' , '' ) ' , '' ) if else : True if '*' , '.*' ), else False [log].info('fuzzyCompareText .format(result)) return def [value1HigherThanValue2](self,"""Compares [log].info('utils.value1HigherThanValue2 .format(value1, '.' ) '.' ) for in for in if return True if if return True if if return True return False
+
+
diff --git a/docs/doxygen/xml/webpageControlTests_8py.xml b/docs/doxygen/xml/webpageControlTests_8py.xml
new file mode 100644
index 0000000..de636bd
--- /dev/null
+++ b/docs/doxygen/xml/webpageControlTests_8py.xml
@@ -0,0 +1,54 @@
+
+
+
+ webpageControlTests.py
+ webpageControlTests
+
+
+
+
+
+from import import import dir_path sys.path.append(dir_path+ "/../../../" ) from import from import from import from import from import from import from import from import from import from import from import from import if "__main__" : "WebpageControlTests" , "WebpageControlTests" , "1" ) [performActionsTests](log=summary)[dynamicButtonsTest](log=summary)[alertTest](log=summary)[sequenceTest](log=summary)[elementAttributeTest](log=summary)[selectOptionsTests](log=summary)[globalActionTest](log=summary)[downloadTest](log=summary)[saveScreenshotTest](log=summary)[dynamicTablesTest](log=summary)
+
+
diff --git a/docs/doxygen/xml/webpageController_8py.xml b/docs/doxygen/xml/webpageController_8py.xml
new file mode 100644
index 0000000..845c687
--- /dev/null
+++ b/docs/doxygen/xml/webpageController_8py.xml
@@ -0,0 +1,698 @@
+
+
+
+ webpageController.py
+ core::webpageController::webpageController
+ core::webpageController
+
+
+
+
+
+import dir_path from import class [webpageController]():def __init__(self, [_pages]None [webDriver]None [log]if not "{log.logPath}browser" ): "{log.logPath}browser" ) if None : return if "controlType" ) "selenium" : [webDriver][seleniumDriver](log,if [_setWebpageConfig](webpageConfig)if [_setBaseUrl](baseUrl)[currentTab]"default" [currentPage]None [currentPageName]None [currentView]None [defaultView]None [tabs]def _setBaseUrl(self, """Sets if "http://" in or "https://" in [url]else : [url]"http://" def _setWebpageConfig(self, """ [webpageConfig][_pages]"pages" ) [globalActions]"global_actions" ) def [configureWebpages](self,""" [_setBaseUrl](baseUrl)[_setWebpageConfig](webpageConfig)def [setWebpage](self,"""Tells [tabs][self.[currentTab]]"pageName" :pageName, "windowId" :self.[_getwindowId](), "baseUrl" :[url], "webpageConfig" :self.[webpageConfig]} if not [currentPage]None [currentPageName]None return [_getPage](pageName)[removeTemporaryWebElements]()[currentPage][currentPageName]if "views" ): [defaultView]"views" ).get( "default" ) else : [defaultView]None [currentView]None [_validateView]()def _isConfigured(self): """Checks if not [url]and [_pages]:raise "Base ) def _isOnPage(self): """Checks if not [currentPage]:raise "No ) def [navigateTo](self,""" [_isConfigured]()[removeTemporaryWebElements]()[_getPage](pageName)[log].debug("Navigating "' ) "url_extension" ) if [webDriver].[navigateTo](self.[url]"url_extension" )) else : "sequence" ) if is None : raise "No [_navigateSequence](navigationSequence)[setWebpage](pageName)def _navigateSequence(self, """ for in [navigateTo](page)[performAction](action)def _checkElements(self, """ if not [currentPage]:raise "Not ) for in try : [webDriver].waitForElement(element)[log].debug("Found except : [log].debug(f"Could ) if "Elements: [log].error(error)raise [log].info("All [currentPageName])def _validateView(self, """Validates [currentPage].get("views" ) if if is None : "View: [log].error(error)raise else : [currentPage]for in "elements" ): [_getElement](elementName)[_checkElements](elements)def _getPage(self, """ [pages].get(pageName)if not raise "Page:" " ) return def _getElement(self, """ [_isOnPage]()[currentPage].get("elements" ).get(elementName) if not "Element "' [currentPageName]"'" [log].error(error)raise if [defaultView]:if in [defaultView].get("elements" ): return [_getViewForElement](elementName)[_getView](viewName)if [currentView]and [defaultView][_activateView](viewName)return def _getViewForElement(self, """Gets [currentPage].get("views" ) for in if in "elements" ): return "Element "' [currentPageName]"'" [log].error(error)raise def _getView(self, """Returns [currentPage].get("views" ) if is None : "Cannot [log].error(error)raise if is None : "View [log].error(error)raise return def _activateView(self, """Activates [log].info(f"Activating ) [_getView](viewName)"sequence" ) if [performAction](sequence)[currentView][_validateView](viewName)def _getAction(self, """ [_isOnPage]()[currentPage].get("actions" ).get(actionName) if not raise "Action: " [currentPageName])return def [pages](self):"""Gets return [_pages].copy()def [performAction](self,""" [_getAction](actionName)for in for in None None if if "args" ): [_interactionArgsSub](interactionVars.get("args" ), if "element" ): "element" ) [performInteraction](interactionType,def getTextOfElement(self, return [webDriver].getText(self.[_getElement](elementName))def [performInteraction](self,""" "Performing if " [_getElement](elementName)if " [log].debug(debugInfo)if "send_keys" : [webDriver].sendKeys(element,"keys" )) elif "click" : [webDriver].click(element)elif "accept_alert" : [webDriver].acceptAlert()elif "clear" : [webDriver].clear(element)elif "refresh" : [log].info("Refreshing [currentPageName])[webDriver].refresh()[removeTemporaryWebElements]()[_validateView]()elif "select" : [webDriver].selectFromDropdown(element,"selectVal" )) elif "dismiss_alert" : [webDriver].dismissAlert()def _interactionArgsSub(self, """ for in if '$' : if not "Did "'. [log].error(error)raise return def [performGlobalAction](self,"""Performs if not [globalActions]:raise "Webpage ) [globalActions].get(globalActionName)for in for in [navigateTo](page)[performAction](actionName,def [getElementAttribute](self,"""Gets return [webDriver].[getElementAttribute](self.[_getElement](elementName),def [isElementSelected](self,"""Returns return [webDriver].[isElementSelected](self.[_getElement](elementName))def [getSelectedOptions](self,"""Gets return [webDriver].[getSelectedOptions](self.[_getElement](elementName))def [getFirstSelectedOption](self,"""Gets return [webDriver].[getFirstSelectedOption](self.[_getElement](elementName))def [getSelectAvailableOptions](self,"""Gets return [webDriver].[getSelectAvailableOptions](self.[_getElement](elementName))def [getUrl](self):"""Gets return [webDriver].browser.current_urldef [getAlertText](self):"""Gets return [webDriver].[getAlertText]()def [closeBrowser](self):"""Ends [log].debug("Closing ) if [webDriver]None : [webDriver].browser.close()def [saveScreenshot](self,"""Saves [log].debug(f"Saving ) [webDriver].[saveScreenshot](f"{self.log.logPath}browser/" , def [saveHtmlSnapshot](self,"""Saves [log].debug(f"Saving ) with '{self.log.logPath}browser/{fileName}.html' , 'w' ) as [webDriver].getHtml())def [getDynamicTable](self,"""Gets [removeTemporaryWebElements]()[_getElement](elementName)if "dynamic_element" ]: [webDriver].getTableElements(element,else : raise "Expecting ) for in for in [currentPage]["elements" ][column[ "elementName" ]] return def [getDynamicTableText](self,"""Gets [log].warn("METHOD ) return [getDynamicTable](elementName,True ) def [removeTemporaryWebElements](self):"""Removes if [currentPage]None : for in [currentPage]["elements" ].items(): if "temporaryFlag" ): for in [currentPage]["elements" ].pop(tempElement) def [createNewTab](self,"""Creates [log].info(f"Creating ) [webDriver].newTab()[configureWebpages](baseUrl,[currentTab][setWebpage](None ) def [switchTab](self,"""Switches [log].info(f"Switching ) [tabs].get(tabName)[webDriver].[switchTab](tab["windowId" ]) [currentTab][configureWebpages](tab["baseUrl" ], "webpageConfig" ]) [setWebpage](tab["pageName" ]) def [getTabs](self):"""Returns return [tabs].keys())def [getTab](self,"""Gets return [tabs][tabName]def _getwindowId(self): """Gets return [webDriver].getWindowId()def [getSubElements](self,"""Returns [_getElement](elementName)[webDriver].[getSubElements](element,for in [currentPage]["elements" ][subElement[ "elementName" ]] "elementName" ]) return
+
+
diff --git a/docs/sphinx/build/html/.buildinfo b/docs/sphinx/build/html/.buildinfo
new file mode 100644
index 0000000..fda7fcc
--- /dev/null
+++ b/docs/sphinx/build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: ad42d17a3c3d1caf536d55b9f66581ff
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/sphinx/build/html/.doctrees/commandModules.doctree b/docs/sphinx/build/html/.doctrees/commandModules.doctree
new file mode 100644
index 0000000..fadb5d3
Binary files /dev/null and b/docs/sphinx/build/html/.doctrees/commandModules.doctree differ
diff --git a/docs/sphinx/build/html/.doctrees/core.commandModules.doctree b/docs/sphinx/build/html/.doctrees/core.commandModules.doctree
new file mode 100644
index 0000000..19b77e2
Binary files /dev/null and b/docs/sphinx/build/html/.doctrees/core.commandModules.doctree differ
diff --git a/docs/sphinx/build/html/.doctrees/core.doctree b/docs/sphinx/build/html/.doctrees/core.doctree
new file mode 100644
index 0000000..cd1e457
Binary files /dev/null and b/docs/sphinx/build/html/.doctrees/core.doctree differ
diff --git a/docs/sphinx/build/html/.doctrees/core.powerModules.doctree b/docs/sphinx/build/html/.doctrees/core.powerModules.doctree
new file mode 100644
index 0000000..d761b5b
Binary files /dev/null and b/docs/sphinx/build/html/.doctrees/core.powerModules.doctree differ
diff --git a/docs/sphinx/build/html/.doctrees/environment.pickle b/docs/sphinx/build/html/.doctrees/environment.pickle
new file mode 100644
index 0000000..cc43f25
Binary files /dev/null and b/docs/sphinx/build/html/.doctrees/environment.pickle differ
diff --git a/docs/sphinx/build/html/.doctrees/index.doctree b/docs/sphinx/build/html/.doctrees/index.doctree
new file mode 100644
index 0000000..ae263e2
Binary files /dev/null and b/docs/sphinx/build/html/.doctrees/index.doctree differ
diff --git a/docs/sphinx/build/html/.doctrees/modules.doctree b/docs/sphinx/build/html/.doctrees/modules.doctree
new file mode 100644
index 0000000..134889d
Binary files /dev/null and b/docs/sphinx/build/html/.doctrees/modules.doctree differ
diff --git a/docs/sphinx/build/html/_sources/commandModules.rst.txt b/docs/sphinx/build/html/_sources/commandModules.rst.txt
new file mode 100644
index 0000000..6c433cc
--- /dev/null
+++ b/docs/sphinx/build/html/_sources/commandModules.rst.txt
@@ -0,0 +1,45 @@
+commandModules package
+======================
+
+Submodules
+----------
+
+commandModules.consoleInterface module
+--------------------------------------
+
+.. automodule:: commandModules.consoleInterface
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+commandModules.serialClass module
+---------------------------------
+
+.. automodule:: commandModules.serialClass
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+commandModules.sshConsole module
+--------------------------------
+
+.. automodule:: commandModules.sshConsole
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+commandModules.telnetClass module
+---------------------------------
+
+.. automodule:: commandModules.telnetClass
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: commandModules
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/sphinx/build/html/_sources/core.commandModules.rst.txt b/docs/sphinx/build/html/_sources/core.commandModules.rst.txt
new file mode 100644
index 0000000..88d629b
--- /dev/null
+++ b/docs/sphinx/build/html/_sources/core.commandModules.rst.txt
@@ -0,0 +1,45 @@
+core.commandModules package
+===========================
+
+Submodules
+----------
+
+core.commandModules.consoleInterface module
+-------------------------------------------
+
+.. automodule:: core.commandModules.consoleInterface
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.commandModules.serialClass module
+--------------------------------------
+
+.. automodule:: core.commandModules.serialClass
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.commandModules.sshConsole module
+-------------------------------------
+
+.. automodule:: core.commandModules.sshConsole
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.commandModules.telnetClass module
+--------------------------------------
+
+.. automodule:: core.commandModules.telnetClass
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: core.commandModules
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/sphinx/build/html/_sources/core.powerModules.rst.txt b/docs/sphinx/build/html/_sources/core.powerModules.rst.txt
new file mode 100644
index 0000000..171793b
--- /dev/null
+++ b/docs/sphinx/build/html/_sources/core.powerModules.rst.txt
@@ -0,0 +1,77 @@
+core.powerModules package
+=========================
+
+Submodules
+----------
+
+core.powerModules.S20control module
+-----------------------------------
+
+.. automodule:: core.powerModules.S20control
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.powerModules.SLP module
+----------------------------
+
+.. automodule:: core.powerModules.SLP
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.powerModules.apc module
+----------------------------
+
+.. automodule:: core.powerModules.apc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.powerModules.apcAos module
+-------------------------------
+
+.. automodule:: core.powerModules.apcAos
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.powerModules.hs100 module
+------------------------------
+
+.. automodule:: core.powerModules.hs100
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.powerModules.kasaControl module
+------------------------------------
+
+.. automodule:: core.powerModules.kasaControl
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.powerModules.none module
+-----------------------------
+
+.. automodule:: core.powerModules.none
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.powerModules.olimex module
+-------------------------------
+
+.. automodule:: core.powerModules.olimex
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: core.powerModules
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/sphinx/build/html/_sources/core.rst.txt b/docs/sphinx/build/html/_sources/core.rst.txt
new file mode 100644
index 0000000..275bead
--- /dev/null
+++ b/docs/sphinx/build/html/_sources/core.rst.txt
@@ -0,0 +1,134 @@
+core package
+============
+
+Subpackages
+-----------
+
+.. toctree::
+ :maxdepth: 4
+
+ core.commandModules
+ core.powerModules
+
+Submodules
+----------
+
+core.capture module
+-------------------
+
+.. automodule:: core.capture
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.commonRemote module
+------------------------
+
+.. automodule:: core.commonRemote
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.configParser module
+------------------------
+
+.. automodule:: core.configParser
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.configParserBase module
+----------------------------
+
+.. automodule:: core.configParserBase
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.decodeParams module
+------------------------
+
+.. automodule:: core.decodeParams
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.deviceManager module
+-------------------------
+
+.. automodule:: core.deviceManager
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.logModule module
+---------------------
+
+.. automodule:: core.logModule
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.outboundClient module
+--------------------------
+
+.. automodule:: core.outboundClient
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.powerControl module
+------------------------
+
+.. automodule:: core.powerControl
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.rackController module
+--------------------------
+
+.. automodule:: core.rackController
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.rcCodes module
+-------------------
+
+.. automodule:: core.rcCodes
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.testControl module
+-----------------------
+
+.. automodule:: core.testControl
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.utilities module
+---------------------
+
+.. automodule:: core.utilities
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+core.webpageController module
+-----------------------------
+
+.. automodule:: core.webpageController
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: core
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/sphinx/build/html/_sources/index.rst.txt b/docs/sphinx/build/html/_sources/index.rst.txt
new file mode 100644
index 0000000..ba056c6
--- /dev/null
+++ b/docs/sphinx/build/html/_sources/index.rst.txt
@@ -0,0 +1,21 @@
+.. python_raft documentation master file, created by
+ sphinx-quickstart on Thu Apr 4 13:09:14 2024.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to python_raft's documentation!
+=======================================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+
+modules
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/sphinx/build/html/_sources/modules.rst.txt b/docs/sphinx/build/html/_sources/modules.rst.txt
new file mode 100644
index 0000000..cc1c6fa
--- /dev/null
+++ b/docs/sphinx/build/html/_sources/modules.rst.txt
@@ -0,0 +1,7 @@
+framework
+=========
+
+.. toctree::
+ :maxdepth: 4
+
+ core
diff --git a/docs/sphinx/build/html/_static/alabaster.css b/docs/sphinx/build/html/_static/alabaster.css
new file mode 100644
index 0000000..517d0b2
--- /dev/null
+++ b/docs/sphinx/build/html/_static/alabaster.css
@@ -0,0 +1,703 @@
+@import url("basic.css");
+
+/* -- page layout ----------------------------------------------------------- */
+
+body {
+ font-family: Georgia, serif;
+ font-size: 17px;
+ background-color: #fff;
+ color: #000;
+ margin: 0;
+ padding: 0;
+}
+
+
+div.document {
+ width: 940px;
+ margin: 30px auto 0 auto;
+}
+
+div.documentwrapper {
+ float: left;
+ width: 100%;
+}
+
+div.bodywrapper {
+ margin: 0 0 0 220px;
+}
+
+div.sphinxsidebar {
+ width: 220px;
+ font-size: 14px;
+ line-height: 1.5;
+}
+
+hr {
+ border: 1px solid #B1B4B6;
+}
+
+div.body {
+ background-color: #fff;
+ color: #3E4349;
+ padding: 0 30px 0 30px;
+}
+
+div.body > .section {
+ text-align: left;
+}
+
+div.footer {
+ width: 940px;
+ margin: 20px auto 30px auto;
+ font-size: 14px;
+ color: #888;
+ text-align: right;
+}
+
+div.footer a {
+ color: #888;
+}
+
+p.caption {
+ font-family: inherit;
+ font-size: inherit;
+}
+
+
+div.relations {
+ display: none;
+}
+
+
+div.sphinxsidebar a {
+ color: #444;
+ text-decoration: none;
+ border-bottom: 1px dotted #999;
+}
+
+div.sphinxsidebar a:hover {
+ border-bottom: 1px solid #999;
+}
+
+div.sphinxsidebarwrapper {
+ padding: 18px 10px;
+}
+
+div.sphinxsidebarwrapper p.logo {
+ padding: 0;
+ margin: -10px 0 0 0px;
+ text-align: center;
+}
+
+div.sphinxsidebarwrapper h1.logo {
+ margin-top: -10px;
+ text-align: center;
+ margin-bottom: 5px;
+ text-align: left;
+}
+
+div.sphinxsidebarwrapper h1.logo-name {
+ margin-top: 0px;
+}
+
+div.sphinxsidebarwrapper p.blurb {
+ margin-top: 0;
+ font-style: normal;
+}
+
+div.sphinxsidebar h3,
+div.sphinxsidebar h4 {
+ font-family: Georgia, serif;
+ color: #444;
+ font-size: 24px;
+ font-weight: normal;
+ margin: 0 0 5px 0;
+ padding: 0;
+}
+
+div.sphinxsidebar h4 {
+ font-size: 20px;
+}
+
+div.sphinxsidebar h3 a {
+ color: #444;
+}
+
+div.sphinxsidebar p.logo a,
+div.sphinxsidebar h3 a,
+div.sphinxsidebar p.logo a:hover,
+div.sphinxsidebar h3 a:hover {
+ border: none;
+}
+
+div.sphinxsidebar p {
+ color: #555;
+ margin: 10px 0;
+}
+
+div.sphinxsidebar ul {
+ margin: 10px 0;
+ padding: 0;
+ color: #000;
+}
+
+div.sphinxsidebar ul li.toctree-l1 > a {
+ font-size: 120%;
+}
+
+div.sphinxsidebar ul li.toctree-l2 > a {
+ font-size: 110%;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid #CCC;
+ font-family: Georgia, serif;
+ font-size: 1em;
+}
+
+div.sphinxsidebar hr {
+ border: none;
+ height: 1px;
+ color: #AAA;
+ background: #AAA;
+
+ text-align: left;
+ margin-left: 0;
+ width: 50%;
+}
+
+div.sphinxsidebar .badge {
+ border-bottom: none;
+}
+
+div.sphinxsidebar .badge:hover {
+ border-bottom: none;
+}
+
+/* To address an issue with donation coming after search */
+div.sphinxsidebar h3.donation {
+ margin-top: 10px;
+}
+
+/* -- body styles ----------------------------------------------------------- */
+
+a {
+ color: #004B6B;
+ text-decoration: underline;
+}
+
+a:hover {
+ color: #6D4100;
+ text-decoration: underline;
+}
+
+div.body h1,
+div.body h2,
+div.body h3,
+div.body h4,
+div.body h5,
+div.body h6 {
+ font-family: Georgia, serif;
+ font-weight: normal;
+ margin: 30px 0px 10px 0px;
+ padding: 0;
+}
+
+div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; }
+div.body h2 { font-size: 180%; }
+div.body h3 { font-size: 150%; }
+div.body h4 { font-size: 130%; }
+div.body h5 { font-size: 100%; }
+div.body h6 { font-size: 100%; }
+
+a.headerlink {
+ color: #DDD;
+ padding: 0 4px;
+ text-decoration: none;
+}
+
+a.headerlink:hover {
+ color: #444;
+ background: #EAEAEA;
+}
+
+div.body p, div.body dd, div.body li {
+ line-height: 1.4em;
+}
+
+div.admonition {
+ margin: 20px 0px;
+ padding: 10px 30px;
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.admonition tt.xref, div.admonition code.xref, div.admonition a tt {
+ background-color: #FBFBFB;
+ border-bottom: 1px solid #fafafa;
+}
+
+div.admonition p.admonition-title {
+ font-family: Georgia, serif;
+ font-weight: normal;
+ font-size: 24px;
+ margin: 0 0 10px 0;
+ padding: 0;
+ line-height: 1;
+}
+
+div.admonition p.last {
+ margin-bottom: 0;
+}
+
+div.highlight {
+ background-color: #fff;
+}
+
+dt:target, .highlight {
+ background: #FAF3E8;
+}
+
+div.warning {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+}
+
+div.danger {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+ -moz-box-shadow: 2px 2px 4px #D52C2C;
+ -webkit-box-shadow: 2px 2px 4px #D52C2C;
+ box-shadow: 2px 2px 4px #D52C2C;
+}
+
+div.error {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+ -moz-box-shadow: 2px 2px 4px #D52C2C;
+ -webkit-box-shadow: 2px 2px 4px #D52C2C;
+ box-shadow: 2px 2px 4px #D52C2C;
+}
+
+div.caution {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+}
+
+div.attention {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+}
+
+div.important {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.note {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.tip {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.hint {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.seealso {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.topic {
+ background-color: #EEE;
+}
+
+p.admonition-title {
+ display: inline;
+}
+
+p.admonition-title:after {
+ content: ":";
+}
+
+pre, tt, code {
+ font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+ font-size: 0.9em;
+}
+
+.hll {
+ background-color: #FFC;
+ margin: 0 -12px;
+ padding: 0 12px;
+ display: block;
+}
+
+img.screenshot {
+}
+
+tt.descname, tt.descclassname, code.descname, code.descclassname {
+ font-size: 0.95em;
+}
+
+tt.descname, code.descname {
+ padding-right: 0.08em;
+}
+
+img.screenshot {
+ -moz-box-shadow: 2px 2px 4px #EEE;
+ -webkit-box-shadow: 2px 2px 4px #EEE;
+ box-shadow: 2px 2px 4px #EEE;
+}
+
+table.docutils {
+ border: 1px solid #888;
+ -moz-box-shadow: 2px 2px 4px #EEE;
+ -webkit-box-shadow: 2px 2px 4px #EEE;
+ box-shadow: 2px 2px 4px #EEE;
+}
+
+table.docutils td, table.docutils th {
+ border: 1px solid #888;
+ padding: 0.25em 0.7em;
+}
+
+table.field-list, table.footnote {
+ border: none;
+ -moz-box-shadow: none;
+ -webkit-box-shadow: none;
+ box-shadow: none;
+}
+
+table.footnote {
+ margin: 15px 0;
+ width: 100%;
+ border: 1px solid #EEE;
+ background: #FDFDFD;
+ font-size: 0.9em;
+}
+
+table.footnote + table.footnote {
+ margin-top: -15px;
+ border-top: none;
+}
+
+table.field-list th {
+ padding: 0 0.8em 0 0;
+}
+
+table.field-list td {
+ padding: 0;
+}
+
+table.field-list p {
+ margin-bottom: 0.8em;
+}
+
+/* Cloned from
+ * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68
+ */
+.field-name {
+ -moz-hyphens: manual;
+ -ms-hyphens: manual;
+ -webkit-hyphens: manual;
+ hyphens: manual;
+}
+
+table.footnote td.label {
+ width: .1px;
+ padding: 0.3em 0 0.3em 0.5em;
+}
+
+table.footnote td {
+ padding: 0.3em 0.5em;
+}
+
+dl {
+ margin-left: 0;
+ margin-right: 0;
+ margin-top: 0;
+ padding: 0;
+}
+
+dl dd {
+ margin-left: 30px;
+}
+
+blockquote {
+ margin: 0 0 0 30px;
+ padding: 0;
+}
+
+ul, ol {
+ /* Matches the 30px from the narrow-screen "li > ul" selector below */
+ margin: 10px 0 10px 30px;
+ padding: 0;
+}
+
+pre {
+ background: #EEE;
+ padding: 7px 30px;
+ margin: 15px 0px;
+ line-height: 1.3em;
+}
+
+div.viewcode-block:target {
+ background: #ffd;
+}
+
+dl pre, blockquote pre, li pre {
+ margin-left: 0;
+ padding-left: 30px;
+}
+
+tt, code {
+ background-color: #ecf0f3;
+ color: #222;
+ /* padding: 1px 2px; */
+}
+
+tt.xref, code.xref, a tt {
+ background-color: #FBFBFB;
+ border-bottom: 1px solid #fff;
+}
+
+a.reference {
+ text-decoration: none;
+ border-bottom: 1px dotted #004B6B;
+}
+
+/* Don't put an underline on images */
+a.image-reference, a.image-reference:hover {
+ border-bottom: none;
+}
+
+a.reference:hover {
+ border-bottom: 1px solid #6D4100;
+}
+
+a.footnote-reference {
+ text-decoration: none;
+ font-size: 0.7em;
+ vertical-align: top;
+ border-bottom: 1px dotted #004B6B;
+}
+
+a.footnote-reference:hover {
+ border-bottom: 1px solid #6D4100;
+}
+
+a:hover tt, a:hover code {
+ background: #EEE;
+}
+
+
+@media screen and (max-width: 870px) {
+
+ div.sphinxsidebar {
+ display: none;
+ }
+
+ div.document {
+ width: 100%;
+
+ }
+
+ div.documentwrapper {
+ margin-left: 0;
+ margin-top: 0;
+ margin-right: 0;
+ margin-bottom: 0;
+ }
+
+ div.bodywrapper {
+ margin-top: 0;
+ margin-right: 0;
+ margin-bottom: 0;
+ margin-left: 0;
+ }
+
+ ul {
+ margin-left: 0;
+ }
+
+ li > ul {
+ /* Matches the 30px from the "ul, ol" selector above */
+ margin-left: 30px;
+ }
+
+ .document {
+ width: auto;
+ }
+
+ .footer {
+ width: auto;
+ }
+
+ .bodywrapper {
+ margin: 0;
+ }
+
+ .footer {
+ width: auto;
+ }
+
+ .github {
+ display: none;
+ }
+
+
+
+}
+
+
+
+@media screen and (max-width: 875px) {
+
+ body {
+ margin: 0;
+ padding: 20px 30px;
+ }
+
+ div.documentwrapper {
+ float: none;
+ background: #fff;
+ }
+
+ div.sphinxsidebar {
+ display: block;
+ float: none;
+ width: 102.5%;
+ margin: 50px -30px -20px -30px;
+ padding: 10px 20px;
+ background: #333;
+ color: #FFF;
+ }
+
+ div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
+ div.sphinxsidebar h3 a {
+ color: #fff;
+ }
+
+ div.sphinxsidebar a {
+ color: #AAA;
+ }
+
+ div.sphinxsidebar p.logo {
+ display: none;
+ }
+
+ div.document {
+ width: 100%;
+ margin: 0;
+ }
+
+ div.footer {
+ display: none;
+ }
+
+ div.bodywrapper {
+ margin: 0;
+ }
+
+ div.body {
+ min-height: 0;
+ padding: 0;
+ }
+
+ .rtd_doc_footer {
+ display: none;
+ }
+
+ .document {
+ width: auto;
+ }
+
+ .footer {
+ width: auto;
+ }
+
+ .footer {
+ width: auto;
+ }
+
+ .github {
+ display: none;
+ }
+}
+
+
+/* misc. */
+
+.revsys-inline {
+ display: none!important;
+}
+
+/* Make nested-list/multi-paragraph items look better in Releases changelog
+ * pages. Without this, docutils' magical list fuckery causes inconsistent
+ * formatting between different release sub-lists.
+ */
+div#changelog > div.section > ul > li > p:only-child {
+ margin-bottom: 0;
+}
+
+/* Hide fugly table cell borders in ..bibliography:: directive output */
+table.docutils.citation, table.docutils.citation td, table.docutils.citation th {
+ border: none;
+ /* Below needed in some edge cases; if not applied, bottom shadows appear */
+ -moz-box-shadow: none;
+ -webkit-box-shadow: none;
+ box-shadow: none;
+}
+
+
+/* relbar */
+
+.related {
+ line-height: 30px;
+ width: 100%;
+ font-size: 0.9rem;
+}
+
+.related.top {
+ border-bottom: 1px solid #EEE;
+ margin-bottom: 20px;
+}
+
+.related.bottom {
+ border-top: 1px solid #EEE;
+}
+
+.related ul {
+ padding: 0;
+ margin: 0;
+ list-style: none;
+}
+
+.related li {
+ display: inline;
+}
+
+nav#rellinks {
+ float: right;
+}
+
+nav#rellinks li+li:before {
+ content: "|";
+}
+
+nav#breadcrumbs li+li:before {
+ content: "\00BB";
+}
+
+/* Hide certain items when printing */
+@media print {
+ div.related {
+ display: none;
+ }
+}
\ No newline at end of file
diff --git a/docs/sphinx/build/html/_static/basic.css b/docs/sphinx/build/html/_static/basic.css
new file mode 100644
index 0000000..cfc60b8
--- /dev/null
+++ b/docs/sphinx/build/html/_static/basic.css
@@ -0,0 +1,921 @@
+/*
+ * basic.css
+ * ~~~~~~~~~
+ *
+ * Sphinx stylesheet -- basic theme.
+ *
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+/* -- main layout ----------------------------------------------------------- */
+
+div.clearer {
+ clear: both;
+}
+
+div.section::after {
+ display: block;
+ content: '';
+ clear: left;
+}
+
+/* -- relbar ---------------------------------------------------------------- */
+
+div.related {
+ width: 100%;
+ font-size: 90%;
+}
+
+div.related h3 {
+ display: none;
+}
+
+div.related ul {
+ margin: 0;
+ padding: 0 0 0 10px;
+ list-style: none;
+}
+
+div.related li {
+ display: inline;
+}
+
+div.related li.right {
+ float: right;
+ margin-right: 5px;
+}
+
+/* -- sidebar --------------------------------------------------------------- */
+
+div.sphinxsidebarwrapper {
+ padding: 10px 5px 0 10px;
+}
+
+div.sphinxsidebar {
+ float: left;
+ width: 230px;
+ margin-left: -100%;
+ font-size: 90%;
+ word-wrap: break-word;
+ overflow-wrap : break-word;
+}
+
+div.sphinxsidebar ul {
+ list-style: none;
+}
+
+div.sphinxsidebar ul ul,
+div.sphinxsidebar ul.want-points {
+ margin-left: 20px;
+ list-style: square;
+}
+
+div.sphinxsidebar ul ul {
+ margin-top: 0;
+ margin-bottom: 0;
+}
+
+div.sphinxsidebar form {
+ margin-top: 10px;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid #98dbcc;
+ font-family: sans-serif;
+ font-size: 1em;
+}
+
+div.sphinxsidebar #searchbox form.search {
+ overflow: hidden;
+}
+
+div.sphinxsidebar #searchbox input[type="text"] {
+ float: left;
+ width: 80%;
+ padding: 0.25em;
+ box-sizing: border-box;
+}
+
+div.sphinxsidebar #searchbox input[type="submit"] {
+ float: left;
+ width: 20%;
+ border-left: none;
+ padding: 0.25em;
+ box-sizing: border-box;
+}
+
+
+img {
+ border: 0;
+ max-width: 100%;
+}
+
+/* -- search page ----------------------------------------------------------- */
+
+ul.search {
+ margin: 10px 0 0 20px;
+ padding: 0;
+}
+
+ul.search li {
+ padding: 5px 0 5px 20px;
+ background-image: url(file.png);
+ background-repeat: no-repeat;
+ background-position: 0 7px;
+}
+
+ul.search li a {
+ font-weight: bold;
+}
+
+ul.search li p.context {
+ color: #888;
+ margin: 2px 0 0 30px;
+ text-align: left;
+}
+
+ul.keywordmatches li.goodmatch a {
+ font-weight: bold;
+}
+
+/* -- index page ------------------------------------------------------------ */
+
+table.contentstable {
+ width: 90%;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.contentstable p.biglink {
+ line-height: 150%;
+}
+
+a.biglink {
+ font-size: 1.3em;
+}
+
+span.linkdescr {
+ font-style: italic;
+ padding-top: 5px;
+ font-size: 90%;
+}
+
+/* -- general index --------------------------------------------------------- */
+
+table.indextable {
+ width: 100%;
+}
+
+table.indextable td {
+ text-align: left;
+ vertical-align: top;
+}
+
+table.indextable ul {
+ margin-top: 0;
+ margin-bottom: 0;
+ list-style-type: none;
+}
+
+table.indextable > tbody > tr > td > ul {
+ padding-left: 0em;
+}
+
+table.indextable tr.pcap {
+ height: 10px;
+}
+
+table.indextable tr.cap {
+ margin-top: 10px;
+ background-color: #f2f2f2;
+}
+
+img.toggler {
+ margin-right: 3px;
+ margin-top: 3px;
+ cursor: pointer;
+}
+
+div.modindex-jumpbox {
+ border-top: 1px solid #ddd;
+ border-bottom: 1px solid #ddd;
+ margin: 1em 0 1em 0;
+ padding: 0.4em;
+}
+
+div.genindex-jumpbox {
+ border-top: 1px solid #ddd;
+ border-bottom: 1px solid #ddd;
+ margin: 1em 0 1em 0;
+ padding: 0.4em;
+}
+
+/* -- domain module index --------------------------------------------------- */
+
+table.modindextable td {
+ padding: 2px;
+ border-collapse: collapse;
+}
+
+/* -- general body styles --------------------------------------------------- */
+
+div.body {
+ min-width: 360px;
+ max-width: 800px;
+}
+
+div.body p, div.body dd, div.body li, div.body blockquote {
+ -moz-hyphens: auto;
+ -ms-hyphens: auto;
+ -webkit-hyphens: auto;
+ hyphens: auto;
+}
+
+a.headerlink {
+ visibility: hidden;
+}
+
+h1:hover > a.headerlink,
+h2:hover > a.headerlink,
+h3:hover > a.headerlink,
+h4:hover > a.headerlink,
+h5:hover > a.headerlink,
+h6:hover > a.headerlink,
+dt:hover > a.headerlink,
+caption:hover > a.headerlink,
+p.caption:hover > a.headerlink,
+div.code-block-caption:hover > a.headerlink {
+ visibility: visible;
+}
+
+div.body p.caption {
+ text-align: inherit;
+}
+
+div.body td {
+ text-align: left;
+}
+
+.first {
+ margin-top: 0 !important;
+}
+
+p.rubric {
+ margin-top: 30px;
+ font-weight: bold;
+}
+
+img.align-left, figure.align-left, .figure.align-left, object.align-left {
+ clear: left;
+ float: left;
+ margin-right: 1em;
+}
+
+img.align-right, figure.align-right, .figure.align-right, object.align-right {
+ clear: right;
+ float: right;
+ margin-left: 1em;
+}
+
+img.align-center, figure.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+img.align-default, figure.align-default, .figure.align-default {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left;
+}
+
+.align-center {
+ text-align: center;
+}
+
+.align-default {
+ text-align: center;
+}
+
+.align-right {
+ text-align: right;
+}
+
+/* -- sidebars -------------------------------------------------------------- */
+
+div.sidebar,
+aside.sidebar {
+ margin: 0 0 0.5em 1em;
+ border: 1px solid #ddb;
+ padding: 7px;
+ background-color: #ffe;
+ width: 40%;
+ float: right;
+ clear: right;
+ overflow-x: auto;
+}
+
+p.sidebar-title {
+ font-weight: bold;
+}
+
+nav.contents,
+aside.topic,
+div.admonition, div.topic, blockquote {
+ clear: left;
+}
+
+/* -- topics ---------------------------------------------------------------- */
+
+nav.contents,
+aside.topic,
+div.topic {
+ border: 1px solid #ccc;
+ padding: 7px;
+ margin: 10px 0 10px 0;
+}
+
+p.topic-title {
+ font-size: 1.1em;
+ font-weight: bold;
+ margin-top: 10px;
+}
+
+/* -- admonitions ----------------------------------------------------------- */
+
+div.admonition {
+ margin-top: 10px;
+ margin-bottom: 10px;
+ padding: 7px;
+}
+
+div.admonition dt {
+ font-weight: bold;
+}
+
+p.admonition-title {
+ margin: 0px 10px 5px 0px;
+ font-weight: bold;
+}
+
+div.body p.centered {
+ text-align: center;
+ margin-top: 25px;
+}
+
+/* -- content of sidebars/topics/admonitions -------------------------------- */
+
+div.sidebar > :last-child,
+aside.sidebar > :last-child,
+nav.contents > :last-child,
+aside.topic > :last-child,
+div.topic > :last-child,
+div.admonition > :last-child {
+ margin-bottom: 0;
+}
+
+div.sidebar::after,
+aside.sidebar::after,
+nav.contents::after,
+aside.topic::after,
+div.topic::after,
+div.admonition::after,
+blockquote::after {
+ display: block;
+ content: '';
+ clear: both;
+}
+
+/* -- tables ---------------------------------------------------------------- */
+
+table.docutils {
+ margin-top: 10px;
+ margin-bottom: 10px;
+ border: 0;
+ border-collapse: collapse;
+}
+
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.align-default {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table caption span.caption-number {
+ font-style: italic;
+}
+
+table caption span.caption-text {
+}
+
+table.docutils td, table.docutils th {
+ padding: 1px 8px 1px 5px;
+ border-top: 0;
+ border-left: 0;
+ border-right: 0;
+ border-bottom: 1px solid #aaa;
+}
+
+th {
+ text-align: left;
+ padding-right: 5px;
+}
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px;
+}
+
+table.citation td {
+ border-bottom: none;
+}
+
+th > :first-child,
+td > :first-child {
+ margin-top: 0px;
+}
+
+th > :last-child,
+td > :last-child {
+ margin-bottom: 0px;
+}
+
+/* -- figures --------------------------------------------------------------- */
+
+div.figure, figure {
+ margin: 0.5em;
+ padding: 0.5em;
+}
+
+div.figure p.caption, figcaption {
+ padding: 0.3em;
+}
+
+div.figure p.caption span.caption-number,
+figcaption span.caption-number {
+ font-style: italic;
+}
+
+div.figure p.caption span.caption-text,
+figcaption span.caption-text {
+}
+
+/* -- field list styles ----------------------------------------------------- */
+
+table.field-list td, table.field-list th {
+ border: 0 !important;
+}
+
+.field-list ul {
+ margin: 0;
+ padding-left: 1em;
+}
+
+.field-list p {
+ margin: 0;
+}
+
+.field-name {
+ -moz-hyphens: manual;
+ -ms-hyphens: manual;
+ -webkit-hyphens: manual;
+ hyphens: manual;
+}
+
+/* -- hlist styles ---------------------------------------------------------- */
+
+table.hlist {
+ margin: 1em 0;
+}
+
+table.hlist td {
+ vertical-align: top;
+}
+
+/* -- object description styles --------------------------------------------- */
+
+.sig {
+ font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+}
+
+.sig-name, code.descname {
+ background-color: transparent;
+ font-weight: bold;
+}
+
+.sig-name {
+ font-size: 1.1em;
+}
+
+code.descname {
+ font-size: 1.2em;
+}
+
+.sig-prename, code.descclassname {
+ background-color: transparent;
+}
+
+.optional {
+ font-size: 1.3em;
+}
+
+.sig-paren {
+ font-size: larger;
+}
+
+.sig-param.n {
+ font-style: italic;
+}
+
+/* C++ specific styling */
+
+.sig-inline.c-texpr,
+.sig-inline.cpp-texpr {
+ font-family: unset;
+}
+
+.sig.c .k, .sig.c .kt,
+.sig.cpp .k, .sig.cpp .kt {
+ color: #0033B3;
+}
+
+.sig.c .m,
+.sig.cpp .m {
+ color: #1750EB;
+}
+
+.sig.c .s, .sig.c .sc,
+.sig.cpp .s, .sig.cpp .sc {
+ color: #067D17;
+}
+
+
+/* -- other body styles ----------------------------------------------------- */
+
+ol.arabic {
+ list-style: decimal;
+}
+
+ol.loweralpha {
+ list-style: lower-alpha;
+}
+
+ol.upperalpha {
+ list-style: upper-alpha;
+}
+
+ol.lowerroman {
+ list-style: lower-roman;
+}
+
+ol.upperroman {
+ list-style: upper-roman;
+}
+
+:not(li) > ol > li:first-child > :first-child,
+:not(li) > ul > li:first-child > :first-child {
+ margin-top: 0px;
+}
+
+:not(li) > ol > li:last-child > :last-child,
+:not(li) > ul > li:last-child > :last-child {
+ margin-bottom: 0px;
+}
+
+ol.simple ol p,
+ol.simple ul p,
+ul.simple ol p,
+ul.simple ul p {
+ margin-top: 0;
+}
+
+ol.simple > li:not(:first-child) > p,
+ul.simple > li:not(:first-child) > p {
+ margin-top: 0;
+}
+
+ol.simple p,
+ul.simple p {
+ margin-bottom: 0;
+}
+
+aside.footnote > span,
+div.citation > span {
+ float: left;
+}
+aside.footnote > span:last-of-type,
+div.citation > span:last-of-type {
+ padding-right: 0.5em;
+}
+aside.footnote > p {
+ margin-left: 2em;
+}
+div.citation > p {
+ margin-left: 4em;
+}
+aside.footnote > p:last-of-type,
+div.citation > p:last-of-type {
+ margin-bottom: 0em;
+}
+aside.footnote > p:last-of-type:after,
+div.citation > p:last-of-type:after {
+ content: "";
+ clear: both;
+}
+
+dl.field-list {
+ display: grid;
+ grid-template-columns: fit-content(30%) auto;
+}
+
+dl.field-list > dt {
+ font-weight: bold;
+ word-break: break-word;
+ padding-left: 0.5em;
+ padding-right: 5px;
+}
+
+dl.field-list > dd {
+ padding-left: 0.5em;
+ margin-top: 0em;
+ margin-left: 0em;
+ margin-bottom: 0em;
+}
+
+dl {
+ margin-bottom: 15px;
+}
+
+dd > :first-child {
+ margin-top: 0px;
+}
+
+dd ul, dd table {
+ margin-bottom: 10px;
+}
+
+dd {
+ margin-top: 3px;
+ margin-bottom: 10px;
+ margin-left: 30px;
+}
+
+.sig dd {
+ margin-top: 0px;
+ margin-bottom: 0px;
+}
+
+.sig dl {
+ margin-top: 0px;
+ margin-bottom: 0px;
+}
+
+dl > dd:last-child,
+dl > dd:last-child > :last-child {
+ margin-bottom: 0;
+}
+
+dt:target, span.highlighted {
+ background-color: #fbe54e;
+}
+
+rect.highlighted {
+ fill: #fbe54e;
+}
+
+dl.glossary dt {
+ font-weight: bold;
+ font-size: 1.1em;
+}
+
+.versionmodified {
+ font-style: italic;
+}
+
+.system-message {
+ background-color: #fda;
+ padding: 5px;
+ border: 3px solid red;
+}
+
+.footnote:target {
+ background-color: #ffa;
+}
+
+.line-block {
+ display: block;
+ margin-top: 1em;
+ margin-bottom: 1em;
+}
+
+.line-block .line-block {
+ margin-top: 0;
+ margin-bottom: 0;
+ margin-left: 1.5em;
+}
+
+.guilabel, .menuselection {
+ font-family: sans-serif;
+}
+
+.accelerator {
+ text-decoration: underline;
+}
+
+.classifier {
+ font-style: oblique;
+}
+
+.classifier:before {
+ font-style: normal;
+ margin: 0 0.5em;
+ content: ":";
+ display: inline-block;
+}
+
+abbr, acronym {
+ border-bottom: dotted 1px;
+ cursor: help;
+}
+
+.translated {
+ background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+ background-color: rgba(255, 207, 207, 0.2)
+}
+
+/* -- code displays --------------------------------------------------------- */
+
+pre {
+ overflow: auto;
+ overflow-y: hidden; /* fixes display issues on Chrome browsers */
+}
+
+pre, div[class*="highlight-"] {
+ clear: both;
+}
+
+span.pre {
+ -moz-hyphens: none;
+ -ms-hyphens: none;
+ -webkit-hyphens: none;
+ hyphens: none;
+ white-space: nowrap;
+}
+
+div[class*="highlight-"] {
+ margin: 1em 0;
+}
+
+td.linenos pre {
+ border: 0;
+ background-color: transparent;
+ color: #aaa;
+}
+
+table.highlighttable {
+ display: block;
+}
+
+table.highlighttable tbody {
+ display: block;
+}
+
+table.highlighttable tr {
+ display: flex;
+}
+
+table.highlighttable td {
+ margin: 0;
+ padding: 0;
+}
+
+table.highlighttable td.linenos {
+ padding-right: 0.5em;
+}
+
+table.highlighttable td.code {
+ flex: 1;
+ overflow: hidden;
+}
+
+.highlight .hll {
+ display: block;
+}
+
+div.highlight pre,
+table.highlighttable pre {
+ margin: 0;
+}
+
+div.code-block-caption + div {
+ margin-top: 0;
+}
+
+div.code-block-caption {
+ margin-top: 1em;
+ padding: 2px 5px;
+ font-size: small;
+}
+
+div.code-block-caption code {
+ background-color: transparent;
+}
+
+table.highlighttable td.linenos,
+span.linenos,
+div.highlight span.gp { /* gp: Generic.Prompt */
+ user-select: none;
+ -webkit-user-select: text; /* Safari fallback only */
+ -webkit-user-select: none; /* Chrome/Safari */
+ -moz-user-select: none; /* Firefox */
+ -ms-user-select: none; /* IE10+ */
+}
+
+div.code-block-caption span.caption-number {
+ padding: 0.1em 0.3em;
+ font-style: italic;
+}
+
+div.code-block-caption span.caption-text {
+}
+
+div.literal-block-wrapper {
+ margin: 1em 0;
+}
+
+code.xref, a code {
+ background-color: transparent;
+ font-weight: bold;
+}
+
+h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
+ background-color: transparent;
+}
+
+.viewcode-link {
+ float: right;
+}
+
+.viewcode-back {
+ float: right;
+ font-family: sans-serif;
+}
+
+div.viewcode-block:target {
+ margin: -1px -10px;
+ padding: 0 10px;
+}
+
+/* -- math display ---------------------------------------------------------- */
+
+img.math {
+ vertical-align: middle;
+}
+
+div.body div.math p {
+ text-align: center;
+}
+
+span.eqno {
+ float: right;
+}
+
+span.eqno a.headerlink {
+ position: absolute;
+ z-index: 1;
+}
+
+div.math:hover a.headerlink {
+ visibility: visible;
+}
+
+/* -- printout stylesheet --------------------------------------------------- */
+
+@media print {
+ div.document,
+ div.documentwrapper,
+ div.bodywrapper {
+ margin: 0 !important;
+ width: 100%;
+ }
+
+ div.sphinxsidebar,
+ div.related,
+ div.footer,
+ #top-link {
+ display: none;
+ }
+}
\ No newline at end of file
diff --git a/docs/sphinx/build/html/_static/custom.css b/docs/sphinx/build/html/_static/custom.css
new file mode 100644
index 0000000..2a924f1
--- /dev/null
+++ b/docs/sphinx/build/html/_static/custom.css
@@ -0,0 +1 @@
+/* This file intentionally left blank. */
diff --git a/docs/sphinx/build/html/_static/doctools.js b/docs/sphinx/build/html/_static/doctools.js
new file mode 100644
index 0000000..d06a71d
--- /dev/null
+++ b/docs/sphinx/build/html/_static/doctools.js
@@ -0,0 +1,156 @@
+/*
+ * doctools.js
+ * ~~~~~~~~~~~
+ *
+ * Base JavaScript utilities for all Sphinx HTML documentation.
+ *
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+"use strict";
+
+const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([
+ "TEXTAREA",
+ "INPUT",
+ "SELECT",
+ "BUTTON",
+]);
+
+const _ready = (callback) => {
+ if (document.readyState !== "loading") {
+ callback();
+ } else {
+ document.addEventListener("DOMContentLoaded", callback);
+ }
+};
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+const Documentation = {
+ init: () => {
+ Documentation.initDomainIndexTable();
+ Documentation.initOnKeyListeners();
+ },
+
+ /**
+ * i18n support
+ */
+ TRANSLATIONS: {},
+ PLURAL_EXPR: (n) => (n === 1 ? 0 : 1),
+ LOCALE: "unknown",
+
+ // gettext and ngettext don't access this so that the functions
+ // can safely bound to a different name (_ = Documentation.gettext)
+ gettext: (string) => {
+ const translated = Documentation.TRANSLATIONS[string];
+ switch (typeof translated) {
+ case "undefined":
+ return string; // no translation
+ case "string":
+ return translated; // translation exists
+ default:
+ return translated[0]; // (singular, plural) translation tuple exists
+ }
+ },
+
+ ngettext: (singular, plural, n) => {
+ const translated = Documentation.TRANSLATIONS[singular];
+ if (typeof translated !== "undefined")
+ return translated[Documentation.PLURAL_EXPR(n)];
+ return n === 1 ? singular : plural;
+ },
+
+ addTranslations: (catalog) => {
+ Object.assign(Documentation.TRANSLATIONS, catalog.messages);
+ Documentation.PLURAL_EXPR = new Function(
+ "n",
+ `return (${catalog.plural_expr})`
+ );
+ Documentation.LOCALE = catalog.locale;
+ },
+
+ /**
+ * helper function to focus on search bar
+ */
+ focusSearchBar: () => {
+ document.querySelectorAll("input[name=q]")[0]?.focus();
+ },
+
+ /**
+ * Initialise the domain index toggle buttons
+ */
+ initDomainIndexTable: () => {
+ const toggler = (el) => {
+ const idNumber = el.id.substr(7);
+ const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`);
+ if (el.src.substr(-9) === "minus.png") {
+ el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`;
+ toggledRows.forEach((el) => (el.style.display = "none"));
+ } else {
+ el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`;
+ toggledRows.forEach((el) => (el.style.display = ""));
+ }
+ };
+
+ const togglerElements = document.querySelectorAll("img.toggler");
+ togglerElements.forEach((el) =>
+ el.addEventListener("click", (event) => toggler(event.currentTarget))
+ );
+ togglerElements.forEach((el) => (el.style.display = ""));
+ if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);
+ },
+
+ initOnKeyListeners: () => {
+ // only install a listener if it is really needed
+ if (
+ !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
+ !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
+ )
+ return;
+
+ document.addEventListener("keydown", (event) => {
+ // bail for input elements
+ if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
+ // bail with special keys
+ if (event.altKey || event.ctrlKey || event.metaKey) return;
+
+ if (!event.shiftKey) {
+ switch (event.key) {
+ case "ArrowLeft":
+ if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
+
+ const prevLink = document.querySelector('link[rel="prev"]');
+ if (prevLink && prevLink.href) {
+ window.location.href = prevLink.href;
+ event.preventDefault();
+ }
+ break;
+ case "ArrowRight":
+ if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
+
+ const nextLink = document.querySelector('link[rel="next"]');
+ if (nextLink && nextLink.href) {
+ window.location.href = nextLink.href;
+ event.preventDefault();
+ }
+ break;
+ }
+ }
+
+ // some keyboard layouts may need Shift to get /
+ switch (event.key) {
+ case "/":
+ if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
+ Documentation.focusSearchBar();
+ event.preventDefault();
+ }
+ });
+ },
+};
+
+// quick alias for translations
+const _ = Documentation.gettext;
+
+_ready(Documentation.init);
diff --git a/docs/sphinx/build/html/_static/documentation_options.js b/docs/sphinx/build/html/_static/documentation_options.js
new file mode 100644
index 0000000..b57ae3b
--- /dev/null
+++ b/docs/sphinx/build/html/_static/documentation_options.js
@@ -0,0 +1,14 @@
+var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
+ VERSION: '',
+ LANGUAGE: 'en',
+ COLLAPSE_INDEX: false,
+ BUILDER: 'html',
+ FILE_SUFFIX: '.html',
+ LINK_SUFFIX: '.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt',
+ NAVIGATION_WITH_KEYS: false,
+ SHOW_SEARCH_SUMMARY: true,
+ ENABLE_SEARCH_SHORTCUTS: true,
+};
\ No newline at end of file
diff --git a/docs/sphinx/build/html/_static/file.png b/docs/sphinx/build/html/_static/file.png
new file mode 100644
index 0000000..a858a41
Binary files /dev/null and b/docs/sphinx/build/html/_static/file.png differ
diff --git a/docs/sphinx/build/html/_static/language_data.js b/docs/sphinx/build/html/_static/language_data.js
new file mode 100644
index 0000000..250f566
--- /dev/null
+++ b/docs/sphinx/build/html/_static/language_data.js
@@ -0,0 +1,199 @@
+/*
+ * language_data.js
+ * ~~~~~~~~~~~~~~~~
+ *
+ * This script contains the language-specific data used by searchtools.js,
+ * namely the list of stopwords, stemmer, scorer and splitter.
+ *
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
+
+
+/* Non-minified version is copied as a separate JS file, is available */
+
+/**
+ * Porter Stemmer
+ */
+var Stemmer = function() {
+
+ var step2list = {
+ ational: 'ate',
+ tional: 'tion',
+ enci: 'ence',
+ anci: 'ance',
+ izer: 'ize',
+ bli: 'ble',
+ alli: 'al',
+ entli: 'ent',
+ eli: 'e',
+ ousli: 'ous',
+ ization: 'ize',
+ ation: 'ate',
+ ator: 'ate',
+ alism: 'al',
+ iveness: 'ive',
+ fulness: 'ful',
+ ousness: 'ous',
+ aliti: 'al',
+ iviti: 'ive',
+ biliti: 'ble',
+ logi: 'log'
+ };
+
+ var step3list = {
+ icate: 'ic',
+ ative: '',
+ alize: 'al',
+ iciti: 'ic',
+ ical: 'ic',
+ ful: '',
+ ness: ''
+ };
+
+ var c = "[^aeiou]"; // consonant
+ var v = "[aeiouy]"; // vowel
+ var C = c + "[^aeiouy]*"; // consonant sequence
+ var V = v + "[aeiou]*"; // vowel sequence
+
+ var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
+ var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
+ var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
+ var s_v = "^(" + C + ")?" + v; // vowel in stem
+
+ this.stemWord = function (w) {
+ var stem;
+ var suffix;
+ var firstch;
+ var origword = w;
+
+ if (w.length < 3)
+ return w;
+
+ var re;
+ var re2;
+ var re3;
+ var re4;
+
+ firstch = w.substr(0,1);
+ if (firstch == "y")
+ w = firstch.toUpperCase() + w.substr(1);
+
+ // Step 1a
+ re = /^(.+?)(ss|i)es$/;
+ re2 = /^(.+?)([^s])s$/;
+
+ if (re.test(w))
+ w = w.replace(re,"$1$2");
+ else if (re2.test(w))
+ w = w.replace(re2,"$1$2");
+
+ // Step 1b
+ re = /^(.+?)eed$/;
+ re2 = /^(.+?)(ed|ing)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ re = new RegExp(mgr0);
+ if (re.test(fp[1])) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+ }
+ else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1];
+ re2 = new RegExp(s_v);
+ if (re2.test(stem)) {
+ w = stem;
+ re2 = /(at|bl|iz)$/;
+ re3 = new RegExp("([^aeiouylsz])\\1$");
+ re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+ if (re2.test(w))
+ w = w + "e";
+ else if (re3.test(w)) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+ else if (re4.test(w))
+ w = w + "e";
+ }
+ }
+
+ // Step 1c
+ re = /^(.+?)y$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(s_v);
+ if (re.test(stem))
+ w = stem + "i";
+ }
+
+ // Step 2
+ re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = new RegExp(mgr0);
+ if (re.test(stem))
+ w = stem + step2list[suffix];
+ }
+
+ // Step 3
+ re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = new RegExp(mgr0);
+ if (re.test(stem))
+ w = stem + step3list[suffix];
+ }
+
+ // Step 4
+ re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
+ re2 = /^(.+?)(s|t)(ion)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(mgr1);
+ if (re.test(stem))
+ w = stem;
+ }
+ else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1] + fp[2];
+ re2 = new RegExp(mgr1);
+ if (re2.test(stem))
+ w = stem;
+ }
+
+ // Step 5
+ re = /^(.+?)e$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(mgr1);
+ re2 = new RegExp(meq1);
+ re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+ if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
+ w = stem;
+ }
+ re = /ll$/;
+ re2 = new RegExp(mgr1);
+ if (re.test(w) && re2.test(w)) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+
+ // and turn initial Y back to y
+ if (firstch == "y")
+ w = firstch.toLowerCase() + w.substr(1);
+ return w;
+ }
+}
+
diff --git a/docs/sphinx/build/html/_static/minus.png b/docs/sphinx/build/html/_static/minus.png
new file mode 100644
index 0000000..d96755f
Binary files /dev/null and b/docs/sphinx/build/html/_static/minus.png differ
diff --git a/docs/sphinx/build/html/_static/plus.png b/docs/sphinx/build/html/_static/plus.png
new file mode 100644
index 0000000..7107cec
Binary files /dev/null and b/docs/sphinx/build/html/_static/plus.png differ
diff --git a/docs/sphinx/build/html/_static/pygments.css b/docs/sphinx/build/html/_static/pygments.css
new file mode 100644
index 0000000..57c7df3
--- /dev/null
+++ b/docs/sphinx/build/html/_static/pygments.css
@@ -0,0 +1,84 @@
+pre { line-height: 125%; }
+td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+.highlight .hll { background-color: #ffffcc }
+.highlight { background: #f8f8f8; }
+.highlight .c { color: #8f5902; font-style: italic } /* Comment */
+.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */
+.highlight .g { color: #000000 } /* Generic */
+.highlight .k { color: #004461; font-weight: bold } /* Keyword */
+.highlight .l { color: #000000 } /* Literal */
+.highlight .n { color: #000000 } /* Name */
+.highlight .o { color: #582800 } /* Operator */
+.highlight .x { color: #000000 } /* Other */
+.highlight .p { color: #000000; font-weight: bold } /* Punctuation */
+.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */
+.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #8f5902 } /* Comment.Preproc */
+.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */
+.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */
+.highlight .gd { color: #a40000 } /* Generic.Deleted */
+.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */
+.highlight .ges { color: #000000 } /* Generic.EmphStrong */
+.highlight .gr { color: #ef2929 } /* Generic.Error */
+.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
+.highlight .gi { color: #00A000 } /* Generic.Inserted */
+.highlight .go { color: #888888 } /* Generic.Output */
+.highlight .gp { color: #745334 } /* Generic.Prompt */
+.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */
+.highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */
+.highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */
+.highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */
+.highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */
+.highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */
+.highlight .ld { color: #000000 } /* Literal.Date */
+.highlight .m { color: #990000 } /* Literal.Number */
+.highlight .s { color: #4e9a06 } /* Literal.String */
+.highlight .na { color: #c4a000 } /* Name.Attribute */
+.highlight .nb { color: #004461 } /* Name.Builtin */
+.highlight .nc { color: #000000 } /* Name.Class */
+.highlight .no { color: #000000 } /* Name.Constant */
+.highlight .nd { color: #888888 } /* Name.Decorator */
+.highlight .ni { color: #ce5c00 } /* Name.Entity */
+.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #000000 } /* Name.Function */
+.highlight .nl { color: #f57900 } /* Name.Label */
+.highlight .nn { color: #000000 } /* Name.Namespace */
+.highlight .nx { color: #000000 } /* Name.Other */
+.highlight .py { color: #000000 } /* Name.Property */
+.highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */
+.highlight .nv { color: #000000 } /* Name.Variable */
+.highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */
+.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */
+.highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */
+.highlight .mb { color: #990000 } /* Literal.Number.Bin */
+.highlight .mf { color: #990000 } /* Literal.Number.Float */
+.highlight .mh { color: #990000 } /* Literal.Number.Hex */
+.highlight .mi { color: #990000 } /* Literal.Number.Integer */
+.highlight .mo { color: #990000 } /* Literal.Number.Oct */
+.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */
+.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */
+.highlight .sc { color: #4e9a06 } /* Literal.String.Char */
+.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */
+.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */
+.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */
+.highlight .se { color: #4e9a06 } /* Literal.String.Escape */
+.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */
+.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */
+.highlight .sx { color: #4e9a06 } /* Literal.String.Other */
+.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */
+.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */
+.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */
+.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */
+.highlight .fm { color: #000000 } /* Name.Function.Magic */
+.highlight .vc { color: #000000 } /* Name.Variable.Class */
+.highlight .vg { color: #000000 } /* Name.Variable.Global */
+.highlight .vi { color: #000000 } /* Name.Variable.Instance */
+.highlight .vm { color: #000000 } /* Name.Variable.Magic */
+.highlight .il { color: #990000 } /* Literal.Number.Integer.Long */
\ No newline at end of file
diff --git a/docs/sphinx/build/html/_static/searchtools.js b/docs/sphinx/build/html/_static/searchtools.js
new file mode 100644
index 0000000..97d56a7
--- /dev/null
+++ b/docs/sphinx/build/html/_static/searchtools.js
@@ -0,0 +1,566 @@
+/*
+ * searchtools.js
+ * ~~~~~~~~~~~~~~~~
+ *
+ * Sphinx JavaScript utilities for the full-text search.
+ *
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+"use strict";
+
+/**
+ * Simple result scoring code.
+ */
+if (typeof Scorer === "undefined") {
+ var Scorer = {
+ // Implement the following function to further tweak the score for each result
+ // The function takes a result array [docname, title, anchor, descr, score, filename]
+ // and returns the new score.
+ /*
+ score: result => {
+ const [docname, title, anchor, descr, score, filename] = result
+ return score
+ },
+ */
+
+ // query matches the full name of an object
+ objNameMatch: 11,
+ // or matches in the last dotted part of the object name
+ objPartialMatch: 6,
+ // Additive scores depending on the priority of the object
+ objPrio: {
+ 0: 15, // used to be importantResults
+ 1: 5, // used to be objectResults
+ 2: -5, // used to be unimportantResults
+ },
+ // Used when the priority is not in the mapping.
+ objPrioDefault: 0,
+
+ // query found in title
+ title: 15,
+ partialTitle: 7,
+ // query found in terms
+ term: 5,
+ partialTerm: 2,
+ };
+}
+
+const _removeChildren = (element) => {
+ while (element && element.lastChild) element.removeChild(element.lastChild);
+};
+
+/**
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
+ */
+const _escapeRegExp = (string) =>
+ string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
+
+const _displayItem = (item, searchTerms) => {
+ const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
+ const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT;
+ const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
+ const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
+ const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
+
+ const [docName, title, anchor, descr, score, _filename] = item;
+
+ let listItem = document.createElement("li");
+ let requestUrl;
+ let linkUrl;
+ if (docBuilder === "dirhtml") {
+ // dirhtml builder
+ let dirname = docName + "/";
+ if (dirname.match(/\/index\/$/))
+ dirname = dirname.substring(0, dirname.length - 6);
+ else if (dirname === "index/") dirname = "";
+ requestUrl = docUrlRoot + dirname;
+ linkUrl = requestUrl;
+ } else {
+ // normal html builders
+ requestUrl = docUrlRoot + docName + docFileSuffix;
+ linkUrl = docName + docLinkSuffix;
+ }
+ let linkEl = listItem.appendChild(document.createElement("a"));
+ linkEl.href = linkUrl + anchor;
+ linkEl.dataset.score = score;
+ linkEl.innerHTML = title;
+ if (descr)
+ listItem.appendChild(document.createElement("span")).innerHTML =
+ " (" + descr + ")";
+ else if (showSearchSummary)
+ fetch(requestUrl)
+ .then((responseData) => responseData.text())
+ .then((data) => {
+ if (data)
+ listItem.appendChild(
+ Search.makeSearchSummary(data, searchTerms)
+ );
+ });
+ Search.output.appendChild(listItem);
+};
+const _finishSearch = (resultCount) => {
+ Search.stopPulse();
+ Search.title.innerText = _("Search Results");
+ if (!resultCount)
+ Search.status.innerText = Documentation.gettext(
+ "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
+ );
+ else
+ Search.status.innerText = _(
+ `Search finished, found ${resultCount} page(s) matching the search query.`
+ );
+};
+const _displayNextItem = (
+ results,
+ resultCount,
+ searchTerms
+) => {
+ // results left, load the summary and display it
+ // this is intended to be dynamic (don't sub resultsCount)
+ if (results.length) {
+ _displayItem(results.pop(), searchTerms);
+ setTimeout(
+ () => _displayNextItem(results, resultCount, searchTerms),
+ 5
+ );
+ }
+ // search finished, update title and status message
+ else _finishSearch(resultCount);
+};
+
+/**
+ * Default splitQuery function. Can be overridden in ``sphinx.search`` with a
+ * custom function per language.
+ *
+ * The regular expression works by splitting the string on consecutive characters
+ * that are not Unicode letters, numbers, underscores, or emoji characters.
+ * This is the same as ``\W+`` in Python, preserving the surrogate pair area.
+ */
+if (typeof splitQuery === "undefined") {
+ var splitQuery = (query) => query
+ .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu)
+ .filter(term => term) // remove remaining empty strings
+}
+
+/**
+ * Search Module
+ */
+const Search = {
+ _index: null,
+ _queued_query: null,
+ _pulse_status: -1,
+
+ htmlToText: (htmlString) => {
+ const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
+ htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() });
+ const docContent = htmlElement.querySelector('[role="main"]');
+ if (docContent !== undefined) return docContent.textContent;
+ console.warn(
+ "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template."
+ );
+ return "";
+ },
+
+ init: () => {
+ const query = new URLSearchParams(window.location.search).get("q");
+ document
+ .querySelectorAll('input[name="q"]')
+ .forEach((el) => (el.value = query));
+ if (query) Search.performSearch(query);
+ },
+
+ loadIndex: (url) =>
+ (document.body.appendChild(document.createElement("script")).src = url),
+
+ setIndex: (index) => {
+ Search._index = index;
+ if (Search._queued_query !== null) {
+ const query = Search._queued_query;
+ Search._queued_query = null;
+ Search.query(query);
+ }
+ },
+
+ hasIndex: () => Search._index !== null,
+
+ deferQuery: (query) => (Search._queued_query = query),
+
+ stopPulse: () => (Search._pulse_status = -1),
+
+ startPulse: () => {
+ if (Search._pulse_status >= 0) return;
+
+ const pulse = () => {
+ Search._pulse_status = (Search._pulse_status + 1) % 4;
+ Search.dots.innerText = ".".repeat(Search._pulse_status);
+ if (Search._pulse_status >= 0) window.setTimeout(pulse, 500);
+ };
+ pulse();
+ },
+
+ /**
+ * perform a search for something (or wait until index is loaded)
+ */
+ performSearch: (query) => {
+ // create the required interface elements
+ const searchText = document.createElement("h2");
+ searchText.textContent = _("Searching");
+ const searchSummary = document.createElement("p");
+ searchSummary.classList.add("search-summary");
+ searchSummary.innerText = "";
+ const searchList = document.createElement("ul");
+ searchList.classList.add("search");
+
+ const out = document.getElementById("search-results");
+ Search.title = out.appendChild(searchText);
+ Search.dots = Search.title.appendChild(document.createElement("span"));
+ Search.status = out.appendChild(searchSummary);
+ Search.output = out.appendChild(searchList);
+
+ const searchProgress = document.getElementById("search-progress");
+ // Some themes don't use the search progress node
+ if (searchProgress) {
+ searchProgress.innerText = _("Preparing search...");
+ }
+ Search.startPulse();
+
+ // index already loaded, the browser was quick!
+ if (Search.hasIndex()) Search.query(query);
+ else Search.deferQuery(query);
+ },
+
+ /**
+ * execute search (requires search index to be loaded)
+ */
+ query: (query) => {
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const titles = Search._index.titles;
+ const allTitles = Search._index.alltitles;
+ const indexEntries = Search._index.indexentries;
+
+ // stem the search terms and add them to the correct list
+ const stemmer = new Stemmer();
+ const searchTerms = new Set();
+ const excludedTerms = new Set();
+ const highlightTerms = new Set();
+ const objectTerms = new Set(splitQuery(query.toLowerCase().trim()));
+ splitQuery(query.trim()).forEach((queryTerm) => {
+ const queryTermLower = queryTerm.toLowerCase();
+
+ // maybe skip this "word"
+ // stopwords array is from language_data.js
+ if (
+ stopwords.indexOf(queryTermLower) !== -1 ||
+ queryTerm.match(/^\d+$/)
+ )
+ return;
+
+ // stem the word
+ let word = stemmer.stemWord(queryTermLower);
+ // select the correct list
+ if (word[0] === "-") excludedTerms.add(word.substr(1));
+ else {
+ searchTerms.add(word);
+ highlightTerms.add(queryTermLower);
+ }
+ });
+
+ if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js
+ localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" "))
+ }
+
+ // console.debug("SEARCH: searching for:");
+ // console.info("required: ", [...searchTerms]);
+ // console.info("excluded: ", [...excludedTerms]);
+
+ // array of [docname, title, anchor, descr, score, filename]
+ let results = [];
+ _removeChildren(document.getElementById("search-progress"));
+
+ const queryLower = query.toLowerCase();
+ for (const [title, foundTitles] of Object.entries(allTitles)) {
+ if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) {
+ for (const [file, id] of foundTitles) {
+ let score = Math.round(100 * queryLower.length / title.length)
+ results.push([
+ docNames[file],
+ titles[file] !== title ? `${titles[file]} > ${title}` : title,
+ id !== null ? "#" + id : "",
+ null,
+ score,
+ filenames[file],
+ ]);
+ }
+ }
+ }
+
+ // search for explicit entries in index directives
+ for (const [entry, foundEntries] of Object.entries(indexEntries)) {
+ if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
+ for (const [file, id] of foundEntries) {
+ let score = Math.round(100 * queryLower.length / entry.length)
+ results.push([
+ docNames[file],
+ titles[file],
+ id ? "#" + id : "",
+ null,
+ score,
+ filenames[file],
+ ]);
+ }
+ }
+ }
+
+ // lookup as object
+ objectTerms.forEach((term) =>
+ results.push(...Search.performObjectSearch(term, objectTerms))
+ );
+
+ // lookup as search terms in fulltext
+ results.push(...Search.performTermsSearch(searchTerms, excludedTerms));
+
+ // let the scorer override scores with a custom scoring function
+ if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item)));
+
+ // now sort the results by score (in opposite order of appearance, since the
+ // display function below uses pop() to retrieve items) and then
+ // alphabetically
+ results.sort((a, b) => {
+ const leftScore = a[4];
+ const rightScore = b[4];
+ if (leftScore === rightScore) {
+ // same score: sort alphabetically
+ const leftTitle = a[1].toLowerCase();
+ const rightTitle = b[1].toLowerCase();
+ if (leftTitle === rightTitle) return 0;
+ return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
+ }
+ return leftScore > rightScore ? 1 : -1;
+ });
+
+ // remove duplicate search results
+ // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
+ let seen = new Set();
+ results = results.reverse().reduce((acc, result) => {
+ let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(',');
+ if (!seen.has(resultStr)) {
+ acc.push(result);
+ seen.add(resultStr);
+ }
+ return acc;
+ }, []);
+
+ results = results.reverse();
+
+ // for debugging
+ //Search.lastresults = results.slice(); // a copy
+ // console.info("search results:", Search.lastresults);
+
+ // print the results
+ _displayNextItem(results, results.length, searchTerms);
+ },
+
+ /**
+ * search for object names
+ */
+ performObjectSearch: (object, objectTerms) => {
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const objects = Search._index.objects;
+ const objNames = Search._index.objnames;
+ const titles = Search._index.titles;
+
+ const results = [];
+
+ const objectSearchCallback = (prefix, match) => {
+ const name = match[4]
+ const fullname = (prefix ? prefix + "." : "") + name;
+ const fullnameLower = fullname.toLowerCase();
+ if (fullnameLower.indexOf(object) < 0) return;
+
+ let score = 0;
+ const parts = fullnameLower.split(".");
+
+ // check for different match types: exact matches of full name or
+ // "last name" (i.e. last dotted part)
+ if (fullnameLower === object || parts.slice(-1)[0] === object)
+ score += Scorer.objNameMatch;
+ else if (parts.slice(-1)[0].indexOf(object) > -1)
+ score += Scorer.objPartialMatch; // matches in last name
+
+ const objName = objNames[match[1]][2];
+ const title = titles[match[0]];
+
+ // If more than one term searched for, we require other words to be
+ // found in the name/title/description
+ const otherTerms = new Set(objectTerms);
+ otherTerms.delete(object);
+ if (otherTerms.size > 0) {
+ const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase();
+ if (
+ [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0)
+ )
+ return;
+ }
+
+ let anchor = match[3];
+ if (anchor === "") anchor = fullname;
+ else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname;
+
+ const descr = objName + _(", in ") + title;
+
+ // add custom score for some objects according to scorer
+ if (Scorer.objPrio.hasOwnProperty(match[2]))
+ score += Scorer.objPrio[match[2]];
+ else score += Scorer.objPrioDefault;
+
+ results.push([
+ docNames[match[0]],
+ fullname,
+ "#" + anchor,
+ descr,
+ score,
+ filenames[match[0]],
+ ]);
+ };
+ Object.keys(objects).forEach((prefix) =>
+ objects[prefix].forEach((array) =>
+ objectSearchCallback(prefix, array)
+ )
+ );
+ return results;
+ },
+
+ /**
+ * search for full-text terms in the index
+ */
+ performTermsSearch: (searchTerms, excludedTerms) => {
+ // prepare search
+ const terms = Search._index.terms;
+ const titleTerms = Search._index.titleterms;
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const titles = Search._index.titles;
+
+ const scoreMap = new Map();
+ const fileMap = new Map();
+
+ // perform the search on the required terms
+ searchTerms.forEach((word) => {
+ const files = [];
+ const arr = [
+ { files: terms[word], score: Scorer.term },
+ { files: titleTerms[word], score: Scorer.title },
+ ];
+ // add support for partial matches
+ if (word.length > 2) {
+ const escapedWord = _escapeRegExp(word);
+ Object.keys(terms).forEach((term) => {
+ if (term.match(escapedWord) && !terms[word])
+ arr.push({ files: terms[term], score: Scorer.partialTerm });
+ });
+ Object.keys(titleTerms).forEach((term) => {
+ if (term.match(escapedWord) && !titleTerms[word])
+ arr.push({ files: titleTerms[word], score: Scorer.partialTitle });
+ });
+ }
+
+ // no match but word was a required one
+ if (arr.every((record) => record.files === undefined)) return;
+
+ // found search word in contents
+ arr.forEach((record) => {
+ if (record.files === undefined) return;
+
+ let recordFiles = record.files;
+ if (recordFiles.length === undefined) recordFiles = [recordFiles];
+ files.push(...recordFiles);
+
+ // set score for the word in each file
+ recordFiles.forEach((file) => {
+ if (!scoreMap.has(file)) scoreMap.set(file, {});
+ scoreMap.get(file)[word] = record.score;
+ });
+ });
+
+ // create the mapping
+ files.forEach((file) => {
+ if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1)
+ fileMap.get(file).push(word);
+ else fileMap.set(file, [word]);
+ });
+ });
+
+ // now check if the files don't contain excluded terms
+ const results = [];
+ for (const [file, wordList] of fileMap) {
+ // check if all requirements are matched
+
+ // as search terms with length < 3 are discarded
+ const filteredTermCount = [...searchTerms].filter(
+ (term) => term.length > 2
+ ).length;
+ if (
+ wordList.length !== searchTerms.size &&
+ wordList.length !== filteredTermCount
+ )
+ continue;
+
+ // ensure that none of the excluded terms is in the search result
+ if (
+ [...excludedTerms].some(
+ (term) =>
+ terms[term] === file ||
+ titleTerms[term] === file ||
+ (terms[term] || []).includes(file) ||
+ (titleTerms[term] || []).includes(file)
+ )
+ )
+ break;
+
+ // select one (max) score for the file.
+ const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w]));
+ // add result to the result list
+ results.push([
+ docNames[file],
+ titles[file],
+ "",
+ null,
+ score,
+ filenames[file],
+ ]);
+ }
+ return results;
+ },
+
+ /**
+ * helper function to return a node containing the
+ * search summary for a given text. keywords is a list
+ * of stemmed words.
+ */
+ makeSearchSummary: (htmlText, keywords) => {
+ const text = Search.htmlToText(htmlText);
+ if (text === "") return null;
+
+ const textLower = text.toLowerCase();
+ const actualStartPosition = [...keywords]
+ .map((k) => textLower.indexOf(k.toLowerCase()))
+ .filter((i) => i > -1)
+ .slice(-1)[0];
+ const startWithContext = Math.max(actualStartPosition - 120, 0);
+
+ const top = startWithContext === 0 ? "" : "...";
+ const tail = startWithContext + 240 < text.length ? "..." : "";
+
+ let summary = document.createElement("p");
+ summary.classList.add("context");
+ summary.textContent = top + text.substr(startWithContext, 240).trim() + tail;
+
+ return summary;
+ },
+};
+
+_ready(Search.init);
diff --git a/docs/sphinx/build/html/_static/sphinx_highlight.js b/docs/sphinx/build/html/_static/sphinx_highlight.js
new file mode 100644
index 0000000..aae669d
--- /dev/null
+++ b/docs/sphinx/build/html/_static/sphinx_highlight.js
@@ -0,0 +1,144 @@
+/* Highlighting utilities for Sphinx HTML documentation. */
+"use strict";
+
+const SPHINX_HIGHLIGHT_ENABLED = true
+
+/**
+ * highlight a given string on a node by wrapping it in
+ * span elements with the given class name.
+ */
+const _highlight = (node, addItems, text, className) => {
+ if (node.nodeType === Node.TEXT_NODE) {
+ const val = node.nodeValue;
+ const parent = node.parentNode;
+ const pos = val.toLowerCase().indexOf(text);
+ if (
+ pos >= 0 &&
+ !parent.classList.contains(className) &&
+ !parent.classList.contains("nohighlight")
+ ) {
+ let span;
+
+ const closestNode = parent.closest("body, svg, foreignObject");
+ const isInSVG = closestNode && closestNode.matches("svg");
+ if (isInSVG) {
+ span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+ } else {
+ span = document.createElement("span");
+ span.classList.add(className);
+ }
+
+ span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+ parent.insertBefore(
+ span,
+ parent.insertBefore(
+ document.createTextNode(val.substr(pos + text.length)),
+ node.nextSibling
+ )
+ );
+ node.nodeValue = val.substr(0, pos);
+
+ if (isInSVG) {
+ const rect = document.createElementNS(
+ "http://www.w3.org/2000/svg",
+ "rect"
+ );
+ const bbox = parent.getBBox();
+ rect.x.baseVal.value = bbox.x;
+ rect.y.baseVal.value = bbox.y;
+ rect.width.baseVal.value = bbox.width;
+ rect.height.baseVal.value = bbox.height;
+ rect.setAttribute("class", className);
+ addItems.push({ parent: parent, target: rect });
+ }
+ }
+ } else if (node.matches && !node.matches("button, select, textarea")) {
+ node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
+ }
+};
+const _highlightText = (thisNode, text, className) => {
+ let addItems = [];
+ _highlight(thisNode, addItems, text, className);
+ addItems.forEach((obj) =>
+ obj.parent.insertAdjacentElement("beforebegin", obj.target)
+ );
+};
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+const SphinxHighlight = {
+
+ /**
+ * highlight the search words provided in localstorage in the text
+ */
+ highlightSearchWords: () => {
+ if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight
+
+ // get and clear terms from localstorage
+ const url = new URL(window.location);
+ const highlight =
+ localStorage.getItem("sphinx_highlight_terms")
+ || url.searchParams.get("highlight")
+ || "";
+ localStorage.removeItem("sphinx_highlight_terms")
+ url.searchParams.delete("highlight");
+ window.history.replaceState({}, "", url);
+
+ // get individual terms from highlight string
+ const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
+ if (terms.length === 0) return; // nothing to do
+
+ // There should never be more than one element matching "div.body"
+ const divBody = document.querySelectorAll("div.body");
+ const body = divBody.length ? divBody[0] : document.querySelector("body");
+ window.setTimeout(() => {
+ terms.forEach((term) => _highlightText(body, term, "highlighted"));
+ }, 10);
+
+ const searchBox = document.getElementById("searchbox");
+ if (searchBox === null) return;
+ searchBox.appendChild(
+ document
+ .createRange()
+ .createContextualFragment(
+ '' +
+ '' +
+ _("Hide Search Matches") +
+ "
"
+ )
+ );
+ },
+
+ /**
+ * helper function to hide the search marks again
+ */
+ hideSearchWords: () => {
+ document
+ .querySelectorAll("#searchbox .highlight-link")
+ .forEach((el) => el.remove());
+ document
+ .querySelectorAll("span.highlighted")
+ .forEach((el) => el.classList.remove("highlighted"));
+ localStorage.removeItem("sphinx_highlight_terms")
+ },
+
+ initEscapeListener: () => {
+ // only install a listener if it is really needed
+ if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return;
+
+ document.addEventListener("keydown", (event) => {
+ // bail for input elements
+ if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
+ // bail with special keys
+ if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return;
+ if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) {
+ SphinxHighlight.hideSearchWords();
+ event.preventDefault();
+ }
+ });
+ },
+};
+
+_ready(SphinxHighlight.highlightSearchWords);
+_ready(SphinxHighlight.initEscapeListener);
diff --git a/docs/sphinx/build/html/commandModules.html b/docs/sphinx/build/html/commandModules.html
new file mode 100644
index 0000000..017fd41
--- /dev/null
+++ b/docs/sphinx/build/html/commandModules.html
@@ -0,0 +1,395 @@
+
+
+
+
+ commandModules package — python_raft documentation
+
+
+
+
+
+
+
+
+commandModules package
+
+
+commandModules.consoleInterface module
+
+
+class commandModules.consoleInterface. consoleInterface
+Bases: object
+
+
+abstract close ( )
+Close the console session.
+
+
+
+
+abstract open ( )
+Abstract method. Define how to open the console session.
+
+
+
+
+abstract read_all ( )
+Abstract method. Define how to read all information displayed in the console.
+Should return the data read.
+
+
+
+
+abstract read_until ( value )
+
+Abstract method. Define how to read all the information displayed in the console, upto the point a defined string appears.
+Should return the data read.
+
+
+Parameters:
+value (str ) – Message to wait for in the console.
+
+
+
+
+
+abstract write ( message )
+Abstract method. Define how to write to the console.
+
+Parameters:
+message (str ) – Message to write into the console.
+
+
+
+
+
+
+
+commandModules.serialClass module
+
+
+commandModules.sshConsole module
+
+
+class commandModules.sshConsole. sshConsole ( address username password key = None known_hosts = None )
+Bases: consoleInterface
+sshConsole is a consoleInterface class to interface with SSH console sessions
+
+Parameters:
+
+address (str ) – IP address of the host to connect to.
username (str ) – Username for logging into the host.
password (str ) – Password for logging into the host.
key (str , optional ) – Filepath of ssh key to use.
known_hosts (str , optional ) – Filepath of known_hosts file to use.
+
+
+
+close ( )
+Close the SSH session
+
+
+
+
+open ( )
+Open the SSH session.
+
+
+
+
+read_all ( )
+Capture all lines that are displayed in the console.
+
+Returns:
+List of strings, with each being a line displayed in the console.
+Return type:
+List
+
+
+
+
+
+read_until ( value )
+Read the console until a message appears.
+
+Parameters:
+value (str ) – The message to wait for in the console.
+Returns:
+List of string, with each being a line displayed in the console up to the value entered.
+Return type:
+List
+
+
+
+
+
+write ( message )
+Write a message into the console.
+
+Parameters:
+message (str ) – String to write into the console.
+
+
+
+
+
+
+
+commandModules.telnetClass module
+
+
+class commandModules.telnetClass. telnet ( log workspacePath host username password port = 23 )
+Bases: consoleInterface
+telnet is a consoleInterface class to interface with telnet console sessions.
+
+Parameters:
+
+log (logModule ) – Log module to be used.
workspacePath (str ) – Path of the tests worksapce to create the sesson.log file.
host (str ) – IP address of the host to open a session with.
username (str ) – Username to login to the session with.
password (str ) – Password to login to the session with.
port (int , optional ) – Listening telnet port on host. Defaults to 23.
+
+
+
+close ( )
+Close the telnet session
+
+
+
+
+connect ( username_prompt = 'login: ' password_prompt = 'Password: ' )
+Open the telnet session
+
+Parameters:
+
+username_prompt (str , optional ) – Expected prompt shown for entering the username.
password_prompt (str , optional ) – Expected prompt shown for entering the password.
+Returns:
+True if session opened successfully.
+Return type:
+bool
+
+
+
+
+
+disconnect ( )
+Close the telnet session
+
+Returns:
+True
+Return type:
+bool
+
+
+
+
+
+open ( )
+Open the telnet session.
+
+
+
+
+read_all ( )
+Read all readily available information displayed in the console.
+
+Returns:
+Information currently displayed in the console.
+Return type:
+str
+
+
+
+
+
+read_eager ( )
+Read all readily available information displayed in the console.
+
+Returns:
+Information currently displayed in the console.
+Return type:
+str
+
+
+
+
+
+read_some ( )
+Read information displayed in the console until EOF hit.
+
+Returns:
+Information currently displayed in the console.
+Return type:
+str
+
+
+
+
+
+read_until ( value )
+Read the console until a message appears.
+
+Parameters:
+value (str ) – The message to wait for in the console.
+Returns:
+Information displayed in the console up to the value entered.
+Return type:
+str
+
+
+
+
+
+read_very_eager ( )
+Read all readily available information displayed in the console, without blocking I/O.
+
+Returns:
+Information currently displayed in the console.
+Return type:
+str
+
+
+
+
+
+write ( message )
+Write a message into the session console.
+
+Parameters:
+message (str ) – Message to write into the console.
+Returns:
+True when the message is successfully written to the console.
+Return type:
+bool
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
core package — python_raft documentation
+
+
+
+
+
+
+
+
+core package
+
+
+
+
+core.commonRemote module
+
+
+core.configParser module
+
+
+core.configParserBase module
+
+
+core.decodeParams module
+
+
+core.deviceManager module
+
+
+
+core.outboundClient module
+
+
+core.powerControl module
+
+
+core.rackController module
+
+
+
+core.testControl module
+
+
+
+core.webpageController module
+
+
+
+
+
+
+
+
+
+
+
+
core.powerModules package — python_raft documentation
+
+
+
+
+
+
+
+
+core.powerModules package
+
+
+core.powerModules.S20control module
+
+
+core.powerModules.SLP module
+
+
+core.powerModules.apc module
+
+
+core.powerModules.apcAos module
+
+
+core.powerModules.hs100 module
+
+
+core.powerModules.kasaControl module
+
+
+core.powerModules.none module
+
+
+core.powerModules.olimex module
+
+
+
+
+
+
+
+
+
+
+
+
Index — python_raft documentation
+
+
+
+
+
+
+
+
+
Index
+
+
+
C
+ |
D
+ |
M
+ |
O
+ |
R
+ |
S
+ |
T
+ |
W
+
+
+
C
+
+
+
D
+
+
+
M
+
+
+
O
+
+
+
R
+
+
+
S
+
+
+
T
+
+
+
W
+
+
+
+
+
+
+
+
+
+
+
Welcome to python_raft’s documentation! — python_raft documentation
+
+
+
+
+
+
+
+
+Welcome to python_raft’s documentation!
+
+
+modules
+
+
+
+
+
+
+
+
+
+
+
framework — python_raft documentation
+ Python Module Index — python_raft documentation
+
+
+
+
+
+
+
+
+
Python Module Index
+
+
+
+
+
+
+
+
+
+
+
+
+
Search — python_raft documentation
+
+
+
+
+
+
+
+
Search
+
+
+
+
+ Please activate JavaScript to enable the search
+ functionality.
+
+
+
+
+
+ Searching for multiple words only shows matches that contain
+ all words.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
