View source for Ping Sensor Plugin

= Introduction  =

This Luup-device can ping different IP-based network devices like routers, computers, iPhones, network-printers, even internet sites and so on. [[Image:Ping_sensor.png|thumb|right]]The result of the ping is being reported to Vera. It's intended to be used as sensor in scenes. So you can trigger scenes if a device (or site) becomes available or unavailable.<br>

= How does it work  =

For every ip you want to observe a own Luup device has to be created. After installation you only have to configure the IP or [http://en.wikipedia.org/wiki/FQDN FQDN]&nbsp;in the "Address" field and a delay time in seconds when a ping should occur has to be put in the "Period" field. 

Use the Arm / Bypass buttons to activate/deactivate your sensor

The field "Tripped" and the red/green circle shows you, if your observed network device is reachable or not.

= Installation  =

To install and configure the sensor do the following steps: 

#Download the ZIP file containing the device definitions from [http://forum.micasaverde.com/index.php?action=dlattach;topic=1997.0;attach=229 here] 
#Unzip the file to harddisk. The following files are contained:<br><sub>D_PingSensor.xml</sub><br><sub>I_PingSensor.xml<br>S_PingSensor.xml<br>S_AwarenessSensor.xml<br>I_AwarenessSensor.xml</sub> 
#Goto&nbsp;''Devices''&nbsp;--&gt;&nbsp;''Luup plugins''&nbsp;--&gt;&nbsp;''Luup files'' 
#click the '''(Browse)''' buttons on the right, and enter the 4 filenames references above. 
#Select the checkbox "[x] Restart Luup after upload" and click '''(Go)''' 
#... wait whilst it uploads and restarts the Lua engine ... 
#If successful, you'll see the 5x files listed in the system. 
#Navigate to ''Devices --&gt; Luup plugins'', scroll to the bottom at the Add device form. 
#Type "<sub>D_PingSensor.xml</sub>", and click (Add Device), type in a name of your choice against the device then click '''(Save)''' 
#After that is done, return again Devices --&gt; Luup plugins and click '''(+)''' Insert the IP or domain name of the device you want to observe in the field "Address" 
#Change the value in the field "Period" to change the time in seconds, which Vera waits between two pings. (e.g. you want to ping a host every minute, you would enter the value 60) 
#click (Save) in the field "Tripped" can you see, if your remote device is available ("1") or not ("0") or you have a look at the red/green circle.
#enjoy!&nbsp;:)<br>

= Known issues  =

*Update the UI on state-change (device becomes visible or unvisible to the plugin) -&gt;solved
*Display a red / green circle (similar to motion sensors) to indicate the presence of a device -&gt; solved
*Active / Inactive Buttons (even this should work similar to the motion sensors "Armed" and "Bypass") -&gt; solved
*Show up as a sensor in the scene-events. -&gt; solved
*A custom icon should be displayed instead of the na.gif -&gt; No chance at the moment. The standard motion sensor icon will show up.<br>

*Invoked UPnP functions have no effect. -&gt; solved (completely controlable by UPnP)

= Discussion  =

The Ping Sensor plugin is discussed in this forum thread: 

[http://forum.micasaverde.com/index.php?topic=1997.0 http://forum.micasaverde.com/index.php?topic=1997.0] 

Feel free to ask questions on that thread, as well as make any suggestions &amp; contributions to the future development of the Ping Sensor plugin's functionality.