Smartcat (BL2100) User's Manual

> ## Appendix C. LCD/Keypad Module

> An optional LCD/keypad is available for the BL2100. Appendix C describes the LCD/keypad and provides the software APIs to make full use of the LCD/keypad.

> ### C.1 Specifications

> Table C-1 lists the electrical, mechanical, and environmental specifications for the LCD/keypad assembly.

> Table C-1. LCD/Keypad Specifications
> Parameter | Specification
> Board Size | 2.60" × 3.00" × 0.75" (66 mm × 76 mm × 19 mm)
> Temperature | Operating Range: 0°C to +50°C Storage Range: -40°C to +85°C
> Humidity | 5% to 95%, noncondensing
> Power Consumption | 1.5 W maximum
> Connections | Connects to high-rise header sockets on BL2100
> LCD Panel Size | 122 × 32 graphic display
> Keypad | 7-key keypad
> LEDs | Seven user-programmable LEDs

> ### C.2 Mounting LCD/Keypad Module on the BL2100

> Install the LCD/keypad module on header sockets J20, J21, and J22 of the BL2100 main board as shown in Figure C-1. Be careful to align the pins over the headers, and do not bend them as you press down to mate the LCD/keypad module with the BL2100 main board.

> Figure C-1. Install LCD/Keypad Module on BL2100 Main Board

> ### C.3 Keypad Labeling

> The keypad may be labeled according to your needs. A template is provided in Figure C-2 to allow you to design your own keypad label insert.

> Figure C-2. Keypad Template

> To replace the keypad legend, remove the old legend and insert your new legend prepared according to the template in Figure C-2. The keypad legend is located under the blue keypad matte, and is accessible from the left only as shown in Figure C-3.

> Figure C-3. Removing and Inserting Keypad Label

> ### C.4 Header Pinouts

> Figure C-4 shows the pinouts for headers J20, J21, and J22 of the BL2100 main board.

> Figure C-4. Pinouts for Headers J20, J21, and J22 of the BL2100 Main Board

> #### C.4.1 I/O Address Assignments

> The LCD and keypad on the LCD/keypad module are addressed by the PE7 strobe as explained in Table C-2.

> Table C-2. LCD/Keypad Module Address Assignment
> Address | Function
> Exx0-Exx7 | LCD control
> Exx8 | LED enable
> Exx9 | Not used
> ExxA | 7-key keypad
> ExxB (bits 0-6) | 7-LED driver
> ExxB (bit 7) | LCD backlight on/off
> ExxC-ExxF | Not used

> ### C.5 Programming Cable Tips

> Once the LCD/keypad module is in place on the BL2100, it is not possible to remove or attach the programming cable to/from the BL2100 programming port. You will have to remove, or at least lift up, the LCD/keypad module while you connect or disconnect the programming cable.

> While you are developing your application, you may wish to connect or disconnect the programming cable when resetting the BL2100 and switching between the Program Mode and the Run Mode. To avoid the inconvenience of removing and replacing the LCD/keypad module each time, the programming cable may be disconnected/reconnected at the RS-232/CMOS level converter in the middle of the programming cable.

> 1. Peel back plastic shrink wrap as shown in Figure C-5.
> Figure C-5. Peel Back Plastic Shrink Wrap

> 2. Disconnect the programming cable at RS-2332/CMOS level converter board.

> Figure C-6. Disconnect Programming Cable

> 3. Line up the colored edges of the programming cable when reconnecting the programming cable. Reconnect the programming cable as shown in Figure C-7, being careful to align the pins with the jack

> Figure C-7. Reconnect Programming Cable

> Once you have finished programming the LCD/keypad module, you should disconnect the programming cable from the BL2100 programming port, remembering to first remove, or at least lift up, the LCD/keypad module, disconnect the programming cable, and finally firmly mount the LCD/keypad module back on the BL2100 main board.

> ### C.6 LCD/Keypad Module Function APIs

> #### C.6.1 LEDs

> When power is applied to the LCD/keypad module for the first time, the red LED (DS1) will come on, indicating that power is being applied to the LCD/keypad module. The red LED is turned off when the brdInit function executes.

> One function is available to control the LEDs, and can be found in the BL21XX.LIB library.

> ##

> void ledOut(int led, int value);

