' ********************************************************************
'
'  $Id: svn_id $
'
'  Implements yFindVirtualSensor(), the high-level API for VirtualSensor functions
'
'  - - - - - - - - - License information: - - - - - - - - -
'
'  Copyright (C) 2011 and beyond by Yoctopuce Sarl, Switzerland.
'
'  Yoctopuce Sarl (hereafter Licensor) grants to you a perpetual
'  non-exclusive license to use, modify, copy and integrate this
'  file into your software for the sole purpose of interfacing
'  with Yoctopuce products.
'
'  You may reproduce and distribute copies of this file in
'  source or object form, as long as the sole purpose of this
'  code is to interface with Yoctopuce products. You must retain
'  this notice in the distributed source file.
'
'  You should refer to Yoctopuce General Terms and Conditions
'  for additional information regarding your rights and
'  obligations.
'
'  THE SOFTWARE AND DOCUMENTATION ARE PROVIDED 'AS IS' WITHOUT
'  WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING
'  WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, FITNESS
'  FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO
'  EVENT SHALL LICENSOR BE LIABLE FOR ANY INCIDENTAL, SPECIAL,
'  INDIRECT OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA,
'  COST OF PROCUREMENT OF SUBSTITUTE GOODS, TECHNOLOGY OR
'  SERVICES, ANY CLAIMS BY THIRD PARTIES (INCLUDING BUT NOT
'  LIMITED TO ANY DEFENSE THEREOF), ANY CLAIMS FOR INDEMNITY OR
'  CONTRIBUTION, OR OTHER SIMILAR COSTS, WHETHER ASSERTED ON THE
'  BASIS OF CONTRACT, TORT (INCLUDING NEGLIGENCE), BREACH OF
'  WARRANTY, OR OTHERWISE.
'
' *********************************************************************


Imports YDEV_DESCR = System.Int32
Imports YFUN_DESCR = System.Int32
Imports System.Runtime.InteropServices
Imports System.Text

