nes::rob::SignalGenerator Class Reference

Generate signals for the R.O.B. protocol. More...

#include <signal_generator.hpp>

Public Member Functions
	SignalGenerator (PulseDriver *driver)
	constructor More...
nes::rob::error_code	init (void *reserved=nullptr)
	Initialize the signal generator. More...
nes::rob::error_code	signal (int sequence) const
	Generate a protocol compatible signal. More...
nes::rob::error_code	testSignal (void) const
	Generate the R.O.B. test signal. More...

Detailed Description

Generate signals for the R.O.B. protocol.

This class will generate the appropriate set of pulses and rests to generate signals from the Nintendo Robotic Operating Buddy protocol.

Constructor & Destructor Documentation

SignalGenerator()

SignalGenerator::SignalGenerator

(

PulseDriver *

driver

)

constructor

Parameters

[in]

driver

A PulseDriver instance

Member Function Documentation

init()

nes::rob::error_code SignalGenerator::init

(

void *

reserved = nullptr

)

Initialize the signal generator.

Performs necessary operations to initialize the signal generator.

Parameters

[in,out]

reserved

Supports driver specific initialization parameters

Returns

an nes::rob::error_code describing errors encountered during processing

Return values

nes::rob::signal_generator_error::success	No errors encountered during processing.
nes::rob::signal_generator_error::driver_init	A HAL error occured during the pulse driver initialization.

signal()

nes::rob::error_code SignalGenerator::signal

(

int

sequence

)

const

Generate a protocol compatible signal.

Accepts an 8-bit binary array, and generates a corresponding signal.

Parameters

[in]

sequence

8-bit binary sequence used to invoke R.O.B.

Returns

an nes::rob::error_code describing errors encountered during processing

Return values

nes::rob::signal_generator_error::success	No errors encountered during processing.
nes::rob::signal_generator_error::driver_error	A driver error occured during pulse driver invocation.

testSignal()

nes::rob::error_code SignalGenerator::testSignal

(

void

)

const

Generate the R.O.B. test signal.

The test signal will disable R.O.B.'s LED if enabled. However, if R.O.B.'s LED is disabled, then the LED will be enabled and then disabled. When sent continuously, the LED will blink on a fixed interval.

Returns

an nes::rob::error_code describing errors encountered during processing

Return values

nes::rob::signal_generator_error::success	No errors encountered during processing.
nes::rob::signal_generator_error::driver_error	A driver error occured during pulse driver invocation.

---

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

• signal_generator.hpp
• signal_generator.cpp