> LED on/off control. This function will only work when the LCD/keypad module is installed on the BL2100.
> PARAMETERS
> led is the LED to control.
> 0 = LED DS1
> 1 = LED DS2
> 2 = LED DS3
> 3 = LED DS4
> 4 = LED DS5
> 5 = LED DS6
> 6 = LED DS7
> value is the value used to control whether the LED is on or off (0 or 1).
> 0 = off
> 1 = on
> RETURN VALUE
> None.
> SEE ALSO

>     brdInit

> #### C.6.2 LCD Display

> The functions used to control the LCD display are contained in the GRAPHIC.LIB library located in the Dynamic C DISPLAYS/GRAPHIC library directory.

> ##

> void glInit(void);

> Initializes the display devices, clears the screen.
> RETURN VALUE
> None.
> SEE ALSO

>     glDispOnOFF, glBacklight, glSetContrast, glPlotDot, glBlock, glPlotDot, glPlotPolygon, glPlotCircle, glHScroll, glVScroll, glXFontInit, glPrintf, glPutChar, glSetBrushType, glBuffLock, glBuffUnlock, glPlotLine

> ##

> void glBackLight(int onOff);

> Sets the intensity of the backlight, if circuitry is installed.
> PARAMETER
> : onOff reflects the low to high values (typically 0 to 255, depending on the board design) to set the backlight intensity (0 will turn the backlight off completely.)
> RETURN VALUE
> None.
> SEE ALSO

>     glInit, glDispOnoff, glSetContrast

> ##

> void glDispOnOff(int onOff);

> Sets the LCD screen on or off. Data will not be cleared from the screen.
> PARAMETER
> onOff turns the LCD screen on or off
> 1--turn the LCD screen on
> 0--turn the LCD screen off
> RETURN VALUE
> None.
> SEE ALSO

>     glInit, glSetContrast, glBackLight

> ##

> void glSetContrast(unsigned level);

> Sets display contrast (the circuitry is not installed for the LCD/keypad module for the BL2100).
> PARAMETER
> level reflects low to high values (typically 0 to 255, depending on the board design) to give high to low contrast respectively.
> RETURN VALUE
> None.
> SEE ALSO

>     glInit, glBacklight, glDispOnoff

> ##

> void glFillScreen(char pattern);

> Fills the LCD display screen with a pattern.
> PARAMETER
> The screen will be set to all black if pattern is 0xFF, all white if pattern is 0x00, and vertical stripes for any other pattern.
> RETURN VALUE
> None.
> SEE ALSO

>     glBlock, glBlankScreen, glPlotPolygon, glPlotCircle

> ##

> void glBlankScreen(void);

> Blanks the LCD display screen (sets LCD display screen to white).
> RETURN VALUE
> None.
> SEE ALSO

>     glFillScreen, glBlock, glPlotPolygon, glPlotCircle

> ##

> void glBlock(int x, int y, int bmWidth, int bmHeight);

> Draws a rectangular block in the page buffer and on the LCD if the buffer is unlocked. Any portion of the block that is outside the LCD display area will be clipped.
> PARAMETERS
> x is the x coordinate of the upper left corner of the block.
> y is the y coordinate of the left top corner of the block.
> bmWidth is the width of the block.
> bmWidth is the height of the block.
> RETURN VALUE
> None.
> SEE ALSO

>     glFillScreen, glBlankScreen, glPlotPolygon, glPlotCircle

> ##

> void glPlotVPolygon(int n, int *pFirstCoord);

> Plots the outline of a polygon in the LCD page buffer, and on the LCD if the buffer is unlocked. Any portion of the polygon that is outside the LCD display area will be clipped. The function will also return, doing nothing, if there are less than 3 vertices.
> PARAMETERS
> n is the number of vertices.
> *pFirstCoord is a pointer to array of vertex coordinates: x1,y1, x2,y2, x3,y3,...
> RETURN VALUE
> None.
> SEE ALSO

>     glPlotPolygon, glFillPolygon, glFillVPolygon

> ##

> void glPlotPolygon(int n, int y1, int x2, int y2, ...);

> Plots the outline of a polygon in the LCD page buffer and on the LCD if the buffer is unlocked. Any portion of the polygon that is outside the LCD display area will be clipped. The function will also return, doing nothing, if there are less than 3 vertices.
> PARAMETERS
> n is the number of vertices.
> y1 is the y coordinate of the first vertex.
> x1 is the x coordinate of the first vertex.
> y2 is the y coordinate of the second vertex.
> x2 is the x coordinate of the second vertex.
> ... are the coordinates of additional vertices.
> RETURN VALUE
> None.
> SEE ALSO

