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

documentation tweaks

Browse Source
This commit is contained in:
Joey Castillo 2021-08-05 16:15:53 -04:00
parent 4e0f249bd2
commit 9fca9c7188
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
watch-library/watch/watch.h
View File

@ -114,24 +114,24 @@ void _watch_init();
void watch_enable_display(); void watch_enable_display();
/** @brief Sets a pixel. Use this to manually set a pixel with a given common and segment number. /** @brief Sets a pixel. Use this to manually set a pixel with a given common and segment number.
* @param com the common pin, numbered from 0-2 * @param com the common pin, numbered from 0-2.
* @param seg the segment pin, numbered from 0-23 * @param seg the segment pin, numbered from 0-23.
*/ */
void watch_set_pixel(uint8_t com, uint8_t seg); 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. /** @brief Clears a pixel. Use this to manually clear a pixel with a given common and segment number.
* @param com the common pin, numbered from 0-2 * @param com the common pin, numbered from 0-2.
* @param seg the segment pin, numbered from 0-23 * @param seg the segment pin, numbered from 0-23.
* Use this to manually set a pixel with a common and a segment number. * Use this to manually set a pixel with a common and a segment number.
*/ */
void watch_clear_pixel(uint8_t com, uint8_t seg); void watch_clear_pixel(uint8_t com, uint8_t seg);
/** @brief Displays a string at the given position, starting from the top left. There are ten digits. /** @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. A space in any position will clear that digit.
* @param string A null-terminated string. * @param string A null-terminated string.
* @param position The position to start. The day of week digits are positions 0 and 1, the day of * @param position The position where you wish to start displaying the string. The day of week digits
month digits are positions 2 and 3, and the main clock line is positions 4-9. * are positions 0 and 1; the day of month digits are positions 2 and 3, and the main
* clock line occupies positions 4-9.
* @note This method does not clear the display; if for example you display a two-character string at * @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. position 0, positions 2-9 will retain whatever state they were previously displaying.
*/ */