blob: e0292cb6ba05509d13c29a094ed40d967598f8db (
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
/*
* This file is subject to the terms of the GFX License. If a copy of
* the license was not distributed with this file, you can obtain one at:
*
* http://ugfx.org/license.html
*/
/**
* @file src/ginput/ginput_dial.h
*
* @defgroup Dial Dial
* @ingroup GINPUT
*
* @brief Sub-Module to handle physical controls that provide a range value (eg. potentiometers and rotary encoders).
*
* @details A dial provides a powerful way to navigate through menus
* on a display.
*
* @pre GFX_USE_GINPUT must be set to TRUE in your gfxconf.h
* @pre GINPUT_NEED_DIAL must be set to TRUE in your gfxconf.h
*
* @{
*/
#ifndef _GINPUT_DIAL_H
#define _GINPUT_DIAL_H
#if GINPUT_NEED_DIAL || defined(__DOXYGEN__)
/*===========================================================================*/
/* Type definitions */
/*===========================================================================*/
// Event types for various ginput sources
#define GEVENT_DIAL (GEVENT_GINPUT_FIRST+4)
typedef struct GEventDial_t {
GEventType type; // The type of this event (GEVENT_DIAL)
uint16_t instance; // The dial instance
uint16_t value; // The dial value
uint16_t maxvalue; // The maximum dial value
} GEventDial;
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Create a dial input instance
*
* @param[in] instance The ID of the dial input instance (from 0 to 9999)
*
* @return The soure handle of the created dial instance
*/
GSourceHandle ginputGetDial(uint16_t instance);
/**
* @brief Reset the value back to the hardware default
*
* @param[in] instance The ID of the dial input instance
*/
void ginputResetDialRange(uint16_t instance);
/**
* @brief Get the maximum value
* @details The readings are scaled to be 0 ... max.
*
* @param[in] instance The ID of the dial input instance
*
* @return The maximum value
*/
uint16_t ginputGetDialRange(uint16_t instance);
/**
* @brief Set the maximum value
* @details The readings are scaled to be 0 ... max.
*
* @param[in] instance The ID of the dial input instance
* @param[in] max The maximum value to be set
*/
void ginputSetDialRange(uint16_t instance, uint16_t max);
/**
* @brief Set the level change required before a dial even is generated (threshold)
* @note This is done after range scaling
*
* @param[in] instance The ID of the dial input instance
* @param[in] diff The amount of level changes
*/
void ginputSetDialSensitivity(uint16_t instance, uint16_t diff);
/**
* @brief Get the current dial status
*
* @param[in] instance The ID of the dial input instance
* @param[in] pdial The dial event struct
*
* @return Returns FALSE on an error (eg invalid instance)
*/
bool_t ginputGetDialStatus(uint16_t instance, GEventDial *pdial);
#ifdef __cplusplus
}
#endif
#endif /* GINPUT_NEED_DIAL */
#endif /* _GINPUT_DIAL_H */
/** @} */
|
