Table Of Content¶

Purpose¶

The generic plugin is used to handle xPL messages sent by xPL clients that are not part of Domogik. They can be arduino DIY devices, ... The generic plugin contains only the description of the xPL messages to catch and so there is nothing to start/stop and nothing to configure.

You just have to install the plugin, check it is present in the clients list and create some devices.

Please notice that you must see your external xPL clients in the clients list as xPL clients. If you don’t see them, it means that the xPL hub doesn’t see them and so the plugin won’t be able to catch the xPL messages.

To be detected by the xPL hub (and Domogik), a xPL client must implement the heartbeat xPL messages. More informations here : http://xplproject.org.uk/wiki/index.php/XPL_Specification_Document#Heartbeat_Messages Notice that some DIY projects don’t implement the heartbeat messages and so Domogik won’t see them!

If you want to create your own arduino xPL client, you can use this library : https://github.com/olebrun/xPL.Arduino

You can check if a xPL message is received on Domogik side by launching the dmg_dump tool.

Dependencies¶

There is no dependency.

Plugin configuration¶

There is nothing to configure.

Create the domogik devices¶

• Temperature devices
• Humidity devices
• CO2 devices
• Solar exposure (insolation) devices
• Pressure devices
• Total volatile organic compound devices
• RGB devices

Set up your widgets on the user interface¶

You can now place the widgets of your devices features on the user interface.

Overview¶

These devices are able to send the temperature.

Configuration¶

When you create such a device, you will have to set this parameter:

xPL message¶

Here is a sample of a compliant xPL message:

xpl-trig
{
hop=1
source=arduino-temp.myarduino
target=*
}
sensor.basic
{
current=13
type=temp
device=tempsensor1
}

• current : contains the value
• device : contains the device address

Overview¶

These devices are able to send the humidity.

Configuration¶

When you create such a device, you will have to set this parameter:

xPL message¶

Here is a sample of a compliant xPL message:

xpl-trig
{
hop=1
source=arduino-humidity.myarduino
target=*
}
sensor.basic
{
current=75
type=temp
device=humiditysensor1
}

• current : contains the value
• device : contains the device address

Overview¶

These devices are able to send the pressure in Pascal.

Configuration¶

When you create such a device, you will have to set this parameter:

xPL message¶

Here is a sample of a compliant xPL message:

xpl-trig
{
hop=1
source=arduino-pressure.myarduino
target=*
}
sensor.basic
{
current=34
type=pressure
device=pressuresensor1
}

• current : contains the value
• device : contains the device address

Overview¶

These devices are able to send the carbon dioxide informations.

Configuration¶

When you create such a device, you will have to set this parameter:

xPL message¶

Here is a sample of a compliant xPL message:

xpl-trig
{
hop=1
source=arduino-co2.myarduino
target=*
}
sensor.basic
{
current=456
type=co2
device=co2sensor1
}

• current : contains the value
• device : contains the device address

Overview¶

These devices are able to send the solar exposure (insolation).

Configuration¶

When you create such a device, you will have to set this parameter:

xPL message¶

Here is a sample of a compliant xPL message:

xpl-trig
{
hop=1
source=arduino-insolation.myarduino
target=*
}
sensor.basic
{
current=123
type=insolation
device=insolationsensor1
}

• current : contains the value
• device : contains the device address

Overview¶

These devices are able to send the total volatile organic compound.

Configuration¶

When you create such a device, you will have to set this parameter:

xPL message¶

Here is a sample of a compliant xPL message:

xpl-trig
{
hop=1
source=arduino-tvoc.myarduino
target=*
}
sensor.basic
{
current=752
type=tvoc
device=tvocsensor1
}

• current : contains the value
• device : contains the device address

Overview¶

These devices are able to control RGB devices.

Configuration¶

When you create such a device, you will have to set this parameter:

xPL message¶

xpl-trig
{
hop=1
source=arduino-rgb.myarduino
target=*
}
arduino.rgb
{
command=setcolor
color=ff0000
device=rgb
}

xpl-cmnd
{
hop=1
source=arduino-rgb.myarduino
target=*
}
arduino.rgb
{
command=setcolor
color=ff0000
device=rgb
}

Manual tests¶

cd tests
python co2.py
python humidity.py
python insolation.py
python pressure.py
python rgb.py
python temperature.py
python tvoc.py

1.1¶

• New sensor and command : RGB devices
• New sensor : humidity
• New sensor : pressure
• New sensor : co2
• New sensor : solar exposure
• New sensor : total volatile organic compound
• Experimental sensor and command : OSD

1.0¶

• Plugin creation
• Add sensor : temperature