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);
Components/VPS2535H/VPS2535H.cpp@7:10e489682b80, 2017-05-09 (annotated)
- Committer:
- Davidroid
- Date:
- Tue May 09 09:37:03 2017 +0000
- Revision:
- 7:10e489682b80
- Parent:
- Components/vps2535h/vps2535h_class.cpp@6:c313d3a5c61a
- Child:
- 8:73df2d2b721c
Aligned to ARM mbed coding style.
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
grussian | 0:c175921ca7c3 | 1 | /** |
grussian | 4:715dcaf74418 | 2 | ****************************************************************************** |
Davidroid | 7:10e489682b80 | 3 | * @file VPS2535H.cpp |
grussian | 5:b683e69b181c | 4 | * @author ADG |
grussian | 5:b683e69b181c | 5 | * @version V1.0.1 |
grussian | 5:b683e69b181c | 6 | * @date 01-July-2016 |
grussian | 5:b683e69b181c | 7 | * @brief implementatio for VPS2535H driver class |
grussian | 4:715dcaf74418 | 8 | ****************************************************************************** |
grussian | 4:715dcaf74418 | 9 | * @attention |
grussian | 4:715dcaf74418 | 10 | * |
grussian | 6:c313d3a5c61a | 11 | * <h2><center>© COPYRIGHT(c) 2016 STMicroelectronics</center></h2> |
grussian | 4:715dcaf74418 | 12 | * |
grussian | 4:715dcaf74418 | 13 | * Redistribution and use in source and binary forms, with or without modification, |
grussian | 4:715dcaf74418 | 14 | * are permitted provided that the following conditions are met: |
grussian | 4:715dcaf74418 | 15 | * 1. Redistributions of source code must retain the above copyright notice, |
grussian | 4:715dcaf74418 | 16 | * this list of conditions and the following disclaimer. |
grussian | 4:715dcaf74418 | 17 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
grussian | 4:715dcaf74418 | 18 | * this list of conditions and the following disclaimer in the documentation |
grussian | 4:715dcaf74418 | 19 | * and/or other materials provided with the distribution. |
grussian | 4:715dcaf74418 | 20 | * 3. Neither the name of STMicroelectronics nor the names of its contributors |
grussian | 4:715dcaf74418 | 21 | * may be used to endorse or promote products derived from this software |
grussian | 4:715dcaf74418 | 22 | * without specific prior written permission. |
grussian | 4:715dcaf74418 | 23 | * |
grussian | 4:715dcaf74418 | 24 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
grussian | 4:715dcaf74418 | 25 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
grussian | 4:715dcaf74418 | 26 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
grussian | 4:715dcaf74418 | 27 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
grussian | 4:715dcaf74418 | 28 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
grussian | 4:715dcaf74418 | 29 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
grussian | 4:715dcaf74418 | 30 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
grussian | 4:715dcaf74418 | 31 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
grussian | 4:715dcaf74418 | 32 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
grussian | 4:715dcaf74418 | 33 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
grussian | 4:715dcaf74418 | 34 | * |
grussian | 4:715dcaf74418 | 35 | ****************************************************************************** |
grussian | 4:715dcaf74418 | 36 | */ |
grussian | 0:c175921ca7c3 | 37 | |
Davidroid | 7:10e489682b80 | 38 | |
grussian | 0:c175921ca7c3 | 39 | /* Includes ------------------------------------------------------------------*/ |
Davidroid | 7:10e489682b80 | 40 | #include "VPS2535H.h" |
grussian | 0:c175921ca7c3 | 41 | |
grussian | 0:c175921ca7c3 | 42 | |
grussian | 0:c175921ca7c3 | 43 | /* Methods -------------------------------------------------------------------*/ |
Davidroid | 7:10e489682b80 | 44 | |
grussian | 0:c175921ca7c3 | 45 | /** |
grussian | 5:b683e69b181c | 46 | * @brief Set VPS2535H Initialization |
grussian | 5:b683e69b181c | 47 | * @param VPS2535H handel structure |
grussian | 0:c175921ca7c3 | 48 | * @retval IPS_SUCCESS |
grussian | 0:c175921ca7c3 | 49 | */ |
Davidroid | 7:10e489682b80 | 50 | int VPS2535H::init(void *init_struct) { |
Davidroid | 7:10e489682b80 | 51 | VPS2535H_init(); |
Davidroid | 7:10e489682b80 | 52 | return IPS_SUCCESS; |
Davidroid | 7:10e489682b80 | 53 | } |
grussian | 0:c175921ca7c3 | 54 | |
grussian | 0:c175921ca7c3 | 55 | /** |
grussian | 5:b683e69b181c | 56 | * @brief Close VPS2535H |
grussian | 0:c175921ca7c3 | 57 | * @param none |
grussian | 0:c175921ca7c3 | 58 | * @retval IPS_SUCCESS |
grussian | 0:c175921ca7c3 | 59 | */ |
Davidroid | 7:10e489682b80 | 60 | int VPS2535H::close(void) { |
Davidroid | 7:10e489682b80 | 61 | VPS2535H_close(); |
Davidroid | 7:10e489682b80 | 62 | return IPS_SUCCESS; |
Davidroid | 7:10e489682b80 | 63 | } |
grussian | 0:c175921ca7c3 | 64 | |
grussian | 0:c175921ca7c3 | 65 | /* Module Interface */ |
grussian | 0:c175921ca7c3 | 66 | /** |
grussian | 5:b683e69b181c | 67 | * @brief Initializes the VPS2535H device |
grussian | 0:c175921ca7c3 | 68 | * @param none |
grussian | 5:b683e69b181c | 69 | * @retval VPS2535H status |
grussian | 0:c175921ca7c3 | 70 | */ |
Davidroid | 7:10e489682b80 | 71 | IPS_StatusTypeDef VPS2535H::VPS2535H_init() { |
Davidroid | 7:10e489682b80 | 72 | Fr_Stby = 1; |
Davidroid | 7:10e489682b80 | 73 | return IPS_SUCCESS; |
grussian | 0:c175921ca7c3 | 74 | } |
grussian | 0:c175921ca7c3 | 75 | |
grussian | 0:c175921ca7c3 | 76 | /** |
grussian | 5:b683e69b181c | 77 | * @brief Close (Deinitialize) the VPS2535H device and used peripheral. |
grussian | 0:c175921ca7c3 | 78 | * @param None |
grussian | 5:b683e69b181c | 79 | * @retval VPS2535H status |
grussian | 0:c175921ca7c3 | 80 | */ |
Davidroid | 7:10e489682b80 | 81 | IPS_StatusTypeDef VPS2535H::VPS2535H_close(){ |
grussian | 0:c175921ca7c3 | 82 | Fr_Stby = 1; |
grussian | 0:c175921ca7c3 | 83 | return IPS_SUCCESS; |
grussian | 0:c175921ca7c3 | 84 | } |
grussian | 0:c175921ca7c3 | 85 | |
grussian | 0:c175921ca7c3 | 86 | /** |
grussian | 0:c175921ca7c3 | 87 | * @brief GetSense function gets the value of the Sense power switch output pin |
grussian | 0:c175921ca7c3 | 88 | * (for either Ch1 or Ch2) upon IO conversion. It just reads from sense pin |
grussian | 5:b683e69b181c | 89 | * @param hips: pointer to a VPS2535H_HandleTypeDef structure that contains |
grussian | 5:b683e69b181c | 90 | * the configuration information for the specified VPS2535H module. |
grussian | 0:c175921ca7c3 | 91 | * Value got from V-sense output is stored in hips->SenseValue |
grussian | 0:c175921ca7c3 | 92 | * field. Status of the operation is stored in hips->Status and |
grussian | 0:c175921ca7c3 | 93 | * hips->Status fields |
grussian | 0:c175921ca7c3 | 94 | * @retval IPS_StatusTypeDef status |
grussian | 0:c175921ca7c3 | 95 | */ |
Davidroid | 7:10e489682b80 | 96 | IPS_StatusTypeDef VPS2535H::VPS2535H_get_sense_channel_diagnostic(IPS_HandleTypeDef *hips){ |
grussian | 0:c175921ca7c3 | 97 | hips->SenseRawValue = 0; //if channel is wrong Sense value is 0 |
grussian | 5:b683e69b181c | 98 | hips->GNDSenseRawValue = 0; // VPS2535H doesn't require GND measurement compensation |
grussian | 0:c175921ca7c3 | 99 | hips-> Status =IPS_WRONG_CHANNEL; |
grussian | 0:c175921ca7c3 | 100 | hips->IO_Status = IPS_IO_FAIL; |
grussian | 0:c175921ca7c3 | 101 | if (hips ->ipsChannel == CHANNEL_1) |
grussian | 0:c175921ca7c3 | 102 | hips->SenseRawValue = CurrentSense1.read() * V_REF * ((R_D1+R_D2)/(R_D2)); |
grussian | 0:c175921ca7c3 | 103 | if (hips ->ipsChannel == CHANNEL_2) |
grussian | 0:c175921ca7c3 | 104 | hips->SenseRawValue = CurrentSense2.read() * V_REF * ((R_D1+R_D2)/(R_D2)); |
grussian | 0:c175921ca7c3 | 105 | |
grussian | 0:c175921ca7c3 | 106 | hips->IO_Status = IPS_IO_SUCCESS; |
grussian | 0:c175921ca7c3 | 107 | hips->Status =IPS_SUCCESS; |
grussian | 0:c175921ca7c3 | 108 | return hips-> Status; |
grussian | 0:c175921ca7c3 | 109 | } |
grussian | 0:c175921ca7c3 | 110 | |
grussian | 0:c175921ca7c3 | 111 | /** |
grussian | 0:c175921ca7c3 | 112 | * @brief GetSecureCurrentSense function gets the I-sense switch output pin |
grussian | 0:c175921ca7c3 | 113 | * upon ADC conversion. |
grussian | 0:c175921ca7c3 | 114 | * @param hips: pointer to a IPS_HandleTypeDef structure that contains |
grussian | 5:b683e69b181c | 115 | * the configuration information for the specified VPS2535H module. |
grussian | 0:c175921ca7c3 | 116 | * Value got from V-sense output is stored in hips->SenseValue |
grussian | 0:c175921ca7c3 | 117 | * field. |
grussian | 0:c175921ca7c3 | 118 | * Status of the operation is stored in hips->Status fields |
grussian | 0:c175921ca7c3 | 119 | * @retval IPS status |
grussian | 0:c175921ca7c3 | 120 | */ |
Davidroid | 7:10e489682b80 | 121 | IPS_StatusTypeDef VPS2535H::VPS2535H_get_secure_current_sense(IPS_HandleTypeDef *hips){ |
grussian | 0:c175921ca7c3 | 122 | |
Davidroid | 7:10e489682b80 | 123 | if ((hips ->ipsChannel != CHANNEL_1) && (hips ->ipsChannel != CHANNEL_2)) { |
grussian | 0:c175921ca7c3 | 124 | hips->Status = IPS_WRONG_CHANNEL; |
grussian | 0:c175921ca7c3 | 125 | return IPS_WRONG_CHANNEL; |
grussian | 0:c175921ca7c3 | 126 | } |
grussian | 0:c175921ca7c3 | 127 | |
grussian | 0:c175921ca7c3 | 128 | /* Get sense feedback */ |
Davidroid | 7:10e489682b80 | 129 | if ((VPS2535H_get_sense_channel_diagnostic(hips) == IPS_SUCCESS) && (hips->Status == IPS_SUCCESS)) { |
grussian | 0:c175921ca7c3 | 130 | hips->IValue= K*hips->SenseRawValue/R_SENSE; |
grussian | 0:c175921ca7c3 | 131 | return IPS_SUCCESS; |
grussian | 0:c175921ca7c3 | 132 | } |
grussian | 0:c175921ca7c3 | 133 | else |
grussian | 0:c175921ca7c3 | 134 | return IPS_FAIL; // see hips->Status |
grussian | 0:c175921ca7c3 | 135 | } |
grussian | 0:c175921ca7c3 | 136 | |
grussian | 0:c175921ca7c3 | 137 | /** |
grussian | 0:c175921ca7c3 | 138 | * @brief GetCurrent function gets the I-sense switch output pin |
grussian | 0:c175921ca7c3 | 139 | * @param Ch: Channel number. Possible value are CHANNEL_1 or CHANNEL_2 |
grussian | 0:c175921ca7c3 | 140 | * @retval Current Value |
grussian | 0:c175921ca7c3 | 141 | */ |
Davidroid | 7:10e489682b80 | 142 | float VPS2535H::get_current(int Ch) { |
grussian | 0:c175921ca7c3 | 143 | |
Davidroid | 7:10e489682b80 | 144 | if (Ch == CHANNEL_1) { |
grussian | 0:c175921ca7c3 | 145 | return (K*CurrentSense1.read()* ((R_D1+R_D2)/(R_D2)) * V_REF/R_SENSE); |
Davidroid | 7:10e489682b80 | 146 | } |
Davidroid | 7:10e489682b80 | 147 | if (Ch == CHANNEL_2) { |
grussian | 0:c175921ca7c3 | 148 | return (K*CurrentSense2.read()* ((R_D1+R_D2)/(R_D2)) * V_REF/R_SENSE); |
Davidroid | 7:10e489682b80 | 149 | } |
grussian | 0:c175921ca7c3 | 150 | return 0; |
grussian | 0:c175921ca7c3 | 151 | } |
grussian | 0:c175921ca7c3 | 152 | |
grussian | 0:c175921ca7c3 | 153 | |
grussian | 0:c175921ca7c3 | 154 | /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ |