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);

Diff: x_nucleo_ips02a1.h

Revision:: 7:10e489682b80
Parent:: 6:c313d3a5c61a
Child:: 8:73df2d2b721c

--- a/x_nucleo_ips02a1.h	Thu Jul 28 16:42:52 2016 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,102 +0,0 @@
-/**
- *******************************************************************************
- * @file    x_nucleo_ips02a1.h
- * @author  ADG
- * @version V1.0.1
- * @date    01-July-2016
- * @brief   Header file for class X_NUCLEO_IPS02A1 representing a X-NUCLEO-IPS02A1
- *          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.
- *
- ******************************************************************************
-*/ 
-
-/* Define to prevent recursive inclusion -------------------------------------*/
-#ifndef __X_NUCLEO_IPS02A1_H
-#define __X_NUCLEO_IPS02A1_H
-
-
-/* Includes ------------------------------------------------------------------*/
-#include "vps2535h_class.h"
-
-/* Classes -------------------------------------------------------------------*/
-/** Class X_NUCLEO_IPS02A1 is intended to represent the intelligent power switch 
- *  Nucleo Expansion Board with the same name.
- *
- *  The expansion board is featuring basically of:\n
- *  -# a VPS2535H power switch\n
- *
- * It is intentionally implemented as a singleton because only one
- * X_NUCLEO_IPS02A1 at a time might be deployed in a HW component stack.\n
- * In order to get the singleton instance you have to call class method `Instance()`, 
- * e.g.:
- * @code
- * // Intelligent Power Switch expansion board singleton instance
- * static X_NUCLEO_IPS02A1 *<TODO>_expansion_board = X_NUCLEO_IPS02A1::Instance();
- * @endcode
- */
-
-class X_NUCLEO_IPS02A1
-{
- protected:
-	X_NUCLEO_IPS02A1(PinName in1, PinName in2, PinName frstdby,
-             PinName sense1, PinName sense2, float vref,float rsense,float rd1,float rd2);
-
-	/**
-	 * @brief  Initialize the singleton's power swicth to default settings
-	 * @retval true if initialization successful, 
-	 * @retval false otherwise
-	 */
-	bool Init(void) {
-          return (Init_VPS2535H());
-	}       
-        
-	bool Init_VPS2535H(void);
-
- public:
-	static X_NUCLEO_IPS02A1& Instance (PinName in1, PinName in2, PinName frstdby,
-             PinName sense1, PinName sense2, float vref,float rsense,float rd1,float rd2);
-    float GetCurrent(int Ch);
-       
-
-	VPS2535H  &vps2535h;
- private:
-	static X_NUCLEO_IPS02A1 *_instance;
-
-};
-
-
-    
-
-#endif /* __X_NUCLEO_IPS02A1_H */
-
-
-
-/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
-
-