/test/periphery-lld/A3906_v1/aos_test_A3906.h - Annotate - AMiRo-OS - Research for Cognitive Interaction

amiro-os / test / periphery-lld / A3906_v1 / aos_test_A3906.h @ 2347b2ff

History | View | Annotate | Download (4.431 KB)

-            e545e620
+/*
 AMiRo-OS is an operating system designed for the Autonomous Mini Robot (AMiRo) platform.
-f0ce9e
+Copyright (C) 2016..2019  Thomas Schöpping et al.
-            e545e620
+            Thomas Schöpping
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
-c72a54c
+#ifndef AMIROOS_TEST_A3906_H
 #define AMIROOS_TEST_A3906_H
-            e545e620
+            Thomas Schöpping
-ba8a
+#include <amiroos.h>
-            e545e620
+            Thomas Schöpping
-c72a54c
+#if (AMIROOS_CFG_TESTS_ENABLE == true) || defined(__DOXYGEN__)
-            e545e620
+            Thomas Schöpping
-            ddf34c3d
+#include <alld_A3906.h>
-            e545e620
+            Thomas Schöpping
-            f3ac1c96
+/******************************************************************************/
 /* CONSTANTS                                                                  */
 /******************************************************************************/
 /******************************************************************************/
 /* SETTINGS                                                                   */
 /******************************************************************************/
 /******************************************************************************/
 /* CHECKS                                                                     */
 /******************************************************************************/
 /******************************************************************************/
 /* DATA STRUCTURES AND TYPES                                                  */
 /******************************************************************************/
-            e545e620
+/**
-c72a54c
+ * @brief   Custom data structure for the test.
-            e545e620
+ */
 typedef struct {
   /**
    * @brief   Pointer to the driver to use.
    */
   A3906Driver* driver;
   /**
    * @brief   PWM driver information.
    */
   struct {
     /**
      * @brief   The PWM driver to use.
      */
     apalPWMDriver_t* driver;
     /**
      * @brief   PWM channel information.
      */
     struct {
       /**
      * @brief   PWM channel for the left wheel forward direction.
      */
       apalPWMchannel_t left_forward;
       /**
      * @brief   PWM channel for the left wheel backward direction.
      */
       apalPWMchannel_t left_backward;
       /**
      * @brief   PWM channel for the right wheel forward direction.
      */
       apalPWMchannel_t right_forward;
       /**
      * @brief   PWM channel for the right wheel backward direction.
      */
       apalPWMchannel_t right_backward;
     } channel;
   } pwm;
   /**
    * @brief   QEI driver information
    */
   struct {
     /**
      * @brief   QEI driver for the left wheel.
      */
     apalQEIDriver_t* left;
     /**
      * @brief   QEI driver for the right wheel.
      */
     apalQEIDriver_t* right;
     /**
      * @brief   QEI increments per wheel revolution.
      */
     apalQEICount_t increments_per_revolution;
   } qei;
   /**
-f67
+   * @brief   Wheel diameter information.
-            e545e620
+   */
-f67
+  struct {
     /**
      * @brief   Left wheel diameter in m.
      */
     float left;
     /**
      * @brief   Right wheel diameter in m.
      */
     float right;
   } wheel_diameter;
-            e545e620
+            Thomas Schöpping
   /**
    * @brief   Timeout value (in us).
    */
   apalTime_t timeout;
-c72a54c
+} aos_test_a3906data_t;
-            e545e620
+            Thomas Schöpping
-            f3ac1c96
+/******************************************************************************/
 /* MACROS                                                                     */
 /******************************************************************************/
 /******************************************************************************/
 /* EXTERN DECLARATIONS                                                        */
 /******************************************************************************/
-de0cc90
+#if defined(__cplusplus)
-            e545e620
+extern "C" {
-de0cc90
+#endif /* defined(__cplusplus) */
-c72a54c
+  aos_testresult_t aosTestA3906Func(BaseSequentialStream* stream, const aos_test_t* test);
-de0cc90
+#if defined(__cplusplus)
-            e545e620
+            Thomas Schöpping
-de0cc90
+#endif /* defined(__cplusplus) */
-            e545e620
+            Thomas Schöpping
-            f3ac1c96
+/******************************************************************************/
 /* INLINE FUNCTIONS                                                           */
 /******************************************************************************/
-c72a54c
+#endif /* (AMIROOS_CFG_TESTS_ENABLE == true) */
-            e545e620
+            Thomas Schöpping
-c72a54c
+#endif /* AMIROOS_TEST_A3906_H */