>     glPlotVPolygon, glFillPolygon, glFillVPolygon

> ##

> void glFillVPolygon(int n, int *pFirstCoord);

> Fills a polygon in the LCD page buffer and on the LCD screen if the buffer is unlocked. Any portion of the polygon that is outside the LCD display area will be clipped. The function will also return, doing nothing, if there are less than 3 vertices.
> PARAMETERS
> n is the number of vertices.
> *pFirstCoord is a pointer to array of vertex coordinates: x1,y1, x2,y2, x3,y3,...
> RETURN VALUE
> None.
> SEE ALSO

>     glFillPolygon, glPlotPolygon, glPlotVPolygon

> ##

> void glFillPolygon(int n, int x1, int y1, int x2, int y2, ...);

> Fills a polygon in the LCD page buffer and on the LCD if the buffer is unlocked. Any portion of the polygon that is outside the LCD display area will be clipped.
> PARAMETERS
> n is the number of vertices.
> x1 is the x coordinate of the first vertex.
> y1 is the y coordinate of the first vertex.
> x2 is the x coordinate of the second vertex.
> y2 is the y coordinate of the second vertex.
> ... are the coordinates of additional vertices.
> RETURN VALUE
> None.
> SEE ALSO

>     glFillVPolygon, glPlotPolygon, glPlotVPolygon

> ##

> void glPlotCircle(int xc, int yc, int rad);

> Draws a circle in the LCD page buffer and on the LCD if the buffer is unlocked. Any portion of the circle that is outside the LCD display area will be clipped.
> PARAMETERS
> xc is the x coordinate of the center of the circle.
> yc is the y coordinate of the center of the circle.
> rad is the radius of the center of the circle (in pixels).
> RETURN VALUE
> None.
> SEE ALSO

>     glFillCircle, glPlotPolygon, glFillPolygon

> ##

> void glFillCircle(int xc, int yc, int rad);

> Draws a filled circle in the LCD page buffer and on the LCD if the buffer is unlocked. Any portion of the circle that is outside the LCD display area will be clipped.
> PARAMETERS
> xc is the x coordinate of the center of the circle.
> yc is the y coordinate of the center of the circle.
> rad is the radius of the center of the circle (in pixels).
> RETURN VALUE
> None.
> SEE ALSO

>     glPlotCircle, glPlotPolygon, glFillPolygon

> ##

> void glXFontInit(fontInfo *pInfo, char pixWidth, char pixHeight, unsigned startChar, unsigned endChar, unsigned long xmemBuffer);

> Initializes the font descriptor structure, where the font is stored in xmem. Each font character's bitmap is column major and byte-aligned.
> PARAMETERS
> *pInfo is a pointer to the font descriptor to be initialized.
> pixWidth is the width (in pixels) of each font item.
> pixHeight is the height (in pixels) of each font item.
> startChar is the value of the first printable character in the font character set.
> endChar is the value of the last printable character in the font character set.
> xmemBuffer is the xmem pointer to a linear array of font bitmaps.
> RETURN VALUE
> None.
> SEE ALSO

>     glPrinf

> ##

> unsigned long glFontCharAddr(fontInfo *pInfo, char letter);

> Returns the xmem address of the character from the specified font set.
> PARAMETERS
> *pInfo is the xmem address of the bitmap font set.
> letter is an ASCII character.
> RETURN VALUE
> xmem address of bitmap character font, column major, and byte-aligned.
> SEE ALSO

>     glPutFont, glPrintf

> ##

> void glPutFont(int x, int y, fontInfo *pInfo, char code);

> Puts an entry from the font table to the page buffer and on the LCD if the buffer is unlocked. Each font character's bitmap is column major and byte-aligned. Any portion of the bitmap character that is outside the LCD display area will be clipped.
> PARAMETERS
> x is the x coordinate (column) of the upper left corner of the text.
> y is the y coordinate (row) of the left top corner of the text.
> *pInfo is a pointer to the font descriptor.
> code is the ASCII character to display.
> RETURN VALUE
> None.
> SEE ALSO

>     glFontCharAddr, glPrintf

> ##

> void glSetPfStep(int stepX, int stepY);

