Shelly-Motion.groovy

/*
 *  Shelly Motion Device Handler
 *
 *  Copyright © 2020 Allterco Robotics US
 *
 *  Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 *  in compliance with the License. You may obtain a copy of the License at:
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software distributed under the License is distributed
 *  on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License
 *  for the specific language governing permissions and limitations under the License.
 *
 * Hubitat is the Trademark and intellectual Property of Hubitat Inc.
 * Shelly is the Trademark and Intellectual Property of Allterco Robotics Ltd
 *
 *-------------------------------------------------------------------------------------------------------------------
 *
 * NOTES: In the Shelly MQTT Settings make sure - Clean Session is checked and Retain is UNchecked
 *        These settings are found via the web settings for the device
 * IMPORTANT NOTE!! Shelly Motion IS NOT SUITABLE as a security device
 *        Please read this comment why --> https://www.facebook.com/groups/shellyforhubitat/permalink/3827955923960766/?comment_id=3827983480624677
 *
 *  Changes:
 *  1.1.1 - Show device IP in data section
 *  1.1.0 - Updated for new FW where parsing had been changed
 *  1.0.0 - Initial release
 *
 */

import groovy.json.JsonSlurper 
import java.util.GregorianCalendar

def setVersion(){
	state.Version = "1.1.1"
	state.InternalName = "ShellyMotion"
}

metadata {
  definition (name: "Shelly Motion", namespace: "sgrayban", 
      author: "Scott Grayban", 
      importURL: "https://raw.githubusercontent.com/ShellyUSA/Hubitat-Drivers/master/Shelly-Motion.groovy")
    {
        capability "Sensor"
        capability "Initialize"
        capability "MotionSensor"
        capability "Battery"
        capability "TamperAlert"
        capability "IlluminanceMeasurement"
        capability "ShockSensor"
        
        //attribute "switch","ENUM",["on","off"]
        attribute "tamper", "string"
        attribute "motion", "string"
        attribute "DriverStatus", "string"
        
        command "resetToInactive"
    }

  preferences {
      input name: "MQTTBroker", type: "text", title: "MQTT Broker Address:", 
          required: true, displayDuringSetup: true
      input name: "username", type: "text", title: "MQTT Username:", 
          description: "(blank if none)", required: false, displayDuringSetup: true
      input name: "password", type: "password", title: "MQTT Password:", 
          description: "(blank if none)", required: false, displayDuringSetup: true
      input name: "topicSub", type: "text", title: "Topic to Subscribe:", 
          description: "Example Topic (shellymotionsensor-60A423). Please don't use a #", 
          required: true, displayDuringSetup: true
      input name: "QOS", type: "text", title: "QOS Value:", required: false, 
        defaultValue: "1", displayDuringSetup: true
      input("logEnable", "bool", title: "Enable logging", required: true, defaultValue: true)
 }
}


def installed() {
    log.info "installed..."
}

// Parse incoming device messages to generate events
def parse(String description) {
  msg = interfaces.mqtt.parseMessage(description)
  topic = msg.get('topic')
  payload = msg.get('payload')
  if (logEnable) log.info "${payload}"
  def parser = new JsonSlurper()
  if (topic == "shellies/${settings?.topicSub}/info") {
      def pr_vals = parser.parseText(payload)
      if (pr_vals.sensor.motion == true) sendEvent(name: "motion", value: "active", displayed: true)
      if (pr_vals.sensor.motion == false) sendEvent(name: "motion", value: "inactive", displayed: true)
      if (pr_vals.sensor.vibration == true) sendEvent(name: "tamper", value: "detected", displayed: true)
      if (pr_vals.sensor.vibration == false) sendEvent(name: "tamper", value: "clear", displayed: true)
      if (pr_vals.sensor.vibration == true) sendEvent(name: "shock", value: "detected", displayed: true)
      if (pr_vals.sensor.vibration == false) sendEvent(name: "shock", value: "clear", displayed: true)
      
      sendEvent(name: "lux", value: pr_vals.lux.value, displayed: true)
      sendEvent(name: "illuminance", value: pr_vals.lux.illumination, displayed: true)
      sendEvent(name: "battery", value: pr_vals.bat.value, displayed: true)
      updateDataValue("ShellyIP", pr_vals.wifi_sta.ip)
  }
}

def resetToInactive(){
  sendEvent(name: "motion", value: "inactive", displayed: true)
}

def updated() {
  if (logEnable) log.info "Updated..."
    initialize()
    unschedule()
    updateDataValue("model", "SHMOS-01")
    //updateDataValue("ShellyHostname", state.ShellyHostname)
    //updateDataValue("ShellyIP", obs1.wifi_sta.ip)
    //updateDataValue("ShellySSID", state.ssid)
    updateDataValue("manufacturer", "Allterco Robotics")
    //updateDataValue("MAC", state.mac)
    setVersion()
    version()
}

