This is the description of the Go API bindings for the Remote Switch Bricklet 2.0. General information and technical specifications for the Remote Switch Bricklet 2.0 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.
The example code below is Public Domain (CC0 1.0).
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_v2_bricklet"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Remote Switch Bricklet 2.0.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
rs, _ := remote_switch_v2_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_v2_bricklet.SwitchToOn)
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
Download (example_remote_callback.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 31 32 33 34 35 36 37 38 39 40 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
"github.com/Tinkerforge/go-api-bindings/remote_switch_v2_bricklet"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Remote Switch Bricklet 2.0.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
rs, _ := remote_switch_v2_bricklet.New(UID, &ipcon) // Create device object.
ipcon.Connect(ADDR) // Connect to brickd.
defer ipcon.Disconnect()
// Don't use device before ipcon is connected.
// Configure to receive from remote type A with minimum repeats set to 1 and enable callback
rs.SetRemoteConfiguration(remote_switch_v2_bricklet.RemoteTypeA, 1, true)
rs.RegisterRemoteStatusACallback(func(houseCode uint8, receiverCode uint8, switchTo remote_switch_v2_bricklet.SwitchTo, repeats uint16) {
fmt.Printf("House Code: %d\n", houseCode)
fmt.Printf("Receiver Code: %d\n", receiverCode)
if switchTo == remote_switch_v2_bricklet.SwitchToOff {
fmt.Println("Switch To: Off")
} else if switchTo == remote_switch_v2_bricklet.SwitchToOn {
fmt.Println("Switch To: On")
}
fmt.Printf("Repeats: %d\n", repeats)
fmt.Println()
})
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
The Remote Switch Bricklet 2.0 API is defined in the package github.com/Tinkerforge/go-api-bindings/remote_switch_v2_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:
which correspond to the values returned from Bricks and Bricklets.
All functions listed below are thread-safe.
remote_switch_v2_bricklet.
New
(uid string, ipcon *IPConnection) (device RemoteSwitchV2Bricklet, err error)¶Parameters: |
|
---|---|
Returns: |
|
Creates a new RemoteSwitchV2Bricklet
object with the unique device ID uid
and adds
it to the IPConnection ipcon
:
device, err := remote_switch_v2_bricklet.New("YOUR_DEVICE_UID", &ipcon)
This device object can be used after the IPConnection has been connected.
(*RemoteSwitchV2Bricklet)
GetSwitchingState
() (state uint8, err error)¶Returns: |
|
---|
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 calls of switch socket functions 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:
(*RemoteSwitchV2Bricklet)
SwitchSocketA
(houseCode uint8, receiverCode uint8, switchTo uint8) (err error)¶Parameters: |
|
---|---|
Returns: |
|
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:
(*RemoteSwitchV2Bricklet)
SwitchSocketB
(address uint32, unit uint8, switchTo uint8) (err error)¶Parameters: |
|
---|---|
Returns: |
|
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:
(*RemoteSwitchV2Bricklet)
DimSocketB
(address uint32, unit uint8, dimValue uint8) (err error)¶Parameters: |
|
---|---|
Returns: |
|
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.
(*RemoteSwitchV2Bricklet)
SwitchSocketC
(systemCode rune, deviceCode uint8, switchTo uint8) (err error)¶Parameters: |
|
---|---|
Returns: |
|
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:
(*RemoteSwitchV2Bricklet)
SetRemoteConfiguration
(remoteType uint8, minimumRepeats uint16, callbackEnabled bool) (err error)¶Parameters: |
|
---|---|
Returns: |
|
Sets the configuration for receiving data from a remote of type A, B or C.
RemoteStatusACallback
callback,
RemoteStatusBCallback
callback and RemoteStatusCCallback
callback).The following constants are available for this function:
For remoteType:
(*RemoteSwitchV2Bricklet)
GetRemoteConfiguration
() (remoteType uint8, minimumRepeats uint16, callbackEnabled bool, err error)¶Returns: |
|
---|
Returns the remote configuration as set by SetRemoteConfiguration()
The following constants are available for this function:
For remoteType:
(*RemoteSwitchV2Bricklet)
GetRemoteStatusA
() (houseCode uint8, receiverCode uint8, switchTo uint8, repeats uint16, err error)¶Returns: |
|
---|
Returns the house code, receiver code, switch state (on/off) and number of repeats for remote type A.
Repeats == 0 means there was no button press. Repeats >= 1 means there was a button press with the specified house/receiver code. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.
Use the callback to get this data automatically when a button is pressed,
see SetRemoteConfiguration()
and RemoteStatusACallback
callback.
The following constants are available for this function:
For switchTo:
(*RemoteSwitchV2Bricklet)
GetRemoteStatusB
() (address uint32, unit uint8, switchTo uint8, dimValue uint8, repeats uint16, err error)¶Returns: |
|
---|
Returns the address (unique per remote), unit (button number), switch state (on/off) and number of repeats for remote type B.
If the remote supports dimming the dim value is used instead of the switch state.
If repeats=0 there was no button press. If repeats >= 1 there was a button press with the specified address/unit. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.
Use the callback to get this data automatically when a button is pressed,
see SetRemoteConfiguration()
and RemoteStatusBCallback
callback.
The following constants are available for this function:
For switchTo:
(*RemoteSwitchV2Bricklet)
GetRemoteStatusC
() (systemCode rune, deviceCode uint8, switchTo uint8, repeats uint16, err error)¶Returns: |
|
---|
Returns the system code, device code, switch state (on/off) and number of repeats for remote type C.
If repeats=0 there was no button press. If repeats >= 1 there was a button press with the specified system/device code. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.
Use the callback to get this data automatically when a button is pressed,
see SetRemoteConfiguration()
and RemoteStatusCCallback
callback.
The following constants are available for this function:
For switchTo:
(*RemoteSwitchV2Bricklet)
SetRepeats
(repeats uint8) (err error)¶Parameters: |
|
---|---|
Returns: |
|
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.
(*RemoteSwitchV2Bricklet)
GetRepeats
() (repeats uint8, err error)¶Returns: |
|
---|
Returns the number of repeats as set by SetRepeats()
.
(*RemoteSwitchV2Bricklet)
GetSPITFPErrorCount
() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)¶Returns: |
|
---|
Returns the error count for the communication between Brick and Bricklet.
The errors are divided into
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.
(*RemoteSwitchV2Bricklet)
SetStatusLEDConfig
(config uint8) (err error)¶Parameters: |
|
---|---|
Returns: |
|
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.
The following constants are available for this function:
For config:
(*RemoteSwitchV2Bricklet)
GetStatusLEDConfig
() (config uint8, err error)¶Returns: |
|
---|
Returns the configuration as set by SetStatusLEDConfig()
The following constants are available for this function:
For config:
(*RemoteSwitchV2Bricklet)
GetChipTemperature
() (temperature int16, err error)¶Returns: |
|
---|
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.
(*RemoteSwitchV2Bricklet)
Reset
() (err error)¶Returns: |
|
---|
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!
(*RemoteSwitchV2Bricklet)
GetIdentity
() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)¶Returns: |
|
---|
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 is always at position 'z'.
The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.
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.
(*RemoteSwitchV2Bricklet)
RegisterSwitchingDoneCallback
(func()) (registrationId uint64)¶Returns: |
|
---|
This callback is triggered whenever the switching state changes
from busy to ready, see GetSwitchingState()
.
(*RemoteSwitchV2Bricklet)
RegisterRemoteStatusACallback
(func(houseCode uint8, receiverCode uint8, switchTo uint8, repeats uint16)) (registrationId uint64)¶Callback Parameters: |
|
---|---|
Returns: |
|
Returns the house code, receiver code, switch state (on/off) and number of repeats for remote type A.
The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.
You have to enable the callback with SetRemoteConfiguration()
. The number
of repeats that you can set in the configuration is the minimum number of repeats that have
to be seen before the callback is triggered for the first time.
The following constants are available for this function:
For switchTo:
(*RemoteSwitchV2Bricklet)
RegisterRemoteStatusBCallback
(func(address uint32, unit uint8, switchTo uint8, dimValue uint8, repeats uint16)) (registrationId uint64)¶Callback Parameters: |
|
---|---|
Returns: |
|
Returns the address (unique per remote), unit (button number), switch state (on/off) and number of repeats for remote type B.
If the remote supports dimming the dim value is used instead of the switch state.
The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.
You have to enable the callback with SetRemoteConfiguration()
. The number
of repeats that you can set in the configuration is the minimum number of repeats that have
to be seen before the callback is triggered for the first time.
The following constants are available for this function:
For switchTo:
(*RemoteSwitchV2Bricklet)
RegisterRemoteStatusCCallback
(func(systemCode rune, deviceCode uint8, switchTo uint8, repeats uint16)) (registrationId uint64)¶Callback Parameters: |
|
---|---|
Returns: |
|
Returns the system code, device code, switch state (on/off) and number of repeats for remote type C.
The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.
You have to enable the callback with SetRemoteConfiguration()
. The number
of repeats that you can set in the configuration is the minimum number of repeats that have
to be seen before the callback is triggered for the first time.
The following constants are available for this function:
For switchTo:
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.
(*RemoteSwitchV2Bricklet)
GetAPIVersion
() (apiVersion [3]uint8, err error)¶Returns: |
|
---|
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.
(*RemoteSwitchV2Bricklet)
GetResponseExpected
(functionId uint8) (responseExpected bool, err error)¶Parameters: |
|
---|---|
Returns: |
|
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:
(*RemoteSwitchV2Bricklet)
SetResponseExpected
(functionId uint8, responseExpected bool) (err error)¶Parameters: |
|
---|---|
Returns: |
|
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:
(*RemoteSwitchV2Bricklet)
SetResponseExpectedAll
(responseExpected bool) (err error)¶Parameters: |
|
---|---|
Returns: |
|
Changes the response expected flag for all setter and callback configuration functions of this device at once.
Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.
(*RemoteSwitchV2Bricklet)
SetBootloaderMode
(mode uint8) (status uint8, err error)¶Parameters: |
|
---|---|
Returns: |
|
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.
The following constants are available for this function:
For mode:
For status:
(*RemoteSwitchV2Bricklet)
GetBootloaderMode
() (mode uint8, err error)¶Returns: |
|
---|
Returns the current bootloader mode, see SetBootloaderMode()
.
The following constants are available for this function:
For mode:
(*RemoteSwitchV2Bricklet)
SetWriteFirmwarePointer
(pointer uint32) (err error)¶Parameters: |
|
---|---|
Returns: |
|
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.
(*RemoteSwitchV2Bricklet)
WriteFirmware
(data [64]uint8) (status uint8, err error)¶Parameters: |
|
---|---|
Returns: |
|
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.
(*RemoteSwitchV2Bricklet)
WriteUID
(uid uint32) (err error)¶Parameters: |
|
---|---|
Returns: |
|
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.
(*RemoteSwitchV2Bricklet)
ReadUID
() (uid uint32, err error)¶Returns: |
|
---|
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
remote_switch_v2_bricklet.
DeviceIdentifier
¶This constant is used to identify a Remote Switch Bricklet 2.0.
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_v2_bricklet.
DeviceDisplayName
¶This constant represents the human readable name of a Remote Switch Bricklet 2.0.