ST / ST_INTERFACES

Official interfaces for ST components.

Dependents:   X_NUCLEO_IKS01A1 mDot_X_NUCLEO_IKS01A1 53L0A1 X_NUCLEO_IKS01A1 ... more

Fork of ST_INTERFACES by Davide Aliprandi

This library contains all abstract classes which together constitute the common API to which all existing and future ST components will adhere to.

Actuators/BCDMotor.h@1:a7810e7acf8d, 2016-09-27 (annotated)

Committer:
Davidroid
Date:
Tue Sep 27 11:28:52 2016 +0000
Revision:
1:a7810e7acf8d
LightSensor, RangeSensor, Nfc interfaces added.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Davidroid 1:a7810e7acf8d 1 /**
Davidroid 1:a7810e7acf8d 2 ******************************************************************************
Davidroid 1:a7810e7acf8d 3 * @file BCDMotor.h
Davidroid 1:a7810e7acf8d 4 * @author IPC Rennes
Davidroid 1:a7810e7acf8d 5 * @version V1.0.0
Davidroid 1:a7810e7acf8d 6 * @date April 6th, 2016
Davidroid 1:a7810e7acf8d 7 * @brief This file contains the abstract class describing the interface of a
Davidroid 1:a7810e7acf8d 8 * Brush DC motor component.
Davidroid 1:a7810e7acf8d 9 ******************************************************************************
Davidroid 1:a7810e7acf8d 10 * @attention
Davidroid 1:a7810e7acf8d 11 *
Davidroid 1:a7810e7acf8d 12 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
Davidroid 1:a7810e7acf8d 13 *
Davidroid 1:a7810e7acf8d 14 * Redistribution and use in source and binary forms, with or without modification,
Davidroid 1:a7810e7acf8d 15 * are permitted provided that the following conditions are met:
Davidroid 1:a7810e7acf8d 16 * 1. Redistributions of source code must retain the above copyright notice,
Davidroid 1:a7810e7acf8d 17 * this list of conditions and the following disclaimer.
Davidroid 1:a7810e7acf8d 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
Davidroid 1:a7810e7acf8d 19 * this list of conditions and the following disclaimer in the documentation
Davidroid 1:a7810e7acf8d 20 * and/or other materials provided with the distribution.
Davidroid 1:a7810e7acf8d 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Davidroid 1:a7810e7acf8d 22 * may be used to endorse or promote products derived from this software
Davidroid 1:a7810e7acf8d 23 * without specific prior written permission.
Davidroid 1:a7810e7acf8d 24 *
Davidroid 1:a7810e7acf8d 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Davidroid 1:a7810e7acf8d 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Davidroid 1:a7810e7acf8d 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Davidroid 1:a7810e7acf8d 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Davidroid 1:a7810e7acf8d 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Davidroid 1:a7810e7acf8d 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Davidroid 1:a7810e7acf8d 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Davidroid 1:a7810e7acf8d 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Davidroid 1:a7810e7acf8d 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Davidroid 1:a7810e7acf8d 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Davidroid 1:a7810e7acf8d 35 *
Davidroid 1:a7810e7acf8d 36 ******************************************************************************
Davidroid 1:a7810e7acf8d 37 */
Davidroid 1:a7810e7acf8d 38
Davidroid 1:a7810e7acf8d 39
Davidroid 1:a7810e7acf8d 40 /* Define to prevent from recursive inclusion --------------------------------*/
Davidroid 1:a7810e7acf8d 41
Davidroid 1:a7810e7acf8d 42 #ifndef __BCDMMOTOR_CLASS_H
Davidroid 1:a7810e7acf8d 43 #define __BCDMMOTOR_CLASS_H
Davidroid 1:a7810e7acf8d 44
Davidroid 1:a7810e7acf8d 45
Davidroid 1:a7810e7acf8d 46 /* Includes ------------------------------------------------------------------*/
Davidroid 1:a7810e7acf8d 47
Davidroid 1:a7810e7acf8d 48 #include <ComponentObject.h>
Davidroid 1:a7810e7acf8d 49
Davidroid 1:a7810e7acf8d 50
Davidroid 1:a7810e7acf8d 51 /* Classes ------------------------------------------------------------------*/
Davidroid 1:a7810e7acf8d 52
Davidroid 1:a7810e7acf8d 53 /** An abstract class for BDCMotor components.
Davidroid 1:a7810e7acf8d 54 */
Davidroid 1:a7810e7acf8d 55 class BDCMotor : public ComponentObject
Davidroid 1:a7810e7acf8d 56 {
Davidroid 1:a7810e7acf8d 57 public:
Davidroid 1:a7810e7acf8d 58 /**
Davidroid 1:a7810e7acf8d 59 * @brief Rotation modes.
Davidroid 1:a7810e7acf8d 60 */
Davidroid 1:a7810e7acf8d 61 typedef enum
Davidroid 1:a7810e7acf8d 62 {
Davidroid 1:a7810e7acf8d 63 BWD = 0, /* Backward. */
Davidroid 1:a7810e7acf8d 64 FWD = 1 /* Forward. */
Davidroid 1:a7810e7acf8d 65 } direction_t;
Davidroid 1:a7810e7acf8d 66
Davidroid 1:a7810e7acf8d 67 /**
Davidroid 1:a7810e7acf8d 68 * @brief Disabling the specified bridge.
Davidroid 1:a7810e7acf8d 69 * @param bridgeId from 0 for bridge A to 1 for bridge B.
Davidroid 1:a7810e7acf8d 70 * @retval None.
Davidroid 1:a7810e7acf8d 71 */
Davidroid 1:a7810e7acf8d 72 virtual void DisableBridge(unsigned int) = 0;
Davidroid 1:a7810e7acf8d 73
Davidroid 1:a7810e7acf8d 74 /**
Davidroid 1:a7810e7acf8d 75 * @brief Enabling the specified bridge.
Davidroid 1:a7810e7acf8d 76 * @param bridgeId from 0 for bridge A to 1 for bridge B
Davidroid 1:a7810e7acf8d 77 * @retval None.
Davidroid 1:a7810e7acf8d 78 */
Davidroid 1:a7810e7acf8d 79 virtual void EnableBridge(unsigned int) = 0;
Davidroid 1:a7810e7acf8d 80
Davidroid 1:a7810e7acf8d 81 /**
Davidroid 1:a7810e7acf8d 82 * @brief Getting the PWM frequency of the specified bridge;
Davidroid 1:a7810e7acf8d 83 * @param bridgeId from 0 for bridge A to 1 for bridge B.
Davidroid 1:a7810e7acf8d 84 * @retval The frequency in Hz of the specified bridge input PWM.
Davidroid 1:a7810e7acf8d 85 */
Davidroid 1:a7810e7acf8d 86 virtual unsigned int GetBridgeInputPwmFreq(unsigned int) = 0;
Davidroid 1:a7810e7acf8d 87
Davidroid 1:a7810e7acf8d 88 /**
Davidroid 1:a7810e7acf8d 89 * @brief Getting the bridge status.
Davidroid 1:a7810e7acf8d 90 * @param bridgeId from 0 for bridge A to 1 for bridge B.
Davidroid 1:a7810e7acf8d 91 * @retval The status.
Davidroid 1:a7810e7acf8d 92 */
Davidroid 1:a7810e7acf8d 93 virtual unsigned int GetBridgeStatus(unsigned int) = 0;
Davidroid 1:a7810e7acf8d 94
Davidroid 1:a7810e7acf8d 95 /**
Davidroid 1:a7810e7acf8d 96 * @brief Getting the device State.
Davidroid 1:a7810e7acf8d 97 * @param motorId from 0 to (MAX_NUMBER_OF_BRUSH_DC_MOTORS - 1).
Davidroid 1:a7810e7acf8d 98 * @retval The device state
Davidroid 1:a7810e7acf8d 99 */
Davidroid 1:a7810e7acf8d 100 virtual motorState_t GetDeviceState(unsigned int) = 0;
Davidroid 1:a7810e7acf8d 101
Davidroid 1:a7810e7acf8d 102 /**
Davidroid 1:a7810e7acf8d 103 * @brief Getting the current speed in % of the specified motor.
Davidroid 1:a7810e7acf8d 104 * @param motorId from 0 to (MAX_NUMBER_OF_BRUSH_DC_MOTORS - 1).
Davidroid 1:a7810e7acf8d 105 * @retval The current speed in %.
Davidroid 1:a7810e7acf8d 106 */
Davidroid 1:a7810e7acf8d 107 virtual unsigned int GetSpeed(unsigned int) = 0;
Davidroid 1:a7810e7acf8d 108
Davidroid 1:a7810e7acf8d 109 /**
Davidroid 1:a7810e7acf8d 110 * @brief Stopping the motor and disabling the power bridge immediately.
Davidroid 1:a7810e7acf8d 111 * @param motorId from 0 to (MAX_NUMBER_OF_BRUSH_DC_MOTORS - 1).
Davidroid 1:a7810e7acf8d 112 * @retval None.
Davidroid 1:a7810e7acf8d 113 */
Davidroid 1:a7810e7acf8d 114 virtual void HardHiZ(unsigned int) = 0;
Davidroid 1:a7810e7acf8d 115
Davidroid 1:a7810e7acf8d 116 /**
Davidroid 1:a7810e7acf8d 117 * @brief Stopping the motor immediately.
Davidroid 1:a7810e7acf8d 118 * @param motorId from 0 to (MAX_NUMBER_OF_BRUSH_DC_MOTORS - 1).
Davidroid 1:a7810e7acf8d 119 * @retval None.
Davidroid 1:a7810e7acf8d 120 */
Davidroid 1:a7810e7acf8d 121 virtual void HardStop(unsigned int) = 0;
Davidroid 1:a7810e7acf8d 122
Davidroid 1:a7810e7acf8d 123 /**
Davidroid 1:a7810e7acf8d 124 * @brief Running the motor.
Davidroid 1:a7810e7acf8d 125 * @param motorId from 0 to (MAX_NUMBER_OF_BRUSH_DC_MOTORS - 1).
Davidroid 1:a7810e7acf8d 126 * @param direction The direction of rotation.
Davidroid 1:a7810e7acf8d 127 * @retval None.
Davidroid 1:a7810e7acf8d 128 */
Davidroid 1:a7810e7acf8d 129 virtual void Run(unsigned int, direction_t) = 0;
Davidroid 1:a7810e7acf8d 130
Davidroid 1:a7810e7acf8d 131 /**
Davidroid 1:a7810e7acf8d 132 * @brief Setting the PWM frequency of the specified bridge.
Davidroid 1:a7810e7acf8d 133 * @param bridgeId from 0 for bridge A to 1 for bridge B.
Davidroid 1:a7810e7acf8d 134 * @param frequency of the PWM in Hz
Davidroid 1:a7810e7acf8d 135 * @retval None.
Davidroid 1:a7810e7acf8d 136 */
Davidroid 1:a7810e7acf8d 137 virtual void SetBridgeInputPwmFreq(unsigned int, unsigned int) = 0;
Davidroid 1:a7810e7acf8d 138
Davidroid 1:a7810e7acf8d 139 /**
Davidroid 1:a7810e7acf8d 140 * @brief Setting the dual bridge configuration mode.
Davidroid 1:a7810e7acf8d 141 * @param configuration. The bridge configuration.
Davidroid 1:a7810e7acf8d 142 * @retval None.
Davidroid 1:a7810e7acf8d 143 */
Davidroid 1:a7810e7acf8d 144 virtual void SetDualFullBridgeConfig(unsigned int) = 0;
Davidroid 1:a7810e7acf8d 145
Davidroid 1:a7810e7acf8d 146 /**
Davidroid 1:a7810e7acf8d 147 * @brief Setting the speed in %.
Davidroid 1:a7810e7acf8d 148 * @param motorId from 0 to (MAX_NUMBER_OF_BRUSH_DC_MOTORS - 1).
Davidroid 1:a7810e7acf8d 149 * @param speed The new speed in %.
Davidroid 1:a7810e7acf8d 150 * @retval "true" in case of success, "false" otherwise.
Davidroid 1:a7810e7acf8d 151 */
Davidroid 1:a7810e7acf8d 152 virtual bool SetSpeed(unsigned int, unsigned int) = 0;
Davidroid 1:a7810e7acf8d 153
Davidroid 1:a7810e7acf8d 154
Davidroid 1:a7810e7acf8d 155 };
Davidroid 1:a7810e7acf8d 156
Davidroid 1:a7810e7acf8d 157 #endif /* __BCDMMOTOR_CLASS_H */
Davidroid 1:a7810e7acf8d 158
Davidroid 1:a7810e7acf8d 159 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/