MatrixMiniR4 1.1.5
Matrix Mini R4 Arduino Library API Documentation
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
MatrixMiniR4 Class Reference

Main class for the MatrixMiniR4 system. More...

#include <MatrixMiniR4.h>

Public Member Functions

 MatrixMiniR4 ()
 
bool begin ()
 Initialize the MatrixMiniR4 system and its components.
 

Public Attributes

MiniR4Power PWR
 Controller Power management.
 
MiniR4DC< 1 > M1
 Port M1 DC 5V Motor.
 
MiniR4DC< 2 > M2
 Port M2 DC 5V Motor.
 
MiniR4DC< 3 > M3
 Port M3 DC 5V Motor.
 
MiniR4DC< 4 > M4
 Port M4 DC 5V Motor.
 
MiniR4RC< 1 > RC1
 Port RC1 RC 5V Servo.
 
MiniR4RC< 2 > RC2
 Port RC2 RC 5V Servo.
 
MiniR4RC< 3 > RC3
 Port RC3 RC 5V Servo.
 
MiniR4RC< 4 > RC4
 Port RC4 RC 5V Servo.
 
MiniR4BTN< 2 > BTN_UP
 Up Button.
 
MiniR4BTN< 1 > BTN_DOWN
 Down Button.
 
MiniR4LED LED
 Built-in RGB LED.
 
MiniR4Motion Motion
 Built-in 6-axis motion sensor.
 
MiniR4BUZZER Buzzer
 Built-in Buzzer.
 
Adafruit_SSD1306 OLED
 Built-in OLED.
 
CWifi WiFi
 WiFiS3 Object.
 
MiniR4I2C<-1, &Wire > I2C0
 Port A3.
 
MiniR4I2C< 0, &Wire1 > I2C1
 Port I2C1.
 
MiniR4I2C< 1, &Wire1 > I2C2
 Port I2C2.
 
MiniR4I2C< 2, &Wire1 > I2C3
 Port I2C3.
 
MiniR4I2C< 3, &Wire1 > I2C4
 Port I2C4.
 
MiniR4PWM< 3, 2 > D1
 Port D1 (p3, p2)(only LEFT support PWM)
 
MiniR4PWM< 5, 4 > D2
 Port D2 (p5, p4)(only LEFT support PWM)
 
MiniR4PWM< 12, 11 > D3
 Port D3 (p12, p11)(only RIGHT support PWM)
 
MiniR4PWM< 13, 10 > D4
 Port D4 (p13, p10)(only RIGHT support PWM)
 
MiniR4DAC< PIN_A1, PIN_A0 > A1
 Port A1(only RIGHT support DAC)
 
MiniR4Analog< PIN_A3, PIN_A2 > A2
 Port A2.
 
MiniR4Analog< PIN_A4, PIN_A5 > A3
 Port A3.
 
UART Uart = UART(UART2_TX_PIN, UART2_RX_PIN)
 UART Port, Or using Serial1.
 
PS2X PS2
 MJ2 or PS2 (4p DAT CMD to D2, 2p CS CLK to D3)
 
MiniR4VernierLib Vernier
 Vernier sensor support.
 
MiniR4SmartCamReader Vision
 mVision (UART 9600)
 

Detailed Description

Main class for the MatrixMiniR4 system.

Note
You can using MiniR4 object to control all functionality.

The MatrixMiniR4 class integrates various modules such as DC motors, servos, buttons, sensors, I2C communication, OLED display, and WiFi functionality, allowing control and interaction with the MatrixMiniR4 system.

Definition at line 47 of file MatrixMiniR4.h.

Constructor & Destructor Documentation

◆ MatrixMiniR4()

MatrixMiniR4::MatrixMiniR4 ( )

Definition at line 18 of file MatrixMiniR4.cpp.

Member Function Documentation

◆ begin()

bool MatrixMiniR4::begin ( )

Initialize the MatrixMiniR4 system and its components.

This function initializes the MMLower (STM32) system, sets up the RGB LED and buzzer, and pre init for all DC motors and servos =. It also configures the OLED display and the MJ2 gamepad.

Returns
true if initialization was successful, false otherwise.

Definition at line 29 of file MatrixMiniR4.cpp.

Member Data Documentation

◆ A1

MiniR4DAC<PIN_A1, PIN_A0> MatrixMiniR4::A1

Port A1(only RIGHT support DAC)

Definition at line 104 of file MatrixMiniR4.h.

◆ A2

MiniR4Analog<PIN_A3, PIN_A2> MatrixMiniR4::A2

Port A2.

Definition at line 105 of file MatrixMiniR4.h.

◆ A3

MiniR4Analog<PIN_A4, PIN_A5> MatrixMiniR4::A3

Port A3.

Definition at line 106 of file MatrixMiniR4.h.

◆ BTN_DOWN

MiniR4BTN<1> MatrixMiniR4::BTN_DOWN

Down Button.

Definition at line 70 of file MatrixMiniR4.h.

