remote_switch_v2_bricklet

package
Version: v0.0.0-...-1640943 Latest Latest
Warning

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

Go to latest
Published: May 7, 2021 License: CC0-1.0 Imports: 5 Imported by: 0

Documentation

Overview

Controls remote mains switches and receives signals from remotes.

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

Index

Constants

View Source
const DeviceDisplayName = "Remote Switch Bricklet 2.0"
View Source
const DeviceIdentifier = 289

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 Function

type Function = uint8
const (
	FunctionGetSwitchingState       Function = 1
	FunctionSetRepeats              Function = 3
	FunctionGetRepeats              Function = 4
	FunctionSwitchSocketA           Function = 5
	FunctionSwitchSocketB           Function = 6
	FunctionDimSocketB              Function = 7
	FunctionSwitchSocketC           Function = 8
	FunctionSetRemoteConfiguration  Function = 9
	FunctionGetRemoteConfiguration  Function = 10
	FunctionGetRemoteStatusA        Function = 11
	FunctionGetRemoteStatusB        Function = 12
	FunctionGetRemoteStatusC        Function = 13
	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
	FunctionCallbackSwitchingDone   Function = 2
	FunctionCallbackRemoteStatusA   Function = 14
	FunctionCallbackRemoteStatusB   Function = 15
	FunctionCallbackRemoteStatusC   Function = 16
)

type RemoteSwitchV2Bricklet

type RemoteSwitchV2Bricklet 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 (*RemoteSwitchV2Bricklet) DeregisterRemoteStatusACallback

func (device *RemoteSwitchV2Bricklet) DeregisterRemoteStatusACallback(registrationId uint64)

Remove a registered Remote Status A callback.

func (*RemoteSwitchV2Bricklet) DeregisterRemoteStatusBCallback

func (device *RemoteSwitchV2Bricklet) DeregisterRemoteStatusBCallback(registrationId uint64)

Remove a registered Remote Status B callback.

func (*RemoteSwitchV2Bricklet) DeregisterRemoteStatusCCallback

func (device *RemoteSwitchV2Bricklet) DeregisterRemoteStatusCCallback(registrationId uint64)

Remove a registered Remote Status C callback.

func (*RemoteSwitchV2Bricklet) DeregisterSwitchingDoneCallback

func (device *RemoteSwitchV2Bricklet) DeregisterSwitchingDoneCallback(registrationId uint64)

Remove a registered Switching Done callback.

func (*RemoteSwitchV2Bricklet) DimSocketB

