dcpwr

Documentation

Overview

Package dcpwr provides the Defined Values and other structs, methods, etc. that are common among all intstruments meeting the IVI-4.4: IviDCPwr Class Specification.

Files are split based on the class capability groups.

Index

• Variables
• type Base
• type BaseChannel
• type CommType
• type CurrentLimitBehavior
• type MeasurementChannel
• type MeasurementType
• type OutputState
• type RangeType

Variables

var (
	ErrNotImplemented     error = errors.New("not implemented in ivi driver")
	ErrOVPUnsupported     error = errors.New("ovp not supported")
	ErrTriggerNotSoftware error = errors.New("trigger source is not set to software trigger.")
)

Error codes related to the IviDCPwr Class Specification.

Types

type Base

type Base interface {
	ChannelCount() int
}

Base provides the interface required for the IviDCPwrBase capability group.

type BaseChannel

type BaseChannel interface {
	CurrentLimit() (float64, error)
	SetCurrentLimit(limit float64) error
	CurrentLimitBehavior() (CurrentLimitBehavior, error)
	SetCurrentLimitBehavior(behavior CurrentLimitBehavior) error
	OutputEnabled() (bool, error)
	SetOutputEnabled(b bool) error
	DisableOutput() error
	EnableOutput() error
	OVPEnabled() (bool, error)
	SetOVPEnabled(b bool) error
	DisableOVP() error
	EnableOVP() error
	VoltageLevel() (float64, error)
	SetVoltageLevel(level float64) error
	ConfigureCurrentLimit(behavior CurrentLimitBehavior, limit float64) error
	ConfigureOutputRange(rt RangeType, rng float64) error
	ConfigureOVP(b bool, limit float64) error
	QueryCurrentLimitMax(voltage float64) (float64, error)
	QueryVoltageLevelMax(currentLimit float64) (float64, error)
	QueryOutputState(os OutputState) (bool, error)
	ResetOutputProtection() error
}

BaseChannel provides the interface for the channel repeated capability for the IviDCPwrBase capability group.

type CommType

type CommType int

CommType defines the available types of communication for a DC power supply.

const (
	GPIB CommType = iota
	RS232
	USB
	LAN
)

Available communiction interfaces for remote communction of a DC power supply.

type CurrentLimitBehavior

type CurrentLimitBehavior int

CurrentLimitBehavior provides the defined values for the Current Limit Behavior defined in Section 4.2.2 of IVI-4.4: IviDCPwr Class Specification.

const (
	CurrentTrip CurrentLimitBehavior = iota
	CurrentRegulate
)

CurrentTrip and CurrentRegulate are the available Current Limit Behaviors. In CurrentTrip behavior, the power supply disables the output when the output current is equal to or greater than the value of the Current Limit attribute. In CurrentRegulate behavior, the power supply restricts the output voltage such that the output current is not greater than the value of the Current Limit attribute.

type MeasurementChannel

type MeasurementChannel interface {
	MeasureVoltage() (float64, error)
	MeasureCurrent() (float64, error)
}

MeasurementChannel provides the interface for the channel repeated capability for the IviDCPwrMeasurement capability group.

type MeasurementType

type MeasurementType int

MeasurementType provides the defined values for the type of measurement defined in Section 7.2.1 of IVI-4.4: IviDCPwr Class Specification.

const (
	CurrentMeasurement MeasurementType = iota
	VoltageMeasurement
)

Available output states that can be queried. The actual values of the output states are the same as those shown in Section 10 IviDCPwr Function Parameter Value Definitions of IVI-4.4: IviDCPwr Class Specification.

type OutputState

type OutputState int

OutputState provides the defined values for the state of the output defined in Section 4.3.9 of IVI-4.4: IviDCPwr Class Specification.

const (
	ConstantVoltage OutputState = iota
	ConstantCurrent
	OverVoltage
	OverCurrent
	Unregulated
)

Available output states that can be queried. The actual values of the output states are the same as those shown in Section 10 IviDCPwr Function Parameter Value Definitions of IVI-4.4: IviDCPwr Class Specification.

type RangeType

type RangeType int

RangeType provides the defined values for the Output Range Type defined in Section 4.3.3 of IVI-4.4: IviDCPwr Class Specification.

const (
	CurrentRange RangeType = iota
	VoltageRange
)

Available range types. In VoltageRange, the voltage range is set by the Range parameter. In CurrentRange, the current range is set by the Range parameter. The actual values of the range types are the same as those shown in Section 10 IviDCPwr Function Parameter Value Definitions of IVI-4.4: IviDCPwr Class Specification.