Skip to main content
X

RAK17001 WisBlock H-Bridge Module Quick Start Guide

Prerequisite​

What Do You Need?​

Before going through each and every step on using the RAK17001 WisBlock H-Bridge Module, make sure to prepare the necessary items listed below:

Hardware​

Software​

Product Configuration​

Hardware Setup​

RAK17001 is a WisBlock Motor Control Module that extends the WisBlock system to be used on controlling DC motor. It has a single H-bridge configuration motor driver that is ideal for low voltage DC motor and battery powered applications. It can get power from the battery of the WisBlock Base or externally via the RAK17001 terminal connector.

By setting the right jumper on the 3-pin header, you can select where you want to get the power source. The 3-pin header is located on the side of the terminal connector. It can allow up to 2.6 A with built-in overcurrent and overtemperature protection.

For more information about RAK17001, refer to the Datasheet.

Motor Driven by the WisBlock Battery​

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 match the polarity on the WisBlock Base board. Not all batteries have the same wiring.

You need to set a header jumper and short VM and BAT. This is to enable power from the battery of the WisBlock module. You can connect one DC motor via A1 and A2 pin of the terminal block.

Figure 1: RAK17001 Powered by WisBlock Battery

Motor Driven by the External VIN​

You need to set header jumper and short VM and VIN to enable power from the external power source. The external power source can be a different battery pack or an independent DC power supply.

Connect this power source to the supply voltage terminals VIN and GND of RAK17001. Make sure that the voltage terminals are suitable for the range from 1.8 V to 10 V. Once done on the setup, you can connect one DC motor via A1 and A2 pin of the terminal block.

Figure 2: RAK17001 Powered by External Voltage Source

Assembling and Disassembling of WisBlock Modules​

Assembling​

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

Figure 3: RAK17001 mounting connection to a WisBlock Base module
Disassembling Procedure​

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

  1. To begin disassembling, remove the screws.
Figure 4: Removing screws from the WisBlock module
  1. After removing the screws, check the silkscreen of the module to find the correct location where force can be applied.
Figure 5: Detaching silkscreen on the WisBlock module
  1. Detach the module from the baseboard by applying force to the module at the position of the connector, as shown in Figure 6.
Figure 6: 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.

After all this setup, you can now connect the battery and USB cable to start programming your WisBlock Core.

Software Configuration and Example​

RAK17001 in RAK4631 WisBlock Core Guide​

Arduino Setup​

After doing the hardware setup, this example code will work both for WisBlock battery-powered motor or an external power source. This will control the DC motor connected via terminal connector. The module will spin the motor clockwise then counterclockwise direction repeatedly.

  1. To begin with the Arduino setup, you need to select the RAK4631 WisBlock Core.
Figure 7: Selecting RAK4631 as the WisBlock Core
  1. Next, copy the following sample code into your Arduino IDE. This example code comes from the RAK17001 WisBlock example repository which demonstrates basic usage of RAK17001 module.
/**
   @file RAK17001_HBridge_STSPIN250.ino
   @author rakwireless.com
   @brief Control the one motors for forward and reverse rotation from slow to fast and then from fast to slow.
   @version 0.1
   @date 2022-05-05
   @copyright Copyright (c) 2022
**/

#include <Arduino.h>
#if defined NRF52_SERIES
#include <LoRaWan-RAK4630.h>                //http://librarymanager/All#SX126x
#elif defined ARDUINO_ARCH_RP2040
#include <LoRaWan-Arduino.h>
#elif defined ESP32
#endif
#define STSPIN250_PH           WB_IO4        //the PH pin determines the direction of the current
#define STSPIN250_PWM          WB_IO3        //the PWM pin can be used to regulate the speed of the rotation
#define STSPIN250_FAULT_CHECK  WB_IO5
#define STSPIN250_EN           WB_IO6
#define FAULT_CHECK_COUNT      4             // if four protection interrupts detected within 5 seconds, Sensor may be thermal shutdown or Overcurrent and short-circuit protections
#define FAULT_CHECK_INTERVAL   5000          //value in [ms] ,


TimerEvent_t appTimer;
static uint32_t timers_init(void);
volatile uint16_t InterruptCount = 0;
volatile int old_time = 0;
volatile int new_time = 0;
bool TimerFlag = false;

