Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tbs1-bo/ea_rpi_modul

Python Bibliothek für ein E/A-Modul für den RaspberryPi.
https://github.com/tbs1-bo/ea_rpi_modul

education hardware io python raspberrypi

Last synced: 26 days ago
JSON representation

Python Bibliothek für ein E/A-Modul für den RaspberryPi.

Awesome Lists containing this project

README 

        
ea_rpi_modul

============



Bei dem Projekt handelt es sich um eine Kombination aus einer Hardware 

(Eingabe-Ausgabe-Modul) bestehend aus zwei Tastern und drei LEDs sowie 

einer Python Bibliothek zur Ansteuerung der Hardware für den Raspberry Pi.



Informationen zur [Hardware](hardware) befinden sich auf der verlinkten Seite.

An dieser Stelle wird die Bibliothek zur Ansteuerung des Moduls genauer

beschrieben.



Installation

============



Das Modul befindet sich im Python-Package-Index (PyPi) unter dem Namen

[eapi](https://pypi.python.org/pypi/eapi). Es kann mit dem folgenden Befehl

auf dem Raspberry Pi installiert werden:



    sudo pip3 install eapi



Wenn die Installation nur lokal für einen User erfolgen soll, heißt der Befehl 



    pip3 install --user eapi



Upgrade

-------



Wenn die Bibliothek bereits installiert ist aber nur in einer älteren Version

vorliegt, kann sie mit dem folgenden Befehl auf den neuesten Stand gebracht werden.



    sudo pip3 install --upgrade eapi



Installation aus den Quellen

----------------------------



Die Quelltexte für das Paket liegen bei github und können auch direkt von dort

installiert werden:



    $ pip3 install git+https://github.com/tbs1-bo/ea_rpi_modul



Wer mit den Quelltexten arbeiten möchte, sollte das repository auschecken und

darüber das Paket selbst installieren.



    $ git clone https://github.com/tbs1-bo/ea_rpi_modul.git

    $ cd ea_rpi_modul

    $ python3 setup.py install



Wenn das Paket nur für den aktuellen Benutzer installiert werden soll, muss

die Option `--user` an `install` übergeben werden. Bei einer systemweiten

Installation muss der letzte Befehl mit `sudo` ausgeführt werden.



Klasse EAModul

==============



![Klassendiagramm (automatisch generiert mit pyreverse)](./klassendiagramm.png)



Die Klasse [EAModul](http://pythonhosted.org/eapi/classeapi_1_1hw_1_1EAModul.html)

dient der Ansteuerung des Moduls. Mit ihr können die Taster ausgelesen und die 

LEDs an- oder  bzw. ausgeschaltet werden.



Der folgende Quelltext demonstriert eine typische Verwendung der Klasse.



    from eapi.hw import EAModul         #0



    ea = EAModul(29, 31, 33, 35, 37)    #1

    ea.schalte_led(EAModul.LED_ROT, 1)  #2

    ea.schalte_led(EAModul.LED_ROT, 0)  #3

    

    if ea.taster_gedrueckt(0):          #4

        print("Taster 0 gedrückt")

        

    ea.cleanup()                        #5



**#0** Aus dem Modul `eapi.hw` wird die Klasse `EAModul` importiert, damit sie

in den folgenden Anweisungen verwendet werden kann.



**#1** Bei der Initialisierung müssen die auf dem RaspberryPi verwendeten PINs

angegeben werden: zuerst die beiden Pins für die Taster (29 und 31), es folgen 

drei Pins für die LEDs (33, 35 und 37).



**#2** Hier wird die rote LED erst ein-



**#3** ... und dann wieder ausgeschaltet.



**#4** Der Zustand des Tasters mit der Nummer 0 wird abgefragt. Die Taster

sind nummeriert (beginnend bei 0).



**#5** Mit der Methode `cleanup()` werden die Pins des Pi wieder auf den

Ausgangszustand zurückgesetzt.



Beispiel 2

----------



In einem weiteren Beispiel können wir sehen, wie man auf das Drücken eines

Tasters reagiert. Die rote und grüne LED blinken fortwährend im Wechsel. Wenn

man während des Programmablaufes irgendwann auf den Taster 1 drückt, beendet

sich das Programm. Über den Taster 0 kann die gelbe LED an- und beim

Loslassen des Tasters wieder ausgeschaltet werden.



    from eapi.hw import EAModul

    import time



    ea_modul = EAModul()                                     #1



    def taster0_gedrueckt(pin):                              #2

        global ea_modul

        ea_modul.schalte_led(EAModul.LED_GELB, ea_modul.taster_gedrueckt(0))



    ea_modul.taster_event_registrieren(0, taster0_gedrueckt) #3



    try:

        while not ea_modul.taster_gedrueckt(1):              #4

            ea_modul.schalte_led(EAModul.LED_ROT, 1)

            time.sleep(0.2)

            ea_modul.schalte_led(EAModul.LED_ROT, 0)

            time.sleep(0.2)



            ea_modul.schalte_led(EAModul.LED_GRUEN, 1)

            time.sleep(0.5)

            ea_modul.schalte_led(EAModul.LED_GRUEN, 0)

            time.sleep(0.2)



    except KeyboardInterrupt:

        ea_modul.cleanup()

    finally:

        ea_modul.cleanup()



**#1** Das Modul wird mit der Standardbeschaltung initialisiert, wenn 

keine Werte für die Pins angegeben werden. Hierbei sind

die PINs der Reihe nach an den Pins 29, 31, 33, 35 und 37 angeschlossen.



**#2** Es wird eine Methode deklariert, die  aufgerufen werden soll, 

sobald der Taster 0 gedrückt wird. Damit dies passiert, wird sie 

gleich dafür registriert.



**#3** Die Methode wird für den Taster 0 registriert und aufgerufen, sobald

der Taster gedrückt wird.



**#4** Der Taster wird in einer Schleife immer wieder abgefragt. Solange der

Taster zum Zeitpunkt der Abfrage nicht gedrückt ist, läuft die Schleife weiter.



Hilfe erhalten

--------------



Der Quelltext ist gut dokumentiert. Man kann sich die Hilfe der Klasse

`EAModul` innerhalb des Python Interpreters mit dem Befehl `help(EAModul)`

anzeigen lassen.



Auf der Kommandozeile unter Linux hilft der Befehl `pydoc3` weiter. Mit

`pydoc3 eapi.hw` wird die Dokumentation für das Modul angezeigt.



Unter Windows ist der Befehl `pydoc3` standardmäßig nicht vorhanden. Hier hilft

der Aufruf `python3 -m pydoc eapi.hw` weiter.



Eine HTML-Version der Dokumentation kann unter der Adresse

http://pythonhosted.org/eapi/ abgerufen werden.



Verwendung ohne Raspberry Pi

============================



Die Bibliothek ist für die Verwendung mit dem Raspberry Pi konzipiert. Wenn

jedoch kein Pi angeschlossen ist, wird eine Bibliothek mit Dummyfunktionen

geladen. Diese gibt für die Eingänge (Taster) zufällige Werte zurück. Bei

Ausgaben (LED) auf den Ausgängen erfolgt eine Textausgabe auf der Konsole.



Vernetzung

==========



Das EA-Modul ist netzwerkfähig und lässt sich über ein Netzwerk ansteuern. So

kann man die drei LEDs über einen UDP-Server im Netz leicht zugänglich

machen. Ein Erläuterung über das genaue Vorgehen befindet sich in der

Dokumentation des Moduls `eapi.net`. Sie kann mit `pydoc3 eapi.net` abgerufen

werden und ist 

[online](http://pythonhosted.org/eapi/namespaceeapi_1_1net.html) 

verfügbar.



Fehler oder Bugs

================



Du hast einen Fehler oder Bug gefunden? Dann erstelle bitte einen

Bugreport. Dafür musst du oben auf "Issues" und dann auf "New Issue"

klicken. Danach kannst du alle Details angeben.