func (device *RemoteSwitchV2Bricklet) DimSocketB(address uint32, unit uint8, dimValue uint8) (err 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 <remote_switch_bricklet_type_b_address_and_unit>`.

func (*RemoteSwitchV2Bricklet) GetAPIVersion

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

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

Returns the current bootloader mode, see SetBootloaderMode.

Associated constants:

* BootloaderModeBootloader
* BootloaderModeFirmware
* BootloaderModeBootloaderWaitForReboot
* BootloaderModeFirmwareWaitForReboot
* BootloaderModeFirmwareWaitForEraseAndReboot

func (*RemoteSwitchV2Bricklet) GetChipTemperature

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

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

func (device *RemoteSwitchV2Bricklet) GetRemoteConfiguration() (remoteType RemoteType, minimumRepeats uint16, callbackEnabled bool, err error)

Returns the remote configuration as set by SetRemoteConfiguration

Associated constants:

* RemoteTypeA
* RemoteTypeB
* RemoteTypeC

func (*RemoteSwitchV2Bricklet) GetRemoteStatusA

func (device *RemoteSwitchV2Bricklet) GetRemoteStatusA() (houseCode uint8, receiverCode uint8, switchTo SwitchTo, repeats uint16, err error)

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 RegisterRemoteStatusACallback callback.

Associated constants:

* SwitchToOff
* SwitchToOn

func (*RemoteSwitchV2Bricklet) GetRemoteStatusB

func (device *RemoteSwitchV2Bricklet) GetRemoteStatusB() (address uint32, unit uint8, switchTo SwitchTo, dimValue uint8, repeats uint16, err error)

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 RegisterRemoteStatusBCallback callback.

Associated constants:

* SwitchToOff
* SwitchToOn

func (*RemoteSwitchV2Bricklet) GetRemoteStatusC

func (device *RemoteSwitchV2Bricklet) GetRemoteStatusC() (systemCode rune, deviceCode uint8, switchTo SwitchTo, repeats uint16, err error)

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 RegisterRemoteStatusCCallback callback.

Associated constants:

* SwitchToOff
* SwitchToOn

func (*RemoteSwitchV2Bricklet) GetRepeats

func (device *RemoteSwitchV2Bricklet) GetRepeats() (repeats uint8, err error)

Returns the number of repeats as set by SetRepeats.

func (*RemoteSwitchV2Bricklet) GetResponseExpected

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

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

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

Returns the configuration as set by SetStatusLEDConfig

Associated constants:

* StatusLEDConfigOff
* StatusLEDConfigOn
* StatusLEDConfigShowHeartbeat
* StatusLEDConfigShowStatus

func (*RemoteSwitchV2Bricklet) GetSwitchingState

func (device *RemoteSwitchV2Bricklet) GetSwitchingState() (state SwitchingState, err 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 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.

Associated constants:

* SwitchingStateReady
* SwitchingStateBusy

func (*RemoteSwitchV2Bricklet) ReadUID

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

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

func (*RemoteSwitchV2Bricklet) RegisterRemoteStatusACallback

func (device *RemoteSwitchV2Bricklet) RegisterRemoteStatusACallback(fn func(uint8, uint8, SwitchTo, uint16)) uint64

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.

func (*RemoteSwitchV2Bricklet) RegisterRemoteStatusBCallback

func (device *RemoteSwitchV2Bricklet) RegisterRemoteStatusBCallback(fn func(uint32, uint8, SwitchTo, uint8, uint16)) uint64

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.

func (*RemoteSwitchV2Bricklet) RegisterRemoteStatusCCallback

func (device *RemoteSwitchV2Bricklet) RegisterRemoteStatusCCallback(fn func(rune, uint8, SwitchTo, uint16)) uint64

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.

func (*RemoteSwitchV2Bricklet) RegisterSwitchingDoneCallback

func (device *RemoteSwitchV2Bricklet) RegisterSwitchingDoneCallback(fn func()) uint64

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

func (*RemoteSwitchV2Bricklet) Reset

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

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

func (device *RemoteSwitchV2Bricklet) SetRemoteConfiguration(remoteType RemoteType, minimumRepeats uint16, callbackEnabled bool) (err error)

Sets the configuration for **receiving** data from a remote of type A, B or C.

* Remote Type: A, B or C depending on the type of remote you want to receive. * Minimum Repeats: The minimum number of repeated data packets until the callback

is triggered (if enabled).

* Callback Enabled: Enable or disable callback (see RegisterRemoteStatusACallback callback,

RegisterRemoteStatusBCallback callback and RegisterRemoteStatusCCallback callback).

Associated constants:

* RemoteTypeA
* RemoteTypeB
* RemoteTypeC

func (*RemoteSwitchV2Bricklet) SetRepeats

func (device *RemoteSwitchV2Bricklet) SetRepeats(repeats uint8) (err 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 (*RemoteSwitchV2Bricklet) SetResponseExpected

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

func (device *RemoteSwitchV2Bricklet) SetResponseExpectedAll(responseExpected bool)

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

func (*RemoteSwitchV2Bricklet) SetStatusLEDConfig

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

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

func (device *RemoteSwitchV2Bricklet) SwitchSocketA(houseCode uint8, receiverCode uint8, switchTo SwitchTo) (err 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 <remote_switch_bricklet_type_a_house_and_receiver_code>`.

Associated constants:

* SwitchToOff
* SwitchToOn

func (*RemoteSwitchV2Bricklet) SwitchSocketB

func (device *RemoteSwitchV2Bricklet) SwitchSocketB(address uint32, unit uint8, switchTo SwitchTo) (err 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 <remote_switch_bricklet_type_b_address_and_unit>`.

Associated constants:

* SwitchToOff
* SwitchToOn

func (*RemoteSwitchV2Bricklet) SwitchSocketC

func (device *RemoteSwitchV2Bricklet) SwitchSocketC(systemCode rune, deviceCode uint8, switchTo SwitchTo) (err 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 <remote_switch_bricklet_type_c_system_and_device_code>`.

Associated constants:

* SwitchToOff
* SwitchToOn

func (*RemoteSwitchV2Bricklet) WriteFirmware

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

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

type RemoteType = uint8
const (
	RemoteTypeA RemoteType = 0
	RemoteTypeB RemoteType = 1
	RemoteTypeC RemoteType = 2
)

type StatusLEDConfig

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

type SwitchTo

type SwitchTo = uint8
const (
	SwitchToOff SwitchTo = 0
	SwitchToOn  SwitchTo = 1
)

type SwitchingState

type SwitchingState = uint8
const (
	SwitchingStateReady SwitchingState = 0
	SwitchingStateBusy  SwitchingState = 1
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL