Ries Twisk / Mbed 2 deprecated JoyStick

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   USBDevice mbed-rtos mbed

Fork of JoyStick by Ries Twisk

Diff: AnalogInFiltered.h

Revision:
1:5b2ab44eb31f
Parent:
0:33bc88c4ab31
Child:
2:ae7a31a3c618
--- a/AnalogInFiltered.h	Wed Aug 28 02:33:03 2013 +0000
+++ b/AnalogInFiltered.h	Wed Aug 28 13:12:39 2013 +0000
@@ -4,16 +4,29 @@
 #include "mbed.h"
 #include "AnalogFilterInterface.h"
 
+/**
+Analog input, this reads a analog value from a PIN and send the data through the filterchain
+*/
 class AnalogInFiltered {
     private:
         AnalogIn *_ain;
         long   _lastValue;
         AnalogFilterInterface   *_filter;
     public:   
+        /**
+        filter : Failter chain
+        pin : Analog input to read
+        */
         AnalogInFiltered(AnalogFilterInterface *filter, PinName pin);
         ~AnalogInFiltered();
+        
+        // Read a value from analog in
         void measure ();
+        
+        // Return the filtered value
         long getValue();
+        
+        // Test if the input value is changed based on a offset
         bool getIsChanged(int offSet);
 };