summaryrefslogtreecommitdiffstats
path: root/watch-library
diff options
context:
space:
mode:
authorJoey Castillo <jose.castillo@gmail.com>2021-08-07 13:48:01 -0400
committerJoey Castillo <jose.castillo@gmail.com>2021-08-07 13:48:01 -0400
commit792665c7fec6fe54cf3975306fe64b8683c192f8 (patch)
treefe25f498991632bd547377aeeee6b5ec11b808dc /watch-library
parent973efe7edc5af0be74960a59dd63aa794a0c1fb0 (diff)
downloadSensor-Watch-792665c7fec6fe54cf3975306fe64b8683c192f8.tar.gz
Sensor-Watch-792665c7fec6fe54cf3975306fe64b8683c192f8.tar.bz2
Sensor-Watch-792665c7fec6fe54cf3975306fe64b8683c192f8.zip
add segment map link
Diffstat (limited to 'watch-library')
-rw-r--r--watch-library/watch/watch.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/watch-library/watch/watch.h b/watch-library/watch/watch.h
index 6711353c..8cb949f6 100644
--- a/watch-library/watch/watch.h
+++ b/watch-library/watch/watch.h
@@ -106,6 +106,9 @@ void _watch_init();
/** @addtogroup slcd Segment LCD Display
* @brief This section covers functions related to the Segment LCD display driver, which is responsible
* for displaying strings of characters and indicators on the main watch display.
+ * @details For a map of all common and segment pins, see <a href="segmap.html">segmap.html</a>. You can
+ * hover over any segment in that diagram to view the common and segment pins associated with
+ * each segment of the display.
*/
/// @{
@@ -123,12 +126,14 @@ typedef enum WatchIndicatorSegment {
void watch_enable_display();
/** @brief Sets a pixel. Use this to manually set a pixel with a given common and segment number.
+ * See <a href="segmap.html">segmap.html</a>.
* @param com the common pin, numbered from 0-2.
* @param seg the segment pin, numbered from 0-23.
*/
void watch_set_pixel(uint8_t com, uint8_t seg);
/** @brief Clears a pixel. Use this to manually clear a pixel with a given common and segment number.
+ * See <a href="segmap.html">segmap.html</a>.
* @param com the common pin, numbered from 0-2.
* @param seg the segment pin, numbered from 0-23.
*/