RAK13001 WisBlock Relay IO Module Quick Start Guide

Prerequisite

What Do You Need?

Before going through each and every step on using the RAK13001 WisBlock module, make sure to prepare the necessary items listed below:

Hardware

• RAK13001 WisBlock Relay IO Module
• WisBlock Base
• Your choice of WisBlock Core
• USB Cable
• Li-Ion/LiPo battery (optional)
• Solar charger (optional)
• LED
• 1 kΩ Resistor

Software

Arduino

• You need to download and install Arduino IDE.
• To add the RAKwireless Core boards on your Arduino Boards Manager, install the RAKwireless Arduino BSP.

Product Configuration

Block Diagram

The RAK13001 uses one relay to isolate the output of MCU. The dielectric strength between coil and contacts of a relay is 4000 VAC 1min.

For input, RAK13001 uses an opto-couple as isolation, and it supports wet contact as default. The rating of input is 12 V-24 VDC. It also can be configured as dry contact by reworking some resistors on the PCB module as instructed in the datasheet. The relay has a maximum rating of 130 VAC / 30 VDC.

Figure 2962: RAK13001 Block Diagram

warning

Figure 2963: Safety Precaution

Hardware Setup

RAK13001 is a WisBlock Interface module that extends the WisBlock system to be used on isolated digital input and output applications. There is one digital output that is isolated by an electromechanical relay which is used to programmatically switch on/off devices operating at high voltage or current applications and one digital input isolated by an opto-couple. The isolated input can be configured as wet contact (default mode) or dry contact.

For more information about RAK13001, refer to the Datasheet.

Pin Definition

Figure 2964: RAK13001 Pin Definition

NOTE

• NO1 and NO2 are Output contacts for the Relay.
• K1 and K2 are Input contacts for the Opto-coupler.

Assembling and Disassembling of WisBlock Modules

Assembling Procedure

The RAK13001 module can be mounted on the IO slot of the WisBlock Base board as shown in Figure 4. Also, always secure the connection of the WisBlock module by using compatible screws.

Figure 2965: RAK13001 mounting connection to WisBlock Base module

RAK13001 Connector Crimping Mechanism

The RAK13001 features a fast-crimping terminal connector to simplify and ensure the wiring process on the fields. The fast-crimping terminal can support cable with a width between 20 AWG to 24 AWG. The usual stripping length is around 6 to 7 mm.

As shown in Figure 5, during the crimping process, you should first press down and maintain the spring head of the crimping terminal firmly, then insert the stripped cable head into the corresponding connector’s hole. Once inserted correctly, release the spring head, and the crimping process is completed.

Figure 2966: RAK13001 Module Connector

Disassembling Procedure

The procedure in disassembling any type of WisBlock modules is the same.

1. First, remove the screws.

Figure 2967: Removing screws from the WisBlock module

2. Once the screws are removed, check the silkscreen of the module to find the correct location where force can be applied.

Figure 2968: Detaching silkscreen on the WisBlock module

3. Apply force to the module at the position of the connector, as shown in Figure 8, to detach the module from the baseboard.

Figure 2969: Applying even forces on the proper location of a WisBlock module

NOTE

If you will connect other modules to the remaining WisBlock Base slots, check on the WisBlock Pin Mapper tool for possible conflicts.

Now, you can connect the battery (optional) and USB cable to start programming your WisBlock Core.

warning

• Batteries can cause harm if not handled properly.
• Only 3.7-4.2 V Rechargeable LiPo batteries are supported. It is highly recommended not to use other types of batteries with the system unless you know what you are doing.
• If a non-rechargeable battery is used, it has to be unplugged first before connecting the USB cable to the USB port of the board to configure the device. Not doing so might damage the battery or cause a fire.
• Only 5 V solar panels are supported. Do not use 12 V solar panels. It will destroy the charging unit and eventually other electronic parts.
• Make sure the battery wires are matching the polarity on the WisBlock Base board. Not all batteries have the same wiring.

Software Configuration and Example

In our example, you will be using the relay as wet contact. Before connecting high voltage modules to the RAK13001, make sure to follow safety precautions.

For RAK13001, the accessible pin assignments are defined as follows in the Arduino IDE:

• WB_IO3 for Optocoupler Input pin
• WB_IO4 for Relay Output pin

These are the quick links that go directly to the software guide for the specific WisBlock Core module you use:

• RAK13001 in RAK4631 WisBlock Core Guide
• RAK13001 in RAK11200 WisBlock Core Guide
• RAK13001 in RAK11310 WisBlock Core Guide

RAK13001 in RAK4631 WisBlock Core Guide

Arduino Setup

Figure 9 is an illustration on how to use the RAK13001 relay for switching applications. You can connect any module to the RAK13001 as long as it operates on its recommended voltage rating.

Figure 2970: RAK13001 switching the LED

1. First, you need to select the RAK4631 WisBlock Core.

Figure 2971: Selecting RAK4631 as WisBlock Core

2. Next, copy the following sample code into your Arduino IDE:

Click to view the code

/**
   @file RAK13001_Relay_OUT_Optocoupled_IN.ino
   @author rakwireless.com
   @brief Relay output optocoupler input.
   @version 0.1
   @date 2021-3-18
   @copyright Copyright (c) 2021
**/

#define OC_PIN    WB_IO3
#define RELAY_PIN WB_IO4

void setup()
{
  pinMode(WB_IO2, OUTPUT);
  digitalWrite(WB_IO2, HIGH);

  // Initialize Serial for debug output
  time_t timeout = millis();
  Serial.begin(115200);
  while (!Serial)
  {
    if ((millis() - timeout) < 5000)
    {
      delay(100);
    }
    else
    {
      break;
    }
  }

  pinMode(RELAY_PIN,OUTPUT);
  pinMode(OC_PIN,INPUT);
}

