Recent changes to Arduino Library

WikiPage Arduino Library modified by Majenko Technologies

Majenko Technologies — Tue, 06 Nov 2012 12:05:15 -0000

--- v10
+++ v11
@@ -56,4 +56,4 @@
 Examples
 ========
 
-There are a number of [examples] you can use to help get you going.
+There are a number of [Examples] you can use to help get you going.

WikiPage Arduino Library modified by Majenko Technologies

Majenko Technologies — Tue, 06 Nov 2012 12:01:45 -0000

--- v9
+++ v10
@@ -52,3 +52,8 @@
 There are a few system management and control related functions which don't really fit into any of the other sections.  These are:
 
 * [led]
+
+Examples
+========
+
+There are a number of [examples] you can use to help get you going.

WikiPage Arduino Library modified by Majenko Technologies

Majenko Technologies — Tue, 06 Nov 2012 11:58:00 -0000

--- v8
+++ v9
@@ -46,35 +46,9 @@
 * [utftochar]
 * [chartoutf]
 
-    strlen(utf16);
-
-Returns the number of characters in a UTF16 string.
-
-    utftochar(utf16,char);
-
-Convert a UTF16 string into a char * string.
-
-    chartoutf(char,utf16);
-
-Convert a char * string into a UTF16 string.
-
 Other Functions
 ===============
 
-    WavePro.led(mode);
+There are a few system management and control related functions which don't really fit into any of the other sections.  These are:
 
-Change the mode of LED operation. "mode" is one of:
-
-    LED_NORMAL
-
-Green LED = disk activity, yellow = recording, yellow = SPI activity, and red is not assigned yet.
-
-    LED_VU
-
-Simple 4-bit VU meter of the playing sound.
-
-    LED_SPECTRUM
-
-This is the clever one. A spectrum analyser display (4 bit of course) of the playing audio. This uses the dsPIC's DSP to do a full FFT of the current block of audio being loaded into the DMA buffers on the fly, and lights the LEDs depending on various threshold levels.
-
-Caution should be used with the SPECTRUM mode, as it is quite processor intensive (as you can imagine) even with the DSP. It's quite amazing that it can do an entire FFT of the audio block realtime whilst loading up the DMA buffers, and tweaking the volume, etc. Using SPECTRUM mode with high bitrate samples might well take too long to calculate and cause pops, skips, and even strange robotic sounding effects as the calculations overflow the alotted time and the DMA buffers don't get filled up in time.
+* [led]

WikiPage Arduino Library modified by Majenko Technologies

Majenko Technologies — Tue, 06 Nov 2012 11:52:11 -0000

--- v7
+++ v8
@@ -36,20 +36,15 @@
 * [findNext]
 * [getUTF]
 
-    WavePro.findFirst(pattern,buf);
-
-Find the first file in the current directory which matches pattern.  Result is returned into buffer pointed to by buf.  Returns SPR_OK on success, or SPR_ECMDFAIL on failure.
-
-    WavePro.findNext(buf);
-
-Find the next file in the sequence started by a previous findFirst.  Result is returned into buffer pointed to by buf.  Returns SPR_OK on success, or SPR_ECMDFAIL on failure.
-
-    WavePro.getUTF(filename,utfname);
-
-Get the full UTF16 name of the specified file.  utfname is an array of 16-bit values (unsigned short *).
 
 Utility Functions
 =================
+
+There are a collection of useful utility functions provided with the library.  These are mainly to facilitate the handling of UTF16 filenames.
+
+* [strlen]
+* [utftochar]
+* [chartoutf]
 
     strlen(utf16);

WikiPage Arduino Library modified by Majenko Technologies

Majenko Technologies — Tue, 06 Nov 2012 11:47:04 -0000

--- v6
+++ v7
@@ -25,19 +25,16 @@
 * [subscribe]
 * [unsubscribe]
 
-    WavePro.subscribe(event);
-
-Subscribe to an event
-
-    WavePro.unsubscribe(event);
-
-Unsubscribe from an event.
-
-Events are:
-
-
 Filesystem Functions
 ====================
+
+You can directly interact with the filesystem on the SD card.  At this time only directory enquiry functions are supported, but it is planned to have full file I/O in a future release.
+
+Current filesystem functions are:
+
+* [findFirst]
+* [findNext]
+* [getUTF]
 
     WavePro.findFirst(pattern,buf);

WikiPage Arduino Library modified by Majenko Technologies

Majenko Technologies — Tue, 06 Nov 2012 11:38:42 -0000

--- v5
+++ v6
@@ -22,6 +22,9 @@
 
 Notification consists of a logic HIGH pulse on pin 22 of the dsPIC chip when an event that you are subscribed to occurs.
 
+* [subscribe]
+* [unsubscribe]
+
     WavePro.subscribe(event);
 
 Subscribe to an event
@@ -32,10 +35,6 @@
 
 Events are:
 
-    SUB_PLAY - A sample has started playing
-    SUB_LOOP - A sample has looped
-    SUB_STOP - A sample has finished playing
-    SUB_QUEUE - A sample has started playing from the queue and the queue has shifted down one.
 
 Filesystem Functions
 ====================

WikiPage Arduino Library modified by Majenko Technologies

Majenko Technologies — Tue, 06 Nov 2012 11:28:32 -0000

--- v4
+++ v5
@@ -1,5 +1,10 @@
 Audio functions
 ===============
+
+Playing audio files with the WavePro Shield is a very simple job.  In many cases you can achieve your aims with a single function call.
+
+Current supported audio function are:
+
 * [boost]
 * [pause]
 * [play]
@@ -11,69 +16,6 @@
 * [seekf]
 * [stop]
 * [volume]
