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
Child:
2:06d0eb54630a
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 x_nucleo_ips02A1.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 Implementation file for the X_NUCLEO_IPS02A1 singleton class
grussian 0:c175921ca7c3 8 ******************************************************************************
grussian 0:c175921ca7c3 9 * @attention
grussian 0:c175921ca7c3 10 *
grussian 0:c175921ca7c3 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
grussian 0:c175921ca7c3 12 *
grussian 0:c175921ca7c3 13 * Redistribution and use in source and binary forms, with or without modification,
grussian 0:c175921ca7c3 14 * are permitted provided that the following conditions are met:
grussian 0:c175921ca7c3 15 * 1. Redistributions of source code must retain the above copyright notice,
grussian 0:c175921ca7c3 16 * this list of conditions and the following disclaimer.
grussian 0:c175921ca7c3 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
grussian 0:c175921ca7c3 18 * this list of conditions and the following disclaimer in the documentation
grussian 0:c175921ca7c3 19 * and/or other materials provided with the distribution.
grussian 0:c175921ca7c3 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
grussian 0:c175921ca7c3 21 * may be used to endorse or promote products derived from this software
grussian 0:c175921ca7c3 22 * without specific prior written permission.
grussian 0:c175921ca7c3 23 *
grussian 0:c175921ca7c3 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
grussian 0:c175921ca7c3 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
grussian 0:c175921ca7c3 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
grussian 0:c175921ca7c3 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
grussian 0:c175921ca7c3 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
grussian 0:c175921ca7c3 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
grussian 0:c175921ca7c3 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
grussian 0:c175921ca7c3 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
grussian 0:c175921ca7c3 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
grussian 0:c175921ca7c3 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
grussian 0:c175921ca7c3 34 *
grussian 0:c175921ca7c3 35 ******************************************************************************
grussian 0:c175921ca7c3 36 */
grussian 0:c175921ca7c3 37
grussian 0:c175921ca7c3 38 /* Includes ------------------------------------------------------------------*/
grussian 0:c175921ca7c3 39 #include "mbed.h"
grussian 0:c175921ca7c3 40 #include "x_nucleo_ips02a1.h"
grussian 0:c175921ca7c3 41
grussian 0:c175921ca7c3 42 /* Static variables ----------------------------------------------------------*/
grussian 0:c175921ca7c3 43 X_NUCLEO_IPS02A1* X_NUCLEO_IPS02A1::_instance = NULL;
grussian 0:c175921ca7c3 44
grussian 0:c175921ca7c3 45
grussian 0:c175921ca7c3 46 /* Methods -------------------------------------------------------------------*/
grussian 0:c175921ca7c3 47 /**
grussian 0:c175921ca7c3 48 * @brief Constructor
grussian 0:c175921ca7c3 49 */
grussian 0:c175921ca7c3 50 X_NUCLEO_IPS02A1::X_NUCLEO_IPS02A1(PinName in1, PinName in2, PinName frstdby,
grussian 0:c175921ca7c3 51 PinName sense1, PinName sense2, float vref,float rsense,float rd1,float rd2) : vps235h2( *(new VPS235H2(in1, in2, frstdby,
grussian 0:c175921ca7c3 52 sense1, sense2, vref,rsense,rd1,rd2)) )
grussian 0:c175921ca7c3 53
grussian 0:c175921ca7c3 54 {
grussian 0:c175921ca7c3 55 }
grussian 0:c175921ca7c3 56
grussian 0:c175921ca7c3 57
grussian 0:c175921ca7c3 58 /**
grussian 0:c175921ca7c3 59 * @brief Get singleton instance
grussian 0:c175921ca7c3 60 * @return a pointer to the initialized singleton instance of class X_NUCLEO_IPS02A1
grussian 0:c175921ca7c3 61 * @param[in] none
grussian 0:c175921ca7c3 62 */
grussian 0:c175921ca7c3 63 X_NUCLEO_IPS02A1& X_NUCLEO_IPS02A1::Instance(PinName in1, PinName in2, PinName frstdby,
grussian 0:c175921ca7c3 64 PinName sense1, PinName sense2, float vref,float rsense,float rd1,float rd2) {
grussian 0:c175921ca7c3 65 if(_instance == NULL) {
grussian 0:c175921ca7c3 66 _instance = new X_NUCLEO_IPS02A1(in1,in2,frstdby,
grussian 0:c175921ca7c3 67 sense1,sense2,vref,rsense,rd1,rd2);
grussian 0:c175921ca7c3 68
grussian 0:c175921ca7c3 69 if(_instance != NULL) {
grussian 0:c175921ca7c3 70 bool ret = _instance->Init();
grussian 0:c175921ca7c3 71 if(!ret) {
grussian 0:c175921ca7c3 72 error("Failed to init X_NUCLEO_IPS02A1 expansion board!\n");
grussian 0:c175921ca7c3 73 }
grussian 0:c175921ca7c3 74 }
grussian 0:c175921ca7c3 75 }
grussian 0:c175921ca7c3 76
grussian 0:c175921ca7c3 77 return (*_instance);
grussian 0:c175921ca7c3 78 }
grussian 0:c175921ca7c3 79
grussian 0:c175921ca7c3 80 /**
grussian 0:c175921ca7c3 81 * @brief Initialize the singleton's power switch
grussian 0:c175921ca7c3 82 * @retval true if initialization successful,
grussian 0:c175921ca7c3 83 * @retval false otherwise
grussian 0:c175921ca7c3 84 */
grussian 0:c175921ca7c3 85 bool X_NUCLEO_IPS02A1::Init_VPS235H2(void) {
grussian 0:c175921ca7c3 86 vps235h2.Open(NULL);
grussian 0:c175921ca7c3 87 return true;
grussian 0:c175921ca7c3 88 }
grussian 0:c175921ca7c3 89
grussian 0:c175921ca7c3 90
grussian 0:c175921ca7c3 91 /**
grussian 0:c175921ca7c3 92 * @brief get current measurement from singleton's power switch
grussian 0:c175921ca7c3 93 * @retval *hips contain status of the operation
grussian 0:c175921ca7c3 94 * param[in] Channel number: CHANNEL_1 or CHANNEL_2
grussian 0:c175921ca7c3 95 */
grussian 0:c175921ca7c3 96 float X_NUCLEO_IPS02A1:: GetCurrent(int Ch){
grussian 0:c175921ca7c3 97
grussian 0:c175921ca7c3 98 return vps235h2.GetCurrent(Ch);
grussian 0:c175921ca7c3 99
grussian 0:c175921ca7c3 100 }
grussian 0:c175921ca7c3 101
grussian 0:c175921ca7c3 102
grussian 0:c175921ca7c3 103 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
grussian 0:c175921ca7c3 104