void setup()
{
  //Sensor power control
  pinMode(WB_IO2, OUTPUT);
  digitalWrite(WB_IO2, HIGH);
  delay(300);

  pinMode(LED_BLUE, OUTPUT);
  digitalWrite(LED_BLUE, LOW);
  Serial.begin(115200);
  time_t timeout = millis();
  while (!Serial)
  {
    if ((millis() - timeout) < 5000)
    {
      delay(100);
    }
    else
    {
      break;
    }
  }
  Serial.println("RAK17001 Hbridege Test!");

  //creat a user timer
  uint32_t err_code;
  err_code = timers_init();
  if (err_code != 0)
  {
    Serial.printf("timers_init failed - %d\n", err_code);
    return;
  }

  pinMode(STSPIN250_PH, OUTPUT);
  digitalWrite(STSPIN250_PH, HIGH);

  pinMode(STSPIN250_PWM, OUTPUT);
  digitalWrite(STSPIN250_PWM, LOW);

  pinMode(STSPIN250_EN, OUTPUT);
  digitalWrite(STSPIN250_EN, HIGH);//if set STSPIN250_EN High,sensor work normal.if set LOW, Sensors enter low power mode.
  //   digitalWrite(STSPIN250_EN, LOW);

  pinMode(STSPIN250_FAULT_CHECK, INPUT);
  attachInterrupt(digitalPinToInterrupt(STSPIN250_FAULT_CHECK), motor_interrupt, FALLING);

  TimerSetValue(&appTimer, FAULT_CHECK_INTERVAL);
  TimerStart(&appTimer);
  delay(100);
}

void loop()
{
  if (TimerFlag)//Thermal shutdown or Overcurrent and short-circuit protections
  {
    InterruptCount = 0;
    digitalWrite(LED_BLUE, HIGH);
    Serial.println("Sensor thermal shutdown or Overcurrent and short-circuit protections,Please check it！！！");
    delay(500);
    return;
  }
  else
  {
    if (digitalRead(STSPIN250_EN) == 1)
    {
      digitalWrite(STSPIN250_PH, HIGH);  //The motor rotates clockwise
      Serial.println("The motor turns clockwise");
      for (uint8_t i = 50 ; i < 255 ; i++ )
      {
        analogWrite(STSPIN250_PWM, i);
        delay(35);
      }
      delay(100);
      for (uint8_t i = 255 ; i > 0 ; i-- )
      {
        analogWrite(STSPIN250_PWM, i);
        delay(35);
      }

      digitalWrite(STSPIN250_PH, LOW);//Counterclockwise rotation of motor
      Serial.println("The motor turns Counterclockwise ");
      for (uint8_t i = 50 ; i < 255 ; i++ )
      {
        analogWrite(STSPIN250_PWM, i);
        delay(35);
      }
      delay(100);
      for (uint8_t i = 255 ; i > 0 ; i-- )
      {
        analogWrite(STSPIN250_PWM, i);
        delay(35);
      }
    }
    else
    {
      Serial.println("please exit the low-power mode ");
      delay(1000);
    }
  }
}


void motor_interrupt() {
  old_time = new_time;
  new_time = millis();
  if (new_time - old_time >= 100)
    InterruptCount++;
}


/**@brief Function for handling user timerout event.
*/
void motor_check_periodic_handler(void)
{
  TimerSetValue(&appTimer, FAULT_CHECK_INTERVAL);
  TimerStart(&appTimer);
  Serial.print("InterruptCount=");
  Serial.println(InterruptCount);
  if (InterruptCount >= FAULT_CHECK_COUNT)
  {
    Serial.print("InterruptCount1=");
    Serial.println(InterruptCount);
    TimerFlag = true;
  }
  InterruptCount = 0;
}

/**@brief Function for the Timer initialization.
   @details Initializes the timer module. This creates and starts application timers.
*/
uint32_t timers_init(void)
{
  TimerInit(&appTimer, motor_check_periodic_handler);
  return 0;
}
NOTE

If you experience any error in compiling the example sketch, check the updated code for the RAK4631 WisBlock Core Module that can be found on the RAK17001 Motor Driver Example WisBlock Repository.

  1. Then you can now select the right port and upload the code, as shown in Figure 8 and Figure 9.
Figure 8: Selecting the correct Serial Port
Figure 9: Uploading the RAK17001 Sample code
  1. When you have successfully uploaded the example sketch, you'll now see that the motor will start spinning and reversing direction repeatedly.

The direction is based on how the wires of DC motor is connected. It should be connected to the A1 and A2 pin of RAK17001 terminal block. You can reverse the direction by interchanging the wire connection.

