Firmware to manage X-Nucleo-IPS02A1 (24V) Intelligent Power Switch.

Dependents:   HelloWorld_IPS02A1

Fork of X_NUCLEO_IPS02A1 by ST Expansion SW Team

X_NUCLEO_IPS02A1 24V Intelligent Power Switch (IPS) Nucleo Expansion Board Firmware Package

Introduction

This firmware package includes Components Device Drivers and Board Support Package for STMicroelectronics X-NUCLEO-IPS02A1 IPS Expansion Board.

Firmware Library

Class X_NUCLEO_IPS02A1 is intended to represent the Intelligent Power Switch expansion board with the same name.

The expansion board is basically featuring by one IP:

  • vps2535h vertical power switch.

It is intentionally implemented as a singleton because only one X-NUCLEO-IPS02A1 at a time might be deployed in a HW component stack. In order to get the singleton instance you have to call class method `Instance()`, e.g.:

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

How to use the firmware package

The basic operations to deal with the firmware pkg and use the IPS are the following :

1) instantiate the X_NUCLEO by calling class method `Instance()`:

// Sensors expansion board singleton instance
static X_NUCLEO_IPS02A1 *sensors_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.Fr_Stby = 1; // set Fr_Stby pin
            ips_expansion_board.vps2535h.In_1 = 1; // switch-on Channel 1
            ips_expansion_board.vps2535h.In_2 = 0; // switch-off Channle 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);
Committer:
grussian
Date:
Thu Apr 07 13:37:58 2016 +0000
Revision:
0:c175921ca7c3
first working realease

Who changed what in which revision?