void loop()
{
  static uint8_t count=0;
  count++;
  if(count == 5)
  {
    digitalWrite( RELAY_PIN , LOW);
  }
  if(count == 10)
  {
    count=0;
    digitalWrite( RELAY_PIN , HIGH);
  }

  if(digitalRead(OC_PIN) == LOW)
  {
    Serial.println("Optocoupled PIN IN Low");
  }

  delay(1000);
}

NOTE

If you experience any error in compiling the example sketch, check the updated code for your WisBlock Core Module that can be found on the RAK13001 WisBlock Example Code Repository.

3. Then you can now select the right port and upload the code, as shown in Figure 11 and Figure 12.

Figure 2972: Selecting the correct Serial Port

Figure 2973: Uploading the RAK13001 Sample code

4. When you successfully uploaded the example sketch, you'll now be to see that the RAK13001 Relay module switches the LED on and off every 5 seconds. You'll also be able to hear clicking sounds from the RAK13001 module which means that the relay is switching.

RAK13001 in RAK11200 WisBlock Core Guide

Arduino Setup

Figure 13 is an illustration on how to use the RAK13001 relay for switching applications. You can connect any module to the RAK13001 as long as it operates on its recommended voltage rating.

Figure 2974: RAK13001 switching the LED

1. First, you need to select the RAK11200 WisBlock Core.

Figure 2975: Selecting RAK11200 as WisBlock Core

2. Next, copy the following sample code into your Arduino IDE:

Click to view the code

/**
   @file RAK13001_Relay_OUT_Optocoupled_IN.ino
   @author rakwireless.com
   @brief Relay output optocoupler input.
   @version 0.1
   @date 2021-3-18
   @copyright Copyright (c) 2021
**/

#define OC_PIN    WB_IO3
#define RELAY_PIN WB_IO4

void setup()
{
  pinMode(WB_IO2, OUTPUT);
  digitalWrite(WB_IO2, HIGH);

  // Initialize Serial for debug output
  time_t timeout = millis();
  Serial.begin(115200);
  while (!Serial)
  {
    if ((millis() - timeout) < 5000)
    {
      delay(100);
    }
    else
    {
      break;
    }
  }

  pinMode(RELAY_PIN,OUTPUT);
  pinMode(OC_PIN,INPUT);
}

void loop()
{
  static uint8_t count=0;
  count++;
  if(count == 5)
  {
    digitalWrite( RELAY_PIN , LOW);
  }
  if(count == 10)
  {
    count=0;
    digitalWrite( RELAY_PIN , HIGH);
  }

  if(digitalRead(OC_PIN) == LOW)
  {
    Serial.println("Optocoupled PIN IN Low");
  }

  delay(1000);
}

NOTE

If you experience any error in compiling the example sketch, check the updated code for your WisBlock Core Module that can be found on the RAK13001 WisBlock Example Code Repository.

3. Then you can now select the right port and upload the code, as shown in Figure 15 and Figure 16.

NOTE

RAK11200 requires the Boot0 pin to be configured properly first before uploading. If not done properly, uploading the source code to RAK11200 will fail. Check the full details on the RAK11200 quick start guide.

Figure 2976: Selecting the correct Serial Port

Figure 2977: Uploading the RAK13001 Sample code

4. When you successfully uploaded the example sketch, you'll now be to see that the RAK13001 Relay module switches the LED on and off every 5 seconds. You'll also be able to hear clicking sounds from the RAK13001 module which means that the relay is switching.

RAK13001 in RAK11310 WisBlock Core Guide

Arduino Setup

Figure 17 is an illustration on how to use the RAK13001 relay for switching applications. You can connect any module to the RAK13001 as long as it operates on its recommended voltage rating.

Figure 2978: RAK13001 switching the LED

1. First, you need to select the RAK11310 WisBlock Core.

Figure 2979: Selecting RAK11310 as WisBlock Core

2. Next, copy the following sample code into your Arduino IDE:

Click to view the code

/**
   @file RAK13001_Relay_OUT_Optocoupled_IN.ino
   @author rakwireless.com
   @brief Relay output optocoupler input.
   @version 0.1
   @date 2021-3-18
   @copyright Copyright (c) 2021
**/

#define OC_PIN    WB_IO3
#define RELAY_PIN WB_IO4

void setup()
{
  pinMode(WB_IO2, OUTPUT);
  digitalWrite(WB_IO2, HIGH);

  // Initialize Serial for debug output
  time_t timeout = millis();
  Serial.begin(115200);
  while (!Serial)
  {
    if ((millis() - timeout) < 5000)
    {
      delay(100);
    }
    else
    {
      break;
    }
  }

  pinMode(RELAY_PIN,OUTPUT);
  pinMode(OC_PIN,INPUT);
}

void loop()
{
  static uint8_t count=0;
  count++;
  if(count == 5)
  {
    digitalWrite( RELAY_PIN , LOW);
  }
  if(count == 10)
  {
    count=0;
    digitalWrite( RELAY_PIN , HIGH);
  }

  if(digitalRead(OC_PIN) == LOW)
  {
    Serial.println("Optocoupled PIN IN Low");
  }

  delay(1000);
}

NOTE

If you experience any error in compiling the example sketch, check the updated code for your WisBlock Core Module that can be found on the RAK13001 WisBlock Example Code Repository.

3. Then you can now select the right port and upload the code, as shown in Figure 19 and Figure 20.

Figure 2980: Selecting the correct Serial Port

Figure 2981: Uploading the RAK13001 Sample code

4. When you successfully uploaded the example sketch, you'll now be to see that the RAK13001 Relay module switches the LED on and off every 5 seconds. You'll also be able to hear clicking sounds from the RAK13001 module which means that the relay is switching.