> Sets the glPrintf() printing step direction. The x and y step directions are independent signed values. The actual step increments depend on the height and width of the font being displayed, which are multiplied by the step values.
> PARAMETERS
> stepX is the glPrintf x step value
> stepY is the glPrintf y step value
> RETURN VALUE
> None.
> SEE ALSO
> Use glGetPfStep() to examine the current x and y printing step direction.

> ##

> int glGetPfStep(void);

> Gets the current glPrintf() printing step direction. Each step direction is independent of the other, and is treated as an 8-bit signed value. The actual step increments depends on the height and width of the font being displayed, which are multiplied by the step values.
> RETURN VALUE
> The x step is returned in the MSB, and the y step is returned in the LSB of the integer result.
> SEE ALSO
> Use glGetPfStep() to control the x and y printing step direction.

> ##

> void glPutChar(char ch, char *ptr, int *cnt,
> glPutCharInst *pInst)

> Provides an interface between the STDIO string-handling functions and the graphic library. The STDIO string-formatting function will call this function, one character at a time, until the entire formatted string has been parsed. Any portion of the bitmap character that is outside the LCD display area will be clipped.
> PARAMETERS
> ch is the character to be displayed on the LCD.
> *ptr is not used, but is a place holder for STDIO string functions.
> *cnt is not used, is a place holder for STDIO string functions.
> *pInst is a font descriptor pointer.
> RETURN VALUE
> None.
> SEE ALSO

>     glPrintf, glPutFont, doprnt

> ##

> void glPrintf(int x, int y, fontInfo *pInfo, char *fmt, ...);

> Prints a formatted string (much like printf) on the LCD screen. Only the character codes that exist in the font set are printed, all others are skipped. For example, '\b', '\t', '\n' and '\r' (ASCII backspace, tab, new line, and carriage return, respectively) will be printed if they exist in the font set, but will not have any effect as control characters. Any portion of the bitmap character that is outside the LCD display area will be clipped.
> PARAMETERS
> x is the x coordinate (column) of the upper left corner of the text.
> y is the y coordinate (row) of the upper left corner of the text.
> *pInfo is a font descriptor pointer.
> *fmt is a formatted string.
> ... are formatted string conversion parameter(s).
> EXAMPLE

>     glprintf(0,0, &fi12x16, "Test %d\n", count);

> RETURN VALUE
> None.
> SEE ALSO

>     glXFontInit

> ##

> void glBuffLock(void);

> Increments LCD screen locking counter. Graphic calls are recorded in the LCD memory buffer and are not transferred to the LCD if the counter is non-zero.

> NOTE | glBuffLock() and glBuffUnlock() can be nested up to a level of 255, but be sure to balance the calls. It is not a requirement to use these procedures, but a set of glBuffLock() and glBuffUnlock()bracketing a set of related graphic calls speeds up the rendering significantly.

> RETURN VALUE
> None.
> SEE ALSO

>     glBuffUnlock, glSwap

> ##

> void glBuffUnlock(void);

> Decrements the LCD screen locking counter. The contents of the LCD buffer are transferred to the LCD if the counter goes to zero.
> RETURN VALUE
> None.
> SEE ALSO

>     glBuffLock, glSwap

> ##

> void glSwap(void);

> Checks the LCD screen locking counter. The contents of the LCD buffer are transferred to the LCD if the counter is zero.
> RETURN VALUE
> None.
> SEE ALSO

>     glBuffUnlock, glBuffLock, _glSwapData (located in the library specifically for the LCD that you are using)

> ##

> void glSetBrushType(int type);

> Sets the drawing method (or color) of pixels drawn by subsequent graphic calls.
> PARAMETER
> type value can be one of the following macros.
> PIXBLACK draws black pixels.
> PIXWHITE draws white pixels.
> PIXXOR draws old pixel XOR'ed with the new pixel.
> RETURN VALUE
> None.
> SEE ALSO

>     glGetBrushType

> ##

> int glGetBrushType(void);

> Gets the current method (or color) of pixels drawn by subsequent graphic calls.
> RETURN VALUE
> The current brush type.
> SEE ALSO

>     glSetBrushType

> ##

> void glPlotDot(int x, int y);

> Draws a single pixel in the LCD buffer, and on the LCD if the buffer is unlocked. If the coordinates are outside the LCD display area, the dot will not be plotted.
> PARAMETERS
> x is the x coordinate of the dot.
> y is the y coordinate of the dot.
> RETURN VALUE
> None.
> SEE ALSO

