Mitchell Hatfield / BridgeDriver2

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.

Fork of BridgeDriver by Jason T

Files at this revision

API Documentation at this revision

Revision 11:2481432a0988, committed 2014-07-30

Comitter:
jason701802
Date:
Wed Jul 30 16:38:46 2014 +0000
Parent:
10:60c3d513b872
Child:
12:4db83c772b51
Commit message:
Improved documentation

Changed in this revision

BridgeDriver.h Show annotated file Show diff for this revision Revisions of this file 
--- a/BridgeDriver.h	Mon Jul 28 21:42:37 2014 +0000
+++ b/BridgeDriver.h	Wed Jul 30 16:38:46 2014 +0000
@@ -30,6 +30,7 @@
     
     public:
         /** Channel pair labels
+         *
          * MOTOR_A - Channel 1 and 2.
          * MOTOR_B - Channel 3 and 4.
          * MOTOR_C - Channel 5 and 6.
@@ -43,6 +44,13 @@
         
         /** Create BridgeDriver object
          *
+         * Enabling PWM for a channel pair links the channels so that they are controlled together. This should be used when connecting a motor between these channels.
+         * Disabling PWM for a channel pair allows individual on/off control for each channel.
+         *
+         * MOTOR_A - Channel 1 and 2.
+         * MOTOR_B - Channel 3 and 4.
+         * MOTOR_C - Channel 5 and 6.
+         * MOTOR_D - Channel 7 and 8.
          * @param *i2c A pointer to the I2C bus that the Enable control and LED port expanders are on.
          * @param enPwmA (Optional) 1 enables PWM on channels 1 and 2 for motor control, 0 disables PWM on channels 1 and 2 for solenoid control. Defaults to 0.
          * @param enPwmB (Optional) 1 enables PWM on channels 3 and 4 for motor control, 0 disables PWM on channels 3 and 4 for solenoid control. Defaults to 0.
@@ -58,6 +66,14 @@
         ~BridgeDriver();
         
         /** Enables/disables PWM for channel pairs
+         *
+         * Enabling PWM for a channel pair links the channels so that they are controlled together. This should be used when connecting a motor between these channels.
+         * Disabling PWM for a channel pair allows individual on/off control for each channel.
+         *
+         * MOTOR_A - Channel 1 and 2.
+         * MOTOR_B - Channel 3 and 4.
+         * MOTOR_C - Channel 5 and 6.
+         * MOTOR_D - Channel 7 and 8.
          * @param enPwmA 1 enables PWM on channels 1 and 2 for motor control, 0 disables PWM on channels 1 and 2 for solenoid control.
          * @param enPwmB 1 enables PWM on channels 3 and 4 for motor control, 0 disables PWM on channels 3 and 4 for solenoid control.
          * @param enPwmC 1 enables PWM on channels 5 and 6 for motor control, 0 disables PWM on channels 5 and 6 for solenoid control.
@@ -66,6 +82,14 @@
         void enablePwm(uint8_t enPwmA, uint8_t enPwmB, uint8_t enPwmC, uint8_t enPwmD);
         
         /** Enables/disables PWM for a given channel pair
+         * 
+         * Enabling PWM for a channel pair links the channels so that they are controlled together. This should be used when connecting a motor between these channels.
+         * Disabling PWM for a channel pair allows individual on/off control for each channel.
+         *
+         * MOTOR_A - Channel 1 and 2.
+         * MOTOR_B - Channel 3 and 4.
+         * MOTOR_C - Channel 5 and 6.
+         * MOTOR_D - Channel 7 and 8.
          * @param motor Motor (channel pair) to enale/disable PWM.
          * @param enPwm 1 enables PWM on channel pair for motor control, 0 disables PWM on channel pair for solenoid control.
          */