Figure 10: Serial monitor logs

RAK17001 in RAK11200 WisBlock Core Guide​

Arduino Setup​

After doing the hardware setup, this example code will work both for WisBlock battery-powered motor or an external power source. This will control the DC motor connected via terminal connector. The module will spin the motor clockwise then counterclockwise direction repeatedly.

  1. To start with the Arduino setup, you need to select the RAK11200 WisBlock Core.
Figure 11: Selecting RAK11200 as the WisBlock Core
  1. Next, copy the following sample code into your Arduino IDE. This example code comes from the RAK17001 WisBlock example repository which demonstrates basic usage of RAK17001 module.
/**
   @file RAK17001_HBridge_STSPIN250.ino
   @author rakwireless.com
   @brief Control the one motors for forward and reverse rotation from slow to fast and then from fast to slow.
   @version 0.1
   @date 2022-05-05
   @copyright Copyright (c) 2022
**/

#include <Arduino.h>

#define STSPIN250_PH           WB_IO4        //the PH pin determines the direction of the current
#define STSPIN250_PWM          WB_IO3        //the PWM pin can be used to regulate the speed of the rotation
#define STSPIN250_FAULT_CHECK  WB_IO5
#define STSPIN250_EN           WB_IO6

#define FAULT_CHECK_COUNT      4             // if four protection interrupts detected within 5 seconds, Sensor may be thermal shutdown or Overcurrent and short-circuit protections
volatile uint16_t  InterruptCount = 0;
volatile int old_time = 0;
volatile int new_time = 0;
hw_timer_t *tim1 = NULL;
bool TimerFlag = false;
// use first channel of 16 channels (started from zero)
#define LEDC_CHANNEL_0  0

// use 13 bit precission for LEDC timer
#define LEDC_TIMER_13_BIT  13

// use 5000 Hz as a LEDC base frequency
#define LEDC_BASE_FREQ     5000

/**
   @brief  Arduino like analogWrite. 
*/
void ledcAnalogWrite(uint8_t channel, uint32_t value, uint32_t valueMax = 255)
{
  // calculate duty, 8191 from 2 ^ 13 - 1
  uint32_t duty = (8191 / valueMax) * min(value, valueMax);

  // write duty to LEDC
  ledcWrite(channel, duty);
}

void setup()
{
  //Sensor power control
  pinMode(WB_IO2, OUTPUT);
  digitalWrite(WB_IO2, HIGH);
  delay(300);

  pinMode(LED_BLUE, OUTPUT);
  digitalWrite(LED_BLUE, LOW);
  Serial.begin(115200);
  time_t timeout = millis();
  while (!Serial)
  {
    if ((millis() - timeout) < 5000)
    {
      delay(100);
    }
    else
    {
      break;
    }
  }
  Serial.println("RAK17001 Test!");

  tim1 = timerBegin(0, 80, true);
  timerAttachInterrupt(tim1, tim1Interrupt, true);
  timerAlarmWrite(tim1, 500000ul, true);
  timerAlarmEnable(tim1);

  pinMode(STSPIN250_PH, OUTPUT);
  digitalWrite(STSPIN250_PH, HIGH);

  pinMode(STSPIN250_PWM, OUTPUT);
  digitalWrite(STSPIN250_PWM, LOW);

  pinMode(STSPIN250_EN, OUTPUT);
  digitalWrite(STSPIN250_EN, HIGH);//if set STSPIN250_EN High,sensor work normal.if set LOW, Sensors enter low power mode.

  pinMode(STSPIN250_FAULT_CHECK, INPUT);
  attachInterrupt(digitalPinToInterrupt(STSPIN250_FAULT_CHECK), motor_interrupt, FALLING);
  delay(300);

  ledcSetup(LEDC_CHANNEL_0, LEDC_BASE_FREQ, LEDC_TIMER_13_BIT); // Set channel 0

  ledcAttachPin(STSPIN250_PWM, LEDC_CHANNEL_0);
}
void loop()
{
  if (TimerFlag)//Thermal shutdown or Overcurrent and short-circuit protections
  {
    InterruptCount = 0;
    digitalWrite(LED_BLUE, HIGH);
    Serial.println("Sensor thermal shutdown or Overcurrent and short-circuit protections,Please check it！！！");
    delay(500);
    return;
  }
  else
  {
    if (digitalRead(STSPIN250_EN) == 1)
    {
      digitalWrite(STSPIN250_PH, HIGH);  //The motor rotates clockwise
      Serial.println("The motor turns clockwise");
      for (uint8_t i = 50 ; i < 255 ; i++ )
      {
        ledcAnalogWrite(LEDC_CHANNEL_0, i);
        delay(50);
      }
      delay(100);
      for (uint8_t i = 255 ; i > 0 ; i-- )
      {
        ledcAnalogWrite(LEDC_CHANNEL_0, i);
        delay(50);
      }

      digitalWrite(STSPIN250_PH, LOW);//Counterclockwise rotation of motor
      Serial.println("The motor turns Counterclockwise ");
      for (uint8_t i = 50 ; i < 255 ; i++ )
      {
        ledcAnalogWrite(LEDC_CHANNEL_0, i);
        delay(50);
      }
      delay(100);
      for (uint8_t i = 255 ; i > 0 ; i-- )
      {
        ledcAnalogWrite(LEDC_CHANNEL_0, i);
        delay(50);
      }
    }
    else
    {
      Serial.println("please exit the low-power mode ");
      delay(1000);
    }
  }
}

