Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

updating docco

  • Loading branch information...
commit 2eb94063b5cb217520ab4824b81b974467b06809 1 parent b6c4c80
Aaron Patterson authored

Showing 1 changed file with 9 additions and 4 deletions. Show diff stats Hide diff stats

  1. +9 4 README.rdoc
13 README.rdoc
Source Rendered
@@ -27,7 +27,7 @@ file displayed on the sign is labeled 'A'.
27 27
28 28 Here is an example of modifying the default sign text:
29 29
30   - bb = BetaBrite::Serial.new('/dev/ttyUSB0') do |sign|
  30 + bb = BetaBrite::USB.new do |sign|
31 31 sign.textfile do
32 32 print ARGV[0]
33 33 end
@@ -35,6 +35,7 @@ Here is an example of modifying the default sign text:
35 35 bb.write!
36 36
37 37 == Autotest Support
  38 +
38 39 Here is an example of a .autotest file using the BetaBrite module:
39 40
40 41 require 'betabrite/autotest'
@@ -48,13 +49,14 @@ You don't need to give the hook method a block, but you can if you'd like to
48 49 customize your messages.
49 50
50 51 == Allocating Memory
  52 +
51 53 The memory in the BetaBrite sign should be configured before anything is
52 54 written to it. You only have to configure the memory once before writing to
53   -it. So subsequent executions of your script do not require allocating memory.
  55 +it. Subsequent executions of your script do not require allocating memory.
54 56
55 57 Here is an example of allocating memory on the sign:
56 58
57   - bb = BetaBrite::Serial.new('/dev/ttyUSB0') do |sign|
  59 + bb = BetaBrite::USB.new do |sign|
58 60 sign.allocate do |memory|
59 61 memory.text('A', 4096)
60 62 memory.string('0', 64)
@@ -65,7 +67,9 @@ Here is an example of allocating memory on the sign:
65 67 For more examples, see the EXAMPLES file.
66 68
67 69 == Different File Types
  70 +
68 71 === Text Files
  72 +
69 73 The data stored in a text file is not supposed to change frequently. If the
70 74 data in a text file is changed, the sign will go blank before anything is
71 75 displayed. This is not good for applications like a stock ticker which
@@ -73,13 +77,14 @@ update data quite frequently. This problem can be avoided by having the
73 77 text file reference more volitile files like String Files.
74 78
75 79 === String Files
  80 +
76 81 String files contain more volitile memory. The contents of a String File
77 82 can be changed without the screen going blank. String Files, however, cannot
78 83 be displayed unless referenced from a Text File.
79 84
80 85 Here is an example of referencing a String File from a Text File:
81 86
82   - bb = BetaBrite::Serial.new('/dev/ttyUSB0') do |sign|
  87 + bb = BetaBrite::USB.new do |sign|
83 88 sign.stringfile('0') do
84 89 print string("cruel").red
85 90 end

0 comments on commit 2eb9406

Please sign in to comment.
Something went wrong with that request. Please try again.