FUTEK .NET API Documentation
FUTEK_USB_DLL Assembly / FUTEK_USB_DLL Namespace / USB_DLL Class / Set_Shunt_Value Method
Type: System.IntPtr
The handle associated with the USB device.
Type: System.Int32
The value associated with a simulated load.
The value must be between 0 and 16,777,215.
Type: System.Byte
The channel number associated with the USB device.


In This Topic
    Set_Shunt_Value Method
    In This Topic
    Warning: The use of this function can affect the factory calibration of the USB device.
    Sets the shunt value stored in the EEPROM of the microcontroller.
    Syntax
    'Declaration
     
    
    Public Function Set_Shunt_Value( _
       ByVal DeviceHandle As IntPtr, _
       ByVal ShuntValue As Integer, _
       Optional ByVal ChannelNumber As Byte _
    ) As String
    'Usage
     
    
    Dim instance As USB_DLL
    Dim DeviceHandle As IntPtr
    Dim ShuntValue As Integer
    Dim ChannelNumber As Byte
    Dim value As String
     
    value = instance.Set_Shunt_Value(DeviceHandle, ShuntValue, ChannelNumber)
    public string Set_Shunt_Value( 
       IntPtr DeviceHandle,
       int ShuntValue,
       byte ChannelNumber
    )

    Parameters

    DeviceHandle
    Type: System.IntPtr
    The handle associated with the USB device.
    ShuntValue
    Type: System.Int32
    The value associated with a simulated load.
    The value must be between 0 and 16,777,215.
    ChannelNumber
    Type: System.Byte
    The channel number associated with the USB device.

    Return Value

    Type: System.String
    A value equal to 0; otherwise Error
    Remarks
    The ShuntValue is an analog-to-digital converter (ADC) value representing the simulated load that is applied to the USB device.
    This function should be used when there is zero load applied to the sensor.
    The Set_Load_Switch should be enabled before this function is called and disabled after this function is called.
    Requirements

    Target Platforms: Windows 10, Windows 11

    Target Framework: .NET Framework 4.8 or later

    See Also