ST / Mbed 2 deprecated HelloWorld_IPS02A1

Simple demo example of X-NUCLEO-IPS02A1 24V Intelligent Power Switch Library usage.

Dependencies:   X_NUCLEO_IPS02A1 mbed

Fork of HelloWorld_IPS02A1 by ST Expansion SW Team

HelloWorld_IPS02A1, demo example for IPS02A1 expansion board

Introduction

This example application provides a basic code to show how to use the X-NUCLEO-IPS02A1 Intelligent Power Switch Expansion Board. The example performs current measurements on output Channel 1 (Ch1) and Channel 2 (Ch2), continuously, in the following conditions:

  • 1) Ch1 OFF, Ch2 OFF
  • 2) Ch1 ON, Ch2 OFF
  • 3) Ch1 OFF, Ch2 ON
  • 4) Ch1 ON, Ch2 ON

for each configuration the Current for each channel is displayed over an opened console (use Hyperterminal or whatever, set 9600 as bauds, 8-bit data, no parity)

Demo Code

The basic operation done by the demo code, which can be used in the customer application are :

1) In order to use get the singleton instance of the X_NUCLEO_IPS02A1 by calling class method `Instance()`:

// IPS expansion board singleton instance
static X_NUCLEO_IPS02A1 *ips_expansion_board = X_NUCLEO_IPS02A1::Instance();

2) Switch-on or Switch-off loads output (Channel 1 or Channel 2) by setting or clearing associated digital input :

            ips_expansion_board.vps2535h.In_1 = 1; // switch-on Channel 1
            ips_expansion_board.vps2535h.In_2 = 0; // switch-off Channel 2

3) Read Current circulating on Channel 1 or Channel 2 and print on the Terminal

            Multisense_Signal= ips_expansion_board.GetCurrent(CHANNEL_1);
            printf("Current Ch1 = %2.3fA \n\r", Multisense_Signal);
            Multisense_Signal= ips_expansion_board.GetCurrent(CHANNEL_2);
            printf("Current Ch2 = %2.3fA \n\r", Multisense_Signal);

main.cpp

Committer:
Davidroid
Date:
2017-07-13
Revision:
10:4bf9e0e0dd69
Parent:
9:60a0bf4a5681

File content as of revision 10:4bf9e0e0dd69:

/**
 ******************************************************************************
 * @file    main.cpp
 * @author  ADG
 * @version V1.0.1
 * @date    01-July-2016
 * @brief   Example application for using the X_NUCLEO_IPS02A1 
 *          Intelligent Power Switch Nucleo expansion board.
 ******************************************************************************
 * @attention
 *
 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *   1. Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *   2. Redistributions in binary form must reproduce the above copyright notice,
 *      this list of conditions and the following disclaimer in the documentation
 *      and/or other materials provided with the distribution.
 *   3. Neither the name of STMicroelectronics nor the names of its contributors
 *      may be used to endorse or promote products derived from this software
 *      without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 *  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 ******************************************************************************
*/ 
 
/**
 * @mainpage X_NUCLEO_IPS02A1 Intelligent Power Switch Nucleo Expansion Board Firmware Package
 *
 * <b>Introduction</b>
 *
 * This firmware package includes Components Device Drivers, Board Support Package
 * and example application for STMicroelectronics X_NUCLEO_IPS02A1 Intelligent Power Switch
 * Nucleo Expansion Board
 * 
 * <b>Example Application</b>
 *
 */


/*** Includes ----------------------------------------------------------------- ***/

#include "mbed.h"
#include "assert.h"
#include "XNucleoIPS02A1.h"
 

/*** Static variables --------------------------------------------------------- ***/

#ifdef DBG_MCU
#include "DbgMCU.h"
static DbgMCU enable_dbg;
#endif // DBG_MCU
 
/* HW settings */
/* Pay attention before changing HW settings, they must be coherent with you HW design */
/* Power Switch Connection to Arduino connectors */
#define IPS02A1_PIN_IN_1             (D5)
#define IPS02A1_PIN_IN_2             (D6)
#define IPS02A1_PIN_FR_STBY          (D4)
#define IPS02A1_PIN_CURRENTSENSE1    (A2)
#define IPS02A1_PIN_CURRENTSENSE2    (A3)
 
/* V-Ref */
#define V_REF 3.3
/* Rsense Value */
#define R_SENSE 1e3
/* R_D1 */
#define R_D1 56e3
/* R_D2 */
#define R_D2 36e3


/*** Variables ----------------------------------------------------------------- ***/

static XNucleoIPS02A1 &ips_expansion_board = XNucleoIPS02A1::instance(IPS02A1_PIN_IN_1,
                                                                      IPS02A1_PIN_IN_2,
                                                                      IPS02A1_PIN_FR_STBY,
                                                                      IPS02A1_PIN_CURRENTSENSE1,
                                                                      IPS02A1_PIN_CURRENTSENSE2,                                                                         
                                                                      V_REF,
                                                                      R_SENSE,
                                                                      R_D1,
                                                                      R_D2);

static Ticker ticker;
DigitalOut user_led(LED1);    
float multisense_signal = 0;    // Multisense pin - signal level
bool  button_pressed = 0;       // User Button
int   test_sequence = 1;        // Test sequence counter
 
//------------------------------------
// Hyperterminal configuration
// 9600 bauds, 8-bit data, no parity
//------------------------------------
InterruptIn user_button(USER_BUTTON); // B1 is the User Button
void b1_pressed (void);
void led_blink (int test_sequence);
void write_serial (void);
void reset_pins (void);


/*** Functions ----------------------------------------------------------------- ***/

/**
 * Main function.
 */