>     glPlotline, glPlotPolygon, glPlotCircle

> ##

> void glPlotLine(int x0, int y0, int x1, int y1);

> Draws a line in the LCD buffer, and on the LCD if the buffer is unlocked. Any portion of the line that is beyond the LCD display area will be clipped.
> PARAMETERS
> x0 is the x coordinate of one endpoint of the line.
> y0 is the y coordinate of one endpoint of the line.
> x1 is the x coordinate of the other endpoint of the line.
> y1 is the y coordinate of the other endpoint of the line.
> RETURN VALUE
> None.
> SEE ALSO

>     glPlotDot, glPlotPolygon, glPlotCircle

> ##

> void glLeft1(int left, int top, int cols, int rows);

> Scrolls byte-aligned window left one pixel, right column is filled by current pixel type (color).
> PARAMETERS
> left is the upper left corner of bitmap, must be evenly divisible by 8.
> top is the left top corner of the bitmap.
> cols is the number of columns in the window, must be evenly divisible by 8.
> rows is the number of rows in the window.
> RETURN VALUE
> None.
> SEE ALSO

>     glHScroll, glRight1

> ##

> void glRight1(int left, int top, int cols, int rows);

> Scrolls byte-aligned window right one pixel, left column is filled by current pixel type (color).
> PARAMETERS
> left is the upper left corner of bitmap, must be evenly divisible by 8.
> top is the left top corner of the bitmap.
> cols is the number of columns in the window, must be evenly divisible by 8.
> rows is the number of rows in the window.
> RETURN VALUE
> None.
> SEE ALSO

>     glHScroll, glLeft1

> ##

> void glUp1(int left, int top, int cols, int rows);

> Scrolls byte-aligned window up one pixel, bottom column is filled by current pixel type (color).
> PARAMETERS
> left is the upper left corner of bitmap, must be evenly divisible by 8.
> top is the left top corner of the bitmap.
> cols is the number of columns in the window, must be evenly divisible by 8.
> rows is the number of rows in the window.
> RETURN VALUE
> None.
> SEE ALSO

>     glVScroll, glDown1

> ##

> void glDown1(int left, int top, int cols, int rows);

> Scrolls byte-aligned window down one pixel, top column is filled by current pixel type (color).
> PARAMETERS
> left is the upper left corner of bitmap, must be evenly divisible by 8.
> top is the left top corner of the bitmap.
> cols is the number of columns in the window, must be evenly divisible by 8.
> rows is the number of rows in the window.
> RETURN VALUE
> None.
> SEE ALSO

>     glVScroll, glUp1

> ##

> void glHScroll(int left, int top, int cols, int rows, int nPix);

> Scrolls right or left, within the defined window by x number of pixels. The opposite edge of the scrolled window will be filled in with white pixels. The window must be byte-aligned.
> Parameters will be verified for the following:
> 1. The left and cols parameters will be verified that they are evenly divisible by 8. If not, they will be changed to a value that is a multiple of 8.
> 2. Parameters will be checked to verify that the scrolling area is valid. The minimum scrolling area is a width of 8 pixels and a height of one row.
> PARAMETERS
> left is the upper left corner of bitmap, must be evenly divisible by 8.
> top is the left top corner of the bitmap.
> cols is the number of columns in the window, must be evenly divisible by 8.
> rows is the number of rows in the window.
> nPix is the number of pixels to scroll within the defined window (a negative value will produce a scroll to the left).
> RETURN VALUE
> None.
> SEE ALSO

>     glVScroll

> ##

> void glVScroll(int left, int top, int cols, int rows, int nPix);

> Scrolls up or down, within the defined window by x number of pixels. The opposite edge of the scrolled window will be filled in with white pixels. The window must be byte-aligned.
> Parameters will be verified for the following:
> 1. The left and cols parameters will be verified that they are evenly divisible by 8. If not, they will be changed to a value that is a multiple of 8.
> 2. Parameters will be checked to verify that the scrolling area is valid. The minimum scrolling area is a width of 8 pixels and a height of one row.
> PARAMETERS
> left is the upper left corner of bitmap, must be evenly divisible by 8.
> top is the left top corner of the bitmap.
> cols is the number of columns in the window, must be evenly divisible by 8.
> rows is the number of rows in the window.
> nPix is the number of pixels to scroll within the defined window (a negative value will produce a scroll up).
> RETURN VALUE
> None.
> SEE ALSO

