industrial_analog_out_v2_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 and current, 0V to 10V and 4mA to 20mA‍.

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

Index

Constants

View Source
const DeviceDisplayName = "Industrial Analog Out Bricklet 2.0"
View Source
const DeviceIdentifier = 2116

Variables

This section is empty.

Functions

This section is empty.

Types

type BootloaderMode

type BootloaderMode = uint8
const (
	BootloaderModeBootloader                    BootloaderMode = 0
	BootloaderModeFirmware                      BootloaderMode = 1
	BootloaderModeBootloaderWaitForReboot       BootloaderMode = 2
	BootloaderModeFirmwareWaitForReboot         BootloaderMode = 3
	BootloaderModeFirmwareWaitForEraseAndReboot BootloaderMode = 4
)

type BootloaderStatus

type BootloaderStatus = uint8
const (
	BootloaderStatusOK                        BootloaderStatus = 0
	BootloaderStatusInvalidMode               BootloaderStatus = 1
	BootloaderStatusNoChange                  BootloaderStatus = 2
	BootloaderStatusEntryFunctionNotPresent   BootloaderStatus = 3
	BootloaderStatusDeviceIdentifierIncorrect BootloaderStatus = 4
	BootloaderStatusCRCMismatch               BootloaderStatus = 5
)

type CurrentRange

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

type Function

type Function = uint8
const (
	FunctionSetEnabled              Function = 1
	FunctionGetEnabled              Function = 2
	FunctionSetVoltage              Function = 3
	FunctionGetVoltage              Function = 4
	FunctionSetCurrent              Function = 5
	FunctionGetCurrent              Function = 6
	FunctionSetConfiguration        Function = 7
	FunctionGetConfiguration        Function = 8
	FunctionSetOutLEDConfig         Function = 9
	FunctionGetOutLEDConfig         Function = 10
	FunctionSetOutLEDStatusConfig   Function = 11
	FunctionGetOutLEDStatusConfig   Function = 12
	FunctionGetSPITFPErrorCount     Function = 234
	FunctionSetBootloaderMode       Function = 235
	FunctionGetBootloaderMode       Function = 236
	FunctionSetWriteFirmwarePointer Function = 237
	FunctionWriteFirmware           Function = 238
	FunctionSetStatusLEDConfig      Function = 239
	FunctionGetStatusLEDConfig      Function = 240
	FunctionGetChipTemperature      Function = 242
	FunctionReset                   Function = 243
	FunctionWriteUID                Function = 248
	FunctionReadUID                 Function = 249
	FunctionGetIdentity             Function = 255
)

type IndustrialAnalogOutV2Bricklet

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

func (device *IndustrialAnalogOutV2Bricklet) 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 (*IndustrialAnalogOutV2Bricklet) GetBootloaderMode

func (device *IndustrialAnalogOutV2Bricklet) GetBootloaderMode() (mode BootloaderMode, err error)

Returns the current bootloader mode, see SetBootloaderMode.

Associated constants:

* BootloaderModeBootloader
* BootloaderModeFirmware
* BootloaderModeBootloaderWaitForReboot
* BootloaderModeFirmwareWaitForReboot
* BootloaderModeFirmwareWaitForEraseAndReboot

func (*IndustrialAnalogOutV2Bricklet) GetChipTemperature

func (device *IndustrialAnalogOutV2Bricklet) GetChipTemperature() (temperature int16, err error)

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

func (*IndustrialAnalogOutV2Bricklet) GetConfiguration

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

Returns the configuration as set by SetConfiguration.

Associated constants:

* VoltageRange0To5V
* VoltageRange0To10V
* CurrentRange4To20mA
* CurrentRange0To20mA
* CurrentRange0To24mA

func (*IndustrialAnalogOutV2Bricklet) GetCurrent

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

Returns the current as set by SetCurrent.

func (*IndustrialAnalogOutV2Bricklet) GetEnabled

func (device *IndustrialAnalogOutV2Bricklet) GetEnabled() (enabled bool, err error)

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

func (*IndustrialAnalogOutV2Bricklet) GetIdentity

func (device *IndustrialAnalogOutV2Bricklet) 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 (*IndustrialAnalogOutV2Bricklet) GetOutLEDConfig

func (device *IndustrialAnalogOutV2Bricklet) GetOutLEDConfig() (config OutLEDConfig, err error)

Returns the Out LED configuration as set by SetOutLEDConfig

Associated constants:

* OutLEDConfigOff
* OutLEDConfigOn
* OutLEDConfigShowHeartbeat
* OutLEDConfigShowOutStatus

func (*IndustrialAnalogOutV2Bricklet) GetOutLEDStatusConfig

func (device *IndustrialAnalogOutV2Bricklet) GetOutLEDStatusConfig() (min uint16, max uint16, config OutLEDStatusConfig, err error)

Returns the Out LED status configuration as set by SetOutLEDStatusConfig.

Associated constants:

* OutLEDStatusConfigThreshold
* OutLEDStatusConfigIntensity

func (*IndustrialAnalogOutV2Bricklet) GetResponseExpected

func (device *IndustrialAnalogOutV2Bricklet) 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 (*IndustrialAnalogOutV2Bricklet) GetSPITFPErrorCount

