Public Member Functions | Private Attributes | List of all members
ArduinoComms Class Reference

#include <arduino_comms.h>

Public Member Functions

 ArduinoComms (const std::string &serial_device, int32_t baud_rate, int32_t timeout_ms)
 
bool connected () const
 
void readEncoderValues (int &val_1, int &val_2)
 
void sendEmptyMsg ()
 
std::string sendMsg (const std::string &msg_to_send, bool print_output=false)
 
void setMotorValues (int val_1, int val_2)
 
void setPidValues (float k_p, float k_d, float k_i, float k_o)
 

Private Attributes

serial::Serial serial_conn_
 Underlying serial connection. More...
 

Detailed Description

Definition at line 7 of file arduino_comms.h.

Constructor & Destructor Documentation

◆ ArduinoComms()

ArduinoComms::ArduinoComms ( const std::string &  serial_device,
int32_t  baud_rate,
int32_t  timeout_ms 
)
inline

Definition at line 12 of file arduino_comms.h.

Member Function Documentation

◆ connected()

bool ArduinoComms::connected ( ) const
inline

Definition at line 22 of file arduino_comms.h.

◆ readEncoderValues()

void ArduinoComms::readEncoderValues ( int &  val_1,
int &  val_2 
)

Definition at line 11 of file arduino_comms.cpp.

◆ sendEmptyMsg()

void ArduinoComms::sendEmptyMsg ( )

Definition at line 6 of file arduino_comms.cpp.

◆ sendMsg()

std::string ArduinoComms::sendMsg ( const std::string &  msg_to_send,
bool  print_output = false 
)

Definition at line 38 of file arduino_comms.cpp.

◆ setMotorValues()

void ArduinoComms::setMotorValues ( int  val_1,
int  val_2 
)

Definition at line 24 of file arduino_comms.cpp.

◆ setPidValues()

void ArduinoComms::setPidValues ( float  k_p,
float  k_d,
float  k_i,
float  k_o 
)

Definition at line 31 of file arduino_comms.cpp.

Member Data Documentation

◆ serial_conn_

serial::Serial ArduinoComms::serial_conn_
private

Underlying serial connection.

Definition at line 28 of file arduino_comms.h.


The documentation for this class was generated from the following files:


diffdrive_arduino
Author(s): Josh Newans
autogenerated on Mon Feb 28 2022 22:13:39