>     glHScroll

> ##

> void glXPutBitmap(int left, int top, int width, int height, unsigned long bitmap);

> Draws bitmap in the specified space. The data for the bitmap are stored in xmem. This function calls glXPutFastmap automatically if the bitmap is byte-aligned (the left edge and the width are each evenly divisible by 8).
> Any portion of a bitmap image or character that is outside the LCD display area will be clipped.
> PARAMETERS
> left is the upper left corner of the bitmap.
> top is the upper left corner of the bitmap.
> width is the width of the bitmap.
> height is the height of the bitmap.
> bitmap is the address of the bitmap in xmem.
> RETURN VALUE
> None.
> SEE ALSO

>     glXPutFastmap, glPrintf

> ##

> void glXPutFastmap(int left, int top, int width, int height, unsigned long bitmap);

> Draws bitmap in the specified space. The data for the bitmap are stored in xmem. This function is like glXPutBitmap, except that it is faster. The restriction is that the bitmap must be byte-aligned.
> Any portion of a bitmap image or character that is outside the LCD display area will be clipped.
> PARAMETERS
> left is the upper left corner of the bitmap, must be evenly divisible by 8.
> top is the upper left corner of the bitmap.
> width is the width of the bitmap, must be evenly divisible by 8.
> height is the height of the bitmap.
> bitmap is the address of the bitmap in xmem.
> RETURN VALUE
> None.
> SEE ALSO

>     glXPutBitmap, glPrintf

> ##

> int TextWindowFrame(windowFrame *window, fontInfo *pFont, int x, int y, int winWidth, int winHeight)

> Defines a text-only display window. This function provides a way to display characters within the text window using only character row and column coordinates. The text window feature provides end-of-line wrapping and clipping after the character in the last column and row is displayed.

> NOTE | Execute the TextWindowFrame function before other Text... functions.

> PARAMETERS

> *window is a window frame descriptor pointer.
> *pFont is a font descriptor pointer.
> x is the x coordinate of where the text window frame is to start.
> y is the y coordinate of where the text window frame is to start.
> winWidth is the width of the text window frame.
> winHeight is the height of the text window frame.
> RETURN VALUE
> 0--window frame was successfully created.
> -1--x coordinate + width has exceeded the display boundary.
> -2--y coordinate + height has exceeded the display boundary.

> ##

> void TextGotoXY(windowFrame *window, int col, int row);

> Sets the cursor location on the display of where to display the next character. The display location is based on the height and width of the character to be displayed.

> NOTE | Execute the TextWindowFrame function before using this function.

> PARAMETERS

> *window is a pointer to a font descriptor.
> col is a character column location.
> row is a character row location.
> RETURN VALUE
> None.
> SEE ALSO

>     TextPutChar, TextPrintf, TextWindowFrame

> ##

> void TextCursorLocation(windowFrame *window, int *col, int *row);

> Gets the current cursor location that was set by a Graphic Text... function.

> NOTE | Execute the TextWindowFrame function before using this function.

> PARAMETERS

> *window is a pointer to a font descriptor.
> *col is a pointer to cursor column variable.
> *row is a pointer to cursor row variable.
> RETURN VALUE
> Lower word = Cursor Row location
> Upper word = Cursor Column location
> SEE ALSO

>     TextGotoXY, TextPrintf, TextWindowFrame, TextCursorLocation

> ##

> void TextPutChar(struct windowFrame *window, char ch);

> Displays a character on the display where the cursor is currently pointing. If any portion of a bitmap character is outside the LCD display area, the character will not be displayed.

> NOTE | Execute the TextWindowFrame function before using this function.

> PARAMETERS

> *window is a pointer to a font descriptor.
> ch is a character to be displayed on the LCD.
> RETURN VALUE
> None.
> SEE ALSO

>     TextGotoXY, TextPrintf, TextWindowFrame, TextCursorLocation

> ##

> void TextPrintf(struct windowFrame *window, char *fmt, ...);

> Prints a formatted string (much like printf) on the LCD screen. Only printable characters in the font set are printed, also escape sequences, '\r' and '\n' are recognized. All other escape sequences will be skipped over; for example, '\b' and 't' will print if they exist in the font set, but will not have any effect as control characters.
> The text window feature provides end-of-line wrapping and clipping after the character in the last column and row is displayed.

> NOTE | Execute the TextWindowFrame function before using this function.

