Global

Type Definitions

ColumnHeader

Description:
  • Custom Driver table Column Header
Properties:
Name Type Attributes Description
label string The table column label. Max 30 Characters
unit string <optional>
 The Unit of measurement of the column values (eg %). Max 10 characters
valueType ValueType <optional>
 The value of the column values (used for display purposes)
Custom Driver table Column Header
Type:
  • Object

ConfigurationBackup

Description:
  • Custom Driver configuration backup Validated version is returned by D.createBackup, should be passed to D.success()
Properties:
Name Type Attributes Description
label string <optional>
 The name of the backup, default is "Custom Driver Configuration Backup"
running string The configuration currently running on the device, must be less than 1mb
startup string <optional>
 The optional configuration which will be active when the device is restarted, must be less than 1mb
ignoredLines Array.<string> <optional>
 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.
Custom Driver configuration backup Validated version is returned by D.createBackup, should be passed to D.success()
Type:
  • Object

DriverTableResult

Description:
  • Custom Driver table Result
Properties:
Name Type Description
label string The table Label. Max 50 characters
columnHeaders Array.<ColumnHeader> The column headers list
rows Array.<Array.<any>> The table rows
Custom Driver table Result
Type:
  • Object

ErrorResult

Description:
  • Used when the result of a call towards a device is in an erroneous state
Properties:
Name Type Description
message string The Error Message
Used when the result of a call towards a device is in an erroneous state
Type:
  • Object

ErrorType

Description:
  • Known Domotz Context Error types
Properties:
Name Type Description
TOO_MANY_VARIABLES_ERROR string Too many variables have been defined in this driver execution
MISSING_DEVICE_ERROR string No device was found for execution
RESOURCE_UNAVAILABLE string The Resource you are trying to access is not available
AUTHENTICATION_ERROR string Authentication with the device has failed
PARSING_ERROR string Failed to parse the response
TIMEOUT_ERROR string The remote call has resulted in a timeout
IMPORT_NOT_ALLOWED string Import statements are not allowed in the sandbox environment
REQUIRE_NOT_ALLOWED string Require statements are not allowed in the sandbox environment
GENERIC_ERROR string A Generic/Unknown error has occurred
Known Domotz Context Error types
Example
D.errorType.TIMEOUT_ERROR

SshAlgorithms

Description:
  • The SSH authentication algorithm parameters
Properties:
Name Type Description
kex Array.<string> A List of SSH key exchange methods to use
cipher Array.<string> A List of SSH ciphers to use
The SSH authentication algorithm parameters
Type:
  • Object
Example
{
    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'
    ]

}

ValueType

Description:
  • Domotz variable value types
Properties:
Name Type Description
STRING string String value
NUMBER string Numerical value
DATETIME string Datetime value
RATE string A numeric value that changes over time in an increasing manner. Only the rate of change is calculated and stored
MONOTONE_RATE string A numeric value similar to the RATE type but ignoring values lower than the previous collected value in the rate of change comparison
Domotz variable value types
Example
D.valueType.RATE

Variable

Description:
  • Custom Driver variable Created via D.createVariable
Properties:
Name Type Description
uid string The identifier of the variable. Must be Unique. Max 50 characters
cannot be one of the following reserved words: "table", "column", "history"
name string The Name/Label of the variable. Max 100 characters
value string The Value of the variable. Max 500 characters
unit string The Unit of measurement of the variable (eg %). Max 10 characters
valueType ValueType The type of the variable value (used for visualization purposes).
Custom Driver variable Created via D.createVariable
Type:
  • Object