-
-    WavePro.play(filename);
-
-Play the file specified by the 8.3 format filename.
-
-    WavePro.play_loop(filename);
-
-Play the file specified by the 8.3 format filename in a continuous loop.
-
-    WavePro.stop();
-
-Stop any playback or recording.
-
-    WavePro.record(format,filename);
-
-Start recording to the 8.3 format filename in the format specified.  The format is a combination of the following flags (OR'd together with |):
-
-* REC_8000
-* REC_11025
-* REC_16000
-* REC_22050
-* REC_24000
-* REC_32000
-* REC_44100
-* REC_48000
-* REC_MONO
-* REC_STEREO
-
-For example: WavePro.record(REC_STEREO | REC_22050, "myrec.wav");
-
-    WavePro.queue(filename);
-
-Add the specified file to the playback queue.  If nothing is playing, playback starts immediately.  Returns TRUE on success, or FALSE if the queue is full.
-
-    WavePro.volume(vol);
-    WavePro.volume(left,right);
-
-Set the playback volume to the specified level - value of the volume is between 0 (silent) and 255 (full volume).  Specifying 2 numbers sets the left and right channels individually.
-
-    WavePro.boost(amp);
-    WavePro.boost(left,right);
-
-Set the playback boost (amplification) to the specified level - value of the boost is between 0 (normal) and 255 (full amplification).  Specifying 2 numbers sets the left and right channels individually.  Setting the boost too high can results in distortion of the playback.
-
-    WavePro.playing();
-
-Returns TRUE if the WavePro shield is playing a sample, or FALSE if it is idle.
-
-    WavePro.playing(posinfo);
-
-Returns TRUE if the WavePro shield is playing a sample, or FALSE if it is idle.  Also returns the current playback status into the "struct posinfo" variable pointed to by posinfo.
-
-    WavePro.seekf(seconds);
-
-Seek forwards a number of seconds (0 to 255).
-
-    WavePro.seekb(seconds);
-
-Seek backwards a number of seconds (0 to 255).
-
-    WavePro.pause();
-
-Pause or resume the playback of the current sample.
 
 Notification Functions
 ======================

WikiPage Arduino Library modified by Majenko Technologies

Majenko Technologies — Tue, 06 Nov 2012 10:24:52 -0000

--- v3
+++ v4
@@ -1,5 +1,16 @@
 Audio functions
 ===============
+* [boost]
+* [pause]
+* [play]
+* [play_loop]
+* [playing]
+* [queue]
+* [record]
+* [seekb]
+* [seekf]
+* [stop]
+* [volume]
 
     WavePro.play(filename);

WikiPage Arduino Library modified by Majenko Technologies

Majenko Technologies — Sun, 04 Nov 2012 15:49:31 -0000

--- v2
+++ v3
@@ -114,3 +114,23 @@
 
 Convert a char * string into a UTF16 string.
 
+Other Functions
+===============
+
+    WavePro.led(mode);
+
+Change the mode of LED operation. "mode" is one of:
+
+    LED_NORMAL
+
+Green LED = disk activity, yellow = recording, yellow = SPI activity, and red is not assigned yet.
+
+    LED_VU
+
+Simple 4-bit VU meter of the playing sound.
+
+    LED_SPECTRUM
+
+This is the clever one. A spectrum analyser display (4 bit of course) of the playing audio. This uses the dsPIC's DSP to do a full FFT of the current block of audio being loaded into the DMA buffers on the fly, and lights the LEDs depending on various threshold levels.
+
+Caution should be used with the SPECTRUM mode, as it is quite processor intensive (as you can imagine) even with the DSP. It's quite amazing that it can do an entire FFT of the audio block realtime whilst loading up the DMA buffers, and tweaking the volume, etc. Using SPECTRUM mode with high bitrate samples might well take too long to calculate and cause pops, skips, and even strange robotic sounding effects as the calculations overflow the alotted time and the DMA buffers don't get filled up in time.

WikiPage Arduino Library modified by Majenko Technologies

Majenko Technologies — Fri, 02 Nov 2012 10:34:46 -0000

--- v1
+++ v2
@@ -35,8 +35,14 @@
 Add the specified file to the playback queue.  If nothing is playing, playback starts immediately.  Returns TRUE on success, or FALSE if the queue is full.
 
     WavePro.volume(vol);
+    WavePro.volume(left,right);
 
-Set the playback volume to the specified level - value of the volume is between 0 (silent) and 255 (full volume).
+Set the playback volume to the specified level - value of the volume is between 0 (silent) and 255 (full volume).  Specifying 2 numbers sets the left and right channels individually.
+
+    WavePro.boost(amp);
+    WavePro.boost(left,right);
+
+Set the playback boost (amplification) to the specified level - value of the boost is between 0 (normal) and 255 (full amplification).  Specifying 2 numbers sets the left and right channels individually.  Setting the boost too high can results in distortion of the playback.
 
     WavePro.playing();
 
@@ -57,6 +63,26 @@
     WavePro.pause();
 
 Pause or resume the playback of the current sample.
+
+Notification Functions
+======================
+
+Notification consists of a logic HIGH pulse on pin 22 of the dsPIC chip when an event that you are subscribed to occurs.
+
+    WavePro.subscribe(event);
+
+Subscribe to an event
+
+    WavePro.unsubscribe(event);
+
+Unsubscribe from an event.
+
+Events are:
+
+    SUB_PLAY - A sample has started playing
+    SUB_LOOP - A sample has looped
+    SUB_STOP - A sample has finished playing
+    SUB_QUEUE - A sample has started playing from the queue and the queue has shifted down one.
 
 Filesystem Functions
 ====================