◆ BTN_UP

MiniR4BTN<2> MatrixMiniR4::BTN_UP

Up Button.

Definition at line 69 of file MatrixMiniR4.h.

◆ Buzzer

MiniR4BUZZER MatrixMiniR4::Buzzer

Built-in Buzzer.

Definition at line 79 of file MatrixMiniR4.h.

◆ D1

MiniR4PWM<3, 2> MatrixMiniR4::D1

Port D1 (p3, p2)(only LEFT support PWM)

Definition at line 98 of file MatrixMiniR4.h.

◆ D2

MiniR4PWM<5, 4> MatrixMiniR4::D2

Port D2 (p5, p4)(only LEFT support PWM)

Definition at line 99 of file MatrixMiniR4.h.

◆ D3

MiniR4PWM<12, 11> MatrixMiniR4::D3

Port D3 (p12, p11)(only RIGHT support PWM)

Definition at line 100 of file MatrixMiniR4.h.

◆ D4

MiniR4PWM<13, 10> MatrixMiniR4::D4

Port D4 (p13, p10)(only RIGHT support PWM)

Definition at line 101 of file MatrixMiniR4.h.

◆ I2C0

MiniR4I2C<-1, &Wire> MatrixMiniR4::I2C0

Port A3.

Definition at line 91 of file MatrixMiniR4.h.

◆ I2C1

MiniR4I2C<0, &Wire1> MatrixMiniR4::I2C1

Port I2C1.

Definition at line 92 of file MatrixMiniR4.h.

◆ I2C2

MiniR4I2C<1, &Wire1> MatrixMiniR4::I2C2

Port I2C2.

Definition at line 93 of file MatrixMiniR4.h.

◆ I2C3

MiniR4I2C<2, &Wire1> MatrixMiniR4::I2C3

Port I2C3.

Definition at line 94 of file MatrixMiniR4.h.

◆ I2C4

MiniR4I2C<3, &Wire1> MatrixMiniR4::I2C4

Port I2C4.

Definition at line 95 of file MatrixMiniR4.h.

◆ LED

MiniR4LED MatrixMiniR4::LED

Built-in RGB LED.

Definition at line 73 of file MatrixMiniR4.h.

◆ M1

MiniR4DC<1> MatrixMiniR4::M1

Port M1 DC 5V Motor.

Definition at line 57 of file MatrixMiniR4.h.

◆ M2

MiniR4DC<2> MatrixMiniR4::M2

Port M2 DC 5V Motor.

Definition at line 58 of file MatrixMiniR4.h.

◆ M3

MiniR4DC<3> MatrixMiniR4::M3

Port M3 DC 5V Motor.

Definition at line 59 of file MatrixMiniR4.h.

◆ M4

MiniR4DC<4> MatrixMiniR4::M4

Port M4 DC 5V Motor.

Definition at line 60 of file MatrixMiniR4.h.

◆ Motion

MiniR4Motion MatrixMiniR4::Motion

Built-in 6-axis motion sensor.

Definition at line 76 of file MatrixMiniR4.h.

◆ OLED

Adafruit_SSD1306 MatrixMiniR4::OLED

Built-in OLED.

Definition at line 82 of file MatrixMiniR4.h.

◆ PS2

PS2X MatrixMiniR4::PS2

MJ2 or PS2 (4p DAT CMD to D2, 2p CS CLK to D3)

Definition at line 112 of file MatrixMiniR4.h.

◆ PWR

MiniR4Power MatrixMiniR4::PWR

Controller Power management.

Definition at line 54 of file MatrixMiniR4.h.

◆ RC1

MiniR4RC<1> MatrixMiniR4::RC1

Port RC1 RC 5V Servo.

Definition at line 63 of file MatrixMiniR4.h.

◆ RC2

MiniR4RC<2> MatrixMiniR4::RC2

Port RC2 RC 5V Servo.

Definition at line 64 of file MatrixMiniR4.h.

◆ RC3

MiniR4RC<3> MatrixMiniR4::RC3

Port RC3 RC 5V Servo.

Definition at line 65 of file MatrixMiniR4.h.

◆ RC4

MiniR4RC<4> MatrixMiniR4::RC4

Port RC4 RC 5V Servo.

Definition at line 66 of file MatrixMiniR4.h.

◆ Uart

UART MatrixMiniR4::Uart = UART(UART2_TX_PIN, UART2_RX_PIN)

UART Port, Or using Serial1.

Definition at line 109 of file MatrixMiniR4.h.

◆ Vernier

MiniR4VernierLib MatrixMiniR4::Vernier

Vernier sensor support.

Definition at line 115 of file MatrixMiniR4.h.

◆ Vision

MiniR4SmartCamReader MatrixMiniR4::Vision

mVision (UART 9600)

Definition at line 118 of file MatrixMiniR4.h.

◆ WiFi

CWifi MatrixMiniR4::WiFi

WiFiS3 Object.

Definition at line 85 of file MatrixMiniR4.h.

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