Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen Revision Vorhergehende Überarbeitung Nächste Überarbeitung | Vorhergehende Überarbeitung | ||
microcontrollertechnik:vorgaben_fuer_die_softwareentwicklung [2021/05/09 11:14] – Externe Bearbeitung 127.0.0.1 | microcontrollertechnik:vorgaben_fuer_die_softwareentwicklung [2024/09/24 13:51] (aktuell) – mexleadmin | ||
---|---|---|---|
Zeile 19: | Zeile 19: | ||
++++Beschreibung| | ++++Beschreibung| | ||
- | <code c> | + | <sxh c; first-line: 1> |
/* ============================================================================ | /* ============================================================================ | ||
Zeile 34: | Zeile 34: | ||
| | ||
- | Software: | + | Software: |
Funktion: | Funktion: | ||
Zeile 61: | Zeile 61: | ||
=============================================================================*/ | =============================================================================*/ | ||
- | </code> | + | </sxh> |
++++ | ++++ | ||
Zeile 68: | Zeile 68: | ||
++++Beispiel für Code-Kommentierung| | ++++Beispiel für Code-Kommentierung| | ||
- | |<fc # | + | |<fc # |
if(i==0) output=0; // wenn i = 1, output=0 | if(i==0) output=0; // wenn i = 1, output=0 | ||
- | </code> | + | </sxh> | |
- | |<fc # | + | |<fc # |
if(i==0) output=0; // nur für erstes Element wird der Output zurückgesetzt | if(i==0) output=0; // nur für erstes Element wird der Output zurückgesetzt | ||
- | </code> | + | </sxh> | |
++++ | ++++ | ||
Zeile 81: | Zeile 81: | ||
++++Beispiel für auskommentierten Code| | ++++Beispiel für auskommentierten Code| | ||
- | |<fc # | + | |<fc # |
... | ... | ||
if (i==1) output(" | if (i==1) output(" | ||
Zeile 90: | Zeile 90: | ||
... | ... | ||
- | </code> | + | </sxh> | |
- | |<fc # | + | |<fc # |
... | ... | ||
if (i==STARTWERT) LCDoutput(startAusgabe); | if (i==STARTWERT) LCDoutput(startAusgabe); | ||
Zeile 97: | Zeile 97: | ||
// Ausgabe, weil i <=1 | // Ausgabe, weil i <=1 | ||
... | ... | ||
- | </code> | + | </sxh> | |
++++ | ++++ | ||
Zeile 107: | Zeile 107: | ||
++++Beispiel für die vordefinierten Makros| | ++++Beispiel für die vordefinierten Makros| | ||
- | |<fc # | + | |<fc # |
# | # | ||
Zeile 121: | Zeile 121: | ||
... | ... | ||
} | } | ||
- | </code> | + | </sxh> | |
- | |<fc # | + | |<fc # |
// Makros | // Makros | ||
Zeile 137: | Zeile 137: | ||
... | ... | ||
} | } | ||
- | </code> | + | </sxh> | |
++++ | ++++ | ||
Zeile 148: | Zeile 148: | ||
* Konstanten per ''# | * Konstanten per ''# | ||
* Falls Sie aus mehreren Wörtern zusammengefügt sind, sollten Sie **mit Unterstrich** | * Falls Sie aus mehreren Wörtern zusammengefügt sind, sollten Sie **mit Unterstrich** | ||
- | <code c> | + | <sxh c; first-line: 1> |
enum tage {MONTAG, DIENSTAG, MITTWOCH, DONNERSTAG, FREITAG, SAMSTAG, SONNTAG}; | enum tage {MONTAG, DIENSTAG, MITTWOCH, DONNERSTAG, FREITAG, SAMSTAG, SONNTAG}; | ||
for (enum tage aktuellerTag = MONTAG; aktuellerTag <= SONNTAG; aktuellerTag++) | for (enum tage aktuellerTag = MONTAG; aktuellerTag <= SONNTAG; aktuellerTag++) | ||
- | {...};</code> | + | {...};</sxh> |
++++Beispiel für Konstanten| | ++++Beispiel für Konstanten| | ||
- | |<fc # | + | {{tablelayout? |
+ | |<fc # | ||
// Konstanten | // Konstanten | ||
Zeile 172: | Zeile 173: | ||
... | ... | ||
- | </code> | + | </sxh> | |
- | |<fc # | + | |<fc # |
// Konstanten | // Konstanten | ||
Zeile 193: | Zeile 194: | ||
... | ... | ||
- | </code> | + | </sxh> | |
++++ | ++++ | ||
Zeile 203: | Zeile 204: | ||
* Variablen beginnen mit Kleinbuchstaben. | * Variablen beginnen mit Kleinbuchstaben. | ||
* Falls Sie aus mehreren Wörtern zusammengefügt sind, so werden die folgenden Wörter **ohne Unterstrich** | * Falls Sie aus mehreren Wörtern zusammengefügt sind, so werden die folgenden Wörter **ohne Unterstrich** | ||
- | * Vermeiden Sie zu allgemeine Namen, wie anzahl, uebergabewert oder string. Sinnvoller sind Namen, wie anzahlBuchstaben, | + | * Vermeiden Sie zu allgemeine Namen, wie anzahl, uebergabewert oder string. Sinnvoller sind Namen, wie '' |
* Nutzen sie auch bei Zählvariablen aussagekräftige Namen. | * Nutzen sie auch bei Zählvariablen aussagekräftige Namen. | ||
- | * Auch kann eine zu allgemeine Deklaration kann zu Problemen führen. Schlecht ist z.B. "int a;". | + | * Auch kann eine zu allgemeine Deklaration kann zu Problemen führen. Schlecht ist z.B. '' |
- | * Es bietet sich an bei der Definition bereits zu initialisieren. Gut ist also "bool a=1;". | + | * Es bietet sich an bei der Definition bereits zu initialisieren. Gut ist also '' |
++++Beispiel für Variablen| | ++++Beispiel für Variablen| | ||
- | |<fc # | + | |<fc # |
// Variablen | // Variablen | ||
Zeile 220: | Zeile 221: | ||
char wasKopie2; | char wasKopie2; | ||
- | </code> | + | </sxh> | |
- | |<fc # | + | |<fc # |
// Variablen | // Variablen | ||
- | const int maxAnzSpieler | + | const uint8_t |
- | uint8_t | + | uint16_t |
- | unsigned char gemesseneBreite = 0; // gemessene Breite in Meter | + | uint8_t |
bool zeichenAusgabe | bool zeichenAusgabe | ||
// ein Zeichen ausgegeben werden darf | // ein Zeichen ausgegeben werden darf | ||
- | </code> | + | </sxh> | |
++++ | ++++ | ||
Zeile 236: | Zeile 237: | ||
* Teilen Sie Ihr Projekt in sinnvolle Unterstrukturen. Diese sind meist Funktionen. Die Unterstrukturen sollten nicht zu groß werden, um die Übersichtlichkeit zu bewahren. | * Teilen Sie Ihr Projekt in sinnvolle Unterstrukturen. Diese sind meist Funktionen. Die Unterstrukturen sollten nicht zu groß werden, um die Übersichtlichkeit zu bewahren. | ||
- | * Bei größeren Programmen ist auch die Aufteilung in mehrere Dateien sinnvoll, also z.b. main.c, LED.c, motorDriver.c. Dabei sollte darauf geachtet werden, dass globalen Variablen und Konstanten jeweils nur im Kontext der einzelnen Dateien genutzt werden und, dass header-Dateien angelegt werden. Das ermöglicht ein separates Testen der unterschiedlichen Dateien (z.B. mit einer Datei testLED.c, welche LED.h inlcude't). | + | * Bei größeren Programmen ist auch die Aufteilung in mehrere Dateien sinnvoll, also z.b. '' |
- | * Nutzen Sie den Zeileneinschub den AtmelStudio | + | * Nutzen Sie den Zeileneinschub den Microchip Studio |
- | * Für die Benennung von Funktionen bietet sich - wie bei Variablen - camelCase an. Zum leichteren Verständnis sollten die Funktionsnamen aus Objekt(e) und Verb zusammengesetzt werden (z.B. bool isI2cMessageNotSent() oder void sentI2cMessage()). Damit wird der Code besser lesbar, Z.B. '' | + | * Für die Benennung von Funktionen bietet sich - wie bei Variablen - camelCase an. Zum leichteren Verständnis sollten die Funktionsnamen aus Objekt(e) und Verb zusammengesetzt werden (z.B. '' |
* Vermeiden Sie zu viele Leerzeilen. | * Vermeiden Sie zu viele Leerzeilen. | ||
* Stellen Sie auch jeder Funktion eine kurze Beschreibung voran. Aus dieser sollte hervorgehen, | * Stellen Sie auch jeder Funktion eine kurze Beschreibung voran. Aus dieser sollte hervorgehen, | ||
++++Beispiel für Anweisungsblöcke| | ++++Beispiel für Anweisungsblöcke| | ||
- | |<fc # | + | |<fc # |
uint8_t unter2_neu(uint8_t Was) | uint8_t unter2_neu(uint8_t Was) | ||
{ | { | ||
Zeile 259: | Zeile 260: | ||
return 0; | return 0; | ||
} | } | ||
- | </code> | + | </sxh> | |
- | |<fc # | + | |<fc # |
uint8_t schluesselPositionFinden(uint8_t schluessel) | uint8_t schluesselPositionFinden(uint8_t schluessel) | ||
/* Das Array schluesselArray wird nach dem übergebenen Schlüssel durchsucht. | /* Das Array schluesselArray wird nach dem übergebenen Schlüssel durchsucht. | ||
Zeile 267: | Zeile 268: | ||
*/ | */ | ||
{ | { | ||
- | for( int aktuelleSchluesselPosition=ERSTE_SCHLUESSEL_POSITION; | + | for( uint8_t |
{ // durchlaufe alle Schlüsselpositionen | { // durchlaufe alle Schlüsselpositionen | ||
if(schluesselArray[aktuelleSchluesselPosition]==schluessel) return aktuelleSchluesselPosition; | if(schluesselArray[aktuelleSchluesselPosition]==schluessel) return aktuelleSchluesselPosition; | ||
Zeile 274: | Zeile 275: | ||
return 0; | return 0; | ||
} | } | ||
- | </code> | + | </sxh> In diesem Beispiel wäre der Funktionsname |
++++ | ++++ | ||
Zeile 284: | Zeile 285: | ||
++++Beispiel für Arrays, Schleifen und Abfragen| | ++++Beispiel für Arrays, Schleifen und Abfragen| | ||
- | |<fc # | + | |<fc # |
#define MAX 10 | #define MAX 10 | ||
Zeile 295: | Zeile 296: | ||
}; | }; | ||
- | </code> | + | </sxh> | |
- | |<fc # | + | |<fc # |
#define MAX 10 | #define MAX 10 | ||
Zeile 307: | Zeile 308: | ||
}; | }; | ||
- | </code> | | + | </sxh> |
++++ | ++++ | ||
Zeile 318: | Zeile 319: | ||
++++Beispiel für ähnliche Zeilen| | ++++Beispiel für ähnliche Zeilen| | ||
- | |<fc # | + | |<fc # |
... | ... | ||
temp = hunderter; | temp = hunderter; | ||
Zeile 333: | Zeile 334: | ||
... | ... | ||
- | </code> | + | </sxh> | |
- | |<fc # | + | |<fc # |
#define ASCII_ZERO 0x30 | #define ASCII_ZERO 0x30 | ||
#define MOD_TEN 10 | #define MOD_TEN 10 | ||
Zeile 355: | Zeile 356: | ||
printDecimalDigit(DISP_LINE1, | printDecimalDigit(DISP_LINE1, | ||
... | ... | ||
- | </code> | + | </sxh> | |
++++ | ++++ | ||
Zeile 364: | Zeile 365: | ||
++++Beispiel für Verzweigungen 1 - Umwandlung in Array | | ++++Beispiel für Verzweigungen 1 - Umwandlung in Array | | ||
- | |<fc # | + | |<fc # |
... | ... | ||
if (i==0) output(" | if (i==0) output(" | ||
Zeile 374: | Zeile 375: | ||
... | ... | ||
- | </code> | + | </sxh> | |
- | |<fc # | + | |<fc # |
#define MAX_ANZ_AUSGABE 6 | #define MAX_ANZ_AUSGABE 6 | ||
#define MAX_ZEICHEN_AUSGABE 4 | #define MAX_ZEICHEN_AUSGABE 4 | ||
Zeile 391: | Zeile 392: | ||
outputToLCD(AusgabeZahl[i]); | outputToLCD(AusgabeZahl[i]); | ||
... | ... | ||
- | </code> | + | </sxh> | |
++++++++Beispiel für Verzweigungen 2 - Umwandlung in Switch-Case| | ++++++++Beispiel für Verzweigungen 2 - Umwandlung in Switch-Case| | ||
- | |<fc # | + | |<fc # |
... | ... | ||
- | if (i==0) doZero; | + | if (i==0) doZero(); // wenn 0 dann null |
- | if (i==1) doOne; | + | if (i==1) doOne(); // wenn 1 dann eins |
- | if (i==2) doTwo; | + | if (i==2) doTwo(); // wenn 2 dann zwei |
- | if (i==3) doThree; | + | if (i==3) doThree(); // wenn 3 dann drei |
- | if (i==4) doFour; | + | if (i==4) doFour(); // wenn 4 dann vier |
- | if (i==5) doFive; | + | if (i==5) doFive(); // wenn 5 dann fünf |
... | ... | ||
- | </code> | + | </sxh> | |
- | |<fc # | + | |<fc # |
... | ... | ||
switch(i) { | switch(i) { | ||
- | case 1: doOne; | + | case 1: doOne(); |
- | case 2: doTwo; | + | case 2: doTwo(); |
- | case 3: doThree; break; | + | case 3: doThree(); break; |
- | case 4: doFour; | + | case 4: doFour(); break; |
- | case 5: doFive; | + | case 5: doFive(); break; |
default: break; | default: break; | ||
}; | }; | ||
... | ... | ||
- | </code> | + | </sxh> | |
++++++++Beispiel für Verzweigungen 3 - Optimierung von Switch-Case| | ++++++++Beispiel für Verzweigungen 3 - Optimierung von Switch-Case| | ||
- | |<fc # | + | |<fc # |
... | ... | ||
switch(i) { | switch(i) { | ||
- | case 1: doOne; | + | case 1: doOne(); |
- | case 2: doOne; | + | case 2: doOne(); |
- | case 3: doThree; | + | case 3: doThree();doFour();doFive(); break; |
- | case 4: doFour; | + | case 4: doFour();doFive(); |
- | case 5: doFive; | + | case 5: doFive(); break; |
- | case 6: doOne; | + | case 6: doOne(); |
- | case 7: doOne; | + | case 7: doOne(); |
- | case 8: doOne; | + | case 8: doOne(); |
- | case 9: doOne; | + | case 9: doOne(); |
default: break; | default: break; | ||
}; | }; | ||
... | ... | ||
- | </code> | + | </sxh> | |
- | |<fc # | + | |<fc # |
... | ... | ||
switch(i) { | switch(i) { | ||
- | case 1, 2, 6...9 : doOne; | + | case 1: |
- | case 3: doThree; | + | case 2: // Einzelne Zahlen können mit case's untereinander ... |
- | case 4: doFour; | + | case 6 ... 9: doOne(); |
- | case 5: doFive; | + | case 3: doThree(); // |
+ | case 4: doFour(); | ||
+ | case 5: doFive(); | ||
default: | default: | ||
}; | }; | ||
... | ... | ||
- | </code> | + | </sxh> | |
++++++++Beispiel für Verzweigungen 4 - Umwandlung in For-Next| | ++++++++Beispiel für Verzweigungen 4 - Umwandlung in For-Next| | ||
- | |<fc # | + | |<fc # |
... | ... | ||
if (( 0<i) && (i<= 7)) j=j+2; | if (( 0<i) && (i<= 7)) j=j+2; | ||
Zeile 462: | Zeile 465: | ||
... | ... | ||
- | </code> | + | </sxh> | |
- | |<fc # | + | |<fc # |
... | ... | ||
- | | + | |
- | | + | |
- | | + | |
- | for(int steps; steps< | + | for(uint8_t |
if( (Grenze[steps] < i) && (i <= Grenze[steps+1]) ) j = j + jSummand[steps]; | if( (Grenze[steps] < i) && (i <= Grenze[steps+1]) ) j = j + jSummand[steps]; | ||
}; | }; | ||
... | ... | ||
- | </code> | + | </sxh> | |
++++ | ++++ | ||
Zeile 480: | Zeile 483: | ||
++++Beispiel für Verzweigungen 4 - Verwenden von Else if| | ++++Beispiel für Verzweigungen 4 - Verwenden von Else if| | ||
- | |<fc # | + | |<fc # |
... | ... | ||
if (( 0<i) && (i<= 7)) j=j+2; | if (( 0<i) && (i<= 7)) j=j+2; | ||
if (( 7<i) && (i<=12)) { | if (( 7<i) && (i<=12)) { | ||
j=j+5; | j=j+5; | ||
- | DoOne; | + | DoOne(); |
} | } | ||
if ((12<i) && (i<=20)) j=j+3; | if ((12<i) && (i<=20)) j=j+3; | ||
... | ... | ||
- | </code> | + | </sxh> | |
- | |<fc # | + | |<fc # |
... | ... | ||
if (( 0<i) && (i<= 7)) { j = j + 2;} | if (( 0<i) && (i<= 7)) { j = j + 2;} | ||
else if (( 7<i) && (i<=12)) { | else if (( 7<i) && (i<=12)) { | ||
j=j+5; | j=j+5; | ||
- | DoOne; | + | DoOne(); |
} | } | ||
else if ((12<i) && (i<=20)) { j = j + 3;}; | else if ((12<i) && (i<=20)) { j = j + 3;}; | ||
... | ... | ||
- | </code> | + | </sxh> | |
++++++++Beispiel für Verzweigungen 5 - Reduzieren der Anweisungen| | ++++++++Beispiel für Verzweigungen 5 - Reduzieren der Anweisungen| | ||
- | |<fc # | + | |<fc # |
... | ... | ||
if (i<=7) { | if (i<=7) { | ||
j=j+2; | j=j+2; | ||
- | DoOne; | + | DoOne(); |
} | } | ||
else if (( 7<i) && (i<=12)) { | else if (( 7<i) && (i<=12)) { | ||
j=j+5; | j=j+5; | ||
- | DoZero; | + | DoZero(); |
- | DoOne; | + | DoOne(); |
} | } | ||
else if (12<i){ | else if (12<i){ | ||
j=j+3; | j=j+3; | ||
- | DoZero; | + | DoZero(); |
- | DoOne; | + | DoOne(); |
}; | }; | ||
... | ... | ||
- | </code> | + | </sxh> | |
- | |<fc # | + | |<fc # |
... | ... | ||
- | if (i<=7) { | + | if ( i <= 7 ) { |
- | j=j+2; | + | j = j + 2; |
} | } | ||
- | else if (( 7<i) && (i<=12)) { | + | else if (( 7 < i ) && ( i <= 12)) { |
- | j=j+5; | + | j = j + 5; |
- | DoZero; | + | DoZero(); |
} | } | ||
- | else if (12< | + | else if ( 12 < i){ |
- | j=j+3; | + | j = j + 3; |
- | DoZero; | + | DoZero(); |
}; | }; | ||
- | DoOne; | + | DoOne(); |
... | ... | ||
- | </code> auch möglich, aber etwas schwerer leserlich: | + | </sxh> |
... | ... | ||
- | if | + | if ( i <= 7) j = j + 2; |
- | else{if | + | else{if |
- | else if (12< | + | else if (12 < i) j = j + 3; |
- | DoZero; | + | DoZero(); |
}; | }; | ||
- | DoOne; | + | DoOne(); |
... | ... | ||
- | </code> | + | </sxh> | |
++++ | ++++ | ||
Zeile 556: | Zeile 559: | ||
++++Beispiel für Schleifen 1 - main()| | ++++Beispiel für Schleifen 1 - main()| | ||
- | |<fc # | + | |<fc # |
void main() | void main() | ||
{ | { | ||
initAll; | initAll; | ||
while(1){ | while(1){ | ||
- | Eingabe; | + | Eingabe(); |
- | Verarbeitung; | + | Verarbeitung(); |
- | if (CancelButton==1) main; | + | if (CancelButton==1) main(); |
- | Ausgabe; | + | Ausgabe(); |
} | } | ||
} | } | ||
- | </code> | + | </sxh> | |
- | |<fc # | + | |<fc # |
void main() | void main() | ||
{ | { | ||
- | initOneTimeFunctions; | + | initOneTimeFunctions(); |
while(1){ | while(1){ | ||
- | initOtherFunctions; | + | initOtherFunctions(); |
CancelButton = 0; | CancelButton = 0; | ||
while(!CancelButton){ | while(!CancelButton){ | ||
- | Eingabe; | + | Eingabe(); |
- | Verarbeitung; | + | Verarbeitung(); |
- | if (!CancelButton) Ausgabe; | + | if (!CancelButton) Ausgabe(); |
}; | }; | ||
} | } | ||
} | } | ||
- | </code> | + | </sxh> | |
++++++++Beispiel für Schleifen 2 - Abbrechen von verschachtelten Schleifen| | ++++++++Beispiel für Schleifen 2 - Abbrechen von verschachtelten Schleifen| | ||
- | |<fc # | + | |<fc # |
- | for(int xpos=0; | + | for(uint8_t |
- | initYPos; | + | initYPos(); |
for(int ypos=0; | for(int ypos=0; | ||
- | Eingabe; | + | Eingabe(); |
- | Verarbeitung; | + | Verarbeitung(); |
if (CancelButton) goto Abbruch; | if (CancelButton) goto Abbruch; | ||
}; | }; | ||
Zeile 601: | Zeile 604: | ||
... | ... | ||
- | </code> | + | </sxh> | |
- | |<fc # | + | |<fc # |
- | | + | |
- | for(int xpos=0 ; xpos< | + | for(uint8_t |
- | initYPos; | + | initYPos(); |
- | for(int ypos=0 ; ypos< | + | for(uint8_t |
- | Eingabe; | + | Eingabe(); |
- | Verarbeitung; | + | Verarbeitung(); |
if (CancelButton) break; | if (CancelButton) break; | ||
}; | }; | ||
Zeile 617: | Zeile 620: | ||
... | ... | ||
- | </code> | + | </sxh> **Beachten Sie, dass in diesem Fall CancelButton eine Variable sein muss und sich zwischen den beiden if-Bedingungen nicht ändern darf (z.B. durch Interrupts).** |
++++ | ++++ | ||
- | * _delay_ms() und _delay_us() sind zu 99% nicht notwendig. Verwenden Sie stattdessen Interrupts, bzw. Timer. Es können z.B. durch Interrupts Takte angelegt werden: takt10ms, takt100ms, takt1s. Diese können dann im main() Verzweigungen in einer Zustandsmaschine | + | * _delay_ms() und _delay_us() sind zu 99% nicht notwendig. Verwenden Sie stattdessen Interrupts, bzw. Timer. |
+ | * Häufig bietet es sich an, in den Takten dann auch Verzweigungen in einer Zustandsmaschine | ||
* Wenn Sie Zahlen in Variablen speichern und diese auch mathematisch weiterverwenden, | * Wenn Sie Zahlen in Variablen speichern und diese auch mathematisch weiterverwenden, | ||
++++Beispiel für Variablen mit Ausgabe| | ++++Beispiel für Variablen mit Ausgabe| | ||
- | |<fc # | + | |<fc # |
... | ... | ||
Zahlenwert = (ADC_Wert/ | Zahlenwert = (ADC_Wert/ | ||
Zeile 633: | Zeile 637: | ||
... | ... | ||
- | </code> | + | </sxh> | |
- | |<fc # | + | |<fc # |
#define ASCII_ZERO 0x30 | #define ASCII_ZERO 0x30 | ||
Zeile 643: | Zeile 647: | ||
Laengen[i] = Laenge; | Laengen[i] = Laenge; | ||
Flaeche | Flaeche | ||
- | LCD_putc(Laengen[i]+ ASCII_ZERO); | + | LCD_putc(Laengen[i] + ASCII_ZERO); |
... | ... | ||
- | </code> | + | </sxh> | |
++++ | ++++ | ||
Zeile 651: | Zeile 655: | ||
====== Bewertung ====== | ====== Bewertung ====== | ||
- | Zur Bewertung lege ich {{checkliste_250520.pdf|diese Checkliste}} | + | Zur Bewertung lege ich {{microcontrollertechnik: |