search

bauland / TinyClrLib

Library to centralize use of modules in TinyClr
Apache License 2.0
1 stars 1 forks source link

MotorDriverL298 XML Documentation #2

Open networkfusion opened 5 years ago

networkfusion commented 5 years ago

The initializer XML doc for the driver is wrong.

It should be:

        /// <summary>
        /// Constructor of MotorDriverL298
        /// </summary>
        /// <param name="pinDir1">pin of direction for Motor 1, pin 6 of P Socket</param>
        /// <param name="pinDir2">pin of direction for Motor 2, pin 9 of P Socket</param>
        /// <param name="pinPwm1">pin of Pwm for Motor 1, pin 8 of P Socket</param>
        /// <param name="pinPwm2">pin of Pwm for Motor 2, pin 7 of P Socket</param>
        /// <param name="idPwmController1">id of Pwm for Motor 1</param>
        /// <param name="idPwmController2">id of Pwm for Motor 2</param>

At least, going by the original .netmf 4.3 driver source.

Tested on a FezSpiderII using the following code:

            var motorDriver = new MotorDriverL298(
                FEZSpiderII.GpioPin.Socket11.Pin6,
                FEZSpiderII.GpioPin.Socket11.Pin9,
                FEZSpiderII.PwmChannel.Controller0.Socket11.Pin8,
                FEZSpiderII.PwmChannel.Controller1.Socket11.Pin7,
                FEZSpiderII.PwmChannel.Controller0.Id,
                FEZSpiderII.PwmChannel.Controller1.Id
                );
bauland commented 5 years ago

And this is from GHI docs: Pin 6: Motor A Direction (GPIO) Pin 7: Motor A Speed (PWM) Pin 8: Motor B Direction (GPIO) Pin 9: Motor B Speed (PWM)

It need to be cleaned Indeed 👍