Display_osd232.pm

Display_osd232

SYNOPSIS

NONE

DESCRIPTION

Allows for displaying one or more pages of text on an Intuitive Circuits OSD-232 On-screen display character overlay board with RS-232 interface. It should also support their VideoStamp product by simply setting the apprpriate baud rate, although I don't have one to test.

INHERITS

NONE

METHODS

addpage(NAME OF PAGE,REFERENCE TO PAGE OBJECT)

Add a page object

deletepage(NAME OF PAGE)

Remove a page object

printpage(NAME OF PAGE)

Print out an entire page. Used for testing

startflipping()

Start flipping between the defined pages

stopflipping()

Stop flipping pages, the screen will be left on whatever page was last displayed

flippage()

Flip to the next page (*** need option to flip to specific page)

currentfliprate()

Get the length of time to display the current page we're flipping to. This is either the pages custom flip rate or the default flip rate if a custom one has not been defined

port([PORT NAME])

Set or return the name of the control port

speed([PORT SPEED])

Set or return the port port speed

fliprate([PAGE FLIP RATE])

Set or return the default page flip rate. This is the number of seconds we show pages that don't have their own flip rate defined

reset()

Reset the osd232 requires minimum of 10ms delay after reset command

clearscreen()

Clear the osd232 display requires minimum of 10ms delay after command

showdisplay()

Show the current osd232 display text on the video output signal (***Combine showdisplay and hidedisplay to a single function with a parameter determining whether to show or hide)

hidedisplay()

hide the current osd232 display text on the video output signal

background(COLOR)

set the display background color

showpage(PAGE NAME)

write a page of text to the osd232 buffer

INI PARAMETERS

NONE

AUTHOR

Brent DeShazer brent@deshazer.net

SEE ALSO

See http://www.icircuits.com/prod_osd232.html and http://www.icircuits.com/prod_videostamp.html

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Display_osd232page

SYNOPSIS

Page parameters

  PAGENAME - unique name of this page
  BGCOLOR - background color of this page
  FLIP - whether to display this page when doing timed flipping
  FLIPRATE - over-ride default flip rate for this page

Line parameters

  TEXT - text to display
  X - horizontal coordinate to display text at
  Y - vertical coordinate to display text at
  TEXTCOLOR - Color to display text in

DESCRIPTION

NONE

INHERITS

NONE

METHODS

pagename([NAME OF PAGE])

set or return name of the page

pageref()

return an object reference to this page

bgcolor([COLOR])

set or return the bakcground color for this page

flip([0 - noflip, =1 - flip])>

set or return whether this page is included in the flip rotation

fliprate([SECONDS])

set or return the flip delay for this page

addline(LINE NAME,PARM1=VALUE,PARM2=>VALUE,...)>

add a line to this page

deleteline(LINE NAME)

delete a line from this page

values(LINE NAME,VALUE HASH KEY)

set or return a value from a lines hash

settext("TEXT TO DISPLAY")

A convenience function to change the text of a line.

print()

Print all the elements of all lines of this page. Used for testing

writedisplay()

Write the content of all lines to the osd232 display memory. Note that whether it actually shows on the screen is dependant on whether we are currently hiding or showing the display!

INI PARAMETERS

NONE

AUTHOR

Brent DeShazer brent@deshazer.net

SEE ALSO

See http://www.icircuits.com/prod_osd232.html and http://www.icircuits.com/prod_videostamp.html

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

 Display_osd232.pm