def uninstalled() {
  if (logEnable) log.info "Disconnecting from mqtt"
  interfaces.mqtt.disconnect()
}

def initialize() {
    if (logEnable) runIn(900,logsOff) // clears debugging after 900 secs 
    if (logEnable) log.info "Initalize..."
	try {
    def mqttInt = interfaces.mqtt
    //open connection
    mqttbroker = "tcp://" + settings?.MQTTBroker + ":1883"
    mqttInt.connect(mqttbroker, "hubitat_${device}", settings?.username,settings?.password)
    //give it a chance to start
    pauseExecution(1000)
    log.info "Connection established"
    def topic = "shellies/" + settings?.topicSub + "/info/#"
    mqttInt.subscribe(topic)
        if (logEnable) log.debug "Subscribed to: ${topic}"
  } catch(e) {
    if (logEnable) log.debug "Initialize error: ${e.message}"
  }
}


def mqttClientStatus(String status) {
  if (status.startsWith("Error")) {
    def restart = false
    if (! interfaces.mqtt.isConnected()) {
      log.warn "mqtt isConnected false"
      restart = true
    }  else if (status.contains("lost")) {
      log.warn "mqtt Connection lost detected"
      restart = true
    } else {
      log.warn "mqtt error: ${status}"
    }
    if (restart) {
      def i = 0
      while (i < 60) {
        // wait for a minute for things to settle out, server to restart, etc...
        pauseExecution(1000*60)
        initialize()
        if (interfaces.mqtt.isConnected()) {
          log.warn "mqtt reconnect success!"
          break
        }
        i = i + 1
      }
    }
  } else {
    if (logEnable) log.warn "mqtt OK: ${status}"
  }
}

def logsOff(){
    log.warn "Debug logging disabled."
    device.updateSetting("logEnable",[value:"false",type:"bool"])
}

void resetMotionEvent() {
    sendEvent(name:"motion", value: "inactive", isStateChange: false, descriptionText: "Motion Inactive")
}

// Check Version   ***** with great thanks and acknowlegment to Cobra (github CobraVmax) for his original code **************
def version(){
	updatecheck()
	schedule("0 0 18 1/1 * ? *", updatecheck) // Cron schedule
//	schedule("0 0/1 * 1/1 * ? *", updatecheck) // Test Cron schedule
}

def updatecheck(){
    setVersion()
	 def paramsUD = [uri: "https://raw.githubusercontent.com/ShellyUSA/Hubitat-Drivers/master/resources/version.json", contentType: "application/json; charset=utf-8"]
	  try {
			httpGet(paramsUD) { respUD ->
				  if (debugParse) log.warn " Version Checking - Response Data: ${respUD.data}"
				  def copyrightRead = (respUD.data.copyright)
				  state.Copyright = copyrightRead
				  def newVerRaw = (respUD.data.versions.Driver.(state.InternalName))
				  def newVer = (respUD.data.versions.Driver.(state.InternalName).replace(".", ""))
				  def currentVer = state.Version.replace(".", "")
				  state.UpdateInfo = (respUD.data.versions.UpdateInfo.Driver.(state.InternalName))
				  state.author = (respUD.data.author)
				  state.icon = (respUD.data.icon)
				  if(newVer == "NLS"){
					   state.DriverStatus = "<b>** This driver is no longer supported by $state.author  **</b>"       
					   log.warn "** This driver is no longer supported by $state.author **"      
				  }           
				  else if(currentVer < newVer){
					   state.DriverStatus = "<b>New Version Available (Version: $newVerRaw)</b>"
					   log.warn "** There is a newer version of this driver available  (Version: $newVerRaw) **"
					   log.warn "** $state.UpdateInfo **"
				 } 
				 else if(currentVer > newVer){
					   state.DriverStatus = "<b>You are using a Test version of this Driver (Version: $newVerRaw)</b>"
				 }
				 else{ 
					 state.DriverStatus = "Current"
					 log.info "You are using the current version of this driver"
				 }
			} // httpGet
	  } // try

	  catch (e) {
		   log.error "Something went wrong: CHECK THE JSON FILE AND IT'S URI -  $e"
	  }

	  if(state.DriverStatus == "Current"){
		   state.UpdateInfo = "Up to date"
		   sendEvent(name: "DriverUpdate", value: state.UpdateInfo)
		   sendEvent(name: "DriverStatus", value: state.DriverStatus)
	  }
	  else {
		   sendEvent(name: "DriverUpdate", value: state.UpdateInfo)
		   sendEvent(name: "DriverStatus", value: state.DriverStatus)
	  }

	  sendEvent(name: "DriverAuthor", value: "sgrayban")
	  sendEvent(name: "DriverVersion", value: state.Version)
}