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

x_nucleo_ips02a1.h@4:715dcaf74418, 2016-06-13 (annotated)

Committer:: grussian
Date:: Mon Jun 13 13:03:44 2016 +0000
Revision:: 4:715dcaf74418
Parent:: 0:c175921ca7c3
Child:: 5:b683e69b181c

small fix following Nicola review

Who changed what in which revision?

User	Revision	Line number	New contents of line
grussian	0:c175921ca7c3	1	/**
grussian	4:715dcaf74418	2	*******************************************************************************
grussian	4:715dcaf74418	3	* @file x_nucleo_ips02a1.h
grussian	4:715dcaf74418	4	* @author APG Mass Market
grussian	4:715dcaf74418	5	* @version V1.0.1
grussian	4:715dcaf74418	6	* @date 01-July-2015
grussian	4:715dcaf74418	7	* @brief Header file for class X_NUCLEO_IPS02A1 representing a X-NUCLEO-IPS02A1
grussian	4:715dcaf74418	8	* expansion board
grussian	4:715dcaf74418	9	*******************************************************************************
grussian	4:715dcaf74418	10	* @attention
grussian	4:715dcaf74418	11	*
grussian	4:715dcaf74418	12	* <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
grussian	4:715dcaf74418	13	*
grussian	4:715dcaf74418	14	* Redistribution and use in source and binary forms, with or without modification,
grussian	4:715dcaf74418	15	* are permitted provided that the following conditions are met:
grussian	4:715dcaf74418	16	* 1. Redistributions of source code must retain the above copyright notice,
grussian	4:715dcaf74418	17	* this list of conditions and the following disclaimer.
grussian	4:715dcaf74418	18	* 2. Redistributions in binary form must reproduce the above copyright notice,
grussian	4:715dcaf74418	19	* this list of conditions and the following disclaimer in the documentation
grussian	4:715dcaf74418	20	* and/or other materials provided with the distribution.
grussian	4:715dcaf74418	21	* 3. Neither the name of STMicroelectronics nor the names of its contributors
grussian	4:715dcaf74418	22	* may be used to endorse or promote products derived from this software
grussian	4:715dcaf74418	23	* without specific prior written permission.
grussian	4:715dcaf74418	24	*
grussian	4:715dcaf74418	25	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
grussian	4:715dcaf74418	26	* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
grussian	4:715dcaf74418	27	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
grussian	4:715dcaf74418	28	* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
grussian	4:715dcaf74418	29	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
grussian	4:715dcaf74418	30	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
grussian	4:715dcaf74418	31	* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
grussian	4:715dcaf74418	32	* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
grussian	4:715dcaf74418	33	* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
grussian	4:715dcaf74418	34	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
grussian	4:715dcaf74418	35	*
grussian	4:715dcaf74418	36	******************************************************************************
grussian	4:715dcaf74418	37	*/
grussian	0:c175921ca7c3	38
grussian	0:c175921ca7c3	39	/* Define to prevent recursive inclusion -------------------------------------*/
grussian	0:c175921ca7c3	40	#ifndef __X_NUCLEO_IPS02A1_H
grussian	0:c175921ca7c3	41	#define __X_NUCLEO_IPS02A1_H
grussian	0:c175921ca7c3	42
grussian	0:c175921ca7c3	43
grussian	0:c175921ca7c3	44	/* Includes ------------------------------------------------------------------*/
grussian	0:c175921ca7c3	45	#include "vps235h2_class.h"
grussian	0:c175921ca7c3	46
grussian	0:c175921ca7c3	47	/* Classes -------------------------------------------------------------------*/
grussian	0:c175921ca7c3	48	/** Class X_NUCLEO_IPS02A1 is intended to represent the intelligent power switch
grussian	0:c175921ca7c3	49	* Nucleo Expansion Board with the same name.
grussian	0:c175921ca7c3	50	*
grussian	0:c175921ca7c3	51	* The expansion board is featuring basically of:\n
grussian	0:c175921ca7c3	52	* -# a VPS235H2 power switch\n
grussian	0:c175921ca7c3	53	*
grussian	0:c175921ca7c3	54	* It is intentionally implemented as a singleton because only one
grussian	0:c175921ca7c3	55	* X_NUCLEO_IPS02A1 at a time might be deployed in a HW component stack.\n
grussian	0:c175921ca7c3	56	* In order to get the singleton instance you have to call class method `Instance()`,
grussian	0:c175921ca7c3	57	* e.g.:
grussian	0:c175921ca7c3	58	* @code
grussian	0:c175921ca7c3	59	* // Intelligent Power Switch expansion board singleton instance
grussian	0:c175921ca7c3	60	* static X_NUCLEO_IPS02A1 *<TODO>_expansion_board = X_NUCLEO_IPS02A1::Instance();
grussian	0:c175921ca7c3	61	* @endcode
grussian	0:c175921ca7c3	62	*/
grussian	0:c175921ca7c3	63
grussian	0:c175921ca7c3	64	class X_NUCLEO_IPS02A1
grussian	0:c175921ca7c3	65	{
grussian	0:c175921ca7c3	66	protected:
grussian	0:c175921ca7c3	67	X_NUCLEO_IPS02A1(PinName in1, PinName in2, PinName frstdby,
grussian	0:c175921ca7c3	68	PinName sense1, PinName sense2, float vref,float rsense,float rd1,float rd2);
grussian	0:c175921ca7c3	69
grussian	0:c175921ca7c3	70	/**
grussian	0:c175921ca7c3	71	* @brief Initialize the singleton's power swicth to default settings
grussian	0:c175921ca7c3	72	* @retval true if initialization successful,
grussian	0:c175921ca7c3	73	* @retval false otherwise
grussian	0:c175921ca7c3	74	*/
grussian	0:c175921ca7c3	75	bool Init(void) {
grussian	0:c175921ca7c3	76	return (Init_VPS235H2());
grussian	0:c175921ca7c3	77	}
grussian	0:c175921ca7c3	78
grussian	0:c175921ca7c3	79	bool Init_VPS235H2(void);
grussian	0:c175921ca7c3	80
grussian	0:c175921ca7c3	81	public:
grussian	0:c175921ca7c3	82	static X_NUCLEO_IPS02A1& Instance (PinName in1, PinName in2, PinName frstdby,
grussian	0:c175921ca7c3	83	PinName sense1, PinName sense2, float vref,float rsense,float rd1,float rd2);
grussian	0:c175921ca7c3	84	float GetCurrent(int Ch);
grussian	0:c175921ca7c3	85
grussian	0:c175921ca7c3	86
grussian	0:c175921ca7c3	87	VPS235H2 &vps235h2;
grussian	0:c175921ca7c3	88	private:
grussian	0:c175921ca7c3	89	static X_NUCLEO_IPS02A1 *_instance;
grussian	0:c175921ca7c3	90
grussian	0:c175921ca7c3	91	};
grussian	0:c175921ca7c3	92
grussian	0:c175921ca7c3	93
grussian	0:c175921ca7c3	94
grussian	0:c175921ca7c3	95
grussian	0:c175921ca7c3	96	#endif /* __X_NUCLEO_IPS02A1_H */
grussian	0:c175921ca7c3	97
grussian	0:c175921ca7c3	98
grussian	0:c175921ca7c3	99
grussian	0:c175921ca7c3	100	/********************** (C) COPYRIGHT STMicroelectronics *END OF FILE**/
grussian	0:c175921ca7c3	101
grussian	0:c175921ca7c3	102