JavaScript - Remote Switch Bricklet – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
    - C/C++
    - C/C++ (iOS)
    - C#
    - C# (Windows Phone)
    - Delphi/Lazarus
    - Java
    - Java (Android)
    - JavaScript
      - Requirements
      - Installation
      - Testing an Example
      - API Reference and Examples
        - IP Connection
        - Bricks
        - Bricklets
          - Ambient Light Bricklet
          - Analog In Bricklet
          - Analog Out Bricklet
          - Barometer Bricklet
          - Color Bricklet
          - Current12 Bricklet
          - Current25 Bricklet
          - Distance IR Bricklet
          - Distance US Bricklet
          - Dual Button Bricklet
          - Dual Relay Bricklet
          - GPS Bricklet
          - Hall Effect Bricklet
          - Humidity Bricklet
          - Industrial Digital In 4 Bricklet
          - Industrial Digital Out 4 Bricklet
          - Industrial Dual 0-20mA Bricklet
          - Industrial Quad Relay Bricklet
          - IO-16 Bricklet
          - IO-4 Bricklet
          - Joystick Bricklet
          - LCD 16x2 Bricklet
          - LCD 20x4 Bricklet
          - LED Strip Bricklet
          - Line Bricklet
          - Linear Poti Bricklet
          - Moisture Bricklet
          - Motion Detector Bricklet
          - Multi Touch Bricklet
          - NFC/RFID Bricklet
          - Piezo Buzzer Bricklet
          - Piezo Speaker Bricklet
          - PTC Bricklet
          - Remote Switch Bricklet
            - Examples
              - SwitchSocket (Node.js)
              - SwitchSocket (HTML)
            - API
              - Basic Functions
              - Advanced Functions
              - Callback Configuration Functions
              - Callbacks
              - Constants
          - Rotary Encoder Bricklet
          - Rotary Poti Bricklet
          - Segment Display 4x7 Bricklet
          - Solid State Relay Bricklet
          - Sound Intensity Bricklet
          - Temperature Bricklet
          - Temperature IR Bricklet
          - Tilt Bricklet
          - Voltage Bricklet
          - Voltage/Current Bricklet
    - LabVIEW
    - Mathematica
    - MATLAB/Octave
    - Perl
    - PHP
    - Python
    - Ruby
    - Shell
    - Visual Basic .NET
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
  - Wireshark Dissector

# JavaScript - Remote Switch Bricklet

This is the description of the JavaScript 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 JavaScript API bindings is part of their general description.

## Examples

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

### SwitchSocket (Node.js)

Download (ExampleSwitchSocket.js)

     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

    var Tinkerforge = require('tinkerforge');

    var HOST = 'localhost';
    var PORT = 4223;
    var UID = 'jKy'; // Change to your UID

    var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
    var rs = new Tinkerforge.BrickletRemoteSwitch(UID, ipcon); // Create device object

    ipcon.connect(HOST, PORT,
        function(error) {
            console.log('Error: '+error);
        }
    ); // Connect to brickd
    // Don't use device before ipcon is connected

    ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
        function(connectReason) {
            // 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, Tinkerforge.BrickletRemoteSwitch.SWITCH_TO_ON);
        }
    );

    console.log("Press any key to exit ...");
    process.stdin.on('data',
        function(data) {
            ipcon.disconnect();
            process.exit(0);
        }
    );

### SwitchSocket (HTML)

