diff --git a/src/motion/Motion.h b/src/motion/Motion.h index 99cb603..16353d8 100644 --- a/src/motion/Motion.h +++ b/src/motion/Motion.h @@ -1,7 +1,48 @@ +/** + * @file Motion.h + * @author Jonathan Schulze, Nick Hübenthal + * @brief This component controls the ability to rotate and change position. + * @version 0.1 + * @date 2023-12-13 + * + * @copyright Copyright (c) 2023 + * + */ + #ifndef Motion_h #define Motion_h class Motion{ +protected: + +public: + Motion(); + + /** + * @brief Initialize the movement component. + * + */ + void begin(void); + + /** + * @brief Move forward for a certain amount of time. + * @param moveForMs Representing the duration of forward moving in milliseconds. + */ + void move(u8int moveForMs); + + /** + * @brief Rotate left for a certain amount of time. + * @param rotateForMs Representing the duration of rotating left in milliseconds. + */ + void rotateLeft(u8int rotateForMs); + + /** + * @brief Rotate right for a certain amount of time. + * @param rotateForMs Representing the duration of rotating right in milliseconds. + */ + void rotateRight(u8int rotateForMs); }; -#endif //Motion_h \ No newline at end of file +#endif //Motion_h + +