industrial_quad_relay_v2_bricklet

package
v0.0.0-...-57cfa29 Latest Latest
Warning

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

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

Documentation

Overview

4 galvanically isolated solid state relays.

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

Index

Constants

View Source 
const DeviceDisplayName = "Industrial Quad Relay Bricklet 2.0"
View Source 
const DeviceIdentifier = 2102

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 ChannelLEDConfig 

type ChannelLEDConfig = uint8
const (
	ChannelLEDConfigOff               ChannelLEDConfig = 0
	ChannelLEDConfigOn                ChannelLEDConfig = 1
	ChannelLEDConfigShowHeartbeat     ChannelLEDConfig = 2
	ChannelLEDConfigShowChannelStatus ChannelLEDConfig = 3
)

type Function 

type Function = uint8
const (
	FunctionSetValue                Function = 1
	FunctionGetValue                Function = 2
	FunctionSetMonoflop             Function = 3
	FunctionGetMonoflop             Function = 4
	FunctionSetSelectedValue        Function = 5
	FunctionSetChannelLEDConfig     Function = 6
	FunctionGetChannelLEDConfig     Function = 7
	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
	FunctionCallbackMonoflopDone    Function = 8
)

type IndustrialQuadRelayV2Bricklet 

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

func New 

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

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

func (*IndustrialQuadRelayV2Bricklet) DeregisterMonoflopDoneCallback 

func (device *IndustrialQuadRelayV2Bricklet) DeregisterMonoflopDoneCallback(registrationId uint64)

Remove a registered Monoflop Done callback.

func (*IndustrialQuadRelayV2Bricklet) GetAPIVersion 

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

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

Returns the current bootloader mode, see SetBootloaderMode.

Associated constants:

  • BootloaderModeBootloader
  • BootloaderModeFirmware
  • BootloaderModeBootloaderWaitForReboot
  • BootloaderModeFirmwareWaitForReboot
  • BootloaderModeFirmwareWaitForEraseAndReboot

func (*IndustrialQuadRelayV2Bricklet) GetChannelLEDConfig 

func (device *IndustrialQuadRelayV2Bricklet) GetChannelLEDConfig(channel uint8) (config ChannelLEDConfig, err error)

Returns the channel LED configuration as set by SetChannelLEDConfig

Associated constants:

  • ChannelLEDConfigOff
  • ChannelLEDConfigOn
  • ChannelLEDConfigShowHeartbeat
  • ChannelLEDConfigShowChannelStatus

func (*IndustrialQuadRelayV2Bricklet) GetChipTemperature 

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

func (device *IndustrialQuadRelayV2Bricklet) 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 (*IndustrialQuadRelayV2Bricklet) GetMonoflop 

func (device *IndustrialQuadRelayV2Bricklet) 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 (*IndustrialQuadRelayV2Bricklet) GetResponseExpected 

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

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

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

Returns the configuration as set by SetStatusLEDConfig

Associated constants:

  • StatusLEDConfigOff
  • StatusLEDConfigOn
  • StatusLEDConfigShowHeartbeat
  • StatusLEDConfigShowStatus

func (*IndustrialQuadRelayV2Bricklet) GetValue 

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

Returns the values as set by SetValue.

func (*IndustrialQuadRelayV2Bricklet) ReadUID 

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

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

func (*IndustrialQuadRelayV2Bricklet) RegisterMonoflopDoneCallback 

func (device *IndustrialQuadRelayV2Bricklet) 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 (*IndustrialQuadRelayV2Bricklet) Reset 

func (device *IndustrialQuadRelayV2Bricklet) 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 (*IndustrialQuadRelayV2Bricklet) SetBootloaderMode 

func (device *IndustrialQuadRelayV2Bricklet) 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 (*IndustrialQuadRelayV2Bricklet) SetChannelLEDConfig 

func (device *IndustrialQuadRelayV2Bricklet) SetChannelLEDConfig(channel uint8, config ChannelLEDConfig) (err error)

Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to Channel Status. In this mode the LED is on if the channel is high and off otherwise.

Associated constants:

  • ChannelLEDConfigOff
  • ChannelLEDConfigOn
  • ChannelLEDConfigShowHeartbeat
  • ChannelLEDConfigShowChannelStatus

func (*IndustrialQuadRelayV2Bricklet) SetMonoflop 

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

Configures a monoflop of the specified channel.

The second parameter is the desired value of the specified channel. A *true* means relay closed and a *false* means relay open.

The third parameter indicates the time that the channels should hold the value.

If this function is called with the parameters (0, 1, 1500) channel 0 will close and in 1.5s channel 0 will open again

A monoflop can be used as a fail-safe mechanism. For example: Lets assume you have a RS485 bus and a Industrial Quad Relay Bricklet 2.0 connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds and channel 0 closed. Channel 0 will be closed all the time. If now the RS485 connection is lost, then channel 0 will be opened in at most two seconds.

func (*IndustrialQuadRelayV2Bricklet) SetResponseExpected 

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

func (device *IndustrialQuadRelayV2Bricklet) SetResponseExpectedAll(responseExpected bool)

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

func (*IndustrialQuadRelayV2Bricklet) SetSelectedValue 

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

Sets the output value of the specified channel without affecting the other channels.

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

func (*IndustrialQuadRelayV2Bricklet) SetStatusLEDConfig 

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

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

Sets the value of all four relays. A value of *true* closes the relay and a value of *false* opens the relay.

Use SetSelectedValue to only change one relay.

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

func (*IndustrialQuadRelayV2Bricklet) SetWriteFirmwarePointer 

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

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.