void tim1Interrupt()
{
  if (InterruptCount)
  {
    if (InterruptCount >= FAULT_CHECK_COUNT)  // if three protection interrupts detected within 5 seconds, Sensor may be thermal shutdown or Overcurrent and short-circuit protections
    {
      TimerFlag = true;
      //    Serial.print("timerAlarmEnabled=");
      //    Serial.println(timerAlarmEnabled(tim1));
    }
  }
}

void motor_interrupt() {
  old_time = new_time;
  new_time = millis();
  if (new_time - old_time >= 100)
    InterruptCount++;
}
NOTE

If you experience any error in compiling the example sketch, check the updated code for the RAK11200 WisBlock Core Module. You can find it on the RAK17001 Motor Driver Example WisBlock Repository.

  1. Then you can now select the right port and upload the code, as shown in Figure 12 and Figure 13.
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 12: Selecting the correct Serial Port
Figure 13: Uploading the RAK17001 Sample code
  1. When you have successfully uploaded the example sketch, you'll now see that the motor will start spinning and reversing direction repeatedly.

The direction is based on how the wires of DC motor is connected. It should be connected to the A1 and A2 pin of RAK17001 terminal block. You can reverse the direction by interchanging the wire connection.

Figure 14: Serial monitor logs

RAK17001 in RAK11310 WisBlock Core Guide​

Arduino Setup​

After doing the hardware setup, this example code will work both for WisBlock battery-powered motor or an external power source. This will control the DC motor connected via terminal connector. The module will spin the motor clockwise then counterclockwise direction repeatedly.

  1. To begin with the Arduino setup, you need to select the RAK11310 WisBlock Core.
Figure 15: Selecting RAK11310 as the WisBlock Core
  1. Next, copy the following sample code into your Arduino IDE. This example code comes from the RAK17001 WisBlock example repository which demonstrates basic usage of RAK17001 module.
/**
   @file RAK17001_HBridge_STSPIN250.ino
   @author rakwireless.com
   @brief Control the one motors for forward and reverse rotation from slow to fast and then from fast to slow.
   @version 0.1
   @date 2022-05-05
   @copyright Copyright (c) 2022
**/

#include <Arduino.h>
#if defined NRF52_SERIES
#include <LoRaWan-RAK4630.h>                //http://librarymanager/All#SX126x
#elif defined ARDUINO_ARCH_RP2040
#include <LoRaWan-Arduino.h>
#elif defined ESP32
#endif
#define STSPIN250_PH           WB_IO4        //the PH pin determines the direction of the current
#define STSPIN250_PWM          WB_IO3        //the PWM pin can be used to regulate the speed of the rotation
#define STSPIN250_FAULT_CHECK  WB_IO5
#define STSPIN250_EN           WB_IO6
#define FAULT_CHECK_COUNT      4             // if four protection interrupts detected within 5 seconds, Sensor may be thermal shutdown or Overcurrent and short-circuit protections
#define FAULT_CHECK_INTERVAL   5000          //value in [ms] ,


TimerEvent_t appTimer;
static uint32_t timers_init(void);
volatile uint16_t InterruptCount = 0;
volatile int old_time = 0;
volatile int new_time = 0;
bool TimerFlag = false;

