summaryrefslogtreecommitdiff
path: root/digital/beacon/src/codewheel.h
blob: 7abe3f0e0f58c812481faafb89ca4c70a07a72c7 (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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/* codewheel.h */
/* Codewheel sensors management. {{{
 *
 * 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 _CODEWHEEL_H
#define _CODEWHEEL_H

#define CODEWHEEL_CPR 499

typedef enum
{
	CODEWHEEL_INIT,
	CODEWHEEL_REQUEST_REBASE,
	CODEWHEEL_REBASED
} TCodewheel_state;

typedef struct
{
	TCodewheel_state state;
	uint16_t rebase_offset;
} codewheel_s;

/* This function initializes the codewheel optical sensors and associated interrupt */
void codewheel_init(void);

/* This function resets the wheel position */
void codewheel_reset(void);

/* This function returns the codewheel state */
TCodewheel_state codewheel_get_state(void);

/* This function modify the codewheel state */
void codewheel_set_state(TCodewheel_state state);

/* This function returns the wheel position */
uint16_t codewheel_get_value(void);

/* This function returns the offset value */
uint16_t codewheel_get_rebase_offset(void);

/* This function saves the counter value used when a codewheel reset is requested */
void codewheel_set_rebase_offset(uint16_t offset);

#endif