func (device *IndustrialAnalogOutV2Bricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

* ACK checksum errors, * message checksum errors, * framing errors and * overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

func (*IndustrialAnalogOutV2Bricklet) GetStatusLEDConfig

func (device *IndustrialAnalogOutV2Bricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)

Returns the configuration as set by SetStatusLEDConfig

Associated constants:

* StatusLEDConfigOff
* StatusLEDConfigOn
* StatusLEDConfigShowHeartbeat
* StatusLEDConfigShowStatus

func (*IndustrialAnalogOutV2Bricklet) GetVoltage

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

Returns the voltage as set by SetVoltage.

func (*IndustrialAnalogOutV2Bricklet) ReadUID

func (device *IndustrialAnalogOutV2Bricklet) ReadUID() (uid uint32, err error)

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

func (*IndustrialAnalogOutV2Bricklet) Reset

func (device *IndustrialAnalogOutV2Bricklet) Reset() (err error)

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

func (*IndustrialAnalogOutV2Bricklet) SetBootloaderMode

func (device *IndustrialAnalogOutV2Bricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

Associated constants:

* BootloaderModeBootloader
* BootloaderModeFirmware
* BootloaderModeBootloaderWaitForReboot
* BootloaderModeFirmwareWaitForReboot
* BootloaderModeFirmwareWaitForEraseAndReboot
* BootloaderStatusOK
* BootloaderStatusInvalidMode
* BootloaderStatusNoChange
* BootloaderStatusEntryFunctionNotPresent
* BootloaderStatusDeviceIdentifierIncorrect
* BootloaderStatusCRCMismatch

func (*IndustrialAnalogOutV2Bricklet) SetConfiguration

func (device *IndustrialAnalogOutV2Bricklet) 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 (*IndustrialAnalogOutV2Bricklet) SetCurrent

func (device *IndustrialAnalogOutV2Bricklet) 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 (*IndustrialAnalogOutV2Bricklet) SetEnabled

func (device *IndustrialAnalogOutV2Bricklet) SetEnabled(enabled bool) (err error)

Enables/disables the output of voltage and current.

func (*IndustrialAnalogOutV2Bricklet) SetOutLEDConfig

func (device *IndustrialAnalogOutV2Bricklet) SetOutLEDConfig(config OutLEDConfig) (err error)

You can turn the Out LED off, on or show a heartbeat. You can also set the LED to Out Status. In this mode the LED can either be turned on with a pre-defined threshold or the intensity of the LED can change with the output value (voltage or current).

You can configure the channel status behavior with SetOutLEDStatusConfig.

Associated constants:

* OutLEDConfigOff
* OutLEDConfigOn
* OutLEDConfigShowHeartbeat
* OutLEDConfigShowOutStatus

func (*IndustrialAnalogOutV2Bricklet) SetOutLEDStatusConfig

func (device *IndustrialAnalogOutV2Bricklet) SetOutLEDStatusConfig(min uint16, max uint16, config OutLEDStatusConfig) (err error)

Sets the Out LED status config. This config is used if the Out LED is configured as Out Status, see SetOutLEDConfig.

For each channel you can choose between threshold and intensity mode.

In threshold mode you can define a positive or a negative threshold. For a positive threshold set the min parameter to the threshold value in mV or µA above which the LED should turn on and set the max parameter to 0. Example: If you set a positive threshold of 5V, the LED will turn on as soon as the output value exceeds 5V and turn off again if it goes below 5V. For a negative threshold set the max parameter to the threshold value in mV or µA below which the LED should turn on and set the min parameter to 0. Example: If you set a negative threshold of 5V, the LED will turn on as soon as the output value goes below 5V and the LED will turn off when the output value exceeds 5V.

In intensity mode you can define a range mV or µA that is used to scale the brightness of the LED. Example with min=2V, max=8V: The LED is off at 2V and below, on at 8V and above and the brightness is linearly scaled between the values 2V and 8V. If the min value is greater than the max value, the LED brightness is scaled the other way around.

Associated constants:

* OutLEDStatusConfigThreshold
* OutLEDStatusConfigIntensity

func (*IndustrialAnalogOutV2Bricklet) SetResponseExpected

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

func (device *IndustrialAnalogOutV2Bricklet) SetResponseExpectedAll(responseExpected bool)

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

func (*IndustrialAnalogOutV2Bricklet) SetStatusLEDConfig

func (device *IndustrialAnalogOutV2Bricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error)

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

Associated constants:

* StatusLEDConfigOff
* StatusLEDConfigOn
* StatusLEDConfigShowHeartbeat
* StatusLEDConfigShowStatus

func (*IndustrialAnalogOutV2Bricklet) SetVoltage

func (device *IndustrialAnalogOutV2Bricklet) 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.

func (*IndustrialAnalogOutV2Bricklet) SetWriteFirmwarePointer

func (device *IndustrialAnalogOutV2Bricklet) SetWriteFirmwarePointer(pointer uint32) (err error)

Sets the firmware pointer for WriteFirmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*IndustrialAnalogOutV2Bricklet) WriteFirmware

func (device *IndustrialAnalogOutV2Bricklet) WriteFirmware(data [64]uint8) (status uint8, err error)

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*IndustrialAnalogOutV2Bricklet) WriteUID

func (device *IndustrialAnalogOutV2Bricklet) WriteUID(uid uint32) (err error)

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

type OutLEDConfig

type OutLEDConfig = uint8
const (
	OutLEDConfigOff           OutLEDConfig = 0
	OutLEDConfigOn            OutLEDConfig = 1
	OutLEDConfigShowHeartbeat OutLEDConfig = 2
	OutLEDConfigShowOutStatus OutLEDConfig = 3
)

type OutLEDStatusConfig

type OutLEDStatusConfig = uint8
const (
	OutLEDStatusConfigThreshold OutLEDStatusConfig = 0
	OutLEDStatusConfigIntensity OutLEDStatusConfig = 1
)

type StatusLEDConfig

type StatusLEDConfig = uint8
const (
	StatusLEDConfigOff           StatusLEDConfig = 0
	StatusLEDConfigOn            StatusLEDConfig = 1
	StatusLEDConfigShowHeartbeat StatusLEDConfig = 2
	StatusLEDConfigShowStatus    StatusLEDConfig = 3
)

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