summaryrefslogtreecommitdiffstats
path: root/watch-library/watch/watch_utility.h
diff options
context:
space:
mode:
Diffstat (limited to 'watch-library/watch/watch_utility.h')
-rw-r--r--watch-library/watch/watch_utility.h41
1 files changed, 41 insertions, 0 deletions
diff --git a/watch-library/watch/watch_utility.h b/watch-library/watch/watch_utility.h
new file mode 100644
index 00000000..e8808923
--- /dev/null
+++ b/watch-library/watch/watch_utility.h
@@ -0,0 +1,41 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2021 Joey Castillo
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#ifndef _WATCH_UTILITY_H_INCLUDED
+#define _WATCH_UTILITY_H_INCLUDED
+////< @file watch_utility.h
+
+#include "watch.h"
+
+/** @addtogroup utility Utility Functions
+ * @brief This section covers various useful functions that don't fit anywhere else.
+ **/
+/// @{
+/** @brief Returns a two-letter weekday for the given timestamp, suitable for display
+ * in positions 0-1 of the watch face
+ * @param date_time The watch_date_time whose weekday you want.
+ */
+const char * watch_utility_get_weekday(watch_date_time date_time);
+
+#endif