remote_switch_bricklet

func (*RemoteSwitchBricklet) DeregisterSwitchingDoneCallback ¶

func (device *RemoteSwitchBricklet) DeregisterSwitchingDoneCallback(registrationId uint64)

Remove a registered Switching Done callback.

func (*RemoteSwitchBricklet) DimSocketB ¶

func (device *RemoteSwitchBricklet) 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>`.

.. versionadded:: 2.0.1$nbsp;(Plugin)

func (*RemoteSwitchBricklet) GetAPIVersion ¶

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

func (device *RemoteSwitchBricklet) 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 (*RemoteSwitchBricklet) GetRepeats ¶

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

Returns the number of repeats as set by SetRepeats.

func (*RemoteSwitchBricklet) GetResponseExpected ¶

func (device *RemoteSwitchBricklet) 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 (*RemoteSwitchBricklet) GetSwitchingState ¶

func (device *RemoteSwitchBricklet) 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 requests to switch sockets 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 (*RemoteSwitchBricklet) RegisterSwitchingDoneCallback ¶

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

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

func (*RemoteSwitchBricklet) SetRepeats ¶

func (device *RemoteSwitchBricklet) 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 (*RemoteSwitchBricklet) SetResponseExpected ¶

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

func (device *RemoteSwitchBricklet) SetResponseExpectedAll(responseExpected bool)

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

func (*RemoteSwitchBricklet) SwitchSocket ¶

func (device *RemoteSwitchBricklet) SwitchSocket(houseCode uint8, receiverCode uint8, switchTo SwitchTo) (err error)

This function is deprecated, use SwitchSocketA instead.

Associated constants:

• SwitchToOff
• SwitchToOn

func (*RemoteSwitchBricklet) SwitchSocketA ¶

func (device *RemoteSwitchBricklet) 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>`.

.. versionadded:: 2.0.1$nbsp;(Plugin)

Associated constants:

• SwitchToOff
• SwitchToOn

func (*RemoteSwitchBricklet) SwitchSocketB ¶

func (device *RemoteSwitchBricklet) 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>`.

.. versionadded:: 2.0.1$nbsp;(Plugin)

Associated constants:

• SwitchToOff
• SwitchToOn

func (*RemoteSwitchBricklet) SwitchSocketC ¶

func (device *RemoteSwitchBricklet) 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>`.

.. versionadded:: 2.0.1$nbsp;(Plugin)

Associated constants:

• SwitchToOff
• SwitchToOn