summaryrefslogtreecommitdiffstats
path: root/claw.hpp
blob: 8cb2cd3bfd13670e119d8719c6a450b0d2965126 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
/**
 * @file claw.hpp
 * @brief A system to handle all claw operations.
 */

#ifndef CLAW_HPP_
#define CLAW_HPP_

namespace claw {
	/**
	 * Initializes the claw system.
	 */
	void init(void);

	/**
	 * Opens the claw, using pre-defined open time.
	 * @see openTime
	 */
	void open(void);

	/**
	 * Closes the claw using the pre-defined close time.
	 * @see closeTime
	 */
	void close(void);

	/**
	 * Opens the claw, but then leaves the motor powered so that it can hold
	 * an object.
	 */
	void hold(void);

	/**
	 * Runs a close-open combination to release the claw from its locked
	 * position on the lift.
	 */
	void unhook(void);
}

/**
 * Defines how many milliseconds it takes for the claw to open.
 */
constexpr unsigned int openTime = 700;

/**
 * Defines how many milliseconds it takes for the claw to close.
 */
constexpr unsigned int closeTime = 900;

#endif // CLAW_HPP_