Editing Alpha Clock Serial v2
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 4: | Line 4: | ||
== Interfacing to Alpha Clock Five == | == Interfacing to Alpha Clock Five == | ||
− | Alpha Clock Five has two onboard hardware serial ports. The main serial port (Arduino PORT0, J2 on the PCB) is normally used for communication with your PC, while the second serial port (Arduino PORT1, J5 on the PCB) is normally used for connecting to another "daisy chained" Alpha Clock Five. | + | Alpha Clock Five has two onboard hardware serial ports. The main serial port (Arduino PORT0, J2 on the PCB) is normally used for communication with your PC, while the second serial port (Arduino PORT1, J5 on the PCB) is normally used for connecting to another "daisy chained" Alpha Clock Five. In general, we will refer to the main serial port, J2, as "the serial port" for purposes of communication. |
− | The serial port on Alpha Clock Five is a "TTL Serial" type that is connected directly to the microcontroller. To interface with a computer, it is normally used with an FTDI serial interface such as the [http:// | + | The serial port on Alpha Clock Five is a "TTL Serial" type that is connected directly to the microcontroller. To interface with a computer, it is normally used with an FTDI serial interface such as the [http://evilmadscience.com/productsmenu/partsmenu/130-usbttl FTDI TTL-232R] or the Adafruit [http://evilmadscience.com/productsmenu/accessories/210 FTDI Friend]. Note that since the interface supports logic-level signals, it cannot be interfaced directly to a traditional RS232 serial port on a computer. |
The interface is normally configured for 19,200 baud, 8N1. | The interface is normally configured for 19,200 baud, 8N1. | ||
Line 20: | Line 20: | ||
== Daisy-Chained Serial == | == Daisy-Chained Serial == | ||
− | Alpha Clock Five features a second hardware serial port, located at location J5 on the circuit board. For daisy chaining, you can use a [http://shop.evilmadscientist.com/productsmenu/partsmenu/586 six pin SIL F-F header cable] to connect from J5 directly to the main serial port (J2) on a second Alpha Clock Five unit. | + | Alpha Clock Five features a second hardware serial port, located at location J5 on the circuit board. For daisy chaining, you can use a [http://shop.evilmadscientist.com/productsmenu/partsmenu/586 six pin SIL F-F header cable] to connect from J5 directly to the main serial port (J2) on a second Alpha Clock Five unit. |
In revision B of the circuit board, J5 is located just below the middle chip, U2. Pin 1, where the "black" side of the cable goes is indicated by an arrow. In revision C of the circuit board, J5 is located below U3, on the lower right side of the circuit board. Pin 1, where the "black" side of the cable goes is indicated by an arrow. Pin 1 is also indicated as the ''square'' pin of header J5. If your kit did not come with a header at location J5, you will need to add one at that location in order to have a place to attach the cable. | In revision B of the circuit board, J5 is located just below the middle chip, U2. Pin 1, where the "black" side of the cable goes is indicated by an arrow. In revision C of the circuit board, J5 is located below U3, on the lower right side of the circuit board. Pin 1, where the "black" side of the cable goes is indicated by an arrow. Pin 1 is also indicated as the ''square'' pin of header J5. If your kit did not come with a header at location J5, you will need to add one at that location in order to have a place to attach the cable. | ||
Line 31: | Line 31: | ||
== Supported commands == | == Supported commands == | ||
− | Firmware version 2.0 supports | + | Firmware version 2.0 supports three serial commands: Set time, Ascii display, and Mode Time (which turns off Ascii display). |
Each command consists of exactly 13 bytes: A single header byte (0xFF), followed by a two-letter command code and then 10 additional bytes of data. | Each command consists of exactly 13 bytes: A single header byte (0xFF), followed by a two-letter command code and then 10 additional bytes of data. | ||
Line 51: | Line 51: | ||
− | The Alpha Clock Five library (v. 2.0 and above) includes a set of Processing sketches, including an example program (AlphaClock_SetTime) that can sync the time on your Alpha Clock Five to that on your PC. | + | The Alpha Clock Five library (v. 2.0 and above) includes a set of Processing sketches, including an example program (AlphaClock_SetTime) that can sync the time on your Alpha Clock Five to that on your PC. To run these sketches, download Processing [http://processing.org from processing.org]. |
− | |||
==== A0: Ascii Display ==== | ==== A0: Ascii Display ==== | ||
− | The A0 function is used to display data, for example alphanumeric characters, on the front LEDs of Alpha Clock Five. | + | The A0 function is used to display data, for example alphanumeric characters, on the front LEDs of Alpha Clock Five. |
Line 67: | Line 66: | ||
− | The 5 ASCII characters to display should be in the range " " (space, ASCII 32) to "e" (lower-case "e", ASCII 101). There are defined characters | + | The 5 ASCII characters to display should be in the range " " (space, ASCII 32) to "e" (lower-case "e", ASCII 101). There are defined characters for A-Z (upper case), 0-9, space, and symbols such as $, %, &, (, ), [, ], =, -, +, /, |, \, _, ., ", and ^. |
+ | ( Please [http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters see here] or [http://web.cs.mun.ca/~michael/c/ascii-table.html here] for a more complete ASCII chart in the appropriate range. ) There are also five | ||
− | |||
+ | Some symbols, such as the exclamation point or a semicolon, ''simply do not'' display well on an alphanumeric display. In certain cases, the decimal points can be used to help make good looking characters, as is the case with the colon, aptly displayed by two decimal points (upper and lower) between two characters. | ||
− | |||
− | |||
− | + | The decimal point string consists of 5 characters, and describes which decimal points (if any) should be lit for each of the five alphanumeric LED displays. For each character in this string, a value '1' will light the lower DP, a value '2' will light the upper DP, and a value '3' will light both DPs. Any other character will not cause either of the LEDs to be lit. Any other character will not cause either of the LEDs to be lit. Note that the decimal string is ''strictly additive''; if the string contains characters that light either DP (for example the period, '.'), the DP string cannot be used to turn off that LED. Note that the decimal point protocol has been changed from that in firmware v1, for which the display characters were 'U', 'L', and 'B' for upper, lower, or both decimal points. | |
− | |||
− | + | Please see the Sample Programs section below for an example program that can display text on the Alpha Clock Five LEDs. | |
+ | |||
+ | |||
+ | Note that the set of characters available (ASCII 32-96) is defined in the firmware. If you need to display characters not in that set, or would like to change the shape of the displayed characters, that can be made possible by editing and uploading a new version of the firmware. | ||
+ | To blank the display, you can send an string consisting of spaces, " ". | ||
==== A''x'': Daisy-Chained Ascii Display ==== | ==== A''x'': Daisy-Chained Ascii Display ==== | ||
− | The A''x'' function | + | The A''x'' function is used to display alphanumeric characters on the front LEDs of more than one Alpha Clock Five, connected through their serial interfaces. |
The full command consists of 13 bytes, as follows: | The full command consists of 13 bytes, as follows: | ||
Line 100: | Line 101: | ||
− | |||
− | + | ==== MT: Mode Time ==== | |
− | |||
− | |||
− | |||
− | |||
− | + | The MT function is used to resume normal display mode-- showing the time --after command A0 has been issued. | |
− | |||
− | |||
− | |||
− | The | ||
The full command consists of 13 bytes, as follows: | The full command consists of 13 bytes, as follows: | ||
* The header byte, 0xFF | * The header byte, 0xFF | ||
− | * The command | + | * The command MT |
− | * | + | * A 10-character string (the contents of this string will be ignored). |
− | |||
− | + | Please see the Sample Programs section below for an example program that displays characters with A0, and then uses MT to display the time again. | |
− | |||
− | + | == Sample programs == | |
+ | Sample applications to communicate with Alpha Clock Five are provided as .pde files, for use with the Processing development environment. Processing is a free, cross-platform programming environment, and you can download your copy [http://processing.org/ at processing.org]. | ||
− | |||
− | + | ==== AlphaClock_SetText ==== | |
− | + | Download this file [http://evilmadscientist.s3.amazonaws.com/source/alphafive/AlphaClock_SetText.pde here] (2 kB .pde file). --NOT YET UPDATED FOR v2. | |
− | + | When you run the application, it presents a window. Click your mouse in the window to alternately display a text string ("ALPHA", plus some added decimal points) and to resume clock display. This demonstrates the use of the A0 and MT serial functions. | |
− | + | Note that you may need to edit the file to select the correct serial port, defined by the "portIndex" variable, in order to select the serial port where your clock is attached. | |
− | |||
− | + | ==== AlphaClock_SetTime ==== | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
+ | Download this file [http://evilmadscientist.s3.amazonaws.com/source/alphafive/AlphaClock_SetTime.pde here] (2 kB .pde file). | ||
− | + | When you run the application, it presents a window. Click your mouse in the window to set the time on the clock to your present computer system time. This demonstrates the use of the ST function, and also provides an accurate way to set the display time. | |
+ | Note that you may need to edit the file to select the correct serial port, defined by the "portIndex" variable, in order to select the serial port where your clock is attached. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
Line 215: | Line 148: | ||
The listed function names are reserved for use in future firmware. If you extend the firmware with additional serial command functions, it is strongly advised that you do not use the following function names: | The listed function names are reserved for use in future firmware. If you extend the firmware with additional serial command functions, it is strongly advised that you do not use the following function names: | ||
− | * SA (May be used for Set Alarm time in future firmware) | + | * B* (B, followed by any character) |
+ | * SA (May be used for Set Alarm time in future firmware) | ||
+ | * SB (May be used for Set Brightness in future firmware) | ||
* M* Where * is in the range 2-9. (May be used for mode setting in future firmware) | * M* Where * is in the range 2-9. (May be used for mode setting in future firmware) | ||
* TP (May be used for producing sounds in future firmware) | * TP (May be used for producing sounds in future firmware) |