analog_out_bricklet

package
Version: v0.0.0-...-8a98e63 Latest Latest
Warning

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

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

Documentation

Overview

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

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

Index

Constants

View Source
const DeviceDisplayName = "Analog Out Bricklet"
View Source
const DeviceIdentifier = 220

Variables

This section is empty.

Functions

This section is empty.

Types

type AnalogOutBricklet

type AnalogOutBricklet 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 (*AnalogOutBricklet) GetAPIVersion

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

func (device *AnalogOutBricklet) 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 (*AnalogOutBricklet) GetMode

func (device *AnalogOutBricklet) GetMode() (mode Mode, err error)

Returns the mode as set by SetMode.

Associated constants:

  • ModeAnalogValue
  • Mode1kToGround
  • Mode100kToGround
  • Mode500kToGround

func (*AnalogOutBricklet) GetResponseExpected

func (device *AnalogOutBricklet) 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 (*AnalogOutBricklet) GetVoltage

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

Returns the voltage as set by SetVoltage.

func (*AnalogOutBricklet) SetMode

func (device *AnalogOutBricklet) SetMode(mode Mode) (err error)

Sets the mode of the analog value. Possible modes:

* 0: Normal Mode (Analog value as set by SetVoltage is applied) * 1: 1k Ohm resistor to ground * 2: 100k Ohm resistor to ground * 3: 500k Ohm resistor to ground

Setting the mode to 0 will result in an output voltage of 0 V. You can jump to a higher output voltage directly by calling SetVoltage.

Associated constants:

  • ModeAnalogValue
  • Mode1kToGround
  • Mode100kToGround
  • Mode500kToGround

func (*AnalogOutBricklet) SetResponseExpected

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

func (device *AnalogOutBricklet) SetResponseExpectedAll(responseExpected bool)

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

func (*AnalogOutBricklet) SetVoltage

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

Sets the voltage. Calling this function will set the mode to 0 (see SetMode).

type Function

type Function = uint8
const (
	FunctionSetVoltage  Function = 1
	FunctionGetVoltage  Function = 2
	FunctionSetMode     Function = 3
	FunctionGetMode     Function = 4
	FunctionGetIdentity Function = 255
)

type Mode

type Mode = uint8
const (
	ModeAnalogValue  Mode = 0
	Mode1kToGround   Mode = 1
	Mode100kToGround Mode = 2
	Mode500kToGround Mode = 3
)

Jump to

Keyboard shortcuts

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