DomoSend (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Communication / Domotics functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

DomoSend (Function)

In french: DomoEnvoie

Sends a command to one or more electrical devices compatible with the X10 protocol.

Note For the X10 powerline protocol to work properly, electrical continuity must be maintained between devices. For example, the transmission cannot pass through an insulation transformer.

Example

// Ouverture de la connexion X10
IDConnexion is int
IDConnexion = DomoOpen("COM4", "A")  
// Allumage des lampes reliées aux modules A3 et A4
DomoSend(IDConnexion, "A3 A4", domoOn)
// Equivalent à : DomoAllume(IDConnexion, "A3 A4")
// Modification de l'intensité de ces lampes
DomoSend(IDConnexion, "A3 A4", domoDim, -60)
// Equivalent à : DomoEnvoie(IdConexion, "A3 A4", domoModifie, -60)
...
// Extinction des lampes
DomoSend(IDConnexion, "A3 A4", domoOff)
// Equivalent à : DomoEteint(IDConnexion, "A3 A4")

// Extinction de tous les appareils sur A
DomoSend(IDConnexion, "A", domoAllOff)

Syntax

<Result> = DomoSend(<Connection ID> , <Address> , <Command to send> [, <Command value>])

<Result>: Boolean

True if the command was successfully sent,
False otherwise (transmission error, device did not respond, etc.). If an error occurs, use ErrorInfo with the errMessage constant to get more details on the error.

<Connection ID>: Integer

Identifier of the connection to use. This identifier is defined by DomoOpen.

<Address>: Character string

Address of electrical devices compatible with the relevant X10 protocol.
The format of an address is as follows: <Code maison><Code module>
Where:
<House code> corresponds to a letter found between A and P.
<Module code> corresponds to a number found between 1 and 16.
For example: "A1", "B14".
To specify several addresses, the addresses must be separated by a space character. For example: "A1 A3 B15".

<Command to send>: Integer constant

Command that must be sent to the specified electrical devices:
domoAllOff Switches all the specified electrical appliances off. In this case, <Address> must only contain one or more house codes.
domoBright Increases the intensity of the specified electrical devices by <Command value> percent (brightness of the lamps in most cases).
domoDim Reduces the intensity of the specified electrical devices by <Command value> percent (brightness of the lamps in most cases).
domoModify Modifies the current status of the specified electrical appliances. In this case, <Command Value> corresponds to:
True: Turns on specified electrical appliances.
False: Turns off specified electrical devices.
<Valeur positive>: Increases the current of specified electrical appliances by <Valeur positive> percent
<Valeur négative>: Reduces the current of specified electrical appliances by <Valeur négative> percent
domoOff Switches the specified electrical appliances off.
domoOn Switches the specified electrical appliances on.

<Command value>: Optional boolean or integer

Value of the command sent:
True Switches the specified electrical appliances on.
False Switches the specified electrical appliances off.
<Positive value> Increases the intensity of the specified electrical devices by <Positive value> percent.
<Negative value> Reduces the intensity of the specified electrical devices by <Negative value> percent.

Component: wd300com.dll