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 Jul 28 16:05:28 2016 +0000
Revision:
5:b683e69b181c
Parent:
Components/vps235h2/vps235h2.h@4:715dcaf74418
Child:
6:c313d3a5c61a
changed component name from vps235h2 to vps2535h

Who changed what in which revision?

UserRevisionLine numberNew contents of line
grussian 0:c175921ca7c3 1 /**
grussian 4:715dcaf74418 2 *******************************************************************************
grussian 5:b683e69b181c 3 * @file vps2535h.h
grussian 5:b683e69b181c 4 * @author ADG
grussian 5:b683e69b181c 5 * @version V1.0.1
grussian 5:b683e69b181c 6 * @date 01-July-2016
grussian 4:715dcaf74418 7 * @brief VPS235H1 module driver.
grussian 4:715dcaf74418 8 * This file provides firmware functions to manage the following
grussian 4:715dcaf74418 9 * functionalities of the VPS235H1 power switch:
grussian 4:715dcaf74418 10 * + Initialization and de-initialization functions
grussian 4:715dcaf74418 11 * + Diagnostic Sense Pin Configuration
grussian 4:715dcaf74418 12 * + Get Sense Diagnostic Values
grussian 4:715dcaf74418 13 *******************************************************************************
grussian 4:715dcaf74418 14 * @attention
grussian 4:715dcaf74418 15 *
grussian 4:715dcaf74418 16 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
grussian 4:715dcaf74418 17 *
grussian 4:715dcaf74418 18 * Redistribution and use in source and binary forms, with or without modification,
grussian 4:715dcaf74418 19 * are permitted provided that the following conditions are met:
grussian 4:715dcaf74418 20 * 1. Redistributions of source code must retain the above copyright notice,
grussian 4:715dcaf74418 21 * this list of conditions and the following disclaimer.
grussian 4:715dcaf74418 22 * 2. Redistributions in binary form must reproduce the above copyright notice,
grussian 4:715dcaf74418 23 * this list of conditions and the following disclaimer in the documentation
grussian 4:715dcaf74418 24 * and/or other materials provided with the distribution.
grussian 4:715dcaf74418 25 * 3. Neither the name of STMicroelectronics nor the names of its contributors
grussian 4:715dcaf74418 26 * may be used to endorse or promote products derived from this software
grussian 4:715dcaf74418 27 * without specific prior written permission.
grussian 4:715dcaf74418 28 *
grussian 4:715dcaf74418 29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
grussian 4:715dcaf74418 30 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
grussian 4:715dcaf74418 31 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
grussian 4:715dcaf74418 32 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
grussian 4:715dcaf74418 33 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
grussian 4:715dcaf74418 34 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
grussian 4:715dcaf74418 35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
grussian 4:715dcaf74418 36 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
grussian 4:715dcaf74418 37 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
grussian 4:715dcaf74418 38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
grussian 4:715dcaf74418 39 *
grussian 4:715dcaf74418 40 ******************************************************************************
grussian 4:715dcaf74418 41 */
grussian 0:c175921ca7c3 42
grussian 0:c175921ca7c3 43 /* Define to prevent recursive inclusion -------------------------------------*/
grussian 5:b683e69b181c 44 #ifndef __VPS2535H_H
grussian 5:b683e69b181c 45 #define __VPS2535H_H
grussian 0:c175921ca7c3 46
grussian 0:c175921ca7c3 47 /* Number of channels */
grussian 0:c175921ca7c3 48 #define NUM_CHANNELS 2
grussian 0:c175921ca7c3 49
grussian 0:c175921ca7c3 50 /* Channel 0 */
grussian 0:c175921ca7c3 51 #define CHANNEL_1 1
grussian 0:c175921ca7c3 52 /* Channel 1 */
grussian 0:c175921ca7c3 53 #define CHANNEL_2 2
grussian 0:c175921ca7c3 54
grussian 0:c175921ca7c3 55 /* V-Sense Temperature Typical value at 25 degree */
grussian 0:c175921ca7c3 56 #define V_SENSE_TC_TYPICAL 2.070
grussian 0:c175921ca7c3 57
grussian 0:c175921ca7c3 58 /* Vcc transfer function */
grussian 0:c175921ca7c3 59 #define VCC_TRANSFER_FUNCT(sense) ((sense)*4)
grussian 0:c175921ca7c3 60 /* Current K factor */
grussian 0:c175921ca7c3 61 #define K 3500
grussian 0:c175921ca7c3 62
grussian 0:c175921ca7c3 63
grussian 0:c175921ca7c3 64
grussian 5:b683e69b181c 65 #endif /* __VPS2535H_H */
grussian 0:c175921ca7c3 66
grussian 0:c175921ca7c3 67
grussian 0:c175921ca7c3 68
grussian 0:c175921ca7c3 69 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
grussian 0:c175921ca7c3 70
grussian 0:c175921ca7c3 71
grussian 0:c175921ca7c3 72
grussian 0:c175921ca7c3 73