Changeset cb3655b in orbit

Timestamp:

12/04/12 19:47:09 (7 years ago)

Author:

dorabot <dorabot@…>

Branches:

master, RawEEG, Raw_EEG_Plot, Servo, Tab_Interface, pyramid

Children:

f323fb4

Parents:

dccf843

Message:

add comment to script

Location:

octave/GenerateAudioCommand

Files:

• .flyCommand.m.swp (added)
• .flyOrbit.m.swp (added)
• bitGenDirect.m (modified) (1 diff)
• flyCommand.m (modified) (3 diffs)
• flyOrbit.m (modified) (2 diffs)
• halfSineGenDirect.m (modified) (2 diffs)
• initCodeGenAndroid.m (modified) (3 diffs)
• octave-core (added)

octave/GenerateAudioCommand/bitGenDirect.m

@@ -4 +4 @@
 % num: how many certain bit to generate.
 % audioFileName: like 'audio.wav'.
-
+% last four parameter: pass period of sine wave here.
 longHIGH=875;
 longLOW=729;

octave/GenerateAudioCommand/flyCommand.m

@@ -7 +7 @@
 %sps = 96000;     % sample rate [samples/s]
 
+% 4 demo codes here for testing. you can either put a matrix as the first parameter, or just use 'demo1' ~ 'demo4' for testing purpose. 
 if length(code)==5
 if code=='demo1'
-        code=[1 0 1 1 0 1 1 1 0 1 0 0 1 1 0 0 1 0 0 1 1 1 1 1 0 1 1 0];%minimum rotating throttle
+        code=[1 0 1 1 0 1 1 1 0 1 0 0 1 1 0 0 1 0 0 1 1 1 1 1 0 1 1 0];%minimum  throttle to make propeller rotating
 elseif code=='demo2'
         code=[1 1 1 1 1 1 1 1 0 1 0 0 0 1 1 0 1 0 0 1 1 1 1 1 0 0 0 0];%maximum throttle
@@ -50 +51 @@
 elseif length(AndroidOriOS)==7 %'Android'
 
+% number with _s suffix is in samples. Optimized with 44100 sampling rate.
 longHIGH=875;longHIGH_s=floor(longHIGH*sps/1e6)-3;%longHIGH[us]  longHIGH_s[sample]
 longLOW=729;longLOW_s=floor(longLOW*sps/1e6+3)+1;
@@ -55 +57 @@
 shortLOW=333;shortLOW_s=floor(shortLOW*sps/1e6)+1+2;
 
-
 shortLOW_ss=floor(shortLOW*sps/1e6)+2;
 
+
+% PAY ATTENTION to the special starting and ending code of command.
 codeWave=[halfSineGenDirect('d',longLOW_s-1,0,1,sps);halfSineGenDirect('u',longHIGH_s-2,0,1,sps);    halfSineGenDirect('d',shortLOW_ss+2,0,1,sps);halfSineGenDirect('u',longHIGH_s-2,0,1,sps); halfSineGenDirect('d',shortLOW_ss+3,0,1,sps)]; %starting 5 half period
 
 % notice that the "code" here should be a 28 bit binary array.
+% function bitGenDirect will generate a complete digit in the form of sine wave of either "0" or "1"
 for i=1:size(code,2)
 codeWave = [codeWave; bitGenDirect(code(i),1,sps,longHIGH_s,   longLOW_s,shortHIGH_s,shortLOW_s)];
         
 endfor
+
 
 codeWave=[codeWave; halfSineGenDirect('u',longHIGH_s,0,1,sps)];  %last half period

octave/GenerateAudioCommand/flyOrbit.m

@@ -3 +3 @@
 % code: array of 1s and 0s. 1 means bit "1", 0 means bit "0".
 % audioFileName: like 'audio.wav'.
-% space: space between codes [us]
+% space: space between codes [uS]
 bps = 16;       % bits per sample
 %sps = 96000;     % sample rate [samples/s]
-
-space=floor(space*48000/1e6);
+%repeatTime: the number of same commands you want to generate
+%AndroidOriOS: 'Android' 'iOS' generates two different style of codes
+%flipOrNot: 'flip' 'notF' some android device needs a flipped signal.
+space=floor(space*48000/1e6);% turn uS into samples
 
 if length(AndroidOriOS)==3 %iOS
