AVR Einstiegsprojekt in Eclipse mit Doxygen!

(2012 – Update 28.05.2012)
Hier ein „Hallo Welt!“/“Hello World!“ für den AVR. Das ganze läuft unter Eclipse. Ich gehe hier nochmal auf die Kommentare mit Doxygen-Tags ein und zeige wie man nicht nur die Hex-File erzeugt und flasht, sondern auch die Code-Dokumentation generiert.

Wenn du Eclipse als Entwicklungsumgebung für den AVR verwenden möchtest, empfehle ich dir das hier verwendete AVR- und eclox-Plugin unter Eclipse. Alles zur Installation der hier verwendeten Software und eine recht ausführliche Anleitung gibt es >>hier<<.

„Hallo Welt“ für den AVR in Eclipse:

      1. Eclipse starten und ein neues AVR Projekt anlegen
        Im Menü unter „File/New Project/C-Project“ wählen und dort links „AVR Cross Target/Empty Project“ und rechts „AVR-GCC Toolchain“ wählen, das Projekt mit „HelloWorld“ bezeichnen und „Next“ drücken.

        eClipseAVR_HelloWorld_NewProject

        eClipseAVR_HelloWorld_NewProject

        Dort nur bei „Release“ einen Haken setzen und „Next“. Ich verwende einen ATmega16 bei 8000000Hz, also bitte dort entsprechend der Zielhardware die Werte eintragen und dann „Finish“ drücken.

      2. Programmieradapter anlegen:
        Im „Project Explorer“ (linker Teil der IDE) wird ein neues Projekt angelegt. Dort das aktuelle Projekt auswählen, Rechtsklick und „Properties“ wählen.
        In diesem Dialog unter „AVR/AVRdude“ gehen und rechts im Tab bei „Programmer“ den Button „New“ anklicken. Hier nehmt ihr die Einstellungen für euren Programmieradapter vor. Wählt dann den neu angelegten Adapter aus und klickt auf „Apply“. (Den Preferences-Dialog geöffnet lassen!)
        Ich verwende den USBasp, die Einstellungen sehen dann so aus.

        eclipse_usbasp_config

        eclipse_usbasp_config

      3. Doxygen Code-Highlights aktivieren:
        Im zuvor geöffneten Preferences-Dialog geht ihr jetzt auf „C/C++ General“. Dort den Haken bei „Enable Project specific..“ setzen und unten „Doxygen“ auswählen. Dialog schließen und zurück zum Workbench. Siehe Bild:

        eclipse_doxyCPP

        eclipse_doxyCPP

      4. Code-Datei „main.c“ anlegen:
        Rechtsklick im Projekt-Explorer auf das Projekt und dort unter „New/Source File“ die „main.c“ anlegen. Diese Datei mit folgendem Code füllen:

        /**
        * @file    main.c
        * @date    10.03.2011
        * @author    Rene Bauer
        * @brief    "Hello World" as blinking light on AVR µC
        * @details Part of a tutorial using doxygen
        *
        */
        #include <avr/io.h>
        #include <util/delay.h>
        
        /**< DataDirection-Register of LED-pin */
        #define DDR_Blink    DDRB
        /**< Port-Register of LED-pin */
        #define PORT_Blink    PORTB
        /**< Pin-Number of LED-pin */
        #define Pin_Blink    3
        
        /**
        * @details Does something important
        * @return
        */
        int main()
        {
        DDR_Blink|=_BV(Pin_Blink);    //Use pin in push-pull mode
        //endless loop
        while (1)
        {
        //Wait
        _delay_ms(500);
        //Change output-state
        PORT_Blink^=_BV(Pin_Blink);
        }
        return 0;
        }
        
      5. Jetzt alles speichern und oben mit Hilfe des“Hammer“-Symbols den Build-Prozess anstoßen. Wenn alles ohne Fehler compiliert habt ihr es richtig gemacht.
      6. Doxygen-Projektdatei anlegen:
        Wieder ein Rechtsklick im Projekt-Explorer auf das aktuelle Projekt und unter „New/Other“ gehen. Im folgenden Dialog könnt ihr unter „Other“ den Punkt „Doxyfile“ wählen (wenn eclox installiert wurde). „Next“ anklicken, dann „Finish“.
      7. Doxygen-Projekt konfigurieren:
        Mache einen Doppelklick auf die neue Doxygen-Datei im Projekt-Explorer. Dort unter „Add“ den aktuellen Dateipfad deines Projektes angeben, in dem sich die .c-Dateien befinden. Alle Einstellungen findest du auf diesem Bild:

        eClipse_doxysettings

        eClipse_doxysettings

      8. Jetzt wieder alles speichern und oben auf das große blaue „@“ klicken. Dort wirst du nach deiner Projekt-Doxydatei gefragt. Gib diese dort an. Jetzt wird die Doxygen-Doku erstellt. Herzlichen Glückwunsch! Du findest sie als index.html im Ausgabeverzeichnis von doxygen (hier: Projektordner/doxygen)
        Wenn das doxygen-Ausgabeverzeichnis im Eclipse-Projektordner liegt, solltest du im Projektexplorer den Pfad vom Build-Prozess ausschließen (Rechtklick ResourceConfigurations/ExcludeFromBuild/Select All)
      9. Projekt auf den AVR flashen:
        Wähle das Projekt durch einen Einfachklick im Projekt-Explorer hervor und drücke auf das grüne „AVR“-Symbol in der Menüleiste. Wenn du den Programmer korrekt eingestellt hast, wird das Projekt jetzt erfolgreich geflasht.

Viel Erfolg!

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind markiert *