From 46c14a44e8e889bbdd317895492b70b179070441 Mon Sep 17 00:00:00 2001 From: joeycastillo Date: Tue, 14 Dec 2021 17:06:59 +0000 Subject: deploy: e8e9a0e2d86d37fa0354b3475c907eae1bf5a6dd --- watch__slcd_8h_source.html | 169 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 169 insertions(+) create mode 100644 watch__slcd_8h_source.html (limited to 'watch__slcd_8h_source.html') diff --git a/watch__slcd_8h_source.html b/watch__slcd_8h_source.html new file mode 100644 index 00000000..8d68ec58 --- /dev/null +++ b/watch__slcd_8h_source.html @@ -0,0 +1,169 @@ + + + + + + + +Sensor Watch: watch-library/watch/watch_slcd.h Source File + + + + + + + + + +
+
+ + + + + + +
+
Sensor Watch +  0.0.0 +
+
A board replacement for the classic Casio F-91W wristwatch, powered by a Microchip SAM L22 microcontroller.
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
watch_slcd.h
+
+
+
1 /*
+
2  * MIT License
+
3  *
+
4  * Copyright (c) 2020 Joey Castillo
+
5  *
+
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
+
7  * of this software and associated documentation files (the "Software"), to deal
+
8  * in the Software without restriction, including without limitation the rights
+
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+
10  * copies of the Software, and to permit persons to whom the Software is
+
11  * furnished to do so, subject to the following conditions:
+
12  *
+
13  * The above copyright notice and this permission notice shall be included in all
+
14  * copies or substantial portions of the Software.
+
15  *
+
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+
22  * SOFTWARE.
+
23  */
+
24 #ifndef _WATCH_SLCD_H_INCLUDED
+
25 #define _WATCH_SLCD_H_INCLUDED
+
27 
+
28 #include "watch.h"
+
29 
+
43 
+
45 typedef enum WatchIndicatorSegment {
+
46  WATCH_INDICATOR_SIGNAL = 0,
+
47  WATCH_INDICATOR_BELL,
+
48  WATCH_INDICATOR_PM,
+
49  WATCH_INDICATOR_24H,
+
50  WATCH_INDICATOR_LAP
+
51 } WatchIndicatorSegment;
+
52 
+
56 void watch_enable_display(void);
+
57 
+
63 void watch_set_pixel(uint8_t com, uint8_t seg);
+
64 
+
70 void watch_clear_pixel(uint8_t com, uint8_t seg);
+
71 
+
74 void watch_clear_display(void);
+
75 
+
85 void watch_display_string(char *string, uint8_t position);
+
86 
+
89 void watch_set_colon(void);
+
90 
+
93 void watch_clear_colon(void);
+
94 
+
98 void watch_set_indicator(WatchIndicatorSegment indicator);
+
99 
+
103 void watch_clear_indicator(WatchIndicatorSegment indicator);
+
104 
+
108 void watch_clear_all_indicators(void);
+
109 
+
122 void watch_start_character_blink(char character, uint32_t duration);
+
123 
+
127 void watch_stop_blink(void);
+
128 
+
139 void watch_start_tick_animation(uint32_t duration);
+
140 
+
144 bool watch_tick_animation_is_running(void);
+
145 
+
149 void watch_stop_tick_animation(void);
+
151 #endif
+
watch_set_colon
void watch_set_colon(void)
Turns the colon segment on.
Definition: watch_slcd.c:248
+
watch_enable_display
void watch_enable_display(void)
Enables the Segment LCD display. Call this before attempting to set pixels or display strings.
Definition: watch_slcd.c:157
+
watch_display_string
void watch_display_string(char *string, uint8_t position)
Displays a string at the given position, starting from the top left. There are ten digits....
Definition: watch_slcd.c:234
+
watch_tick_animation_is_running
bool watch_tick_animation_is_running(void)
Checks if the tick animation is currently running.
Definition: watch_slcd.c:310
+
WatchIndicatorSegment
WatchIndicatorSegment
An enum listing the icons and indicators available on the watch.
Definition: watch_slcd.h:45
+
watch_set_pixel
void watch_set_pixel(uint8_t com, uint8_t seg)
Sets a pixel. Use this to manually set a pixel with a given common and segment number....
Definition: watch_slcd.c:162
+
watch_clear_colon
void watch_clear_colon(void)
Turns the colon segment off.
Definition: watch_slcd.c:252
+
watch_start_character_blink
void watch_start_character_blink(char character, uint32_t duration)
Blinks a single character in position 7. Does not affect other positions.
Definition: watch_slcd.c:272
+
watch_clear_indicator
void watch_clear_indicator(WatchIndicatorSegment indicator)
Clears an indicator on the LCD. Use this to turn off one of the indicator segments.
Definition: watch_slcd.c:260
+
watch_stop_blink
void watch_stop_blink(void)
Stops and clears all blinking segments.
Definition: watch_slcd.c:299
+
watch_start_tick_animation
void watch_start_tick_animation(uint32_t duration)
Begins a two-segment "tick-tock" animation in position 8.
Definition: watch_slcd.c:304
+
watch_clear_all_indicators
void watch_clear_all_indicators(void)
Clears all indicator segments.
Definition: watch_slcd.c:264
+
watch_set_indicator
void watch_set_indicator(WatchIndicatorSegment indicator)
Sets an indicator on the LCD. Use this to turn on one of the indicator segments.
Definition: watch_slcd.c:256
+
watch_clear_pixel
void watch_clear_pixel(uint8_t com, uint8_t seg)
Clears a pixel. Use this to manually clear a pixel with a given common and segment number....
Definition: watch_slcd.c:166
+
watch_clear_display
void watch_clear_display(void)
Clears all segments of the display, including incicators and the colon.
Definition: watch_slcd.c:170
+
watch_stop_tick_animation
void watch_stop_tick_animation(void)
Stops the tick/tock animation and clears all animating segments.
Definition: watch_slcd.c:314
+
WATCH_INDICATOR_PM
@ WATCH_INDICATOR_PM
The PM indicator, indicating that a time is in the afternoon.
Definition: watch_slcd.h:48
+
WATCH_INDICATOR_BELL
@ WATCH_INDICATOR_BELL
The small bell indicating that an alarm is set.
Definition: watch_slcd.h:47
+
WATCH_INDICATOR_SIGNAL
@ WATCH_INDICATOR_SIGNAL
The hourly signal indicator; also useful for indicating that sensors are on.
Definition: watch_slcd.h:46
+
WATCH_INDICATOR_LAP
@ WATCH_INDICATOR_LAP
The LAP indicator; the F-91W uses this in its stopwatch UI.
Definition: watch_slcd.h:50
+
WATCH_INDICATOR_24H
@ WATCH_INDICATOR_24H
The 24H indicator, indicating that the watch is in a 24-hour mode.
Definition: watch_slcd.h:49
+ +
+ +
+Generated by doxygen 1.9.1 +
+ + -- cgit v1.2.3