> PARAMETERS

> *window is a pointer to a font descriptor.
> *fmt is a formatted string.
> ... are formatted string conversion parameter(s).
> EXAMPLE

>     TextPrintf(&TextWindow, "Test %d\n", count);

> RETURN VALUE
> None.
> SEE ALSO

>     TextGotoXY, TextPutChar, TextWindowFrame, TextCursorLocation

> #### C.6.3 Keypad

>     The functions used to control the keypad are contained in the KEYPAD.LIB library located in the Dynamic C KEYPAD library directory.

> ##

> void keyInit(void);

> Initializes keypad process
> RETURN VALUE
> None.
> SEE ALSO

>     brdInit

> ##

> void keyConfig(char cRaw, char cPress, char cRelease, char cCntHold, char cSpdLo, char cCntLo, char cSpdHi);

> Assigns each key with key press and release codes, and hold and repeat ticks for auto repeat and debouncing.
> PARAMETERS
>   cRaw is a raw key code index.
>   1x7 keypad matrix with raw key code index assignments (in brackets):

>   [0] |  | [1] |  | [2] |  | [3]
>   | [4] |  | [5] |  | [6] |

>   User Keypad Interface
>   cPress is a key press code
>   An 8-bit value is returned when a key is pressed.
>   0 = Unused.
>   See keypadDef() for default press codes.
>   cRelease is a key release code.
>   An 8-bit value is returned when a key is pressed.
>   0 = Unused.
>   cCntHold is a hold tick.
>   How long to hold before repeating.
>   0 = No Repeat.
>   cSpdLo is a low-speed repeat tick.
>   How many times to repeat.
>   0 = None.
>   cCntLo is a low-speed hold tick.
>   How long to hold before going to high-speed repeat.
>   0 = Slow Only.
>   cSpdHi is a high-speed repeat tick.
>   How many times to repeat after low speed repeat.
>   0 = None.
> RETURN VALUE
> None.
> SEE ALSO

>     keyProcess, keyGet, keypadDef

> ##

> void keyProcess(void);

> Scans and processes keypad data for key assignment, debouncing, press and release, and repeat.

> NOTE | This function is also able to process an 8 × 8 matrix keypad.

> RETURN VALUE

> None
> SEE ALSO

>     keyConfig, keyGet, keypadDef

> ##

> char keyGet(void);

> Get next keypress
> RETURN VALUE
> The next keypress, or 0 if none
> SEE ALSO

>     keyConfig, keyProcess, keypadDef

> ##

> int keyUnget(char cKey);

> Push keypress on top of input queue
> PARAMETER
> cKey
> RETURN VALUE
> None.
> SEE ALSO

>     keyGet

> ##

> void keypadDef();

>   Configures the physical layout of the keypad with the desired ASCII return key codes.
>   Keypad physical mapping 1 × 7

>   0 | 4 | 1 | 5 | 2 | 6 | 3
>   ['L'] |  | ['U'] |  | ['D'] |  | ['R']
>   | ['-'] |  | ['+'] |  | ['E'] |

>   where
>   'E' represents the ENTER key
>   '+' represents
>   '-' represents
>   'D' represents Down Scroll
>   'U' represents Up Scroll
>   'R' represents Right Scroll
>   'L' represents Left Scroll
>   Example: Do the following for the above physical vs. ASCII return key codes.

>     	 	 	 	 	 keyConfig (  3,'R',0, 0, 0, 0, 0 );
>     	 	 	 	 	 keyConfig (  6,'E',0, 0, 0, 0, 0 );
>     	 	 	 	 	 keyConfig (  2,'D',0, 0, 0, 0, 0 );
>     	 	 	 	 	 keyConfig (  4,'-',0, 0, 0, 0, 0 );
>     	 	 	 	 	 keyConfig (  1,'U',0, 0, 0, 0, 0 );
>     	 	 	 	 	 keyConfig (  5,'+',0, 0, 0, 0, 0 );
>     	 	 	 	 	 keyConfig (  0,'L',0, 0, 0, 0, 0 );

> Characters are returned upon keypress with no repeat.
> RETURN VALUE
> None.
> SEE ALSO

>     keyConfig, keyGet, keyProcess

> ##

> void keyScan(char *pcKeys);

> Writes "1" to each row and reads the value. The position of a keypress is indicated by a zero value in a bit position.
> PARAMETER
> *pcKeys is the address of the value read.
> RETURN VALUE
> None.
> SEE ALSO

