Commit 78d57a59620cfa952f93163af28250924bb78efa

Authored by Arnaud Blanchard
1 parent aa78cf97

Update README.md

Showing 1 changed file with 24 additions and 11 deletions
@@ -3,7 +3,19 @@ Set of programs to manipulate data in blc_channels. They do not have any lib dep @@ -3,7 +3,19 @@ Set of programs to manipulate data in blc_channels. They do not have any lib dep
3 Acquire input values 3 Acquire input values
4 ==================== 4 ====================
5 5
6 -From keyboard 6 +from files
  7 +----------
  8 +
  9 + `i_fread <filename.tsv>`
  10 +
  11 +Read a line of data from the file in tsv (i.e. '0.3 0.55 0.56 ' is a vector of 3 values) and creates a channel (a vector) containing these data.
  12 +If there are many lines, it updates the data as fast as possible with each time.
  13 +It is very fast you can be either be synchronized or using -p to requiert a minimal time between each update.
  14 +You can also use a first column describing the time in µs to read the line.
  15 +Finaly you can limit the number of line read by using -n.
  16 +
  17 +
  18 +from keyboard
7 ------------- 19 -------------
8 20
9 `i_keyboard` changes values with the keyboard arrows or specific keys: 21 `i_keyboard` changes values with the keyboard arrows or specific keys:
@@ -30,20 +42,21 @@ Creates a channel '/toto' of 4 float values between 0 and 1 and display the pour @@ -30,20 +42,21 @@ Creates a channel '/toto' of 4 float values between 0 and 1 and display the pour
30 42
31 We see the initial values are set to 49% (i.e. 0.5) and we can chenge them with the arrow. 43 We see the initial values are set to 49% (i.e. 0.5) and we can chenge them with the arrow.
32 You could change the initial value by changing the neutral value (-N). 44 You could change the initial value by changing the neutral value (-N).
33 -You can change the min and max with -m and -M. The default step of one keypressed in 0.004 (~1/256) or 1 with UIN8 type. It can be chenged with -S. 45 +You can change the min and max with -m and -M. The default step of one keypressed in 0.004 (~1/256) or 1 with UIN8 type.
  46 +It can be changed with -S.
34 47
35 -Sometime you do not want intermediate values but only toggle to max and min then use -T. 48 +Sometime you do not want intermediate values but only toggle to max and min. Then use -T.
36 49
37 -From files  
38 ----------- 50 +from oscillator
  51 +---------------
39 52
40 - `i_fread <filename.tsv>` 53 + `i_oscillator -o/toto`
41 54
42 -Read a line of data from the file in tsv (i.e. '0.3 0.55 0.56 ' is a vector of 3 values) and creates a channel (a vector) containing these data.  
43 -If there are many lines, it updates the data as fast as possible with each time.  
44 -It is very fast you can be either be synchronized or using -p to requiert a minimal time between each update.  
45 -You can also use a first column describing the time in µs to read the line.  
46 -Finaly you can limit the number of line read by using -n. 55 +Generates sinusoidale oscillations and put it in the channel /toto.
  56 +You can specify the frequency with -f and the refresh rate with -r.
  57 +The refresh rate defines how often you will update the value of the oscillator but will not change the frequency.
  58 +
  59 +You can use a buffer to keep the historic of the oscillation.
47 60
48 61
49 Generate outputs 62 Generate outputs