API Reference

Table of Contents:

• Decorators
  • niveristand.nivs_rt_sequence()
  • NivsParam
    • NivsParam.BY_VALUE
• Client API
  • NI VeriStand Data types
    • BooleanValue
    • BooleanValueArray
    • ChannelReference
    • DoubleValue
    • DoubleValueArray
    • I32Value
    • I32ValueArray
    • I64Value
    • I64ValueArray
    • U32Value
    • U32ValueArray
    • U64Value
    • U64ValueArray
    • VectorChannelReference
    • DataType
  • Real-Time Sequence APIs
    • RealTimeSequence
      • RealTimeSequence.run()
      • RealTimeSequence.save()
    • ErrorAction
      • ErrorAction.AbortSequence
      • ErrorAction.ContinueSequenceExecution
      • ErrorAction.StopSequence
  • Stimulus Profile APIs
    • StimulusProfileState
      • StimulusProfileState.CompletionState
      • StimulusProfileState.completion_state
      • StimulusProfileState.last_error
      • StimulusProfileState.ret_val
      • StimulusProfileState.session
      • StimulusProfileState.wait_for_result()
• Errors
  • VeristandError
  • TranslateError
  • SequenceError
    • SequenceError.inner_error
    • SequenceError.is_fatal
    • SequenceError.should_raise
  • RunError
    • RunError.get_all_errors()
  • RunFailedError
  • RunAbortedError
• Library
  • abstime()
  • arraysize()
  • clearfault()
  • clearlasterror()
  • deltat()
  • deltatus()
  • fault()
  • fix()
  • generate_error()
  • getlasterror()
  • iteration()
  • localhost_wait()
  • multitask()
  • nivs_yield()
  • quotient()
  • recip()
  • rand()
  • rem()
  • seqtime()
  • seqtimeus()
  • stop_task()
  • task()
  • tickcountms()
  • tickcountus()
  • wait()
  • wait_until_next_ms_multiple()
  • wait_until_next_us_multiple()
  • wait_until_settled()
  • ramp()
  • sine_wave()
  • square_wave()
  • triangle_wave()
  • uniform_white_noise_wave()
• Real-Time Sequence Tools
  • run_py_as_rtseq()
  • save_py_as_rtseq()
• Legacy API
  • Workspace
    • Workspace.GetAliasList()
    • Workspace.GetChannelVectorValues()
    • Workspace.GetEngineState()
    • Workspace.GetMultipleChannelValues()
    • Workspace.GetMultipleSystemNodesData()
    • Workspace.GetSingleChannelValue()
    • Workspace.GetSystemNodeChannelList()
    • Workspace.GetSystemNodeChildren()
    • Workspace.LockWorkspaceFile()
    • Workspace.RunWorkspaceFile()
    • Workspace.SetChannelVectorValues()
    • Workspace.SetMultipleChannelValues()
    • Workspace.SetSingleChannelValue()
    • Workspace.StopWorkspaceFile()
    • Workspace.UnlockWorkspaceFile()
  • Workspace2
    • Workspace2.ConnectToSystem()
    • Workspace2.DisconnectFromSystem()
    • Workspace2.GetSystemState()
    • Workspace2.LockConnection()
    • Workspace2.ReconnectToSystem()
    • Workspace2.SetChannelValues()
    • Workspace2.StartDataLogging()
    • Workspace2.StopDataLogging()
    • Workspace2.UnlockConnection()
  • PyAlarmPriority
  • PyAlarmState
  • PyAlarmMode
  • Alarm
    • Alarm.GetAlarmData()
    • Alarm.SetAlarmData()
    • Alarm.SetAlarmData2()
    • Alarm.SetAlarmMode()
    • Alarm.SetEnabledState()
  • AlarmManager
    • AlarmManager.GetAlarmList()
    • AlarmManager.GetAlarmsStatus()
    • AlarmManager.GetMultipleAlarmsData()
  • AlarmManager2
    • AlarmManager2.GetAlarmList()
    • AlarmManager2.GetAlarmsStatus()
    • AlarmManager2.GetMultipleAlarmsData()
  • PyModelState
  • PyModelCommand
  • Model
    • Model.GetModelExecutionState()
    • Model.RestoreModelState()
    • Model.SaveModelState()
    • Model.SetModelExecutionState()
  • ModelManager
    • ModelManager.GetModelList()
    • ModelManager.GetMultipleParameterValues()
    • ModelManager.GetParameterVectorValues()
    • ModelManager.GetParametersList()
    • ModelManager.GetSingleParameterValue()
    • ModelManager.SetMultipleParameterValues()
    • ModelManager.SetParameterVectorValues()
    • ModelManager.SetSingleParameterValue()
  • ModelManager2
    • ModelManager2.GetModelList()
    • ModelManager2.GetMultipleParameterValues()
    • ModelManager2.GetParameterVectorValues()
    • ModelManager2.GetParametersList()
    • ModelManager2.GetSingleParameterValue()
    • ModelManager2.SetMultipleParameterValues()
    • ModelManager2.SetParameterValues()
    • ModelManager2.SetParameterVectorValues()
    • ModelManager2.SetSingleParameterValue()
    • ModelManager2.UpdateParametersFromFile()
  • ChannelFaultManager
    • ChannelFaultManager.ClearAllFaults()
    • ChannelFaultManager.ClearFault()
    • ChannelFaultManager.GetFaultList()
    • ChannelFaultManager.GetFaultValue()
    • ChannelFaultManager.SetFaultValue()
  • PyStimulusState
  • PyStimulusResult
  • Stimulus
    • Stimulus.GetStimulusProfileFile()
    • Stimulus.GetStimulusProfileManagerState()
    • Stimulus.GetStimulusProfileResult()
    • Stimulus.ReserveStimulusProfileManager()
    • Stimulus.RunStimulusProfile()
    • Stimulus.StopStimulusProfile()
    • Stimulus.UnreserveStimulusProfileManager()
  • Stimulus2
    • Stimulus2.RunStimulusProfile()
  • MacroRecorder
  • PyMacroPlayerState
  • PyMacroPlayerMode
  • MacroPlayer
    • MacroPlayer.LoadMacro()
    • MacroPlayer.PlayMacro()
    • MacroPlayer.PlayState()