myWRIO
C++ framework for NationalInstruments myRIO
myRIO Namespace Reference

Namespaces

 GyroRegisters
 

Classes

class  Acc
 Embedded accelerometer. More...
 
class  AIO
 Read or write an analog value through a 12 bits DAC/ADC. More...
 
class  DIO
 Digital input/output. More...
 
class  Encoder
 Embedded encoder. More...
 
class  Gyro
 Helper class to use with a L3G4200D gyro sensor. More...
 
class  I2C
 In this configuration, myRIO will always be the master. More...
 
union  I2C_CNTL
 I2C_CNTL contains informations about the procedure to come. More...
 
class  Log
 Easily print data to a log file. More...
 
class  Motor
 Combination of PWM and Encoder to work with motors. More...
 
class  MotorPID
 This class can be used to regulate a motor speed. More...
 
class  Pendulum
 
class  PWM
 Outputs a PWM signal (3.3V) More...
 
class  Time
 Stopwatch or countdown. More...
 
class  Wifi
 Use this class to exchange data via wifi. More...
 

Enumerations

enum  {
  AO0 = AOA_0VAL, AO1 = AOA_1VAL, BO0 = AOB_0VAL, BO1 = AOB_1VAL,
  CO0 = AOC_0VAL, CO1 = AOC_1VAL
}
 Analog output ports. More...
 
enum  {
  AI0 = AIA_0VAL, AI1 = AIA_1VAL, AI2 = AIA_2VAL, AI3 = AIA_3VAL,
  BI0 = AIB_0VAL, BI1 = AIB_1VAL, BI2 = AIB_2VAL, BI3 = AIB_3VAL,
  CI0 = AIC_0VAL, CI1 = AIC_1VAL
}
 Analog inputs ports. More...
 
enum  { IN, OUT }
 IN/OUT pin direction. More...
 
enum  { LED0, LED1, LED2, LED3 }
 LEDs on the chassis. More...
 
enum  {
  A0, A1, A2, A3,
  A4, A5, A6, A7,
  A8, A9, A10, A11,
  A12, A13, A14, A15,
  A_LAST
}
 A port DIO. More...
 
enum  {
  B0 = A_LAST, B1, B2, B3,
  B4, B5, B6, B7,
  B8, B9, B10, B11,
  B12, B13, B14, B15,
  B_LAST
}
 B port DIO. More...
 
enum  {
  C0 = B_LAST, C1, C2, C3,
  C4, C5, C6, C7,
  C_LAST
}
 C port DIO. More...
 
enum  { ENCA, ENCB }
 Encoder channels. More...
 
enum  { SPD_100KBPS = 100, SPD_400KBPS = 400 }
 Speed of the I2C bus. More...
 
enum  { I2C_WRITE, I2C_READ }
 Read or write state. More...
 
enum  { CCW, CW }
 
enum  {
  PWMA0 = PWMA_0CNFG, PWMA1 = PWMA_1CNFG, PWMA2 = PWMA_2CNFG, PWMB0 = PWMB_0CNFG,
  PWMB1 = PWMB_1CNFG, PWMB2 = PWMB_2CNFG, PWMC0 = PWMC_0CNFG, PWMC1 = PWMC_1CNFG
}
 A0 = pin A D8 A1 = pin A D9 A2 = pin A D10 B0 = pin B D8 B1 = pin B D9 B2 = pin B D10 C0 = pin C D3 C1 = pin C D7. More...
 

Functions

bool myRIO_init ()
 
bool myRIO_close ()
 
bool myRIO_error ()
 
static std::string printBits (uint8_t byte)
 This function can be used to print each bit of an unsigned char. More...
 

Variables

static NiFpga_Status status
 This global variable allow the user to keep track of errors if not 0. More...
 

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Analog output ports.

Enumerator
AO0 
AO1 
BO0 
BO1 
CO0 
CO1 

Definition at line 13 of file AIO.h.

◆ anonymous enum

anonymous enum

Analog inputs ports.

Enumerator
AI0 
AI1 
AI2 
AI3 
BI0 
BI1 
BI2 
BI3 
CI0 
CI1 

Definition at line 23 of file AIO.h.

◆ anonymous enum

anonymous enum
Enumerator
CCW 
CW 

Definition at line 11 of file Motor.h.

◆ anonymous enum

anonymous enum

A0 = pin A D8 A1 = pin A D9 A2 = pin A D10 B0 = pin B D8 B1 = pin B D9 B2 = pin B D10 C0 = pin C D3 C1 = pin C D7.

Enumerator
PWMA0 

Pin PWMA_0.

PWMA1 

Pin PWMA_1.

PWMA2 

Pin PWMA_2.

PWMB0 

Pin PWMB_0.

PWMB1 

Pin PWMB_1.

PWMB2 

Pin PWMB_2.

PWMC0 

Pin PWMC_0.

PWMC1 

Pin PWMC_1.

Definition at line 19 of file PWM.h.

◆ anonymous enum

anonymous enum

IN/OUT pin direction.

Enumerator
IN 
OUT 

Definition at line 14 of file DIO.h.

◆ anonymous enum

anonymous enum

LEDs on the chassis.

Enumerator
LED0 
LED1 
LED2 
LED3 

Definition at line 20 of file DIO.h.

◆ anonymous enum

anonymous enum

A port DIO.

Enumerator
A0 
A1 
A2 
A3 
A4 
A5 
A6 
A7 
A8 
A9 
A10 
A11 
A12 
A13 
A14 
A15 
A_LAST 

Definition at line 28 of file DIO.h.

◆ anonymous enum

anonymous enum

B port DIO.

Enumerator
B0 
B1 
B2 
B3 
B4 
B5 
B6 
B7 
B8 
B9 
B10 
B11 
B12 
B13 
B14 
B15 
B_LAST 

Definition at line 49 of file DIO.h.

◆ anonymous enum

anonymous enum

C port DIO.

Enumerator
C0 
C1 
C2 
C3 
C4 
C5 
C6 
C7 
C_LAST 

Definition at line 70 of file DIO.h.

◆ anonymous enum

anonymous enum

Encoder channels.

Enumerator
ENCA 
ENCB 

Definition at line 12 of file Encoder.h.

◆ anonymous enum

anonymous enum

Speed of the I2C bus.

Enumerator
SPD_100KBPS 
SPD_400KBPS 

Definition at line 25 of file I2C.h.

◆ anonymous enum

anonymous enum

Read or write state.

Enumerator
I2C_WRITE 
I2C_READ 

Definition at line 33 of file I2C.h.

Function Documentation

◆ myRIO_close()

bool myRIO::myRIO_close ( )

Definition at line 12 of file MyRIO.cpp.

◆ myRIO_error()

bool myRIO::myRIO_error ( )
Examples
project_angle.cpp, and project_pendulum.cpp.

Definition at line 20 of file MyRIO.cpp.

◆ myRIO_init()

◆ printBits()

static std::string myRIO::printBits ( uint8_t  byte)
static

This function can be used to print each bit of an unsigned char.

Parameters
byteThe byte to print
Returns
An empty string, for convenience : cout << "Bytes : " << printBits(var) << endl;

Definition at line 38 of file MyRIO.h.

Variable Documentation

◆ status

NiFpga_Status myRIO::status
static

This global variable allow the user to keep track of errors if not 0.

Examples
example_blink.cpp.

Definition at line 30 of file MyRIO.h.