gusimplewhiteboard
guWhiteboard::Oculus_PrimeSerialInterface Class Reference

Serial interface for the main oculus prime board. More...

#include <Oculus_PrimeSerialInterface.hpp>

Inheritance diagram for guWhiteboard::Oculus_PrimeSerialInterface:
Collaboration diagram for guWhiteboard::Oculus_PrimeSerialInterface:

Public Member Functions

 Oculus_PrimeSerialInterface ()
 default constructor More...
 
 Oculus_PrimeSerialInterface (const std::string &str)
 string constructor (see from_string() below) More...
 
void from_string (const std::string &str)
 parse class properties from a string More...
 
std::string description () const
 pretty print method for showing the current property values More...
 
- Public Member Functions inherited from wb_oculus_prime_serial
 CONTROLLED_ARRAY_PROPERTY (uint8_t, forward, 2) CONTROLLED_ARRAY_PROPERTY(uint8_t
 speed for each wheel More...
 
 CONTROLLED_ARRAY_PROPERTY (uint8_t, right, 2) CONTROLLED_PROPERTY(uint8_t
 stop More...
 
stop CONTROL_BIT (forward) CONTROL_BIT(left) CONTROL_BIT(right) CONTROL_BIT(stop) wb_oculus_prime_serial()
 < value ignored, mask setting is what's used More...
 

Additional Inherited Members

- Public Attributes inherited from wb_oculus_prime_serial
 left
 

Detailed Description

Serial interface for the main oculus prime board.

Examples

Set the oculus prime motor acceleration

Oculus_PrimeSerialInterface i; 
wb_byte_pair p; p.set_first(15); p.set_second(15);
i.set_forward(p); 
Oculus_PrimeSerialInterface_t.set(i); //Sends the set command via the wb to the oculus prime

Definition at line 38 of file Oculus_PrimeSerialInterface.hpp.

Constructor & Destructor Documentation

◆ Oculus_PrimeSerialInterface() [1/2]

guWhiteboard::Oculus_PrimeSerialInterface::Oculus_PrimeSerialInterface ( )
inline

default constructor

Definition at line 44 of file Oculus_PrimeSerialInterface.hpp.

◆ Oculus_PrimeSerialInterface() [2/2]

guWhiteboard::Oculus_PrimeSerialInterface::Oculus_PrimeSerialInterface ( const std::string &  str)
inline

string constructor (see from_string() below)

Parameters
[in]stra serialised string containing properties to set in this class

Definition at line 50 of file Oculus_PrimeSerialInterface.hpp.

References from_string().

Member Function Documentation

◆ description()

std::string guWhiteboard::Oculus_PrimeSerialInterface::description ( ) const
inline

pretty print method for showing the current property values

Returns
pretty printed string

Definition at line 108 of file Oculus_PrimeSerialInterface.hpp.

◆ from_string()

void guWhiteboard::Oculus_PrimeSerialInterface::from_string ( const std::string &  str)
inline

parse class properties from a string

Parameters
[in]stra serialised string containing properties to set in this class

Definition at line 77 of file Oculus_PrimeSerialInterface.hpp.

References ARRAY_PARSER, DELIMITER, wb_oculus_prime_serial::left, PARSE_UINT8, PARSER, SEP, and SV.

Referenced by Oculus_PrimeSerialInterface().


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