compAIR/libcreate
compAIR/libcreate
4
0
Fork 1
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Merge pull request #33 from kmoriarty/master

Browse source 
updated setDigits function API comments
This commit is contained in:
Jacob Perron 2018-04-04 22:28:30 -07:00 • committed by GitHub
commit f243987b29
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

16
include/create/create.h
View file

@ -278,17 +278,19 @@ namespace create {
/**
* \brief Set the four 7-segment display digits from left to right.
*
* \todo This function is not yet implemented refer to https://github.com/AutonomyLab/libcreate/issues/7
* \todo This function is not yet implemented refer to https://github.com/AutonomyLab/libcreate/issues/7
* \param segments to enable (true) or disable (false).
* The size of segments should be less than 29.
* The ordering of segments is left to right, top to bottom for each digit:
*
* 0 7 14 21
* |‾‾‾| |‾‾‾| |‾‾‾| |‾‾‾|
* 1 |___| 2 8 |___| 9 15 |___| 16 22 |___| 23
* | 3 | | 10| | 17| | 24|
* 4 |___| 5 11|___| 12 18 |___| 19 25 |___| 26
* 6 13 20 27
* <pre>
0 7 14 21
|‾‾‾| |‾‾‾| |‾‾‾| |‾‾‾|
1 |___| 2 8 |___| 9 15 |___| 16 22 |___| 23
| 3 | | 10| | 17| | 24|
4 |___| 5 11|___| 12 18 |___| 19 25 |___| 26
6 13 20 27
</pre>
*
* \return true if successful, false otherwise
*/