>     keyConfig, keyGet, keypadDef, keyProcess

> ### C.7 Sample Programs

> The following sample programs are found in the 122x32_1x7 subdirectory in SAMPLES/LCD_Keypad.

> - ALPHANUM.C--Demonstrates how to create messages using the keypad and then displaying them on the LCD display.
> - COFTERMA.C--Demonstrates cofunctions, the cofunction serial library, and using a serial ANSI terminal such as Hyperterminal from an available COM port connection.
> - DISPPONG.C--Demonstrates output to LCD display.
> - DKADEMO1.C--Demonstrates some of the LCD/keypad module font and bitmap manipulation features with horizontal and vertical scrolling, and using the GRAPHIC.LIB library.
> - FUN.C--Demonstrates drawing primitive features (lines, circles, polygons) using the GRAPHIC.LIB library
> - KEYBASIC.C--Demonstrates the following keypad functions in the STDIO display window:
> - default ASCII keypad return values.
> - custom ASCII keypad return values.
> - keypad repeat functionality.
> - KEYMENU.C--Demonstrates how to implement a menu system using a highlight bar on a graphic LCD display. The menu options for this sample are as follows.
> 1. Set Date/Time
> 2. Display Date/Time
> 3. Turn Backlight OFF
> 4. Turn Backlight ON
> 5. Toggle LEDs
> 6. Increment LEDs
> 7. Disable LEDs
> - LED.C--Demonstrates how to toggle the LEDs on the LCD/keypad module.
> - SCROLLING.C--Demonstrates scrolling features of the GRAPHIC.LIB library.
> - TEXT.C--Demonstrates the text functions in the GRAPHIC.LIB library. Here is a list of what is demonstrated.
> 1. Font initialization.
> 2. Text window initialization.
> 3. Text window, end-of-line wraparound, end-of-text window clipping, line feed, and carriage return.
> 4. Creating 2 different TEXT windows for display.
> 5. Displaying different FONT sizes.

> The following sample programs, found in the TCPIP subdirectory in SAMPLES/LCD_Keypad/122x32_1x7, are targeted at the Ethernet-enabled versions of the BL2100, the BL2100 and the BL2110. Remember to configure the IP address, netmask, and gateway as indicated in the sample programs.

> - MBOXDEMO.C--This program implements a web server that allows e-mail messages to be entered that are then shown on the LCD display. The keypad allows you to scroll within messages, flip to other e-mails, mark messages as read, and delete e-mails. When a new e-mail arrives, an LED turns on, and turns off once the message has been marked as read. A log of all e-mail actions is kept, and can be displayed in the Web browser. All current e-mails can also be read with the Web browser.
> - When using MBOXDEMO.C, connect the BL2100 and a PC (or other device with a Web Browser) to an Ethernet. If you connect the PC and the BL2100 directly, be sure to use a crossover Ethernet cable; strait-through Ethernet cables and a hub may be used instead.
> - TCP_RESPOND.C--This program and TCP_SEND.C are executed on two separate single-board computers to demonstrate how the two boards communicate with each other. Use PCSEND.EXE on the PC console side at the command prompt if you do not have a second board. PCSEND.EXE is located with source code in the SAMPLES/LCD_Keypad/Windows directory.
> - TCP_RESPOND.C waits for a message from another single-board computer. The message received is displayed on the LCD, and you may respond by pressing a key on the keypad. The response is then sent to the remote single-board computer.
> - TCPSEND.C--This program andTCP_RESPOND.C are executed on two separate single-board computers to demonstrate how the two boards communicate with each other. Use PCRESPOND.EXE on the PC console side at the command prompt if you do not have a second board. PCRESPOND.EXE is located with source code in the SAMPLES/LCD_Keypad/Windows directory.
> - When a key on the keypad is pressed, a message associated with that key is sent to a specified destination address and port. The destination then responds to that message. The response is displayed on the LCD.
> - Note that only the LEFT and UP scroll keys are set up to cause a message to be sent.

> When using TCPSEND.C and TCP_RESPOND.C, connect the BL2100 and the other single-board computer to an Ethernet. If you connect the them directly, be sure to use a crossover Ethernet cable; strait-through Ethernet cables and a hub may be used instead.

Z-World http://www.zworld.com Voice: (530) 753-3737 FAX: (530) 753-5141 sales@zworld.com