Back to godoc.org

Package io4_v2_bricklet

v0.0.0-...-aef6928
Latest Go to latest

The latest major version is .

Published: May 19, 2020 | License: CC0-1.0 | Module: github.com/Tinkerforge/go-api-bindings

Overview

4-channel digital input/output.

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

Index

Constants

const DeviceDisplayName = "IO-4 Bricklet 2.0"
const DeviceIdentifier = 2111

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 Direction

type Direction = rune
const (
	DirectionIn  Direction = 'i'
	DirectionOut Direction = 'o'
)

type EdgeType

type EdgeType = uint8
const (
	EdgeTypeRising  EdgeType = 0
	EdgeTypeFalling EdgeType = 1
	EdgeTypeBoth    EdgeType = 2
)

type Function

type Function = uint8
const (
	FunctionSetValue                              Function = 1
	FunctionGetValue                              Function = 2
	FunctionSetSelectedValue                      Function = 3
	FunctionSetConfiguration                      Function = 4
	FunctionGetConfiguration                      Function = 5
	FunctionSetInputValueCallbackConfiguration    Function = 6
	FunctionGetInputValueCallbackConfiguration    Function = 7
	FunctionSetAllInputValueCallbackConfiguration Function = 8
	FunctionGetAllInputValueCallbackConfiguration Function = 9
	FunctionSetMonoflop                           Function = 10
	FunctionGetMonoflop                           Function = 11
	FunctionGetEdgeCount                          Function = 12
	FunctionSetEdgeCountConfiguration             Function = 13
	FunctionGetEdgeCountConfiguration             Function = 14
	FunctionSetPWMConfiguration                   Function = 15
	FunctionGetPWMConfiguration                   Function = 16
	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
	FunctionCallbackInputValue                    Function = 17
	FunctionCallbackAllInputValue                 Function = 18
	FunctionCallbackMonoflopDone                  Function = 19
)

type IO4V2Bricklet

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

func New

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

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

func (*IO4V2Bricklet) DeregisterAllInputValueCallback

func (device *IO4V2Bricklet) DeregisterAllInputValueCallback(registrationId uint64)

Remove a registered All Input Value callback.

func (*IO4V2Bricklet) DeregisterInputValueCallback

func (device *IO4V2Bricklet) DeregisterInputValueCallback(registrationId uint64)

Remove a registered Input Value callback.

func (*IO4V2Bricklet) DeregisterMonoflopDoneCallback

func (device *IO4V2Bricklet) DeregisterMonoflopDoneCallback(registrationId uint64)

Remove a registered Monoflop Done callback.

func (*IO4V2Bricklet) GetAPIVersion

func (device *IO4V2Bricklet) 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 (*IO4V2Bricklet) GetAllInputValueCallbackConfiguration

func (device *IO4V2Bricklet) GetAllInputValueCallbackConfiguration() (period uint32, valueHasToChange bool, err error)

Returns the callback configuration as set by SetAllInputValueCallbackConfiguration.

func (*IO4V2Bricklet) GetBootloaderMode

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

Returns the current bootloader mode, see SetBootloaderMode.

Associated constants:

* BootloaderModeBootloader
* BootloaderModeFirmware
* BootloaderModeBootloaderWaitForReboot
* BootloaderModeFirmwareWaitForReboot
* BootloaderModeFirmwareWaitForEraseAndReboot

func (*IO4V2Bricklet) GetChipTemperature

func (device *IO4V2Bricklet) 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 (*IO4V2Bricklet) GetConfiguration

func (device *IO4V2Bricklet) GetConfiguration(channel uint8) (direction Direction, value bool, err error)

Returns the channel configuration as set by SetConfiguration.

Associated constants:

* DirectionIn
* DirectionOut

func (*IO4V2Bricklet) GetEdgeCount

func (device *IO4V2Bricklet) GetEdgeCount(channel uint8, resetCounter bool) (count uint32, err error)

Returns the current value of the edge counter for the selected channel. You can configure the edges that are counted with SetEdgeCountConfiguration.

If you set the reset counter to *true*, the count is set back to 0 directly after it is read.

Note

Calling this function is only allowed for channels configured as input.

func (*IO4V2Bricklet) GetEdgeCountConfiguration

