Go - Remote Switch Bricklet

This is the description of the Go API bindings for the Remote Switch Bricklet. General information and technical specifications for the Remote Switch Bricklet are summarized in its hardware description.

An installation guide for the Go API bindings is part of their general description. Additional documentation can be found on godoc.org.

Examples

The example code below is Public Domain (CC0 1.0).

Switch Socket

Download (example_switch_socket.go)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/remote_switch_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Remote Switch Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    rs, _ := remote_switch_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    // Switch on a type A socket with house code 17 and receiver code 1.
    // House code 17 is 10001 in binary (least-significant bit first)
    // and means that the DIP switches 1 and 5 are on and 2-4 are off.
    // Receiver code 1 is 10000 in binary (least-significant bit first)
    // and means that the DIP switch A is on and B-E are off.
    rs.SwitchSocketA(17, 1, remote_switch_bricklet.SwitchToOn)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

API

The Remote Switch Bricklet API is defined in the package github.com/Tinkerforge/go-api-bindings/remote_switch_bricklet

Nearly every function of the Go bindings can return an ipconnection.DeviceError, implementing the error interface. The error can have one of the following values:

  • ipconnection.DeviceErrorSuccess = 0
  • ipconnection.DeviceErrorInvalidParameter = 1
  • ipconnection.DeviceErrorFunctionNotSupported = 2
  • ipconnection.DeviceErrorUnknownError = 3

which correspond to the values returned from Bricks and Bricklets.

All functions listed below are thread-safe.

Basic Functions

func remote_switch_bricklet.New(uid string, ipcon *IPConnection) (device RemoteSwitchBricklet, err error)
Parameters:
  • uid – Type: string
  • ipcon – Type: *IPConnection
Returns:
  • device – Type: RemoteSwitchBricklet
  • err – Type: error

Creates a new RemoteSwitchBricklet object with the unique device ID uid and adds it to the IPConnection ipcon:

device, err := remote_switch_bricklet.New("YOUR_DEVICE_UID", &ipcon)

This device object can be used after the IPConnection has been connected.

func (*RemoteSwitchBricklet) SwitchSocket(houseCode uint8, receiverCode uint8, switchTo uint8) (err error)
Parameters:
  • houseCode – Type: uint8, Range: [0 to 31]
  • receiverCode – Type: uint8, Range: [0 to 31]
  • switchTo – Type: uint8, Range: See constants
Returns:
  • err – Type: error

This function is deprecated, use SwitchSocketA() instead.

The following constants are available for this function:

For switchTo:

  • remote_switch_bricklet.SwitchToOff = 0
  • remote_switch_bricklet.SwitchToOn = 1
func (*RemoteSwitchBricklet) GetSwitchingState() (state uint8, err error)
Returns:
  • state – Type: uint8, Range: See constants
  • err – Type: error

Returns the current switching state. If the current state is busy, the Bricklet is currently sending a code to switch a socket. It will not accept any requests to switch sockets until the state changes to ready.

How long the switching takes is dependent on the number of repeats, see SetRepeats().

The following constants are available for this function:

For state:

  • remote_switch_bricklet.SwitchingStateReady = 0
  • remote_switch_bricklet.SwitchingStateBusy = 1
func (*RemoteSwitchBricklet) SwitchSocketA(houseCode uint8, receiverCode uint8, switchTo uint8) (err error)
Parameters:
  • houseCode – Type: uint8, Range: [0 to 31]
  • receiverCode – Type: uint8, Range: [0 to 31]
  • switchTo – Type: uint8, Range: See constants
Returns:
  • err – Type: error

To switch a type A socket you have to give the house code, receiver code and the state (on or off) you want to switch to.

A detailed description on how you can figure out the house and receiver code can be found here.

The following constants are available for this function:

For switchTo:

  • remote_switch_bricklet.SwitchToOff = 0
  • remote_switch_bricklet.SwitchToOn = 1

New in version 2.0.1 (Plugin).

func (*RemoteSwitchBricklet) SwitchSocketB(address uint32, unit uint8, switchTo uint8) (err error)
Parameters:
  • address – Type: uint32, Range: [0 to 226 - 1]
  • unit – Type: uint8, Range: [0 to 15, 255]
  • switchTo – Type: uint8, Range: See constants
Returns:
  • err – Type: error

To switch a type B socket you have to give the address, unit and the state (on or off) you want to switch to.

To switch all devices with the same address use 255 for the unit.

A detailed description on how you can teach a socket the address and unit can be found here.

The following constants are available for this function:

For switchTo:

  • remote_switch_bricklet.SwitchToOff = 0
  • remote_switch_bricklet.SwitchToOn = 1

New in version 2.0.1 (Plugin).