Download (ExampleSwitchSocket.html), Test (ExampleSwitchSocket.html)

     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
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55

    <!DOCTYPE html>
    <html>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
        <head>
            <title>Tinkerforge | JavaScript Example</title>
        </head>
        <body>
            <div style="text-align:center;">
                <h1>Remote Switch Bricklet Switch Socket Example</h1>
                <p>
                    <input value="localhost" id="host" type="text" size="20">:
                    <input value="4280" id="port" type="text" size="5">,
                    <input value="uid" id="uid" type="text" size="5">
                    <input value="Start Example" id="start" type="button" onclick="startExample();">
                </p>
                <p>
                    <textarea id="text" cols="80" rows="24" style="resize:none;"
                              >Press "Start Example" to begin ...</textarea>
                </p>
            <div>
            <script src="./Tinkerforge.js" type='text/javascript'></script>
            <script type='text/javascript'>
                var ipcon;
                var textArea = document.getElementById("text");
                function startExample() {
                    textArea.value = "";
                    var HOST = document.getElementById("host").value;
                    var PORT = parseInt(document.getElementById("port").value);
                    var UID = document.getElementById("uid").value;
                    if(ipcon !== undefined) {
                        ipcon.disconnect();
                    }
                    ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                    var rs = new Tinkerforge.BrickletRemoteSwitch(UID, ipcon); // Create device object
                    ipcon.connect(HOST, PORT,
                        function(error) {
                            textArea.value += 'Error: '+error+ '\n';
                        }
                    ); // Connect to brickd
                    // Don't use device before ipcon is connected

                    ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                        function(connectReason) {
                            // 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, Tinkerforge.BrickletRemoteSwitch.SWITCH_TO_ON);
                        }
                    );
                }
            </script>
        </body>
    </html>

## API

Generally, every method of the JavaScript bindings can take two optional parameters, `returnCallback` and `errorCallback`. These are two user defined callback functions. The `returnCallback` is called with the return values as parameters, if the method returns something. The `errorCallback` is called with an error code in case of an error. The error code can be one of the following values:

- IPConnection.ERROR_ALREADY_CONNECTED = 11
- IPConnection.ERROR_NOT_CONNECTED = 12
- IPConnection.ERROR_CONNECT_FAILED = 13
- IPConnection.ERROR_INVALID_FUNCTION_ID = 21
- IPConnection.ERROR_TIMEOUT = 31
- IPConnection.ERROR_INVALID_PARAMETER = 41
- IPConnection.ERROR_FUNCTION_NOT_SUPPORTED = 42
- IPConnection.ERROR_UNKNOWN_ERROR = 43

The namespace for the JavaScript bindings is `Tinkerforge.*`.

### Basic Functions

new `BrickletRemoteSwitch`(uid, ipcon)

  Parameters:

  - uid -- string
  - ipcon -- IPConnection

  Creates an object with the unique device ID `uid`:

      var remoteSwitch = new BrickletRemoteSwitch("YOUR_DEVICE_UID", ipcon);

  This object can then be used after the IP Connection is connected (see examples above).

`BrickletRemoteSwitch.``switchSocket`(houseCode, receiverCode, switchTo[, returnCallback][, errorCallback])

  Parameters:

  - houseCode -- int
  - receiverCode -- int
  - switchTo -- int

  Callback: | undefined

  This function is deprecated, use `switchSocketA()` instead.

  The following constants are available for this function:

  - BrickletRemoteSwitch.SWITCH_TO_OFF = 0
  - BrickletRemoteSwitch.SWITCH_TO_ON = 1

`BrickletRemoteSwitch.``getSwitchingState`([returnCallback][, errorCallback])

  Callback:

  - state -- int

  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 `switchSocket()` 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:

  - BrickletRemoteSwitch.SWITCHING_STATE_READY = 0
  - BrickletRemoteSwitch.SWITCHING_STATE_BUSY = 1

`BrickletRemoteSwitch.``switchSocketA`(houseCode, receiverCode, switchTo[, returnCallback][, errorCallback])

  Parameters:

  - houseCode -- int
  - receiverCode -- int
  - switchTo -- int

  Callback: | undefined

  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.

  The house code and receiver code have a range of 0 to 31 (5bit).

  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:

  - BrickletRemoteSwitch.SWITCH_TO_OFF = 0
  - BrickletRemoteSwitch.SWITCH_TO_ON = 1

  New in version 2.0.1 (Plugin).

`BrickletRemoteSwitch.``switchSocketB`(address, unit, switchTo[, returnCallback][, errorCallback])

  Parameters:

  - address -- int
  - unit -- int
  - switchTo -- int

  Callback: | undefined

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

  The address has a range of 0 to 67108863 (26bit) and the unit has a range of 0 to 15 (4bit). 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:

  - BrickletRemoteSwitch.SWITCH_TO_OFF = 0
  - BrickletRemoteSwitch.SWITCH_TO_ON = 1

  New in version 2.0.1 (Plugin).