func (device *IO4V2Bricklet) GetEdgeCountConfiguration(channel uint8) (edgeType EdgeType, debounce uint8, err error)

Returns the edge type and debounce time for the selected channel as set by SetEdgeCountConfiguration.

Note

Calling this function is only allowed for channels configured as input.

Associated constants:

* EdgeTypeRising
* EdgeTypeFalling
* EdgeTypeBoth

func (*IO4V2Bricklet) GetIdentity

func (device *IO4V2Bricklet) 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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an `Isolator Bricklet <isolator_bricklet>` is always as position 'z'.

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

func (*IO4V2Bricklet) GetInputValueCallbackConfiguration

func (device *IO4V2Bricklet) GetInputValueCallbackConfiguration(channel uint8) (period uint32, valueHasToChange bool, err error)

Returns the callback configuration for the given channel as set by SetInputValueCallbackConfiguration.

func (*IO4V2Bricklet) GetMonoflop

func (device *IO4V2Bricklet) GetMonoflop(channel uint8) (value bool, time uint32, timeRemaining uint32, err error)

Returns (for the given channel) the current value and the time as set by SetMonoflop as well as the remaining time until the value flips.

If the timer is not running currently, the remaining time will be returned as 0.

func (*IO4V2Bricklet) GetPWMConfiguration

func (device *IO4V2Bricklet) GetPWMConfiguration(channel uint8) (frequency uint32, dutyCycle uint16, err error)

Returns the PWM configuration as set by SetPWMConfiguration.

func (*IO4V2Bricklet) GetResponseExpected

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

func (device *IO4V2Bricklet) 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 (*IO4V2Bricklet) GetStatusLEDConfig

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

Returns the configuration as set by SetStatusLEDConfig

Associated constants:

* StatusLEDConfigOff
* StatusLEDConfigOn
* StatusLEDConfigShowHeartbeat
* StatusLEDConfigShowStatus

func (*IO4V2Bricklet) GetValue

func (device *IO4V2Bricklet) GetValue() (value [4]bool, err error)

Returns the logic levels that are currently measured on the channels. This function works if the channel is configured as input as well as if it is configured as output.

func (*IO4V2Bricklet) ReadUID

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

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

func (*IO4V2Bricklet) RegisterAllInputValueCallback

func (device *IO4V2Bricklet) RegisterAllInputValueCallback(fn func([4]bool, [4]bool)) uint64

This callback is triggered periodically according to the configuration set by SetAllInputValueCallbackConfiguration.

The parameters are the same as GetValue. Additional the `changed` parameter is true if the value has changed since the last callback.

func (*IO4V2Bricklet) RegisterInputValueCallback

func (device *IO4V2Bricklet) RegisterInputValueCallback(fn func(uint8, bool, bool)) uint64

This callback is triggered periodically according to the configuration set by SetInputValueCallbackConfiguration.

The parameters are the channel, a value-changed indicator and the actual value for the channel. The `changed` parameter is true if the value has changed since the last callback.

func (*IO4V2Bricklet) RegisterMonoflopDoneCallback

func (device *IO4V2Bricklet) RegisterMonoflopDoneCallback(fn func(uint8, bool)) uint64

This callback is triggered whenever a monoflop timer reaches 0. The parameters contain the channel and the current value of the channel (the value after the monoflop).

func (*IO4V2Bricklet) Reset

func (device *IO4V2Bricklet) 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 (*IO4V2Bricklet) SetAllInputValueCallbackConfiguration

func (device *IO4V2Bricklet) SetAllInputValueCallbackConfiguration(period uint32, valueHasToChange bool) (err error)

The period is the period with which the RegisterAllInputValueCallback callback is triggered periodically. A value of 0 turns the callback off.

If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

func (*IO4V2Bricklet) SetBootloaderMode

func (device *IO4V2Bricklet) 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 (*IO4V2Bricklet) SetConfiguration

func (device *IO4V2Bricklet) SetConfiguration(channel uint8, direction Direction, value bool) (err error)

Configures the value and direction of a specific channel. Possible directions are 'i' and 'o' for input and output.

If the direction is configured as output, the value is either high or low (set as *true* or *false*).

If the direction is configured as input, the value is either pull-up or default (set as *true* or *false*).

For example:

