HSv

' SmartDimmer.vb , v. 2.0
'   This script requires 4 parameters, separated by ':'
'    - Device Reference ID
'    - Start level (%)  0 - 100 [integer]
'                       (use -1 for current devicevalue)
'                       (use -2 to add end level to current value)
'    - End level (%)    0 - 100 [integer]
'    - Time (sec)       1 - 3600 [integer]
'                               HSv, Feb. 2019

Public Module GlobalVars
  Public Shared infoLog  As Boolean = True      ' Log whats happening...?
  Public Shared warnLog  As Boolean = True      ' Log warnings...? (you really should!)
  Public Shared debugLog As Boolean = False     ' Log a bit more...?
End Module

Public Sub Main(ByVal _params As Object)
  Dim showLoc     As Boolean = False    ' Add location to the devicename when
                                        ' writing to the log
  Dim Waittime    As Integer = 250      ' Default minimum loop time in millisec
                                        ' - i.e. 250 means 4 times per sec.
  Dim MaxTimespan As Integer = 3600     ' Max timespan is one hour - I guess this can be changed if you need to...
  Dim LogID       As String  = "SmartDimmer"


' ---------------------------------------------------
'  There should not be anything to change below here
' ---------------------------------------------------

  ' I guess reading the input parameters would eb a good idea...
  Dim deviceRef  As Integer = Integer.parse(_params.ToString.split(":")(0))
  Dim Startvalue As Integer = Integer.parse(_params.ToString.split(":")(1))
  Dim Stopvalue  As Integer = Integer.parse(_params.ToString.split(":")(2))
  Dim Timespan   As Integer = Integer.parse(_params.ToString.split(":")(3))

  ' Does the device exist at all...?
  If ( Not hs.DeviceExistsRef(deviceRef)) Then
    Logging(LogID, "warn", "Device " & deviceRef & " does not exist - Exiting!")
    Exit Sub
  End If

  ' If startvalue is set to -1, then use the current devicevalue as start.
  ' Do this also if start and endvalue are the same
  ' ( changing from 10 to 10 doesn't make sense, so therefore I assume you meant change from <current> to <new> )
  If ( (Startvalue = -1) OrElse (Startvalue = Stopvalue) ) Then
    Startvalue = hs.DeviceValue(deviceRef)
  ElseIf (Startvalue < -1) Then
    Startvalue = hs.DeviceValue(deviceRef)
    Stopvalue  = Startvalue + Stopvalue
  End If

  ' Read the name of the device, as it's more human readable in the log
  Dim deviceName As String
  If showLoc Then
    deviceName = hs.devicename(deviceRef)
  Else
    deviceName = hs.GetDeviceByRef(deviceRef).name(hs)
  End If

  ' Check if inputs are within limits
  If Startvalue < 0           Then Startvalue = 0
  If Startvalue > 100         Then Startvalue = 100
  If Stopvalue  < 0           Then Stopvalue  = 0
  If Stopvalue  > 100         Then Stopvalue  = 100
  If Timespan   < 1           Then Timespan   = 1
  If Timespan   > MaxTimespan Then Timespan   = MaxTimespan

  ' let the log know what we are up to...
  Logging(LogID, "info", "Device " & deviceName & " - from " & Startvalue & "% to " & Stopvalue & "% over " & Timespan & "sec")

  If Stopvalue <> Startvalue Then
    ' Calculate change per <Waittime> millisec.
    Dim DeltaValue As Integer = (Stopvalue - Startvalue) / (Timespan * (1000/Waittime))

    ' The minimum change is 1 (or -1) - If it is less I need to change it to 1, and calculate a new step-time
    ' I.e - If I want to change from 0 to 10 in 20 sec - I need to change by 1 every 2 sec.
    If Math.Abs(DeltaValue) < 1 Then
      If Stopvalue < Startvalue Then
        DeltaValue = -1
      Else
        DeltaValue = 1
      End If
      Waittime  = Math.Abs(TimeSpan / (Startvalue - Stopvalue) * 1000)
    End If
    Logging(LogID, "debug", "Device " & deviceName & " - Deltavalue= " & DeltaValue & " , Waittime= " & Waittime)

    ' Need to declare this so that I don't bail at the first iteration
    Dim Previouslevel As Integer = Startvalue

    For Each cc As HomeSeerAPI.CAPIControl In hs.CAPIGetControl(deviceRef)
      For Newlevel As Integer = Startvalue To Stopvalue Step DeltaValue

        ' Check if there is an override - i.e. the device has been changed outside the script
        If ((hs.DeviceValue(deviceRef) = Previouslevel) OrElse (Previouslevel = Startvalue)) Then
          ' Set the correct dim level
          cc.ControlValue = Newlevel
          hs.CAPIControlHandler(cc)
          Logging(LogID, "debug", "Device " & deviceName & " : " & Previouslevel & " -> " & Newlevel)

          ' Wait the required amount of time
          System.Threading.Thread.Sleep(Waittime)
          Previouslevel = Newlevel
        Else
          ' Manual override - You openend the pod bay doors yourself :-/
          ' Write a warning and get the h... outta' here
          Logging(LogID, "warn", "Device " & deviceName & " - Manual override, bailed out at " & Previouslevel & "% -> " & hs.DeviceValue(deviceRef) & "%")
          Exit Sub
        End If
      Next

      ' In case the device end up with an incorrect value (d.t. increments only in integers),
      ' then I set the final value outside the loop.
      If (hs.DeviceValue(deviceRef) <> Stopvalue) Then
        Logging(LogID, "debug", "Device " & deviceName & " : " & Previouslevel & " -> " & Stopvalue & " (Final touch)")
        cc.ControlValue = Stopvalue
        hs.CAPIControlHandler(cc)
      End If

      ' Be nice and let the log know we are done :-)
      Logging(LogID, "info", "Device " & deviceName & " - done!")
      Exit Sub
    Next
  Else
    ' Nothing for me to do here
    ' This means that the device is already at the StopValue.
    Logging(LogID, "warn", "Device " & deviceName & " nothing to do!")
  End If

End Sub

' Routine for writing to the log
Sub Logging(ByVal LogID As String, ByVal msgType As String, ByVal msg As String)
  Dim msgComplete As String
  Dim writetolog As Boolean = False

  Select Case msgType
    Case  "info"
      If GlobalVars.infoLog Then
        msgComplete = "Info: " & msg
        writetolog = True
      End If

    Case  "debug"
      If GlobalVars.debugLog Then
        msgComplete = "Debug: " & msg
        writetolog = True
      End If

    Case  "warn"
      If GlobalVars.warnLog Then
        msgComplete = "Warning: " & msg
        writetolog = True
      End If

    Case Else
      msgComplete = "Msgtype '" & msgType & "' undefined"
      writetolog = True
  End Select

  If writetolog Then hs.Writelog (LogID, msgComplete)

End Sub