@@ -14 +16 @@
 elseif length(AndroidOriOS)==7 %Android
 
-        if AndroidOriOS=='Android'
-        fullCodeWave=[flyCommand(code,space,'temp1,wav',sps,4,AndroidOriOS,flipOrNot);initCodeGenAndroid('temp2.wav',sps);zeros(1,1);flyCommand(code,space,'temp3.wav',sps,repeatTime,AndroidOriOS,flipOrNot)];
-        elseif AndroidOriOS=='Command'
+        if AndroidOriOS=='Android'%generate android style command with init
+
+%Android style command consists of 4(any number larger than 2) command, init code, and certain repeat of command.
+%function initCodeGenAndroid can generate init
+%function flyCommand can generate command
+        fullCodeWave=[flyCommand(code,space,'temp1.wav',sps,4,AndroidOriOS,flipOrNot);initCodeGenAndroid('temp2.wav',sps);zeros(1,1);flyCommand(code,space,'temp3.wav',sps,repeatTime,AndroidOriOS,flipOrNot)];
+        elseif AndroidOriOS=='Command'%generate command only
         fullCodeWave=[flyCommand(code,space,'temp3.wav',sps,repeatTime,AndroidOriOS,flipOrNot)];
         endif

octave/GenerateAudioCommand/halfSineGenDirect.m

@@ -2 +2 @@
 
 % dir: 'u' means UP, 'd' means down.
-% halfPeriod: half period of cosine signal[us].
+% halfPeriod: half period of sine signal[us].
 % zero: zero level of cosine signal.
 % amp: amplitude of cosine signal, in percentage. 
@@ -13 +13 @@
 freq = floor(sps/(halfPeriod_in_samples*2));       % frequency of the tone [Hz]
 
-
+%linspace is an octave function that generates a sequence with certain step.
 time = linspace(1/sps, halfPeriod, halfPeriod_in_samples);
 if (dir== 'u') 
-        wave = sin(time*2*pi*freq)'.*amp+zero;
+        wave = sin(time*2*pi*freq)'.*amp+zero;%'u' indicates above zero line
 elseif (dir=='d')
-        wave = sin((time+halfPeriod)*2*pi*freq)'.*amp+zero;
+        wave = sin((time+halfPeriod)*2*pi*freq)'.*amp+zero;%'d' indicates below zero line
 endif
 

octave/GenerateAudioCommand/initCodeGenAndroid.m

@@ -6 +6 @@
 bps = 16;       % bits per sample
 
+
+%all numbers start with '_' is measured in uS with audacity.
 _longHIGH=1000; %[us]
 _longLOW=2000; 
@@ -14 +16 @@
 _space=84354;
 
+%turn everything into samples based on sps. Modifyer is optimized when sps=44100Hz
 longHIGH=floor(_longHIGH*sps/1e6)-1;
 longLOW=floor(_longLOW*sps/1e6)+1;
@@ -22 +25 @@
 space=floor(_space*sps/1e6);
 
+%initWave stores the init code we will finnaly generate
+%function halfSineGenDirect can generate the upper or lower half of a sine wave based on how many samples are included in a "half-period" sine wave.
 initWave=[halfSineGenDirect('u',longHIGH,0,1,sps);zeros(longLOW,1);halfSineGenDirect('u',longHIGH,0,1,sps);zeros(longLOW,1);halfSineGenDirect('u',longHIGH,0,1,sps);halfSineGenDirect('d',mediumLOW,0,1,sps);halfSineGenDirect('u',shortHIGH,0,1,sps)];
 
-initWave2=[initWave;halfSineGenDirect('d',shortLOW,0,1,sps)];
-initWave=[initWave;halfSineGenDirect('d',mediumLOW,0,1,sps)];
+initWave2=[initWave;halfSineGenDirect('d',shortLOW,0,1,sps)];%inits 4,5,6
+initWave=[initWave;halfSineGenDirect('d',mediumLOW,0,1,sps)];%inits 1,2,3