int main(void) {
    user_button.fall(&b1_pressed); //Interrupt User Button
   
    printf("############################################################ \n\r");
    printf("###################  TEST PROCEDURE ######################## \n\r");
    printf("############################################################ \n\n\r");
    printf("This demo performs current measurements on Ch1 and Ch2  \n\r");
    printf("in the following conditions: \n\r\n\r");
    printf(" 1) Ch1 OFF, Ch2 OFF \n\r");
    printf(" 2) Ch1 ON,  Ch2 OFF \n\r");
    printf(" 3) Ch1 OFF, Ch2 ON \n\r");
    printf(" 4) Ch1 ON,  Ch2 ON \n\r\n\r");
      
    printf("Start test Procedure.... \n\r\n\r");
    printf("PRESS USER BUTTON (Blue One) on NUCLEO to perform single test \n\r\n\r\n\r");
    
    
    while (true) {
        // Wait for User button pressed.
        while (!button_pressed) {}
           
        button_pressed = 0;
        
        led_blink(test_sequence);
     
        switch (test_sequence) {
          case (1):
            printf("############################################################ \n\r");
            printf("###################  TEST PROCEDURE ######################## \n\r");
            printf("############################################################ \n\n\r");
            printf("This demo performs current measurements on Ch1 and Ch2  \n\r");
            printf("in the following conditions: \n\r\n\r");
            printf(" 1) Ch1 OFF, Ch2 OFF \n\r");
            printf(" 2) Ch1 ON,  Ch2 OFF \n\r");
            printf(" 3) Ch1 OFF, Ch2 ON \n\r");
            printf(" 4) Ch1 ON,  Ch2 ON \n\r\n\r");
            printf("\n\r\n\r");
            break;
 
          case (2): {
            printf("Test 1: StandBy\n\r");
            reset_pins();
            wait (0.1);
            write_serial();
            multisense_signal = ips_expansion_board.get_current(CHANNEL_1);
            printf("Current Ch1 = %2.3fA \n\r", multisense_signal);
            multisense_signal = ips_expansion_board.get_current(CHANNEL_2);
            printf("Current Ch2 = %2.3fA \n\r", multisense_signal);
            printf("\n\r\n\r");
           }
           break;
 
          case(3):{
            printf("Test 2: Ch1=ON, CH2=OFF\n\r");
            ips_expansion_board.vps2535h.In_1 = 1;
            ips_expansion_board.vps2535h.In_2 = 0;
            ips_expansion_board.vps2535h.Fr_Stby = 1;
            wait (0.1);
            write_serial();
            multisense_signal = ips_expansion_board.get_current(CHANNEL_1);
            printf("Current Ch1 = %2.3fA \n\r", multisense_signal);
            multisense_signal = ips_expansion_board.get_current(CHANNEL_2);
            printf("Current Ch2 = %2.3fA \n\r", multisense_signal);
            wait (0.5);
            reset_pins();
            printf("\n\r\n\r");
           }
           break;
 
          case(4):{
            printf("Test 3: Ch1=OFF, CH2=ON\n\r");
            ips_expansion_board.vps2535h.In_1 = 0;
            ips_expansion_board.vps2535h.In_2 = 1;
            ips_expansion_board.vps2535h.Fr_Stby = 1;
            wait (0.1);
            write_serial();
            multisense_signal = ips_expansion_board.get_current(CHANNEL_1);
            printf("Current Ch1 = %2.3fA \n\r", multisense_signal);
            multisense_signal = ips_expansion_board.get_current(CHANNEL_2);
            printf("Current Ch2 = %2.3fA \n\r", multisense_signal);
            wait (.5);
            reset_pins();
            printf("\n\r\n\r");
           }
           break;
 
          case(5):{
            printf("Test 4: Ch1=ON, CH2=ON  \n\r");
            ips_expansion_board.vps2535h.In_1= 1;
            ips_expansion_board.vps2535h.In_2 = 1;
            ips_expansion_board.vps2535h.Fr_Stby = 1;
            wait (0.1);
            write_serial();
            multisense_signal = ips_expansion_board.get_current(CHANNEL_1);
            printf("Current Ch1 = %2.3fA \n\r", multisense_signal);
            multisense_signal = ips_expansion_board.get_current(CHANNEL_2);
            printf("Current Ch2 = %2.3fA \n\r", multisense_signal);
            wait (.5);
            reset_pins();
            printf("\n\r\n\r");
           }
          break;
 
          default: {
            printf("End of Test Cycle. Press the user button to continue...\n\n\n\r");  
            test_sequence = 0;
            reset_pins();
           }
          break;
        } 
    }
}

/**
 * Interrupt procedure, user button is pressed.
 */
void b1_pressed() {
    test_sequence ++;
 
    user_led = 1; // LED is ON
    wait(0.05);   // 50 ms
    user_led = 0; // LED is OFF
 
    button_pressed = 1;
}

/**
 * Feedback by using User LED.
 */ 
void led_blink(int test_sequence) {

    for (int test = 0; test < test_sequence; test++) {
        user_led = 1; // LED is ON
        wait(0.05);  // 50 ms
        user_led = 0; // LED is OFF
        wait(0.05);  // 50 msec
    }
    wait(1- (test_sequence * 2 * 0.05));
}

/**
 * Send messages and data to the serial port.
 */
void write_serial() {
    printf("Input 1= %d\t", ips_expansion_board.vps2535h.In_1.read());
    printf("Input 2= %d\t", ips_expansion_board.vps2535h.In_2.read());
    printf("Fr_Stby= %d\t\n\r", ips_expansion_board.vps2535h.Fr_Stby.read());
}

/**
 * Reset input pins.
 */
void reset_pins() {
    ips_expansion_board.vps2535h.In_1= 0;
    ips_expansion_board.vps2535h.In_2 = 0;
    ips_expansion_board.vps2535h.Fr_Stby = 0;
}