Skip to content
This repository has been archived by the owner on Sep 27, 2021. It is now read-only.

Update Udp identifiers, rename hardware and mock filenames/classes, remove filename from @file and add script for it #194

Merged
merged 10 commits into from
Mar 5, 2019
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,10 @@ Including the files in this order helps avoid dependencies being brought in indi

An example:

shapes/circle.cpp
```C++
/**
* @file shapes/circle.cpp
* @file
*/

// The corresponding header file that this source file implements
Expand Down
7 changes: 4 additions & 3 deletions Common/app/PeripheralInstances.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,13 @@


/********************************* Includes **********************************/

#include "PeripheralInstances.h"

#include "HalUartInterface.h"
#include "GpioInterfaceImpl.h"
#include "OsInterfaceImpl.h"
#include "SystemConf.h"
#include "UartInterfaceImpl.h"

#include "usart.h"
#include "gpio.h"
Expand All @@ -26,7 +27,7 @@
using dynamixel::Motor;
using dynamixel::DaisyChain;
using dynamixel::DaisyChainParams;
using hal::HalUartInterface;
using hal::UartInterfaceImpl;
using cmsis::OsInterfaceImpl;
using hal::GpioInterfaceImpl;

Expand All @@ -37,7 +38,7 @@ using hal::GpioInterfaceImpl;
namespace periph{
// Variables
// ----------------------------------------------------------------------------
HalUartInterface uart_if;
UartInterfaceImpl uart_if;
OsInterfaceImpl os_if;
GpioInterfaceImpl gpio_if;

Expand Down
8 changes: 4 additions & 4 deletions Common/app/freertos.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@

/* USER CODE BEGIN Includes */
/**
* @file freertos.c
* @file
* @brief Code for freertos application
* @author Gokul
* @author Tyler
Expand All @@ -76,9 +76,9 @@
#include "rx_helper.h"
#include "tx_helper.h"
#include "UartDriver/UartDriver.h"
#include "HalUartInterface.h"
#include "OsInterfaceImpl.h"
#include "CircularDmaBuffer/CircularDmaBuffer.h"
#include "UartInterfaceImpl.h"
/* USER CODE END Includes */

/* Variables -----------------------------------------------------------------*/
Expand Down Expand Up @@ -151,7 +151,7 @@ namespace{

buffer::BufferMaster buffer_master;
cmsis::OsInterfaceImpl os_if_impl;
hal::HalUartInterface uart_if;
hal::UartInterfaceImpl uart_if;
uart::UartDriver pc_uart_driver(&os_if_impl, &uart_if, UART_HANDLE_PC);

bool setup_is_done = false;
Expand Down Expand Up @@ -406,7 +406,7 @@ void StartCommandTask(void const * argument)
pMotor->setComplianceMargin(1);
}
}

// The only other communication with the motors will occur in the UART
// threads, so we can use DMA now.
periph::initMotorIOType(IO_Type::DMA);
Expand Down
2 changes: 1 addition & 1 deletion Common/app/imu_helper.cpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
*****************************************************************************
* @file imu_helper.cpp
* @file
* @author Tyler Gamvrelis
*
* @addtogroup IMU_Helper IMU Helper
Expand Down
2 changes: 1 addition & 1 deletion Common/app/imu_helper.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
*****************************************************************************
* @file imu_helper.h
* @file
* @author Tyler Gamvrelis
* @brief Helper file for the IMU thread in the main program flow
*
Expand Down
2 changes: 1 addition & 1 deletion Common/app/rx_helper.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
*****************************************************************************
* @file rx_helper.h
* @file
* @author Hannah
* @brief Header for the helper file used to aid StartRXTask() in freertos.cpp
*****************************************************************************
Expand Down
2 changes: 1 addition & 1 deletion Common/app/tx_helper.cpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
*****************************************************************************
* @file tx_helper.c
* @file
* @author Hannah
* @brief Helper file for the function StartTXTask() in freertos.cpp
*****************************************************************************
Expand Down
2 changes: 1 addition & 1 deletion Common/app/tx_helper.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
*****************************************************************************
* @file tx_helper.h
* @file
* @author Hannah
* @brief Header for the helper file used to aid StartTxTask() in freertos.cpp
*****************************************************************************
Expand Down
2 changes: 1 addition & 1 deletion Common/component/UartDriver/UartDriver.cpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
*****************************************************************************
* @file UartDriver.cpp
* @file
* @author Tyler Gamvrelis
*
* @defgroup UartDriver
Expand Down
2 changes: 1 addition & 1 deletion Common/component/UartDriver/UartDriver.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
*****************************************************************************
* @file UartDriver.h
* @file
* @author Tyler Gamvrelis
* @author Robert Fairley
*
Expand Down
Loading