Module yocto_virtualsensor

    REM --- (YVirtualSensor return codes)
    REM --- (end of YVirtualSensor return codes)
    REM --- (YVirtualSensor dlldef)
    REM --- (end of YVirtualSensor dlldef)
   REM --- (YVirtualSensor yapiwrapper)
   REM --- (end of YVirtualSensor yapiwrapper)
  REM --- (YVirtualSensor globals)

  Public Const Y_INVALIDVALUE_INVALID As Double = YAPI.INVALID_DOUBLE
  Public Delegate Sub YVirtualSensorValueCallback(ByVal func As YVirtualSensor, ByVal value As String)
  Public Delegate Sub YVirtualSensorTimedReportCallback(ByVal func As YVirtualSensor, ByVal measure As YMeasure)
  REM --- (end of YVirtualSensor globals)

  REM --- (YVirtualSensor class start)

  '''*
  ''' <summary>
  '''   The <c>YVirtualSensor</c> class allows you to use Yoctopuce virtual sensors.
  ''' <para>
  '''   These sensors make it possible to show external data collected by the user
  '''   as a Yoctopuce Sensor. This class inherits from <c>YSensor</c> class the core
  '''   functions to read measurements, to register callback functions, and to access
  '''   the autonomous datalogger. It adds the ability to change the sensor value as
  '''   needed, or to mark current value as invalid.
  ''' </para>
  ''' </summary>
  '''/
  Public Class YVirtualSensor
    Inherits YSensor
    REM --- (end of YVirtualSensor class start)

    REM --- (YVirtualSensor definitions)
    Public Const INVALIDVALUE_INVALID As Double = YAPI.INVALID_DOUBLE
    REM --- (end of YVirtualSensor definitions)

    REM --- (YVirtualSensor attributes declaration)
    Protected _invalidValue As Double
    Protected _valueCallbackVirtualSensor As YVirtualSensorValueCallback
    Protected _timedReportCallbackVirtualSensor As YVirtualSensorTimedReportCallback
    REM --- (end of YVirtualSensor attributes declaration)

    Public Sub New(ByVal func As String)
      MyBase.New(func)
      _classname = "VirtualSensor"
      REM --- (YVirtualSensor attributes initialization)
      _invalidValue = INVALIDVALUE_INVALID
      _valueCallbackVirtualSensor = Nothing
      _timedReportCallbackVirtualSensor = Nothing
      REM --- (end of YVirtualSensor attributes initialization)
    End Sub

    REM --- (YVirtualSensor private methods declaration)

    Protected Overrides Function _parseAttr(ByRef json_val As YJSONObject) As Integer
      If json_val.has("invalidValue") Then
        _invalidValue = Math.Round(json_val.getDouble("invalidValue") / 65.536) / 1000.0
      End If
      Return MyBase._parseAttr(json_val)
    End Function

    REM --- (end of YVirtualSensor private methods declaration)

    REM --- (YVirtualSensor public methods declaration)

    '''*
    ''' <summary>
    '''   Changes the measuring unit for the measured value.
    ''' <para>
    '''   Remember to call the <c>saveToFlash()</c> method of the module if the
    '''   modification must be kept.
    ''' </para>
    ''' <para>
    ''' </para>
    ''' </summary>
    ''' <param name="newval">
    '''   a string corresponding to the measuring unit for the measured value
    ''' </param>
    ''' <para>
    ''' </para>
    ''' <returns>
    '''   <c>YAPI.SUCCESS</c> if the call succeeds.
    ''' </returns>
    ''' <para>
    '''   On failure, throws an exception or returns a negative error code.
    ''' </para>
    '''/
    Public Function set_unit(ByVal newval As String) As Integer
      Dim rest_val As String
      rest_val = newval
      Return _setAttr("unit", rest_val)
    End Function

    '''*
    ''' <summary>
    '''   Changes the current value of the sensor (raw value, before calibration).
    ''' <para>
    ''' </para>
    ''' <para>
    ''' </para>
    ''' </summary>
    ''' <param name="newval">
    '''   a floating point number corresponding to the current value of the sensor (raw value, before calibration)
    ''' </param>
    ''' <para>
    ''' </para>
    ''' <returns>
    '''   <c>YAPI.SUCCESS</c> if the call succeeds.
    ''' </returns>
    ''' <para>
    '''   On failure, throws an exception or returns a negative error code.
    ''' </para>
    '''/
    Public Function set_currentRawValue(ByVal newval As Double) As Integer
      Dim rest_val As String
      rest_val = Ltrim(Str(Math.Round(newval * 65536.0)))
      Return _setAttr("currentRawValue", rest_val)
    End Function

    Public Function set_sensorState(ByVal newval As Integer) As Integer
      Dim rest_val As String
      rest_val = Ltrim(Str(newval))
      Return _setAttr("sensorState", rest_val)
    End Function

    '''*
    ''' <summary>
    '''   Changes the invalid value of the sensor, returned if the sensor is read when in invalid state
    '''   (for instance before having been set).
    ''' <para>
    '''   Remember to call the <c>saveToFlash()</c>
    '''   method of the module if the modification must be kept.
    ''' </para>
    ''' <para>
    ''' </para>
    ''' </summary>
    ''' <param name="newval">
    '''   a floating point number corresponding to the invalid value of the sensor, returned if the sensor is
    '''   read when in invalid state
    '''   (for instance before having been set)
    ''' </param>
    ''' <para>
    ''' </para>
    ''' <returns>
    '''   <c>YAPI.SUCCESS</c> if the call succeeds.
    ''' </returns>
    ''' <para>
    '''   On failure, throws an exception or returns a negative error code.
    ''' </para>
    '''/
    Public Function set_invalidValue(ByVal newval As Double) As Integer
      Dim rest_val As String
      rest_val = Ltrim(Str(Math.Round(newval * 65536.0)))
      Return _setAttr("invalidValue", rest_val)
    End Function
    '''*
    ''' <summary>
    '''   Returns the invalid value of the sensor, returned if the sensor is read when in invalid state
    '''   (for instance before having been set).
    ''' <para>
    ''' </para>
    ''' <para>
    ''' </para>
    ''' </summary>
    ''' <returns>
    '''   a floating point number corresponding to the invalid value of the sensor, returned if the sensor is
    '''   read when in invalid state
    '''   (for instance before having been set)
    ''' </returns>
    ''' <para>
    '''   On failure, throws an exception or returns <c>YVirtualSensor.INVALIDVALUE_INVALID</c>.
    ''' </para>
    '''/
    Public Function get_invalidValue() As Double
      Dim res As Double = 0
      If (Me._cacheExpiration <= YAPI.GetTickCount()) Then
        If (Me.load(YAPI._yapiContext.GetCacheValidity()) <> YAPI.SUCCESS) Then
          Return INVALIDVALUE_INVALID
        End If
      End If
      res = Me._invalidValue
      Return res
    End Function

    '''*
    ''' <summary>
    '''   Retrieves a virtual sensor for a given identifier.
    ''' <para>
    '''   The identifier can be specified using several formats:
    ''' </para>
    ''' <para>
    ''' </para>
    ''' <para>
    '''   - FunctionLogicalName
    ''' </para>
    ''' <para>
    '''   - ModuleSerialNumber.FunctionIdentifier
    ''' </para>
    ''' <para>
    '''   - ModuleSerialNumber.FunctionLogicalName
    ''' </para>
    ''' <para>
    '''   - ModuleLogicalName.FunctionIdentifier
    ''' </para>
    ''' <para>
    '''   - ModuleLogicalName.FunctionLogicalName
    ''' </para>
    ''' <para>
    ''' </para>
    ''' <para>
    '''   This function does not require that the virtual sensor is online at the time
    '''   it is invoked. The returned object is nevertheless valid.
    '''   Use the method <c>YVirtualSensor.isOnline()</c> to test if the virtual sensor is
    '''   indeed online at a given time. In case of ambiguity when looking for
    '''   a virtual sensor by logical name, no error is notified: the first instance
    '''   found is returned. The search is performed first by hardware name,
    '''   then by logical name.
    ''' </para>
    ''' <para>
    '''   If a call to this object's is_online() method returns FALSE although
    '''   you are certain that the matching device is plugged, make sure that you did
    '''   call registerHub() at application initialization time.
    ''' </para>
    ''' <para>
    ''' </para>
    ''' </summary>
    ''' <param name="func">
    '''   a string that uniquely characterizes the virtual sensor, for instance
    '''   <c>MyDevice.virtualSensor1</c>.
    ''' </param>
    ''' <returns>
    '''   a <c>YVirtualSensor</c> object allowing you to drive the virtual sensor.
    ''' </returns>
    '''/
    Public Shared Function FindVirtualSensor(func As String) As YVirtualSensor
      Dim obj As YVirtualSensor
      obj = CType(YFunction._FindFromCache("VirtualSensor", func), YVirtualSensor)
      If ((obj Is Nothing)) Then
        obj = New YVirtualSensor(func)
        YFunction._AddToCache("VirtualSensor", func, obj)
      End If
      Return obj
    End Function

    '''*
    ''' <summary>
    '''   Registers the callback function that is invoked on every change of advertised value.
    ''' <para>
    '''   The callback is then invoked only during the execution of <c>ySleep</c> or <c>yHandleEvents</c>.
    '''   This provides control over the time when the callback is triggered. For good responsiveness,
    '''   remember to call one of these two functions periodically. The callback is called once juste after beeing
    '''   registered, passing the current advertised value  of the function, provided that it is not an empty string.
    '''   To unregister a callback, pass a Nothing pointer as argument.
    ''' </para>
    ''' <para>
    ''' </para>
    ''' </summary>
    ''' <param name="callback">
    '''   the callback function to call, or a Nothing pointer. The callback function should take two
    '''   arguments: the function object of which the value has changed, and the character string describing
    '''   the new advertised value.
    ''' @noreturn
    ''' </param>
    '''/
    Public Overloads Function registerValueCallback(callback As YVirtualSensorValueCallback) As Integer
      Dim val As String
      If (Not (callback Is Nothing)) Then
        YFunction._UpdateValueCallbackList(Me, True)
      Else
        YFunction._UpdateValueCallbackList(Me, False)
      End If
      Me._valueCallbackVirtualSensor = callback
      REM // Immediately invoke value callback with current value
      If (Not (callback Is Nothing) AndAlso Me.isOnline()) Then
        val = Me._advertisedValue
        If (Not (val = "")) Then
          Me._invokeValueCallback(val)
        End If
      End If
      Return 0
    End Function

    Public Overrides Function _invokeValueCallback(value As String) As Integer
      If (Not (Me._valueCallbackVirtualSensor Is Nothing)) Then
        Me._valueCallbackVirtualSensor(Me, value)
      Else
        MyBase._invokeValueCallback(value)
      End If
      Return 0
    End Function

    '''*
    ''' <summary>
    '''   Registers the callback function that is invoked on every periodic timed notification.
    ''' <para>
    '''   The callback is invoked only during the execution of <c>ySleep</c> or <c>yHandleEvents</c>.
    '''   This provides control over the time when the callback is triggered. For good responsiveness, remember to call
    '''   one of these two functions periodically. To unregister a callback, pass a Nothing pointer as argument.
    ''' </para>
    ''' <para>
    ''' </para>
    ''' </summary>
    ''' <param name="callback">
    '''   the callback function to call, or a Nothing pointer. The callback function should take two
    '''   arguments: the function object of which the value has changed, and an <c>YMeasure</c> object describing
    '''   the new advertised value.
    ''' @noreturn
    ''' </param>
    '''/
    Public Overloads Function registerTimedReportCallback(callback As YVirtualSensorTimedReportCallback) As Integer
      Dim sensor As YSensor
      sensor = Me
      If (Not (callback Is Nothing)) Then
        YFunction._UpdateTimedReportCallbackList(sensor, True)
      Else
        YFunction._UpdateTimedReportCallbackList(sensor, False)
      End If
      Me._timedReportCallbackVirtualSensor = callback
      Return 0
    End Function

    Public Overrides Function _invokeTimedReportCallback(value As YMeasure) As Integer
      If (Not (Me._timedReportCallbackVirtualSensor Is Nothing)) Then
        Me._timedReportCallbackVirtualSensor(Me, value)
      Else
        MyBase._invokeTimedReportCallback(value)
      End If
      Return 0
    End Function

    '''*
    ''' <summary>
    '''   Changes the current sensor state to invalid (as if no value would have been ever set).
    ''' <para>
    ''' </para>
    ''' </summary>
    ''' <returns>
    '''   <c>YAPI.SUCCESS</c> if the call succeeds.
    ''' </returns>
    ''' <para>
    '''   On failure, throws an exception or returns a negative error code.
    ''' </para>
    '''/
    Public Overridable Function set_sensorAsInvalid() As Integer
      Return Me.set_sensorState(1)
    End Function


    '''*
    ''' <summary>
    '''   Continues the enumeration of virtual sensors started using <c>yFirstVirtualSensor()</c>.
    ''' <para>
    '''   Caution: You can't make any assumption about the returned virtual sensors order.
    '''   If you want to find a specific a virtual sensor, use <c>VirtualSensor.findVirtualSensor()</c>
    '''   and a hardwareID or a logical name.
    ''' </para>
    ''' </summary>
    ''' <returns>
    '''   a pointer to a <c>YVirtualSensor</c> object, corresponding to
    '''   a virtual sensor currently online, or a <c>Nothing</c> pointer
    '''   if there are no more virtual sensors to enumerate.
    ''' </returns>
    '''/
    Public Function nextVirtualSensor() As YVirtualSensor
      Dim hwid As String = ""
      If (YISERR(_nextFunction(hwid))) Then
        Return Nothing
      End If
      If (hwid = "") Then
        Return Nothing
      End If
      Return YVirtualSensor.FindVirtualSensor(hwid)
    End Function

    '''*
    ''' <summary>
    '''   Starts the enumeration of virtual sensors currently accessible.
    ''' <para>
    '''   Use the method <c>YVirtualSensor.nextVirtualSensor()</c> to iterate on
    '''   next virtual sensors.
    ''' </para>
    ''' </summary>
    ''' <returns>
    '''   a pointer to a <c>YVirtualSensor</c> object, corresponding to
    '''   the first virtual sensor currently online, or a <c>Nothing</c> pointer
    '''   if there are none.
    ''' </returns>
    '''/
    Public Shared Function FirstVirtualSensor() As YVirtualSensor
      Dim v_fundescr(1) As YFUN_DESCR
      Dim dev As YDEV_DESCR
      Dim neededsize, err As Integer
      Dim serial, funcId, funcName, funcVal As String
      Dim errmsg As String = ""
      Dim size As Integer = Marshal.SizeOf(v_fundescr(0))
      Dim p As IntPtr = Marshal.AllocHGlobal(Marshal.SizeOf(v_fundescr(0)))

      err = yapiGetFunctionsByClass("VirtualSensor", 0, p, size, neededsize, errmsg)
      Marshal.Copy(p, v_fundescr, 0, 1)
      Marshal.FreeHGlobal(p)

      If (YISERR(err) Or (neededsize = 0)) Then
        Return Nothing
      End If
      serial = ""
      funcId = ""
      funcName = ""
      funcVal = ""
      errmsg = ""
      If (YISERR(yapiGetFunctionInfo(v_fundescr(0), dev, serial, funcId, funcName, funcVal, errmsg))) Then
        Return Nothing
      End If
      Return YVirtualSensor.FindVirtualSensor(serial + "." + funcId)
    End Function

    REM --- (end of YVirtualSensor public methods declaration)

  End Class

  REM --- (YVirtualSensor functions)

  '''*
  ''' <summary>
  '''   Retrieves a virtual sensor for a given identifier.
  ''' <para>
  '''   The identifier can be specified using several formats:
  ''' </para>
  ''' <para>
  ''' </para>
  ''' <para>
  '''   - FunctionLogicalName
  ''' </para>
  ''' <para>
  '''   - ModuleSerialNumber.FunctionIdentifier
  ''' </para>
  ''' <para>
  '''   - ModuleSerialNumber.FunctionLogicalName
  ''' </para>
  ''' <para>
  '''   - ModuleLogicalName.FunctionIdentifier
  ''' </para>
  ''' <para>
  '''   - ModuleLogicalName.FunctionLogicalName
  ''' </para>
  ''' <para>
  ''' </para>
  ''' <para>
  '''   This function does not require that the virtual sensor is online at the time
  '''   it is invoked. The returned object is nevertheless valid.
  '''   Use the method <c>YVirtualSensor.isOnline()</c> to test if the virtual sensor is
  '''   indeed online at a given time. In case of ambiguity when looking for
  '''   a virtual sensor by logical name, no error is notified: the first instance
  '''   found is returned. The search is performed first by hardware name,
  '''   then by logical name.
  ''' </para>
  ''' <para>
  '''   If a call to this object's is_online() method returns FALSE although
  '''   you are certain that the matching device is plugged, make sure that you did
  '''   call registerHub() at application initialization time.
  ''' </para>
  ''' <para>
  ''' </para>
  ''' </summary>
  ''' <param name="func">
  '''   a string that uniquely characterizes the virtual sensor, for instance
  '''   <c>MyDevice.virtualSensor1</c>.
  ''' </param>
  ''' <returns>
  '''   a <c>YVirtualSensor</c> object allowing you to drive the virtual sensor.
  ''' </returns>
  '''/
  Public Function yFindVirtualSensor(ByVal func As String) As YVirtualSensor
    Return YVirtualSensor.FindVirtualSensor(func)
  End Function

  '''*
  ''' <summary>
  '''   Starts the enumeration of virtual sensors currently accessible.
  ''' <para>
  '''   Use the method <c>YVirtualSensor.nextVirtualSensor()</c> to iterate on
  '''   next virtual sensors.
  ''' </para>
  ''' </summary>
  ''' <returns>
  '''   a pointer to a <c>YVirtualSensor</c> object, corresponding to
  '''   the first virtual sensor currently online, or a <c>Nothing</c> pointer
  '''   if there are none.
  ''' </returns>
  '''/
  Public Function yFirstVirtualSensor() As YVirtualSensor
    Return YVirtualSensor.FirstVirtualSensor()
  End Function


  REM --- (end of YVirtualSensor functions)

End Module
