global.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Global</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Global</h1>

    
<section>

<header>
    
        <h2></h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        
<dl class="details">

    
</dl>


    </div>

    
        <h3 class="subsection-title">Members</h3>

        
<h4 class="name" id="deviceLibrary"><span class="type-signature">(constant) </span>deviceLibrary<span class="type-signature"></span></h4>


<div class="description">
    This file is part of Domotz Agent.
</div>


<dl class="details">

    
    <dt class="tag-copyright">Copyright:</dt>
    <dd class="tag-copyright"><ul class="dummy"><li>Copyright (C) Domotz Inc</li></ul></dd>
    

    <dt class="tag-license">License:</dt>
    <dd class="tag-license"><ul class="dummy"><li>Domotz Agent is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Domotz Agent is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Domotz Agent.  If not, see <http://www.gnu.org/licenses/>.</li></ul></dd>
    

</dl>


        <h3 class="subsection-title">Type Definitions</h3>

        
<h4 class="name" id="CheerioAPI">CheerioAPI</h4>


<div class="description">
    The Cheerio Library Loaded Document Interface.
Can be used to traverse and manipulate the loaded document.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="https://cheerio.js.org/interfaces/CheerioAPI.html">https://cheerio.js.org/interfaces/CheerioAPI.html</a></li>
        </ul>
    </dd>
    

</dl>


<h4 class="name" id="CheerioOptions">CheerioOptions</h4>


<div class="description">
    The Cheerio Library Accepted Options
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="https://cheerio.js.org/interfaces/CheerioOptions.html">https://cheerio.js.org/interfaces/CheerioOptions.html</a></li>
        </ul>
    </dd>
    

</dl>


<h4 class="name" id="ColumnHeader">ColumnHeader</h4>


<div class="description">
    Custom Driver table Column Header
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>label</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">The table column label. Max 30 Characters</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>unit</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">The Unit of measurement of the column values (eg %). Max 10 characters</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>valueType</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#ValueType">ValueType</a></span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">The value of the column values (used for display purposes)</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h4 class="name" id="ConfigurationBackup">ConfigurationBackup</h4>


<div class="description">
    Custom Driver configuration backup
Validated version is returned by D.createBackup, should be passed to D.success()
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>label</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">The name of the backup, default is "Custom Driver Configuration Backup"</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>running</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">The configuration currently running on the device, must be less than 1mb</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>startup</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">The optional configuration which will be active when the device is restarted, must be less than 1mb</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>ignoredLines</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;string></span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">List of regular expressions
They are used to decide if a line should be considered when comparing configurations for misalignment.
The regex engine directly substitutes the match text with an empty string.
Do not pass flags in the regex, the format is not supported.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h4 class="name" id="DeviceCredentials">DeviceCredentials</h4>


<div class="description">
    Custom Driver device credentials
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>username</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The device username</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>password</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The device password</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h4 class="name" id="DriverTableResult">DriverTableResult</h4>


<div class="description">
    Custom Driver table Result
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>label</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The table Label. Max 50 characters</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>columnHeaders</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;<a href="global.html#ColumnHeader">ColumnHeader</a>></span>


            </td>

            
            <td class="description last">The column headers list</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>rows</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Array.&lt;any>></span>


            </td>

            
            <td class="description last">The table rows</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h4 class="name" id="ErrorResult">ErrorResult</h4>


<div class="description">
    Used when the result of a call towards a device is in an erroneous state
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>message</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The Error Message</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h4 class="name" id="ErrorType">ErrorType</h4>


<div class="description">
    Known Domotz Context Error types
</div>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>TOO_MANY_VARIABLES_ERROR</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Too many variables have been defined in this driver execution</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>MISSING_DEVICE_ERROR</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">No device was found for execution</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>RESOURCE_UNAVAILABLE</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The Resource you are trying to access is not available</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>AUTHENTICATION_ERROR</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Authentication with the device has failed</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>PARSING_ERROR</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Failed to parse the response</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>TIMEOUT_ERROR</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The remote call has resulted in a timeout</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>IMPORT_NOT_ALLOWED</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Import statements are not allowed in the sandbox environment</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>REQUIRE_NOT_ALLOWED</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Require statements are not allowed in the sandbox environment</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>GENERIC_ERROR</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">A Generic/Unknown error has occurred</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>D.errorType.TIMEOUT_ERROR</code></pre>


<h4 class="name" id="HttpCallback">HttpCallback</h4>