* (0, 'i', true) will set channel 0 as input pull-up. * (1, 'i', false) will set channel 1 as input default (floating if nothing is connected). * (2, 'o', true) will set channel 2 as output high. * (3, 'o', false) will set channel 3 as output low.

A running monoflop timer or PWM for the specific channel will be aborted if this function is called.

Associated constants:

* DirectionIn
* DirectionOut

func (*IO4V2Bricklet) SetEdgeCountConfiguration

func (device *IO4V2Bricklet) SetEdgeCountConfiguration(channel uint8, edgeType EdgeType, debounce uint8) (err error)

Configures the edge counter for a specific channel.

The edge type parameter configures if rising edges, falling edges or both are counted if the channel is configured for input. Possible edge types are:

* 0 = rising * 1 = falling * 2 = both

Configuring an edge counter resets its value to 0.

If you don't know what any of this means, just leave it at default. The default configuration is very likely OK for you.

Note

Calling this function is only allowed for channels configured as input.

Associated constants:

* EdgeTypeRising
* EdgeTypeFalling
* EdgeTypeBoth

func (*IO4V2Bricklet) SetInputValueCallbackConfiguration

func (device *IO4V2Bricklet) SetInputValueCallbackConfiguration(channel uint8, period uint32, valueHasToChange bool) (err error)

This callback can be configured per channel.

The period is the period with which the RegisterInputValueCallback callback is triggered periodically. A value of 0 turns the callback off.

If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

func (*IO4V2Bricklet) SetMonoflop

func (device *IO4V2Bricklet) SetMonoflop(channel uint8, value bool, time uint32) (err error)

The first parameter is the desired state of the channel (*true* means output *high* and *false* means output *low*). The second parameter indicates the time that the channel should hold the state.

If this function is called with the parameters (true, 1500): The channel will turn on and in 1.5s it will turn off again.

A PWM for the selected channel will be aborted if this function is called.

A monoflop can be used as a failsafe mechanism. For example: Lets assume you have a RS485 bus and a IO-4 Bricklet 2.0 is connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds. The channel will be *high* all the time. If now the RS485 connection is lost, the channel will turn *low* in at most two seconds.

func (*IO4V2Bricklet) SetPWMConfiguration

func (device *IO4V2Bricklet) SetPWMConfiguration(channel uint8, frequency uint32, dutyCycle uint16) (err error)

Activates a PWM for the given channel.

You need to set the channel to output before you call this function, otherwise it will report an invalid parameter error. To turn the PWM off again, you can set the frequency to 0 or any other function that changes a value of the channel (e.g. SetSelectedValue).

A running monoflop timer for the given channel will be aborted if this function is called.

func (*IO4V2Bricklet) SetResponseExpected

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

func (device *IO4V2Bricklet) SetResponseExpectedAll(responseExpected bool)

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

func (*IO4V2Bricklet) SetSelectedValue

func (device *IO4V2Bricklet) SetSelectedValue(channel uint8, value bool) (err error)

Sets the output value of a specific channel without affecting the other channels.

A running monoflop timer or PWM for the specific channel will be aborted if this function is called.

Note

This function does nothing for channels that are configured as input. Pull-up
resistors can be switched on with SetConfiguration.

func (*IO4V2Bricklet) SetStatusLEDConfig

func (device *IO4V2Bricklet) 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 (*IO4V2Bricklet) SetValue

func (device *IO4V2Bricklet) SetValue(value [4]bool) (err error)

Sets the output value of all four channels. A value of *true* or *false* outputs logic 1 or logic 0 respectively on the corresponding channel.

Use SetSelectedValue to change only one output channel state.

For example: (True, True, False, False) will turn the channels 0-1 high and the channels 2-3 low.

All running monoflop timers and PWMs will be aborted if this function is called.

Note

This function does nothing for channels that are configured as input. Pull-up
resistors can be switched on with SetConfiguration.

func (*IO4V2Bricklet) SetWriteFirmwarePointer

func (device *IO4V2Bricklet) 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 (*IO4V2Bricklet) WriteFirmware

func (device *IO4V2Bricklet) 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 (*IO4V2Bricklet) WriteUID

func (device *IO4V2Bricklet) 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 StatusLEDConfig

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

Package Files

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier