Migrating wiki contents from Google Code

2015-03-15 10:11:53 -04:00
commit e09fe56554
21 changed files with 990 additions and 0 deletions
--- a/setDisplayToString.md
+++ b/setDisplayToString.md
@@ -0,0 +1,143 @@
+# setDisplayToString Reference (TM1638/TM1640) #
+
+Set the display to the string.
+
+```
+void setDisplayToString(const char* string, const word dots, const byte pos, const byte font[]);
+```
+
+| Argument | Detail | Default | Since |
+|:---------|:-------|:--------|:------|
+| string | The text to display | _required_ |  |
+| dots | The dots to set (bitwise) | 0 | v1.4.0 |
+| pos | The position to start. 0 for the leftmost, 7 for the rightmost | required | v1.6.0 |
+| font | The font (segment data) to use, defaulting to the built-in font. | FONT\_DEFAULT, the built-in font |  |
+
+# Example #
+
+Display "Ricardo." using the built-in font:
+```
+char* name = "Ricardo.";
+
+module.setDisplayToString(name);
+```
+
+Display "Ricardo " with dots on every other letter:
+```
+char* name = "Ricardo ";
+
+module.setDisplayToString(name, 0b10101010);
+```
+
+Display "foo bar":
+```
+char* foo = "foo";
+char* bar = "bar";
+
+module.setDisplayToString(foo, 0);
+module.setDisplayToString(bar, 0, 4);
+```
+
+# Font character data #
+
+Fonts can be created like the built-in font:
+```
+// definition for the displayable ASCII chars
+const byte FONT_DEFAULT[] = {
+  0b00000000, // (32)  <space>
+  0b10000110, // (33)   !
+  0b00100010, // (34)   "
+  0b01111110, // (35)   #
+  0b01101101, // (36)   $
+  0b00000000, // (37)   %
+  0b00000000, // (38)   &
+  0b00000010, // (39)   '
+  0b00110000, // (40)   (
+  0b00000110, // (41)   )
+  0b00000000, // (42)   *
+  0b00000000, // (43)   +
+  0b00000100, // (44)   ,
+  0b01000000, // (45)   -
+  0b10000000, // (46)   .
+  0b01010010, // (47)   /
+  0b00111111, // (48)   0
+  0b00000110, // (49)   1
+  0b01011011, // (50)   2
+  0b01001111, // (51)   3
+  0b01100110, // (52)   4
+  0b01101101, // (53)   5
+  0b01111101, // (54)   6
+  0b00100111, // (55)   7
+  0b01111111, // (56)   8
+  0b01101111, // (57)   9
+  0b00000000, // (58)   :
+  0b00000000, // (59)   ;
+  0b00000000, // (60)   <
+  0b01001000, // (61)   =
+  0b00000000, // (62)   >
+  0b01010011, // (63)   ?
+  0b01011111, // (64)   @
+  0b01110111, // (65)   A
+  0b01111111, // (66)   B
+  0b00111001, // (67)   C
+  0b00111111, // (68)   D
+  0b01111001, // (69)   E
+  0b01110001, // (70)   F
+  0b00111101, // (71)   G
+  0b01110110, // (72)   H
+  0b00000110, // (73)   I
+  0b00011111, // (74)   J
+  0b01101001, // (75)   K
+  0b00111000, // (76)   L
+  0b00010101, // (77)   M
+  0b00110111, // (78)   N
+  0b00111111, // (79)   O
+  0b01110011, // (80)   P
+  0b01100111, // (81)   Q
+  0b00110001, // (82)   R
+  0b01101101, // (83)   S
+  0b01111000, // (84)   T
+  0b00111110, // (85)   U
+  0b00101010, // (86)   V
+  0b00011101, // (87)   W
+  0b01110110, // (88)   X
+  0b01101110, // (89)   Y
+  0b01011011, // (90)   Z
+  0b00111001, // (91)   [
+  0b01100100, // (92)   \ (this can't be the last char on a line, even in comment or it'll concat)
+  0b00001111, // (93)   ]
+  0b00000000, // (94)   ^
+  0b00001000, // (95)   _
+  0b00100000, // (96)   `
+  0b01011111, // (97)   a
+  0b01111100, // (98)   b
+  0b01011000, // (99)   c
+  0b01011110, // (100)  d
+  0b01111011, // (101)  e
+  0b00110001, // (102)  f
+  0b01101111, // (103)  g
+  0b01110100, // (104)  h
+  0b00000100, // (105)  i
+  0b00001110, // (106)  j
+  0b01110101, // (107)  k
+  0b00110000, // (108)  l
+  0b01010101, // (109)  m
+  0b01010100, // (110)  n
+  0b01011100, // (111)  o
+  0b01110011, // (112)  p
+  0b01100111, // (113)  q
+  0b01010000, // (114)  r
+  0b01101101, // (115)  s
+  0b01111000, // (116)  t
+  0b00011100, // (117)  u
+  0b00101010, // (118)  v
+  0b00011101, // (119)  w
+  0b01110110, // (120)  x
+  0b01101110, // (121)  y
+  0b01000111, // (122)  z
+  0b01000110, // (123)  {
+  0b00000110, // (124)  |
+  0b01110000, // (125)  }
+  0b00000001, // (126)  ~
+};
+```