analog_out_v2_bricklet

Documentation

Overview

Generates configurable DC voltage between 0V and 12V‍.

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

Index

• Constants
• type AnalogOutV2Bricklet
  • func New(uid string, ipcon *ipconnection.IPConnection) (AnalogOutV2Bricklet, error)
  • func (device *AnalogOutV2Bricklet) GetAPIVersion() [3]uint8
  • func (device *AnalogOutV2Bricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, ...)
  • func (device *AnalogOutV2Bricklet) GetInputVoltage() (voltage uint16, err error)
  • func (device *AnalogOutV2Bricklet) GetOutputVoltage() (voltage uint16, err error)
  • func (device *AnalogOutV2Bricklet) GetResponseExpected(functionID Function) (bool, error)
  • func (device *AnalogOutV2Bricklet) SetOutputVoltage(voltage uint16) (err error)
  • func (device *AnalogOutV2Bricklet) SetResponseExpected(functionID Function, responseExpected bool) error
  • func (device *AnalogOutV2Bricklet) SetResponseExpectedAll(responseExpected bool)
• type Function

Constants

const DeviceDisplayName = "Analog Out Bricklet 2.0"

const DeviceIdentifier = 256

Types

type AnalogOutV2Bricklet

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

func New

func New(uid string, ipcon *ipconnection.IPConnection) (AnalogOutV2Bricklet, error)

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

func (*AnalogOutV2Bricklet) GetAPIVersion

func (device *AnalogOutV2Bricklet) 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 (*AnalogOutV2Bricklet) GetIdentity

func (device *AnalogOutV2Bricklet) 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 (*AnalogOutV2Bricklet) GetInputVoltage

func (device *AnalogOutV2Bricklet) GetInputVoltage() (voltage uint16, err error)

Returns the input voltage.

func (*AnalogOutV2Bricklet) GetOutputVoltage

func (device *AnalogOutV2Bricklet) GetOutputVoltage() (voltage uint16, err error)

Returns the voltage as set by SetOutputVoltage.

func (*AnalogOutV2Bricklet) GetResponseExpected

func (device *AnalogOutV2Bricklet) 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 (*AnalogOutV2Bricklet) SetOutputVoltage

func (device *AnalogOutV2Bricklet) SetOutputVoltage(voltage uint16) (err error)

Sets the voltage.

func (*AnalogOutV2Bricklet) SetResponseExpected

func (device *AnalogOutV2Bricklet) 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 (*AnalogOutV2Bricklet) SetResponseExpectedAll

func (device *AnalogOutV2Bricklet) SetResponseExpectedAll(responseExpected bool)

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

type Function

type Function = uint8

const (
	FunctionSetOutputVoltage Function = 1
	FunctionGetOutputVoltage Function = 2
	FunctionGetInputVoltage  Function = 3
	FunctionGetIdentity      Function = 255
)