PicoSopeReader/dotnet example/Imports.cs

/**************************************************************************
*
* Filename:    Imports.cs
*
* Copyright:   Pico Technology Limited 2007
*
* Author:      MJL
*
* Description:
*   This file contains all the .NET wrapper calls needed to support
*   the console example. It also has the enums and structs required
*   by the (wrapped) function calls.
*
* History:
*     14Dec06	MJL	Created
*
* Revision Info: "file %n date %f revision %v"
*						""
*
***************************************************************************/

using System;
using System.Runtime.InteropServices;
using System.Text;

namespace ps5000example
{
  class Imports
  {
    #region constants
    private const string _DRIVER_FILENAME = "ps5000.dll";

    public const int MaxValue = 32512;
    #endregion

    #region Driver enums

    public enum Channel : int
    {
      ChannelA,
      ChannelB,
      ChannelC,
      ChannelD,
      External,
      Aux,
      None,
    }

    public enum Range : int
    {
      Range_10MV,
      Range_20MV,
      Range_50MV,
      Range_100MV,
      Range_200MV,
      Range_500MV,
      Range_1V,
      Range_2V,
      Range_5V,
      Range_10V,
      Range_20V,
      Range_50V,
    }

    public enum ReportedTimeUnits : int
    {
      FemtoSeconds,
      PicoSeconds,
      NanoSeconds,
      MicroSeconds,
      MilliSeconds,
      Seconds,
    }

    public enum SiggenWaveType : int
    {
      Sine,
      Square,
      Triangle,
      RampUp,
      RampDown,
      SinXOverX,
      Gaussian,
      HalfSine,
      DcVoltage,
      MAX_WAVE_TYPES
    }

    public enum SiggenSweepType : int
    {
      Up,
      Down,
      UpDown,
      DownUp
    }

    public enum SiggenTrigType : int
    {
      Rising,
      Falling,
      GateHigh,
      GateLow
    }

    public enum SiggenTrigSource : int
    {
      None,
      ScopeTrigger,
      AuxIn,
      ExtIn,
      SoftwareTrigger
    }

    public enum SiggenIndexMode : int
    {
      Single,
      Dual,
      Quad,
    }

    public enum EtsMode : int
    {
      Off,
      Fast,
      Slow,
    }

    public enum ThresholdMode : int
    {
      Level,
      Window
    }

    public enum ThresholdDirection : int
    {
      // Values for level threshold mode
      //
      Above,
      Below,
      Rising,
      Falling,
      RisingOrFalling,

      // Values for window threshold mode
      //
      Inside = Above,
      Outside = Below,
      Enter = Rising,
      Exit = Falling,
      EnterOrExit = RisingOrFalling,

      None = Rising,
    }

    public enum DownSamplingMode : int
    {
      None,
      Aggregate
    }

    public enum PulseWidthType : int
    {
      None,
      LessThan,
      GreaterThan,
      InRange,
      OutOfRange
    }

    public enum TriggerState : int
    {
      DontCare,
      True,
      False,
    }

    [StructLayout(LayoutKind.Sequential, Pack = 1)]
    public struct TriggerChannelProperties
    {
      public short ThresholdMajor;
      public short ThresholdMinor;
      public ushort Hysteresis;
      public Channel Channel;
      public ThresholdMode ThresholdMode;


      public TriggerChannelProperties(
        short thresholdMajor,
        short thresholdMinor,
        ushort hysteresis,
        Channel channel,
        ThresholdMode thresholdMode)
      {
        this.ThresholdMajor = thresholdMajor;
        this.ThresholdMinor = thresholdMinor;
        this.Hysteresis = hysteresis;
        this.Channel = channel;
        this.ThresholdMode = thresholdMode;
      }
    }

    [StructLayout(LayoutKind.Sequential, Pack = 1)]
    public struct TriggerConditions
    {
      public TriggerState ChannelA;
      public TriggerState ChannelB;
      public TriggerState ChannelC;
      public TriggerState ChannelD;
      public TriggerState External;
      public TriggerState Aux;
      public TriggerState Pwq;

      public TriggerConditions(
        TriggerState channelA,
        TriggerState channelB,
        TriggerState channelC,
        TriggerState channelD,
        TriggerState external,
        TriggerState aux,
        TriggerState pwq)
      {
        this.ChannelA = channelA;
        this.ChannelB = channelB;
        this.ChannelC = channelC;
        this.ChannelD = channelD;
        this.External = external;
        this.Aux = aux;
        this.Pwq = pwq;
      }
    }

    [StructLayout(LayoutKind.Sequential, Pack = 1)]
    public struct PwqConditions
    {
      public TriggerState ChannelA;
      public TriggerState ChannelB;
      public TriggerState ChannelC;
      public TriggerState ChannelD;
      public TriggerState External;
      public TriggerState Aux;

      public PwqConditions(
        TriggerState channelA,
        TriggerState channelB,
        TriggerState channelC,
        TriggerState channelD,
        TriggerState external,
        TriggerState aux)
      {
        this.ChannelA = channelA;
        this.ChannelB = channelB;
        this.ChannelC = channelC;
        this.ChannelD = channelD;
        this.External = external;
        this.Aux = aux;
      }
    }
    #endregion

    #region Driver Imports
    #region Callback delegates
    public delegate void ps5000BlockReady(short handle, short status, IntPtr pVoid);

    public delegate void ps5000StreamingReady(
                        short handle,
                        int noOfSamples,
                        uint startIndex,
                        short ov,
                        uint triggerAt,
                        short triggered,
                        short autoStop,
                        IntPtr pVoid);

