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/vps235h2/vps235h2_class.cpp
- Committer:
- grussian
- Date:
- 2016-04-07
- Revision:
- 2:06d0eb54630a
- Parent:
- 0:c175921ca7c3
- Child:
- 4:715dcaf74418
File content as of revision 2:06d0eb54630a:
/** ****************************************************************************** * @file vps235h2.cpp * @author APG Mass Market * @version V1.0.0 * @date 01-July-2015 * @brief implementatio for VPS235H2 driver class ****************************************************************************** * @attention * * <h2><center>© COPYRIGHT(c) 2014 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. * ****************************************************************************** */ /* Includes ------------------------------------------------------------------*/ #include "vps235h2_class.h" #include "vps235h2.h" /* Methods -------------------------------------------------------------------*/ /** * @brief Set VPS235H2 Initialization * @param VPS235H2 handel structure * @retval IPS_SUCCESS */ int VPS235H2 :: Init(void *init_struct) { VPS235H2_Init(); return IPS_SUCCESS; } /** * @brief Close VPS235H2 * @param none * @retval IPS_SUCCESS */ int VPS235H2 :: Close(void) { VPS235H2_Close(); return IPS_SUCCESS; } /* Module Interface */ /** * @brief Initializes the VPS235H2 device * @param none * @retval VPS235H2 status */ IPS_StatusTypeDef VPS235H2 :: VPS235H2_Init(){ Fr_Stby = 1; return IPS_SUCCESS; } /** * @brief Close (Deinitialize) the VPS235H2 device and used peripheral. * @param None * @retval VPS235H2 status */ IPS_StatusTypeDef VPS235H2 :: VPS235H2_Close(){ Fr_Stby = 1; return IPS_SUCCESS; } /** * @brief GetSense function gets the value of the Sense power switch output pin * (for either Ch1 or Ch2) upon IO conversion. It just reads from sense pin * @param hips: pointer to a VPS235H2_HandleTypeDef structure that contains * the configuration information for the specified VPS235H2 module. * Value got from V-sense output is stored in hips->SenseValue * field. Status of the operation is stored in hips->Status and * hips->Status fields * @retval IPS_StatusTypeDef status */ IPS_StatusTypeDef VPS235H2 :: VPS235H2_GetSenseChannelDiagnostic(IPS_HandleTypeDef *hips){ hips->SenseRawValue = 0; //if channel is wrong Sense value is 0 hips->GNDSenseRawValue = 0; // VPS235H2 doesn't require GND measurement compensation hips-> Status =IPS_WRONG_CHANNEL; hips->IO_Status = IPS_IO_FAIL; if (hips ->ipsChannel == CHANNEL_1) hips->SenseRawValue = CurrentSense1.read() * V_REF * ((R_D1+R_D2)/(R_D2)); if (hips ->ipsChannel == CHANNEL_2) hips->SenseRawValue = CurrentSense2.read() * V_REF * ((R_D1+R_D2)/(R_D2)); hips->IO_Status = IPS_IO_SUCCESS; hips->Status =IPS_SUCCESS; return hips-> Status; } /** * @brief GetSecureCurrentSense function gets the I-sense switch output pin * upon ADC conversion. * @param hips: pointer to a IPS_HandleTypeDef structure that contains * the configuration information for the specified VPS235H2 module. * Value got from V-sense output is stored in hips->SenseValue * field. * Status of the operation is stored in hips->Status fields * @retval IPS status */ IPS_StatusTypeDef VPS235H2 :: VPS235H2_GetSecureCurrentSense(IPS_HandleTypeDef *hips){ if ((hips ->ipsChannel != CHANNEL_1) && (hips ->ipsChannel != CHANNEL_2) ){ hips->Status = IPS_WRONG_CHANNEL; return IPS_WRONG_CHANNEL; } /* Get sense feedback */ if ((VPS235H2_GetSenseChannelDiagnostic(hips) == IPS_SUCCESS) && (hips->Status == IPS_SUCCESS)){ hips->IValue= K*hips->SenseRawValue/R_SENSE; return IPS_SUCCESS; } else return IPS_FAIL; // see hips->Status } /** * @brief GetCurrent function gets the I-sense switch output pin * @param Ch: Channel number. Possible value are CHANNEL_1 or CHANNEL_2 * @retval Current Value */ float VPS235H2 :: GetCurrent(int Ch){ if (Ch == CHANNEL_1) return (K*CurrentSense1.read()* ((R_D1+R_D2)/(R_D2)) * V_REF/R_SENSE); if (Ch == CHANNEL_2) return (K*CurrentSense2.read()* ((R_D1+R_D2)/(R_D2)) * V_REF/R_SENSE); return 0; } /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/