Álvaro de Rada / X_NUCLEO_PLC01A1

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Components/Interfaces/PLCInput_class.h@4:e97bbb97aa43, 2016-02-24 (annotated)

Committer:
apalmieri
Date:
Wed Feb 24 10:52:31 2016 +0000
Revision:
4:e97bbb97aa43
Parent:
0:b66a560b6618 
Class renaming to keep coherence w/ other expansion board drivers

Who changed what in which revision?

UserRevisionLine numberNew contents of line
apalmieri 0:b66a560b6618 1 /**
apalmieri 0:b66a560b6618 2 ******************************************************************************
apalmieri 0:b66a560b6618 3 * @file PLCInput_class.h
apalmieri 0:b66a560b6618 4 * @author AST/CL
apalmieri 0:b66a560b6618 5 * @version V1.0.0
apalmieri 0:b66a560b6618 6 * @date Feb 4th, 2016
apalmieri 0:b66a560b6618 7 * @brief This file contains the abstract class describing the interface of a
apalmieri 0:b66a560b6618 8 * PLC input component.
apalmieri 0:b66a560b6618 9 ******************************************************************************
apalmieri 0:b66a560b6618 10 * @attention
apalmieri 0:b66a560b6618 11 *
apalmieri 0:b66a560b6618 12 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
apalmieri 0:b66a560b6618 13 *
apalmieri 0:b66a560b6618 14 * Redistribution and use in source and binary forms, with or without modification,
apalmieri 0:b66a560b6618 15 * are permitted provided that the following conditions are met:
apalmieri 0:b66a560b6618 16 * 1. Redistributions of source code must retain the above copyright notice,
apalmieri 0:b66a560b6618 17 * this list of conditions and the following disclaimer.
apalmieri 0:b66a560b6618 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
apalmieri 0:b66a560b6618 19 * this list of conditions and the following disclaimer in the documentation
apalmieri 0:b66a560b6618 20 * and/or other materials provided with the distribution.
apalmieri 0:b66a560b6618 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
apalmieri 0:b66a560b6618 22 * may be used to endorse or promote products derived from this software
apalmieri 0:b66a560b6618 23 * without specific prior written permission.
apalmieri 0:b66a560b6618 24 *
apalmieri 0:b66a560b6618 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
apalmieri 0:b66a560b6618 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
apalmieri 0:b66a560b6618 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
apalmieri 0:b66a560b6618 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
apalmieri 0:b66a560b6618 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
apalmieri 0:b66a560b6618 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
apalmieri 0:b66a560b6618 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
apalmieri 0:b66a560b6618 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
apalmieri 0:b66a560b6618 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
apalmieri 0:b66a560b6618 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
apalmieri 0:b66a560b6618 35 *
apalmieri 0:b66a560b6618 36 ******************************************************************************
apalmieri 0:b66a560b6618 37 */
apalmieri 0:b66a560b6618 38
apalmieri 0:b66a560b6618 39
apalmieri 0:b66a560b6618 40 /* Define to prevent from recursive inclusion --------------------------------*/
apalmieri 0:b66a560b6618 41
apalmieri 0:b66a560b6618 42 #ifndef __PLCINPUT_CLASS_H
apalmieri 0:b66a560b6618 43 #define __PLCINPUT_CLASS_H
apalmieri 0:b66a560b6618 44
apalmieri 0:b66a560b6618 45
apalmieri 0:b66a560b6618 46 /* Includes ------------------------------------------------------------------*/
apalmieri 0:b66a560b6618 47
apalmieri 0:b66a560b6618 48 #include <Component_class.h>
apalmieri 0:b66a560b6618 49
apalmieri 0:b66a560b6618 50
apalmieri 0:b66a560b6618 51 /* Classes ------------------------------------------------------------------*/
apalmieri 0:b66a560b6618 52
apalmieri 0:b66a560b6618 53 /** An abstract class for PLCInput component.
apalmieri 0:b66a560b6618 54 */
apalmieri 0:b66a560b6618 55 class PLCInput : public Component
apalmieri 0:b66a560b6618 56 {
apalmieri 0:b66a560b6618 57 public:
apalmieri 0:b66a560b6618 58
apalmieri 0:b66a560b6618 59 /**
apalmieri 0:b66a560b6618 60 * @brief Get Read Status
apalmieri 0:b66a560b6618 61 * @param None
apalmieri 0:b66a560b6618 62 * @retval Status
apalmieri 0:b66a560b6618 63 */
apalmieri 0:b66a560b6618 64 virtual uint8_t GetReadStatus(void) = 0;
apalmieri 0:b66a560b6618 65
apalmieri 0:b66a560b6618 66 /**
apalmieri 0:b66a560b6618 67 * @brief Set Read Status
apalmieri 0:b66a560b6618 68 * @param Status
apalmieri 0:b66a560b6618 69 * @retval None
apalmieri 0:b66a560b6618 70 */
apalmieri 0:b66a560b6618 71 virtual void SetReadStatus(uint8_t status) = 0;
apalmieri 0:b66a560b6618 72
apalmieri 0:b66a560b6618 73 /**
apalmieri 0:b66a560b6618 74 * @brief Get Input Status
apalmieri 0:b66a560b6618 75 * @param None
apalmieri 0:b66a560b6618 76 * @retval Channels status corresponding to 8 inputs
apalmieri 0:b66a560b6618 77 */
apalmieri 0:b66a560b6618 78 virtual uint8_t GetInputData(void) = 0;
apalmieri 0:b66a560b6618 79
apalmieri 0:b66a560b6618 80 /**
apalmieri 0:b66a560b6618 81 * @brief Over Temperature Alarm bit
apalmieri 0:b66a560b6618 82 * @param None
apalmieri 0:b66a560b6618 83 * @retval Overtemperature bit, 1 in case of alarm
apalmieri 0:b66a560b6618 84 */
apalmieri 0:b66a560b6618 85 virtual uint8_t OverTempAlarm(void) = 0;
apalmieri 0:b66a560b6618 86
apalmieri 0:b66a560b6618 87 /**
apalmieri 0:b66a560b6618 88 * @brief Parity Check bits
apalmieri 0:b66a560b6618 89 * @param None
apalmieri 0:b66a560b6618 90 * @retval Parity bits for diagnosing inconsistency in data transmission
apalmieri 0:b66a560b6618 91 */
apalmieri 0:b66a560b6618 92 virtual uint8_t CheckParity(void) = 0;
apalmieri 0:b66a560b6618 93
apalmieri 0:b66a560b6618 94 /**
apalmieri 0:b66a560b6618 95 * @brief Under Voltage Alarm bit
apalmieri 0:b66a560b6618 96 * @param None
apalmieri 0:b66a560b6618 97 * @retval Under voltage alarm bit, 1 in case of alarm
apalmieri 0:b66a560b6618 98 */
apalmieri 0:b66a560b6618 99 virtual uint8_t UnderVoltAlarm(void) = 0;
apalmieri 0:b66a560b6618 100
apalmieri 0:b66a560b6618 101 /**
apalmieri 0:b66a560b6618 102 * @brief Get input information from input channels component
apalmieri 0:b66a560b6618 103 * @param RX buffer
apalmieri 0:b66a560b6618 104 * @retval None
apalmieri 0:b66a560b6618 105 */
apalmieri 0:b66a560b6618 106 virtual void DigInpArray_GetInput(uint8_t *inputArray) = 0;
apalmieri 0:b66a560b6618 107
apalmieri 0:b66a560b6618 108 /* Auxiliary method to enable or disable SPI CS pin */
apalmieri 0:b66a560b6618 109 virtual void setInputSPI(uint8_t l) = 0;
apalmieri 0:b66a560b6618 110 };
apalmieri 0:b66a560b6618 111
apalmieri 0:b66a560b6618 112 #endif /* __PLCINPUT_CLASS_H */
apalmieri 0:b66a560b6618 113
apalmieri 0:b66a560b6618 114 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/