This is a SmartThings Edge driver for creating virtual SmartThings devices that monitor the online/offline status of LAN devices.
Now with Wake-on-LAN control!! (12/14/21)
For the device you want to monitor, you'll need to know if it is a UPnP device (see https://openconnectivity.org/upnp-specs/UPnP-arch-DeviceArchitecture-v2.0-20200417.pdf), or if it at least responds to SSDP discovery requests. If you don't know, you can simply try it and see if it works. Alternatively you can use a UPnP explorer on your local LAN to discover all your monitorable devices. One such explorer is available as a SmartThings Edge driver (Channel: https://api.smartthings.com/invitation-web/accept?id=4f17fc7e-7a44-4826-884d-31117037c08d).
You will configure the monitor to find your device either via IP address or UUID. Note that if you use IP address, ideally it is a static IP address, although this it is not mandatory. The configured IP address is used only to initially find the device. Once the device is found, its UUID is retrieved and saved. If the device later changes IP address for whatever reason, it will be re-discovered based on its UUID. To avoid any IP address issues, you can configure the monitor with the device's UUID if you know it. Some further considerations:
- If your device is simple, without multiple embedded logical devices/services, then all you need to know is the IP address of the device.
- If it is a more complex device with multiple logical devices/services each with their own unique UUID, then you'll need to configure the specific UUID of the sub-device/service you want to monitor.
This feature is not part of the UPnP or SSDP discovery protocol. It is a separate feature supported at the network hardware interface of the device. Just because you can discover and monitor a device, does not mean that WOL will work with that device. And the reverse is also true: just because your device supports WOL, doesn't mean it can be discovered and monitored.
Use this channel invitation link to get the Edge driver installed to your hub: https://api.smartthings.com/invitation-web/accept?id=cc2197b9-2dce-4d88-b6a1-2d198a0dfdef
Sign in to your SmartThings account, register your hub to the channel, and then from the Driver list, click Install for 'LAN Device Monitor'.
When the driver is installed to the hub (could take up to 12 hours), use the mobile app to do an Add device/Scan nearby. A new device will be created in the 'No room assigned' room called LAN Device Monitor.
Go to the device details screen in the mobile app and go to device settings by tapping the 3 vertical dot menu in the upper right corner, and then tap Settings.
Select an icon from the list to represent your LAN device. Note that it can take a few minutes or app closure & reopen before the new icon is displayed. Please also note that some icons will not have animation and color on the device dashboard card. Switch, plug, contact, light, TV usually work the best.
Set either the IP Address or UUID fields for you device. Note that if you configure both these fields with valid values, UUID will be used.
- A valid IP address must be in the form nnn.nnn.nnn.nnn where 'n' is a numeric digit and 'nnn' is less than 255; do not include port number
- A valid UUID must be in the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx where 'x' is a hexidecimal character (0-9, a-f or A-F)
You can configure how often, in seconds, the device is polled to determine if it is online. The minimum interval is 10 seconds, and the default is 20 seconds. The more frequent you poll, the more potential LAN traffic the driver will be generating - how much will depend on the device. Better behaved devices that implement the full and proper SSDP protocol will be more responsive and require less LAN traffic.
If you want to use the Wake-on-LAN feature, you must configure the MAC address of the device you want to control.
If you want to use the Wake-on-LAN feature, you can modify this address, but normally this should be left to the default of 255.255.255.255:7. If an alternate address is configured, the IP address must end in .255, and the port number must be a single digit - typically 7 or 9.
The device card will show your selected icon, and reflect the on/off status of the device
The device details screen contains device information plus actions the user can take.
Starting at the top, the device details screen will show information about the device currently being monitored, including its online/offline status, name & model as reported by the device, UUID, and current IP address (may be different from what you initially configured if not static). Note that these fields will be grayed-out when monitoring is turned off.
Following the device info fields is a switch to turn monitoring on and off. There must be a valid IP address or UUID configured or any attempts to switch on monitoring will result in the switch immediately turning off again.
Monitoring can be suspended for a currently monitored device by turning the switch off at any time. This will result in the info fields getting grayed-out, the device status field set to '-unknown-', and the dashboard state will show 'off'. The switch capability used for automation conditions will also be set to off, so be aware of this when setting up automations.
Monitoring can be turned back on at any time as long as there is a valid IP address or UUID configured.
Note on configuration changes:
- Before any changes to configuration settings take effect (new IP address, UUID or different polling frequency), device monitoring must first be turned off, and then back on.
- Icon changes will happen without turning device monitoring off and on, but may not show right away.
This button is used to send a Wake-on-LAN 'magic packet' to the device MAC address configured in Settings. The device must be configured to enable this feature, and your LAN router must be able to forward broadcast messages for the configured port number.
At the bottom of the device details screen, there is a button to create another virtual device, which you can then configure just as described above. Each additional device created will also have this button, so new devices can be created from any LAN monitoring device.
A standard switch capability is provided that can be used in automation IF conditions to test the on/off status of the device.
Generally, device online/offline status should get initialized within 10 seconds of initially turning on monitoring, but it may take longer for some devices - up to 20-30 seconds.
If a device has implemented the full SSDP specification then response times and subsequent updating of device online/offline status will be quick, particularly when the device goes offline. Well-implemented devices may also report their status more frequently than the polling interval you configure. So for example, even if you define a polling interval of 15 minutes, the device may choose to report more frequently. This may be seen in networking equipment devices (routers, range extenders, etc.), which often have very frequent reporting intervals (e.g. every 30-45 seconds).
The SmartThings Edge platform is still in beta as of November 2021, and as such there are some known bugs. One of these may affect this driver whenever a driver update is made. When the the new driver is installed, the following error may be seen several times in the log output:
Lua: runtime error: [string "cosock"]:296: cosock tried to call socket.select with no sockets and no timeout. this is a bug, please report it
stack traceback:
[C]: in function 'error'
[string "cosock"]:296: in field 'run'
[string "st.driver"]:743: in method 'run'
[string "init.lua"]:596: in main chunk
Typically this resolves itself after multiple retries, but occasionally it never does. A reboot of the hub may be necessary to clear it. If that doesn't work, then the driver will have to be uninstalled and installed again. Unfortunately this also requires deletion of any devices.