<div class="description">
    The Http library callback
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">callback</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>error</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">The HTTP response error</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>response</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">The HTTP response object</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>body</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">The HTTP response body</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h4 class="name" id="HttpOptions">HttpOptions</h4>


<div class="description">
    The Http Library Options
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>url</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">The url suffix of the request target</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>headers</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">The Request HTTP Headers defined as key value pairs. Eg {'Accept': 'text/html'}</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>body</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">The Request HTTP Body</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>port</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    80
                
                </td>
            

            <td class="description last">The port to use for the request. If protocol is set to https the default is 443</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>auth</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">object</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">The authentication to use. Eg 'basic' / {'bearer': 'the token'}</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>username</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">The device username. If not set the custom driver management purpose one is used</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>password</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">The device password. If not set the custom driver management purpose one is used</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>jar</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last">if true, remember cookies for future use</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>useHostname</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    true
                
                </td>
            

            <td class="description last">if false, ip address is used as host.
If true or not set the device host_name is used as host</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>protocol</code></td>
            

            <td class="type">
            
                
<span class="param-type">http</span>
|

<span class="param-type">https</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    http
                
                </td>
            

            <td class="description last">The protocol to use in the request</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h4 class="name" id="snmpCallback">snmpCallback</h4>


<div class="description">
    The SNMP query callback
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">callback</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>output</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object.&lt;string, string></span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">The output object from the snmp query execution as a key-value pair for each oid and it corresponding value</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>error</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#ErrorResult">ErrorResult</a></span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Will be present if the snmp query resulted in an error.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h4 class="name" id="snmpSessionOptions">snmpSessionOptions</h4>


<div class="description">
    The SNMP Session Options
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>port</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    161
                
                </td>
            

            <td class="description last">UDP port to send requests to</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>timeout</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    5000
                
                </td>
            

            <td class="description last">The time the snmp session queries will persist for (in milisenconds).</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>maxRepetitions</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    24
                
                </td>
            

            <td class="description last">How many rows of a table are to be retrieved in a single GetBulk operation. Used in SNMP Walk</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h4 class="name" id="SshAlgorithms">SshAlgorithms</h4>


<div class="description">
    The SSH authentication algorithm parameters
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>kex</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;string></span>


            </td>

            
            <td class="description last">A List of SSH key exchange methods to use</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>cipher</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;string></span>


            </td>

            
            <td class="description last">A List of SSH ciphers to use</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>{
    cipher: [
        'aes128-gcm',
        'aes128-gcm@openssh.com',
        'aes256-gcm',
        'aes256-gcm@openssh.com'
    ],
    kex: [
        'diffie-hellman-group-exchange-sha1',
        'diffie-hellman-group-exchange-sha256',
        'ecdh-sha2-nistp256',
        'ecdh-sha2-nistp384',
        'ecdh-sha2-nistp521'
    ]

}</code></pre>


<h4 class="name" id="SshCallback">SshCallback</h4>


<div class="description">
    The SSH Command Execution Result
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">callback</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>output</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">The stdout from the SSH Command execution</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>error</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#ErrorResult">ErrorResult</a></span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Will be present if the execution resulted in an error</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h4 class="name" id="SshOptions">SshOptions</h4>


<div class="description">
    The SSH Library Options
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>command</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">The ssh command to execute against the device</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>timeout</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">The time to wait for the command execution</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>username</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">The device username. If not set the custom driver management purpose one is used</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>password</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">The device password. If not set the custom driver management purpose one is used</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>keyboard_interactive</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last">Try keyboard-interactive user authentication if primary user authentication method fails</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>port</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    22
                
                </td>
            

            <td class="description last">The SSH port</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>algorithms</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#SshAlgorithms">SshAlgorithms</a></span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">The SSH Kex and Ciphers to use</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h4 class="name" id="TCPCallback">TCPCallback</h4>


<div class="description">
    The TCP library callback
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">callback</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>output</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">The Result from the tcp command execution</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>error</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#ErrorResult">ErrorResult</a></span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Will be present if the execution resulted in an error</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h4 class="name" id="TCPOptions">TCPOptions</h4>


<div class="description">
    The TCP library Options
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>command</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">The tcp command to execute against the device</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>port</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    23
                
                </td>
            

            <td class="description last">The tcp port to connect to</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>timeout</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    500
                
                </td>
            

            <td class="description last">The time the tcp command will execute for at most (in milliseconds)</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>keepAlive</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last">Boolean flag to use if the TCP connection should persist until the timeout value runs out. Disabled by default</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>encoding</code></td>
            

            <td class="type">
            
                
