ein bisschen doku

This commit is contained in:
2021-11-23 18:51:52 +01:00
parent 2c1c31f42b
commit f086bfa6b3
6 changed files with 85 additions and 55 deletions
+5 -52
View File
@@ -1,15 +1,4 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<diagram program="umlet" version="14.3.0">
<zoom_level>10</zoom_level>
<element>
<id>UMLClass</id>
<coordinates>
<x>460</x>
<y>60</y>
<w>220</w>
<h>510</h>
</coordinates>
<panel_attributes>&lt;&lt;hardware&gt;&gt;
<diagram program="umletino" version="14.4.0-SNAPSHOT"><zoom_level>10</zoom_level><element><id>UMLClass</id><coordinates><x>350</x><y>0</y><w>220</w><h>510</h></coordinates><panel_attributes>&lt;&lt;hardware&gt;&gt;
MotorControl
--
- name: String
@@ -40,18 +29,7 @@ MotorControl
+ isAccelerationPositive(): bool
+ isAccelerationNegative(): bool
- setRealPower(power: int8_t)
- increasePower(power: int8_t)</panel_attributes>
<additional_attributes/>
</element>
<element>
<id>UMLClass</id>
<coordinates>
<x>80</x>
<y>480</y>
<w>220</w>
<h>330</h>
</coordinates>
<panel_attributes>&lt;&lt;hardware&gt;&gt;
- increasePower(power: int8_t)</panel_attributes><additional_attributes></additional_attributes></element><element><id>UMLClass</id><coordinates><x>80</x><y>380</y><w>220</w><h>330</h></coordinates><panel_attributes>&lt;&lt;hardware&gt;&gt;
Speedometer
--
- encoder: ESP32Encoder
@@ -71,18 +49,7 @@ Speedometer
+ getSpeed(): double
+ getDirection(): uint8_t
- addValToBuf(val: int16_t)
- getAverage(): int16_t</panel_attributes>
<additional_attributes/>
</element>
<element>
<id>UMLClass</id>
<coordinates>
<x>70</x>
<y>60</y>
<w>270</w>
<h>370</h>
</coordinates>
<panel_attributes>MoveControl
- getAverage(): int16_t</panel_attributes><additional_attributes></additional_attributes></element><element><id>UMLClass</id><coordinates><x>70</x><y>0</y><w>270</w><h>370</h></coordinates><panel_attributes>MoveControl
--
- debug: DebugMqtt*
- left_motor: MotorControl*
@@ -105,18 +72,7 @@ Speedometer
+ setSpeed(speed: double)
+ setRotationspeed(speed: double)
- calcWheelSpeed()
- regulateMotors()</panel_attributes>
<additional_attributes/>
</element>
<element>
<id>UMLClass</id>
<coordinates>
<x>700</x>
<y>60</y>
<w>220</w>
<h>330</h>
</coordinates>
<panel_attributes>&lt;&lt;driveModi&gt;&gt;
- regulateMotors()</panel_attributes><additional_attributes></additional_attributes></element><element><id>UMLClass</id><coordinates><x>580</x><y>0</y><w>220</w><h>330</h></coordinates><panel_attributes>&lt;&lt;driveModi&gt;&gt;
ManualControl
--
- encoder: ESP32Encoder
@@ -136,7 +92,4 @@ ManualControl
+ getSpeed(): double
+ getDirection(): uint8_t
- addValToBuf(val: int16_t)
- getAverage(): int16_t</panel_attributes>
<additional_attributes/>
</element>
</diagram>
- getAverage(): int16_t</panel_attributes><additional_attributes></additional_attributes></element></diagram>
+17
View File
@@ -0,0 +1,17 @@
Controller
PS3-Button: Change Mode
Mode: ManualControl
L3: Joystick Mode
Left Joystick: Drive
R3: Shoulder Trigger Mode
L2: Spin left side
R2: Spin right side
Mode: Autopilot
Mode: CaptureRoute
Mode: ConsolControl