void setup()
{
  //Sensor power control
  pinMode(WB_IO2, OUTPUT);
  digitalWrite(WB_IO2, HIGH);
  delay(300);

  pinMode(LED_BLUE, OUTPUT);
  digitalWrite(LED_BLUE, LOW);
  Serial.begin(115200);
  time_t timeout = millis();
  while (!Serial)
  {
    if ((millis() - timeout) < 5000)
    {
      delay(100);
    }
    else
    {
      break;
    }
  }
  Serial.println("RAK17001 Hbridege Test!");

  //creat a user timer
  uint32_t err_code;
  err_code = timers_init();
  if (err_code != 0)
  {
    Serial.printf("timers_init failed - %d\n", err_code);
    return;
  }

  pinMode(STSPIN250_PH, OUTPUT);
  digitalWrite(STSPIN250_PH, HIGH);

  pinMode(STSPIN250_PWM, OUTPUT);
  digitalWrite(STSPIN250_PWM, LOW);

  pinMode(STSPIN250_EN, OUTPUT);
  digitalWrite(STSPIN250_EN, HIGH);//if set STSPIN250_EN High,sensor work normal.if set LOW, Sensors enter low power mode.
  //   digitalWrite(STSPIN250_EN, LOW);

  pinMode(STSPIN250_FAULT_CHECK, INPUT);
  attachInterrupt(digitalPinToInterrupt(STSPIN250_FAULT_CHECK), motor_interrupt, FALLING);

  TimerSetValue(&appTimer, FAULT_CHECK_INTERVAL);
  TimerStart(&appTimer);
  delay(100);
}

void loop()
{
  if (TimerFlag)//Thermal shutdown or Overcurrent and short-circuit protections
  {
    InterruptCount = 0;
    digitalWrite(LED_BLUE, HIGH);
    Serial.println("Sensor thermal shutdown or Overcurrent and short-circuit protections,Please check it！！！");
    delay(500);
    return;
  }
  else
  {
    if (digitalRead(STSPIN250_EN) == 1)
    {
      digitalWrite(STSPIN250_PH, HIGH);  //The motor rotates clockwise
      Serial.println("The motor turns clockwise");
      for (uint8_t i = 50 ; i < 255 ; i++ )
      {
        analogWrite(STSPIN250_PWM, i);
        delay(35);
      }
      delay(100);
      for (uint8_t i = 255 ; i > 0 ; i-- )
      {
        analogWrite(STSPIN250_PWM, i);
        delay(35);
      }

      digitalWrite(STSPIN250_PH, LOW);//Counterclockwise rotation of motor
      Serial.println("The motor turns Counterclockwise ");
      for (uint8_t i = 50 ; i < 255 ; i++ )
      {
        analogWrite(STSPIN250_PWM, i);
        delay(35);
      }
      delay(100);
      for (uint8_t i = 255 ; i > 0 ; i-- )
      {
        analogWrite(STSPIN250_PWM, i);
        delay(35);
      }
    }
    else
    {
      Serial.println("please exit the low-power mode ");
      delay(1000);
    }
  }
}


void motor_interrupt() {
  old_time = new_time;
  new_time = millis();
  if (new_time - old_time >= 100)
    InterruptCount++;
}


/**@brief Function for handling user timerout event.
*/
void motor_check_periodic_handler(void)
{
  TimerSetValue(&appTimer, FAULT_CHECK_INTERVAL);
  TimerStart(&appTimer);
  Serial.print("InterruptCount=");
  Serial.println(InterruptCount);
  if (InterruptCount >= FAULT_CHECK_COUNT)
  {
    Serial.print("InterruptCount1=");
    Serial.println(InterruptCount);
    TimerFlag = true;
  }
  InterruptCount = 0;
}

/**@brief Function for the Timer initialization.
   @details Initializes the timer module. This creates and starts application timers.
*/
uint32_t timers_init(void)
{
  TimerInit(&appTimer, motor_check_periodic_handler);
  return 0;
}
NOTE

If you experience any error in compiling the example sketch, check the updated code for the RAK11310 WisBlock Core Module that can be found on the RAK17001 Motor Driver Example WisBlock Repository.

  1. Then you can now select the right port and upload the code, as shown in Figure 16 and Figure 17.
Figure 16: Selecting the correct Serial Port
Figure 17: Uploading the RAK17001 Sample code
  1. When you have successfully uploaded the example sketch, you'll now see that the motor will start spinning and reversing direction repeatedly.

The direction is based on how the wires of DC motor is connected. It should be connected to the A1 and A2 pin of RAK17001 terminal block. You can reverse the direction by interchanging the wire connection.

Figure 18: Serial monitor logs