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

X-NUCLEO-IPS02A1 - 24V Intelligent power switch expansion board