UserRevisionLine numberNew contents of line
grussian 0:c175921ca7c3 1 /**
grussian 0:c175921ca7c3 2 ******************************************************************************
grussian 0:c175921ca7c3 3 * @file main.cpp
grussian 0:c175921ca7c3 4 * @author APG Mass Market
grussian 0:c175921ca7c3 5 * @version V1.0.1
grussian 0:c175921ca7c3 6 * @date 16-Nov-2015
grussian 0:c175921ca7c3 7 * @brief Example application for using the X_NUCLEO_IPS02A1
grussian 0:c175921ca7c3 8 * Intelligent Power Switch Nucleo expansion board.
grussian 0:c175921ca7c3 9 ******************************************************************************
grussian 0:c175921ca7c3 10 * @attention
grussian 0:c175921ca7c3 11 *
grussian 0:c175921ca7c3 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
grussian 0:c175921ca7c3 13 *
grussian 0:c175921ca7c3 14 * Redistribution and use in source and binary forms, with or without modification,
grussian 0:c175921ca7c3 15 * are permitted provided that the following conditions are met:
grussian 0:c175921ca7c3 16 * 1. Redistributions of source code must retain the above copyright notice,
grussian 0:c175921ca7c3 17 * this list of conditions and the following disclaimer.
grussian 0:c175921ca7c3 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
grussian 0:c175921ca7c3 19 * this list of conditions and the following disclaimer in the documentation
grussian 0:c175921ca7c3 20 * and/or other materials provided with the distribution.
grussian 0:c175921ca7c3 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
grussian 0:c175921ca7c3 22 * may be used to endorse or promote products derived from this software
grussian 0:c175921ca7c3 23 * without specific prior written permission.
grussian 0:c175921ca7c3 24 *
grussian 0:c175921ca7c3 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
grussian 0:c175921ca7c3 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
grussian 0:c175921ca7c3 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
grussian 0:c175921ca7c3 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
grussian 0:c175921ca7c3 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
grussian 0:c175921ca7c3 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
grussian 0:c175921ca7c3 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
grussian 0:c175921ca7c3 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
grussian 0:c175921ca7c3 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
grussian 0:c175921ca7c3 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
grussian 0:c175921ca7c3 35 *
grussian 0:c175921ca7c3 36 ******************************************************************************
grussian 0:c175921ca7c3 37 */
grussian 0:c175921ca7c3 38
grussian 0:c175921ca7c3 39 /**
grussian 0:c175921ca7c3 40 * @mainpage X_NUCLEO_IPS02A1 Intelligent Power Switch Nucleo Expansion Board Firmware Package
grussian 0:c175921ca7c3 41 *
grussian 0:c175921ca7c3 42 * <b>Introduction</b>
grussian 0:c175921ca7c3 43 *
grussian 0:c175921ca7c3 44 * This firmware package includes Components Device Drivers, Board Support Package
grussian 0:c175921ca7c3 45 * and example application for STMicroelectronics X_NUCLEO_IPS02A1 Intelligent Power Switch
grussian 0:c175921ca7c3 46 * Nucleo Expansion Board
grussian 0:c175921ca7c3 47 *
grussian 0:c175921ca7c3 48 * <b>Example Application</b>
grussian 0:c175921ca7c3 49 *
grussian 0:c175921ca7c3 50 */
grussian 0:c175921ca7c3 51 /*** Includes ----------------------------------------------------------------- ***/
grussian 0:c175921ca7c3 52 #include "mbed.h"
grussian 0:c175921ca7c3 53 #include "assert.h"
grussian 0:c175921ca7c3 54 #include "x_nucleo_ips02a1.h"
grussian 0:c175921ca7c3 55
grussian 0:c175921ca7c3 56 /*** Static variables --------------------------------------------------------- ***/
grussian 0:c175921ca7c3 57 #ifdef DBG_MCU
grussian 0:c175921ca7c3 58 #include "DbgMCU.h"
grussian 0:c175921ca7c3 59 static DbgMCU enable_dbg;
grussian 0:c175921ca7c3 60 #endif // DBG_MCU
grussian 0:c175921ca7c3 61
grussian 0:c175921ca7c3 62 /* HW settings */
grussian 0:c175921ca7c3 63 /* Pay attention before changing HW settings, they must be coherent with you HW design */
grussian 0:c175921ca7c3 64 /* Power Switch Connection to Arduino connectors */
grussian 0:c175921ca7c3 65 #define IPS02A1_PIN_IN_1 (D5)
grussian 0:c175921ca7c3 66 #define IPS02A1_PIN_IN_2 (D6)
grussian 0:c175921ca7c3 67 #define IPS02A1_PIN_FR_STBY (D4)
grussian 0:c175921ca7c3 68 #define IPS02A1_PIN_CURRENTSENSE1 (A2)
grussian 0:c175921ca7c3 69 #define IPS02A1_PIN_CURRENTSENSE2 (A3)
grussian 0:c175921ca7c3 70
grussian 0:c175921ca7c3 71
grussian 0:c175921ca7c3 72 /* V-Ref */
grussian 0:c175921ca7c3 73 #define V_REF 3.3
grussian 0:c175921ca7c3 74 /* Rsense Value */
grussian 0:c175921ca7c3 75 #define R_SENSE 1e3
grussian 0:c175921ca7c3 76 /* R_D1 */
grussian 0:c175921ca7c3 77 #define R_D1 56e3
grussian 0:c175921ca7c3 78 /* R_D2 */
grussian 0:c175921ca7c3 79 #define R_D2 36e3
grussian 0:c175921ca7c3 80
grussian 0:c175921ca7c3 81 /* End of HW settings */
grussian 0:c175921ca7c3 82
grussian 0:c175921ca7c3 83 static X_NUCLEO_IPS02A1 &ips_expansion_board = X_NUCLEO_IPS02A1::Instance(IPS02A1_PIN_IN_1,
grussian 0:c175921ca7c3 84 IPS02A1_PIN_IN_2,
grussian 0:c175921ca7c3 85 IPS02A1_PIN_FR_STBY,
grussian 0:c175921ca7c3 86 IPS02A1_PIN_CURRENTSENSE1,
grussian 0:c175921ca7c3 87 IPS02A1_PIN_CURRENTSENSE2,
grussian 0:c175921ca7c3 88 V_REF,
grussian 0:c175921ca7c3 89 R_SENSE,
grussian 0:c175921ca7c3 90 R_D1,
grussian 0:c175921ca7c3 91 R_D2);
grussian 0:c175921ca7c3 92
grussian 0:c175921ca7c3 93
grussian 0:c175921ca7c3 94 static Ticker ticker;
grussian 0:c175921ca7c3 95 DigitalOut UserLed(LED1);
grussian 0:c175921ca7c3 96
grussian 0:c175921ca7c3 97 /*** Main function ------------------------------------------------------------- ***/
grussian 0:c175921ca7c3 98 /* Generic main function/loop, interrupt based cyclic execution
grussian 0:c175921ca7c3 99 */
grussian 0:c175921ca7c3 100
grussian 0:c175921ca7c3 101 float Multisense_Signal = 0; // Multisense pin - signal level
grussian 0:c175921ca7c3 102 bool ButtonPressed = 0; // User Button
grussian 0:c175921ca7c3 103 int TestSequence = 1; // Test sequence counter
grussian 0:c175921ca7c3 104
grussian 0:c175921ca7c3 105 //------------------------------------
grussian 0:c175921ca7c3 106 // Hyperterminal configuration
grussian 0:c175921ca7c3 107 // 9600 bauds, 8-bit data, no parity
grussian 0:c175921ca7c3 108 //------------------------------------
grussian 0:c175921ca7c3 109
grussian 0:c175921ca7c3 110 InterruptIn UserButton(USER_BUTTON); // B1 is the User Button
grussian 0:c175921ca7c3 111 void B1_pressed (void);
grussian 0:c175921ca7c3 112 void LedBlink (int TestSequence);
grussian 0:c175921ca7c3 113 void Write_Serial (void);
grussian 0:c175921ca7c3 114 void Reset_Pins (void);
grussian 0:c175921ca7c3 115
grussian 0:c175921ca7c3 116
grussian 0:c175921ca7c3 117 int main(void){
grussian 0:c175921ca7c3 118 UserButton.fall(&B1_pressed); //interrupt User Button
grussian 0:c175921ca7c3 119
grussian 0:c175921ca7c3 120 printf("############################################################ \n\r");
grussian 0:c175921ca7c3 121 printf("################### TEST PROCEDURE ######################## \n\r");
grussian 0:c175921ca7c3 122 printf("############################################################ \n\n\r");
grussian 0:c175921ca7c3 123 printf("This demo performs current measurements on Ch1 and Ch2 \n\r");
grussian 0:c175921ca7c3 124 printf("in the following conditions: \n\r\n\r");
grussian 0:c175921ca7c3 125 printf(" 1) Ch1 OFF, Ch2 OFF \n\r");
grussian 0:c175921ca7c3 126 printf(" 2) Ch1 ON, Ch2 OFF \n\r");
grussian 0:c175921ca7c3 127 printf(" 3) Ch1 OFF, Ch2 ON \n\r");
grussian 0:c175921ca7c3 128 printf(" 4) Ch1 ON, Ch2 ON \n\r\n\r");
grussian 0:c175921ca7c3 129
grussian 0:c175921ca7c3 130 printf("Start test Procedure.... \n\r\n\r");
grussian 0:c175921ca7c3 131 printf("PRESS USER BUTTON (Blue One) on NUCLEO to perform single test \n\r\n\r\n\r");
grussian 0:c175921ca7c3 132
grussian 0:c175921ca7c3 133
grussian 0:c175921ca7c3 134 while (true) {
grussian 0:c175921ca7c3 135 // wait for User button is pressed
grussian 0:c175921ca7c3 136 while (!ButtonPressed) {
grussian 0:c175921ca7c3 137 }
grussian 0:c175921ca7c3 138
grussian 0:c175921ca7c3 139 ButtonPressed = 0;
grussian 0:c175921ca7c3 140
grussian 0:c175921ca7c3 141 LedBlink(TestSequence);
grussian 0:c175921ca7c3 142
grussian 0:c175921ca7c3 143 switch (TestSequence) {
grussian 0:c175921ca7c3 144 case (1):
grussian 0:c175921ca7c3 145 printf("############################################################ \n\r");
grussian 0:c175921ca7c3 146 printf("################### TEST PROCEDURE ######################## \n\r");
grussian 0:c175921ca7c3 147 printf("############################################################ \n\n\r");
grussian 0:c175921ca7c3 148 printf("This demo performs current measurements on Ch1 and Ch2 \n\r");
grussian 0:c175921ca7c3 149 printf("in the following conditions: \n\r\n\r");
grussian 0:c175921ca7c3 150 printf(" 1) Ch1 OFF, Ch2 OFF \n\r");
grussian 0:c175921ca7c3 151 printf(" 2) Ch1 ON, Ch2 OFF \n\r");
grussian 0:c175921ca7c3 152 printf(" 3) Ch1 OFF, Ch2 ON \n\r");
grussian 0:c175921ca7c3 153 printf(" 4) Ch1 ON, Ch2 ON \n\r\n\r");
grussian 0:c175921ca7c3 154 printf("\n\r\n\r");
grussian 0:c175921ca7c3 155 break;
grussian 0:c175921ca7c3 156 case (2): {
grussian 0:c175921ca7c3 157 printf("Test 1: StandBy\n\r");
grussian 0:c175921ca7c3 158 Reset_Pins();
grussian 0:c175921ca7c3 159 wait (0.1);
grussian 0:c175921ca7c3 160 Write_Serial();
grussian 0:c175921ca7c3 161 Multisense_Signal= ips_expansion_board.GetCurrent(CHANNEL_1);
grussian 0:c175921ca7c3 162 printf("Current Ch1 = %2.3fA \n\r", Multisense_Signal);
grussian 0:c175921ca7c3 163 Multisense_Signal= ips_expansion_board.GetCurrent(CHANNEL_2);
grussian 0:c175921ca7c3 164 printf("Current Ch2 = %2.3fA \n\r", Multisense_Signal);
grussian 0:c175921ca7c3 165 printf("\n\r\n\r");
grussian 0:c175921ca7c3 166 }
grussian 0:c175921ca7c3 167 break;
grussian 0:c175921ca7c3 168
grussian 0:c175921ca7c3 169
grussian 0:c175921ca7c3 170 case(3):{
grussian 0:c175921ca7c3 171 printf("Test 2: Ch1=ON, CH2=OFF\n\r");
grussian 0:c175921ca7c3 172 ips_expansion_board.vps235h2.In_1 = 1;
grussian 0:c175921ca7c3 173 ips_expansion_board.vps235h2.In_2 = 0;
grussian 0:c175921ca7c3 174 ips_expansion_board.vps235h2.Fr_Stby = 1;
grussian 0:c175921ca7c3 175
grussian 0:c175921ca7c3 176 wait (0.1);
grussian 0:c175921ca7c3 177 Write_Serial();
grussian 0:c175921ca7c3 178 Multisense_Signal= ips_expansion_board.GetCurrent(CHANNEL_1);
grussian 0:c175921ca7c3 179 printf("Current Ch1 = %2.3fA \n\r", Multisense_Signal);
grussian 0:c175921ca7c3 180 Multisense_Signal= ips_expansion_board.GetCurrent(CHANNEL_2);
grussian 0:c175921ca7c3 181 printf("Current Ch2 = %2.3fA \n\r", Multisense_Signal);
grussian 0:c175921ca7c3 182 wait (0.5);
grussian 0:c175921ca7c3 183 Reset_Pins();
grussian 0:c175921ca7c3 184 printf("\n\r\n\r");
grussian 0:c175921ca7c3 185 }
grussian 0:c175921ca7c3 186 break;
grussian 0:c175921ca7c3 187
grussian 0:c175921ca7c3 188 case(4):{
grussian 0:c175921ca7c3 189 printf("Test 3: Ch1=OFF, CH2=ON\n\r");
grussian 0:c175921ca7c3 190 ips_expansion_board.vps235h2.In_1 = 0;
grussian 0:c175921ca7c3 191 ips_expansion_board.vps235h2.In_2 = 1;
grussian 0:c175921ca7c3 192 ips_expansion_board.vps235h2.Fr_Stby = 1;
grussian 0:c175921ca7c3 193
grussian 0:c175921ca7c3 194 wait (0.1);
grussian 0:c175921ca7c3 195 Write_Serial();
grussian 0:c175921ca7c3 196 Multisense_Signal= ips_expansion_board.GetCurrent(CHANNEL_1);
grussian 0:c175921ca7c3 197 printf("Current Ch1 = %2.3fA \n\r", Multisense_Signal);
grussian 0:c175921ca7c3 198 Multisense_Signal= ips_expansion_board.GetCurrent(CHANNEL_2);
grussian 0:c175921ca7c3 199 printf("Current Ch2 = %2.3fA \n\r", Multisense_Signal);
grussian 0:c175921ca7c3 200 wait (.5);
grussian 0:c175921ca7c3 201 Reset_Pins();
grussian 0:c175921ca7c3 202 printf("\n\r\n\r");
grussian 0:c175921ca7c3 203 }
grussian 0:c175921ca7c3 204 break;
grussian 0:c175921ca7c3 205
grussian 0:c175921ca7c3 206 case(5):{
grussian 0:c175921ca7c3 207 printf("Test 4: Ch1=ON, CH2=ON \n\r");
grussian 0:c175921ca7c3 208 ips_expansion_board.vps235h2.In_1= 1;
grussian 0:c175921ca7c3 209 ips_expansion_board.vps235h2.In_2 = 1;
grussian 0:c175921ca7c3 210 ips_expansion_board.vps235h2.Fr_Stby = 1;
grussian 0:c175921ca7c3 211 wait (0.1);
grussian 0:c175921ca7c3 212 Write_Serial();
grussian 0:c175921ca7c3 213 Multisense_Signal= ips_expansion_board.GetCurrent(CHANNEL_1);
grussian 0:c175921ca7c3 214 printf("Current Ch1 = %2.3fA \n\r", Multisense_Signal);
grussian 0:c175921ca7c3 215 Multisense_Signal= ips_expansion_board.GetCurrent(CHANNEL_2);
grussian 0:c175921ca7c3 216 printf("Current Ch2 = %2.3fA \n\r", Multisense_Signal);
grussian 0:c175921ca7c3 217 wait (.5);
grussian 0:c175921ca7c3 218 Reset_Pins();
grussian 0:c175921ca7c3 219 printf("\n\r\n\r");
grussian 0:c175921ca7c3 220 }
grussian 0:c175921ca7c3 221 break;
grussian 0:c175921ca7c3 222
grussian 0:c175921ca7c3 223 default: {
grussian 0:c175921ca7c3 224 printf("End Test Cycle...press to user button to continue\n\n\n\r");
grussian 0:c175921ca7c3 225 TestSequence = 0;
grussian 0:c175921ca7c3 226 Reset_Pins();
grussian 0:c175921ca7c3 227 }
grussian 0:c175921ca7c3 228 break;
grussian 0:c175921ca7c3 229
grussian 0:c175921ca7c3 230 }
grussian 0:c175921ca7c3 231
grussian 0:c175921ca7c3 232 }
grussian 0:c175921ca7c3 233
grussian 0:c175921ca7c3 234 }
grussian 0:c175921ca7c3 235
grussian 0:c175921ca7c3 236
grussian 0:c175921ca7c3 237 void B1_pressed (){
grussian 0:c175921ca7c3 238 // Interrupt procedure - User button is pressed
grussian 0:c175921ca7c3 239 TestSequence ++;
grussian 0:c175921ca7c3 240
grussian 0:c175921ca7c3 241 UserLed = 1; // LED is ON
grussian 0:c175921ca7c3 242 wait(0.05); // 50 ms
grussian 0:c175921ca7c3 243 UserLed = 0; // LED is OFF
grussian 0:c175921ca7c3 244
grussian 0:c175921ca7c3 245 ButtonPressed = 1;
grussian 0:c175921ca7c3 246
grussian 0:c175921ca7c3 247 }
grussian 0:c175921ca7c3 248
grussian 0:c175921ca7c3 249 void LedBlink (int TestSequence){
grussian 0:c175921ca7c3 250 // Option feedback by usingUser LED
grussian 0:c175921ca7c3 251 for (int TestCounter =0; TestCounter<TestSequence; TestCounter++) {
grussian 0:c175921ca7c3 252 UserLed = 1; // LED is ON
grussian 0:c175921ca7c3 253 wait(0.05); // 50 ms
grussian 0:c175921ca7c3 254 UserLed = 0; // LED is OFF
grussian 0:c175921ca7c3 255 wait(0.05); // 50 msec
grussian 0:c175921ca7c3 256 }
grussian 0:c175921ca7c3 257 wait(1-(TestSequence*2*0.05));
grussian 0:c175921ca7c3 258 }
grussian 0:c175921ca7c3 259
grussian 0:c175921ca7c3 260 void Write_Serial (){
grussian 0:c175921ca7c3 261 // This code send messages and data to the serial port
grussian 0:c175921ca7c3 262 // send info to serial port
grussian 0:c175921ca7c3 263
grussian 0:c175921ca7c3 264 printf("Input 1= %d\t", ips_expansion_board.vps235h2.In_1.read());
grussian 0:c175921ca7c3 265 printf("Input 2= %d\t", ips_expansion_board.vps235h2.In_2.read());
grussian 0:c175921ca7c3 266 printf("Fr_Stby= %d\t\n\r", ips_expansion_board.vps235h2.Fr_Stby.read());
grussian 0:c175921ca7c3 267
grussian 0:c175921ca7c3 268
grussian 0:c175921ca7c3 269 }
grussian 0:c175921ca7c3 270
grussian 0:c175921ca7c3 271 void Reset_Pins(){
grussian 0:c175921ca7c3 272 // reset input pins to
grussian 0:c175921ca7c3 273 ips_expansion_board.vps235h2.In_1= 0;
grussian 0:c175921ca7c3 274 ips_expansion_board.vps235h2.In_2 = 0;
grussian 0:c175921ca7c3 275 ips_expansion_board.vps235h2.Fr_Stby = 0;
grussian 0:c175921ca7c3 276 }
grussian 0:c175921ca7c3 277
grussian 0:c175921ca7c3 278
grussian 0:c175921ca7c3 279