<span class="param-type">str</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    utf8
                
                </td>
            

            <td class="description last">The tcp command response encoding. Default 'utf8'</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h4 class="name" id="TelnetCallback">TelnetCallback</h4>


<div class="description">
    The Telnet library callback
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">callback</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>output</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">The Result from the telnet command execution</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>error</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#ErrorResult">ErrorResult</a></span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Will be present if the execution resulted in an error</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h4 class="name" id="TelnetOptions">TelnetOptions</h4>


<div class="description">
    The Telnet library Options
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>command</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">The telnet command to execute against the device</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>port</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    23
                
                </td>
            

            <td class="description last">The telnet port to connect to</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>timeout</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    500
                
                </td>
            

            <td class="description last">The time the telnet session will persist for (in milisenconds)</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>negotiationMandatory</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last">Set this to true if the telnet session requires authentication</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>shellPrompt</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    /(?:\/ )?#\s/
                
                </td>
            

            <td class="description last">The expected shell prompt regular expression for the telnet session</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>loginPrompt</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    /login[: ]*$/i
                
                </td>
            

            <td class="description last">The expected username prompt regular expression for the telnet session</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>passwordPrompt</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    /Password: /i
                
                </td>
            

            <td class="description last">The expected password prompt regular expression for the telnet session</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h4 class="name" id="ValueType">ValueType</h4>


<div class="description">
    Domotz variable value types
</div>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>STRING</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">String value</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>NUMBER</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Numerical value</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>DATETIME</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Datetime value</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>RATE</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">A numeric value that changes over time in an increasing manner.
Only the rate of change is calculated and stored</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>MONOTONE_RATE</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">A numeric value similar to the RATE type but ignoring values lower
than the previous collected value in the rate of change comparison</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>D.valueType.RATE</code></pre>


<h4 class="name" id="Variable">Variable</h4>


<div class="description">
    Custom Driver variable
Created via D.createVariable
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>uid</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The identifier of the variable. Must be Unique. Max 50 characters
<br> cannot be one of the following reserved words: "table", "column", "history"</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The Name/Label of the variable. Max 100 characters</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The Value of the variable. Max 500 characters</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>unit</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The Unit of measurement of the variable (eg %). Max 10 characters</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>valueType</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#ValueType">ValueType</a></span>


            </td>

            
            <td class="description last">The type of the variable value (used for visualization purposes).</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h4 class="name" id="WinRMCallback">WinRMCallback</h4>


<div class="description">
    The WinRM Command Execution Result
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">callback</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>output</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#WinRMOutput">WinRMOutput</a></span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Output of the execution, present if no error has occurred</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>error</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#ErrorResult">ErrorResult</a></span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Will be present if the execution resulted in an error</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h4 class="name" id="WinRMOptions">WinRMOptions</h4>


<div class="description">
    The WinRM Library Options
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>command</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">The winrm command to execute against the device</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>username</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">The device username. If not set the custom driver management purpose one is used</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>password</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">The device password. If not set the custom driver management purpose one is used</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>port</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    5985
                
                </td>
            

            <td class="description last">The WinRM port</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h4 class="name" id="WinRMOutput">WinRMOutput</h4>


<div class="description">
    The WinRM Command Execution Result output
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>commandId</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">Id of the WinRM command</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>shellId</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">Id of the remote shell that executed the command</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>stdout</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">standard output produced by the command</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>stderr</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">standard error produced by the command (should always be null)</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>exitCode</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">exit code of the command (should always be 0)</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Externals</h3><ul><li><a href="D.external__.html">_</a></li></ul><h3>Namespaces</h3><ul><li><a href="console.html">console</a></li><li><a href="D.html">D</a></li><li><a href="D._unsafe.html">_unsafe</a></li><li><a href="D._unsafe.buffer.html">buffer</a></li><li><a href="D.crypto.html">crypto</a></li><li><a href="D.crypto.Cipher.html">Cipher</a></li><li><a href="D.crypto.Decipher.html">Decipher</a></li><li><a href="D.device.html">device</a></li><li><a href="D.device.http.html">http</a></li><li><a href="D.math.html">math</a></li><li><a href="DomotzConfigurationManagement.html">DomotzConfigurationManagement</a></li><li><a href="DomotzGeneric.html">DomotzGeneric</a></li><li><a href="driverTable.html">driverTable</a></li><li><a href="snmpSession.html">snmpSession</a></li></ul><h3>Global</h3><ul><li><a href="global.html#deviceLibrary">deviceLibrary</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Mon Oct 07 2024 11:42:37 GMT+0300 (Eastern European Summer Time)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>