    public delegate void ps5000DataReady(
                        short handle,
                        int noOfSamples,
                        short overflow,
                        uint triggerAt,
                        short triggered,
                        IntPtr pVoid);
    #endregion

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000OpenUnit")]
    public static extern short OpenUnit(out short handle);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000CloseUnit")]
    public static extern short CloseUnit(short handle);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000RunBlock")]
    public static extern short RunBlock(
                        short handle, 
                        int noOfPreTriggerSamples,
                        int noOfPostTriggerSamples, 
                        uint timebase, 
                        short oversample, 
                        out int timeIndisposedMs, 
                        ushort segmentIndex, 
                        ps5000BlockReady lpPs5000BlockReady, 
                        IntPtr pVoid);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000Stop")]
    public static extern short Stop(short handle);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000SetChannel")]
    public static extern short SetChannel(
                        short handle,
                        Channel channel,
                        short enabled,
                        short dc,
                        Range range);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000SetDataBuffers")]
    public static extern short SetDataBuffers(
                        short handle,
                        Channel channel,
                        short[] bufferMax,
                        short[] bufferMin,
                        int bufferLth);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000SetDataBuffer")]
    public static extern short SetDataBuffer(
                        short handle,
                        Channel channel,
                        short[] buffer,
                        long bufferLth);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000SetEts")]
    public static extern short SetEts(
                        short handle,
                        EtsMode mode,
                        short etsCycles,
                        short etsInterleave,
                        out int sampleTimePicoseconds);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000SetTriggerChannelDirections")]
    public static extern short SetTriggerChannelDirections(
                        short handle,
                        ThresholdDirection channelA,
                        ThresholdDirection channelB,
                        ThresholdDirection channelC,
                        ThresholdDirection channelD,
                        ThresholdDirection ext,
                        ThresholdDirection aux);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000GetTimebase")]
    public static extern short GetTimebase(
                       short handle,
                       uint timebase,
                       int noSamples,
                       out int timeIntervalNanoseconds,
                       short oversample,
                       out int maxSamples,
                       ushort segmentIndex);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000GetValues")]
    public static extern short GetValues(
        short handle,
        uint startIndex,
        ref uint noOfSamples,
        uint downSampleRatio,
        DownSamplingMode downSampleDownSamplingMode,
        ushort segmentIndex,
        out short overflow);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000SetPulseWidthQualifier")]
    public static extern short SetPulseWidthQualifier(
      short handle,
      PwqConditions[] conditions,
      short numConditions,
      ThresholdDirection direction,
      uint lower,
      uint upper,
      PulseWidthType type);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000SetTriggerChannelProperties")]
    public static extern short SetTriggerChannelProperties(
      short handle,
      TriggerChannelProperties[] channelProperties,
      short numChannelProperties,
      short auxOutputEnable,
      int autoTriggerMilliseconds);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000SetTriggerChannelConditions")]
    public static extern short SetTriggerChannelConditions(
      short handle,
      TriggerConditions[] conditions,
      short numConditions);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000SetTriggerDelay")]
    public static extern short SetTriggerDelay(short handle, uint delay);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000GetUnitInfo")]
    public static extern short GetUnitInfo(short handle, StringBuilder infoString, short stringLength, out short requiredSize, int info);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000SetSigGenBuiltIn")]
    public static extern short SetSiggenBuiltIn(
      short handle,
      int offsetVoltage,
      uint pkToPk,
      SiggenWaveType siggenWaveType,
      float startFrequency,
      float stopFrequency,
      float increment,
      float dwellTime,
      SiggenSweepType sweepType,
      bool whiteNoise,
      uint shots,
      uint sweeps,
      SiggenTrigType triggerType,
      SiggenTrigSource triggerSource,
      short extInThreshold);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000SetSigGenArbitrary")]
    public static extern short SetSiggenArbitrary(
      short handle,
      int offsetVoltage,
      uint pkToPk,
      uint startDeltaPhase,
      uint stopDeltaPhase,
      uint deltaPhaseIncrement,
      uint dwellCount,
      short[] arbitraryWaveform,
      uint arbitraryWaveformSize,
      SiggenSweepType sweepType,
      bool whiteNoise,
      SiggenIndexMode indexMode,
      uint shots,
      uint sweeps,
      SiggenTrigType triggerType,
      SiggenTrigSource triggerSource,
      short extInThreshold);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000RunStreaming")]
    public static extern short RunStreaming(
      short handle,
      ref uint sampleInterval,
      ReportedTimeUnits sampleIntervalTimeUnits,
      uint maxPreTriggerSamples,
      uint maxPostPreTriggerSamples,
      bool autoStop,
      uint downSamplingRation,
      uint overviewBufferSize);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000GetStreamingLatestValues")]
    public static extern short GetStreamingLatestValues(
      short handle,
      ps5000StreamingReady lpPs5000StreamingReady,
      IntPtr pVoid);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000SetNoOfCaptures")]
    public static extern short SetNoOfRapidCaptures(
      short handle,
      ushort nWaveforms);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000MemorySegments")]
    public static extern short MemorySegments(
      short handle,
      ushort nSegments,
      out int nMaxSamples);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000SetDataBufferBulk")]
    public static extern short SetDataBuffersRapid(
      short handle,
      Channel channel,
      short[] buffer,
      int bufferLth,
      ushort waveform);

    [DllImport(_DRIVER_FILENAME, EntryPoint = "ps5000GetValuesBulk")]
    public static extern short GetValuesRapid(
      short handle,
      ref uint noOfSamples,
      ushort fromSegmentIndex,
      ushort toSegmentIndex,
      short[] overflows);
    #endregion
  }
}