ManualWoFrames < Velo

---+ User Manual without Frames

---+ Command-Line Interface

---++ Terminal Emulator
You can use the command-line interface CLI over USB CDC or Bluetooth LE vSP. You need an application for the PC or an app for the smartphone.

---+++ Terminal emulator apps for smartphones (Bluetooth)  
The BLE vSP profile is proprietary, there is no standard serial communication profile: 
   * [[https://play.google.com/store/apps/details?id=com.lairdtech.lairdtoolkit][Android Smartphones]] Laird Toolkit, Serial (vSP)
   * [[https://itunes.apple.com/gb/app/laird-toolkit/id978146538][iOS]] Laird Toolkit, Serial
After a successful connection the LED LD16 is on (blue).

---+++ Terminal emulator applications for PCs
You have to connect the Velo Bling-Bling with an USB cable to the PC:
   * [[http://www.putty.org/][PuTTY]] (Windows and Linux)
   * [[http://en.sourceforge.jp/projects/ttssh2/][Tera Term]] (Windows)
   * [[http://realterm.sourceforge.net/][Realterm]] (Windows)
   * minicom (Linux)
You have to install a driver for Windows. The device name is =Virtual Com Port=, the appropriate INF file (Setup Information file) is [[%ATTACHURLPATH%/fsl_ucwxp.inf][fsl_ucwxp.inf]].

After the connector is plugged in, LED LD14 goes on (green or yellow). Additionally a LED from LD1 to LD13 goes on, these LEDs show the battery level, LD1 (red) is lowest, LD13 (green) is highest (battery fully charged). If you push the ESC key now, the LEDs go off and similar text is showed:
<verbatim>
Euler Wheel 32, Velo Bling Bling                                                                                  
--------------------------------                                                                                  

Version 4.2rc1, 2016/02/01, Copyright Peter Schmid                                                                

Normal operation mode (automatically), hit ESC for command line interface (interactive mode)                      
Command Line Interface (interactive mode).                                                                        
CLI>  
</verbatim>

---++ Basic Configuration

Hier ein paar Beispiele, wie man das Bling-Bling konfiguriert. Es müssen nur die fett geschriebenen Zeichen eingegeben werden.

Beispiel um den Radumfang einzustellen (Eingabe in Meter, alle Einheiten sind [[http://de.wikipedia.org/wiki/Internationales_Einheitensystem][SI]]):
<pre>
CLI> <b>set circumference 2.130</b>
</pre>
Oder in Kurzschreibweise:
<pre>
CLI> <b>set circ 2.130</b>
</pre>

Vorderrad auswählen
<pre>
CLI> <b>set wheel front</b>
</pre>

Soll die Konfiguration dauerhaft abgespeichert werden, d.h. auch nach einem Akkuwechsel oder wenn der Akku voll entladen wurde.:
<pre>
CLI> <b>save</b>
</pre>

Die obere Anzeige wird =upper= die untere =lower= genannt. Den Teil zwischen =upper= und =lower= nenne ich =bling=. Im =bling= Teil werden die Bilder wiederholt, wenn eine Anzeige ausgeschaltet ist (=blank=), dann wird dort auch das Bling-Muster wiederholt.  Will man in der Anzeige den String (Text) =Hallo Velo!= ausgeben, so geht man folgendermassen vor (bitte beachten! für Leerzeichen gibt man _ ein):
<pre>
CLI> <b>set string lower Hallo_Velo!</b>
CLI> <b>set lower string</b>
</pre>

---++ Images
Man kann auch Bilder mit der Escape-Sequenz =\i&#60;nn&#62;= in den String einfügen, z.B. die Schweizer Flagge mit =\i00=. Weitere Escape-Sequenzen: 
<verbatim>
 *  	_      Space
 *  	\_     _
 *  	\\     \
 *  	\i<nn> image number 00..49
 *  	\f<nn> font         00..04
 *  	\c<nn> color 00..07 
 *  	\s<nn> space in columns
</verbatim>

Die Farbe des Strings setzt man mit:
<pre>
CLI> <b>set color lower green</b>
</pre>
Farben:
<pre>
red|green|yellow|blue|magenta|cyan|white
rd|gn|yl|bl|ma|cy|wt
</pre>

Momentan sind nur wenige Bilder abgespeichert (hauptsächlich Nationalflaggen). Insgesamt hat es im Speicher Platz für 50 Bilder. Bilder können auch heraufgeladen werden. Beispiel um Bild 21 auf der unteren Anzeige auszugeben:
<pre>
CLI> <b>set image lower 21</b>
CLI> <b>set lower img</b>
</pre>
Hier die Liste der momentan verfügbaren Bilder:
<verbatim> 
0:  Switzerland
1:  Germany
2:  Austria
3:  Italy
4:  France
5:  Belgium
6:  Spain
10: heart
11: snow
20: Germany spyr.ch Switzerland
21: countries Austria Italy France Belgium
22: countries Switzerland Italy France Germany 
23: countries Germany Switzerland Italy
24: veloblingbling
</verbatim>

Will man die Schweizer Flagge als Bling ausgeben:
<pre>
CLI> <b>set bling img</b>
CLI> <b>set image bling 0</b>
</pre>

Die Seite (surface) mit dem Drucktaster heisst =top=, die andere =bottom=. Die Befehle wie =set lower image= beziehen sich auf die augenblicklich eingestellte Seite. Die Seite wählt man aus mit:
<pre>
CLI> <b>set surface bottom</b>
</pre>

Die wichtigsten Konfigurationen (die Infos beziehen sich auf die eingestellt Seite, in diesem Beispiel auf =top=) ausgeben:
<pre>
CLI> <b>show all</b>                                                                                                    
surface top                                                                                                       
upper currentspeed                                                                                                
lower image                                                                                                       
bling blank                                                                                                       
string upper GNU/Linux                                                                                            
string lower spyr.ch                                                                                              
color upper green                                                                                                 
color lower red                                                                                                   
image upper 20
image lower 24
image bling 0
currentspeed 0.0 m/s
maximumspeed 0.0 m/s
averagespeed 0.0 m/s
tripdistance 0.0 m
totaldistance 0.0 m
currentaltitude 361 m
tripaltitude 0 m
totalaltitude 0 m
incline 0 %
altimeteroffset 0 m
temperature 22.4 °C
pedalingcadence 0 /Min
triptime 1 s
totaltime 0 s
chronotime 0 s
circumference 2.11 m
stretch 1.0 
logintervall 60 s
battery 4.29 V
acceleration -0.92 -0.61 9.66 m/s^2, Orientation 198
trip stopped
chrono stopped
unit metric
side left
wheel rear
20150327190034
</pre>

---++ Overview Commands 
Übersicht Befehle:
<verbatim>
show     all
set      upper|lower speed|max|avg|trip|tot|alt|inc|temp|cad|watch|time|stop|string|blk|img|light
set      bling blk|img
show     currentspeed|speed   <float>            [m/s]
show     maximumspeed|max     <float>            [m/s]
show     averagespeed|avg     <float>            [m/s]
show     tripdistance|trip    <float>            [m]
show|set totaldistance|tot    <float>            [m]
show     currentaltitude|alt  <float>            [m]
show     tripelevationgain|gain <float>          [m]
show|set totalelevationgain|totgain <float>      [m]
set      altimeteroffset|alti <float>            [m]
show     incline|inc          <float>            [%]
show     temperature|temp     <float>            [°C]
show     pedalingcadence|cad  <float>            [/Min]
      
show|set currenttime|watch    yyyymmddhhmmss
show     triptime|time        <float>            [s]
show|set totaltime|tottime    <float>            [s]
show     chronotime|chrono    <float>            [s]
     
show     datalog
      
show|set circumference|circ   <float>            [m]
show|set unit                 imperial|metric 
show|set stretch              <float>
show|set side                 left|right      
show|set wheel                front|rear
show|set logintervall|log     <float>            [s]
show|set delay                <float>            [°]
show|set surface              top|bottom
      
show|set upper|lower          speed|max|avg|trip|tot|alt|inc|temp|cad|watch|time|stop|str|blk|img|light
show|set bling                str|blk|img
	
show|set color upper|lower    rd|gn|yl|bl|ma|cy|wt
		
show|set pattern              number           [0..49]
rrrrrrrrrrrr    
rrrrrwwrrrrr    
rrrrrwwrrrrr         
rrwwwwwwwwrr    
rrwwwwwwwwrr    
rrrrrwwrrrrr    
rrrrrwwrrrrr    
rrrrrrrrrrrr    
	.
show|set string upper|lower   anystring
show|set image upper|lower|bling number

set script                    number
commands..
;

show script                   number
script start|test             number
script stop
     
trip start|stop|pause|resume
    
test
about
help
reset
exit
</verbatim>

---++ Fonts
Das Display ist 100x16 Pixel gross. Im Beispiel unten ist die =12= in 8x12 Font, der =:= ist in 5x12 und das "A" in 12x16 Font. 
<verbatim>
        0 1 2 3 4 5 6 7 8 9 A B C D E F101122131415161718191A1B1C1D1E1F2021..
F 8000 --------------------------------------------         XXXX 
E 4000 --------------------------------------------         XXXX
D 2000 --------------------------------------------       XXXXXXXX
C 1000 --------------------------------------------       XXXXXXXX
B 0800                                                    XXXXXXXX
A 0400     XX           XXXXXXXX                        XXXXXXXXXXXX
9 0200   XXXX         XXXX    XXXX                      XXXX    XXXX
8 0100 XXXXXX         XXXX    XXXX                      XXXX    XXXX
7 0080     XX                 XXXX        XXXX        XXXX        XXXX
6 0040     XX               XXXX          XXXX        XXXXXXXXXXXXXXXX
5 0020     XX             XXXX                        XXXXXXXXXXXXXXXX
4 0010     XX           XXXX                        XXXX            XXXX
3 0008     XX         XXXX    XXXX        XXXX      XXXX            XXXX
2 0004 XXXXXXXXXXX----XXXXXXXXXXXX----    XXXX----  XXXX            XXXX--
1 0002                  
0 0001                   
</verbatim>
Es sind 20 Zeichen in 5x12, 14 Zeichen in 7x12, 12 Zeichen in 8x12 und 8 Zeichen in 12x16 Font darstellbar. Die verfügbaren Fonts sind 5x12 (00), 6x8 (01), 7x12 (02), 7x12b (03), 8x12 (04) und 12x16 (05). Der Default-Font ist 7x12b. Font ist innerhalb des Strings mit =\f&#60;nn&#62;= änderbar, z.B. =\f00= für den kleinsten Font.

---++ Scripts
Very simple script interpreter. Every line is interpreted by
CLI except lines beginning with : (colon) or ; (semicolon). After
reading a semicolon the script restarts from the beginning.
A line has to be <= 80 chars long.
 
The script buffer is 800 bytes and shares the same memory for the
images (dotmatrix). That means one buffer has room for about 50
command lines. If that is not enough then you can start another
script buffer within the script.
 
---+++ Special Commands
<pre>
:wait n
</pre>
waits n seconds

<pre>
:exit
</pre>
aborts script

<pre>
;
</pre>
script end, restart script from beginning

---+++ Sample
<pre>
CLI> <b>set script 40
set string upper Hallo
set string lower Velo
set upper string
set lower string
:wait 10
set upper speed
set lower trip
:wait 10
;</b>
CLI> <b>show script 40</b>
set string upper Hallo
set string lower Velo
set upper string
set lower string
:wait 10
set upper speed
set lower trip
:wait 10
;
CLI> <b>script start 40</b>
CLI> <b>script stop</b>
script stopped
</pre>

-- %USERSIG{PeterSchmid - 2016-10-26}%

---++ Comments

%COMMENT%
This topic: Velo > WebHome > EWheelEn > UserManual > ManualWoFrames
Topic revision: r1 - 2016-10-26 - PeterSchmid