summaryrefslogtreecommitdiffhomepage
path: root/digital/beacon/tests/motor/motor.h
diff options
context:
space:
mode:
Diffstat (limited to 'digital/beacon/tests/motor/motor.h')
-rw-r--r--digital/beacon/tests/motor/motor.h75
1 files changed, 75 insertions, 0 deletions
diff --git a/digital/beacon/tests/motor/motor.h b/digital/beacon/tests/motor/motor.h
new file mode 100644
index 00000000..f1393d87
--- /dev/null
+++ b/digital/beacon/tests/motor/motor.h
@@ -0,0 +1,75 @@
+/* motor.h */
+/* Motor control. {{{
+ *
+ * Copyright (C) 2012 Florent Duchon
+ *
+ * APBTeam:
+ * Web: http://apbteam.org/
+ * Email: team AT apbteam DOT org
+ *
+ * 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 2 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, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ *
+ * }}} */
+
+#ifndef _MOTOR_H
+#define _MOTOR_H
+
+#define MOTOR_TARGET_SPEED_INIT 0
+#define MOTOR_SPEED_STOP 0
+#define MOTOR_SPEED_MIN 0
+#define MOTOR_SPEED_MAX 140
+
+typedef struct
+{
+ uint16_t target_speed;
+} motor_s;
+
+typedef enum
+{
+ MOTOR_STOPPED,
+ MOTOR_IN_ROTATION
+} TMotor_state;
+
+/* This function initializes the motor control output */
+void motor_init(void);
+
+/* This function starts the motor rotation */
+void motor_start(void);
+
+/* This function stops the motor rotation */
+void motor_stop(void);
+
+/* This function sets the motor speed */
+void motor_set_speed(uint8_t value);
+
+/* This function returns the motor speed in raw format */
+uint8_t motor_get_speed_raw();
+
+/* This function returns the motor state */
+TMotor_state motor_get_state(void);
+
+/* This function starts or stops the motor according to the current state */
+void motor_start_stop_control(void);
+
+/* This function sets the target speed */
+void motor_set_target_speed(uint8_t value);
+
+/* This function returns the target speed */
+uint8_t motor_get_target_speed();
+
+/* This function control the motor speed accroding to target speed requested */
+void motor_control_speed(uint16_t time);
+
+#endif