industrial_analog_out_bricklet

package
Version: v0.0.0-...-1640943 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 7, 2021 License: CC0-1.0 Imports: 5 Imported by: 0

Documentation

Overview

Generates configurable DC voltage and current, 0V to 10V and 4mA to 20mA‍.

See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/IndustrialAnalogOut_Bricklet_Go.html.

Index

Constants

View Source
const DeviceDisplayName = "Industrial Analog Out Bricklet"
View Source
const DeviceIdentifier = 258

Variables

This section is empty.

Functions

This section is empty.

Types

type CurrentRange

type CurrentRange = uint8
const (
	CurrentRange4To20mA CurrentRange = 0
	CurrentRange0To20mA CurrentRange = 1
	CurrentRange0To24mA CurrentRange = 2
)

type Function

type Function = uint8
const (
	FunctionEnable           Function = 1
	FunctionDisable          Function = 2
	FunctionIsEnabled        Function = 3
	FunctionSetVoltage       Function = 4
	FunctionGetVoltage       Function = 5
	FunctionSetCurrent       Function = 6
	FunctionGetCurrent       Function = 7
	FunctionSetConfiguration Function = 8
	FunctionGetConfiguration Function = 9
	FunctionGetIdentity      Function = 255
)

type IndustrialAnalogOutBricklet

type IndustrialAnalogOutBricklet struct {
	// contains filtered or unexported fields
}

func New

Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.

func (*IndustrialAnalogOutBricklet) Disable

func (device *IndustrialAnalogOutBricklet) Disable() (err error)

Disables the output of voltage and current.

The default is disabled.

func (*IndustrialAnalogOutBricklet) Enable

func (device *IndustrialAnalogOutBricklet) Enable() (err error)

Enables the output of voltage and current.

The default is disabled.

func (*IndustrialAnalogOutBricklet) GetAPIVersion

func (device *IndustrialAnalogOutBricklet) GetAPIVersion() [3]uint8

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

func (*IndustrialAnalogOutBricklet) GetConfiguration

func (device *IndustrialAnalogOutBricklet) GetConfiguration() (voltageRange VoltageRange, currentRange CurrentRange, err error)

Returns the configuration as set by SetConfiguration.

Associated constants:

* VoltageRange0To5V
* VoltageRange0To10V
* CurrentRange4To20mA
* CurrentRange0To20mA
* CurrentRange0To24mA

func (*IndustrialAnalogOutBricklet) GetCurrent

func (device *IndustrialAnalogOutBricklet) GetCurrent() (current uint16, err error)

Returns the current as set by SetCurrent.

func (*IndustrialAnalogOutBricklet) GetIdentity

func (device *IndustrialAnalogOutBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an `Isolator Bricklet <isolator_bricklet>` is always at position 'z'.

The device identifier numbers can be found `here <device_identifier>`. |device_identifier_constant|

func (*IndustrialAnalogOutBricklet) GetResponseExpected

func (device *IndustrialAnalogOutBricklet) GetResponseExpected(functionID Function) (bool, error)

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

See SetResponseExpected for the list of function ID constants available for this function.

func (*IndustrialAnalogOutBricklet) GetVoltage

func (device *IndustrialAnalogOutBricklet) GetVoltage() (voltage uint16, err error)

Returns the voltage as set by SetVoltage.

func (*IndustrialAnalogOutBricklet) IsEnabled

func (device *IndustrialAnalogOutBricklet) IsEnabled() (enabled bool, err error)

Returns *true* if output of voltage and current is enabled, *false* otherwise.

func (*IndustrialAnalogOutBricklet) SetConfiguration

func (device *IndustrialAnalogOutBricklet) SetConfiguration(voltageRange VoltageRange, currentRange CurrentRange) (err error)

Configures the voltage and current range.

Possible voltage ranges are:

* 0V to 5V * 0V to 10V

Possible current ranges are:

* 4mA to 20mA * 0mA to 20mA * 0mA to 24mA

The resolution will always be 12 bit. This means, that the precision is higher with a smaller range.

Associated constants:

* VoltageRange0To5V
* VoltageRange0To10V
* CurrentRange4To20mA
* CurrentRange0To20mA
* CurrentRange0To24mA

func (*IndustrialAnalogOutBricklet) SetCurrent

func (device *IndustrialAnalogOutBricklet) SetCurrent(current uint16) (err error)

Sets the output current.

The output current and output voltage are linked. Changing the output current also changes the output voltage.

func (*IndustrialAnalogOutBricklet) SetResponseExpected

func (device *IndustrialAnalogOutBricklet) SetResponseExpected(functionID Function, responseExpected bool) error

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

func (*IndustrialAnalogOutBricklet) SetResponseExpectedAll

func (device *IndustrialAnalogOutBricklet) SetResponseExpectedAll(responseExpected bool)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

func (*IndustrialAnalogOutBricklet) SetVoltage

func (device *IndustrialAnalogOutBricklet) SetVoltage(voltage uint16) (err error)

Sets the output voltage.

The output voltage and output current are linked. Changing the output voltage also changes the output current.

type VoltageRange

type VoltageRange = uint8
const (
	VoltageRange0To5V  VoltageRange = 0
	VoltageRange0To10V VoltageRange = 1
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL