added a basic main page

Author: shashankmarch27

Docs/index.md

@@ -0,0 +1,100 @@
+@mainpage
+DriveMaster is a common library designed to simplify the implementation of RC protocol decoding in Arduino projects. It provides a modular and extensible architecture that allows for easy integration of various RC protocols.
+
+# Supported Protocol
+
+- [DShot300](#dshot300)
+- [DShot600](#dshot600)
+
+## DShot300 {#dshot300}
+
+### Configuration
+
+- Baud rate: 100000
+- Data bits: 8 Bits
+- Parity: Even Parity
+- Stop bits: 2 Stop bits
+- Signal polarity: Inverted
+
+## DShot600 {#dshot600}
+
+### Configuration
+
+- Baud rate: 420000
+- Data bits: 8 Bits
+- Parity: No Parity
+- Stop bits: 1 Stop bits
+- Signal polarity: Uninverted
+
+# Getting Started
+- [Installation](#installation)
+- [Tutorial](#tutorial)
+- [Examples](#example)
+
+# Installation {#installation}
+
+## Arduino Installation
+
+To use the DriveMaster library in your Arduino projects, follow these installation steps:
+
+1. Download the DriveMaster library from the [GitHub repository](https://github.com/Witty-Wizard/DriveMaster).
+2. Extract the downloaded ZIP file.
+3. Copy the extracted folder to the `libraries` directory in your Arduino sketchbook.
+4. Restart the Arduino IDE.
+5. You should now be able to include the DriveMaster library in your Arduino sketches.
+
+## PlatformIO Installation
+
+If you are using PlatformIO, you can install the DriveMaster library directly from the PlatformIO Library Manager. Add the following line to your `platformio.ini` file:
+
+```ini
+lib_deps = Witty-Wizard/DriveMaster @ ^0.1.0
+```
+# Tutorial {#tutorial}
+
+## Using DriveMaster Library for Motor Control
+
+To control motors in your Arduino project using the DriveMaster library, follow these steps:
+
+1. **Include Necessary Libraries**
+
+Include the required library at the beginning of your sketch:
+```cpp
+#include <DriveMaster.h>
+```
+
+2. **Instantiate DriveMaster Object**
+Create an instance of the DriveMaster class, specifying the pin connected to the motor:
+
+```cpp
+Copy code
+DriveMaster *motor = new DriveMaster(motorPin);
+```
+
+3. **Initialize Motor Control**
+Call the begin() method to initialize motor control:
+
+```cpp
+void setup() {
+    motor->begin();
+}
+```
+
+5. **Send Commands or Values**
+You can use the sendCommand() or sendValue() methods to send specific commands or values to the motor:
+
+```cpp
+// Send a specific command to the motor
+motor->sendCommand(1000);
+
+// Send a value directly to the motor
+motor->sendValue(512);
+```
+
+# Examples {#example}
+
+## DShot Example
+@include "../examples/basic_dshot/basic_dshot.ino"
+
+# License
+This library is distributed under the GNU [General Public License version 3.0](https://www.gnu.org/licenses/gpl-3.0.html).

examples/basic_dshot/basic_dshot.ino

@@ -0,0 +1,19 @@
+/*!
+ * @file basic_dshot.ino
+ */
+#include <DriveMaster.h>
+
+#define MOTOR_PIN 9
+
+DriveMaster *motor;
+
+void setup() {
+  motor = new DriveMaster(MOTOR_PIN);
+  motor->begin();
+}
+
+void loop() {
+  // Example: Set motor speed to 50% duty cycle
+  motor->sendValue(512);
+  delay(1000); // Delay for 1 second
+}

src/DriveMaster.h

@@ -1,20 +1,51 @@
+/**
+ * @file DriveMaster.h
+ * @brief Header file for the DriveMaster class.
+ */
+
 #pragma once
 #ifndef DRIVEMASTER_H
 #define DRIVEMASTER_H
 
 #include <Arduino.h>
 
+/**
+ * @brief Base class for motor control.
+ */
 class DriveMaster {
 public:
+  /**
+   * @brief Construct a new DriveMaster object with the specified pin.
+   * @param pin The pin number for motor control.
+   */
   DriveMaster(int pin);
+  /**
+   * @brief Destroy the DriveMaster object.
+   */
   virtual ~DriveMaster();
+  /**
+   * @brief Initialize the motor control.
+   */
   virtual void begin();
+  /**
+   * @brief Write a command to the motor.
+   * @param value The command value to write.
+   * @param telemetry Flag indicating telemetry presence.
+   */
   virtual void write(uint16_t value, bool telemetery = false);
+  /**
+   * @brief Send a command to the motor.
+   * @param value The command value to send.
+   */
   virtual void sendCommand(uint16_t value);
+  /**
+   * @brief Send a value to the motor.
+   * @param value The value to send.
+   */
   virtual void sendValue(uint16_t value);
 
 protected:
-  int _pin;
+  int _pin; /**< Pin number for motor control. */
 };
 #include "dshot.h"
 #endif

src/dshot.h

@@ -1,3 +1,8 @@
+/**
+ * @file dshot.h
+ * @brief Header file for the dshot class.
+ */
+
 #pragma once
 #ifndef DSHOT_H
 #define DSHOT_H
@@ -6,24 +11,62 @@
 #include <esp32-hal-rmt.h>
 #define DSHOT_FRAME_LENGTH 16
 
-enum DShotType { DSHOT_150, DSHOT_300 };
+/**
+ * @brief Enumeration for different DShot types.
+ */
+enum DShotType {
+  DSHOT_150, /**< DShot150 protocol */
+  DSHOT_300  /**< DShot300 protocol */
+};
 
+/**
+ * @brief Class representing DShot communication.
+ */
 class dshot : public DriveMaster {
 private:
-  rmt_obj_t *_channel = nullptr;
-  rmt_data_t _data[DSHOT_FRAME_LENGTH];
-  uint16_t _timingDuration0;
-  uint16_t _timingDuration1;
-  uint16_t _timingDurationBit;
+  rmt_obj_t *_channel = nullptr; /**< RMT channel for DShot communication */
+  rmt_data_t _data[DSHOT_FRAME_LENGTH]; /**< RMT data array for DShot frames */
+  uint16_t _timingDuration0;            /**< Timing duration for logic 0 */
+  uint16_t _timingDuration1;            /**< Timing duration for logic 1 */
+  uint16_t _timingDurationBit;          /**< Timing duration for a bit */
+  /**
+   * @brief Calculate the CRC (Cyclic Redundancy Check) for the given DShot
+   * command value.
+   * @param value DShot command value
+   * @return Calculated CRC value
+   */
   uint8_t calculateCrc(uint16_t value);
+  /**
+   * @brief Write a DShot frame with the specified value and telemetry flag.
+   * @param value DShot value to write
+   * @param telemetry Flag indicating telemetry presence
+   */
   void write(uint16_t value, bool telemetery = false);
 
 public:
+  /**
+   * @brief Construct a new dshot object with the specified pin and DShot type.
+   * @param pin Pin to use for DShot communication
+   * @param type DShot protocol type (DSHOT_150 or DSHOT_300)
+   */
   explicit dshot(int pin, DShotType type = DSHOT_300);
+  /**
+   * @brief Destroy the dshot object.
+   */
   ~dshot();
-
+  /**
+   * @brief Initialize the DShot communication.
+   */
   void begin() override;
+  /**
+   * @brief Send a DShot command with telemetry enabled.
+   * @param value DShot command value
+   */
   void sendCommand(uint16_t value) override;
+  /**
+   * @brief Send a DShot value with telemetry disabled.
+   * @param value DShot value to send
+   */
   void sendValue(uint16_t value) override;
 };