`BrickletRemoteSwitch.``dimSocketB`(address, unit, dimValue[, returnCallback][, errorCallback])

  Parameters:

  - address -- int
  - unit -- int
  - dimValue -- int

  Callback: | undefined

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

  The address has a range of 0 to 67108863 (26bit), the unit and the dim value has a range of 0 to 15 (4bit).

  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).

`BrickletRemoteSwitch.``switchSocketC`(systemCode, deviceCode, switchTo[, returnCallback][, errorCallback])

  Parameters:

  - systemCode -- char
  - deviceCode -- int
  - switchTo -- int

  Callback: | undefined

  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.

  The system code has a range of 'A' to 'P' (4bit) and the device code has a range of 1 to 16 (4bit).

  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:

  - BrickletRemoteSwitch.SWITCH_TO_OFF = 0
  - BrickletRemoteSwitch.SWITCH_TO_ON = 1

  New in version 2.0.1 (Plugin).

### Advanced Functions

`BrickletRemoteSwitch.``setRepeats`(repeats[, returnCallback][, errorCallback])

  Parameters:

  - repeats -- int

  Callback: | undefined

  Sets the number of times the code is send when of the `switchSocket()` 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.

  The default value is 5.

`BrickletRemoteSwitch.``getRepeats`([returnCallback][, errorCallback])

  Callback:

  - repeats -- int

  Returns the number of repeats as set by `setRepeats()`.

`BrickletRemoteSwitch.``getAPIVersion`()

  Return type: | [int, int, int]

  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.

`BrickletRemoteSwitch.``getResponseExpected`(functionId[, errorCallback])

  Parameters:

  - functionId -- int

  Return type: | boolean

  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 send and errors are silently ignored, because they cannot be detected.

  See `setResponseExpected()` for the list of function ID constants available for this function.

`BrickletRemoteSwitch.``setResponseExpected`(functionId, responseExpected[, errorCallback])

  Parameters:

  - functionId -- int
  - responseExpected -- boolean

  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 and callbacks it is always disabled.

  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 send and errors are silently ignored, because they cannot be detected.

  The following function ID constants are available for this function:

  - BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET = 1
  - BrickletRemoteSwitch.FUNCTION_SET_REPEATS = 4
  - BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_A = 6
  - BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_B = 7
  - BrickletRemoteSwitch.FUNCTION_DIM_SOCKET_B = 8
  - BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_C = 9

`BrickletRemoteSwitch.``setResponseExpectedAll`(responseExpected)

  Parameters:

  - responseExpected -- boolean

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

`BrickletRemoteSwitch.``getIdentity`([returnCallback][, errorCallback])

  Callback:

  - uid -- string
  - connectedUid -- string
  - position -- char
  - hardwareVersion -- [int, int, int]
  - firmwareVersion -- [int, int, int]
  - deviceIdentifier -- int

  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' or 'd'.

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

### Callback Configuration Functions

`BrickletRemoteSwitch.``on`(id, callback)

  Parameters:

  - id -- int
  - callback -- function

  Registers a callback with ID id to the function callback. The available IDs with corresponding function signatures are listed below.

### Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the `on()` function of the device object. The first parameter is the callback ID and the second parameter the callback function:

    remoteSwitch.on(BrickletRemoteSwitch.CALLBACK_EXAMPLE,
        function (param) {
            console.log(param);
        }
    );

The available constants with inherent number and type of parameters are described below.

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.

`BrickletRemoteSwitch.``CALLBACK_SWITCHING_DONE`

  This callback is called whenever the switching state changes from busy to ready, see `getSwitchingState()`.

### Constants

`BrickletRemoteSwitch.``DEVICE_IDENTIFIER`

  This constant is used to identify a Remote Switch Bricklet.

  The `getIdentity()` function and the `CALLBACK_ENUMERATE` callback of the IP Connection have a `device_identifier` parameter to specify the Brick's or Bricklet's type.

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.