func (*RemoteSwitchBricklet) DimSocketB(address uint32, unit uint8, dimValue uint8) (err error)
Parameters:
  • address – Type: uint32, Range: [0 to 226 - 1]
  • unit – Type: uint8, Range: [0 to 15, 255]
  • dimValue – Type: uint8, Range: [0 to 255]
Returns:
  • err – Type: error

To control a type B dimmer you have to give the address, unit and the dim value you want to set the dimmer to.

A detailed description on how you can teach a dimmer the address and unit can be found here.

New in version 2.0.1 (Plugin).

func (*RemoteSwitchBricklet) SwitchSocketC(systemCode rune, deviceCode uint8, switchTo uint8) (err error)
Parameters:
  • systemCode – Type: rune, Range: ['A' to 'P']
  • deviceCode – Type: uint8, Range: [1 to 16]
  • switchTo – Type: uint8, Range: See constants
Returns:
  • err – Type: error

To switch a type C socket you have to give the system code, device code and the state (on or off) you want to switch to.

A detailed description on how you can figure out the system and device code can be found here.

The following constants are available for this function:

For switchTo:

  • remote_switch_bricklet.SwitchToOff = 0
  • remote_switch_bricklet.SwitchToOn = 1

New in version 2.0.1 (Plugin).

Advanced Functions

func (*RemoteSwitchBricklet) SetRepeats(repeats uint8) (err error)
Parameters:
  • repeats – Type: uint8, Range: [0 to 255], Default: 5
Returns:
  • err – Type: error

Sets the number of times the code is sent when one of the switch socket functions is called. The repeats basically correspond to the amount of time that a button of the remote is pressed.

Some dimmers are controlled by the length of a button pressed, this can be simulated by increasing the repeats.

func (*RemoteSwitchBricklet) GetRepeats() (repeats uint8, err error)
Returns:
  • repeats – Type: uint8, Range: [0 to 255], Default: 5
  • err – Type: error

Returns the number of repeats as set by SetRepeats().

func (*RemoteSwitchBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)
Returns:
  • uid – Type: string, Length: up to 8
  • connectedUid – Type: string, Length: up to 8
  • position – Type: rune, Range: ['a' to 'h', 'i', 'z']
  • hardwareVersion – Type: [3]uint8
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • firmwareVersion – Type: [3]uint8
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • deviceIdentifier – Type: uint16, Range: [0 to 216 - 1]
  • err – Type: 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 is always as position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding Register*Callback function, which returns a unique callback ID. This ID can be used to deregister the callback later with the corresponding Deregister*Callback function.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

func (*RemoteSwitchBricklet) RegisterSwitchingDoneCallback(func()) (registrationId uint64)
Returns:
  • registrationId – Type: uint64

This callback is triggered whenever the switching state changes from busy to ready, see GetSwitchingState().

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

func (*RemoteSwitchBricklet) GetAPIVersion() (apiVersion [3]uint8, err error)
Returns:
  • apiVersion – Type: [3]uint8
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • err – Type: error

Returns the version of the API definition 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 (*RemoteSwitchBricklet) GetResponseExpected(functionId uint8) (responseExpected bool, err error)
Parameters:
  • functionId – Type: uint8, Range: See constants
Returns:
  • responseExpected – Type: bool
  • err – Type: 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.

The following constants are available for this function:

For functionId:

  • remote_switch_bricklet.FunctionSwitchSocket = 1
  • remote_switch_bricklet.FunctionSetRepeats = 4
  • remote_switch_bricklet.FunctionSwitchSocketA = 6
  • remote_switch_bricklet.FunctionSwitchSocketB = 7
  • remote_switch_bricklet.FunctionDimSocketB = 8
  • remote_switch_bricklet.FunctionSwitchSocketC = 9
func (*RemoteSwitchBricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err error)
Parameters:
  • functionId – Type: uint8, Range: See constants
  • responseExpected – Type: bool
Returns:
  • err – Type: 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.

The following constants are available for this function:

For functionId:

  • remote_switch_bricklet.FunctionSwitchSocket = 1
  • remote_switch_bricklet.FunctionSetRepeats = 4
  • remote_switch_bricklet.FunctionSwitchSocketA = 6
  • remote_switch_bricklet.FunctionSwitchSocketB = 7
  • remote_switch_bricklet.FunctionDimSocketB = 8
  • remote_switch_bricklet.FunctionSwitchSocketC = 9
func (*RemoteSwitchBricklet) SetResponseExpectedAll(responseExpected bool) (err error)
Parameters:
  • responseExpected – Type: bool
Returns:
  • err – Type: error

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

Constants

remote_switch_bricklet.DeviceIdentifier

This constant is used to identify a Remote Switch Bricklet.

The GetIdentity() function and the (*IPConnection) RegisterEnumerateCallback callback of the IPConnection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

remote_switch_bricklet.DeviceDisplayName

This constant represents the human readable name of a Remote Switch Bricklet.