hueso/Sensor-Watch
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Activity

port SLCD to gossamer, add new string display options

Browse Source
This commit is contained in:
joeycastillo
2024-09-18 16:04:55 -04:00
parent ac88e2de8c
commit 9e32cbc523
8 changed files with 887 additions and 242 deletions
Download Patch File Download Diff File Expand all files Collapse all files

124
watch-library/shared/watch/watch_slcd.h
View File

@@ -21,8 +21,9 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#ifndef _WATCH_SLCD_H_INCLUDED
#define _WATCH_SLCD_H_INCLUDED
#pragma once
////< @file watch_slcd.h
#include "watch.h"
@@ -41,13 +42,21 @@
*/
/// @{
#define SLCD_SEGID(com, seg) (((com) << 16) | (seg))
#define SLCD_COMNUM(segid) (((segid) >> 16) & 0xFF)
#define SLCD_SEGNUM(segid) ((segid)&0xFF)
/// An enum listing the icons and indicators available on the watch.
typedef enum WatchIndicatorSegment {
WATCH_INDICATOR_SIGNAL = 0, ///< The hourly signal indicator; also useful for indicating that sensors are on.
WATCH_INDICATOR_BELL, ///< The small bell indicating that an alarm is set.
WATCH_INDICATOR_PM, ///< The PM indicator, indicating that a time is in the afternoon.
WATCH_INDICATOR_24H, ///< The 24H indicator, indicating that the watch is in a 24-hour mode.
WATCH_INDICATOR_LAP ///< The LAP indicator; the F-91W uses this in its stopwatch UI.
WATCH_INDICATOR_LAP, ///< The LAP indicator; the F-91W uses this in its stopwatch UI.
// These next indicators are only available on the new custom LCD:
WATCH_INDICATOR_BATTERY, ///< The battery indicator. Will fall back to the LAP icon on the original F-91W LCD.
WATCH_INDICATOR_SLEEP, ///< The sleep indicator. No fallback here; use the tick animation to indicate sleep.
} WatchIndicatorSegment;
/** @brief Enables the Segment LCD display.
@@ -75,6 +84,8 @@ void watch_clear_display(void);
/** @brief Displays a string at the given position, starting from the top left. There are ten digits.
A space in any position will clear that digit.
* @deprecated This function is deprecated. Use `watch_display_top_left`, `watch_display_top_right`
and `watch_display_main_line` instead
* @param string A null-terminated string.
* @param position The position where you wish to start displaying the string. The day of week digits
* are positions 0 and 1; the day of month digits are positions 2 and 3, and the main
@@ -82,7 +93,101 @@ void watch_clear_display(void);
* @note This method does not clear the display; if for example you display a two-character string at
position 0, positions 2-9 will retain whatever state they were previously displaying.
*/
void watch_display_string(char *string, uint8_t position);
void watch_display_string(char *string, uint8_t position) __attribute__ ((deprecated("Use watch_display_top_left, watch_display_top_right and watch_display_main_line instead.")));
/**
* @brief Displays a string at in the digits at the top left, which typically show the day of the week.
* @param string A null-terminated string with two characters to display.
*/
void watch_display_top_left(char *string);
/**
* @brief Displays a string at in the digits at the top left, which typically show the day of the week.
* @details This function is designed to make use of the new custom LCD, which has three digits at the
* top left. If you are using the original F-91W LCD, this function will fall back to displaying
* the fallback string. So for example if you were displaying a world clock for Anchorage, you
* could pass "ANC" as the string, and "AN" as the fallback.
* @param string A null-terminated string with 1-3 characters to display on the custom LCD.
* @param fallback A null-terminated string with 1-2 characters to display on the original F-91W LCD.
* @note Both the custom LCD and the original F-91W LCD have some limitations on what characters can be
* displayed. For example, the custom LCD can display "NYC" but the original F-91W LCD can't
* display "NY" due to the shared segments in position 1. On the other hand the original F-91W
* can display "FR" for Friday thanks to its extra segment in position 1, but the custom LCD can
* only display lowercase R, "Fri", due to the more simplistic 8-segment design of all the sigits.
* Some fine-tuning may be necessary to get the best results on both displays.
*/
void watch_display_top_left_with_fallback(char *string, char *fallback);
/**
* @brief Displays a string in the digits at the top right, which typically show the day of the month.
* @param string A null-terminated string with two characters to display.
*/
void watch_display_top_right(char *string);
/**
* @brief Displays a string in the digits at the top right, which typically show the day of the month.
* @param string A null-terminated string with two characters to display on the custom LCD.
* @param fallback A null-terminated string with two characters to display on the original F-91W LCD.
* @note On the original F-91W LCD, position 2 can only display the numbers 1, 2 and 3 (or a
* lowercase 'a') due to its aggressive segment sharing in this position. You may need to come
* up with more complex logic to create a useful fallback if displaying other characters here.
* Position 3, the second digit, is a standard 7-segment digit.
*/
void watch_display_top_right_with_fallback(char *string, char *fallback);
/**
* @brief Displays a string in the main line of the display, which typically shows the time.
* @param string A null-terminated string with six characters to display. Omit the colon; if you want
* the colon to appear, use watch_set_colon() to turn it on.
*/
void watch_display_main_line(char *string);
/**
* @brief Displays a string in the main line of the display, which typically shows the time.
* @param string A null-terminated string with 7 characters to display. The first character must be
* either a 1 or a space; on the custom LCD, this will indicate whether to turn on the leading
* '1' segment. Omit any colons or decimal points.
* @param fallback A null-terminated string with 6 characters to display if the custom LCD is not
* available. Once again, omit the colon.
* @note This function is a bit more complicated, but the gist is, the custom LCD can display
* "1888888", while the original F-91W LCD can only display "888888". In addition, on the original
* Casio LCD, the first digit of the hours and seconds display have their top and bottom segments
* linked, which causes some limitations. The intent is for you to use the function like this,
* for example, displaying a longutide and latitude:
*
* watch_display_main_line_with_fallback("14990#W", "-14990") // "149.90°W" or "-149.90"
* watch_display_main_line_with_fallback(" 6122#N", "+ 6122") // "61.22°N" or "+61.22"
*
* In the first example, the leading 1 allows us to dusplay "146.90°W" on the custom LCD, with the
* numeric portion in the clock digits, and the "°W" hint in the small seconds digits. Meanwhile on
* the classic LCD, the fallback string "-14990" will display -149 in the large clock digits, and
* 90 in the small seconds digits, indicating that this is a decimal portion.
* In the second example, the leading space allows us to display "61.22°N" on the custom LCD, with
* the "°N" in the seconds place, while the fallback string "+ 6122" will display +61 on the large
* clock digits, and 22 in the small seconds digits, indicating that this is a decimal portion.
*
* Note also that the custom LCD has a vertical descender in the two seconds digits, which can be
* used to displaty uppercase letters like D, I, T, M and W.
*/
void watch_display_main_line_with_fallback(char *string, char *fallback);
/**
* @brief Displays a string in the hours portion of the main line.
* @param string A null-terminated string with two characters to display.
*/
void watch_display_hours(char *string);
/**
* @brief Displays a string in the minutes portion of the main line.
* @param string A null-terminated string with two characters to display.
*/
void watch_display_minutes(char *string);
/**
* @brief Displays a string in the seconds portion of the main line.
* @param string A null-terminated string with two characters to display.
*/
void watch_display_seconds(char *string);
/** @brief Turns the colon segment on.
*/
@@ -92,6 +197,16 @@ void watch_set_colon(void);
*/
void watch_clear_colon(void);
/** @brief Turns the decimal segment on.
* @note Only exists on the custom LCD, in the same position as the colon.
*/
void watch_set_decimal_if_available(void);
/** @brief Turns the decimal segment off.
* @note Only exists on the custom LCD, in the same position as the colon.
*/
void watch_clear_decimal_if_available(void);
/** @brief Sets an indicator on the LCD. Use this to turn on one of the indicator segments.
* @param indicator One of the indicator segments from the enum. @see WatchIndicatorSegment
*/
@@ -148,4 +263,3 @@ bool watch_tick_animation_is_running(void);
*/
void watch_stop_tick_animation(void);
/// @}
#endif