DE102017116258B4 - Computer-Zeitschaltuhr - Google Patents
Computer-Zeitschaltuhr Download PDFInfo
- Publication number
- DE102017116258B4 DE102017116258B4 DE102017116258.5A DE102017116258A DE102017116258B4 DE 102017116258 B4 DE102017116258 B4 DE 102017116258B4 DE 102017116258 A DE102017116258 A DE 102017116258A DE 102017116258 B4 DE102017116258 B4 DE 102017116258B4
- Authority
- DE
- Germany
- Prior art keywords
- global
- ctypes
- self
- str
- media
- Prior art date
- Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
- Active
Links
Images
Classifications
-
- G—PHYSICS
- G04—HOROLOGY
- G04G—ELECTRONIC TIME-PIECES
- G04G15/00—Time-pieces comprising means to be operated at preselected times or after preselected time intervals
- G04G15/006—Time-pieces comprising means to be operated at preselected times or after preselected time intervals for operating at a number of different times
-
- G—PHYSICS
- G04—HOROLOGY
- G04C—ELECTROMECHANICAL CLOCKS OR WATCHES
- G04C23/00—Clocks with attached or built-in means operating any device at preselected times or after preselected time-intervals
- G04C23/14—Mechanisms continuously running to relate the operation(s) to the time of day
- G04C23/18—Mechanisms continuously running to relate the operation(s) to the time of day for operating one device at a number of different times
-
- G—PHYSICS
- G04—HOROLOGY
- G04G—ELECTRONIC TIME-PIECES
- G04G21/00—Input or output devices integrated in time-pieces
- G04G21/04—Input or output devices integrated in time-pieces using radio waves
-
- G—PHYSICS
- G08—SIGNALLING
- G08C—TRANSMISSION SYSTEMS FOR MEASURED VALUES, CONTROL OR SIMILAR SIGNALS
- G08C17/00—Arrangements for transmitting signals characterised by the use of a wireless electrical link
- G08C17/02—Arrangements for transmitting signals characterised by the use of a wireless electrical link using a radio link
Abstract
Elektronische Zeitschaltuhr (1.1, 1.2) bestehend aus einem Einplatinencomputer (7), einer USV-Platine mit Weitbereichsspannungseingang (8), einem Pegelwandler (6.2), einem Echtzeituhrmodul (4), Ein-/Ausgangsports bestehend aus einem 16-Bit Port-Expander und einer Treiberstufe (5.1, 5.2), einer 40-poligen Stift- und Buchsenleiste (2), einer I2C-Bus-Adressierung (A0, A1, A2) angeordnet auf einer Ein- und Ausgangsplatine (3), einer Funkantenne mit einem Funksender und einem Funkempfänger und einem DALI-Mastermodul (6.1), wobei die elektronische Zeitschaltuhr (1.1, 1.2) einen Wireless-Access-Point ausbildet, wobei die elektronische Zeitschaltuhr (1.1, 1.2) auf ein auf dem Einplatinencomputer (7) lauffähiges, auf einer Speichereinheit abgespeichertes, eigenes Betriebssystem zugreift, das die Grundfunktionen der elektronischen Zeitschaltuhr (1.1, 1.2) und die Zugriffe auf externe und interne Daten bereitstellt und eine eigene GUI bzw. ein Web-Interface aufweist, wobei die elektronische Zeitschaltuhr (1.1, 1.2) ein Gehäuse besitzt, das von zwei zusammensteckbaren Gehäuseschalen gebildet ist dadurch gekennzeichnet, dass eine der Gehäuseschalen auf einer HUT-Schiene angeordnet ist, wobei auf einer Ein- und Ausgangsplatine (3) innerhalb des Gehäuses fünfunddreißig Printklemmen (K1 bis K35) zur Bereitstellung von Ein- und Ausgängen, seriellen Schnittstellen und Busanschlüssen angeordnet sind und wobei das Gehäuse ein DIN-Hutschienenleergehäuse mit integriertem Schnappfuß ist und die Innenseiten des Gehäuses mit einem EMV-Schutzlack überzogen sind.
Description
- Zeitschaltuhren und insbesondere Schaltuhren sind Geräte, die zu festgelegten Zeiten einen elektrischen Kontakt ein- oder ausschalten. Diese Einschalt- und Ausschaltzeiten sind in der Regel individuell einstellbar.
- Es gibt diverse Ausführungen von Zeitschaltuhren, wie Tageszeitschaltuhren mit vierundzwanzigstündigen Zykluszeiten, bei denen die eingestellte(n) Schaltzeit(en) sich täglich wiederholen, Wochenschaltuhren mit unterschiedlichen Schaltzeiten für jeden Wochentag und Jahreszeitschaltuhren, bei welchen für jeden Kalendertag verschiedene Schaltzeiten eingestellt werden können.
- Es gibt diverse Arten von Zeitschaltuhren mit unterschiedlichen technischen Realisierungen. So sind elektromechanische Zeitschaltuhren bekannt, welche einen Elektromotor aufweisen, der eine Scheibe dreht und durch Eindrücken von Stiften werden ein oder mehrere Kontakte betätigt.
- Es sind weiterhin Zeitschaltuhren mit einem rein elektronischen/elektrischen Aufbau bekannt. Bei solchen Zeitschaltuhren ist zumeist ein Mikroprozessor vorhanden, der, über ein Display, das zur Visualisierung dient, und mittels Tasten, zur Bedienung einstellbar ist.
- Zeitschaltuhren sind in verschiedenen Bauformen bekannt, so zum Beispiel als Zwischenstecker mit geschalteter Schukosteckdose, als Zeitschaltuhren für den Verteilereinbau bzw. der Montage auf einer DIN-Hutschiene, als Zeitschaltuhren für den Fronteinbau in Schaltschränken oder Zeitschaltuhren zur Wandmontage.
- Weiterhin sind mikroprozessorgesteuerte Zeitschaltuhren bekannt, die batteriegestützt mit einem hochgenauen Quarz arbeiten, bzw. funkgesteuert mittels eines Zeitzeichensenders, dem sogenannten DCF77-Signal, von zentraler Stelle oder über ein GPS-Signal eingestellt werden.
- Außerdem sind Zeitschaltuhren mit externen Eingängen und mehreren Ausgängen bekannt, mittels welcher zusätzliche Funktionen, wie ein Ablauf-Timer, eine Schaltungsvorwahl oder eine Dauerschaltung, realisierbar sind.
- Die bekannten Schaltuhren werden in der Regel mittels Display und Tasten direkt am Gerät oder mit einem PC und Kabelverbindung oder mit einem Übertragungsgerät, z.B. über eine Infrarotschnittstelle zur Schaltuhr, mit Ethernet-Schnittstelle oder Powerline, an ein LAN angebunden oder über einem KNX-Bus programmiert.
- Weiterhin ist es bekannt mittels NFC, sogenannter „Near Field Communication“, drahtlos, zum Beispiel per Handy, eine Zeitschaltuhr zu programmieren. Hierbei werden die Daten per Induktionsprinzip, z. B. bei einer Frequenz von 13,56 MHz und einer max. Datenübertragungsrate von max. 424 kbit/s, von einem geeigneten Smartphone zur Schaltuhr, mit entsprechend verbautem Chip, übertragen.
- Die Nachteile der NFC-Technologie zur Programmierung einer Zeitschaltuhr mittels Smartphone sind, dass die Datenübertragung automatisch erfolgt, sobald ein elektromagnetisches Feld eines „Lese-Chips“ vom Smartphone erkannt wird. Daher ist nur bedingt eine kontrollierte Datenübertragung möglich. Außerdem erfolgt die Datenübertragung unverschlüsselt und die Reichweite der NFC-Technik ist auf den Nahbereich beschränkt.
Zur Datenübertragung muss mit dem Smartphone nahezu direkt bis an das elektronische Gerät herangegangen werden und es wird ein spezielles Programm, eine sogenannte APP, auf dem Smartphone zur Datenübertragung benötigt. Außerdem haben nicht alle Smartphones die NFC-Technologie integriert. - In den Veröffentlichungen „PiPS - der etwas andere π-Power-Switch“ (aufgerufen am 06.04.2018 über URL: http://pips.tgd-consulting.de/index.cgi), „PiPS-It! Management Software Release Notes“ (aufgerufen am 06.04.2018 über URL: http://www.tgd-consulting.de/ChangeLog-PiPSIt-ReleaseNotes.txt) und „Mehr-Kanal-Zeitschaltuhr (PIPS - Pi-Power Switch)“ (aufgerufen am 09.04.2018 über URL: https://www.raspberrypi.org/forums/viewtopic.php?t=72302) wird eine elektronische Vorrichtung vorgestellt, die über eine Weboberfläche gesteuert verschiedene elektrische Verbraucher über ein Relais-Modul ein- und abschalten kann. Zusätzlich können über eine Erweiterung auch Funksteckdosen über eine 433-MHz-Funkverbindung geschaltet werden. Diese Vorrichtung ist auch in der Lage, elektrische Verbraucher zeitgesteuert zu schalten.
- Nachteilig hierbei ist die Beschränkung auf das Ein- und Ausschalten von elektrischen Verbrauchern über angeschlossene Relais. Außerdem muss ein Netzwerk bereitgestellt werden, über das der Zugriff auf den PiPS erfolgt. Hierfür ist nachteilig zusätzliche Hardware, wie bspw. ein Router, notwendig.
- Die Veröffentlichung „HEIK, Andreas: WLAN-Accesspoint mit dem Raspberry Pi, 2013“ (aufgerufen am 09.04.2018 über URL: https://www-user.tu-chemnitz.de/~anhe/VORTRAG/RASPI_WLAN/raspi_wlan.pdf) erläutert eine Vorgehensweise, wie der Einplatinenrechner Raspberry Pi als WLAN-Accesspoint eingerichtet werden kann. Damit soll es WLAN-Nutzern ermöglicht werden über ihre Geräte ins Internet zu gelangen. Der WLAN-Accesspoint ist in der Lage, Geräten selbstständig IP-Adressen zu verteilen und automatisch zu verwalten. Darüber hinaus werden Möglichkeiten genannt, die Vorrichtung vor fremden Zugriff digital zu schützen.
- Nachteilig ist hierbei, dass der Raspberry Pi lediglich als Schnittstelle zwischen Internet und Benutzer fungiert. Eine bedienungsfreundliche Benutzeroberfläche zum Konfigurieren des Raspberry Pi's bzw. des Accesspoints wird nicht vorgestellt. Die Möglichkeit, den Raspberry Pi für weitere (Schalt-) Schnittstellen zu benutzen wird ebenfalls nicht offenbart und auch nicht in Betracht gezogen.
- Die Veröffentlichung „Benutzerhandbuch S.USV pi solutions, Olmatic GmbH, Nagold, Revision 2 15.03.2017“ (aufgerufen am 10.04.2018 über URL: https://www.s-usv.de/files/pdf/SUSV_Manual_Rev2_0_GER.pdf) offenbart eine sog. unterbrechungsfreie Stromversorgung (USV) für den Einplatinenrechner Raspberry Pi. Über einen Akku wird im Falle eines Stromausfalls der angeschlossene Raspberry Pi mit Spannung versorgt und kontrolliert heruntergefahren. Die USV besitzt zusätzlich eine Real Time Clock. Dieses Bauteil liefert ein Zeitsignal, welches auch bei einem Stromausfall bestehen bleibt. Dadurch kann die interne Uhr des Raspberry Pi's nach dem Start automatisch wieder neu gestellt werden. Außerdem ist es möglich, den angeschlossenen Einplatinenrechner zeitgesteuert an- und auszuschalten.
- Nachteilig bei dieser Vorrichtung ist, dass einerseits das Zeitsignal von der Real Time Clock nur gehalten und nicht selbstständig eingestellt wird. Eine Synchronisation muss über ein angeschlossenes Netzwerk oder manuell erfolgen. Außerdem erkennt die USV keine Dauerschleife seitens eines Programms, welches den angeschlossenen Raspberry Pi lahm legt. Ein Neustart kann nur zeitgesteuert durchgeführt werden.
- Die Veröffentlichung „Communication in building automation, Siemens Switzerland, 2014" (aufgerufen am 10.04.2018 über URL: http://www.siemens.com/bt/file?soi=A6V10209534) liefert eine Übersicht über die möglichen Protokolle zur Maschinenkommunikation im Rahmen der Heimautomation. Die Beschreibung stammt von der Firma Siemens und stellt neben den Protokollen gleich dazugehörige Hardware von Siemens vor.
- Nachteilig bei den vorgestellten Soft- und Hardwarelösungen ist, dass die unterschiedlichen Protokolle nicht direkt kompatibel zueinander sind. Eine unmittelbare Kommunikation zwischen bspw. KNX und DALI ist nicht vorgesehen und eine Lösung wird nicht in Aussicht gestellt. Eine kabellose Hardwarelösung mittels WLAN ist ebenfalls nicht vorgesehen. Eine Kabelanbindung für sämtliche Sensoren und Aktoren ist aufwändig und teuer.
- Die weiteren Nachteile der bekannten Zeitschaltuhren liegen in der nicht vorhandenen oder begrenzten Erweiterungsmöglichkeit der Geräte. Ein Nutzer einer solchen Zeitschaltuhr muss sich in der Regel bereits im Vorfeld Gedanken machen, wie viele Schaltkanäle er maximal benötigt.
- Aufgabe der vorliegenden Erfindung ist es eine elektronische Zeitschaltuhr mit mehreren Ein- und Ausgängen, sowie vielfältiger Erweiterungsmöglichkeiten, insbesondere für den Verteilereinbau, aufzuzeigen, die einfach bedienbar und programmierbar ist.
- Diese Aufgabe wird mit den Merkmalen des Patentanspruches 1 gelöst. In den abhängigen Patentansprüchen sind Weiterbildungen im Detail angegeben.
- Die erfindungsgemäße elektronische Zeitschaltuhr bietet flexible Einsatzmöglichkeiten und kann vielfältig über serielle Schnittstellen, wie z. B. I2C, UART, SPI oder USB, erweitert werden, so dass aus der elektronischen Zeitschaltuhr ein vollwertiges Automatisierungssystem gebildet werden kann. Die Ausbaumöglichkeiten der elektronischen Zeitschaltuhr sind nur von den Topologien der seriellen Schnittstellen her begrenzt.
- Das Hauptmerkmal der erfindungsgemäßen elektronischen Zeitschaltuhr richtet sich auf die Bedienung und Programmierung durch beliebige WIFI-fähige Geräte und einem Webbrowser. Auf den Bedienungsgeräten wird keine zusätzliche Software bzw. Applikation oder APP zur Datenübertragung bzw. Programmierung der elektronischen Zeitschaltuhr benötigt.
- Es wird keine zusätzliche Hardware, wie Übertragungs- oder Schnittstellengeräte, wie z.B. ein LAN-Modul, ein Powerline-Adapter, ein Router, etc., zur Bedienung und Programmierung der elektronischen Zeitschaltuhr benötigt. Es ist lediglich ein bedienbares WIFI-fähiges Endgerät mit einem Webbrowser erforderlich.
- Die elektronische Zeitschaltuhr wird als wireless Access-Point betrieben. Die Verbindungen der angemeldeten Clients erfolgen über WLAN mit WPA2-Verschlüsselung. Die elektronische Zeitschaltuhr vergibt in ihrer Funktion als DHCP-Server IP-Adressen an die Clients. Die Zugangsdaten und Netzwerkeinstellungen für das WLAN der elektronischen Zeitschaltuhr können vom Nutzer bzw. Administrator festgelegt werden.
- Der Zugriff auf den Webserver der elektronischen Zeitschaltuhr ist zusätzlich passwortgeschützt. Es können separate Oberflächen, sogenannte GUIs, für den Nutzer und/oder dem Bediener der elektronischen Zeitschaltuhr programmiert werden.
- Bei Bedarf kann aus der Ferne über das Internet durch Verbindung zu einem Router mit VPN-Funktion die Programmierung, Konfiguration oder Bedienung erfolgen, vorausgesetzt, dass die elektronische Zeitschaltuhr im Netzwerk des Routers integriert ist.
- Die elektronische Zeitschaltuhr wird mit einem Einplatinencomputer realisiert, der einen Mikroprozessor bzw. eine Mikrocomputereinheit aufweist, auf dem bzw. der ein eigenes Betriebssystem installiert ist und läuft.
- Der Zugang zum Betriebssystem, das eine eigene GUI besitzt, kann durch eine sichere SSH-Verbindung (Secure Shell) erfolgen. Mittels der GUI oder aber durch einen Fernzugriff kann, via Fernwartung der elektronischen Zeitschaltuhr, eine sichere SSH-Verbindung (Secure Shell) erfolgen. Dabei wird von einem beliebig entfernten PC oder Computer oder einer Computereinheit eine verschlüsselte Verbindung durch Authentifizierung bzw. Anmeldung zur elektronischen Zeitschaltuhr aufgebaut. Als Computereinheit ist ein jedes Gerät zu verstehen, das eine Eingabeeinheit und einen Mikrocomputer besitzt und eine Verbindung zu einem Netzwerk herstellen bzw. aufbauen kann. So fällt hierunter auch ein Smartphone oder eine Spielekonsole.
- Der Vorteil der vorbeschriebenen Ausgestaltung liegt darin, dass keine lokalen Peripheriegeräte wie Tastatur, Mouse oder Monitor an die elektronische Zeitschaltuhr angeschlossen werden müssen.
- Wesentliche Merkmale, Anschlussmöglichkeiten und Vorteile der elektronischen Zeitschaltuhr werden nachfolgend aufgezeigt.
- Die elektronische Zeitschaltuhr in der vorgenannten Ausgestaltung ist in der Dimensionierung auf genormten DIN-Hutschienengehäuse mit einer Breite von sechs Platzeinheiten für den Verteilereinbau, zum Einbau in Bedienanlagen oder in Steuerpulten auf fünfunddreißig Millimeter breiten Tragschienen oder DIN-Schienen konzipiert.
- Die elektronische Zeitschaltuhr besitzt einen Einplatinencomputer mit lüfterloser CPU, vorzugsweise einen embedded Einplatinencomputer, der für einen Dauerbetrieb ausgelegt ist. Es sind vorteilhaft keine rotierenden Teile vorhanden.
- Die elektronische Zeitschaltuhr entspricht der CE-Kennzeichnung und weist alle erforderlichen Elemente auf.
- Die elektronische Zeitschaltuhr weist eine hohe Sicherheit während des Betriebes auf, da kein Schutz gegen direktes Berühren erforderlich ist.
- Die an der elektronischen Zeitschaltuhr höchste anzulegende Spannung beträgt vierundzwanzig Volt Gleichspannung, entsprechend dem allgemeinen Industriestandard in der Automatisierungstechnik oder die bei Maschinensteuerungen üblicherweise zur Anwendung kommt.
- Die elektronische Zeitschaltuhr besitzt eine USV-Platine mit einem Weitbereichsspannungseingang und einem Pegelwandler.
- Die Versorgung mit elektrischer Energie erfolgt durch ein externes Netzteil, das vorzugsweise ein Hutschienen-Netzteil mit vierundzwanzig Volt Gleichspannung und mit Potentialtrennung, einem SELV gemäß EN 60950, ist. Die Niederspannungsrichtlinie für elektrische Geräte kommt daher nicht zum Tragen. Es besteht die Möglichkeit externe Koppelrelais oder Schütze beliebiger Hersteller mit vierundzwanzig Volt Steuerspannung, direkt an die Ausgänge der elektronischen Zeitschaltuhr anzuschließen und damit elektrische Verbraucher zu schalten bzw. anzusteuern.
- Es sind keine Relais innerhalb der elektronischen Zeitschaltuhr verbaut, daher kann mit einer längeren Lebenszeit der elektronischen Zeitschaltuhr gerechnet werden und auch die Störfestigkeit wird dadurch erhöht.
- Es sind Kabel mit einem Leitungsquerschnitt bis zu 2,5 mm2 anschließbar.
- Durch den Anschluss von Koppelrelais an Ein- und Ausgängen erfolgt eine Einhaltung der sicheren elektrischen Trennung (gegenseitige Trennung von elektrischen Stromkreisen durch räumliche Trennung).
- Es sind Anschlussmöglichkeiten von externen manuellen und automatischen Impulsgebern als Schalter, Taster oder Schaltgeräte mit potentialfreien Kontakt vorgesehen, die direkt anschließbar sind und einen Wechselkontakt bzw. Schliesserkontakt realisieren.
- Potentialbehaftete Kontakte werden mit Koppelrelais bzw. elektromechanischen Relais mit Wechsel- bzw. Schliesserkontakt angeschlossen.
- Es ist eine leichte, verständliche und individuell veränderbare Oberfläche für die Bedienung der elektronischen Zeitschaltuhr vorgesehen. Die gesamten Programmierungen und Einstellungen können durch den Errichter bzw. Nutzer oder Bediener der elektronischen Zeitschaltuhr, sofern das notwendige Wissen vorhanden ist, individuell und bei Bedarf verändert, ergänzt, verbessert oder erweitert werden.
- An der elektronischen Zeitschaltuhr sind keine Bedientasten und kein Display vorhanden, da sämtliche Einstellungen über ein bedienbares WIFI-fähiges Endgerät mit Webbrowser oder durch einen Computer getätigt werden. Somit ist auch eine „Manipulation“ der Einstellungen lokal nicht möglich.
- Serienmäßig ist das Linux Betriebssystem „Raspian Jessie“ auf der elektronischen Zeitschaltuhr vorinstalliert, der vollständige Kernel kann jederzeit angepasst werden.
- Durch die freie Verfügbarkeit mit Veröffentlichung des vollständigen Sourcecodes entstehen unbegrenzt viele Möglichkeiten zur softwaretechnischen Weiterentwicklung der elektronischen Zeitschaltuhr.
- Es entstehen keine weiteren Kosten für das LINUX Betriebssystem und somit für Einsatzzwecke. Das Multiuser-Betriebssystem bietet alle Funktionalität, die man von einem modernen Betriebssystem erwartet, nämlich echtes Multitasking, dynamisch nachladbare Bibliotheken, u.a. für Programmiersprachen, Speicherverwaltung, grafische Bediener-Oberfläche, Emaildienst, usw.. Dies eröffnet vielseitige Einsatzgebiete für die elektronische Zeitschaltuhr, z.B. zur Lichtsteuerung, Sonnenschutzsteuerung, Zeiterfassungssystem, etc..
- Die vorinstallierten Dienste und Konfigurationen des Betriebssystems, z.B. W-LAN-Accesspoint, Respawn-Service, vorinstallierter Webserver Lighttpd, Voreinstellungen der Echtzeituhr, der Real Time Clock oder kurz RTC und des optional anschließbaren GPS-Empfängers zur Uhrzeitsynchronisierung, Vorinstallation eines Gammu SMS Daemon, SSMTP-Dienstes, Watchdog-Dienst, Programmiersprachen wie Python, PHP und Java Script, einschließlich fertig programmierter Webseiten und Scripte, Vorkonfiguration der Rechteeinstellungen für bestimmte Dateien unter Linux, usw., Anschlussmöglichkeit eines externen GPS-Empfängers mit 3,3V Betriebsspannung an eine UART-Schnittstelle und eine der elektronischen Zeitschaltuhr zur automatischen Zeit- und Datumseinstellung, z.B. bei Sommer-/Winterzeitumstellung dienende Schnittstelle und weitere serielle Schnittstellen sind vorhanden.
- Es besteht die Möglichkeit des Anschlusses von diversen Sensoren, wie z.B. 1-wire Sensoren, eines Funk-Sendemoduls, wie z. B. 433 oder 868 oder 915 MHz zur Ansteuerung von Funk-Schaltaktoren, wie z. B. Enocean, Z-Wave Controller, oder eines KNX-Moduls zur Kommunikation mit dem KNX-Bus, SPI-Schnittstelle, z.B. nutzbar als Brücke zum CAN-BUS, I2C-Schnittstelle, z.B. zur Erweiterung von Ein- und Ausgängen, USB-Port-Anschlüsse, z.B. zur Speichererweiterung, etc..
- Die elektronische Zeitschaltuhr besitzt eine verhältnismäßig große Rechenleistung und Speicherkapazität gegenüber microcontroller-basierten Lösungen. Es ist eine Ethernet-Schnittstelle, vorteilhaft als Netzwerk-Schnittstelle, eine Bluetooth-Kommunikation und eine WLAN-Kommunikation als Accesspoint-Modus vorhanden. Durch die WLAN-Kommunikation mittels Accesspoint ist die elektronische Zeitschaltuhr auch ohne Verbindung zu einem Router- und Internetanschluss einsetzbar.
- Es ist ein HDMI-Anschluss zur Ausgabe von Bild- und/oder Tonsignalen an externe Geräte vorhanden.
- Es besteht außerdem die Möglichkeit Status-Emails zu versenden, sofern eine Internetverbindung hergestellt ist. Außerdem besteht weiterhin die Möglichkeit Status-SMS zu versenden, sofern ein UMTS-Surfstick mit einer freigeschalteten SIM-Karte angeschlossen ist.
- Leuchten mit DALI-Schnittstelle bzw. DALI-Betriebsgeräte sind automatisch, zeitabhängig oder manuell per Web-Interface oder mit externen Tastern schaltbar oder dimmbar, und es ist eine automatische und/oder manuelle Lichtszenenauswahl möglich.
- Die Anbindung an den DALI-Bus, einem sogenannten Digital Addressable Lighting Interface, findet direkt, d.h. ohne zusätzliche externe Schnittstellen-Umsetzer oder Gateways als DALI-Mastergerät statt.
- Es sind zwei Schalteingänge zur sofortigen Nutzung für das Schalten und Dimmen von DALI-Betriebsgeräten durch Anschluss von herkömmlichen Tastern mit Schliesserkontakt vorhanden.
- Das Betriebssystem, das vorzugsweise auf dem Linux-Dateisystem beruht, einschließlich sämtlicher Software, befindet sich auf einem extern angeschlossenen USB-Stick, der als Micro-USB-Stick ausgestaltet ist, so dass Funktionsänderungen durch Anschluss eines anderen Speichersticks jederzeit einfach und unkompliziert durchgeführt werden können.
- Für die gesamte Software auf dem USB-Stick kann auch auf anderen Datenträgern ein Backup erstellt werden. Der Bootloader bzw. die Bootumgebung befinden sich ebenfalls auf dem USB-Stick oder auf einer Micro SD-Karte nach Industriestandard. Diese ist für einen erweiterten Temperaturbereich und einer hohen Anzahl von Lese-/Schreibzyklen ausgelegt.
- Es besteht die Möglichkeit, mehrere elektronische Zeitschaltuhren zur bidirektionalen Kommunikation, z.B. zum Einsatz als Master-Slave-Betrieb, durch Implementierung eines Websocket-Protokolls im Webbrowser zu betreiben.
- Die universell einsetzbare elektronische Zeitschaltuhr kann durch verschiedene Programmierungen für unterschiedlichste Problemlösungen dienen, so z.B. zum Einsatz als Stempeluhr, als Betriebsstundenzähler, als Jalousie- oder Heizungssteuerung, zur Lichtsteuerung usw..
- Die universell einsetzbare elektronische Zeitschaltuhr kann außerdem als Wecker genutzt werden, zeitgesteuert oder manuell. Via eines oder mehrerer angeschlossener Taster und eines implementierten, fernsteuerbaren Multimediaplayers, bezeichnet als VLC-Player, können Audio- und/oder Videosignale manuell oder auch zeitgesteuert über die HDMI-Schnittstelle ausgeben werden.
- Die universell einsetzbare elektronische Zeitschaltuhr kann weiterhin mit externen WIFI-Microcontrollern, wie z.B. dem ESP 8266 Chip, über WLAN kommunizieren und dadurch alle WIFIbasierten elektronischen Schaltungen kabellos über das WLAN der elektronischen Zeitschaltuhr, bei Bedarf weltweit, fernsteuern. Beispielsweise können WIFI-Relais als Clients im Netzwerk der universell einsetzbaren elektronischen Zeitschaltuhr oder eines beliebigen anderen externen Netzwerkes, mit dem die universell einsetzbare elektronische Zeitschaltuhr zusätzlich verbunden ist, gegebenenfalls auch über VPN, somit auch weltweit drahtlos von zentraler Stelle aus, angesteuert werden. Es wird lediglich eine lokale Spannungsversorgung, z.B. 230V AC, für den Betrieb der WIFIbasierten elektronischen Schaltung benötigt.
- Die nachfolgend genannten elektronischen Bauteile/Einzelbaugruppen ergeben im Verbund mit einer entsprechenden Software eine professionelle elektronische Zeitschaltuhr als Schaltzentrale.
- Die erfindungsgemäße elektronische Zeitschaltuhr besteht aus einem Einplatinencomputer, der auf einer Platine angeordnet ist, wobei zusätzlich ein Echtzeituhrmodul, Eingangs- und Ausgangsports, eine Funkantenne mit einem Funksender und einem Funkempfänger und einem DALI-Mastermodul angeordnet sind. Die elektronische Zeitschaltuhr ist als wireless Hotspot bzw. Access-Point betreibbar. Damit kann die elektronische Zeitschaltuhr, da sie selbst einen wireless Access-Point ausbildet, von einem Gerät, das auf den wireless Access-Point zugreifen kann, gesteuert und eingestellt werden.
- Ein wireless Access-Point ist ein drahtloser Zugangspunkt für z. B. ein Netzwerk. Man bezeichnet einen wireless Access-Point auch als Hotspot oder auch als Basisstation. Ein wireless Access-Point dient als Schnittstelle für kabellose Kommunikationsgeräte. Endgeräte stellen per W-LAN eine Funkverbindung zum wireless Access Point her, der z. B. mit einem fest installierten Kommunikationsnetz verbunden sein kann. Es ist üblich, dass wireless Access-Points mobile Endgeräte mit eingebautem wireless Adapter über WIFI, auch als WLAN bezeichnet, Local Area Network, kurz mit LAN bezeichnet, oder einem anderen kabelgebundenen Datennetz verbinden.
Ein wireless Access Point kann zudem im sogenannten Ad-hoc-Modus als zentrale Schnittstelle zwischen mehreren Endgeräten eingesetzt werden. Auf diese Weise können Geräte, die kabellos miteinander verbunden werden, miteinander kommunizieren. - Vorteilhaft nach Patentanspruch 2 ist, dass die elektronische Zeitschaltuhr via WLAN mit WPA2-Verschlüsselung kommuniziert und als DHCP-Server IP-Adressen für Clients vergibt. Damit kann die elektronische Zeitschaltuhr auf bekannte Kommunikationsprotokolle und Verschlüsselungen zugreifen, wobei der Zugriff auf den wireless Access-Point entsprechend geschützt ist.
- Weiterhin ist vorgesehen, dass die elektronische Zeitschaltuhr auf ein auf dem Einplatinencomputer lauffähiges, auf einer Speichereinheit abgespeichertes, eigenes Betriebssystem zugreift, das die Grundfunktionen der elektronischen Zeitschaltuhr und die Zugriffe auf externe und interne Daten bereitstellt und eine eigene GUI bzw. ein eigenes Web-Interface besitzt. Damit ist die elektronische Zeitschaltuhr ein eigenes Rechnersystem, das autark lauffähig ist und für externe mobile Geräte, die über den wireless Access-Point zugreifen, für diese eine eigene Benutzeroberfläche generiert und zugleich die erforderlichen Funktionen bereitstellt.
- Vorteilhaft nach Patentanspruch 3 ist, dass die elektronische Zeitschaltuhr mindestens eine UART-Schnittstelle und/oder mindestens eine ISP-Schnittstelle und/oder eine Schnittstelle zum Anschluss eines GPS-Empfängers, und/oder eine Schnittstelle zum Anschluss eines Funksende/-empfangsmoduls, und/oder eine KNX-Busschnittstelle und/oder eine I2C-Busschnittstelle und/oder eine CAN-Busschnittstelle und/oder mindestens einen USB-Port-Anschluss zur Speichererweiterung und/oder eine HDMI-Schnittstelle aufweist. Damit sind verschiedenste elektrische bzw. elektronische Komponenten anschließbar.
- Weiterhin ist vorgesehen, dass die elektronische Zeitschaltuhr ein Gehäuse besitzt, das von zwei zusammensteckbaren Gehäuseschalen gebildet wird, wobei eine der Gehäuseschalen auf eine DIN-HUT-Schiene anordenbar ist. Damit ist die elektronische Zeitschaltuhr gekapselt und geschützt und kann als Einheit auf ein HUT-Schienensystem aufgesteckt werden und auch in bestehende Anlagen integriert werden.
- Vorteilhaft nach Patentanspruch 4 ist, dass der Einplatinencomputer als Mastergerät betreibbar ist. Damit können weitere Geräte als Slaves drahtgebunden angeschlossen oder per WIFI angesteuert werden und der Einplatinencomputer ist die zentrale Steuereinheit für Zugriffe auf den wireless Access Point.
- In einer vorteilhaften Ausgestaltung der Erfindung nach Patentanspruch 5 ist vorgesehen, dass der Einplatinencomputer als embedded System realisiert ist.
- Weiterhin ist vorgesehen, dass am Gehäuse fünfunddreißig Anschlüsse über Printklemmen angeordnet sind.
- Vorteilhaft nach Patentanspruch 6 ist, dass die elektronische Zeitschaltuhr einen Hardware Watchdog sowie einen Respawn als Dienst zur permanenten System- und Prozessüberwachung vorweist. Damit kann nach einem Systemfehler die elektronische Zeitschaltuhr autonom und ohne extern ausgelösten Neustart reaktiviert werden.
- Weiterhin ist vorgesehen, dass das Gehäuse ein DIN-Hutschienenleergehäuse mit integrierten Schnappfuß ist und die Innenseiten des Gehäuses mit EMV-Schutzlack überzogen sind. Damit kann das Gehäuse auf ein HUT-Schienensystem aufgebracht werden. Durch den EMV-Schutzlack wird eine Verbesserung der Abschirmung vor elektronischer Strahlung, sowohl von als auch zu den Bauteilen, Baugruppen der elektronischen Zeitschaltuhr erzielt.
- Vorteilhaft nach Patentanspruch 7 ist, dass von der elektronischen Zeitschaltuhr als DALI-Master autonom DALI-Betriebsgeräte zeitsteuerbar sind und/oder diese manuell via angeschlossene Taster ansteuerbar sind, wobei die Anzahl von DALI-Kanälen der elektronischen Zeitschaltuhr erweiterbar sind. Diese sind an der elektronischen Zeitschaltuhr anordenbar. Die elektronische Zeitschaltuhr ist entsprechend erweiterbar.
- Vorteilhaft nach Patentanspruch 8 ist, dass durch die elektronische Zeitschaltuhr herkömmliche Fernschalter ersetzen kann. So können Stromstoßschalter, Treppenlichtschalter und alle Arten von Multifunktionsrelais von der elektronischen Zeitschaltuhr ersetzt werden. Hierzu sind an den Eingängen Taster mit Öffner-, Schliesser oder Wechselkontakten und an den Ausgängen Solid-State-Relais und/oder halbelektronische bistabile Relais und/oder Schütze mit - jeweils - 24 V DC-Versorgungsspannung anzuschließen.
- Vorteilhaft nach Patentanspruch 9 ist, dass durch die elektronische Zeitschaltuhr durch Anschluss von einem oder mehreren Tastern mit Öffner-, Schliesser- oder Wechselkontakten manuell, oder durch Zeitfunktionen automatisch, Audio- und/oder Videosignale über einen HDMI-Ausgang zu- oder abschaltbar sind, wobei die auszugebende Lautstärke regulierbar und/oder die Bedienfunktionen eines in der elektronischen Zeitschaltuhr implementierten Multimediaplayers bereitstellbar sind. Diese Funktionen sind von der elektronischen Zeitschaltuhr bereitstellbar und es muss kein Bediengerät, wie etwa ein PC oder Smartphone vorhanden sein. Auf diese Weise kann ein Zu- und/oder Abschalten eines Audiostreams, beispielsweise als Internet-Radio Stream, eines Videostreams, in einem Netzwerk oder einer auf der elektronischen Zeitschaltuhr gespeicherten Audio- oder Videodatei, etc. erfolgen. Sämtliche weiteren Funktionen, wie z. B. Pause, nächster oder vorhergehender Titel, Sprungmarken, usw. können mit an der elektronischen Zeitschaltuhr angeschlossenen Tastern ausgeführt bzw. initiiert werden.
- Vorteilhaft nach Patentanspruch 10 ist, dass die elektronische Zeitschaltuhr mit externen Geräten via WIFI kommuniziert. Hierzu können WIFI-basierte Mikrokontroller, wie z. B. der ESP 8266 Chip im W-LAN Netzwerk der elektronischen Zeitschaltuhr betrieben werden. So kann autonom mittels verschiedener Nachrichtenprotokolle, wie z. B. dem MQTT-Protokoll, interaktiv kommuniziert werden. Ein in der elektronischen Zeitschaltuhr integrierter MQTT-Server, der sogenannte Broker, überträgt ein MQTT-Protokoll zu einem WIFI Mikrokontroller Chip, der als Consumer / Client eingerichtet ist und an dem zusätzlich ein Relais, ein Sensor, etc. angeschlossen ist.
- Sämtliche in den Anmeldeunterlagen offenbarten Merkmale werden als erfindungswesentlich beansprucht, sofern sie einzeln und/oder in Kombination gegenüber dem Stand der Technik neu sind.
- Die nachfolgende Beschreibung der Erfindung anhand eines konkreten Ausführungsbeispiels anhand der Figur stellt keine Limitierung der Erfindung auf dieses konkrete Ausführungsbeispiel dar.
- Es zeigen die Figuren
1 und2 den schematischen Aufbau einer elektronischen Zeitschaltuhr. Es werden nachfolgend für gleiche Elemente gleiche Bezugszeichen verwendet, dies dient der einfacheren Verständlichkeit der nachfolgenden Beschreibung anhand der Figuren1 und2 . - Die Computer-Zeitschaltuhr
1.1 ,1.2 besteht aus einem Einplatinencomputer7 . Die Platine3 ist dem Einplatinencomputer7 und dem Weitbereichsspannungseingang8 von mindestens 24V Gleichspannung bzw. DC und der Erzeugung einer 5 VDC-Spannung für den Betrieb des Einplatinencomputers7 über eine Buchsenleiste2 und einer mehrpoligen Verbindungsleitung oder auch durch mehrere Einzelleitungen verbunden. Es ist ein Micro USB-Stick, der über eine entsprechende Anschlusseinheit angeschlossen ist,insbesondere einen externen Anschluss, angeschlossen und es ist eine Micro SD-Karte angeordnet, die in der Ausführung nach FIG intern verbaut ist und daher nicht dargestellt ist. - Weiterhin ist ein Pegelumsetzer/Pegelwandler
6.2 , ein sogenannter Level Shifter vorhanden, der eine bidirektionale Signalanpassung zwischen 3,3 V und 5 V DC (Gleichspannung)zwischen den Baupruppen durchführt. - Weiterhin ist ein Echtzeituhrmodul
4 , auch als RTC bezeichnet, vorhanden, das einen hochgenauen Quarz und eine I2C-Busschnittstelle besitzt, und entweder durch einen Akku oder eine Batterie gepuffert ist. - Weiterhin ist auf der Ein- und Ausgangsplatine
3 ein 16-Bit Port Expander5.1 mit einer I2C-Busschnittstelle, sowie einem Relais-Treiber5.2 jeweils als integrierte Schaltung, kurz als IC bezeichnet, verbaut. - Es ist ein DALI-Master Modul
6.1 mit Schalteingängen und I2C-Busschnittstelle vorhanden. - Weiterhin ist ein modifiziertes Universal DIN-Hutschienengehäuse mit in der Ausgestaltung nach FIG sechs Platzeinheiten vorhanden.
- Es ist außerdem eine externe Spannungsquelle, in der Ausgestaltung nach FIG als Netzteil mit einer 24V Gleichspannung und mindestens 2A (SELV) vorhanden.
- Weiterhin ist ein serieller Anschluss vorhanden. Über diesen seriellen Anschluss kann ein GPS-Empfänger an einer UART-Schnittstelle angeschlossen werden.
- Es ist außerdem ein optionaler Anschluss vorhanden, an den für den Fall, dass der Einplatinencomputer
7 einen UFL RP-SMA Anschluss besitzt, eine WLAN-Antenne für ein besseres Funknetz anschließbar ist. Der Anschluss ist am Gehäuseoberteil der elektronischen Zeitschaltuhr angebracht und wird durch eine Leitung mit dem Einplatinencomputer7 verbunden. - Es sind USB-Anschlüsse vorhanden, an den ein Ultra-Nano WLAN-Stick zur kabellosen Einbindung in ein bestehendes Netzwerk ankoppelbar ist.
- Für das Zusammenwirken der einzelnen elektronischen Bauteile und Baugruppen bzw. Schaltkreise dient der I2C-Bus. Dieser ist ein synchroner, serieller Zweitdrahtbus mit Master/Slave-Funktion. Die beiden Datenleitungen SCL (Taktleitung) und SDA (Datenleitung) dienen der Kommunikation. Die Busspannung beträgt 3,3 V DC oder 5 V DC, je nach verwendeter elektronischer Baugruppe und wird bei Bedarf mit einem Pegelwandler
6.2 , auch I2C-Level-Shifter bezeichnet, angepasst. - Damit jeder Busteilnehmer weiß, welche Befehle vom Master auszuführen sind, erhält jede kommunizierende Einheit mit einer solchen Schnittstelle eine physikalische Hardware-Adresse über die Anschlüsse
A0 ,A1 undA2 zugeteilt. Entweder die Adressen werden mittels Steckbrücken (Jumper) eingestellt oder sie sind bei einigen kommunizierenden Einheiten dort fest eingestellt. Manche I2C-Adressen von kommunizierenden Einheiten können auch per Software eingestellt werden. Die AnschlüsseA0 ,A1 undA2 nehmen wahlweise die Potentiale GND oder Masse oder OV, oder +3,3 V oder 5 V, je nach Anpassung, an. Die Busspannung aller Slaves, d. h. insbesondere der intern verbauten elektronische Baugruppen und Schaltkreise und des Einplatinencomputers7 muss gleich sein oder durch den Level Shifter angepasst sein. - Der Adressbereich vom I2C-Bus wird durch sieben Bit festgelegt, so dass insgesamt einhundertachtundzwanzig Adressen vorhanden sind. Dadurch, dass sechzehn Adressen für Sonderaufgaben reserviert sind, können theoretisch einhundertzwölf Busteilnehmer adressiert werden. Vom gleichen Typ einer integrierten Schaltung können natürlich weniger als einhundertzwölf Adressen vergeben werden, da jedes IC nur einen bestimmten Adressierungsbereich zur Verfügung stellt. Jede Hardware-Adresse darf nur einmal vergeben werden.
- Bei der Computerzeitschaltuhr
1.1 ,1.2 wird der Einplatinencomputer7 als Bus-Master verwendet. Die restlichen Baugruppen bzw. Bauteile werden als I2C-Slaves angesprochen. - Der Einplatinencomputer
7 besitzt Pullup-/Pulldown-Widerstände zur Pegelanpassung der GPIO's auf Busspannungsniveau. Diese sind bereits integriert. - Die Übertragungsrate erfolgt im Standard-Modus der elektronischen Zeitschaltuhr mit lOkbit/s (Taktfrequenz = 10kHz) in beide Richtungen, also bidirektional.
- Die Taktfrequenz vom I2C-Bus kann bei Bedarf auf maximal 400kHz, dem sogenannten Fast-Mode, durch Anpassung der sogenannten Datei „config.txt“ angehoben werden.
- Zum Einplatinencomputer
- Die am Markt befindlichen Rechner bzw. CPU's sind preisgünstig, leistungsfähig und inzwischen weit verbreitet. Der Einplatinencomputer
7 wird als eingebettetes System, sogenanntes Embedded System, verwendet und dient als zentrale Steuereinheit der restlichen Baugruppen und Bauteile. Der Rechner übernimmt Überwachungs-, Steuerungs- oder Regelfunktionen. Seine Größe beträgt max. LxBxH = 90mm x 56mm x20mm. Es werden nur Einplatinencomputer7 eingesetzt, die als Stand-Alone Gerät die CE-Kennzeichnung erhalten haben. Der Einplantinencomputer7 besteht aus den folgenden Baugruppen: - Rechenprozessor bzw. CPU, Taktgenerator, Festspeicher, sogenanntes ROM, flüchtiger Speicher, sogenannter RAM-Speicher, Micro-SD-Karten-Slot, auch mit SDHC bezeichnet, Grafikprozessor, auch mit GPU bezeichnet, Ein- und Ausgabe-Pins, auch als GPIOReset-Pins bezeichnet, die als frei programmierbare Schnittstellen realisiert sind, Kommunikationsschnittstellen in Form z. B. von LAN, WIFI, diese optional mit UFL-WLAN-Antennenbuchse zur Anschlussmöglichkeit von externen WLAN-Antennen, Bluetooth, USB, SATA, HDMI, Audioport, weitere Schnittstellen, wie z. B. CSI, DSI, I2S, analoger Audioausgang, Mikrofon-Eingang, UART, I2C, SPI, und mindestens einer Zustands-/Aktivitäts-LED.
- An sämtlichen GPIO-Anschlüssen können nur digitale Signale verarbeitet werden. Analoge Signale können durch den externen Anschluss von Analog/Digital- bzw. Digital/Analog-Wandlern an den seriellen Schnittstellen verarbeitet oder bereitgestellt werden.
- Durch die vorhandenen USB-Schnittstellen können zusätzliche Erweiterungen, wie z. B. ein zweites WLAN-Netzwerk über WIFI Micro-USB-Stick zur Verbindung an einen externen Router mit Internetanschluss und Anschluss eines externen Micro-USB-Speichers zur Speichererweiterung, realisiert werden. Der Anschluss eines externen GPS-Empfängers ist u.a. auch am USB möglich.
- Der Bootloader, die Software zur Geräteinitialisierung und zum Gerätestart, und das Dateisystem des Betriebssystems befinden sich auf einer Industrie Micro SD-Karte oder befinden sich direkt auf einem am Einplatinencomputer
7 angeschlossenen Micro USB-Speicher. - Der Einplatinencomputer
7 wird über einen integrierten Weitbereichsspannungseingang8 mit Erzeugung der 5 V Betriebsspannung betrieben. Dadurch ist eine externe Spannungsversorgung von 24V DC mit mindestens 2A in der Lage, nicht nur die gesamten elektronischen Baugruppen der elektronischen Zeitschaltuhr zu versorgen, sondern es können auch die extern angeschlossenen 24V DC Relais und/oder Schütze damit angesteuert werden. - Da die durchschnittlich gemessene Temperatur der CPU um die 60°C beträgt und laut Herstellerangaben die maximal zulässige Betriebstemperatur von ca. 80°C für die hier beschriebenen Anwendungen nicht ansatzweise erreicht wird, ist für den Dauereinsatz kein zusätzlicher passiver oder aktiver Kühlkörper erforderlich. Dauertests von mehreren Monaten haben keine negativen Beeinflussungen durch die im Gehäuse entstehende Wärme gezeigt. Durch die angewendeten Programmiertechniken hält sich die ständige Auslastung der CPU in Grenzen und daher kann die im Gehäuse entstehende Wärme als vernachlässigbar betrachtet werden.
- Ein weiterer Langzeitversuch von einem Jahr mit Einbau der Computer-Zeitschaltuhr in einem Schaltschrank im Außenbereich ist ebenfalls positiv verlaufen. Selbst beim Einsatz unter klimatisch schwierigen Bedingungen, wie bei Frost mit zweistelligen Minusgraden oder bei höherer Luftfeuchtigkeit, konnten keine Ausfallerscheinungen beobachtet werden.
- Der Einplatinencomputer
7 ist softwareseitig wie folgt konfiguriert und programmiert, damit ein Zusammenspiel aller elektronischen Baugruppen und eine Bedienung der Computer-Zeitschaltuhr1.1 ,1.2 über WIFI-fähige Endgeräte und einem Webbrowser die vorher beschriebenen Merkmale ermöglicht werden. - Installation des Betriebssystems Linux mit einer Shell
- Es erfolgt zunächst eine Installation von Open Source Entwicklungssoftware wie C/C++ und Skriptsprachen wie Python, PHP, Java Script, Texteditor mit IDE-Funktionalität, usw..
- Sodann erfolgt das Laden und Aktivieren der I2C-Treiber und aller erforderlichen Bibliotheken in den Kernel der CPU bzw. des Einplatinencomputers
7 . Anschließend erfolgt die Installation eines Webservers und die Installation von Software wie PHP und CGI, eines SSMTP Tools zum Versenden von Emails vom Webserver aus. Anschließend erfolgt die Installation eines Gammu SMS Daemon als Hintergrundprozess zum Senden von SMS-Nachrichten. Es erfolgt sodann die Konfiguration des Einplatinencomputers7 als WLAN-Router im Accesspoint-Modus. - Konfiguration der Echtzeituhr
- Es erfolgt eine Einrichtung eines Hardware Watchdog-Dienstes zur permanenten Systemüberwachung für den 24-Stunden Betrieb. Das System wird automatisch neu gestartet, wenn eine Störung vorliegt bzw. das System nicht mehr ordnungsgemäß funktioniert. Weiterhin erfolgt die Einrichtung eines Respawn-Hintergrunddienstes für die permanente Laufzeit-Überwachung des Haupt Python-Scripes „i2c-ein-ausgänge.py“.
- Die erforderlichen Einstellungen sind unter anderem vom eingesetzten Einplatinencomputer
7 abhängig und können daher entsprechend variieren. - USV-Platine mit Weitbereichsspannungseingang
- Es ist eine USV-Platine
8 mit einem Weitbereichsspannungseingang von mindestens 5V/12V/24V DC und Erzeugung einer 5 Volt Gleichspannung für den Betrieb des Einplatinencomputers7 vorhanden. - Aus Optimierungsgründen erledigt diese Funktion eine passend auf den GPIO-Port
9 vom Einplatinencomputer7 aufsteckbare USV-Platine8 im Wide-Range-Modus, eine sogenannte Schaltregler-Lösung. Es werden nur USV-Platinen eingesetzt, die eine CE-Kennzeichnung im Stand-A-Lone Betrieb erhalten haben. - Der GPIO-Port
9 vom Einplatinencomputer7 wird dabei von der USV-Platine8 durchgeleitet, so dass alle GPIO-Pins uneingeschränkt weiter zur Verfügung stehen. Die USV-Funktion wird bei der Computer-Zeitschaltuhr1.1 ,1.2 nicht genutzt, da ein Spannungsausfall den Ausnahmefall darstellt und sich die gesamte Software bei einem Datenverlust, auf einen extern zugänglichen Micro USB-Stick befindet, und somit leicht ein Software-Backup zurückgespielt werden kann. - Es wird davon ausgegangen, dass vor einem nicht vorhersehbaren eintretenden Spannungsausfall vorab eine Sicherungskopie der Software auf einen weiteren Micro USB-Stick erstellt wurde.
- Vor der Erstinbetriebnahme der Computer-Zeitschaltuhr
1.1 ,1.2 sollte eine Sicherungskopie vom voreingestellten Betriebssystem einschließlich sämtlicher Programmierungen erstellt werden. - Sollte es auf Grund unglücklicher Umstände dennoch zu einem Datenverlust, zur Beschädigung des Betriebssystems oder zur Zerstörung des am Einplatinencomputer
7 angeschlossenen Micro USB-Stick durch einen Spannungsausfall oder anderer Umstände gekommen sein, so kann innerhalb kurzer Zeit der zweite Micro USB-Stick mit der Sicherungskopie angeschlossen werden und die Computer-Zeitschaltuhr1.1 ,1.2 funktioniert wieder. - Micro-USB Stick und Micro-SD Karte
- Die Auslagerung des kompletten Betriebssystems und Software auf einen Micro USB-Stick hat für die Lebensdauer der Computer-Zeitschaltuhr
1.1 ,1.2 einen erheblichen Vorteil. USB-Speicher haben heutzutage eine relativ große Speicherkapazität, eine hohe Anzahl an Schreib- und Lesezyklen, die Lese- und Schreibgeschwindigkeit ist für die Anwendung als Zeitschaltuhr schnell genug und sie sind hinsichtlich der Speicherkapazität günstig zu erwerben. Die zur Zeit am Markt kleinsten USB-Speicher, Micro USB-Sticks, haben gerade mal eine Abmessung von ca. 20x15x7mm bei einem Gewicht von ca. 2 Gramm. Ein solcher USB-Speicher ist optimal zur Speicherung von Bootloader, Betriebssystem und der gesamten Software der Computer-Zeitschaltuhr1.1 ,1.2 geeignet, da in vielen Schaltschränken nicht immer ausreichend Platz für den Einbau weiterer Geräte zur Verfügung steht. Im eingesteckten Zustand wird gerade mal eine halbe Teilungseinheit an zusätzlichem Platz zur Gehäusebreite von sechs Platzeinheiten der Computer-Zeitschaltuhr1.1 ,1.2 benötigt. - Pegelumsetzer/Pegelwandler (Level Shifter)
- Durch den intern verbauten Pegelwandler
6.2 für den I2C-Bus können Erweiterungsbaugruppen nicht nur mit 3,3V DC, sondern auch mit 5 V DC Betriebsspannung am I2C-Bus vom Einplatinencomputer7 angeschlossen werden. Die Kommunikation über den Pegelwandler6.2 erfolgt bidirektional. Durch die Bereitstellung von zwei Spannungsebenen ist eine breitere Anschlussvielfalt von digitalen Schaltkreisen am Einplatinencomputer7 gewährleistet. - Echtzeituhr (RTC) mit I2C-Busschnittstelle
- Eine Zeitschaltuhr benötigt immer die richtige Zeit. Damit diese auch nach Ausfall der Versorgungsspannung der Zeitschaltuhr weiter läuft, oder wenn die Systemzeit nicht durch die Internetzeit, dem Network Time Protocol /NTP, oder von einem Zeitsignalsender, z. B. GPS, regelmäßig aktualisiert wird, kommt ein Real Time Clock Modul
4 (RTC) zum Einsatz. Das RTC-Modul4 wird am internen I2C-Bus angeschlossen und über diesen per PHP-Skript konfiguriert und ausgelesen. Eine im Gehäuse der Computer-Zeitschaltuhr verbaute wiederaufladbare Batterie, z. B. in Form eines Lithium-Ionen Knopfzellen-Akku, z.B. eines LIR 2032 mit 3,6V oder z. B. zweier in Reihe geschaltete AA/AAA-Batterien mit jeweils 1,5 V, somit einer Gesamtspannung von 3V, dienen zur Zeiterhaltung bei Ausfall der permanenten Spannungsquelle. Beim Einsatz von Batterien werden diese in einem zertifizierten Einbau-Batteriefach im Gehäuse-Oberteil eingelegt. - Das RTC-Modul
4 ist mit einem integrierten Schwingquarz und einem digital temperatur- kompensierten Oszillator, einer DTCXO-Funktion, aufgebaut. Die Oszillatorfrequenz von 32,768 kHz wird dabei temperaturabhängig anhand eines Kompensationsnetzwerkes abgeglichen. Die RTC-Zeit/das RTC-Datum kann mit einem Webserver und PHP-Skript von jedem an der Computer-Zeitschaltuhr1.1 ,1.2 angemeldeten Client per Webbrowser eingestellt werden. Durch eine Eingabemaske auf dem Webserver kann das Datum und die Uhrzeit im RTC-Modul4 eingestellt werden. Das RTC-Modul4 aktualisiert wiederrum die Systemzeit und das Systemdatum vom Einplatinencomputer7 . Schließlich werden Systemzeit und -datum als Kontrolle per JavaScript in Echtzeit auf dem Web-Interface dem Bediener angezeigt. - Ein- und Ausgangsplatine mit einem 16-Bit Port Expander
5.1 und I2C-Busschnittstelle, sowie Relais-Treiber 5.2 - Die Ein- und Ausgangsplatine
3 dient dazu, um Ein- und Ausgänge eines 16-Bit Port-Expanders und einen Teil der verfügbaren Anschlüsse eines Einplatinencomputers7 und des DALI-Master- Moduls6.1 für extern angeschlossene elektrische Betriebsmittel herzustellen. Die elektronischen Baugruppen, Echtzeituhrmodul4 (RTC), DALI-Master-Modul6.1 und Pegelwandler-Modul6.2 werden mit der Ein- und Ausgangsplatine3 mittels Stift- oder Buchsenleiste2 im Rastermaß2 ,54mm verbunden. Die Ein- und Ausgangsplatine3 verbindet die vorher genannten Module mit der erforderlichen Spannungsversorgung und dem I2C-Bus (Datenleitung / SDA und Taktleitung / SCL) vom Einplatinencomputer7 . - Im Einzelnen werden nachfolgende Anschlüsse über Printklemmen
K1 bis K35 nach Außen geführt. Insgesamt stehen fünfunddreißig AnschlussklemmenK1 bis K35 zur Verfügung. - Die Zuordnung der bereitgestellten Anschlüsse zu den Printklemmen
K1 bis K35 ist vom eingesetzten Einplatinencomputer7 abhängig kann daher variieren, die nachfolgende Legende ist daher beispielhaft für den in FIG ausgewählten Einplatinencomputer7 dargestellt. - K1: GND
- K2: SCL (I2C-Bus)
- K3: SDA (I2C-Bus)
- K4: Eingang/IN 01
- K5: Eingang/In 02
- K6: Eingang/ IN 03
- K7: Eingang/ IN 04
- K8: Eingang/ IN 05
- K9: Eingang/ IN 06
- K10: Eingang/ IN 07
- K11: Eingang/ IN 08
- K12: GND
- K13: +24V (Eingang)
- K14: GPIO 25/ Computer
- K15: Ausgang/ OUT 08
- K16: Ausgang/ OUT 07
- K17: +5 V
- K18: Ausgang/ OUT 01
- K19: DALI-Tastereingang 2
- K20: DALI-Tastereingang 1
- K21: Ausgang/ OUT 02
- K22: SPI/ Clock
- K23: GPIO 23/ Computer
- K24: Ausgang/ OUT 03
- K25: SPI / Miso
- K26: SPI / Mosi
- K27: Ausgang/ OUT 04
- K28: UART / RXD
- K29: UART / TXD
- K30: Ausgang/ OUT 05
- K31: +3,3V (Ausgang)
- K32: GPIO 20/ Computer
- K33: Ausgang/ OUT 06
- K34: DALI-Master/ Bus 1
- K35: DALI-Master / Bus 2
- Da die elektronischen Baugruppen bzw. Bauelemente der Computer-Zeitschaltuhr
1.1 ,1.2 mit verschiedenen Spannungen arbeiten, werden zur Signalübertragung die Massepotentiale aller Spannungen intern miteinander verbunden.
Die seriellen Anschlüsse I2C, UART, RS 232 bzw. RS 485 und SPI des Einplatinencomputers7 werden an PrintklemmenK1 bis K35 der Ein- und Ausgangsplatine3 als Ein- und Ausgänge zum Anschluss für Geräteerweiterungen verbunden. Technische Daten der Printklemmen:Klemmentyp: Schraubklemme Rastermaß: 5,08 mm Anschlussquerschnitte Eindrähtig (starr): 0,2 mm2 bis 4,0 mm2 feindrähtig (flexibel): 0,2 mm2 bis 2,5mm2 feindrähtig mit Aderendhülse: 0,25mm2 bis 2,5mm2 Werkstoffe: Klemmstück aus Messing Schraube aus Stahl Lötfahne aus Kupferlegierung Isolierstoff: PA6.6 Brennbarkeitsklasse: UL 94 V-0 Einsatztemperatur: 30° C bis 105° C - Die Eingänge IN 01 bis IN 08 und die Ausgänge OUT 01 bis OUT 08 werden durch den 16-Bit I/0-Port-Expander 5.1 bereitgestellt. Ein Relais-Treiber
5.2 sorgt dafür, dass an den Ausgängen OUT01 bis OUT 08 bistabile Koppelrelais und Schütze auf 5V/12V/24V-Basis direkt angeschlossen werden können. Damit reduziert sich der interne Verschaltungsaufwand erheblich gegenüber der Nutzung freier GPIO-Pins vom Einplatinencomputer7 . Die Aufgabe des 16-Bit I/0-Port-Expanders 5.1 übernimmt ein integrierter Schaltkreis MAX 7311 und die Treiberstufe5.2 für die Ansteuerung der Koppelrelais und Schütze erfolgt durch einen ULN 2803 als integrierte Schaltung. Der MAX 7311 wird mit der 5 Volt Gleichspannung vom Einplatinencomputer7 betrieben und der ULN 2803 mit der 12/24V DC Spannung des externen Netzteils. - Die physikalische Adressierung des MAX 7311, die Hardwareadresse, wird durch die Anschlüsse
A0 ,A1 undA2 mittels Steckbrücken, d. h. Jumper, gegen GND, dem Low-Signal, oder +5 Volt, dem High-Signal, auf Stiftleisten im Rastermaß 2,54mm festgelegt. - Der Port-Expander
5.1 kommuniziert als Slave über die Datenleitungen SCA und SDA des I2C-Busses mit dem Einplatinencomputer7 , der die Aufgabe als Bus-Master übernimmt. Port 1 vom MAX 7311 wird als Eingangsport und Port2 als Ausgangsport festgelegt. Die Eingänge am Port 1 werden durch einen freien GPIO-Pin vom Einplatinencomputer7 , der am Interrupt-Pin am MAX 7311 angeschlossen ist, abgefragt. - Sobald sich ein Zustandswechsel an einem Eingang ergibt, reagiert die Software darauf und löst das programmierte Ereignis, die Interrupt Service Routine / ISR, aus. Der Vorteil dieser Methode ist, dass die CPU scheinbar mehrere Aufgaben gleichzeitig erledigen kann.
Nachdem die ISR von der CPU abgearbeitet worden ist, wird wieder in das Hauptprogramm zurück gesprungen. Diese Vorgehensweise ist wegen der Anzahl der verfügbaren Eingänge erforderlich, sie spart deutlich an Rechenleistung der CPU und folglich ist diese Methode stromsparender und damit wird weniger Verlustwärme im Gerät erzeugt. Bei der Abfrage so vieler Eingänge gleichzeitig, ist es einfach nicht möglich, durch alternative Programmierung mit z.B. Polling bzw. Hauptprogramm läuft in einer Endlosschleife, ein vernünftig laufendes Programm zu erstellen. Die Folgen wären regelmäßige „Programmabstürze“, erhebliche Verlangsamung des Programmablaufes und nicht die Möglichkeit zu haben, mehrere Aufgaben quasi gleichzeitig zu erledigen, sind entscheidende Kriterien zur Programmierung mit Auslösung eines Hardware-Interrupts. - Da CMOS-Eingänge dazu neigen, beliebig selbstständig in den Zustand High oder Low zu schalten, muss gewährleistet sein, dass die Eingänge immer einen definierten Zustand annehmen (High- oder Low-Pegel). Die Eingänge IN 01 bis IN 08 werden wegen dem Einsatz der vorher genannten Schaltkreise dauerhaft nach GND / Masse geschalten.
- Lediglich zur Auslösung eines Interrupts werden diese Eingänge für einen Bruchteil einer Sekunde von der Verbindung nach GND / Masse unterbrochen.
- Die intern im Einplatinencomputer
7 verbauten Pullup-/Pulldown-Widerstände werden nur für GPIO-Eingänge verwendet. - Für die Eingänge IN 01 bis IN 08 sind keine externen Widerstände zur definierten Pegelanpassung erforderlich.
- Die GPIO-Pins 20, 23 und 25 an den Printklemmen
K32 ,K23 undK14 werden ausschließlich als Digitaleingänge verwendet. Externe Pullup- oder Pulldown- Widerstände werden zur Beschaltung nicht benötigt, da bereits intern auf dem Einplatinencomputer7 zuschaltbare Widerstände verbaut sind, um immer einen definierten Eingangszustand (High- oder Low-Pegel) zu erzeugen. Die intern verbauten Widerstände können per Software zu- und abgeschaltet werden. - Der GPIO-Pin 09 (SPI Miso) an Printklemme
K25 und GPIO 10 (SPI Mosi) an PrintklemmeK26 kann auch als Digitaleingang verwendet werden. Es gelten die gleichen Bedingungen wie für die zuvor beschriebenen GPIO-PinsK20 ,K23 undK25 . Sollten diese Pins für die serielle Schnittstelle SPI in Verbindung mit GPIO 11(SPI / Clock) genutzt werden, so muss vorher die SPI-Schnittstelle per Webbrowser aktiviert (auf „on“ geschalten) werden. GPIO 11 an Printklemme K22 kann nicht als Digitaleingang verwendet werden. - Die Printklemmen
K14 ,K23 ,K25 ,K26 undK32 dürfen ausschließlich nur als Eingänge über Koppelrelais betrieben werden. Es darf kein Fremdpotential angelegt werden. Die Eingänge werden generell mit Koppelrelais nach GND / Masse / 0V geschalten und als Schalteingänge ausgewertet. - Aus sicherheitsrelevanten Gründen, vor allem zum Schutz des Einplatinencomputers
7 vor Zerstörung durch zu hohe Spannungen und Überschreitung der maximalen Strombelastung für den einzelnen GPIO (maximal ca. 16mA) bzw. den maximalen Gesamtstrom aller GPIO's (ca. 50 mA), werden diese nicht als Ausgänge verwendet, da keine geeignete Treiberschaltung mit Transistoren vorhanden ist. - Der Ausgangsport
5.1 des MAX 7311 ist über Leiterbahnen direkt mit den Eingängen der Treiberstufe5.2 ULN 2803 verbunden. Die acht Ausgänge der Treiberstufe stehen an den Printklemmen für den direkten Anschluss von Koppelrelais und Schützen bereit. - Beim direkten Anschluss an die Ausgänge OUT 01 bis OUT 08 ist folgendes zu beachten, um die Treiberstufe
5.2 ULN 2803 nicht zu zerstören:Maximale Eingangsspannung: 30V DC Maximale Ausgangsspannung: 50V DC Maximaler Ausgangsstrom für alle acht Ausgänge zusammen: 500mA (Spitzenstrom, kein Dauerstr - Um die Treiberstufe
5.2 (Kollektorausgänge der integrierten Transistoren) nicht zu überlasten, wird festgelegt, dass der maximal zu entnehmende Gesamtstrom von 400mA nicht überschritten werden darf. Somit stehen beim gleichzeitigen Schalten aller acht Ausgänge durchschnittlich 50mA Strom pro Ausgang zur Verfügung. Im Schaltungsaufbau mit dem Prototypen haben sich folgende Strommesswerte für die Ausgänge OUT 01 bis OUT 08 in der Praxis ergeben, die als Richtwerte dienen sollen: - Stromaufnahme einer konventionellen 24V DC Schützspule: ca. 100mA
- Stromaufnahme eines Solid-State-Relais bei 24V DC: ca. 21mA
- Stromaufnahme eines halbelektronischen bistabilen Spezialrelais bei 24V DCca. 2mA
- Auf Grund der gemessenen Stromwerte ist der Anschluss von Solid-State-Relais und bistabilen Relais als „Nulldurchgangsschalter“ an die Ausgänge der Computer-Zeitschaltuhr
1.1 ,1.2 zu bevorzugen, da diese die Treiberstufe am wenigsten belasten und somit die Lebensdauer der integrierten Schaltung höher ist. Der Anschluss einer Kombination dieser Geräte mit herkömmlichen 24V DC Schützen ist möglich und wurde anhand von Dauertests mit Wirkleistungsverbrauchern erprobt. Beim direkten Schalten von induktiven Verbrauchern (die direkte Ansteuerung von getakteten Antrieben ist nicht vorgesehen) durch Schütze muss eine Freilaufdiode parallel zur Schützspule angeschlossen werden, so dass sie in Sperrrichtung an der Steuerspannung des Schütz liegt. Die Freilaufdiode hat die Aufgabe ungewollte Störungen bis hin zur Zerstörung an den elektronischen Bauteilen zu verhindern und die Anschlusskontakte des Schützes zu schonen. Sofern es der Einsatz zulässt, sollte auch wie beim Einsatz der empfohlenen Relais auf die Vorteile der Halbleiter- Schalttechnologie in Form von Halbleiterschützen zurückgegriffen werden. - DALI-Master Modul mit Schalteingängen und I2C-Busschnittstelle
- Eine weitere intern verbaute Platine mit einem LW09 Chip stellt eine galvanisch getrennte Verbindung über Optokoppler zwischen dem DALI-Bus und dem I2C -Bus her. Somit ist es möglich Lichtsteuerungsbefehle an DALI-Betriebsgeräte zu senden. Die Platine
6.1 wird mit der internen Spannung von 5 V Gleichspannung betrieben. Die Funktion der Schalteingänge und die Befehle an DALI-Betriebsgeräte zum dimmen, schalten oder Lichtszenenaufruf werden über die I2C-Schnittstelle programmiert. An jedem der beiden Schalteingänge (PrintklemmenK19 ,K20 ) können potentialfreie Schalter oder Taster mit Schliesserkontakten, wobei Taster zu bevorzugen sind, angeschlossen werden. Die Schaltgeräte werden zwischen GND / Masse / 0V und dem jeweiligen Eingang angeschlossen. Die DALI-Anschlussklemmen (K34 ,K35 ) sind polungsunabhängig. - Modifiziertes Universal DIN-Hutschienengehäuse mit sechs Platzeinheiten
- Als Grundlage für den Einbau der elektronischen Baugruppen und Bauelemente dient ein universelles DIN-Hutschienen-Leergehäuse mit einer Breite von 105mm bei sechs Platzeinheiten, wobei eine Platzeinheit im Verteilerbau 17,5 mm entspricht, einer Höhe von 71mm und einer Tiefe von 90mm. Das Gehäuse besteht aus zwei Halbschalen mit Ober- und Unterteil, die ineinander einrasten und mittels vier Schrauben noch zusätzlich verschraubt werden. Durch einen integrierten Schnappfuß wird das Gehäuse auf eine Tragschiene für den Verteilereinbau aufgesteckt. Als Material für das Gehäuse wird temperatur- und alterungsbeständiger Kunststoff aus ABS (Acrylnitril-Butadien-Styrol-Copolymere) verwendet.
- Der verwendete Einplatinencomputer
7 und die USV-Platine mit Weitbereichsspannungseingang8 passen von ihrer Breite exakt in den unteren Bereich vom Gehäuseoberteil eines universellen DIN-Hutschienengehäuses. Damit ist der Einbau leicht möglich und es sind keine größeren Änderungsmaßnahmen am Gehäuse erforderlich. Am Gehäuseoberteil wird lediglich ein passender rechteckiger Ausschnitt an der linken Seite zur Freilegung der vier USB-Anschlüsse und der Netzwerkbuchse, ein rechteckiger Ausschnitt ca. mittig oberhalb der Schraublöcher für die Printklemmenklemmen Nr.K 1 bisK 17 zur Freilegung der HDMI-Buchse, sowie ein runder Ausschnitt oberhalb vom PrintklemmenanschlussK 35 für den optionalen Anschluss einer externen WLAN-Antenne mit RP-SMA Anschluss hergestellt. Da alle vorher genannten Anschlüsse vom Einplatinencomputer7 steck- oder schraubbar (auch bei Anschlussvariante mit externer WLAN-Antenne) ausgeführt sind, stören diese auch nicht beim Anschluss von externen Geräten an den PrintklemmenanschlüssenK 1 bisK 35 . - Ein großer Vorteil der Computer-Zeitschaltuhr
1.1 ,1.2 ist, dass keine wesentlich aktiven elektronischen Bauteile, die Wärme verursachen, innerhalb des Hutschienengehäuses verbaut sind. Somit werden thermische Probleme generell vermieden. Außerdem wird Platz für eine maximale Anzahl an verfügbaren Ein- und Ausgänge geschaffen und die Computer-Zeitschaltuhr1.1 ,1.2 kann bei einem Defekt der Spannungsquelle durch Austausch dieser weiter betrieben werden. Die Computer-Zeitschaltuhr1.1 ,1.2 kann auch mit einer Gleichspannungsquelle anderer Spezifikationen für den Einsatz verschiedener Verteilereinbaugeräte oder für andere Verwendungszwecke eingesetzt werden. - Die Versorgungsspannung muss im Bereich von 5 bis 30 Volt zur Verfügung gestellt werden. Es dürfen nur entstörte Netzteile mit Sicherheitskleinspannung (SELV) verwendet werden.
- Optional externer Anschluss / GPS-Empfänger an der UART-Schnittstelle angeschlossen:
- Es besteht die Möglichkeit, die Systemuhrzeit der Zeitschaltuhr durch den optionalen Anschluss eines GPS-Empfängers automatisch in regelmäßigen Abständen synchronisieren zu lassen. Seine Antenne benötigt stets eine Sichtverbindung zu mehreren GPS-Satelliten, um das Signal empfangen zu können. Das GPS-Empfängermodul wird an die Klemmen RXD und TXD der UART-Schnittstelle für die Kommunikation mit dem Einplatinencomputer
7 , sowie an die vom diesen bereitgestellte Versorgungsspannung von 3,3V DC angeklemmt. Der GPS-Empfänger wird zur Datums- und Uhrzeitsynchronisierung (verhindert das Abtriften des systemeigenen verbauten Echtzeituhrmoduls / RTC der Zeitschaltuhr) und optional zur Positionsbestimmung für die Bereitstellung von Astrozeiten genutzt. - Optional externer Anschluss (nur bei Einsatz eines Einplatinencomputers mit UFL RP-SMA Anschluss):
- WLAN-Antenne für ein besseres Funknetz anstatt der auf dem Einplatinencomputer verbauten WLAN-Antenne kann auch optional eine externe abgesetzte WLAN Antenne zur Erhaltung oder Verbesserung der Sendeleistung dienen. Diese Möglichkeit bietet sich an, wenn die Computer-Zeitschaltuhr
1.1 ,1.2 ohne Router- und Internetanschluss genutzt werden soll und zum Beispiel in einer Verteilung mit geschlossener Metalltür (Abschirmwirkung) eingebaut wird. Durch einen UFLS-SMD Steckverbinder (Microminiature Koaxial-Steckverbinder), der auf dem Einplatinencomputer7 aufgelötet wird und einen ca. 10cm langen UFL-RP-SMA Anschlussadapter, der die Verbindung vom Einplatinencomputer7 zum Anschluss am Gehäuseoberteil herstellt, ist optional der Anschluss einer externen W-LAN 802.11 b/g/n Antenne möglich. Die Onboard Chip-Antenne wird durch diesen Anschluss außer Kraft gesetzt, da der Signalweg dann zum UFLS-SMD Steckverbinder geleitet wird. - Optional externe USB-Anschlüsse: Ultra-Nano WLAN-Stick zur kabellosen Einbindung in ein bestehendes Netzwerk
- An der Computer-Zeitschaltuhr
1.1 ,1.2 stehen mehrere USB-Anschlüsse zur Verfügung. Soll die Computer-Zeitschaltuhr1.1 ,1.2 in ein vorhandenes Netzwerk integriert werden und es steht keine kabelgebundene Anbindung via LAN zur Verfügung, so besteht die Möglichkeit, einen Ultra-Nano-WLAN-Stick mit sehr kompakter Bauform direkt anzuschließen. Die Computer-Zeitschaltuhr1.1 ,1.2 kann gleichzeitig als Accesspoint mit dem integrierten WLAN-Chip auf dem Einplatinencomputer7 und mit dem extern angeschlossenen Ultra-Nano-WLAN-Stick zur Anbindung an einem Router mit eigenen Netzwerk betrieben werden. - Elektromagnetische Verträglichkeit (EMV):
- Zur Verbesserung der Abschirmwirkung werden die Innenwände der beiden Kunststoff-Halbschalen vom Hutschienengehäuse mit einem EMV-Schutzlack überzogen. Der Schutzlack bildet eine leitfähige Umhüllung der Gehäuse-Innenseiten und besteht aus Harzen, Lösungsmitteln und leitenden Pigmenten aus Kupfer und Silber. Die Metallpigmente bilden auf der Oberfläche der Gehäuseteile eine leitfähige Beschichtung und verhindern dadurch elektromagnetische Interferenzen (EMI) und elektrostatische Entladungen (ESD). Der Schutzlack ist für den Einsatz bei wechselnden Wärme- und Feuchtigkeitsbedingungen geeignet. Vor der Oberflächenbehandlung werden diese gereinigt und von Fett befreit. Die Störsicherheit durch Einhaltung der EMV-Richtlinie ist bislang für die Computer-Zeitschaltuhr
1.1 ,1.2 nicht nachgewiesen. - Softwareseitige Einstellungen, Konfigurationen und Programmierungen:
- Als Betriebssystem für die Computer-Zeitschaltuhr wird Linux eingesetzt (GNU freie Copyleft-Lizenz für Software und andere Arten von Werken). Der GNU General Public License (GPL) in seiner aktuellen Version
3 vom 29. Juni 2007 wird entsprochen. Das Copyright unterliegt der Free Software Foundation, lnc. 51Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - Folgende Konfigurationen werden für das Booten (Startbedingungen) vom Einplatinencomputer
7 standardmäßig in der Datei /boot/config.txt eingestellt: -
- Audio-Schnittstelle „ein“
- 12C-Schnittstelle „ein“
- SPJI-Schnittstelle „aus“
- (kann bei Bedarf auf „ein“ geschalten werden)
- UART-Schnittstelle „ein“
- I2C-Baudrate (Taktgeschwindigkeit) = 10 kHz (Normal Modus) um eine „sichere“ Kommunikation auf der Busleitung zu gewährleisten, der Fast-Modus beträgt 400 kHz.
- UART Baudrate (Taktgeschwindigkeit) = 9,6 kHz für den Betrieb eines extern angeschlossenen GPS-Empfängers.
- In der Datei /etc/sudoers.tmp werden dem Benutzer „www-data“ Rootrechte (uneingeschränkte Schreib- und Leserechte) für die nachfolgenden programmierten Script- und Textdateien eingeräumt (Die Dateien sind beispielhaft für den Prototypen zu sehen, es können je nach Verwendungszweck der Computer-Zeitschaltuhr
1.1 ,1.2 noch mehr programmierte Dateien/Scripte bzw. in abgewandelter Form vorhanden sein. - Einplatinencomputer
7 mit WLAN on Board in den Accesspoint-Modus versetzen und als WLAN-Hotspot und Client einrichten durch Konfiguration der folgenden Dateien: -
- /etc/network/interfaces
- /etc/wpa_supplicant/wpa_supplicant.conf
- /etc/hostapd/hostapd.conf
- /etc/rc.local
- Die Computer-Zeitschaltuhr
1.1 ,1.2 mit dem Einplatinencomputer7 mit WLAN on Board wird in den Accesspoint-Modus (WIFI-Hotspot) versetzt und stellt ein WLAN mit einer eigenen IP- und Zugangs-Konfiguration zur Verfügung. Die Computer-Zeitschaltuhr1.1 ,1.2 stellt dazu einen DHCP- und DNS-Server bereit. Clients (WIFI-Geräte) können sich somit automatisch zur Computer-Zeitschaltuhr1.1 ,1.2 verbinden, nachdem das frei konfigurierbare Netzwerk-Passwort erfolgreich in einem WIFI-Gerät eingegeben wurde. Jedes WIFI-Gerät bekommt von der Computer-Zeitschaltuhr1.1 ,1.2 eine eindeutige IP-Adresse zugewiesen. Folgende Netzwerkeinstellungen können bei der Computer-Zeitschaltuhr1.1 ,1.2 über das Web Interface (GUI)vorgenommen werden: - - Netzwerkname (ssid)
- - Funkkanal (channel)
- - Netzwerk-Passwort (passphrase)
- - Ländercode (country_code)
- Für die Einrichtung der Computer-Zeitschaltuhr
1.1 ,1.2 als Accesspoint sind nachfolgende Einstellungen durchgeführt worden: - In der Datei „interfaces“ im Pfad /etc/network/interfaces wird eingestellt:
# Konfiguration des im Einplatinencomputer verbauten W-LAN Adapters (wlan0) allow-hotplug wlan0 iface wlan0 inet manual # wlan0 Adapter mit manueller Einstellung # Konfiguration eines optional angeschlossenen W-LAN Adapters am USB-Port (wlan1) allow-hotplug wlan1 iface wlan1 inet manual # wlan1 Adapter mit manueller Einstellung
In der Datei „hostapd.conf“ im Pfad /etc/hostapd/hostapd.conf wird eingestellt:
interface=wlan0 # W-LAN Adapter festlegen welcher den # Accesspoint # bereitstellen soll driver=nl80211 # Festlegung welcher Treiber für den # W-LAN Adapter # verwendet wird ssid=xxx # Netzwerkname, xxx = beliebiger Name hw_mode=g # Übertragungsmodus (Frequenzband) des # W-LANAdapters (g= 2,4Ghz Band / a =5 # Ghz Band) wme_enabled=1 ieee80211n=1 # IEEE 802.11n / WLAN mit 40-200 MBit/s Channel=x # Funkkanal einstellen, x = 1-13 # Channel 01 : 2.412 GHz # Channel 02 : 2.417 GHz # Channel 03 : 2.422 GHz # Channel 04 : 2.427 GHz # Channel 05 : 2.432 GHz # Channel 06 : 2.437 GHz # Channel 07 : 2.442 GHz # Channel 08 : 2.447 GHz # Channel 09 : 2.452 GHz # Channel 10 : 2.457 GHz # Channel 11 : 2.462 GHz # Channel 12 : 2.467 GHz # Channel 13 : 2.472 GHz # Die Funkkanäle können je nach # eingesetzten Einplatinencomputer 7 # auch im 5GHz Band verfügbar sein. macaddr_acl=0 # 0 = jede MAC-Adresse (Hardwareadresse) # von den Clients akzeptieren, es sei # denn, es gibt eine Verbotsliste # 1 = keine MAC-Adresse (Hardwareadresse) # zulassen, es sei denn, es gibt eine # Freigabeliste # 2 = Verwende einen externen RADIUS- # Authentifizierungsserver auth_algs=1 # Art der Authentifizierung # 1 = Open System / WPA-Verschlüsselung # 2 = Shared Key / WEP-Verschlüsselung # 3 = beide Verschlüsselungssysteme # anwenden wpa=2 # 1 = WPA1 Verschlüsselung # 2 = WPA2 Verschlüsselung # 3 = beide Verschlüsselungssysteme # anwenden wpa_key_mgmt=WPA-PSK # Pre-shared-Key Management # akzeptiert einen vorher # vereinbarten Schlüssel (PSK) #wpa_passphrase=xxx # W-LAN Schlüssel (Passwort) als # Klartext, # xxx = beliebige Buchstaben, Zahlen # und Sonderzeichen # Kombination oder wpa_psk=xxx # W-LAN Schlüssel (Passwort) 64-Bit # verschlüsselteintragen (größere # Sicherheit) Buchstaben, Zahlen und # Sonderzeichen, Kombination rsn_pairwise=CCMP # CCMP Protokoll für den paarweisen # Schlüssel zwischen Accesspoint und # Client im Sicherheitsnetzwerk # anbieten wpa_pairwise=CCMP TKIP # TKIP und CCMP Protokoll für die # paarweise WPA- # Verschlüsselung anbieten country_code=DE # den Ländercode für Deutschland für # die nur in Deutschland # zugelassenen Frequenzen verwenden # (Diese Einstellung muss richtig # vorgegeben werden, # je nach dem in welchen Land die # universelle elektronische # Zeitschaltuhr verwendet wird, der # Errichter ist dafür # verantwortlich!)
DHCP-Dienst / IP-Adressen (LAN und WLAN/Accesspoint-Modus) und den DNS-Dienst (dynamische Namensauflösung) der Computer-Zeitschaltuhr 1.1 , 1.2 und des Einplatinencomputers 7 festlegen und einstellen:
1. Modifikation der Datei /etc/dhcpcd.conf
In der Datei „dhcpcd.conf“ wird eingestellt: interface wlan0 static ip_address=x.x.x.x # x.x.x.x steht für eine # beliebige feste IP-Adresse netmask=255.255.255.0 # Subnetzmaske (Präfix) # festlegen, # i.d.R. 255.255.255.0
2. Modifikation der Datei /etc/dnsmasq.conf
In der Datei „dnsmasq.conf“ wird eingestellt: interface=wlan0 # DHCP- und DNS-Server ist aktiv für # W-LAN Adapter # „wlan0“ bind-interfaces # nur im lokalen Netzwerk auf Anfragen # hören server=8.8.8.8 # leitet alle DNS-Anfragen auf den Google # Nameserver weiter domain-needed # Dnsmasq fragt nur dann den # Upstream-Nameserver # ab, wenn der angefragte Hostname einen # Domainnamen enthält bogus-priv # Anfragen nach IP-Adressen (Reverse # Lookups) an den # Upstream-DNS-Server weiterleiten, wenn # diese nicht # aus einem privaten IP-Adressbereich # stammen dhcp-range=x.x.x.v,x.x.x.w,24h # Adressbereich für den # DHCP-Server festlegen, # wobei x.x.x für die # ersten drei Oktett # (8 Bit) für den # Hostanteil steht und das # vierte Oktett v, w # für den zu vergebenen # Client-Bereich steht und # die vergebenen Adressen # der Clients 24 Stunden # pro Tag unverändert sein # sollen
RTC (DS3231)4 für den Einplatinencomputer 1.1, 1.2 integrieren:
2. Modifikation der Datei /lib/udev/hwdock-set(bestehendes Hardware Clock Script)
Nachfolgende Zeilen werden auskommentiert, um eine einwandfreie Funktion desRTC-Moduls zu gewährleisten: # if [-e /run/systemd/system] ; then # exit 0 # fi
3. Softwarebasierte Uhr und NTP-Dienst abschalten
sudo update-rc.d fake-hwclock disable # Softwareuhr # ausschalten sudo update-rc.d ntp disable # NTP-Dienst # ausschalten sudo reboot # Neustart des # Betriebssystems
4. Systemzeit neu einstellen
# über das Web Interface # Script „zeitschaltuhr.php“
5. Neu eingestellte Systemzeit in der RTC übernehmen Aktuelle Uhrzeit und Datum über das Web Interface / Script „zeitschaltuhr.php“ eingeben und speichern. Dabei wird von diesen Script auch u.a. folgender Befehl ausgeführt: sudo hwclock -w (neu eingestellte Uhrzeit und Datum in das RTC-Modul übernehmen).
6. Kontrolle, ob die RTC die neue Systemzeit übernommen hat, kann durch den Shell-Befehl „sudo hwclock -r“ (zurücklesen der geschriebenen Zeit und Datum aus der RTC) durchgeführt werden.
7. Das Script „zeitschaltuhr.php“ führt u.a. auch noch folgenden Shell-Befehl aus, um die in der RTC abgespeicherte Uhrzeit und das Datum als Systemzeit zu übertragen sudo hwclock -s
Die System-Uhrzeit / das System-Datum wird von einen Java Script ausgelesen und in Echtzeit auf der Startseite „zeitschaltuhr.php“ des Web Interfaces angezeigt.
Die System-Uhrzeit / das System-Datum wird von einen Java Script ausgelesen und in Echtzeit auf der Startseite „zeitschaltuhr.php“ des Web Interfaces angezeigt.
Anlegen eines Autostart-Services „smbus.service“ (Respawn Service) für ein ständig funktionierendes Python-Script „i2c_ein-ausgaenge.py“. Der Service befindet sich im Dateipfad „/etc/systemd/system“. Das Python-Script muss auch nach einem Systemfehler oder selbständigen Beenden des Scripts weiter funktionieren, da dieses die Aufgabe hat, die Ein- und Ausgänge der elektronischen Zeitschaltuhr 1.1 , 1.2 zu verwalten. Das bedeutet, ergibt sich an den Eingängen ein Zustandswechsel (High-Pegel zu Low-Pegel oder umgekehrt), so reagiert das Script darauf und betätigt z.B. einen Ausgang und/oder führt eine andere Funktion aus.
Beschreibung für das Anlegen des Services:
- 1. Neue Datei „smbus.service“ anlegen und unter/etc/systemd/System/ speichern
- 2. Die Datei „smbus.service“ ist wie folgt aufgebaut:
- • Beschreibung des Dienstes [Unit] Description=My Script Service
- • Festlegung Multi-User Betrieb After=multi-user.target
- • Integrierte Entwicklungsumgebung für Python (IDLE) definieren [Service] Type=idle
- • Pfad zum immer wieder ausführenden Script angeben ExecStart=/usr/bin/python /var/www/cgi-bin/i2c_ein-ausgaenge.py &
- • Neustart des Scripts auf „immer neu starten“ festlegen Restart=always
- • Festlegung, auf welchen anderen Prozess gewartet werden soll, bis das Script neu gestartet werden soll [Install] WantedBy=multi-user.target
Anlegen eines Autostart-Services (Respawn Service) für einen MQTT-Broker / Mosquitto (Nachrichtenprotokoll gemäß OASIS- bzw. ISO Standard ISO/IEC PRF 20922) als „mosquitto.Service“. Der Service befindet sich im Dateipfad „/etc/systemd/system“. Die elektronische Zeitschaltuhr fungiert dabei als MQTT-Broker, der Befehle an MQTT Clients (z.B. Microcontroller ESP 8266 mit WIFI Chip) überträgt und dieser dann den/die Befehl(e) ausführt. Ein besonderes Merkmal der elektronischen Zeitschaltuhr ist dabei, dass z.B. WIFI-Relais als Clients im WLAN-Netz der Computer-Zeitschaltuhr 1.1 , 1.2 angemeldet werden können und dabei durch die Zeitschaltuhr automatisch zeitgesteuert oder durch an die Computer-Zeitschaltuhr 1.1 , 1.2 angeschlossene Taster betätigt werden können oder über das Web Interface der Computer-Zeitschaltuhr 1.1 , 1.2 einzeln oder in Gruppen betätigt werden können.
Beschreibung für das Anlegen des mosquitto.service:
1. Neue Datei „mosquitto.service“ anlegen und unter
/etc/systemd/system/ speichern
/etc/systemd/system/ speichern
2. Die Datei „mosquitto.service“ ist wie folgt aufgebaut:
- Beschreibung des Dienstes [Unit] Description=Mosquitto MQTT Broker daemon - Festlegung Multi-User Betrieb ConditionPathExists=/etc/mosquitto/mosquitto.conf Wants=multi-user.target After=multi-user.target Requires=network.target Integrierte Entwicklungsumgebung für Python (IDLE) definieren [Service] Type=simple - Pfad zum immer wieder ausführenden Script angeben ExecStart=/usr/sbin/mosquitto -c /etc/mosquitto/mosquitto.conf -d ExecReload=/bin/kill -HUP $MAINPID PIDFile=/run/mosquitto.pid - Neustart des Scripts auf „starte neu bei Fehler“ festlegen Restart=on-failure - Festlegung, auf welchen anderen Prozess gewartet werden soll, bis das Script neu gestartet werden soll [Install] WantedBy=multi-user.target
Für die Installation des Mosquitto-Brokers wird folgender Shell-Befehl ausgeführt:sudo apt-get install -y mosquitto mosquitto-clients
Die beigefügten Programmierbeispiele in den Scriptsprachen Python, PHP und JavaScript dienen der besseren Verständlichkeit für die Umsetzung der jeweiligen Funktionsweisen und können individuell verändert, verbessert und ergänzt werden, da es sich wie anfangs erwähnt um einen veröffentlichten Sourcecode nach der GNU Copyleft-Lizenz handelt. Wie bei allen softwarebasierten elektronischen Geräten gibt es natürlich eine Vielzahl von Lösungsmöglichkeiten, u.a. auch mit anderen Programmiersprachen wie z.B. C oder C++.
Für multimediale Anwendungen (Audio / Video) ist der bekannte kostenlose VLC-Player vorinstalliert. Dieser kann zahlreiche Video und Audio Formate und Streams aus dem Internet oder von lokalen Datenträgern abspielen oder im Netzwerk / in den Netzwerken der Computer-Zeitschaltuhr 1.1 , 1.2 an angemeldete Clients zur Verfügung stellen. Im Web Interface der Computer-Zeitschaltuhr 1.1 , 1.2 ist auch das Web Interface des VLC-Players implementiert, so dass auf angemeldeten Endgeräten keine zusätzliche APP für den VLC-Player installiert werden muss und Audio- und Videodateien an der Computer-Zeitschaltuhr 1.1 , 1.2 angeschlossenen Speichergeräten zur Verfügung stehen. Somit kann mehr Speicherplatz auf den Endgeräten für andere Zwecke genutzt werden. Die Computer-Zeitschaltuhr 1.1 , 1.2 kann jederzeit Audio- und Videodateien oder Streams aus dem Internet oder von lokalen Datenträgern zeitgesteuert wiedergeben. Als weitere besondere Eigenschaft der Computer-Zeitschaltuhr 1.1 , 1.2 kann gesehen werden, dass an der Computer-Zeitschaltuhr 1.1 , 1.2 angeschlossene herkömmliche Taster den VLC-Player fernsteuern können, d.h. dass Audio- oder Videodateien durch diese direkt gestartet, gestoppt, die Lautstärke oder alle weiteren Bedienfunktionen erzeugt werden können. Prinzipiell können fast alle Bedienungsfunktionen des VLC-Players durch angeschlossene elektrische Betriebsmittel realisiert werden.
Die Programmierbeispiele spiegeln nur die wesentlichsten Teile eines möglichen Funktionsumfangs der Computer-Zeitschaltuhr 1.1 , 1.2 wieder.
Die nachfolgenden Scripte und Textdateien, die zur Speicherung von Zuständen dienen, ermöglichen mit der vorher beschriebenen Hardware die Funktionsweise einer elektronischen Zeitschaltuhr 1.1 , 1.2 mit darüber hinausgehenden Funktionsumfang.
Die Einstellungen (SSID/Netzwerkname, Sendekanal und Netzwerkpasswort) für den Accesspoint-Modus der Computer-Zeitschaltuhr 1.1 , 1.2 können wie alle anderen Einstellungen über den Webserver durch den Errichter/Bediener eingestellt und abgespeichert werden.
Der Lösungsansatz hierfür kann aus den nachfolgenden Programmierbeispielen abgeleitet werden und wird generell auf gleicher Art und Weise für alle möglichen Einstellungen / Eingaben durchgeführt.
Prinzipiell werden alle Einstellungen mittels PHP-Scripte mit HTML-Teil abgefragt und werden entweder durch Auswahl von Checkboxen, Radio-Buttons oder Eingabemasken in Textdateien oder anderen Dateien des Dateisystems abgespeichert. Aus den veränderten Dateien wird wieder gelesen und es werden so die Zustände von Ein- und Ausgängen verarbeitet. Aufgrund des Einsatzes eines Port Expanders werden Ein- und Ausgänge von diesen generell bitweise verarbeitet und byteweise geschrieben oder gelesen. Das Lesen oder Schreiben aus allen veränderten Dateien erfolgt zeilenweise und die Dateien werden bei jeder Veränderung überschrieben oder erweitert. Alle Scripte mit dem Platzhalter „x“ sind mehrmals vorhanden, wobei der Buchstabe „x“ stellvertretend für die Kanalnummer eines Ausgangs steht.
Python-Scripte:
www-data ALL=(root) NOPASSWD: /var/www/cgi-bin/reboot_pi.py www-data ALL=(root) NOPASSWD: /var/www/cgi-bin/gpsdData.py www-data ALL=(root) NOPASSWD: /var/www/cgi-bin/i2c_ein- ausgaenge.py www-data ALL=(root) NOPASSWD: /var/www/cgi-bin/i2c_on_chx.py www-data ALL=(root) NOPASSWD: /var/www/cgi-bin/i2c_off_chx.py www-data ALL=(root) NOPASSWD: /var/www/cgi- bin/treppenlicht x.py www-data ALL=(root) NOPASSWD: /var/www/cgi-bin/emailsenden.py www-data ALL=(root) NOPASSWD: /var/www/cgi-bin/vlc_http.py www-data ALL=(root) NOPASSWD: /var/www/cgi- bin/wifi_relais_x_on.py www-data ALL=(root) NOPASSWD: /var/www/cgi- bin/wifi_relais_x_off.py www-data ALL=(root) NOPASSWD: /usr/local/lib/python3.4/dist- packages/vlc.py
PHP-Scripte:
www-data ALL=(root) NOPASSWD: /var/www/htdocs/zeitschaltuhr.php www-data ALL=(root) NOPASSWD: /var/www/htdocs/startverhalten.php www-data ALL=(root) NOPASSWD: /var/www/htdocs/ausgaenge- systemstart.php www-data ALL=(root) NOPASSWD: /var/www/htdocs/ausgaenge- schalten.php www-data ALL=(root) NOPASSWD: /var/www/htdocs/automatik- schaltkanal.php www-data ALL=(root) NOPASSWD: /var/www/htdocs/kanal_ein- aus.php www-data ALL=(root) NOPASSWD: /var/www/htdocs/ein-aus.php www-data ALL=(root) NOPASSWD: /var/www/htdocs/ein- ausschaltzeit.php www-data ALL=(root) NOPASSWD: /var/www/htdocs/schalten- extern-0x.php www-data ALL=(root) NOPASSWD: /var/www/htdocs/schalten- extern-lesen.php www-data ALL=(root) NOPASSWD: /var/www/htdocs/schaltzeiten_anzeigen.php www-data ALL=(root) NOPASSWD: /var/www/htdocs/schaltzeiten_loeschen.php www-data ALL=(root) NOPASSWD: /var/www/htdocs/ schaltzeit_anzeigen-uebertragen.php
Sonstige Scripte:
www-data ALL=(root) NOPASSWD: /etc/systemd/system/smbus.service www-data ALL=(root) NOPASSWD: /etc/systemd/system/mosquitto.service www-data ALL=(root) NOPASSWD: /var/www/htdocs/dhtml.js www-data ALL=(root) NOPASSWD: /usr/local/bin/eth0_down.sh Textdateien, in denen Zustände hinein geschrieben oder heraus gelesen werden: www-data ALL=(root) NOPASSWD: /var/www/cgi-bin/reboot_pi.txt www-data ALL=(root) NOPASSWD: /var/www/cgi-bin/input_01.txt www-data ALL=(root) NOPASSWD: /var/www/cgi-bin/variable_q.txt www-data ALL=(root) NOPASSWD: /var/www/htdocs/ch.txt www-data ALL=(root) NOPASSWD: /var/www/htdocs/kanal.txt www-data ALL=(root) NOPASSWD: /var/www/htdocs/schalten- extern.txt www-data ALL=(root) NOPASSWD: /var/www/htdocs/merker_schaltzeiten.txt www-data ALL=(root) NOPASSWD: /var/spool/cron/crontabs/schaltzeiten.txt
reboot_pi.py
Mit diesem Script werden die Anfangszustände der Ausgänge bei Neustart / Einschalten oder bei Spannungswiederkehr nach Unterbrechung der Spannungsversorgung für die Computer-Zeitschaltuhr 1.1 , 1.2 festgelegt. Über den Webbrowser kann der Nutzer der Computer-Zeitschaltuhr 1.1 , 1.2 die Anfangszustände jedes einzelnen Ausgangs festlegen. Die Einstellungen für die Ausgänge werden als Dezimalwert (Wertigkeit der gesetzten Bits) in der Datei 11 reboot pi.txt“ abgespeichert. Das Script „reboot_pi.py“ liest den zuvor mit dem PHP-Script „startverhalten.php“ eingetragenen Dezimalwert aus der Datei „reboot.txt“, wertet diesen aus und wandelt ihn in eine Hexadezimalzahl für den I2C-Befehl. Dieser Wert wird anschließend über den I2C-Bus in das Ausgangsregister vom 16-Bit Port-Expanderübertragen, so dass die Ausgänge nach dem Neustart das gewünschte Startverhalten zeigen. Der momentane Zustand der Ausgänge wird auch immer als Dezimalwert in die Datei) Input_01.txt“ geschrieben.
Ausgeführt wird das Script „reboot_pi.py“ automatisch nach jedem Systemstart oder Neustart (Reboot) des Einplatinencomputers 7 in Form eines Cronjobs (zeitabhängige wiederkehrende Aufgabe in einem Linux-Betriebssystem) im Dateiverzeichnis „/var/spool/cron/crontabs“.
Nachfolgend das Programmierbeispiel in der Scriptsprache Python für die gewünschte Funktionsweise:
#!/usr/bin/env python3 # -*- coding: utf-8 -*- # Definierte Anfangszustaende fuer die Ausgaenge festlegen # Bibliotheken aus der Scriptsprache Python laden import smbus import time bus = smbus.SMBus(1) DEVICE = 0x27 # I2C-Portexpander Adresse IO_DIRECTION A = 0x06 # Festlegung Register A als Ausgang # (0=Ausgang, 1=Eingang / # Werkseinstellung) OUTPORTA = 0x02 # Register A als Ausgaenge zuweisen bus.write_byte_data(DEVICE,IO_DIRECTION_A,0x00) bus.write_byte_data(DEVICE,OUTPORTA,0xFF) time.sleep(.000001) bus.write_byte_data(DEVICE,OUTPORTA,0x00) # Datei reboot_pi.txt auslesen, um die jeweiligen Ausgaenge (1-8) auf High-Pegel (1) # oder Low-Pegel (0) nach dem Systemstart oder Neustart/Reboot zu schalten. # Voreinstellungen der Ausgaenge bei Systemstart aus Datei reboot_pi.txt lesen fobj = open(„/var/www/cgi- bin/reboot_pi.txt“) for line in fobj: str_byte = line.rstrip() Register2 = int(str_byte) ib = bin(Register2) [2:].zfill(8) 08 = (ib [0]) 07 = (ib [1]) 06 = (ib [2]) 05 = (ib[3]) 04 = (ib [4]) 03 = (ib[5]) 02 = (ib[6]) 01 = (ib[7]) out8 = str(o8) out7 = str(o7) out6 = str(o6) out5 = str(o5) out4 = str(o4) out3 = str(o3) out2 = str(o2) out1 = str(o1) # 8 Bit Ausdruck der Voreinstellungen fuer das Verhalten der Ausgaenge x = out8 + out7 + out6 + out5 + out4 + out3 + out2 + out1 integer_byte = int(x, 2) # Uebertragung an den Port Expander / Register A als Ausgang und 8-Bit Ausdruck zur Festlegung High- oder Low-Pegel der Ausgaenge bus.write_byte_data(DEVICE,IO_DIRECTION_A,0x00) bus.write_byte_data(DEVICE,OUTPORTA,integer_byte) # Zustaende der Ausgaenge in die Datei „input_01.txt“ schreiben fobj_out = open(„/var/www/cgi-bin/input_01.txt“, „w“) fobj_out.write(str(integer_byte)) fobj_out.close()
gpsdData . py
Auch das Script „gpsdData.py“ wird auf gleicher Weise als Cronjob nach dem Reboot und zusätzlich ca. stündlich (Zeitintervall kann als Cronjob beliebig verändert werden) ausgeführt, um die eingebaute RTC-Uhr zu synchronisieren. Das Script ermittelt Datum, Uhrzeit und bedarfsweise Positionsdaten von einem optional an der UART-Schnittstelle (RXD / TXD) der Zeitschaltuhr angeschlossenen GPS-Empfänger. Durch das regelmäßige Ermitteln der präzisen Uhrzeit von einem Satelliten und automatisches Aktualisieren der Systemzeit des Einplatinencomputers 7 sowie des eingebauten RTC-Moduls 4 wird dem langfristigen „abdriften“ der Echtzeituhr entgegengewirkt. Sollte kein GPS-Empfänger an der Computer- Zeitschaltuhr 1.1 , 1.2 angeschlossen sein, so kann die Systemzeit und das Systemdatum des Einplatinencomputers 7 auch über den Webserver verändert/eingestellt werden.
Nachfolgend das Programmierbeispiel in der Scriptsprache Python für die gewünschte Funktionsweise:
#! /usr/bin/env python2.7.9 import gps from gps import * from time import * import time import threading import subprocess gpsd = None class GpsPoller(threading.Thread): def init (self): threading.Thread. init (self) global gpsd gpsd = gps(mode=WATCH_ENABLE) self.current_value = None self.running = True def run(self): global gpsd while gpsp.running: gpsd.next() if __name__ == ' __main__ ': gpsp = GpsPoller() gpsp. start () while True: gpsd.next() if gpsd.utc != None and gpsd.utc != ": gpsutc = gpsd.utc[0:4] + gpsd.utc[5:7] + gpsd.utc[8:10] + ' ' + gpsd.utc[11:19] # Datum und Uhrzeit in das Computersystem schreiben subprocess.call([‚sudo date -u --set="%s"‘ % gpsutc], shell=True) time.sleep(1) # RTC-Zeit auf Systemzeit setzen subprocess.call([‚sudo hwclock -w‘], shell=True) sys.exit(0)
i2c_ein-ausgaenge.py
Die Programmierung wird mit einem Python-Script und den Bibliotheken smbus, time, RPi.GPIO as GPIO, signal, subprocess und sys erstellt.
Da dieses Script zuverlässig und ständig laufen muss, wird dieses von einem Linux „Service to Start“ (Respawn Service) als Hintergrund-Prozess überwacht und bei einem Systemfehler automatisch neu gestartet.
Das „Lesen“ der Eingänge und „Schreiben“ der Ausgänge des 16-Bit-Portexpander IC's erfolgt mittels Ausführung von unterschiedlichen, kleineren in Python programmierten Skripten. Daneben werden auch Bash- (Shell) Befehle mit den PHP-Skripten direkt ausgeführt, um den vollständigen Funktionsumfang der Zeitschaltuhr zu gewährleisten. Das zeitgesteuerte Schalten der Ausgänge wird durch Programmierung eines Cron-Daemons (Anlegen von zeitabhängigen Aufgaben / Cronjobs als Hintergrundprozesse) erledigt. Die Programmierung der Schaltzeiten erfolgt über direkte Eingabe eines Zeitpunktes oder Zeitintervalle, einer Kalenderfunktion bzw. mit Radio-Buttons und Checkboxen eines HTML Formulars.
Nachfolgend das Programmierbeispiel in der Scriptsprache Python für die gewünschte Funktionsweise:
#!/usr/bin/env python3 # -*- coding: utf-8 -*- import smbus import time import RPi.GPIO as GPIO import signal import subprocess import sys import os import imp # vlc Modulpfad pfad = os.path.expanduser(„/usr/local/lib/python3.4/dist- packages“) module_file = os.path.join(pfad, „vlc.py“) # Library vlc laden vlc = imp.load_source(‚vlc‘, module_file) import vlc bus = smbus.SMBus(1) #GPIO.setwarnings(False) #GPIO.setmode(GPIO.BCM) # GPIO-Nummer des Boards verwenden GPIO.setmode(GPIO.BOARD) # PIN-Nummer des Boards verwenden time.sleep(2) m_8 = 0 merker_8 = 0 m_7 = 0 merker _7 = 0 m_6 = 0 merker _6 = 0 m_5 = 0 merker _5 = 0 m_4 = 0 merker_4 = 0 m_3 = 0 merker_3 = 0 m_2 = 0 merker_2 = 0 m_1 = 0 merker_1 = 0 z8 = 0 z 7 = 0 z6 = 0 z5 = 0 z4 = 0 z3 = 0 z2 = 0 z1 = 0 o8 = 0 o7 = 0 o6 = 0 o5 = 0 o4 = 0 o3 = 0 o2 = 0 o1 = 0 hm8 = 0 hm7 = 0 hm6 = 0 hm5 = 0 hm4 = 0 hm3 = 0 hm2 = 0 hm1 = 0 v = 0 u = 0 s = 0 t = 0 d = 0 e = 0 f = 0 g = 0 h = 0 q8 = 0 q7 = 0 q6 = 0 q5 = 0 q4 = 0 q3 = 0 q2 = 0 q1 = 0 c = 100 # VLC-Player aufrufen global instance global player global media instance = vlc.Instance() player = instance.media_player_new() media = instance.media_new(‚http://br-brl- franken.cast.addradio.de/br/br1/franken/mp3/128/stream.mp3‘) #oder zum Beispiel #media = anstance.media_new(‚/home/Boga7paha6tI/Music/ Andy_Borg_-_Adios_Amor.mp3‘) player.set_media(media) DEVICE = 0x27 # I2C-Portexpander Adresse IO_DIRECTION_A = 0x06 # Festlegung Bank A als Ausgang # (0=Ausgang, 1=Eingang / # Werkseinstellung) IO_DIRECTION_B = 0x07 # Festlegung Bank B als Eingang # (0=Ausgang, 1=Eingang / # Werkseinstellung) IO_POLARITY_A = 0x04 # Festlegung der Polaritaet von # Bank A (0=Normal, 1=Invertiert) IO POLARITY B = 0x05 # Festlegung der Polaritaet von # Bank B (0=Normal, 1=Invertiert) OUTPORTA = 0x02 # Bank A Ausgaenge setzen INPORTB = 0x01 # Bank B Eingaenge lesen bus.write_byte_data(DEVICE,IO_DIRECTION_A,0x00) bus.write_byte_data(DEVICE,IO_DIRECTION_B,0xFF) # Konfiguration der ext. DALI-Taster # SW 1 steuert alle Devices (Broadcast Befehl) # SW 2 steuert nur Device 0 subprocess.Popen(„sudo i2cset -y 1 0x20 0x08 0x02 0xFF 0x02 0x01 i“, shell=True, stdout=subprocess.PIPE) GPIO.setup(40, GPIO.IN) GPIO.setup(40, GPIO.IN, pull_up_down = GPIO.PUD_UP) GPIO.setup(38, GPIO.IN) GPIO.setup(38, GPIO.IN, pull_up_down = GPIO.PUD_UP) #global sub #sub_8 = subprocess.Popen(„php ./var/www/htdocs/tl_zs_8.php“, shell=True, stdout=subprocess.PIPE) def eingang_config_01(): with open („/var/www/htdocs/schalten-extern.txt“) as rfile: line = rfile.readlines()[0:9] global ic1 global ic2 global ic3 global ic4 global ic5 global ic6 global ic7 global ic8 ic1 = int (line[0]) ic2 = int(line[l]) ic3 = int(line[2]) ic4 = int(line[3]) ic5 = int(line[4]) ic6 = int(line[5]) ic7 = int(line[6]) ic8 = int(line[7]) eingang config 01() def input_01(): # Zustaende der Ausgaenge aus Datei input_01.txt lesen fobj = open(„/var/www/cgi-bin/input _01.txt“) for line in fobj: str_byte = line.rstrip() Register2 = int(str_byte) ib = bin(Register2) [2:] .zfill (8) global out8 global out7 global out6 global out5 global out4 global out3 global out2 global out1 o8 = (ib[0]) o7 = (ib [1] ) o6 = (ib[2]) o5 = (ib[3]) o4 = (ib[4]) o3 = (ib[5]) o2 = (ib[6] ) o1 = (ib[7]) out8 = str(o8) out7 = str(o7) out6 = str(o6) out5 = str(o5) out4 = str(o4) out3 = str(o3) out2 = str(o2) out1 = str(o1) input_01 () def zustaende(): bus.write_byte_data(DEVICE,IO_DIRECTION_B,0xFF) Register2 = bus.read_byte_data(DEVICE, INPORTB) R2 = bin(Register2)[2:].zfill(8) global in8 global in7 global in6 global in5 global in4 global in3 global in2 global in1 in8 = (R2[0]) in7 = (R2[1]) in6 = (R2[2]) in5 = (R2[3]) in4 = (R2[4]) in3 = (R2[5]) in2 = (R2[6]) in1 = (R2[7]) def variable_q_read() : # Variablenzustaende aus Datei variable _q.txt lesen fobj_var = open(„/var/www/cgi-bin/variable q.txt“) for line_var in fobj_var: str_byte_var = line_var.rstrip() inhalt_var = int(str_byte_var) ib_var = bin(inhalt_var)[2:].zfill(8) global var8 global var7 global var6 global var5 global var4 global var3 global var2 global var1 o8_var = (ib_var[0]) o7_var = (ib_var[1]) o6_var = (ib_var[2]) o5_var = (ib_var[3]) o4_var = (ib_var[4]) o3_var = (ib_var[5]) o2_var = (ib_var[6]) o1_var = (ib_var[7]) var8 = str(o8-var) var7 = str(o7_var) var6 = str(o6_var) var5 = str(o5_var) var4 = str(o4_var) var3 = str(o3_var) var2 = str(o2_var) var1 = str(o1_var) def variable_q_write(): global int_byte var7 = „0“ var6 = „0“ var5 = „0“ var4 = „0“ var3 = „0“ var2 = „0“ varl = „0“ z = var8 + var7 + var6 + var5 + var4 + var3 + var2 + var1 # 8 Bit Ausdruck Variablenuebergabe int_byte = int(z, 2) # Zustaende der Ausgaenge in Datei variable q.txt schreiben fobj_out = open(„/var/www/cgi-bin/variable_q.txt“, „w“) fobj_out.write(str(int_byte)) fobj_out.close() def schalten(): time.sleep(.010) global integer_byte x = out8 + out7 + out6 + out5 + out4 + out3 + out2 + out1 # 8 Bit Ausdruck Port Expander Ausgang integer_byte= int(x, 2) #print (x) bus.write_byte_data(DEVICE,IO_DIRECTION_A,0x00) bus.write_byte_data(DEVICE,OUTPORTA,integer_byte) time.sleep(.020) # Zustaende der Ausgaenge in Datei input_01.txt schreiben fobj_out = open(„/var/www/cgi-bin/input_01.txt“, „w“) fobj_out.write(str(integer_byte)) fobj_out.close() def taster_8(): # Taster mit Wechselkontakt (Bruecke zwischen Oeffner und Schliesser!) am Eingang 8 anschliessen time.sleep(.050) global m_8 global merker_8 if merker_8 == 0: # steigende Flanke merker -8 = 1 m_8 = 1 elif merker_8 == 1: # Taster halten / anhaltender Impuls merker_8 = 2 m_8 = 1 elif merker_8 == 2: # fallende Flanke merker_8 = 3 m_8 = 0 elif merker _8 == 3: # Taster losgelassen / kein Impuls merker_8 = 0 m_8 = 0 def taster_7(): # Taster mit Wechselkontakt (Bruecke zwischen Oeffner und Schliesser!) am Eingang 7 anschliessen time.sleep(.050) global m_7 global merker_7 if merker_7 == 0: # steigende Flanke merker_7 = 1 m_7 = 1 elif merker_7 == 1: # Taster halten / anhaltender Impuls merker_7 = 2 m_7 = 1 elif merker_7 == 2: # fallende Flanke merker -7 = 3 m_7 = 0 elif merker _7 == 3: # Taster losgelassen / kein Impuls merker _7 = 0 m_7 = 0 def taster_6(): # Taster mit Wechselkontakt (Bruecke zwischen Oeffner und Schliesser!) am Eingang 6 anschliessen time.sleep(.050) global m_6 global merker _6 if merker_6 == 0: # steigende Flanke merker_6 = 1 m_6 = 1 elif merker_6 == 1: # Taster halten / anhaltender Impuls merker_6 = 2 m_6 = 1 elif merker_6 == 2: # fallende Flanke merker_6 = 3 m_6 = 0 elif merker_6 == 3: # Taster losgelassen / kein Impuls merker_6 = 0 m_6 = 0 def taster_5(): # Taster mit Wechselkontakt (Bruecke zwischen Oeffner und Schliesser!) am Eingang 5 anschliessen time.sleep(.050) global m_5 global merker _5 if merker _5 == 0: # steigende Flanke merker _5 = 1 m_5 = 1 elif merker _5 == 1: # Taster halten / anhaltender Impuls merker_5 = 2 m_5 = 1 elif merker_5 == 2: # fallende Flanke merker_5 = 3 m_5 = 0 elif merker _5 == 3: # Taster losgelassen / kein Impuls merker _5 = 0 m_5 = 0 def taster_4(): # Taster mit Wechselkontakt (Bruecke zwischen Oeffner und Schliesser!) am Eingang 4 anschliessen time.sleep(.050) global m_4 global merker_4 if merker_4 == 0: # steigende Flanke merker_4 = 1 m_4 = 1 elif merker_4 == 1: # Taster halten / anhaltender Impuls merker_4 = 2 m_4 = 1 elif merker_4 == 2: # fallende Flanke merker_4 = 3 m_4 = 0 elif merker_4 == 3: # Taster losgelassen / kein Impuls merker_4 = 0 m_4 = 0 def taster_3(): # Taster mit Wechselkontakt (Bruecke zwischen Oeffner und Schliesser!) am Eingang 3 anschliessen time.sleep(.050) global m_3 global merker_3 if merker _3 == 0: # steigende Flanke merker _3 = 1 m_3 = 1 elif merker _3 == 1: # Taster halten / anhaltender Impuls merker _3 = 2 m_3 = 1 elif merker _3 == 2: # fallende Flanke merker _3 = 3 m_3 = 0 elif merker_3 == 3: # Taster losgelassen / kein Impuls merker _3 = 0 m_3 = 0 def taster_2(): # Taster mit Wechselkontakt (Bruecke zwischen Oeffner und Schliesser!) am Eingang 2 anschliessen time.sleep(.050) global m_2 global merker _2 if merker_2 == 0: # steigende Flanke merker_2 = 1 m_2 = 1 elif merker_2 == 1: # Taster halten / anhaltender Impuls merker_2 = 2 m_2 = 1 elif merker_2 == 2: # fallende Flanke merker_2 = 3 m_2 = 0 elif merker_2 == 3: # Taster losgelassen / kein Impuls merker_2 = 0 m_2 = 0 def taster_1(): # Taster mit Wechselkontakt (Bruecke zwischen Oeffner und Schliesser!) am Eingang 1 anschliessen time.sleep(.050) global m_1 global merker _1 if merker _1 == 0: # steigende Flanke merker _1 = 1 m_1 = 1 elif merker_1 == 1: # Taster halten / anhaltender Impuls merker_1 = 2 m_1 = 1 elif merker_1 == 2: # fallende Flanke merker_1 = 3 m_1 = 0 elif merker_1 == 3: # Taster losgelassen / kein Impuls merker_1 = 0 m_1 = 0 def ch_8_ss(): # Eingang/Ausgang 8 als Stromstoßschalter global out8 global sub global f global m_8 time.sleep(.010) taster_8 () if m_8 == 1 and f == 0: out8 = „1“ f = f + 1 if m_8 == 0 and f == 1: out8 = „0“ f = 0 schalten () def ch_7_ss(): # Eingang/Ausgang 7 als Multimedia-Taster (Radiotaster ein/aus) global out7 global sub global s global m_7 time.sleep(.010) taster_7 () if m_7 == 1 and s == 0: player.play() out7 = „1“ # optional nur um zu sehen, ob Eingang 7 als Taster wirkt... s = s + 1 if m_7 == 0 and s == 1: player.audio_set_volume(c) player. stop () out7 = „0“ # optional nur um zu sehen, ob Eingang 7 als Taster wirkt... s = 0 schalten () def ch_6_ss(): # Eingang 6 als Multimedia-Taster (Lautstaerke einstellen) global out6 global sub global t global c global m_6 time.sleep(.010) taster_6() if m_6 == 1 and t == 0: #player.set_position(50) player.audio_set_volume(150) c = 150 #print(„leiser“) t = t + 1 if m_6 == 0 and t == 1: player.audio_set_volume(130) c = 130 #print(„leiser“) t = t + 1 if m_6 == 1 and t == 2: player.audio_set_volume(110) c = 110 #print(„leiser“) t = t + 1 if m_6 == 0 and t == 3: player.audio_set_volume(90) c = 90 #print(„leiser“) t = t + 1 if m_6 == 1 and t == 4: player.audio_set_volume(70) c = 70 #print(„leiser“) t = t + 1 if m_6 == 0 and t == 5: player.audio_set_volume(0) c = 150 #print („stumm“) t = 0 def ch_5_ss(): # Webradio mit Taster 5 als Stationswaehler fuer Radio Streams inkl. Stream beenden global out5 global sub global v, u global m_5 time.sleep(.010) taster_5() if m_5 == 1 and v == 0: subprocess.Popen([‚omxplayer‘, ‚http://stream.104.6rtl.com/rtl -80er/mp3- 192.mp3‘],stdin=subprocess.PIPE,stdout=subprocess.PIPE, stderr =subprocess.PIPE, close_fds=True) time.sleep(.400) v = v + 1 if m_5 == 0 and v == 1: time.sleep(.0100) v = v + 1 os.system(‚killall omxplayer.bin‘) subprocess.Popen([‚omxplayer‘, ‚http://br-br1- franken.cast.addradio.de/br/br1/franken/mp3/128/stream.mp3‘], stdin=subprocess.PIPE,stdout=subprocess.PIPE,stderr=subproces s.PIPE, close_fds=True) if m_5 == 1 and v == 2: time.sleep(.0100) os.system(‚killall omxplayer.bin‘) subprocess.Popen([‚omxplayer‘, ‚http://br-br3- live.cast.addradio.de/br/br3/live/mp3/128/stream.mp3‘],stdin= subprocess.PIPE,stdout=subprocess.PIPE,stderr=subprocess.PIPE , close_fds=True) v = v + 1 u = 1 time.sleep(.0100) # Wird nur benoetigt, wenn nur ein Webradio Stationswahltaster verwendet werden soll, um den Dienst des Musikplayers (Stream) zu beenden... if m_5 == 0 and u == 1: os.system(‚killall omxplayer.bin‘) time.sleep(.040) v = 0 u = 0 m_5 = 1 def ch_4_ss(): # Eingang 4 als WIFI-Taster (WIFI-Relais am Microcontroller ESP 8266 ein/aus) # MQTT-Protokoll mit Mosquitto ueber WIFI an Microcontroller ESP 8266 uebertragen global out4 global sub global d global m_4 time.sleep(.010) taster_4 () if m_4 == 1 and d == 0: subprocess.Popen(„mosquitto_pub -h 10.0.0.1 - t /test/switch/wifi_relay_001/relay/0 -m 1“, shell=True, stdout=subprocess.PIPE) d = d + 1 if m_4 == 0 and d == 1: subprocess.Popen(„mosquitto_pub -h 10.0.0.1 - t /test/switch/wifi_relay_001/relay/0 -m 0“, shell=True, stdout=subprocess.PIPE) d = 0 def ch_3_ss(): # Eingang 3 als DALI-Taster / I2C-Befehl an LW09 Chip, um DALI-Befehl # an DALI- Betriebsgeraet zu uebertragen global out3 global sub global e global m_3 time.sleep(.010) taster_3 () if m_3 == 1 and e == 0: subprocess.Popen(„sudo i2cset -y 1 0x20 0x01 0x01 0xFF i“, shell=True, stdout=subprocess.PIPE) # Broadcast-(Ein)befehl an alle Betriebsgeraete e = e + 1 if m_3 == 0 and e == 1: subprocess.Popen(„sudo i2cset -y 1 0x20 0x01 0x01 0x00 i“, shell=True, stdout=subprocess.PIPE) # Broadcast-(Aus)befehl an alle Betriebsgeraete e = 0 def ch_2_ss(): # Eingang/Ausgang 2 als Stromstoßschalter global out2 global sub global g global m_2 time.sleep(.010) taster_2 () if m_2 == 1 and g == 0: out2 = „1“ g = g + 1 if m_2 == 0 and 2 == 1: out2 = „0“ g = 0 schalten () def ch_1_ss(): # Eingang/Ausgang 8 als Stromstoßschalter global out1 global sub global h global m_1 time.sleep(.010) taster_1 () if m_1 == 1 and h == 0: out1 = „1“ h = h + 1 if m_1 == 0 and h == 1: out1 = „0“ h = 0 schalten () def ch_8_sf(): # Impulseingang 8 mit elektromechanischen Relais und Wechselkontakt global out8 global hm8 time.sleep(.005) hm8 = hm8 + 1 if hm8 == 1: out8 = „1“ elif hm8 == 2: out8 = „0“ hm8 = 0 schalten () if hm8 == 1: out8 = „1“ elif hm8 == 2: out8 = „0“ hm8 = 0 schalten () def ch_8_tl(): # Eingang/Ausgang 8 als Taster mit Treppenlicht- Zeitschaltfunktion global out8 global q8 global m_8 global var8 taster_8 () input_01 () variable_q_read() q8 = int(var8) time.sleep(.100) if (m_8 == 1 and q8 == 0) or (m_8 == 0 and q8 == 0): # Prozess Treppenlichtzeitfunktion starten sub_8 = subprocess.Popen(„/var/www/cgi- bin/ treppenlicht_8.py“, stdout=subprocess.PIPE) sub_8 if m_8 == 0 and q8 == 1: # Prozess Treppenlichtzeitfunktion beenden und wieder neu starten = nachtriggern subprocess.Popen(„sudo kill -s SIGINT $(ps aux | grep -v grep | grep /var/www/cgi-bin/treppenlicht_8.py | awk {‚print $2‘})“, shell=True, stdout=subprocess.PIPE) time.sleep(.100) sub_8 = subprocess.Popen(„/var/www/cgi- bin/treppenlicht_8.py“, stdout=subprocess.PIPE) sub_8 schalten() def button_abfrage(): # Funktionszuweisung Eingang 8 if ic8 == 1 and in8 == „1“ and in7 == „0“ and in6 == „0“ and in5 == „0“ and in4 == „0“ and in3 == „0“ and in2 == „0“ and in1 == „0“: ch_8_ss() # Stromstoßschalter elif ic8 == 2 and in8 == „1“ and in7 == „0“ and in6 == „0“ and in5 == „0“ and in4 == „0“ and in3 == „0“ and in2 == „0“ and in1 == „0“: ch_8_sf() # Impulseingang mit elektromechanischen Relais und Wechselkontakt elif ic8 == 3 and in8 == „1“ and in7 == „0“ and in6 == „0“ and in5 == „0“ and in4 == „0“ and in3 == „0“ and in2 == „0“ and in1 == „0“: ch_8_tl() # Treppenlicht-Zeitschalter elif ic8 == 0: out8 = „0“ # keine Funktion # Funktionszuweisung Eingang 7 if ic7 == 1 and in7 == „1“ and in8 == „0“ and in6 == „0“ and in5 == „0“ and in4 == „0“ and in3 == „0“ and in2 == „0“ and in1 == „0“: ch_7_ss() # Stromstoßschalter elif ic7 == 2 and in7 == „1“ and in8 == „0“ and in6 == „0“ and in5 == „0“ and in4 == „0“ and in3 == „0“ and in2 == „0“ and in1 == „0“: ch_7_sf() # Impulseingang mit elektromechanischen Relais und Wechselkontakt elif ic7 == 3 and in7 == „1“ and in8 == „0“ and in6 == „0“ and in5 == „0“ and in4 == „0“ and in3 == „0“ and in2 == „0“ and in1 == „0“: ch_7_tl() # Treppenlicht-Zeitschalter elif ic7 == 0: out7 = „0“ # keine Funktion # Funktionszuweisung Eingang 6 if ic6 == 1 and in6 == „1“ and in8 == „0“ and in7 == „0“ and in5 == „0“ and in4 == „0“ and in3 == „0“ and in2 == „0“ and in1 == „0“: ch_6_ss() # Stromstoßschalter elif ic6 == 2 and in6 == „1“ and in8 == „0“ and in6 == „0“ and in5 == „0“ and in4 == „0“ and in3 == „0“ and in2 == „0“ and in1 == „0“: ch_6_sf() # Impulseingang mit elektromechanischen Relais und Wechselkontakt elif ic6 == 3 and in6 == „1“ and in8 == „0“ and in7 == „0“ and in5 == „0“ and in4 == „0“ and in3 == „0“ and in2 == „0“ and in1 == „0“: ch_6_tl() # Treppenlicht-Zeitschalter elif ic6 == 0: out6 = „0“ # keine Funktion # Funktionszuweisung Eingang 5 if ic5 == 1 and in5 == „1“: ch_5_ss() # Stromstoßschalter elif ic5 == 2: ch_5_sf() # Impulseingang mit elektromechanischen Relais und Wechselkontakt elif ic5 == 3: ch_5_t1 () # Treppenlicht-Zeitschalter elif ic5 == 0: out5 = „0“ # keine Funktion # Funktionszuweisung Eingang 4 if ic4 == 1 and in4 == „1“: ch_4_ss() # Stromstoßschalter elif ic4 == 2: ch_4_sf() # Impulseingang mit elektromechanischen Relais und Wechselkontakt elif ic4 == 3: ch_4_tl () # Treppenlicht-Zeitschalter elif ic4 == 0: out4 = „0“ # keine Funktion # Funktionszuweisung Eingang 3 if ic3 == 1 and in3 == „1“: ch_3_ss() # Stromstoßschalter elif ic3 == 2: ch_3_sf() # Impulseingang mit elektromechanischen Relais und Wechselkontakt elif ic3 == 3: ch_3_tl() # Treppenlicht-Zeitschalter elif ic3 == 0: out3 = „0“ # keine Funktion # Funktionszuweisung Eingang 2 if ic2 == 1 and in2 == „1“: ch_2_ss() # Stromstoßschalter elif ic2 == 2: ch_2_sf() # Impulseingang mit elektromechanischen Relais und Wechselkontakt elif ic2 == 3: ch_2_tl o # Treppenlicht-Zeitschalter elif ic2 == 0: out2 = „0“ # keine Funktion # Funktionszuweisung Eingang 1 if ic1 == 1 and in1 == „1“: ch_1_ss() # Stromstoßschalter elif ic1 == 2: ch_1_sf() # Impulseingang mit elektromechanischen Relais und Wechselkontakt elif ic1 == 3: ch_1_tl () # Treppenlicht-Zeitschalter elif ic1 == 0: out1 = „0“ # keine Funktion def check_buttons_PE(channel): try: time.sleep(.0025) input_01() zustaende() button_abfrage() except IOError: return 0 def check _buttons _GPIO(channel): try: global out7 if GPIO.input(38) == 0: out7 = „1“ schalten () time.sleep(0.20) else: out7 = „0“ schalten ( ) time.sleep(0.20) if GPIO.input(38) == 0: out7 = „1“ schalten() time.sleep(0.20) else: out7 = „0“ schalten() time.sleep(0.20) except IOError: return 0 # 16 Bit Port Expander über Hardware-Interrupt am Pin 40 vom Einplatinen-Computer abfragen GPIO.add_event_detect(40, GPIO.FALLING, callback=check_buttons_PE, bouncetime=10) # GPIO 20 / Pin 38 vom Einplatinen-Computer als Interrupt abfragen GPIO.add_event_detect(38, GPIO.RISING, callback=check_buttons_GPIO, bouncetime=120) signal.pause() # Script am laufen halten GPIO.cleanup() # Cleanup GPIO bei Exit
i2c_on_chx.py
Das Python Script wird durch einen Cronjob (programmierte Schaltzeit) aufgerufen und schaltet den jeweiligen Ausgang auf Low-Pegel.
#!/usr/bin/env python3 # -*- coding: utf-8 -*- import smbus import sys import time bus = smbus.SMBus(1) DEVICE = 0x27 # I2C-Portexpander Adresse IO_DIRECTION_A = 0x06 # Festlegung Bank A als Ausgang (0=Ausgang, 1=Eingang / Werkseinstellung) OUTPORTA = 0x02 # Bank A Ausgaenge setzen # Zustaende der Ausgaenge aus Datei input_01.txt lesen fobj = open („/var/www/cgi-bin/input_01.txt“) for line in fobj: str_byte = line.rstrip() Register2 = int(str_byte) ib = bin(Register2) [2:] .zfill(8) o8 = (ib [0]) o7 = (ib [1]) o6 = (ib [2]) o5 = (ib [3]) o4 = (ib [4]) o3 = (ib[5]) o2 = (ib [6]) o1 = (ib[7]) out8 = str(o8) out7 = str(o7) out6 = str(o6) out5 = str(o5) out4 = str(o4) out3 = str(o3) out2 = str(o2) out1 = str(o1) # Automatik (ein/aus) fuer Ausgaenge aus Datei kanal.txt lesen with open(„/var/www/htdocs/kanal.txt“) as rfile: line_k_l = rfile.readlines()[0:1] line_k1 = [line.strip() for line in line_k_1] if line_kl == [‚1‘] and out2 == „0“: out1 =„1“ # Kanal / Ausgang 8 per Zeitfunktion schalten x = out8 + out7 + out6 + out5 + out4 + out3 + out2 + out1 # 8 Bit Ausdruck Port Expander Ausgang integer_byte= int(x, 2) bus.write_byte_data(DEVICE,IO_DIRECTION_A,0x00) bus.write_byte_data(DEVICE,OUTPORTA,integer_byte) # Zustaende der Ausgaenge in Datei input_01.txt schreiben fobj_out = open(„/var/www/cgi-bin/input_01.txt“, „w“) fobj_out.write(str(integer_byte) ) fobj_out.close()
i2c_off_ chx.py
Das Python Script wird durch einen Cronjob (programmierte Schaltzeit) aufgerufen und schaltet den jeweiligen Ausgang auf High-Pegel.
#!/usr/bin/env python3 # -*- coding: utf-8 -*- import smbus import sys import time bus = smbus.SMBus(1) DEVICE = 0x27 # I2C-Portexpander Adresse IO_DIRECTION_A = 0x06 # Festlegung Bank A als Ausgang (0=Ausgang, 1=Eingang / Werkseinstellung) OUTPORTA = 0x02 # Bank A Ausgaenge setzen # Zustaende der Ausgaenge aus Datei input_01.txt lesen fobj = open(„/var/www/cgi-bin/input_01.txt“) for line in fobj: str_byte = line.rstrip() Register2 = int(str_byte) ib = bin(Register2) [2:].zfill(8) o8 = (ib [0] ) o7 = (ib[1]) o6 = (ib [2]) o5 = (ib [3]) o4 = (ib [4]) o3 = (ib [5]) o2 = (ib [6]) o1 = (ib [7]) out8 = str(o8) out7 = str(o7) out6 = str(o6) out5 = str(o5) out4 = str(o4) out3 = str (o3) out2 = str(o2) out1 = str(o1) # Automatik (ein/aus) fuer Ausgaenge aus Datei kanal.txt lesen with open(„/var/www/htdocs/kanal.txt“) as rfile: line_k_l = rfile.readlines()[0:1] line_kl = [line.strip() for line in line_k_1] if line_kl == [‚1‘] and out1 == „1“: out1 =„0“ if line_kl == [‚0‘]: out1 =„0“ # Kanal / Ausgang 8 per Zeitfunktion schalten x = out8 + out7 + out6 + out5 + out4 + out3 + out2 + out1 # 8 Bit Ausdruck Port Expander Ausgang integer_byte= int(x, 2) bus.write_byte_data(DEVICE,IO_DIRECTION_A,0x00) bus.write_byte_data(DEVICE,OUTPORTA,integer_byte) # Zustaende der Ausgaenge in Datei input_01.txt schreiben fobj_out = open(„/var/www/cgi-bin/input_01.txt“, „w“) fobj_out.write(str(integer_byte)) fobj_out.close()
treppenlicht_x.py
Das Python Script realisiert einen Treppenlichtzeitschalter, die Funktion kann über das Web Interface voreingestellt werden für einen bestimmten Eingang und zugehörigen Ausgang.
#!/usr/bin/env python3 # -*- coding: utf-8 -*- import smbus import time bus = smbus.SMBus(1) DEVICE = 0x27 # I2C-Portexpander Adresse IO_DIRECTION_A = 0x06 # Festlegung Bank A als Ausgang (0=Ausgang, 1=Eingang / Werkseinstellung) IO_POLARITY_A = 0x04 # Festlegung der Polaritaet von Bank A (0=Normal, 1=Invertiert) OUTPORTA = 0x02 # Bank A Ausgaenge setzen bus.write_byte_data(DEVICE,IO_DIRECTION_A,0x00) global var8 global var7 global var6 global var5 global var4 global var3 global var2 global var1 var8 = „0“ var7 = „0“ var6 = „0“ var5 = „0“ var4 = „0“ var3 = „0“ var2 = „0“ var1 = „0“ # Festlegung der Zeiten - Wertuebergabe von Web-Interface an nachfolgende Variablen vorgesehen... ez 1 = 180 # ez = Einschaltzeit bz_1 = 0.5 # bz = Blinkzeit der Ausschaltvorwarnung az_1 = 60 # az = Ausschaltzeit def input_01(): # Zustaende der Ausgaenge aus Datei input_01.txt lesen fobj = open („/var/www/cgi-bin/input_01.txt“) for line in fobj: str_byte = line.rstrip() Register2 = int(str_byte) ib = bin(Register2) [2:].zfill(8) global out8 global out7 global out6 global out5 global out4 global out3 global out2 global out1 o8 = (ib[0]) o7 = (ib[1]) o6 = (ib[2]) o5 = (ib[3]) o4 = (ib[4]) o3 = (ib[5]) o2 = (ib[6]) o1 = (ib[7]) out8 = str(o8) out7 = str(o7) out6 = str(o) out5 = str(o5) out4 = str(o4) out3 = str(o3) out2 = str(o2) out1 = str(o1) def schalten(): time.sleep(.010) global integer_byte global out8 global out7 global out6 global out5 global out4 global out3 global out2 global out1 x = out8 + out7 + out6 + out5 + out4 + out3 + out2 + out1 # 8 Bit Ausdruck Port Expander Ausgang integer_byte = int(x, 2) bus.write_byte_data(DEVICE,IO_DIRECTION_A,0x00) bus.write_byte_data(DEVICE,OUTPORTA,integer_byte) time.sleep(.010) # Zustaende der Ausgaenge in Datei input_01.txt schreiben fobj_out = open(„/var/www/cgi-bin/input_01.txt“, „w“) fobj_out.write(str(integer_byte)) fobj_out.close() def variable_q_read(): # Zustaende der Variable q aus Datei variable q.txt lesen fobj_q = open („/var/www/cgi-bin/variable_q.txt“) for line_q in fobj_q: str_byte_q = line_q.rstrip() fq = int(str_byte_q) ib_q = bin(fq) [2:] .zfill (8) global var8 global var7 global var6 global var5 global var4 global var3 global var2 global var1 oq_8 = (ib_q[0]) oq_7 = (ib_q[1]) oq_6 = (ib_q[2]) oq_5 = (ib_q[3]) oq_4 = (ib_q[4]) oq_3 = (ib_q[5]) oq_2 = (ib_q[6]) oq_1 = (ib_q[7]) var8 = str(oq_8) var7 = str(oq_7) var6 = str(oq_6) var5 = str(oq_5) var4 = str(oq_4) var3 = str(oq_3) var2 = str(oq_2) var1 = str(oq_1) def variable_q_write(): global int_byte global var8 global var7 global var6 global var5 global var4 global var3 global var2 global var1 z = var8 + var7 + var6 + var5 + var4 + var3 + var2 + var1 # 8 Bit Ausdruck Variablenuebergabe int_byte = int(z, 2) # Zustaende der Ausgaenge in Datei variable_q.txt schreiben fobj_out = open(„/var/www/cgi-bin/variable_q.txt“, „w“) fobj_out.write(str(int_byte)) fobj_out.close() def einschalten(): global var8 global var7 global var6 global var5 global var4 global var3 global var2 global var1 global out8 global out7 global out6 global out5 global out4 global out3 global out2 global out1 variable_q_read() var1 = „1“ variable_q_write() input_01() out1 = „1“ schalten () def ausschalten(): global var8 global var7 global var6 global var5 global var4 global var3 global var2 global var1 global out8 global out7 global out6 global out5 global out4 global out3 global out2 global out1 variable_q_read() var1 = „0“ variable_q_write() input_01() out1 = „0“ schalten () einschalten() time.sleep(ez_1) ausschalten () time.sleep(bz_1) einschalten() time.sleep(bz_1) ausschalten () time.sleep(bz_1) einschalten() time.sleep(bz_1) ausschalten () time.sleep(bz_1) einschalten() time.sleep(bz_1) ausschalten() time.sleep(bz_1) einschalten() time.sleep(az_1) ausschalten()
emailsenden.py
Das Python Script ermöglicht das Senden einer Emailnachricht, wenn z.B. an einem Eingang ein Signalwechsel von Low auf High erfolgt. Über das Web Interface ist angedacht, dass eine beliebige Texteingabe für die Email erfolgen kann. Beim nachfolgenden Beispiel ist der Text in der Programmierung vorgegeben und kann nur durch den Programmierer verändert werden. Die in den Befehlen mit „xxx“ Platzhalter gekennzeichneten Stellen müssen individuell angepasst werden.
#!/usr/bin/env python # -*- coding: utf-8 -*- from email.mime.text import MIMEText import smtplib import sys # Absender Emailadresse sender = ‚zeitschaltuhr@xxx.de‘ # Adresse SMTP Server smtpserver = ‚smtp.xxx‘ # SMTP Benutzername smtpusername = ‚zeitschaltuhr@xxx.de‘ # SMTP Passwort smtppassword = ‚xxx‘ # Benutze TLS / SSL - Verschluesselung usetls = True def sendmail(recipient,subject,content): # RFC 2822 Nachricht erzeugen msg = MIMEText(content) msg[‚From‘] = sender msg[‚To‘] = recipient msg[‚Subject‘] = subject # SMTP Verbindung oeffnen server = smtplib.SMTP(smtpserver) # Starte TLS / SSL - Verschluesselung if usetls: server.starttls() # Login Emailserver if smtpusername and smtppassword: server.login(smtpusername,smtppassword) # Nachricht senden server.sendmail(sender,recipient,msg.as_string()) # SMTP-Server schliessen server.quit() def main(): # Nachrichtentext senden an sendmail(‚xxx@xxx.xx‘, 'Testmail', 'Hier den gewünschten Text eingeben!') # Python Script beenden sys.exit(0) if __name__ == ' __main __': main ()
vlc_http.py
Das Python Script ruft das implementierte Web Interface des VLC-Players auf. Genauso gut kann der Aufruf über ein PHP-Script erfolgen, damit das Web Interface direkt aus der GUI der elektronischen Zeitschaltuhr aufgerufen wird. Das Passwort für das Web Interface des VLC-Players ist in den Einstellungen des VLC-Players fest eingestellt und ist nicht angedacht vom Errichter / Bediener der Zeitschaltuhr zu verändern.
#!/usr/bin/env python3 # -*- coding: utf-8 -*- # Anmeldung # Feld Benutzername leer lassen # Passwort = vlc import time import subprocess time.sleep(10) subprocess.Popen(„vlc -I http --http-host 192.168.178.58:8080“, shell=True, stdout=subprocess.PIPE) subprocess.Popen(„vlc -I http --http-host 10.0.0.1:8080“, shell=True, stdout=subprocess.PIPE)
wifi_relais_x_on.py / wifi_relais_x_off.py
Das Python Script sendet den Befehl zum Signalwechsel Low zu High an ein WIFI-Relais. Als Übertragungsprotokoll wird MQTT verwendet. Die elektronische Zeitschaltuhr ist der MQTT-Broker und das WIFI-Relais ist der MQTT-Client.
#!/usr/bin/env python3 # -*- coding: utf-8 -*- import subprocess # ON-Befehl subprocess.Popen(„mosquitto_pub -h 10.0.0.1 -t /test/switch/wifi_relay_001/relay/0 -m 1“, shell=True, stdout=subprocess.PIPE) #!/usr/bin/env python3 # -*- coding: utf-8 -*- import subprocess # OFF-Befehl subprocess.Popen(„mosquitto_pub -h 10.0.0.1 -t /test/switch/wifi_relay_001/relay/0 -m 0“, shell=True, stdout=subprocess.PIPE)
vlc.py
Das Python Script wird als externe Python-Library aufgerufen. Die Library wurde vom VideoLan Team programmiert und unter liegt der GNU / GPL. Es dient der Ansteuerung des Mediaplayers VLC durch die elektronische Zeitschaltuhr. Eine Fernbedienung durch an die Zeitschaltuhr angeschlossene Taster oder eine automatische Zeitsteuerung oder eine Steuerung des VLC-Players über das Web Interface der Zeitschaltuhr von Audio- und Videosignalen mit Ausgabe an der HDMI-Schnittstelle wird in Verbindung mit weiteren Scripten ermöglicht.
#! /usr/bin/python # -*- coding: utf-8 -*- # Python ctypes bindings for VLC # Copyright (C) 2009-2012 the VideoLAN team # $Id: $ # # Authors: Olivier Aubert <contact at olivieraubert.net> # Jean Brouwers <MrJean1 at gmail.com> # Geoff Salmon <geoff.salmon at gmail.com> # # This library is free software; you can redistribute it and/or modify # it under the terms of the GNU Lesser General Public License as # published by the Free Software Foundation; either version 2.1 of the # License, or (at your option) any later version. # # This library is distributed in the hope that it will be useful, but # WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # Lesser General Public License for more details. # # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA " " "This module provides bindings for the LibVLC public API, see U{http://wiki.videolan.org/LibVLC}. You can find the documentation and a README file with some examples at U{http://www.advene.org/download/python-ctypes/}. Basically, the most important class is L{Instance}, which is used to create a libvlc instance. From this instance, you then create L{MediaPlayer} and L{MediaListPlayer} instances. Alternatively, you may create instances of the L{MediaPlayer} and L{MediaListPlayer} class directly and an instance of L{Instance} will be implicitly created. The latter can be obtained using the C{get_instance} method of L{MediaPlayer} and L{MediaListPlayer}. “ “ “ import ctypes from ctypes.util import find_library import os import sys import functools # Used by EventManager in override.py from inspect import getargspec __version__ = „2.2.4“ build_date = „Mon Mar 20 11:04:27 2017 - 2.2.4“ # The libvlc doc states that filenames are expected to be in UTF8, do # not rely on sys.getfilesystemencoding() which will be confused, # esp. on windows. DEFAULT_ENCODING = ‚utf-8‘ if sys.version_info[0] > 2: str = str unicode = str bytes = bytes basestring = (str, bytes) PYTHON3 = True def str_to_bytes(s): “ “ “Translate string or bytes to bytes. “ “ “ if isinstance (s, str): return bytes(s, DEFAULT_ENCODING) else: return s def bytes_to_str(b): “ “ “Translate bytes to string. “ “ “ if isinstance(b, bytes): return b.decode(DEFAULT_ENCODING) else: return b else: str = str unicode = unicode bytes = str basestring = basestring PYTHON3 = False def str_to_bytes(s): “ “ “Translate string or bytes to bytes. “ “ “ if isinstance(s, unicode): return s.encode(DEFAULT_ENCODING) else: return s def bytes_to_str(b): “ “ “Translate bytes to unicode string. “ “ “ if isinstance(b, str): return unicode(b, DEFAULT_ENCODING) else: return b # Internal guard to prevent internal classes to be directly # instanciated. _internal_guard = object() def find_lib(): dll = None plugin_path = None if sys.platform.startswith(‚linux‘): p = find_library(‚vlc‘) try: dll = ctypes.CDLL(p) except OSError: # may fail dll = ctypes.CDLL(‚libvlc.so.5‘) elif sys.platform.startswith(‚win‘): libname = ‚libvlc.dll‘ p = find_library(libname) if p is None: try: # some registry settings # leaner than win32api, win32con if PYTHON3: import winreg as w else: import _winreg as w for r in w.HKEY_LOCAL_MACHINE, w.HKEY_CURRENT_USER: try: r = w.OpenKey(r, 'Software\\VideoLAN\\VLC') plugin_path, _ = w.QueryValueEx(r, 'InstallDir') w.CloseKey(r) break except w.error: pass except ImportError: # no PyWin32 pass if plugin_path is None: # try some standard locations. programfiles = os.environ[„ProgramFiles“] homedir = os.environ[„HOMEDRIVE“] for p in (‚{programfiles}\\VideoLan{libname}‘, '{homedir}:\\VideoLan{libname}', '{programfiles} {libname}', '{homedir}:{libname}'): p = p.format(homedir = homedir, programfiles = programfiles, libname = ‚\\VLC\\‘ + libname) if os.path.exists(p): plugin_path = os.path.dirname(p) break if plugin_path is not None: # try loading p = os.getcwd() os.chdir(plugin_path) # if chdir failed, this will raise an exception dll = ctypes.CDLL(libname) # restore cwd after dll has been loaded os.chdir(p) else: # may fail dll = ctypes.CDLL(libname) else: plugin_path = os.path.dirname(p) dll = ctypes.CDLL(p) elif sys.platform.startswith(‚darwin‘): # FIXME: should find a means to configure path d = ‚/Applications/VLC.app/Contents/MacOS/‘ p = d + ‚lib/libvlc.dylib‘ if os.path.exists(p): dll = ctypes.CDLL(p) for p in (‚modules‘, ‚plugins‘): p = d + p if os.path.isdir(p): plugin_path = p break else: # hope, some PATH is set... dll = ctypes.CDLL(‚libvlc.dylib‘) else: raise NotImplementedError(‚%s: %s not supported‘ % (sys.argv[0], sys.platform)) return (dll, plugin_path) # plugin_path used on win32 and MacOS in override.py dll, plugin_path = find_lib() class VLCException(Exception): “ “ “Exception raised by libvlc methods. “ “ “ pass try: _Ints = (int, long) except NameError: # no long in Python 3+ _Ints = int _Seqs = (list, tuple) # Used for handling *event_manager() methods. class memoize_parameterless(object): “ “ “Decorator. Caches a parameterless method's return value each time it is called. If called later with the same arguments, the cached value is returned (not reevaluated). Adapted from https://wiki.python.org/moin/PythonDecoratorLibrary “ “ “ def __init__(self, func): self.func = func self._cache = {} def __call__(self, obj): try: return self._cache[obj] except KeyError: v = self._cache[obj] = self.func(obj) return v def __repr__(self): “ “ “Return the function's docstring. “ “ “ return self.func.__doc__ def __get__(self, obj, objtype): “ “ “Support instance methods. “ “ “ return functools.partial(seif.__call__, obj) # Default instance. It is used to instanciate classes directly in the # 00-wrapper. _default_instance = None def get_default_instance(): “ “ “Return the default VLC.Instance. “ “ “ global _default_instance if _default_instance is None: _default_instance = Instance() return _default_instance _Cfunctions = {} # from LibVLC __version__ _Globals = globals() # sys.modules[__name__].__dict__ def _Cfunction(name, flags, errcheck, *types): " " “(INTERNAL) New ctypes function binding. “ „ “ if hasattr(dll, name) and name in _Globals: p = ctypes.CFUNCTYPE(*types) f = p((name, dll), flags) if errcheck is not None: f.errcheck = errcheck # replace the Python function # in this module, but only when # running as python -0 or -00 if __debug__: _Cfunctions[name] = f else: _Globals[name] = f return f raise NameError(‚no function %r‘ % (name,)) def _Cobject(cls, ctype): " " “(INTERNAL) New instance from ctypes. “ “ “ o = object.__new__(cls) o._as_parameter_ = ctype return o def _Constructor(cls, ptr=_internal_guard): " " “(INTERNAL) New wrapper from ctypes. “ “ “ if ptr == _internal_guard: raise VLCException(„(INTERNAL) ctypes class. You should get references for this class through methods of the LibVLC API.“) if ptr is None or ptr == 0: return None return _Cobject(cls, ctypes.c_void_p(ptr)) class _Cstruct(ctypes.Structure): " " “(INTERNAL) Base class for ctypes structures. “ “ “ _fields_ = [] # list of 2-tuples (‚name‘, ctyptes.<type>) def __str__(self): 1 = [' %s:\t%s' % (n, getattr(self, n)) for n, _ in self._fields_] return ‚\n‘.join([self.__class__.__name__] + 1) def __repr__(self): return ‚%s.%s‘ % (self.__class__.__module__, self) class _Ctype(object): " " “(INTERNAL) Base class for ctypes. “ “ “ @staticmethod def from_param(this): # not self " " "(INTERNAL) ctypes parameter conversion method. " " " if this is None: return None return this._as_parameter_ class ListPOINTER(object): " " "Just like a POINTER but accept a list of ctype as an argument. " “ “ def __init__(self, etype): self.etype = etype def from_param(self, param): if isinstance(param, _Seqs): return (self.etype * len(param))(*param) else: return ctypes.POINTER(param) # errcheck functions for some native functions. def string_result(result, func, arguments): " " “Errcheck function. Returns a string and frees the original pointer. It assumes the result is a char *. “ „ “ if result: # make a python string copy s = bytes_to_str(ctypes.string_at(result)) # free original string ptr libvlc_free(result) return s return None def class_result(classname): " " “Errcheck function. Returns a function that creates the specified class. “ “ “ def wrap_errcheck(result, func, arguments): if result is None: return None return classname(result) return wrap_errcheck # Wrapper for the opaque struct libvlc_log_t class Log(ctypes.Structure): pass Log_ptr = ctypes.POINTER(Log) # FILE* ctypes wrapper, copied from # http://svn.python.org/projects/ctypes/trunk/ctypeslib/ctypesl ib/contrib/pythonhdr.py class FILE(ctypes.Structure): pass FILE_ptr = ctypes.POINTER(FILE) if PYTHON3: PyFile_FromFd = ctypes.pythonapi.PyFile_FromFd PyFile_FromFd.restype = ctypes.py_object PyFile_FromFd.argtypes = [ctypes.c_int, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_int, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_int] PyFile_AsFd = ctypes.pythonapi.PyObject_AsFileDescriptor PyFile_AsFd.restype = ctypes.c_int PyFile_AsFd.argtypes = [ctypes.py_object] else: PyFile_FromFile = ctypes.pythonapi.PyFile_FromFile PyFile_FromFile.restype = ctypes.py_object PyFile_FromFile.argtypes = [FILE_ptr, ctypes.c_char_p, ctypes.c_char_p, ctypes.CFUNCTYPE(ctypes.c_int, FILE_ptr)] PyFile_AsFile = ctypes.pythonapi.PyFile_AsFile PyFile_AsFile.restype = FILE_ptr PyFile_AsFile.argtypes = [ctypes.py_object] # Generated enum types # class _Enum(ctypes.c_uint): ''' (INTERNAL) Base class ''' _enum_names_ = {} def __str__(self): n = self._enum_names_.get(self.value,'') or (‚FIXME_(%r)‘ % (self.value,)) return ‚.'‘.join((self.__class__.__name__, n)) def __hash__(self): return self.value def __repr__(self): return ‚.'‘.join((seif.__class__.__module__, self.__str__())) def __eq__(self, other): return ((isinstance(other, _Enum) and self.value == other.value) or (isinstance(other, _Ints) and self.value == other)) def __ne__(self, other): return not seif.__eq__(other) class LogLevel(_Enum): '''Logging messages level. \note future libvlc versions may define new levels. ''' _enum_names_ = { 0: ‚DEBUG‘, 2: ‚NOTICE‘, 3: ‚WARNING‘, 4: ‚ERROR‘, } LogLevel.DEBUG = LogLevel(0) LogLevel.ERROR = LogLevel(4) LogLevel.NOTICE = LogLevel(2) LogLevel.WARNING = LogLevel(3) class EventType(_Enum): '''Event types. ''' _enum_names_ = { 0: ‚MediaMetaChanged‘, 1: ‚MediaSubItemAdded‘, 2: ‚MediaDurationChanged‘, 3: ‚MediaParsedChanged‘, 4: ‚MediaFreed‘, 5: ‚MediaStateChanged‘, 6: ‚MediaSubItemTreeAdded‘, 0x100: ‚MediaPlayerMediaChanged‘, 257: ‚MediaPlayerNothingSpecial‘, 258: ‚MediaPlayerOpening‘, 259: ‚MediaPlayerBuffering‘, 260: ‚MediaPlayerPlaying‘, 261: ‚MediaPlayerPaused‘, 262: ‚MediaPlayerStopped‘, 263: ‚MediaPlayerForward‘, 264: ‚MediaPlayerBackward‘, 265: ‚MediaPlayerEndReached‘, 266: ‚MediaPlayerEncounteredError‘, 267: ‚MediaPlayerTimeChanged‘, 268: ‚MediaPlayerPositionChanged‘, 269: ‚MediaPlayerSeekableChanged‘, 270: ‚MediaPlayerPausableChanged‘, 271: ‚MediaPlayerTitleChanged‘, 272: ‚MediaPlayerSnapshotTaken‘, 273: ‚MediaPlayerLengthChanged‘, 274: ‚MediaPlayerVout‘, 275: ‚MediaPlayerScrambledChanged‘, 279: ‚MediaPlayerCorked‘, 280: ‚MediaPlayerUncorked‘, 281: ‚MediaPlayerMuted‘, 282: ‚MediaPlayerUnmuted‘, 283: ‚MediaPlayerAudioVolume‘, 0x200: ‚MediaListItemAdded‘, 513: ‚MediaListWillAddItem‘, 514: ‚MediaListItemDeleted‘, 515: ‚MediaListWillDeleteItem‘, 0x300: ‚MediaListViewItemAdded‘, 769: ‚MediaListViewWillAddItem‘, 770: ‚MediaListViewItemDeleted‘, 771: ‚MediaListViewWillDeleteItem‘, 0x400: ‚MediaListPlayerPlayed‘, 1025: ‚MediaListPlayerNextItemSet‘, 1026: ‚MediaListPlayerStopped‘, 0x500: ‚MediaDiscovererStarted‘, 1281: ‚MediaDiscovererEnded‘, 0x600: ‚VlmMediaAdded‘, 1537: ‚VlmMediaRemoved‘, 1538: ‚VlmMediaChanged‘, 1539: ‚VlmMediaInstanceStarted‘, 1540: ‚VlmMediaInstanceStopped‘, 1541: ‚VlmMediaInstanceStatusInit‘, 1542: ‚VlmMediaInstanceStatusOpening‘, 1543: ‚VlmMediaInstanceStatusPlaying‘, 1544: ‚VlmMediaInstanceStatusPause‘, 1545: ‚VlmMediaInstanceStatusEnd‘, 1546: ‚VlmMediaInstanceStatusError‘, } EventType.MediaDiscovererEnded = EventType(1281) EventType.MediaDiscovererStarted = EventType(0×500) EventType.MediaDurationChanged = EventType(2) EventType.MediaFreed = EventType(4) EventType.MediaListItemAdded = EventType(0x200) EventType.MediaListItemDeleted = EventType(514) EventType.MediaListPlayerNextItemSet = EventType(1025) EventType.MediaListPlayerPlayed = EventType(0x400) EventType.MediaListPlayerStopped = EventType(1026) EventType.MediaListViewItemAdded = EventType(0x300) EventType.MediaListViewItemDeleted = EventType(770) EventType.MediaListViewWillAddItem = EventType(769) EventType.MediaListViewWillDeleteItem = EventType(771) EventType.MediaListWillAddItem = EventType(513) EventType.MediaListWillDeleteItem = EventType(515) EventType.MediaMetaChanged = EventType(0) EventType.MediaParsedChanged = EventType(3) EventType.MediaPlayerAudioVolume = EventType(283) EventType.MediaPlayerBackward = EventType(264) EventType.MediaPlayerBuffering = EventType(259) EventType.MediaPlayerCorked = EventType(279) EventType.MediaPlayerEncounteredError = EventType(266) EventType.MediaPlayerEndReached = EventType(265) EventType.MediaPlayerForward = EventType(263) EventType.MediaPlayerLengthChanged = EventType(273) EventType.MediaPlayerMediaChanged = EventType(0x100) EventType.MediaPlayerMuted = EventType(281) EventType.MediaPlayerNothingSpecial = EventType(257) EventType.MediaPlayerOpening = EventType(258) EventType.MediaPlayerPausableChanged = EventType(270) EventType.MediaPlayerPaused = EventType(261) EventType.MediaPlayerPlaying = EventType(260) EventType.MediaPlayerPositionChanged = EventType(268) EventType.MediaPlayerScrambledChanged = EventType(275) EventType.MediaPlayerSeekableChanged = EventType(269) EventType.MediaPlayerSnapshotTaken = EventType(272) EventType.MediaPlayerStopped = EventType(262) EventType.MediaPlayerTimeChanged = EventType(267) EventType.MediaPlayerTitleChanged = EventType(271) EventType.MediaPlayerUncorked = EventType(280) EventType.MediaPlayerUnmuted = EventType(282) EventType.MediaPlayerVout = EventType(274) EventType.MediaStateChanged = EventType(5) EventType.MediaSubItemAdded = EventType(1) EventType.MediaSubItemTreeAdded = EventType(6) EventType.VlmMediaAdded = EventType(0x600) EventType.VlmMediaChanged = EventType(1538) EventType.VlmMediaInstanceStarted = EventType(1539) EventType.VlmMediaInstanceStatusEnd = EventType(1545) EventType.VlmMediaInstanceStatusError = EventType(1546) EventType.VlmMediaInstanceStatusInit = EventType(1541) EventType.VlmMediaInstanceStatusOpening = EventType(1542) EventType.VlmMediaInstanceStatusPause = EventType(1544) EventType.VlmMediaInstanceStatusPlaying = EventType(1543) EventType.VlmMediaInstanceStopped = EventType(1540) EventType.VlmMediaRemoved = EventType(1537) class Meta(_Enum): '''Meta data types. ' ‚ '‘ _enum_names_ = { 0: ‚Title‘, 1: ‚Artist‘, 2: ‚Genre‘, 3: ‚Copyright‘, 4: ‚Album‘, 5: ‚TrackNumber‘, 6: ‚Description‘, 7: ‚Rating‘, 8: ‚Date‘, 9: ‚Setting‘, 10: ‚URL‘, 11: ‚Language‘, 12: ‚NowPlaying‘, 13: ‚Publisher‘, 14: ‚EncodedBy‘, 15: ‚ArtworkURL‘, 16: ‚TrackID‘, 17: ‚TrackTotal‘, 18: ‚Director‘, 19: ‚Season‘, 20: ‚Episode‘, 21: ‚ShowName‘, 22: ‚Actors‘, } Meta.Actors = Meta(22) Meta.Album = Meta(4) Meta.Artist = Meta(1) Meta.ArtworkURL = Meta(15) Meta.Copyright = Meta(3) Meta.Date = Meta(8) Meta.Description = Meta(6) Meta.Director = Meta(18) Meta.EncodedBy = Meta(14) Meta.Episode = Meta(20) Meta.Genre = Meta(2) Meta.Language = Meta(11) Meta.NowPlaying = Meta(12) Meta.Publisher = Meta(13) Meta.Rating = Meta(7) Meta.Season = Meta(19) Meta.Setting = Meta(9) Meta.ShowName = Meta(21) Meta.Title = Meta(0) Meta.TrackID = Meta(16) Meta.TrackNumber = Meta(5) Meta.TrackTotal = Meta(17) Meta.URL = Meta(10) class State(_Enum): '''Note the order of libvlc_state_t enum must match exactly the order of See mediacontrol_playerstatus, See input_state_e enums, and videolan.libvlc.state (at bindings/cil/src/media.cs). expected states by web plugins are: idle/close=0, opening=1, buffering=2, playing=3, paused=4, stopping=5, ended=6, error=7. ''' _enum_names_ = { 0: ‚NothingSpecial‘, 1: ‚Opening‘, 2: ‚Buffering‘, 3: ‚Playing‘, 4: ‚Paused‘, 5: ‚Stopped‘, 6: ‚Ended‘, 7: ‚Error‘, } State.Buffering = State(2) State.Ended = State(6) State.Error = State(7) State.NothingSpecial = State(0) State.Opening = State(1) State.Paused = State(4) State.Playing = State(3) State.Stopped = State(5) class TrackType(_Enum): '''N/A ''' _enum_names_ = { -1: ‚unknown‘, 0: ‚audio‘, 1: ‚video‘, 2: ‚text‘, } TrackType.audio = TrackType(0) TrackType.text = TrackType(2) TrackType.unknown = TrackType(-1) TrackType.video = TrackType(1) class VideoMarqueeOption(_Enum): '''Marq options definition. ''' _enum_names_= { 0: ‚Enable‘, 1: ‚Text‘, 2: ‚Color‘, 3: ‚Opacity‘, 4: ‚Position‘, 5: ‚Refresh‘, 6: ‚Size‘, 7: ‚Timeout‘, 8: ‚marquee_X‘, 9: ‚marquee_Y‘, } VideoMarqueeOption.Color = VideoMarqueeOption(2) VideoMarqueeOption.Enable = VideoMarqueeOption(0) VideoMarqueeOption.Opacity = VideoMarqueeOption(3) VideoMarqueeOption.Position = VideoMarqueeOption(4) VideoMarqueeOption.Refresh = VideoMarqueeOption(5) VideoMarqueeOption.Size = VideoMarqueeOption(6) VideoMarqueeOption.Text = VideoMarqueeOption(1) VideoMarqueeOption.Timeout = VideoMarqueeOption(7) VideoMarqueeOption.marquee_X = VideoMarqueeOption(8) VideoMarqueeOption.marquee_Y = VideoMarqueeOption(9) class NavigateMode(_Enum): '''Navigation mode. ''' _enum_names_ = { 0: ‚activate‘, 1: ‚up‘, 2: ‚down‘, 3: ‚left‘, 4: ‚right‘, } NavigateMode.activate = NavigateMode(0) NavigateMode.down = NavigateMode(2) NavigateMode.left = NavigateMode(3) NavigateMode.right = NavigateMode(4) NavigateMode.up = NavigateMode(1) class Position(_Enum): '''Enumeration of values used to set position (e.g. of video title). ''' _enum_names_ = { -1: ‚disable‘, 0: ‚center‘, 1: ‚left‘, 2: ‚right‘, 3: ‚top‘, 4: ‚left‘, 5: ‚right‘, 6: ‚bottom‘, 7: ‚left‘, 8: ‚right‘, } Position.bottom = Position(6) Position.center = Position(0) Position.disable = Position(-1) Position.left = Position(1) Position.left = Position(4) Position.left = Position(7) Position.right = Position(2) Position.right = Position(5) Position.right = Position(8) Position.top = Position(3) class VideoLogoOption(_Enum): ' ' ‚Option values for libvlc_video_{get,set}_logo_{int,string}. ‘ ‚ '‘ _enum_names_ = { 0: ‚enable‘, 1: ‚file‘, 2: ‚logo_x‘, 3: ‚logo_y‘, 4: ‚delay‘, 5: ‚repeat‘, 6: ‚opacity‘, 7: ‚position‘, } VideoLogoOption.delay = VideoLogoOption(4) VideoLogoOption.enable = VideoLogoOption(0) VideoLogoOption.file = VideoLogoOption(1) VideoLogoOption.logo_x = VideoLogoOption(2) VideoLogoOption.logo_y = VideoLogoOption(3) VideoLogoOption.opacity = VideoLogoOption(6) VideoLogoOption.position = VideoLogoOption(7) VideoLogoOption.repeat = VideoLogoOption(5) class VideoAdjustOption(_Enum): ' ' ‚Option values for libvlc_video_{get,set}_adjust_{int,float,bool}. ‘ ‚ '‘ _enum_names_ = { 0: ‚Enable‘, 1: ‚Contrast‘, 2: ‚Brightness‘, 3: ‚Hue‘, 4: ‚Saturation‘, 5: ‚Gamma‘, } VideoAdjustOption.Brightness = VideoAdjustOption(2) VideoAdjustOption.Contrast = VideoAdjustOption(1) VideoAdjustOption.Enable = VideoAdjustOption(0) VideoAdjustOption.Gamma = VideoAdjustOption(5) VideoAdjustOption.Hue = VideoAdjustOption(3) VideoAdjustOption.Saturation = VideoAdjustOption(4) class AudioOutputDeviceTypes(_Enum): '''Audio device types. ''' _enum_names_ = { -1: ‚Error‘, 1: ‚Mono‘, 2: ‚Stereo‘, 4: ‚_2F2R‘, 5: ‚_3F2R‘, 6: ‚_5_1‘, 7: ‚_6_1‘, 8: ‚_7_1‘, 10: ‚SPDIF‘, } AudioOutputDeviceTypes.Error = AudioOutputDeviceTypes(-1) AudioOutputDeviceTypes.Mono = AudioOutputDeviceTypes(1) AudioOutputDeviceTypes.SPDIF = AudioOutputDeviceTypes(10) AudioOutputDeviceTypes.Stereo = AudioOutputDeviceTypes(2) AudioOutputDeviceTypes._2F2R = AudioOutputDeviceTypes(4) AudioOutputDeviceTypes._3F2R = AudioOutputDeviceTypes(5) AudioOutputDeviceTypes._5_1 = AudioOutputDeviceTypes(6) AudioOutputDeviceTypes._6_1 = AudioOutputDeviceTypes(7) AudioOutputDeviceTypes._7_1 = AudioOutputDeviceTypes(8) class AudioOutputChannel(_Enum): ''' Audio channels. ''' _enum_names_ = { -1: ‚Error‘, 1: ‚Stereo‘, 2: ‚RStereo‘, 3: ‚Left‘, 4: ‚Right‘, 5: ‚Dolbys‘, } AudioOutputChannel.Dolbys = AudioOutputChannel(5) AudioOutputChannel.Error = AudioOutputChannel(-1) AudioOutputChannel.Left = AudioOutputChannel(3) AudioOutputChannel.RStereo = AudioOutputChannel(2) AudioOutputChannel.Right = AudioOutputChannel(4) AudioOutputChannel.Stereo = AudioOutputChannel(1) class PlaybackMode(_Enum): '''Defines playback modes for playlist. ''' _enum_names_ = { 0: ‚default‘, 1: ‚loop‘, 2: ‚repeat‘, } PlaybackMode.default = PlaybackMode(0) PlaybackMode.loop = PlaybackMode(1) PlaybackMode.repeat = PlaybackMode(2) class Callback(ctypes.c_void_p): " " "Callback function notification. @param p_event: the event triggering the callback. “ „ “ pass class LogCb(ctypes.c_void_p): " " "Callback prototype for LibVLC log message handler. @param data: data pointer as given to L{libvlc_log_set} (). @param level: message level (@ref enum libvlc_log_level). @param ctx: message context (meta-information about the message). @param fmt: printf() format string (as defined by ISO C11). @param args: variable argument list for the format @note Log message handlers B{must} be thread-safe. @warning The message context pointer, the format string parameters and the variable arguments are only valid until the callback returns. “ „ “ pass class VideoLockCb(ctypes.c_void_p): " " "Callback prototype to allocate and lock a picture buffer. Whenever a new video frame needs to be decoded, the lock callback is invoked. Depending on the video chroma, one or three pixel planes of adequate dimensions must be returned via the second parameter. Those planes must be aligned on 32-bytes boundaries. @param opaque: private pointer as passed to L{libvlc_video_set_callbacks} () [IN]. @param planes: start address of the pixel planes (LibVLC allocates the array of void pointers, this callback must initialize the array) [OUT]. @return: a private pointer for the display and unlock callbacks to identify the picture buffers. “ „ “ pass class VideoUnlockCb(ctypes.c_void_p): " " "Callback prototype to unlock a picture buffer. When the video frame decoding is complete, the unlock callback is invoked. This callback might not be needed at all. It is only an indication that the application can now read the pixel values if it needs to. @warning: A picture buffer is unlocked after the picture is decoded, but before the picture is displayed. @param opaque: private pointer as passed to L{libvlc_video_set_callbacks} () [IN]. @param picture: private pointer returned from the @ref libvlc_video_lock_cb callback [IN]. @param planes: pixel planes as defined by the @ref libvlc_video_lock_cb callback (this parameter is only for convenience) [IN]. “ „ “ pass class VideoDisplayCb(ctypes.c_void_p): " " "Callback prototype to display a picture. When the video frame needs to be shown, as determined by the media playback clock, the display callback is invoked. @param opaque: private pointer as passed to L{libvlc_video_set_callbacks} () [IN]. @param picture: private pointer returned from the @ref libvlc_video_lock_cb callback [IN]. “ „ “ pass class VideoFormatCb(ctypes.c_void_p): " " "Callback prototype to configure picture buffers format. This callback gets the format of the video as output by the video decoder and the chain of video filters (if any). It can opt to change any parameter as it needs. In that case, LibVLC will attempt to convert the video format (rescaling and chroma conversion) but these operations can be CPU intensive. @param opaque: pointer to the private pointer passed to L{libvlc_video_set_callbacks} () [IN/OUT]. @param chroma: pointer to the 4 bytes video format identifier [IN/OUT]. @param width: pointer to the pixel width [IN/OUT]. @param height: pointer to the pixel height [IN/OUT]. @param pitches: table of scanline pitches in bytes for each pixel plane (the table is allocated by LibVLC) [OUT]. @return: lines table of scanlines count for each plane. “ „ “ pass class VideoCleanupCb(ctypes.c_void_p): " " "Callback prototype to configure picture buffers format. @param opaque: private pointer as passed to L{libvlc_video_set_callbacks} () (and possibly modified by @ref libvlc_video_format_cb) [IN]. “ „ “ pass class AudioPlayCb(ctypes.c_void_p): " " "Callback prototype for audio playback. @param data: data pointer as passed to L{libvlc_audio_set_callbacks} () [IN]. @param samples: pointer to the first audio sample to play back [IN]. @param count: number of audio samples to play back. @param pts: expected play time stamp (see libvlc_delay()). “ „ “ pass class AudioPauseCb(ctypes.c_void_p): " " "Callback prototype for audio pause. @note: The pause callback is never called if the audio is already paused. @param data: data pointer as passed to L{libvlc_audio_set_callbacks} () [IN]. @param pts: time stamp of the pause request (should be elapsed already). “ „ “ pass class AudioResumeCb(ctypes.c_void_p): " " "Callback prototype for audio resumption (i.e. restart from pause). @note: The resume callback is never called if the audio is not paused. @param data: data pointer as passed to L{libvlc_audio_set_callbacks} () [IN]. @param pts: time stamp of the resumption request (should be elapsed already). “ „ “ pass class AudioFlushCb(ctypes.c_void_p): " " "Callback prototype for audio buffer flush (i.e. discard all pending buffers and stop playback as soon as possible). @param data: data pointer as passed to L{libvlc_audio_set_callbacks} () [IN]. “ „ “ pass class AudioDrainCb(ctypes.c_void_p): " " "Callback prototype for audio buffer drain (i.e. wait for pending buffers to be played). @param data: data pointer as passed to L{libvlc_audio_set_callbacks} () [IN]. “ „ “ pass class AudioSetVolumeCb(ctypes.c_void_p): " " "Callback prototype for audio volume change. @param data: data pointer as passed to L{libvlc_audio_set_callbacks} () [IN]. @param volume: software volume (1. = nominal, 0. = mute). @param mute: muted flag. “ „ “ pass class AudioSetupCb(ctypes.c_void_p): " " "Callback prototype to setup the audio playback. This is called when the media player needs to create a new audio output. @param opaque: pointer to the data pointer passed to L{libvlc_audio_set_callbacks} () [IN/OUT]. @param format: 4 bytes sample format [IN/OUT]. @param rate: sample rate [IN/OUT]. @param channels: channels count [IN/OUT]. @return: 0 on success, anything else to skip audio playback. “ „ “ pass class AudioCleanupCb(ctypes.c_void_p): " " "Callback prototype for audio playback cleanup. This is called when the media player no longer needs an audio output. @param opaque: data pointer as passed to L{libvlc_audio_set_callbacks} () [IN]. “ " “ pass class CallbackDecorators(object): "Class holding various method decorators for callback functions." Callback = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p) Callback.__doc__ = '''Callback function notification. @param p_event: the event triggering the callback. ''' LogCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int, Log_ptr, ctypes.c_char_p, ctypes.c_void_p) LogCb.__doc__ = '''Callback prototype for LibVLC log message handler. @param data: data pointer as given to L{libvlc_log_set} (). @param level: message level (@ref enum libvlc_log_level). @param ctx: message context (meta-information about the message). @param fmt: printf() format string (as defined by ISO C11). @param args: variable argument list for the format @note Log message handlers B{must} be thread-safe. @warning The message context pointer, the format string parameters and the variable arguments are only valid until the callback returns. ''' VideoLockCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.POINTER(ctypes.c_void_p)) VideoLockCb.__doc__ = '''Callback prototype to allocate and lock a picture buffer. Whenever a new video frame needs to be decoded, the lock callback is invoked. Depending on the video chroma, one or three pixel planes of adequate dimensions must be returned via the second parameter. Those planes must be aligned on 32-bytes boundaries. @param opaque: private pointer as passed to L{libvlc_video_set_callbacks} () [IN]. @param planes: start address of the pixel planes (LibVLC allocates the array of void pointers, this callback must initialize the array) [OUT]. @return: a private pointer for the display and unlock callbacks to identify the picture buffers. ''' VideoUnlockCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p, ctypes.POINTER(ctypes.c_void_p)) VideoUnlockCb.__doc__ = '''Callback prototype to unlock a picture buffer. When the video frame decoding is complete, the unlock callback is invoked. This callback might not be needed at all. It is only an indication that the application can now read the pixel values if it needs to. @warning: A picture buffer is unlocked after the picture is decoded, but before the picture is displayed. @param opaque: private pointer as passed to L{libvlc_video_set_callbacks} () [IN]. @param picture: private pointer returned from the @ref libvlc_video_lock_cb callback [IN]. @param planes: pixel planes as defined by the @ref libvlc_video_lock_cb callback (this parameter is only for convenience) [IN]. ''' VideoDisplayCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p) VideoDisplayCb.__doc__ = '''Callback prototype to display a picture. When the video frame needs to be shown, as determined by the media playback clock, the display callback is invoked. @param opaque: private pointer as passed to L{libvlc_video_set_callbacks} () [IN]. @param picture: private pointer returned from the @ref libvlc_video_lock_cb callback [IN]. ''' VideoFormatCb = ctypes.CFUNCTYPE(ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_void_p), ctypes.c_char_p, ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint)) VideoFormatCb.__doc__ = '''Callback prototype to configure picture buffers format. This callback gets the format of the video as output by the video decoder and the chain of video filters (if any). It can opt to change any parameter as it needs. In that case, LibVLC will attempt to convert the video format (rescaling and chroma conversion) but these operations can be CPU intensive. @param opaque: pointer to the private pointer passed to L{libvlc_video_set_callbacks} () [IN/OUT]. @param chroma: pointer to the 4 bytes video format identifier [IN/OUT]. @param width: pointer to the pixel width [IN/OUT]. @param height: pointer to the pixel height [IN/OUT]. @param pitches: table of scanline pitches in bytes for each pixel plane (the table is allocated by LibVLC) [OUT] . @return: lines table of scanlines count for each plane. ''' VideoCleanupCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p) VideoCleanupCb.__doc__ = '''Callback prototype to configure picture buffers format. @param opaque: private pointer as passed to L{libvlc_video_set_callbacks} () (and possibly modified by @ref libvlc_video_format_cb) [IN]. ''' AudioPlayCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p, ctypes.c_uint, ctypes.c_int64) AudioPlayCb.__doc__ = '''Callback prototype for audio playback. @param data: data pointer as passed to L{libvlc_audio_set_callbacks} () [IN]. @param samples: pointer to the first audio sample to play back [IN]. @param count: number of audio samples to play back. @param pts: expected play time stamp (see libvlc_delay()). ''' AudioPauseCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int64) AudioPauseCb.__doc__ = '''Callback prototype for audio pause. @note: The pause callback is never called if the audio is already paused. @param data: data pointer as passed to L{libvlc_audio_set_callbacks} () [IN]. @param pts: time stamp of the pause request (should be elapsed already). ''' AudioResumeCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int64) AudioResumeCb.__doc__ = '''Callback prototype for audio resumption (i.e. restart from pause). @note: The resume callback is never called if the audio is not paused. @param data: data pointer as passed to L{libvlc_audio_set_callbacks} () [IN]. @param pts: time stamp of the resumption request (should be elapsed already). ''' AudioFlushCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int64) AudioFlushCb.__doc__ = '''Callback prototype for audio buffer flush (i.e. discard all pending buffers and stop playback as soon as possible). @param data: data pointer as passed to L{libvlc_audio_set_callbacks} () [IN]. ''' AudioDrainCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p) AudioDrainCb.__doc__ = '''Callback prototype for audio buffer drain (i.e. wait for pending buffers to be played). @param data: data pointer as passed to L{libvlc_audio_set_callbacks} () [IN]. ''' AudioSetVolumeCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_float, ctypes.c_bool) AudioSetVolumeCb.__doc__ = '''Callback prototype for audio volume change. @param data: data pointer as passed to L{libvlc_audio_set_callbacks} () [IN]. @param volume: software volume (1. = nominal, 0. = mute). ''' @param mute: muted flag. AudioSetupCb = ctypes.CFUNCTYPE(ctypes.POINTER(ctypes.c_int), ctypes.POINTER(ctypes.c_void_p), ctypes.c_char_p, ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint)) AudioSetupCb.__doc__ = '''Callback prototype to setup the audio playback. This is called when the media player needs to create a new audio output. @param opaque: pointer to the data pointer passed to L{libvlc_audio_set_callbacks} () [IN/OUT]. @param format: 4 bytes sample format [IN/OUT]. @param rate: sample rate [IN/OUT]. @param channels: channels count [IN/OUT]. @return: 0 on success, anything else to skip audio playback. ''' AudioCleanupCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p) AudioCleanupCb.__doc__ = '''Callback prototype for audio playback cleanup. This is called when the media player no longer needs an audio output. @param opaque: data pointer as passed to L{libvlc_audio_set_callbacks} () [IN]. ''' cb = CallbackDecorators # End of generated enum types # # From libvlc_structures.h class AudioOutput(_Cstruct): def __str__(self): return ‚%s(%s:%s)‘ % (seif.__class__.__name__, self.name, self.description) AudioOutput._fields_ = [# recursive struct (‚name‘, ctypes.c_char_p), (‚description‘, ctypes.c_char_p), (‚next‘, ctypes.POINTER(AudioOutput)), ] class LogMessage(_Cstruct): _fields_ = [ (‚size‘, ctypes.c_uint), (‚severity‘, ctypes.c_int), (‚type‘, ctypes.c_char_p), (‚name‘, ctypes.c_char_p), (‚header‘, ctypes.c_char_p), ](‚message‘, ctypes.c_char_p), def __init__(self): super(LogMessage, self).__init__() self.size = ctypes.sizeof(self) def __str__(self): return ‚%s(%d:%s): %s‘ % (self.__class__.__name__, self.severity, self.type, self.message) class MediaEvent(_Cstruct): _fields_ = [ (‚media_name‘, ctypes.c_char_p), ](‚instance_name‘, ctypes.c_char_p), class MediaStats(_Cstruct): _fields_ = [ (‚read_bytes‘, ctypes.c_int), (‚input_bitrate‘, ctypes.c_float), (‚demux_read_bytes‘, ctypes.c_int), (‚demux_bitrate‘, ctypes.c_float), (‚demux_corrupted‘, ctypes.c_int), (‚demux_discontinuity‘, ctypes.c_int), (‚decoded_video‘, ctypes.c_int), (‚decoded_audio‘, ctypes.c_int), (‚displayed_pictures‘, ctypes.c_int), (‚lost_pictures‘, ctypes.c_int), (‚played_abuffers‘, ctypes.c_int), (‚lost_abuffers‘, ctypes.c_int), (‚sent_packets‘, ctypes.c_int), (‚sent_bytes‘, ctypes.c_int), ](‚send_bitrate‘, ctypes.c_float), class MediaTrackInfo(_Cstruct): _fields_ = [ (‚codec‘, ctypes.c_uint32), (‚id‘, ctypes.c_int), (‚type‘, TrackType), (‚profile‘, ctypes.c_int), (‚level‘, ctypes.c_int), (‚channels_or_height‘, ctypes.c_uint), ](‚rate_or_width‘, ctypes.c_uint), class AudioTrack(_Cstruct): _fields_ = [ (‚channels‘, ctypes.c_uint), (‚rate‘, ctypes.c_uint), ] class VideoTrack(_Cstruct): _fields_ = [ (‚height‘, ctypes.c_uint), (‚width‘, ctypes.c_uint), (‚sar_num‘, ctypes.c_uint), (‚sar_den‘, ctypes.c_uint), (‚frame_rate_num‘, ctypes.c_uint), (‚frame_rate_den‘, ctypes.c_uint), ] class SubtitleTrack(_Cstruct): _fields_ = [ (‚encoding‘, ctypes.c_char_p), ] class MediaTrackTracks(ctypes.Union): _fields_ = [ (‚audio‘, ctypes.POINTER(AudioTrack)), (‚video‘, ctypes.POINTER(VideoTrack)), (‚subtitle‘, ctypes.POINTER(SubtitleTrack)), ] class MediaTrack(_Cstruct): _anonymous_ = („u“,) _fields_ = [ (‚codec‘, ctypes.c_uint32), (‚original_fourcc‘, ctypes.c_uint32), (‚id‘, ctypes.c_int), (‚type‘, TrackType), (‚profile‘, ctypes.c_int), (‚level‘, ctypes.c_int), (‚u‘, MediaTrackTracks), (‚bitrate‘, ctypes.c_uint), (‚language‘, ctypes.c_char_p), (‚description‘, ctypes.c_char_p), ] class PlaylistItem(_Cstruct): _fields_ = [ (‚id‘, ctypes.c_int), (‚uri‘, ctypes.c_char_p), ](‚name‘, ctypes.c_char_p), def __str__(self): return ‚%s #%d %s (uri %s)‘ % (self.__class__.__name__, self.id, self.name, self.uri) class Position(object): " " "Enum-like, immutable window position constants. See e.g. VideoMarqueeOption.Position. “ „ “ Center = 0 Left = 1 CenterLeft = 1 Right = 2 CenterRight = 2 Top = 4 TopCenter = 4 TopLeft = 5 TopRight = 6 Bottom = 8 BottomCenter = 8 BottomLeft = 9 BottomRight = 10 def __init__(self, *unused): raise TypeError(‚constants only‘) def __setattr__(self, *unused): #PYCHOK expected raise TypeError(‚immutable constants‘) class Rectangle(_Cstruct): _fields_ = [ (‚top‘, ctypes.c_int), (‚left‘, ctypes.c_int), (‚bottom‘, ctypes.c_int), (‚right‘, ctypes.c_int), ] class TrackDescription(_Cstruct): def __str__(self): return ‚%s(%d:%s)‘ % (self.__class__.__name__, self.id, self.name) TrackDescription._fields_ = [# recursive struct (‚id‘, ctypes.c_int), (‚name‘, ctypes.c_char_p), (‚next‘, ctypes.POINTER(TrackDescription)), ] def track_description_list(head): " " "Convert a TrackDescription linked list to a Python list (and release the former). “ „ “ r = [] if head: item = head while item: item = item.contents r.append((item.id, item.name)) item = item.next try: libvlc_track_description_release(head) except NameError: libvlc_track_description_list_release(head) return r class EventUnion(ctypes.Union): _fields_ = [ (‚meta_type‘, ctypes.c_uint), (‚new_child‘, ctypes.c_uint), (‚new_duration‘, ctypes.c_longlong), (‚new_status‘, ctypes.c_int), (‚media‘, ctypes.c_void_p), (‚new_state‘, ctypes.c_uint), # FIXME: Media instance (‚new_cache‘, ctypes.c_float), (‚new_position‘, ctypes.c_float), (‚new_time‘, ctypes.c_longlong), (‚new_title‘, ctypes.c_int), (‚new_seekable‘, ctypes.c_longlong), (‚new_pausable‘, ctypes.c_longlong), (‚new_scrambled‘, ctypes.c_longlong), (‚new_count‘, ctypes.c_longlong), # FIXME: Skipped MediaList and MediaListView... (‚filename‘, ctypes.c_char_p), (‚new_length‘, ctypes.c_longlong), ](‚media_event‘, MediaEvent), class Event(_Cstruct): _fields_ = [ (‚type‘, EventType), (‚object‘, ctypes.c_void_p), ](‚u‘, EventUnion), class ModuleDescription(_Cstruct): def_str_(self): return ‚%s %s (%s)‘ % (self._class_name_, self.shortname, self.name) ModuleDescription._fields_ = [ # recursive struct (‚name‘, ctypes.c_char_p), (‚shortname‘, ctypes.c_char_p), (‚longname‘, ctypes.c_char_p), (‚help‘, ctypes.c_char_p), (‚next‘, ctypes.POINTER(ModuleDescription)), ] def module_description_list(head): " " "Convert a ModuleDescription linked list to a Python list (and release the former). “ „ “ r = [] if head: item = head while item: item = item.contents r.append((item.name, item.shortname, item.longname, item.help)) item = item.next libvlc_module_description_list_release(head) return r class AudioOutputDevice(_Cstruct): def_str_(self): return '%s(%d:%s)' % (self._class _._name _, self.id, self.name) AudioOutputDevice._fields_ = [ # recursive struct (‚next‘, ctypes.POINTER(AudioOutputDevice)), (‚device‘, ctypes.c_char_p ), (‚description‘, ctypes.c_char_p), ] class TitleDescription(_Cstruct): -fields = [ (‚duration‘, ctypes.c_longlong), (‚name‘, ctypes.c_char_p), (‚menu‘, ctypes.c_bool), class ChapterDescription(-Cstruct): -fields = [ (‚time offset‘, ctypes.c_longlong), (‚duration‘, ctypes.c_longlong), (‚name‘, ctypes.c_char_p), class VideoViewpoint(_Cstruct): _fields = [ (‚yaw‘, ctypes.c_float), (‚pitch‘, ctypes.c_float), (‚roll‘, ctypes.c_float), (‚field of view‘, ctypes.c_float), # This struct depends on the MediaSlaveType enum that is defined only # in > 2.2 if ‚MediaSlaveType‘ in locals(): class MediaSlave( Cstruct): fields = [ (‚psz_uri‘, ctypes.c_char_p), (‚i_type‘, MediaSlaveType), (‚i_priority‘, ctypes.c_uint) class RDDescription(_Cstruct): fields = [ (‚name‘, ctypes.c_char_p), (‚longname‘, ctypes.c char p) # End of header.py # class EventManager(_Ctype): '''Create an event manager with callback handler. This class interposes the registration and handling of event notifications in order to (a) remove the need for decorating each callback functions with the decorator '@callbackmethod', (b) allow any number of positional and/or keyword arguments to the callback (in addition to the Event instance) and (c) to preserve the Python objects such that the callback and argument objects remain alive (i.e. are not garbage collected) until B{after} the notification has been unregistered. @note: Only a single notification can be registered for each event type in an EventManager instance. , , , _callback _handler = None _callbacks = {} def_new_(cls, ptr=_internal_guard): if ptr == _internal_guard: raise VLCException(„(INTERNAL) ctypes class.\nYou should get a reference to EventManager through the MediaPlayer.event_manager() method.“) return Constructor(cls, ptr) def event_attach(self, eventtype, callback, *args, **kwds) : " " "Register an event notification. @param eventtype: the desired event type to be notified about. @param callback: the function to call when the event occurs. @param args: optional positional arguments for the callback. @param kwds: optional keyword arguments for the callback. @return: 0 on success, ENOMEM on error. @note: The callback function must have at least one argument, an Event instance. Any other, optional positional and keyword arguments are in B{addition} to the first one. “ „ “ if not isinstance(eventtype, EventType): raise VLCException(„%s required: %r“ % (‚EventType‘, eventtype)) if not hasattr(callback, ‚_call_‘): # callable () raise VLCException(„%s required: %r“ % (‚callable‘, callback)) # check that the callback expects arguments if not any(getargspec(callback)[:2]): # list (...) raise VLCException(„%s required: %r“ % (‚argument‘, callback)) if seif._callback_handler is None: _called_from_ctypes = ctypes.CFUNCTYPE(None, ctypes.POINTER(Event), ctypes.c_void_p) @_called_from_ctypes def _callback_handler(event, k): " " "(INTERNAL) handle callback call from ctypes. @note: We cannot simply make this an EventManager method since ctypes does not prepend self as the first parameter, hence this closure. '' '' try: # retrieve Python callback and arguments call, args, kwds = seif._callbacks[k] # deref event.contents to simplify callback code call(event.contents, *args, **kwds) except KeyError: # detached? pass self._callback_handler = _callback_handler self._callbacks = {} k = eventtype.value r = libvlc_event_attach(self, k, self._callback_handler, k) if not r: self._callbacks[k] = (callback, args, kwds) return r def event_detach(self, eventtype): " " "Unregister an event notification. @param eventtype: the event type notification to be removed. ifnot isinstance(eventtype, EventType): raise VLCException(„%s required: %r“ % (‚EventType‘, eventtype)) k = eventtype.value if k in self._callbacks: del seif._callbacks[k] # remove, regardless of libvlc return value libvlc_event_detach(self, k, self._callback_handler, k) class Instance(_Ctype): '''Create a new Instance instance. It may take as parameter either: - a string - a list of strings as first parameters - the parameters given as the constructor parameters (must be strings) , , , def_new_(cls, *args): if len(args) == 1: # Only 1 arg. It is either a C pointer, or an arg string, # or a tuple. i = args[0] if isinstance(i, _Ints): return Constructor(cls, i) elif isinstance(i, basestring): args = i.strip().split() elif isinstance(i, _Seqs): args = list(i) else: raise VLCException(‚Instance %r‘ % (args,)) else: args = list(args) if not args: # no parameters passed args = [‚vlc‘] elif args[0] != ‚vlc‘: args.insert(0, ‚vlc‘) if plugin_path is not None: # set plugin_path if detected, win32 and MacOS, # if the user did not specify it itself. os.environ.setdefault(‚VLC_PLUGIN_PATH‘, plugin_path) if PYTHON3: args = [ str_to_bytes(a) for a in args ] return libvlc_new(len(args), args) def media_player_new(self, uri=None): " " "Create a new MediaPlayer instance. @param uri: an optional URI to play in the player. “ „ “ p = libvlc_media_player_new(self) if uri: p.set_media(self.media_new(uri)) p._instance = self return p def media_list_player_new(self): " " "Create a new MediaListPlayer instance. “ „ “ p = libvlc_media_list_player_new(self) p._instance = self return p def media_new(self, mrl, *options): " " "Create a new Media instance. If mrl contains a colon (:) preceded by more than 1 letter, it will be treated as a URL. Else, it will be considered as a local path. If you need more control, directly use media_new_location/media_new_path methods. Options can be specified as supplementary string parameters, but note that many options cannot be set at the media level, and rather at the Instance level. For instance, the marquee filter must be specified when creating the vlc.Instance or vlc.MediaPlayer. Alternatively, options can be added to the media using the Media.add_options method (with the same limitation). @param options: optional media option=value strings “ „ “ if ' : ' in mrl and mrl.index(‚:'‘) > 1: # Assume it is a URL m = libvlc_media_new_location(self, str_to_bytes(mrl)) else: # Else it should be a local path. m = libvlc_media_new_path(self, str_to_bytes(os.path.normpath(mrl))) for o in options: libvlc_media_add_option(m, str_to_bytes(o)) m._instance = self return m def media_list_new(self, mrls=None): " " "Create a new MediaList instance. @param mrls: optional list of MRL strings “ „ “ 1 = libvlc_media_list_new(self) # We should take the lock, but since we did not leak the # reference, nobody else can access it. if mrls: for m in mrls: 1.add_media(m) 1._instance = self return 1 def audio_output_enumerate_devices(self): " " "Enumerate the defined audio output devices. @return: list of dicts {name:, description:, devices:} " „ “ r = [ ] head = libvlc_audio_output_list_get(self) if head: i = head while i: i = i.contents d = [{ ‚id‘: libvlc_audio_output_device_id (self, i.name, d), 'longname' : libvlc_audio_output_device_longname(self, i.name, d) } for d in ränge(libvlc_audio_output_device_count (self, i.name) ) ] r.append({‚name‘: i.name, ‚description‘: i.description, ‚devices‘: d}) i = i.next libvlc_audio_output_list_release(head) return r def audio_filter_list_get(self): " " "Returns a list of available audio filters. “ „ “ return module_description_list(libvlc_audio_filter_list_get(self)) def video_filter_list_get(self): " " "Returns a list of available video filters. “ „ “ return module_description_list(libvlc_video_filter_list_get(self)) def release(self): '''Decrement the reference count of a libvlc instance, and destroy it if it reaches zero. , , , return libvlc_release(self) def retain(self): '''Increments the reference count of a libvlc instance. The initial reference count is 1 after L{new}() returns. ''' return libvlc_retain(self) def add_intf(self, name): '''Try to start a user interface for the libvlc instance. @param name: interface name, or None for default. @return: 0 on success, -1 on error. , , , return libvlc_add_intf(self, str_to_bytes(name)) def wait(self): '''Waits until an interface causes the instance to exit. You should start at least one interface first, using L{add_intf} ( ). ''' return libvlc_wait(self) def set_user_agent(self, name, http): '''Sets the application name. LibVLC passes this as the user agent string when a protocol requires it. @param name: human-readable application name, e.g. "FooBar player 1.2.3". @param http: HTTP User Agent, e.g. „FooBar/1.2.3 Python/2.6.0“. @version: LibVLC 1.1.1 or later. , , , return libvlc_set_user_agent(self, str_to_bytes(name), str_to_bytes(http) ) def set_app_id(self, id, version, icon): '''Sets some meta-information about the application. See also L{set_user_agent} ( ). @param id: Java-style application identifier, e.g. „com.acme.foobar“. @param version: application version numbers, e.g. „1.2.3“. @param icon: application icon name, e.g. „foobar“. @version: LibVLC 2.1.0 or later. , , , return libvlc_set_app_id(self, str_to_bytes(id), str_to_bytes(version), str_to_bytes(icon)) def log_unset(self): ''' Unsets the logging callback for a LibVLC instance. This is rarely needed: the callback is implicitly unset when the instance is destroyed. This function will wait for any pending callbacks invocation to complete (causing a deadlock if called from within the callback). @version: LibVLC 2.1.0 or later. , , , return libvlc_log_unset(self) def log_set(self, cb, data): '''Sets the logging callback for a LibVLC instance. This function is thread-safe: it will wait for any pending callbacks invocation to complete. @param data: opaque data pointer for the callback function @note Some log messages (especially debug) are emitted by LibVLC while is being initialized. These messages cannot be captured with this interface. @warning A deadlock may occur if this function is called from the callback. @param p_instance: libvlc instance. @version: LibVLC 2.1.0 or later. ''' return libvlc_log_set(self, cb, data) def log_set_file(self, stream): '''Sets up logging to a file. @param stream: FILE pointer opened for writing (the FILE pointer must remain valid until L{log_unset} ( )). @version: LibVLC 2.1.0 or later. , , , return libvlc_log_set_file(self, stream) def get_log_verbosity(self): '''Always returns minus one. This function is only provided for backward compatibility. @return: always -1. , , , return libvlc_get_log_verbosity(self) def set_log_verbosity(self, level): ''' This function does nothing. It is only provided for backward compatibility. @param level: ignored. , , , return libvlc_set_log_verbosity(self, level) def log_open(self) : ''' This function does nothing useful. Itis only provided for backward compatibility. @return: an unique pointer or None on error. , , , return libvlc_log_open(self) def media_discoverer_new_from_name(self, psz_name) : ' ' 'Discover media service by name. @param psz_name: service name. @return: media discover object or None in case of error. , , , return libvlc_media_discoverer_new_from_name(self, str_to_bytes(psz_name)) def media_library_new(self): '''Create an new Media Library object. @return: a new object or None on error. ''' return libvlc_media_library_new(self) def vlm_release(self): ' ' ‚Release the vlm instance related to the given L{Instance}. , , , return libvlc_vlm_release(self) def vlm_add_broadcast(self, psz_name, psz_input, psz_output, i_options, ppsz_options, b_enabled, b_loop): ‘ ‚ '‘ Add a broadcast, with one input. @param psz_name: the name of the new broadcast. @param psz_input: the input MRL. @param psz_output: the output MRL (the parameter to the „sout“ variable). @param i_options: number of additional options. @param ppsz_options: additional options. @param b_enabled: boolean for enabling the new broadcast. @param b_loop: Should this broadcast be played in loop ? @return: 0 on success, -1 on error. ''' return libvlc_vlm_add_broadcast(self, str_to_bytes(psz_name), str_to_bytes(psz_input), str_to_bytes(psz_output), i_options, ppsz_options, b_enabled, b_loop) def vlm_add_vod(self, psz_name, psz_input,i_options, ppsz_options, b_enabled, psz_mux): '''Add a vod, with one input. @param psz_name: the name of the new vod media. @param psz_input: the input MRL. @param i_options: number of additional options. @param ppsz_options: additional options. @param b_enabled: boolean for enabling the new vod. @param psz_mux: the muxer of the vod media. @return: 0 on success, -1 on error. ''' return libvlc_vlm_add_vod(self, str_to_bytes(psz_name), str_to_bytes(psz_input), i_options, ppsz_options, b_enabled, str_to_bytes(psz_mux)) def vlm_del_media(self, psz_name) : '''Delete a media (VOD or broadcast). @param psz_name: the media to delete. @return: 0 on success, -1 on error. , , , return libvlc_vlm_del_media(seif, str_to_bytes(psz_name) ) def vlm_set_enabled(self, psz_name, b_enabled): ‘ ‚ '‘ Enable or disable a media (VOD or broadcast). @param psz_name: the media to work on. @param b_enabled: the new status. @return: 0 on success, -1 on error. ''' return libvlc_vlm_set_enabled(self, str_to_bytes(psz_name), b_enabled) def vlm_set_output(self, psz_name, psz_output): ' ' 'Set the output for a media. @param psz_name: the media to work on. @param psz_output: the output MRL (the parameter to the „sout“ variable). @return: 0 on success, -1 on error. , , , return libvlc_vlm_set_output(self, str_to_bytes(psz_name), str_to_bytes(psz_output) ) def vlm_set_input(self, psz_name, psz_input): '''Set a media‘s input MRL. This will delete all existing inputs and add the specified one. @param psz_name: the media to work on. @param psz_input: the input MRL. @return: 0 on success, -1 on error. , , , return libvlc_vlm_set_input(self, str_to_bytes(psz_name), str_to_bytes(psz_input) ) def vlm_add_input(self, psz_name, psz_input): ''‘ Add a media's input MRL. This will add the specified one. @param psz_name: the media to work on. @param psz_input: the input MRL. @return: 0 on success, -1 on error. ''‘ return libvlc_vlm_add_input(self, str_to_bytes(psz_name), str_to_bytes(psz_input) ) def vlm_set_loop(self, psz_name, b_loop): '''Set a media‘s loop status. @param psz_name: the media to work on. @param b_loop: the new status. @return: 0 on success, -1 on error. ' ‚ '‘ return libvlc_vlm_set_loop(self, str_to_bytes(psz_name), b_loop) def vlm_set_mux(self, psz_name, psz_mux): '''Set a media‘s vod muxer. @param psz_name: the media to work on. @param psz_mux: the new muxer. @return: 0 on success, -1 on error. , , , return libvlc_vlm_set_mux(self, str_to_bytes(psz_name), str_to_bytes(psz_mux)) def vlm_change_media(self, psz_name, psz_input, psz_output, i_options, ppsz_options, b_enabled, b_loop): '''Edit the parameters of a media. This will delete all existing inputs and add the specified one. @param psz_name: the name of the new broadcast. @param psz_input: the input MRL. @param psz_output: the output MRL (the parameter to the „sout“ variable). @param i_options: number of additional options. @param ppsz_options: additional options. @param b_enabled: boolean for enabling the new broadcast. @param b_loop: Should this broadcast be played in loop ? @return: 0 on success, -1 on error. , , , return libvlc_vlm _change_media(self, str_to_bytes(psz_name), str_to_bytes(psz_input), str_to_bytes(psz_output), i_options, ppsz_options, b_enabled, b_loop) def vlm_play_media(self, psz_name) : ‘ ' 'Play the named broadcast. @param psz_name: the name of the broadcast. @return: 0 on success, -1 on error. , , , return libvlc_vlm_play_media(self, str_to_bytes(psz_name) ) def vlm_stop_media(self, psz_name) : ‚ '‘ ‚Stop the named broadcast. @param psz_name: the name of the broadcast. @return: 0 on success, -1 on error. , , , return libvlc_vlm_stop_media(self, str_to_bytes(psz_name) ) def vlm_pause_media(self, psz_name) : '''Pause the named broadcast. @param psz_name: the name of the broadcast. @return: 0 on success, -1 on error. , , , return libvlc_vlm_pause_media(self, str_to_bytes(psz_name) ) def vlm_seek_media(self, psz_name, f_percentage): '''Seek in the named broadcast. @param psz_name: the name of the broadcast. @param f_percentage: the percentage to seek to. @return: 0 on success, -1 on error. ‘ ‚ '‘ return libvlc_vlm_seek _media(self, str_to_bytes(psz_name), f_percentage) def vlm_show_media(self, psz_name) : ' ' 'Return information about the named media as a JSON string representation. This function is mainly intended for debugging use, if you want programmatic access to the state of a vlm_media_instance_t, please use the corresponding libvlc_vlm_get_media_instance_xxx -functions. Currently there are no such functions available for vlm_media_t though. @param psz_name: the name of the media, if the name is an empty string, all media is described. @return: string with information about named media, or None on error. ''' return libvlc_vlm_show_media(self, str_to_bytes(psz_name) ) def vlm_get_media_instance_position(self, psz_name, i_instance): ' ' 'Get vlm_media instance position by name or instance id. @param psz_name: name of vlm media instance. @param i_instance: instance id. @return: position as float or -1. on error. ''' return libvlc_vlm_get_media_instance_position(self, str_to_bytes(psz_name), i_instance) def vlm_get_media_instance_time(self, psz_name, i_instance): ' ' 'Get vlm _media instance time by name or instance id. @param psz_name: name of vlm media instance. @param i_instance: instance id. @return: time as integer or -1 on error. , , , return libvlc_vlm_get_media_instance_time(self, str_to_bytes(psz_name), i_instance) def vlm_get_media_instance_length(self, psz_name, i_instance): ‘ ' 'Get vlm_media instance length by name or instance id. @param psz_name: name of vlm media instance. @param i_instance: instance id. @return: length of media item or -1 on error. , , , return libvlc_vlm_get_media_instance_length(self, str_to_bytes(psz_name), i_instance) def vlm_get_media_instance_rate(self, psz_name, i_instance): ‘ ' 'Get vlm_media instance playback rate by name or instance id. @param psz_name: name of vlm media instance. @param i_instance: instance id. @return: playback rate or -1 on error. , , , return libvlc_vlm_get_media_instance_rate(self, str_to_bytes(psz_name), i_instance) def vlm_get_media_instance_title(self, psz_name, i_instance): ‘ ' 'Get vlm _media instance title number by name or instance id. @param psz_name: name of vlm media instance. @param i_instance: instance id. @return: title as number or -1 on error. @bug: will always return 0. , , , return libvlc_vlm_get_media_instance_title(self, str_to_bytes(psz_name), i_instance) def vlm_get_media_instance_chapter(self, psz_name, i_instance): ‘ ' 'Get vlm_media instance chapter number by name or instance id. @param psz_name: name of vlm media instance. @param i_instance: instance id. @return: chapter as number or -1 on error. @bug: will always return 0. ''' return libvlc_vlm_get_media_instance_chapter(self, str_to_bytes(psz_name), i_instance) def vlm_get_media_instance_seekable(self, psz_name, i_instance): ' ' 'Is libvlc instance seekable ? @param psz_name: name of vlm media instance. @param i_instance: instance id. @return: 1 if seekable, 0 if not, -1 if media does not exist. @bug: will always return 0. ''' return libvlc_vlm_get_media_instance_seekable(self, str_to_bytes(psz_name), i_instance) @memoize_parameterless def vlm_get_event_manager(self): ' ' 'Get libvlc_event_manager from a vlm media. The p_event_manager is immutable, so you don't have to hold the lock. @return: libvlc_event_manager. , , , return libvlc_vlm_get_event_manager(self) def media_new_location(self, psz_mrl): ' ' 'Create a media with a certain given media resource location, for instance a valid URL. @note: To refer to a local file with this function, the file://... URI syntax B{must} be used (see IETF RFC3986). We recommend using L{media_new_path} ( ) instead when dealing with local files. See L{media_release}. @param psz_mrl: the media location. @return: the newly created media or None on error. , , , return libvlc _media _new_location(self, str_to_bytes(psz_mrl) ) def media_new_path(self, path): '''Create a media for a certain file path. See L{media_release}. @param path: local filesystem path. @return: the newly created media or None on error. , , , return libvlc_media_new_path(self, str_to_bytes(path) ) def media_new_fd(self, fd): '''Create a media for an already open file descriptor. The file descriptor shall be open for reading (or reading and writing). Regular file descriptors, pipe read descriptors and character device descriptors (including TTYs) are supported on all platforms. Block device descriptors are supported where available. Directory descriptors are supported on systems that provide fdopendir(). Sockets are supported on all platforms where they are file descriptors, i.e. all except Windows. @note: This library will B{not} automatically close the file descriptor under any circumstance. Nevertheless, a file descriptor can usually only be rendered once in a media player. To render it a second time, the file descriptor should probably be rewound to the beginning with lseek ( ). See L{media_release}. @param fd: open file descriptor. @return: the newly created media or None on error. @version: LibVLC 1.1.5 and later. ''' return libvlc_media_new_fd(self, fd) def media_new_as_node(self, psz_name) : '''Create a media as an empty node with a given name. See L{media_release}. @param psz_name: the name of the node. @return: the new empty media or None on error. , , , return libvlc media_new_as_node(self, str_to_bytes(psz_name) ) def playlist_play(self, i_id, i_options, ppsz_options): ' ' 'Start playing (if there is any item in the playlist). Additionnal playlist item options can be specified for addition to the item before it is played. @param i_id: the item to play. If this is a negative number, the next item will be selected. Otherwise, the item with the given ID will be played. @param i_options: the number of options to add to the item. @param ppsz_options: the options to add to the item. , , , return libvlc_playlist_play(self, i_id, i_options, ppsz_options) def audio_output_list_get(self): ‘ ' 'Gets the list of available audio output modules. @return: list of available audio outputs. It must be freed it with In case of error, None is returned. , , , return libvlc_audio_output_list_get(self) def audio_output_device_count(self, psz_name): ‘ ' 'Backward compatibility stub. Do not use in new code. Use L{audio_output_device_list_get} ( ) instead. @return: always 0. ‘ ‚ '‘ return libvlc_audio_output_device_count(self, str_to_bytes(psz_name) ) def audio_output_device_longname(self, psz_name, i_device): ' ' 'Backward compatibility stub. Do not use in new code. Use L{audio_output_device_list_get} ( ) instead. @return: always None. ''' return libvlc_audio_output_device_longname(self, str_to_bytes(psz_name), i_device) def audio_output_device_id(self, psz_name, i_device): ' ' 'Backward compatibility stub. Do not use in new code. Use L{audio_output_device_list_get} ( ) instead. @return: always None. , , , return libvlc_audio_output_device_id(self, str_to_bytes(psz_name), i_device) def audio_output_device_list_get(self, aout): ‘ ' 'Gets a list of audio output devices for a given audio output module, See L{audio output device set} ( ). @note: Not all audio outputs support this. In particular, an empty (None) list of devices does B{not} imply that the specified audio output does not work. @note: The list might not be exhaustive. @warning: Some audio output devices in the list might not actually work in some circumstances. By default, it is recommended to not specify any explicit audio device. @param psz_aout: audio output name (as returned by L{audio_output_list_get} ( ) ). @return: A None-terminated linked list of potential audio output devices. It must be freed it with L{audio_output_device_list_release}(). @version: LibVLC 2.1.0 or later. ''' return libvlc_audio_output_device_list_get(self, str_to_bytes(aout)) class LogIterator( Ctype): '''Create a new VLC log iterator. , , , def _new_ (cls, ptr=_internal_guard): '''(INTERNAL) ctypes wrapper constructor. ''' return _Constructor(cls, ptr) def _iter_(self): return self def next(self): if self.has_next(): b = LogMessage ( ) i = libvlc_log_iterator_next(self, b) return i.contents raise StopIteration def _next_(self): return seif.next ( ) def free(self): ' ' 'Frees memory allocated by L{log_get_iterator} ( ). ''' return libvlc_log_iterator_free(self) def has_next(self): ' ' 'Always returns zero. This function is only provided for backward compatibility. @return: always zero. , , , return libvlc_log_iterator_has_next(self) class Media (_Ctype) : '''Create a new Media instance. Usage: Media(MRL, *options) See vlc.Instance.media_new documentation for details. , , , def new_(cls, *args): if args: i = args[0] if isinstance(i, _Ints): return Constructor(cls, i) if isinstance(i, Instance): return i.media_new(*args[1:]) o = get_default_instance ( ) .media_new(*args) return o def get_instance(self): return getattr(self, ‚_instance‘, None) def add_options(self, *options): " " "Add a list of options to the media. Options must be written without the double-dash. Warning: most audio and video options, such as text renderer, have no effects on an individual media. These options must be set at the vlc.Instance or vlc.MediaPlayer instanciation. @param options: optional media option=value strings " “ “ for o in options: self.add_option(o) def tracks_get(self): " " "Get media descriptor's elementary streams description Note, you need to call L{parse}() or play the media at least once before calling this function. Not doing this will result in an empty array. The result must be freed with L{tracks_release}. @version: LibVLC 2.1.0 and later. " “ “ mediaTrack_pp = ctypes.POINTER(MediaTrack) ( ) n = libvlc_media_tracks_get(self, ctypes.byref(mediaTrack_pp) ) info = ctypes.cast(mediaTrack_pp, ctypes.POINTER(ctypes.POINTER(MediaTrack) * n)) try: contents = info.contents except ValueError: # Media not parsed, no info. return None tracks = ( contents[i].contents for i in range(len(contents) ) ) # libvlc_media_tracks_release(mediaTrack_pp, n) return tracks def add_option(self, psz_options): ''' Add an option to the media. This option will be used to determine how the media_player will read the media. This allows to use VLC's advanced reading/streaming options on a per-media basis. @note: The options are listed in ‚vlc --long-help‘ from the command line, e.g. „-sout-all“. Keep in mind that available options and their semantics vary across LibVLC versions and builds. @warning: Not all options affects L{Media} objects: Specifically, due to architectural issues most audio and video options, such as text renderer options, have no effects on an individual media. These options must be set through L{new} ( ) instead. @param psz_options: the options (as a string). ''' return libvlc_media_add_option(self, str_to_bytes(psz_options) ) def add_option_flag(self, psz_options, i_flags): ' ' 'Add an option to the media with configurable flags. This option will be used to determine how the media_player will read the media. This allows to use VLC‘s advanced reading/streaming options on a per-media basis. The options are detailed in vlc --long-help, for instance „--sout-all“. Note that all options are not usable on medias: specifically, due to architectural issues, video- related options such as text renderer options cannot be set on a single media. They must be set on the whole libvlc instance instead. @param psz_options: the options (as a string). @param i_flags: the flags for this option. , , , return libvlc_media_add_option_flag(self, str_to_bytes(psz_options), i_flags) def retain(self): ' ' 'Retain a reference to a media descriptor object (libvlc _media _t). Use L{release}() to decrement the reference count of a media descriptor object. , , , return libvlc_media_retain(self) def release(self): ‘ ' 'Decrement the reference count of a media descriptor object. If the reference count is 0, then L{release}() will release the media descriptor object. It will send out an libvlc_MediaFreed event to all listeners. If the media descriptor object has been released it should not be used again. , , , return libvlc_media_release(self) def get_mrl(self): ‘ ' 'Get the media resource locator (mrl) from a media descriptor object. @return: string with mrl of media descriptor object. ''' return libvlc_media_get_mrl(self) def duplicate(self): ' ' 'Duplicate a media descriptor object. , , , return libvlc_media_duplicate(self) def get_meta(self, e_meta): ‘ ' 'Read the meta of the media. If the media has not yet been parsed this will return None. This methods automatically calls L{parse_async} ( ), so after calling it you may receive a libvlc_MediaMetaChanged event. If you prefer a synchronous version ensure that you call L{parse}() before get_meta ( ). See L{parse} See L{parse_async} See libvlc_MediaMetaChanged. @param e_meta: the meta to read. @return: the media‘s meta. ''' return libvlc_media_get_meta(self, e_meta) def set_meta(self, e_meta, psz_value): ' ' 'Set the meta of the media (this function will not save the meta, call L{save_meta} in order to save the meta). @param e_meta: the meta to write. @param psz_value: the media‘s meta. , , , return libvlc_media_set_meta(self, e_meta, str_to_bytes(psz_value)) def save_meta(seif): '''Save the meta previously set. @return: true if the write operation was successful. ''' return libvlc_media _save -meta(self) def get_state(self): ' ' 'Get current state of media descriptor object. Possible media states are defined in libvlc_structures.c ( libvlc_NothingSpecial=0, libvlc_Opening, libvlc_Buffering, libvlc_Playing, libvlc_Paused, libvlc_Stopped, libvlc_Ended, libvlc_Error). See libvlc_state_t. @return: state of media descriptor object. ''' return libvlc_media_get_state(self) def get_stats(self, p_stats): ' ' 'Get the current statistics about the media. @param p_stats:: structure that contain the statistics about the media (this structure must be allocated by the caller). @return: true if the statistics are available, false otherwise \libvlc_return_bool. ''' return libvlc_media_get_stats(self, p_stats) def subitems(self): ' ' 'Get subitems of media descriptor object. This will increment the reference count of supplied media descriptor object. Use L{list_release} ( ) to decrement the reference counting. @return: list of media descriptor subitems or None. ''' return libvlc media_subitems(self) @memoize_parameterless def event_manager(self): ' ' 'Get event manager from media descriptor object. NOTE: this function doesn't increment reference counting. @return: event manager object. ''' return libvlc_media_event_manager(self) def get_duration(self): ' ' 'Get duration (in ms) of media descriptor object item. @return: duration of media item or -1 on error. ''' return libvlc_media_get_duration(self) def parse(self): '''Parse a media. This fetches (local) meta data and tracks information. The method is synchronous. See L{parse_async} See L{get_meta} See L{get_tracks_info}. , , , return libvlc_media_parse(self) def parse_async(self): '''Parse a media. This fetches (local) meta data and tracks information. The method is the asynchronous of L{parse}(). To track when this is over you can listen to libvlc_MediaParsedChanged event. However if the media was already parsed you will not receive this event. See L{parse} See libvlc_MediaParsedChanged See L{get_meta} See L{get_tracks_info}. , , , return libvlc_media_parse_async(self) def is_parsed(self) : '''Get Parsed status for media descriptor object. See libvlc_MediaParsedChanged. @return: true if media object has been parsed otherwise it returns false \libvlc_return_bool. , , , return libvlc_media_is_parsed(self) def set_user_data(self, p_new_user_data): '''Sets media descriptor's user_data. user_data is specialized data accessed by the host application, VLC.framework uses it as a pointer to an native object that references a L{Media} pointer. @param p_new_user_data: pointer to user data. ''' return libvlc_media_set_user_data(self, p_new_user_data) def get_user_data(self): '''Get media descriptor's user_data. user_data is specialized data accessed by the host application, VLC.framework uses it as a pointer to an native object that references a L{Media} pointer. ''' return libvlc_media_get_user_data(self) def get_tracks_info(self): '''Get media descriptor's elementary streams description Note, you need to call L{parse}() or play the media at least once before calling this function. Not doing this will result in an empty array. \deprecated Use L{tracks_get} instead. @param tracks: address to store an allocated array of Elementary Streams descriptions (must be freed by the caller) [OUT] . @return: the number of Elementary Streams. ''' return libvlc_media_get_tracks_info(self) def player_new_from_media(self): '''Create a Media Player object from a Media. @return: a new media player object, or None on error. ''' return libvlc_media_player_new_from_media(self) class MediaDiscoverer(_Ctype): '''N/A ''' def_new_(cls, ptr=_internal_guard): '''(INTERNAL) ctypes wrapper constructor. ''' return_Constructor(cls, ptr) def release(self): '''Release media discover object. If the reference count reaches 0, then the object will be released. ''' return libvlc_media_discoverer_release(self) def localized_name(self): '''Get media service discover object its localized name. @return: localized name. ''' return libvlc_media_discoverer_localized_name(self) def media_list(self): '''Get media service discover media list. @return: list of media items. ''' return libvlc_media_discoverer_media_list(self) @memoize_parameterless def event_manager(self): '''Get event manager from media service discover object. @return: event manager object. ''' return libvlc_media_discoverer_event_manager(self) def is_running(self) : '''Query if media service discover object is running. @return: true if running, false if not \libvlc_return_bool. ''' return libvlc_media_discoverer_is_running(self) class MediaLibrary(_Ctype): '''N/A ''' def_new_(cls, ptr=_internal_guard): '''(INTERNAL) ctypes wrapper constructor. ''' return_Constructor(cls, ptr) def release(self): '''Release media library object. This functions decrements the reference count of the media library object. If it reaches 0, then the object will be released. ''' return libvlc_media_library_release(self) def retain(self): '''Retain a reference to a media library object. This function will increment the reference counting for this object. Use L{release}() to decrement the reference count. ''' return libvlc_media_library_retain(self) def load(self): '''Load media library. @return: 0 on success, -1 on error. ''' return libvlc_media_library_load(self) def media_list(self): '''Get media library subitems. @return: media list subitems. ''' return libvlc_media_library_media_list(self) class MediaList(_Ctype): '''Create a new MediaList instance. Usage: MediaList(list_of_MRLs) See vlc.Instance.media_list_new documentation for details. ''' def _new_(cls, *args): if args: i = args[0] if isinstance(i, _Ints): return -Constructor(cls, i) if isinstance(i, Instance): return i.media_list_new(*args[1:]) o = get_default_instance().media_list_new(*args) return o def get_instance(self): return getattr(self, ‚_instance‘, None) def add_media(self, mrl): " " "Add media instance to media list. The L{lock} should be held upon entering this function. @param mrl: a media instance or a MRL. @return: 0 on success, -1 if the media list is read- only. “ „ “ if isinstance(mrl, basestring): mrl = (self.get_instance() or get_default_instance()).media_new(mrl) return libvlc_media_list_add_media(self, mrl) def release(self): '''Release media list created with L{new}(). ''' return libvlc_media_list_release(self) def retain(self): '''Retain reference to a media list. ''' return libvlc_media_list_retain(self) def set_media (self, p md): '''Associate media instance with this media list instance. If another media instance was present it will be released. The L{lock} should NOT be held upon entering this function. @param p_md: media instance to add. ''' return libvlc_media_list_set_media(self, p_md) def media(self): '''Get media instance from this media list instance. This action will increase the refcount on the media instance. The L{lock} should NOT be held upon entering this function. @return: media instance. ''' return libvlc_media_list_media(self) def insert_media(self, p_md, i_pos): '''Insert media instance in media list on a position The L{lock} should be held upon entering this function. @param p_md: a media instance. @param i_pos: position in array where to insert. @return: 0 on success, -1 if the media list is read- only. ''' return libvlc_media_list_insert_media(self, p_md, i_pos) def remove_index(self, i_pos): '''Remove media instance from media list on a position The L{lock} should be held upon entering this function. @param i_pos: position in array where to insert. @return: 0 on success, -1 if the list is read-only or the item was not found. ''' return libvlc_media_list_remove_index(self, i_pos) def count(self): '''Get count on media list items The L{lock} should be held upon entering this function. @return: number of items in media list. ''' return libvlc_media_list_count(self) def_len_(self): return libvlc_media_list_count(self) def item_at_index(self, i_pos): '''List media instance in media list at a position The L{lock} should be held upon entering this function. @param i_pos: position in array where to insert. @return: media instance at position i_pos, or None if not found. In case of success, L{media_retain} () is called to increase the refcount on the media. ''' return libvlc_media_list_item_at_index(self, i_pos) def_getitem_(self, i): return libvlc_media _list_item_at_index(self, i) def_iter_(self): for i in range(len(self)): yield self[i] def index_of_item(self, p_md): '''Find index position of List media instance in media list. Warning: the function will return the first matched position. The L{lock} should be held upon entering this function. @param p_md: media instance. @return: position of media instance or -1 if media not found. ''' return libvlc_media_list_index_of_item(self, p_md) def is_readonly(self): '''This indicates if this media list is read-only from a user point of view. @return: 1 on readonly, 0 on readwrite \libvlc_return_bool. ''' return libvlc_media_list_is_readonly(self) def lock(self): '''Get lock on media list items. ''' return libvlc_media_list_lock(self) def unlock(self): '''Release lock on media list items The L{lock} should be held upon entering this function. ''' return libvlc_media_list_unlock(self) @memoize_parameterless def event_manager(self): '''Get libvlc_event_manager from this media list instance. The p_event_manager is immutable, so you don't have to hold the lock. @return: libvlc_event_manager. ''' return libvlc_media_list_event_manager(self) class MediaListPlayer(_Ctype): '''Create a new MediaListPlayer instance. It may take as parameter either: - a vlc.Instance - nothing ''' def _new_(cls, arg=None): if arg is None: i = get_default_instancen () elif isinstance(arg, Instance): i = arg elif isinstance(arg, _Ints): return Constructor(cls, arg) else: raise TypeError(‚MediaListPlayer %r‘ % (arg,)) return i.media_list_player_new () def get_instance(self): " " "Return the associated Instance. “ " “ return self._instance #PYCHOK expected def release(self): '''Release a media_list_player after use Decrement the reference count of a media player object. If the reference count is 0, then L{release}() will release the media player object. If the media player object has been released, then it should not be used again. ''' return libvlc_media_list_player_release(self) def retain(self): '''Retain a reference to a media player list object. Use L{release}() to decrement reference count. ''' return libvlc_media_list_player_retain(self) @memoize_parameterless def event_manager(self): '''Return the event manager of this media_list_player. @return: the event manager. ''' return libvlc_media_list_player_event_manager(self) def set_media_player(self, p_mi): '''Replace media player in media_list_player with this instance. @param p_mi: media player instance. ''' return libvlc_media_list_player_set_media_player(self, p_mi) def set_media_list(self, p_mlist): '''Set the media list associated with the player. @param p_mlist: list of media. ''' return libvlc_media_list_player_set_media_list(self, p_mlist) def play(self): '''Play media list. ''' return libvlc_media_list_player_play(self) def pause(self): '''Toggle pause (or resume) media list. ''' return libvlc_media_list_player_pause(self) def is_playing(self): '''Is media list playing? @return: true for playing and false for not playing \libvlc_return_bool. ''' return libvlc_media_list_player_is_playing(self) def get_state(self): '''Get current libvlc_state of media list player. @return: libvlc_state_t for media list player. ''' return libvlc_media_list_player_get_state(self) def play_item_at_index(self, i_index): '''Play media list item at position index. @param i_index: index in media list to play. @return: 0 upon success -1 if the item wasn't found. ''' return libvlc_media_list_player_play_item_at_index(self, i_index) def __getitem__(self, i): return libvlc_media_list_player_play_item_at_index(self, i) def __iter__(self): for i in range(len(self)): yield self[i] def play_item(self, p_md): '''Play the given media item. @param p_md: the media instance. @return: 0 upon success, -1 if the media is not part of the media list. ''' return libvlc_media_list_player_play_item(self, p_md) def stop(self): '''Stop playing media list. ''' return libvlc_media_list_player_stop(self) def next(self): '''Play next item from media list. @return: 0 upon success -1 if there is no next item. ''' return libvlc_media_list_player_next(self) def previous(self): '''Play previous item from media list. @return: 0 upon success -1 if there is no previous item.''' return libvlc_media_list_player_previous(self) def set_playback_mode(self, e_mode): '''Sets the playback mode for the playlist. @param e_mode: playback mode specification. ''' return libvlc_media_list_player_set_playback_mode(self, e_mode) class MediaPlayer(_Ctype): '''Create a new MediaPlayer instance. It may take as parameter either: - a string (media URI), options... In this case, a vlc.Instance will be created. - a vlc.Instance, a string (media URI), options... ''' def _new_(cls, *args): if len(args) == 1 and isinstance(args[0], _Ints): return _Constructor(cls, args[0]) if args and isinstance(args[0], Instance): instance = args[0] args = args[1:] else: instance = get_default_instance () o = instance.media_player_new () if args: o.set_media(instance.media_new(*args)) return o def get_instance(self): " " "Return the associated Instance. “ " “ return self._instance #PYCHOK expected def set_mrl(self, mrl, *options): " " "Set the MRL to play. Warning: most audio and video options, such as text renderer, have no effects on an individual media. These options must be set at the vlc.Instance or vlc.MediaPlayer instanciation. @param mrl: The MRL @param options: optional media option=value strings @return: the Media object “ " “ m = self.get_instance ().media_new(mrl, *options) self.set_media(m) return m def video_get_spu_description(self): " " "Get the description of available video subtitles. “ „ “ return track_description_list(libvlc_video_get_spu_description(self) ) def video_get_title_description(self): " " "Get the description of available titles. “ " “ return track_description_list(libvlc_video_get_title_description(sel f)) def video_get_chapter_description(self, title): " " "Get the description of available chapters for specific title. @param title: selected title (int) “ „ “ return track_description_list(libvlc_video_get_chapter_description(s elf, title)) def video_get_track_description(self): " " "Get the description of available video tracks. “ „ “ return track_description_list(libvlc_video_get_track_description(sel f)) def audio_get_track_description(self): " " "Get the description of available audio tracks. “ " “ return track_description_list(libvlc_audio_get_track_description(sel f)) def get_full_title_descriptions(self): '''Get the full description of available titles. @return: the titles list @version: LibVLC 3.0.0 and later. ''' titleDescription_pp = ctypes.POINTER(TitleDescription) () n = libvlc_media_player_get_full_title_descriptions(self, ctypes.byref(titleDescription_pp)) info = ctypes.cast(ctypes.titleDescription_pp, ctypes.POINTER(ctypes.POINTER(TitleDescription) * n)) return info def get_full_chapter_descriptions(self, i_chapters_of_title): '''Get the full description of available chapters. @param i_chapters_of_title: index of the title to query for chapters (uses current title if set to -1). @return: the chapters list @version: LibVLC 3.0.0 and later. ''' chapterDescription_pp = ctypes.POINTER(ChapterDescription) () n = libvlc_media_player_get_full_chapter_descriptions(self, ctypes.byref(chapterDescription_pp)) info = ctypes.cast(ctypes.chapterDescription_pp, ctypes.POINTER(ctypes.POINTER(ChapterDescription) * n)) return info def video_get_size(self, num=0): " " "Get the video size in pixels as 2-tuple (width, height). @param num: video number (default 0). “ „ “ r = libvlc_video_get_size(self, num) if isinstance(r, tuple) and len(r) == 2: return r else: raise VLCException(‚invalid video number (%s)‘ % (num,)) def set_hwnd(self, drawable): " " "Set a Win32/Win64 API window handle (HWND). Specify where the media player should render its video output. If LibVLC was built without Win32/Win64 API output support, then this has no effects. @param drawable: windows handle of the drawable. “ „ “ if not isinstance(drawable, ctypes.c_void_p): drawable = ctypes.c_void_p(int(drawable)) libvlc_media_player_set_hwnd(self, drawable) def video_get_width(self, num=0): " " "Get the width of a video in pixels. @param num: video number (default 0). “ " “ return self.video_get_size(num) [0] def video_get_height(self, num=0): " " "Get the height of a video in pixels. @param num: video number (default 0). “ „ “ return self.video_get_size(num) [1] def video_get_cursor(self, num=0): " " "Get the mouse pointer coordinates over a video as 2-tuple (x, y). Coordinates are expressed in terms of the decoded video resolution, B{not} in terms of pixels on the screen/viewport. To get the latter, you must query your windowing system directly. Either coordinate may be negative or larger than the corresponding size of the video, if the cursor is outside the rendering area. @warning: The coordinates may be out-of-date if the pointer is not located on the video rendering area. LibVLC does not track the mouse pointer if the latter is outside the video widget. @note: LibVLC does not support multiple mouse pointers (but does support multiple input devices sharing the same pointer). @param num: video number (default 0). “ „ “ r = libvlc_video_get_cursor(self, num) if isinstance(r, tuple) and len(r) == 2: return r raise VLCException(‚invalid video number (%s)‘ % (num,)) def release(self): '''Release a media_player after use Decrement the reference count of a media player object. If the reference count is 0, then L{release} () will release the media player object. If the media player object has been released, then it should not be used again. ''' return libvlc_media_player_release(self) def retain(self): '''Retain a reference to a media player object. Use L{release}() to decrement reference count. ''' return libvlc_media_player_retain(self) def set_media(self, p_md): '''Set the media that will be used by the media_player. If any, previous md will be released. @param p_md: the Media. Afterwards the p_md can be safely destroyed. ''' return libvlc_media_player_set_media(self, p_md) def get_media(self): '''Get the media used by the media_player. @return: the media associated with p_mi, or None if no media is associated. ''' return libvlc_media_player_get_media(self) @memoize_parameterless def event_manager(self): '''Get the Event Manager from which the media player send event. @return: the event manager associated with p_mi. ''' return libvlc_media_player_event_manager(self) def is_playing(self): '''is_playing. @return: 1 if the media player is playing, 0 otherwise \libvlc_return_bool. ''' return libvlc_media_player_is_playing(self) def play(self): '''Play. @return: 0 if playback started (and was already started), or -1 on error. ''' return libvlc_media_player_play(self) def set_pause(self, do_pause): '''Pause or resume (no effect if there is no media). @param do_pause: play/resume if zero, pause if non- zero. @version: LibVLC 1.1.1 or later. ''' return libvlc_media_player_set_pause(self, do_pause) def pause(self): '''Toggle pause (no effect if there is no media). ''' return libvlc_media_player_pause(self) def stop(self): '''Stop (no effect if there is no media). ''' return libvlc_media_player_stop(self) def video_set_callbacks(self, lock, unlock, display, opaque): '''Set callbacks and private data to render decoded video to a custom area in memory. Use L{video_set_format} () or L{video_set_format_callbacks} () to configure the decoded format. @param lock: callback to lock video memory (must not be None). @param unlock: callback to unlock video memory (or None if not needed). @param display: callback to display video (or None if not needed). @param opaque: private pointer for the three callbacks (as first parameter). @version: LibVLC 1.1.1 or later. ''' return libvlc_video_set_callbacks(self, lock, unlock, display, opaque) def video_set_format(self, chroma, width, height, pitch): '''Set decoded video chroma and dimensions. This only works in combination with L{video_set_callbacks} (), and is mutually exclusive with L{video_set_format_callbacks} (). @param chroma: a four-characters string identifying the chroma (e.g. „RV32“ or „YUYV“). @param width: pixel width. @param height: pixel height. @param pitch: line pitch (in bytes). @version: LibVLC 1.1.1 or later. @bug: All pixel planes are expected to have the same pitch. To use the YCbCr color space with chrominance subsampling, consider using L{video_set_format_callbacks} () instead. ''' return libvlc_video_set_format(self, str_to_bytes(chroma), width, height, pitch) def video_set_format_callbacks(self, setup, cleanup): '''Set decoded video chroma and dimensions. This only works in combination with L{video_set_callbacks} (). @param setup: callback to select the video format (cannot be None). @param cleanup: callback to release any allocated resources (or None). @version: LibVLC 2.0.0 or later. ''' return libvlc_video_set_format_callbacks(self, setup, cleanup) def set_nsobject(self, drawable): '''Set the NSView handler where the media player should render its video output. Use the vout called „macosx“. The drawable is an NSObject that follow the VLCOpenGLVideoViewEmbedding protocol: @begincode \@protocol VLCOpenGLVideoViewEmbedding <NSObject> - (void)addVoutSubview:(NSView *)view; - (void)removeVoutSubview:(NSView *)view; \@end @endcode Or it can be an NSView object. If you want to use it along with Qt4 see the QMacCocoaViewContainer. Then the following code should work: @begincode NSView *video = [[NSView alloc] init]; QMacCocoaViewContainer *container = new QMacCocoaViewContainer(video, parent); L{set_nsobject} (mp, video); [video release]; @endcode You can find a live example in VLCVideoView in VLCKit.framework. @param drawable: the drawable that is either an NSView or an object following the VLCOpenGLVideoViewEmbedding protocol. ''' return libvlc_media_player_set_nsobject(self, drawable) def get_nsobject(self): '''Get the NSView handler previously set with L{set_nsobject} (). @return: the NSView handler or 0 if none where set. ''' return libvlc_media_player_get_nsobject(self) def set_agl(self, drawable): '''Set the agl handler where the media player should render its video output. @param drawable: the agl handler. ''' return libvlc_media_player_set_agl(self, drawable) def get_agl(self): '''Get the agl handler previously set with L{set_agl} () . @return: the agl handler or 0 if none where set. ''' return libvlc_media_player_get_agl(self) def set_xwindow(self, drawable): '''Set an X Window System drawable where the media player should render its video output. If LibVLC was built without X11 output support, then this has no effects. The specified identifier must correspond to an existing Input/Output class X11 window. Pixmaps are B{not} supported. The caller shall ensure that the X11 server is the same as the one the VLC instance has been configured with. This function must be called before video playback is started; otherwise it will only take effect after playback stop and restart. @param drawable: the ID of the X window. ''' return libvlc_media_player_set_xwindow(self, drawable) def get_xwindow(self): '''Get the X Window System window identifier previously set with L{set_xwindow} (). Note that this will return the identifier even if VLC is not currently using it (for instance if it is playing an audio-only input). @return: an X window ID, or 0 if none where set. ''' return libvlc_media_player_get_xwindow(self) def get_hwnd(self): '''Get the Windows API window handle (HWND) previously set with L{set_hwnd} (). The handle will be returned even if LibVLC is not currently outputting any video to it. @return: a window handle or None if there are none. ''' return libvlc_media_player_get_hwnd(self) def audio_set_callbacks(self, play, pause, resume, flush, drain, opaque): '''Set callbacks and private data for decoded audio. Use L{audio_set_format} () or L{audio_set_format_callbacks} () to configure the decoded audio format. @param play: callback to play audio samples (must not be None). @param pause: callback to pause playback (or None to ignore) . @param resume: callback to resume playback (or None to ignore). @param flush: callback to flush audio buffers (or None to ignore). @param drain: callback to drain audio buffers (or None to ignore). @param opaque: private pointer for the audio callbacks (as first parameter). @version: LibVLC 2.0.0 or later. ''' return libvlc_audio_set_callbacks(self, play, pause, resume, flush, drain, opaque) def audio_set_volume_callback(self, set_volume): '''Set callbacks and private data for decoded audio. This only works in combination with L{audio_set_callbacks} (). Use L{audio_set_format} () or L{audio_set_format_callbacks} () to configure the decoded audio format. @param set_volume: callback to apply audio volume, or None to apply volume in software. @version: LibVLC 2.0.0 or later. ''' return libvlc_audio_set_volume_callback(self, set_volume) def audio_set_format_callbacks(self, setup, cleanup): '''Set decoded audio format. This only works in combination with L{audio_set_callbacks} (). @param setup: callback to select the audio format (cannot be None). @param cleanup: callback to release any allocated resources (or None). @version: LibVLC 2.0.0 or later. ''' return libvlc_audio_set_format_callbacks(self, setup, cleanup) def audio_set_format(self, format, rate, channels): '''Set decoded audio format. This only works in combination with L{audio_set_callbacks} (), and is mutually exclusive with L{audio_set_format_callbacks} (). @param format: a four-characters string identifying the sample format (e.g. „S16N“ or „FL32“). @param rate: sample rate (expressed in Hz). @param channels: channels count. @version: LibVLC 2.0.0 or later. ''' return libvlc_audio_set_format(self, str_to_bytes(format), rate, channels) def get_length(self): '''Get the current movie length (in ms). @return: the movie length (in ms), or -1 if there is no media. ''' return libvlc_media_player_get_length(self) def get_time(self): '''Get the current movie time (in ms). @return: the movie time (in ms), or -1 if there is no media. ''' return libvlc_media_player_get_time(self) def set_time(self, i_time): '''Set the movie time (in ms). This has no effect if no media is being played. Not all formats and protocols support this. @param i_time: the movie time (in ms). ''' return libvlc_media_player_set_time(self, i_time) def get_position(self): '''Get movie position as percentage between 0.0 and 1.0. @return: movie position, or -1. in case of error. ''' return libvlc_media_player_get_position(self) def set_position(self, f_pos): '''Set movie position as percentage between 0.0 and 1.0. This has no effect if playback is not enabled. This might not work depending on the underlying input format and protocol. @param f_pos: the position. ''' return libvlc_media_player_set_position(self, f_pos) def set_chapter(self, i_chapter): '''Set movie chapter (if applicable). @param i_chapter: chapter number to play. ''' return libvlc_media_player_set_chapter(self, i_chapter) def get_chapter(self): '''Get movie chapter. @return: chapter number currently playing, or -1 if there is no media. ''' return libvlc_media_player_get_chapter(self) def get_chapter_count(self): '''Get movie chapter count. @return: number of chapters in movie, or -1. ''' return libvlc_media_player_get_chapter_count(self) def will_play(self): '''Is the player able to play. @return: boolean \libvlc_return_bool. ''' return libvlc_media_player_will_play(self) def get_chapter_count_for_title(self, i_title): '''Get title chapter count. @param i_title: title. @return: number of chapters in title, or -1. ''' return libvlc_media_player_get_chapter_count_for_title(self, i_title) def set_title(self, i_title): '''Set movie title. @param i_title: title number to play. ''' return libvlc_media_player_set_title(self, i_title) def get_title(self): '''Get movie title. @return: title number currently playing, or -1. ''' return libvlc_media_player_get_title(self) def get_title_count(self): '''Get movie title count. @return: title number count, or -1. ''' return libvlc_media_player_get_title_count(self) def previous_chapter(self): '''Set previous chapter (if applicable). ''' return libvlc_media_player_previous_chapter(self) def next_chapter(self): '''Set next chapter (if applicable). ''' return libvlc_media_player_next_chapter(self) def get_rate(self): '''Get the requested movie play rate. @warning: Depending on the underlying media, the requested rate may be different from the real playback rate. @return: movie play rate. ''' return libvlc_media_player_get_rate(self) def set_rate(self, rate): '''Set movie play rate. @param rate: movie play rate to set. @return: -1 if an error was detected, 0 otherwise (but even then, it might not actually work depending on the underlying media protocol). ''' return libvlc_media_player_set_rate(self, rate) def get_state(self): '''Get current movie state. @return: the current state of the media player (playing, paused, ...) See libvlc_state_t. ''' return libvlc_media_player_get_state(self) def get_fps(self): '''Get movie fps rate. @return: frames per second (fps) for this playing movie, or 0 if unspecified. ''' return libvlc_media_player_get_fps(self) def has_vout(self): '''How many video outputs does this media player have? @return: the number of video outputs. ''' return libvlc_media_player_has_vout(self) def is_seekable(self): '''Is this media player seekable? @return: true if the media player can seek \libvlc_return_bool. ''' return libvlc_media_player_is_seekable(self) def can_pause(self): '''Can this media player be paused? @return: true if the media player can pause \libvlc_return_bool. ''' return libvlc_media_player_can_pause(self) def program_scrambled(self): '''Check if the current program is scrambled. @return: true if the current program is scrambled \libvlc_return_bool. @version: LibVLC 2.2.0 or later. ''' return libvlc_media_player_program_scrambled(self) def next_frame(self): '''Display the next frame (if supported). ''' return libvlc_media_player_next_frame(self) def navigate(self, navigate): '''Navigate through DVD Menu. @param navigate: the Navigation mode. @version: libVLC 2.0.0 or later. ''' return libvlc_media_player_navigate(self, navigate) def set_video_title_display(self, position, timeout): '''Set if, and how, the video title will be shown when media is played. @param position: position at which to display the title, or libvlc_position_disable to prevent the title from being displayed. @param timeout: title display timeout in milliseconds (ignored if libvlc_position_disable). @version: libVLC 2.1.0 or later. ''' return libvlc_media_player_set_video_title_display(self, position, timeout) def toggle_fullscreen(self): '''Toggle fullscreen status on non-embedded video outputs. @warning: The same limitations applies to this function as to L{set_fullscreen} (). ''' return libvlc_toggle_fullscreen(self) def set_fullscreen(self, b_fullscreen): '''Enable or disable fullscreen. @warning: With most window managers, only a top-level windows can be in full-screen mode. Hence, this function will not operate properly if L{set_xwindow} () was used to embed the video in a non-top-level window. In that case, the embedding window must be reparented to the root window B{before} fullscreen mode is enabled. You will want to reparent it back to its normal parent when disabling fullscreen. @param b_fullscreen: boolean for fullscreen status. ''' return libvlc_set_fullscreen(self, b_fullscreen) def get_fullscreen(self): '''Get current fullscreen status. @return: the fullscreen status (boolean) \libvlc_return_bool. ''' return libvlc_get_fullscreen(self) def video_set_key_input(self, on): '''Enable or disable key press events handling, according to the LibVLC hotkeys configuration. By default and for historical reasons, keyboard events are handled by the LibVLC video widget. @note: On X11, there can be only one subscriber for key press and mouse click events per window. If your application has subscribed to those events for the X window ID of the video widget, then LibVLC will not be able to handle key presses and mouse clicks in any case. @warning: This function is only implemented for X11 and Win32 at the moment. @param on: true to handle key press events, false to ignore them. ''' return libvlc_video_set_key_input(self, on) def video_set_mouse_input(self, on): '''Enable or disable mouse click events handling. By default, those events are handled. This is needed for DVD menus to work, as well as a few video filters such as „puzzle“. See L{video_set_key_input} (). @warning: This function is only implemented for X11 and Win32 at the moment. @param on: true to handle mouse click events, false to ignore them. ''' return libvlc_video_set_mouse_input(self, on) def video_get_scale(self): '''Get the current video scaling factor. See also L{video_set_scale} (). @return: the currently configured zoom factor, or 0. if the video is set to fit to the output window/drawable automatically. ''' return libvlc_video_get_scale(self) def video_set_scale(self, f_factor): '''Set the video scaling factor. That is the ratio of the number of pixels on screen to the number of pixels in the original decoded video in each dimension. Zero is a special value; it will adjust the video to the output window/drawable (in windowed mode) or the entire screen. Note that not all video outputs support scaling. @param f_factor: the scaling factor, or zero. ''' return libvlc_video_set_scale(self, f_factor) def video_get_aspect_ratio(self): '''Get current video aspect ratio. @return: the video aspect ratio or None if unspecified (the result must be released with free() or L{free} ()). ''' return libvlc_video_get_aspect_ratio(self) def video_set_aspect_ratio(self, psz_aspect): '''Set new video aspect ratio. @param psz_aspect: new video aspect-ratio or None to reset to default @note Invalid aspect ratios are ignored. ''' return libvlc_video_set_aspect_ratio(self, str_to_bytes(psz_aspect)) def video_get_spu(self): '''Get current video subtitle. @return: the video subtitle selected, or -1 if none. ''' return libvlc_video_get_spu(self) def video_get_spu_count(self): '''Get the number of available video subtitles. @return: the number of available video subtitles. ''' return libvlc_video_get_spu_count(self) def video_set_spu(self, i_spu): '''Set new video subtitle. @param i_spu: video subtitle track to select (i_id from track description). @return: 0 on success, -1 if out of range. ''' return libvlc_video_set_spu(self, i_spu) def video_set_subtitle_file(self, psz_subtitle): '''Set new video subtitle file. @param psz_subtitle: new video subtitle file. @return: the success status (boolean). ''' return libvlc_video_set_subtitle_file(self, str_to_bytes(psz_subtitle)) def video_get_spu_delay(self): '''Get the current subtitle delay. Positive values means subtitles are being displayed later, negative values earlier. @return: time (in microseconds) the display of subtitles is being delayed. @version: LibVLC 2.0.0 or later. ''' return libvlc_video_get_spu_delay(self) def video_set_spu_delay(self, i_delay): '''Set the subtitle delay. This affects the timing of when the subtitle will be displayed. Positive values result in subtitles being displayed later, while negative values will result in subtitles being displayed earlier. The subtitle delay will be reset to zero each time the media changes. @param i_delay: time (in microseconds) the display of subtitles should be delayed. @return: 0 on success, -1 on error. @version: LibVLC 2.0.0 or later. ''' return libvlc_video_set_spu_delay(self, i_delay) def video_get_crop_geometry(self): '''Get current crop filter geometry. @return: the crop filter geometry or None if unset. ''' return libvlc_video_get_crop_geometry(self) def video_set_crop_geometry(self, psz_geometry): '''Set new crop filter geometry. @param psz_geometry: new crop filter geometry (None to unset). ''' return libvlc_video_set_crop_geometry(self, str_to_bytes(psz_geometry)) def video_get_teletext(self): '''Get current teletext page requested. @return: the current teletext page requested. ''' return libvlc_video_get_teletext(self) def video_set_teletext(self, i_page): '''Set new teletext page to retrieve. @param i_page: teletex page number requested. ''' return libvlc_video_set_teletext(self, i_page) def toggle_teletext(self): '''Toggle teletext transparent status on video output.''' return libvlc_toggle_teletext(self) def video_get_track_count(self): '''Get number of available video tracks. @return: the number of available video tracks (int). ''' return libvlc_video_get_track_count(self) def video_get_track(self): '''Get current video track. @return: the video track ID (int) or -1 if no active input.''' return libvlc_video_get_track(self) def video_set_track(self, i_track): '''Set video track. @param i_track: the track ID (i_id field from track description). @return: 0 on success, -1 if out of range. ''' return libvlc_video_set_track(self, i_track) def video_take_snapshot(self, num, psz_filepath, i_width, i_height): '''Take a snapshot of the current video window. If i_width AND i_height is 0, original size is used. If i_width XOR i_height is 0, original aspect-ratio is preserved. @param num: number of video output (typically 0 for the first/only one). @param psz_filepath: the path where to save the screenshot to. @param i_width: the snapshot's width. @param i_height: the snapshot's height. @return: 0 on success, -1 if the video was not found. ''' return libvlc_video_take_snapshot(self, num, str_to_bytes(psz_filepath), i_width, i_height) def video_set_deinterlace(self, psz_mode): '''Enable or disable deinterlace filter. @param psz_mode: type of deinterlace filter, None to disable.''' return libvlc_video_set_deinterlace(self, str_to_bytes(psz_mode) ) def video_get_marquee_int(self, option): '''Get an integer marquee option value. @param option: marq option to get See libvlc_video_marquee_int_option_t. ''' return libvlc_video_get_marquee_int(self, option) def video_get_marquee_string(self, option): '''Get a string marquee option value. @param option: marq option to get See libvlc_video_marquee_string_option_t. ''' return libvlc_video_get_marquee_string(self, option) def video_set_marquee_int(self, option, i_val): '''Enable, disable or set an integer marquee option Setting libvlc_marquee_Enable has the side effect of enabling (arg !0) or disabling (arg 0) the marq filter. @param option: marq option to set See libvlc_video_marquee_int_option_t. @param i_val: marq option value. ''' return libvlc_video_set_marquee_int(self, option, i_val) def video_set_marquee_string(self, option, psz_text): '''Set a marquee string option. @param option: marq option to set See libvlc_video marquee_string_option_t. @param psz_text: marq option value. ''' return libvlc_video_set_marquee_string(self, option, str_to_bytes(psz_text) ) def video_get_logo_int(self, option): '''Get integer logo option. @param option: logo option to get, values of libvlc_video_logo_option_t. ''' return libvlc_video_get_logo_int(self, option) def video_set_logo_int(self, option, value): '''Set logo option as integer. Options that take a different type value are ignored. Passing libvlc_logo_enable as option value has the side effect of starting (arg !0) or stopping (arg 0) the logo filter. @param option: logo option to set, values of libvlc_video_logo_option_t. @param value: logo option value. ''' return libvlc_video_set_logo_int(self, option, value) def video_set_logo_string(self, option, psz_value): '''Set logo option as string. Options that take a different type value are ignored. @param option: logo option to set, values of libvlc_video_logo_option_t. @param psz_value: logo option value. ''' return libvlc_video_set_logo_string(self, option, str_to_bytes(psz_value)) def video_get_adjust_int(self, option): '''Get integer adjust option. @param option: adjust option to get, values of libvlc_video_adjust_option_t. @version: LibVLC 1.1.1 and later. ''' return libvlc_video_get_adjust_int(self, option) def video_set_adjust_int(self, option, value): '''Set adjust option as integer. Options that take a different type value are ignored. Passing libvlc_adjust_enable as option value has the side effect of starting (arg !0) or stopping (arg 0) the adjust filter. @param option: adust option to set, values of libvlc_video_adjust_option_t. @param value: adjust option value. @version: LibVLC 1.1.1 and later. ''' return libvlc_video_set_adjust_int(self, option, value) def video_get_adjust_float(self, option): '''Get float adjust option. @param option: adjust option to get, values of libvlc_video_adjust_option_t. @version: LibVLC 1.1.1 and later. ''' return libvlc_video_get_adjust_float(self, option) def video_set_adjust_float(self, option, value): '''Set adjust option as float. Options that take a different type value are ignored. @param option: adust option to set, values of libvlc_video_adjust_option_t. @param value: adjust option value. @version: LibVLC 1.1.1 and later. ''' return libvlc_video_set_adjust_float(self, option, value) def audio_output_set(self, psz_name): '''Selects an audio output module. @note: Any change will take be effect only after playback is stopped and restarted. Audio output cannot be changed while playing. @param psz_name: name of audio output, use psz_name of See L{AudioOutput}. @return: 0 if function succeded, -1 on error. ''' return libvlc_audio_output_set(self, str_to_bytes(psz_name)) def audio_output_device_enum(self): '''Gets a list of potential audio output devices, See L{audio_output_device_set} ( ). @note: Not all audio outputs support enumerating devices. The audio output may be functional even if the list is empty (None). @note: The list may not be exhaustive. @warning: Some audio output devices in the list might not actually work in some circumstances. By default, it is recommended to not specify any explicit audio device. @return: A None-terminated linked list of potential audio output devices. It must be freed it with L{audio_output_device_list_release} ( ). @version: LibVLC 2.2.0 or later. ''' return libvlc_audio_output_device_enum(self) def audio_output_device_set(self, module, device_id): '''Configures an explicit audio output device. If the module paramater is None, audio output will be moved to the device specified by the device identifier string immediately. This is the recommended usage. A list of adequate potential device strings can be obtained with L{audio_output_device_enum} ( ) . However passing None is supported in LibVLC version 2.2.0 and later only; in earlier versions, this function would have no effects when the module parameter was None. If the module parameter is not None, the device parameter of the corresponding audio output, if it exists, will be set to the specified string. Note that some audio output modules do not have such a parameter (notably MMDevice and PulseAudio). A list of adequate potential device strings can be obtained with L{audio_output_device_list_get} ( ). @note: This function does not select the specified audio output plugin. L{audio_output_set} ( ) is used for that purpose. @warning: The syntax for the device parameter depends on the audio output. Some audio output modules require further parameters (e.g. a channels map in the case of ALSA). @param module: If None, current audio output module. if non-None, name of audio output module. @param device_id: device identifier string. @return: Nothing. Errors are ignored (this is a design bug). ''' return libvlc_audio_output_device_set(self, str_to_bytes(module), str_to_bytes(device_id)) def audio_toggle_mute(self): '''Toggle mute status. ''' return libvlc_audio_toggle_mute(self) def audio_get_mute(self): '''Get current mute status. @return: the mute status (boolean) if defined, -1 if undefined/unapplicable. ''' return libvlc_audio_get_mute(self) def audio_set_mute(self, status): '''Set mute status. @param status: If status is true then mute, otherwise unmute @warning This function does not always work. If there are no active audio playback stream, the mute status might not be available. If digital pass-through (S/PDIF, HDMI...) is in use, muting may be unapplicable. Also some audio output plugins do not support muting at all. @note To force silent playback, disable all audio tracks. This is more efficient and reliable than mute. ''' return libvlc_audio_set_mute(self, status) def audio_get_volume(self): '''Get current software audio volume. @return: the software volume in percents (0 = mute, 100 = nominal / 0dB). ''' return libvlc_audio_get_volume(self) def audio_set_volume(self, i_volume): '''Set current software audio volume. @param i_volume: the volume in percents (0 = mute, 100 = 0dB). @return: 0 if the volume was set, -1 if it was out of range.''' return libvlc_audio_set_volume(self, i_volume) def audio_get_track_count(self): '''Get number of available audio tracks. @return: the number of available audio tracks (int), or -1 if unavailable. ''' return libvlc_audio_get_track_count(self) def audio_get_track(self): '''Get current audio track. @return: the audio track ID or -1 if no active input. ''' return libvlc_audio_get_track(self) def audio_set_track(self, i_track): '''Set current audio track. @param i_track: the track ID (i_id field from track description). @return: 0 on success, -1 on error. ''' return libvlc_audio_set_track(self, i_track) def audio_get_channel(self): '''Get current audio channel. @return: the audio channel See libvlc_audio_output_channel_t. ''' return libvlc_audio_get_channel(self) def audio_set_channel(self, channel): '''Set current audio channel. @param channel: the audio channel, See libvlc_audio_output_channel_t. @return: 0 on success, -1 on error. ''' return libvlc_audio_set_channel(self, channel) def audio_get_delay(self) : '''Get current audio delay. @return: the audio delay (microseconds). @version: LibVLC 1.1.1 or later. ''' return libvlc_audio_get_delay(self) def audio_set_delay(self, i_delay): '''Set current audio delay. The audio delay will be reset to zero each time the media changes. @param i_delay: the audio delay (microseconds). @return: 0 on success, -1 on error. @version: LibVLC 1.1.1 or later. ''' return libvlc_audio_set_delay(self, i_delay) def set_equalizer(self, p_equalizer): '''Apply new equalizer settings to a media player. The equalizer is first created by invoking L{audio_equalizer_new}() or L{audio_equalizer_new_from_preset} ( ). It is possible to apply new equalizer settings to a media player whether the media player is currently playing media or not. Invoking this method will immediately apply the new equalizer settings to the audio output of the currently playing media if there is any. If there is no currently playing media, the new equalizer settings will be applied later if and when new media is played. Equalizer settings will automatically be applied to subsequently played media. To disable the equalizer for a media player invoke this method passing None for the p_equalizer parameter. The media player does not keep a reference to the supplied equalizer so it is safe for an application to release the equalizer reference any time after this method returns. @param p_equalizer: opaque equalizer handle, or None to disable the equalizer for this media player. @return: zero on success, -1 on error. @version: LibVLC 2.2.0 or later. ''' return libvlc_media_player_set_equalizer(self, p_equalizer) # LibVLC_version_functions # def libvlc_clearerr ( ): '''Clears the LibVLC error status for the current thread. This is optional. By default, the error status is automatically overridden when a new error occurs, and destroyed when the thread exits. ''' f = _Cfunctions.get(‚libvlc_clearerr‘, None) or \ _Cfunction(‚libvlc_clearerr‘, ( ), None, None) return f() def libvlc_vprinterr(fmt, ap): '''Sets the LibVLC error status and message for the current thread. Any previous error is overridden. @param fmt: the format string. @param ap: the arguments. @return: a nul terminated string in any case. ''' f = _Cfunctions.get(‚libvlc_vprinterr‘, None) or \ _Cfunction(‚libvlc_vprinterr‘, ((1,), (1,),), None, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_void_p) return f(fmt, ap) def libvlc_new(argc, argv): ''Create and initialize a libvlc instance. This functions accept a list of „command line“ arguments similar to the main ( ). These arguments affect the LibVLC instance default configuration. @param argc: the number of arguments (should be 0). @param argv: list of arguments (should be None). @return: the libvlc instance or None in case of error. @version Arguments are meant to be passed from the command line to LibVLC, just like VLC media player does. The list of valid arguments depends on the LibVLC version, the operating system and platform, and set of available LibVLC plugins. Invalid or unsupported arguments will cause the function to fail (i.e. return None). Also, some arguments may alter the behaviour or otherwise interfere with other LibVLC functions. @warning There is absolutely no warranty or promise of forward, backward and cross-platform compatibility with regards to L{libvlc_new} ( ) arguments. We recommend that you do not use them, other than when debugging. ''' f = Cfunctions.get(‚libvlc new‘, None) or \ _Cfunction(‚libvlc_new‘, ((1,), (1,),), class_result(Instance), ctypes.c_void_p, ctypes.c_int, ListPOINTER(ctypes.c_char_p)) return f(argc, argv) def libvlc_release(p_instance): '''Decrement the reference count of a libvlc instance, and destroy it if it reaches zero. @param p_instance: the instance to destroy. ''' f = Cfunctions.get(‚libvlc release‘, None) or \ -Cfunction(‚libvlc_release‘, (( 1, ) , ), None, None, Instance) return f(p_instance) def libvlc_retain(p_instance): '''Increments the reference count of a libvlc instance. The initial reference count is 1 after L{libvlc_new}() returns. @param p_instance: the instance to reference. ''' f = Cfunctions.get(‚libvlc retain‘, None) or \ _Cfunction(‚libvlc_retain‘, (( 1, ) , ), None, None, Instance) return f(p_instance) def libvlc_add_intf(p_instance, name): '''Try to start a user interface for the libvlc instance. @param p_instance: the instance. @param name: interface name, or None for default. @return: 0 on success, -1 on error. ''' f = _Cfunctions.get(‚libvlc_add_intf‘, None) or \ _Cfunction(‚libvlc_add_intf‘, ((1,), (1,),), None, ctypes.c_int, Instance, ctypes.c_char_p) return f(p_instance, name) def libvlc_wait(p_instance): '''Waits until an interface causes the instance to exit. You should start at least one interface first, using L{libvlc_add_intf} ( ). @param p_instance: the instance @warning This function wastes one thread doing basically nothing. libvlc_set_exit_handler ( ) should be used instead. ''' f = _Cfunctions.get(‚libvlc_wait‘, None) or \ _Cfunction(‚libvlc_wait‘, ((1,),), None, None, Instance) return f(p_instance) def libvlc_set_user_agent(p_instance, name, http): '''Sets the application name. LibVLC passes this as the user agent string when a protocol requires it. @param p_instance: LibVLC instance. @param name: human-readable application name, e.g. „FooBar player 1.2.3“. @param http: HTTP User Agent, e.g. „FooBar/1.2.3 Python/2.6.0“. @version: LibVLC 1.1.1 or later. ''' f = _Cfunctions.get(‚libvlc_set_user_agent‘, None) or \ _Cfunction(‚libvlc_set_user_agent‘, ((1,), (1,), (1,),), None, None, Instance, ctypes.c_char_p, ctypes.c_char_p) return f(p_instance, name, http) def libvlc_set_app_id(p_instance, id, version, icon): '''Sets some meta-information about the application. See also L{libvlc_set_user_agent} ( ). @param p_instance: LibVLC instance. @param id: Java-style application identifier, e.g. „com.acme.foobar“. @param version: application version numbers, e.g. „1.2.3". @param icon: application icon name, e.g. „foobar“. @version: LibVLC 2.1.0 or later. ''' f = _Cfunctions.get(‚libvlc_set_app_id‘, None) or \ _Cfunction(‚libvlc_set_app_id‘, ((1,), (1,), (1,), (1,),), None, None, Instance, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_char_p) return f(p_instance, id, version, icon) def libvlc_get_version ( ): '''Retrieve libvlc version. Example: „1.1.0-git The Luggage“. @return: a string containing the libvlc version. ''' f = _Cfunctions.get(‚libvlc_get_version‘, None) or \ _Cfunction(‚libvlc_get_version‘, (), None, ctypes.c_char_p) return f ( ) def libvlc_get_compiler ( ) : '''Retrieve libvlc compiler version. Example: „gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)“. @return: a string containing the libvlc compiler version. ''' f = _Cfunctions.get(‚libvlc_get_compiler‘, None) or \ _Cfunction(‚libvlc_get_compiler‘, (), None, ctypes.c_char_p) return f ( ) def libvlc_get_changeset ( ): '''Retrieve libvlc changeset. Example: „aa9bce0bc4“. @return: a string containing the libvlc changeset. ''' f = _Cfunctions.get(‚libvlc_get_changeset‘, None) or \ _Cfunction(‚libvlc_get_changeset‘, (), None, ctypes.c_char_p) return f ( ) def libvlc_free(ptr): '''Frees an heap allocation returned by a LibVLC function. If you know you're using the same underlying C run-time as the LibVLC implementation, then you can call ANSI C free() directly instead. @param ptr: the pointer. ''' f = _Cfunctions.get(‚libvlc_free‘, None) or \ _Cfunction(‚libvlc_free‘, ((1,),), None, None, ctypes.c_void_p) return f(ptr) def libvlc_event_attach(p_event_manager, i_event_type, f_callback, user_data): '''Register for an event notification. @param p_event_manager: the event manager to which you want to attach to. Generally it is obtained by vlc_my_object_event_manager() where my_object is the object you want to listen to. @param i_event_type: the desired event to which we want to listen. @param f_callback: the function to call when i_event_type occurs. @param user_data: user provided data to carry with the event. @return: 0 on success, ENOMEM on error. ''' f = _Cfunctions.get(‚libvlc_event_attach‘, None) or \ _Cfunction(‚libvlc_event_attach‘, ((1,), (1,), (1,), (1,),), None, ctypes.c_int, EventManager, ctypes.c_uint, Callback, ctypes.c_void_p) return f(p_event_manager, i_event_type, f_callback, user_data) def libvlc_event_detach(p_event_manager, i_event_type, f_callback, p_user_data): '''Unregister an event notification. @param p_event_manager: the event manager. @param i_event_type: the desired event to which we want to unregister. @param f_callback: the function to call when i_event_type occurs. @param p_user_data: user provided data to carry with the event. ''' f = _Cfunctions.get(‚libvlc_event_detach‘, None) or \ _Cfunction ('libvlc_event_detach', ((1,), (1,), (1,), (1,),), None, None, EventManager, ctypes.c_uint, Callback, ctypes.c_void_p) return f(p_event_manager, i_event_type, f_callback, p_user_data) def libvlc_event_type_name(event_type): '''Get an event's type name. @param event_type: the desired event. ''' f = _Cfunctions.get(‚libvlc_event_type_name‘, None) or \ _Cfunction(‚libvlc_event_type_name‘ , ((1,),), None, ctypes.c_char_p, ctypes.c_uint) return f(event_type) def libvlc_log_get_context(ctx): '''Gets debugging information about a log message: the name of the VLC module emitting the message and the message location within the source code. The returned module name and file name will be None if unknown. The returned line number will similarly be zero if unknown. @param ctx: message context (as passed to the @ref libvlc_log_cb callback). @return: module module name storage (or None), file source code file name storage (or None), line source code file line number storage (or None). @version: LibVLC 2.1.0 or later. ''' f = _Cfunctions.get(‚libvlc_log_get_context‘, None) or \ _Cfunction(‚libvlc_log_get_context‘, ((1,), (2,), (2,), (2,),), None, None, Log_ptr, ListPOINTER(ctypes.c_char_p), ListPOINTER(ctypes.c_char_p), ctypes.POINTER(ctypes.c_uint)) return f(ctx) def libvlc_log_get_object(ctx, id): '''Gets VLC object information about a log message: the type name of the VLC object emitting the message, the object header if any and a temporaly-unique object identifier. This information is mainly meant for B{manual} troubleshooting. The returned type name may be „generic“ if unknown, but it cannot be None. The returned header will be None if unset; in current versions, the header is used to distinguish for VLM inputs. The returned object ID will be zero if the message is not associated with any VLC object. @param ctx: message context (as passed to the @ref libvlc_log_cb callback). @return: name object name storage (or None), header object header (or None), line source code file line number storage (or None). @version: LibVLC 2.1.0 or later. ''' f = _Cfunctions.get(‚libvlc_log_get_object‘, None) or \ _Cfunction (' libvlc_log_get_object', ((1,), (2,), (2,), (1,),), None, None, Log_ptr, ListPOINTER(ctypes.c_char_p), ListPOINTER(ctypes.c_char_p), ctypes.POINTER(ctypes.c_uint)) return f(ctx, id) def libvlc_log_unset(p_instance): '''Unsets the logging callback for a LibVLC instance. This is rarely needed: the callback is implicitly unset when the instance is destroyed. This function will wait for any pending callbacks invocation to complete (causing a deadlock if called from within the callback). @param p_instance: libvlc instance. @version: LibVLC 2.1.0 or later. ''' f = _Cfunctions.get(‚libvlc_log_unset‘, None) or \ _Cfunction(‚libvlc_log_unset‘, ((1,),), None, None, Instance) return f(p_instance) def libvlc_log_set(p_instance, cb, data): '''Sets the logging callback for a LibVLC instance. This function is thread-safe: it will wait for any pending callbacks invocation to complete. @param cb: callback function pointer. @param data: opaque data pointer for the callback function @note Some log messages (especially debug) are emitted by LibVLC while is being initialized. These messages cannot be captured with this interface. @warning A deadlock may occur if this function is called from the callback. @param p_instance: libvlc instance. @version: LibVLC 2.1.0 or later. ''' f = _Cfunctions.get(‚libvlc_log_set‘, None) or \ _Cfunction(' libvlc_log_set', ((1,), (1,), (1,),), None, None, Instance, LogCb, ctypes.c_void_p) return f(p_instance, cb, data) def libvlc_log_set_file(p_instance, stream): '''Sets up logging to a file. @param p_instance: libvlc instance. @param stream: FILE pointer opened for writing (the FILE pointer must remain valid until L{libvlc_log_unset} ( )). @version: LibVLC 2.1.0 or later. ''' f = _Cfunctions.get(‚libvlc_log_set_file‘, None) or \ _Cfunction(‚libvlc_log_set_file‘, ((1,), (1,),), None, None, Instance, FILE_ptr) return f(p_instance, stream) def libvlc_get_log_verbosity(p_instance): '''Always returns minus one. This function is only provided for backward compatibility. @param p_instance: ignored. @return: always -1. ''' f = _Cfunctions.get(‚libvlc_get_log_verbosity‘, None) or \ _Cfunction(‚libvlc_get_log_verbosity‘, ((1,),), None, ctypes.c_uint, Instance) return f(p_instance) def libvlc_set_log_verbosity(p_instance, level): '''This function does nothing. It is only provided for backward compatibility. @param p_instance: ignored. @param level: ignored. ''' f = _Cfunctions.get(‚libvlc_set_log_verbosity‘, None) or \ _Cfunction (' libvlc_set_log_verbosity', ((1,), (1,),), None, None, Instance, ctypes.c_uint) return f(p_instance, level) def libvlc_log_open(p_instance): '''This function does nothing useful. It is only provided for backward compatibility. @param p_instance: libvlc instance. @return: an unique pointer or None on error. ''' f = _Cfunctions.get(‚libvlc_log_open‘, None) or \ _Cfunction(‚libvlc_log_open‘, ((1,),), None, Log_ptr, Instance) return f(p_instance) def libvlc_log_close(p_log): '''Frees memory allocated by L{libvlc_log_open} ( ). @param p_log: libvlc log instance or None. ''' f = _Cfunctions.get(‚libvlc_log_close‘, None) or \ _Cfunction(‚libvlc_log_close‘, ((1,),), None, None, Log_ptr) return f(p_log) def libvlc_log_count(p_log): '''Always returns zero. This function is only provided for backward compatibility. @param p_log: ignored. @return: always zero. ''' f = _Cfunctions.get(‚libvlc_log_count‘, None) or \ _Cfunction(‚libvlc_log_count‘, ((1,),), None, ctypes.c_uint, Log_ptr) return f(p_log) def libvlc_log_clear(p_log): '''This function does nothing. It is only provided for backward compatibility. @param p_log: ignored. ''' f = _Cfunctions.get(‚libvlc_log_clear‘, None) or \ _Cfunction(‚libvlc_log_clear‘, ((1,),), None, None, Log_ptr) return f(p_log) def libvlc_log_get_iterator(p_log): '''This function does nothing useful. It is only provided for backward compatibility. @param p_log: ignored. @return: an unique pointer or None on error or if the parameter was None. ''' f = _Cfunctions.get, None) or \ _Cfunction(‚libvlc_log_get_iterator‘, ((1,) ,), class_result(LogIterator) , ctypes.c_void_p, Log_ptr) return f(p_log) def libvlc_log_iterator_free(p_iter): '''Frees memory allocated by L{libvlc_log_get_iterator} ( ). @param p_iter: libvlc log iterator or None. ''' f = _Cfunctions.get(‚libvlc_log_iterator_free‘, None) or \ _Cfunction(‚libvlc_log_iterator_free‘, ((1,),), None, None, LogIterator) return f(p_iter) def libvlc_log_iterator_has_next(p_iter): '''Always returns zero. This function is only provided for backward compatibility. @param p_iter: ignored. @return: always zero. ''' f = _Cfunctions.get(‚libvlc_log_iterator_has_next‘, None) or \ _Cfunction(‚libvlc_log_iterator_has_next‘, ( (1,),), None, ctypes.c_int, LogIterator) return f(p_iter) def libvlc_log_iterator_next(p_iter, p_buf): '''Always returns None. This function is only provided for backward compatibility. @param p_iter: libvlc log iterator or None. @param p_buf: ignored. @return: always None. ''' f = Cfunctions.get(‚libvlc log iterator next‘, None) or \ _Cfunction (' libvlc_log_iterator_next', ((1,), (1,),), None, ctypes.POINTER(LogMessage), LogIterator, ctypes.POINTER(LogMessage) ) return f(p_iter, p_buf) def libvlc_module_description_list_release(p_list): '''Release a list of module descriptions. @param p_list: the list to be released. ''' f = _Cfunctions.get(‚libvlc_module_description_list_release‘, None) or \ _Cfunction(‚libvlc_module_description_list_release‘, ( (1,),), None, None, ctypes.POINTER(ModuleDescription)) return f(p_list) def libvlc_audio_filter_list_get(p_instance): '''Returns a list of audio filters that are available. @param p_instance: libvlc instance. @return: a list of module descriptions. It should be freed with L{libvlc_module_description_list_release} ( ). In case of an error, None is returned. See L{ModuleDescription} See L{libvlc_module_description_list_release}. ''' f = _Cfunctions.get(‚libvlc_audio_filter_list_get‘, None) or \ _Cfunction(‚libvlc_audio_filter_list_get‘, ( (1,),), None, ctypes.POINTER(ModuleDescription) , Instance) return f(p_instance) def libvlc_video_filter_list_get(p_instance): '''Returns a list of video filters that are available. @param p_instance: libvlc instance. @return: a list of module descriptions. It should be freed with L{libvlc_module_description_list_release} ( ). In case of an error, None is returned. See L{ModuleDescription} See L{libvlc_module_description_list_release}. ''' f = _Cfunctions.get(‚libvlc_video_filter_list_get‘, None) or \ _Cfunction(‚libvlc_video_filter_list_get‘, ( (1,),), None, ctypes.POINTER(ModuleDescription), Instance) return f(p_instance) def libvlc_clock ( ): '''Return the current time as defined by LibVLC. The unit is the microsecond. Time increases monotonically (regardless of time zone changes and RTC adjustements) . The origin is arbitrary but consistent across the whole system (e.g. the system uptim, the time since the system was booted) . @note: On systems that support it, the POSIX monotonic clock is used. ''' f = _Cfunctions.get(‚libvlc_clock‘, None) or \ _Cfunction(‚libvlc_clock‘, (), None, ctypes.c_int64) return f ( ) def libvlc_media_discoverer_new_from_name(p_inst, psz_name): '''Discover media service by name. @param p_inst: libvlc instance. @param psz_name: service name. @return: media discover object or None in case of error. ''' f = _Cfunctions.get(‚libvlc_media_discoverer_new_from_name‘, None) or \ _Cfunction(‚libvlc_media_discoverer_new_from_name‘, ((1,), (1,),), class_result(MediaDiscoverer), ctypes.c_void_p, Instance, ctypes.c_char_p) return f(p_inst, psz_name) def libvlc_media_discoverer_release(p_mdis): '''Release media discover object. If the reference count reaches 0, then the object will be released. @param pmdis: media service discover object. ''' f = _Cfunctions.get(‚libvlc_media_discoverer_release‘, None) or \ _Cfunction(‚libvlc_media_discoverer_release‘, ( (1,),), None, None, MediaDiscoverer) return f(p_mdis) def libvlc_media_discoverer_localized_name(p_mdis): '''Get media service discover object its localized name. @param p_mdis: media discover object. @return: localized name. ''' f = _Cfunctions.get(‚libvlc_media_discoverer_localized_name‘, None) or \ _Cfunction(‚libvlc_media_discoverer_localized_name‘, ((1,),), string_result, ctypes.c_void_p, MediaDiscoverer) return f(p_mdis) def libvlc_media_discoverer_media_list(p_mdis): '''Get media service discover media list. @param p_mdis: media service discover object. @return: list of media items. ''' f = _Cfunctions.get(‚libvlc_media_discoverer_media_list‘, None) or \ _Cfunction(‚libvlc_media_discoverer_media_list‘, ((1,),), class_result(MediaList), ctypes.c_void_p, MediaDiscoverer) return f(p_mdis) def libvlc_media_discoverer_event_manager(p_mdis): '''Get event manager from media service discover object. @param p_mdis: media service discover object. @return: event manager object. ''' f = _Cfunctions.get(‚libvlc_media_discoverer_event_manager‘, None) or \ _Cfunction(‚libvlc_media_discoverer_event_manager‘, ((1,) , ) , class_result(EventManager), ctypes.c_void_p, MediaDiscoverer) return f(p_mdis) def libvlc_media_discoverer_is_running(p_mdis): '''Query if media service discover object is running. @param p_mdis: media service discover object. @return: true if running, false if not \libvlc_return_bool. ''' f = _Cfunctions.get(‚libvlc_media_discoverer_is_running‘, None) or \ _Cfunction(‚libvlc_media_discoverer_is_running‘, ( (1,),), None, ctypes.c_int, MediaDiscoverer) return f(p_mdis) def libvlc_media_library_new(p_instance): '''Create an new Media Library object. @param p_instance: the libvlc instance. @return: a new object or None on error. ''' \f = _Cfunctions.get(‚libvlcmedia_library_new‘, None) or _Cfunction(‚libvlc_media_library_new‘, ( (1,),), class_result(MediaLibrary), ctypes.c_void_p, Instance) return f(p_instance) def libvlc_media_library_release(p_mlib): '''Release media library object. This functions decrements the reference count of the media library object. If it reaches 0, then the object will be released. @param p_mlib: media library object. ''' f = _Cfunctions.get(‚libvlc_media_library_release‘, None) or \ _Cfunction(‚libvlc_media_library_release‘, ((1,),), None, None, MediaLibrary) return f(p_mlib) def libvlc_media_library_retain(p_mlib): '''Retain a reference to a media library object. This function will increment the reference counting for this object. Use L{libvlc_media_library_release} ( ) to decrement the reference count. @param p_mlib: media library object. ''' f = _Cfunctions.get(‚libvlc_media_library_retain‘, None) or \ _Cfunction(‚libvlc_media_library_retain‘, ((1,) ,), None, None, MediaLibrary) return f(p_mlib) def libvlc_media_library_load(p_mlib): '''Load media library. @param p_mlib: media library object. @return: 0 on success, -1 on error. ''' f = _Cfunctions.get(‚libvlc_media_library_load‘, None) or \ _Cfunction(‚libvlc_media_library_load‘, ( (1, ) , ) , None, ctypes.c_int, MediaLibrary) return f(p_mlib) def libvlc_media_library_media_list(p_mlib): '''Get media library subitems. @param p_mlib: media library object. @return: media list subitems. ''' f = _Cfunctions.get(‚libvlc_media_library_media_list‘, None) or \ _Cfunction(‚libvlc_media_library_media_list‘, ( (1,),), class_result(MediaList), ctypes.c_void_p, MediaLibrary) return f(p_mlib) def libvlc_vlm_release(p_instance): '''Release the vlm instance related to the given L{Instance}. @param p_instance: the instance. ''' f = _Cfunctions.get(‚libvlc_vlm_release‘, None) or \ _Cfunction(‚libvlc_vlm_release‘, ((1,),), None, None, Instance) return f(p_instance) def libvlc_vlm_add_broadcast(p_instance, psz_name, psz_input, psz_output, i_options, ppsz_options, b_enabled, b_loop): '''Add a broadcast, with one input. @param p_instance: the instance. @param psz_name: the name of the new broadcast. @param psz_input: the input MRL. @param psz_output: the output MRL (the parameter to the "sout" variable). @param i_options: number of additional options. @param ppsz_options: additional options. @param b_enabled: boolean for enabling the new broadcast. @param b_loop: Should this broadcast be played in loop ? @return: 0 on success, -1 on error. ''' f = _Cfunctions.get(‚libvlc_vlm_add_broadcast‘, None) or \ _Cfunction(‚libvlc_vlm_add_broadcast‘, ((1,), (1,), (1,), (1,), (1,), ( 1, ), (1,), ( 1, ) , ) , None, ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_int, ListPOINTER(ctypes.c_char_p), ctypes.c_int, ctypes.c_int) return f(p_instance, psz_name, psz_input,psz_output, i_options, ppsz_options, b_enabled, b_loop) def libvlc_vlm_add_vod(p_instance, psz_name, psz_input, i_options, ppsz_options, b_enabled, psz_mux): '''Add a vod, with one input. @param p_instance: the instance. @param psz_name: the name of the new vod media. @param psz_input: the input MRL. @param i_options: number of additional options. @param ppsz_options: additional options. @param b_enabled: boolean for enabling the new vod. @param psz_mux: the muxer of the vod media. @return: 0 on success, -1 on error. ''' f = _Cfunctions.get(‚libvlc_vlm_add_vod‘, None) or \ _Cfunction(‚libvlc_vlm_add_vod‘, ((1,), (1,), (1,), (1,), (1,), (1,), (1,),), None, ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_int, ListPOINTER(ctypes.c_char_p), ctypes.c_int, ctypes.c_char_p) return f(p_instance, psz_name, psz_input,i_options, ppsz_options, b_enabled, psz_mux) def libvlc_vlm_del_media(p_instance, psz_name): '''Delete a media (VOD or broadcast). @param p_instance: the instance. @param psz_name: the media to delete. @return: 0 on success, -1 on error. ''' f = _Cfunctions.get(‚libvlc_vlm_del_media‘, None) or \ _Cfunction(‚libvlc_vlm_del_media‘ , ((1,), (1,),), None, ctypes.c_int, Instance, ctypes.c_char_p) return f(p_instance, psz_name) def libvlc_vlm_set_enabled(p_instance, psz_name, b_enabled): '''Enable or disable a media (VOD or broadcast). @param p_instance: the instance. @param psz_name: the media to work on. @param b_enabled: the new status. @return: 0 on success, -1 on error. ''' f = _Cfunctions.get(‚libvlc_vlm_set_enabled‘, None) or \ _Cfunction(‚libvlc_vlm_set_enabled‘, ((1,), (1,), (1,),), None, ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_int) return f(p_instance, psz_name, b_enabled) def libvlc_vlm_set_output(p_instance, psz_name, psz_output): '''Set the output for a media. @param p_instance: the instance. @param psz_name: the media to work on. @param \psz_output: the output MRL (the parameter to the „sout“ variable). @return: 0 on success, -1 on error. ''' f = _Cfunctions.get(‚libvlc_vlm_set_output‘, None) or \ _Cfunction (' libvlc_vlm_set_output', ((1,), (1,), (1,),), None, ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_char_p) return f(p_instance, psz_name, psz_output) def libvlc_vlm_set_input(p_instance, psz_name, psz_input): '''Set a media's input MRL. This will delete all existing inputs and add the specified one. @param p_instance: the instance. @param psz_name: the media to work on. @param psz_input: the input MRL. @return: 0 on success, -1 on error. ''' f = _Cfunctions.get(‚libvlc_vlm_set_input‘, None) or \ _Cfunction (' libvlc_vlm_set_input', ((1,), (1,), (1,),), None, ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_char_p) return f(p_instance, psz_name, psz_input) def libvlc_vlm_add_input(p_instance, psz_name, psz_input): '''Add a media's input MRL. This will add the specified one. @param p_instance: the instance. @param psz_name: the media to work on. @param psz_input: the input MRL. @return: 0 on success, -1 on error. ''' f = _Cfunctions.get(‚libvlc_vlm_add_input‘, None) or \ _Cfunction (' libvlc_vlm_add_input', ((1,), (1,), (1,),), None, ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_char_p) return f(p_instance, psz_name, psz_input) def libvlc_vlm_set_loop(p_instance, psz_name, b_loop): '''Set a media's loop status. @param p_instance: the instance. @param psz_name: the media to work on. @param b_loop: the new status. @return: 0 on success, -1 on error. ''' f = _Cfunctions.get(‚libvlc_vlm_set_loop‘, None) or \ _Cfunction(‚libvlc_vlm_set_loop‘, ((1,), (1,), (1,),), None, ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_int) return f(p_instance, psz_name, b_loop) def libvlc_vlm_set_mux(p_instance, psz_name, psz_mux): '''Set a media's vod muxer. @param p_instance: the instance. @param psz_name: the media to work on. @param psz_mux: the new muxer. @return: 0 on success, -1 on error. ''' f = _Cfunctions.get(‚libvlc_vlm_set_mux‘, None) or \ _Cfunction (‚libvlc_vlm_set_mux‘, ((1,), (1,), (1,),), None, ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_char_p) return f(p_instance, psz_name, psz_mux) def libvlc_vlm_change_media(p_instance, psz_name, psz_input, psz_output, i_options, ppsz_options, b_enabled, b_loop): '''Edit the parameters of a media. This will delete all existing inputs and add the specified one. @param p_instance: the instance. @param psz_name: the name of the new broadcast. @param psz_input: the input MRL. @param psz_output: the output MRL (the parameter to the „sout“ variable). @param i_options: number of additional options. @param ppsz_options: additional options. @param b_enabled: boolean for enabling the new broadcast. @param b_loop: Should this broadcast be played in loop ? @return: 0 on success, -1 on error. ''' f = _Cfunctions.get(‚libvlc_vlm_change_media‘, None) or \ _Cfunction(‚libvlc_vlm_change_media‘, ((1,), (1,), (1,), (1,), (1,), (1,), (1,), (1,),), None, ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_int, ListPOINTER(ctypes.c_char_p), ctypes.c_int, ctypes.c_int) return f(p_instance, psz_name, psz_input, psz_output, i_options, ppsz_options, b_enabled, b_loop) def libvlc_vlm_play_media(p_instance, psz_name): '''Play the named broadcast. @param p_instance: the instance. @param psz_name: the name of the broadcast. @return: 0 on success, -1 on error. ''' f = _Cfunctions.get(‚libvlc_vlm_play_media‘, None) or \ _Cfunction(‚libvlc_vlm_play_media‘, ((1,), (1,),), None, ctypes.c_int, Instance, ctypes.c_char_p) return f(p_instance, psz_name) def libvlc_vlm_stop_media(p_instance, psz_name): '''Stop the named broadcast. @param p_instance: the instance. @param psz_name: the name of the broadcast. @return: 0 on success, -1 on error. ''' f = _Cfunctions.get(‚libvlc_vlm_stop_media‘, None) or \ _Cfunction(‚libvlc_vlm_stop_media‘, ((1,), (1,),), None, ctypes.c_int, Instance, ctypes.c_char_p) return f(p_instance, psz_name) def libvlc_vlm_pause_media(p_instance, psz_name): '''Pause the named broadcast. @param p_instance: the instance. @param psz_name: the name of the broadcast. @return: 0 on success, -1 on error. ''' f = _Cfunctions.get(‚libvlc_vlm_pause_media‘, None) or \ _Cfunction (' libvlc_vlm_pause_media', ((1,), (1,),), None, ctypes.c_int, Instance, ctypes.c_char_p) return f(p_instance, psz_name) def libvlc_vlm_seek_media(p_instance, psz_name, f_percentage): '''Seek in the named broadcast. @param p_instance: the instance. @param psz_name: the name of the broadcast. @param f_percentage: the percentage to seek to. @return: 0 on success, -1 on error. ''' f = _Cfunctions.get(‚libvlc_vlm_seek_media‘, None) or \ _Cfunction (‚libvlc_vlm_seek_media‘, ((1,), (1,), (1,),), None, ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_float) return f(p_instance, psz_name, f_percentage) def libvlc_vlm_show_media(p_instance, psz_name): '''Return information about the named media as a JSON string representation. This function is mainly intended for debugging use, if you want programmatic access to the state of a vlm_media_instance_t, please use the corresponding libvlc_vlm_get_media_instance_xxx -functions. Currently there are no such functions available for vlm_media_t though. @param p_instance: the instance. @param psz_name: the name of the media, if the name is an empty string, all media is described. @return: string with information about named media, or None on error. ''' f = _Cfunctions.get(‚libvlc_vlm_show_media‘, None) or \ _Cfunction(‚libvlc_vlm_show_media‘, ((1,), (1,),), string_result, ctypes.c_void_p, Instance, ctypes.c_char_p) return f(p_instance, psz_name) def libvlc_vlm_getmedia_instance_position(p_instance, psz_name, i_instance): '''Get vlm_media instance position by name or instance id. @param p_instance: a libvlc instance. @param psz_name: name of vlm media instance. @param i_instance: instance id. @return: position as float or -1. on error. ''' f = _Cfunctions.get(‚libvlc_vlm_get_media_instance_position‘, None) or \ _Cfunction(‚libvlc_vlm_get_media_instance_position‘, ((1,), (1,), (1,),), None, ctypes.c_float, Instance, ctypes.c_char_p, ctypes.c_int) return f(p_instance, psz_name, i_instance) def libvlc_vlm_get_media_instance_time(p_instance, psz_name, i_instance): '''Get vlm_media instance time by name or instance id. @param p_instance: a libvlc instance. @param psz_name: name of vlm media instance. @param i_instance: instance id. @return: time as integer or -1 on error. ''' f = _Cfunctions.get(‚libvlc_vlm_get_media_instance_time‘, None) or \ _Cfunction(‚libvlc_vlm_get media _instance_time‘, ((1,), (1,), (1,),), None, ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_int) return f (p_instance, psz_name, i_instance) def libvlc_vlm_get_media_instance_length(p_instance, psz_name, i_instance): '''Get vlm_media instance length by name or instance id. @param p_instance: a libvlc instance. @param psz_name: name of vlm media instance. @param i_instance: instance id. @return: length of media item or -1 on error. ''' f = _Cfunctions.get(‚libvlc_vlm_get_media_instance_length‘, None) or \ _Cfunction(‚libvlc_vlm_get_media_instance_length‘, ((1,), (1,), (1,),), None, ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_int) return f(p_instance, psz_name, i_instance) def libvlc_vlm_get_media_instance_rate(p_instance, psz_name, i_instance): '''Get vlm_media instance playback rate by name or instance id. @param p_instance: a libvlc instance. @param psz_name: name of vlm media instance. @param i_instance: instance id. @return: playback rate or -1 on error. ''' f = _Cfunctions.get(‚libvlc_vlm_get_media_instance_rate‘, None) or \ _Cfunction(‚libvlc_vlm _get media _instance _rate‘, ((1,), (1,), (1,),), None, ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_int) return f(p_instance, psz_name, i_instance) def libvlc_vlm_get_media_instance_title(p_instance, psz_name, i_instance): '''Get vlm_media instance title number by name or instance id. @param p_instance: a libvlc instance. @param psz_name: name of vlm media instance. @param i_instance: instance id. @return: title as number or -1 on error. @bug: will always return 0. ''' f = _Cfunctions.get(‚libvlc_vlm_get_media_instance_title‘, None) or \ _Cfunction(‚libvlc_vlm_get_media_instance_title‘, ((1,), (1,), (1,),), None, ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_int) return f(p_instance, psz_name, i_instance) def libvlc_vlm_get_media_instance_chapter(p_instance, psz_name, i_instance): '''Get vlm_media instance chapter number by name or instance id. @param p_instance: a libvlc instance. @param psz_name: name of vlm media instance. @param i_instance: instance id. @return: chapter as number or -1 on error. @bug: will always return 0. ''' f = _Cfunctions.get(‚libvlc_vlm_get_media_instance_chapter‘, None) or \ _Cfunction(‚libvlc_vlm_get_media_instance_chapter‘, ((1,), (1,), (1,),), None, ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_int) return f(p_instance, psz_name, i_instance) def libvlc_vlm_get_media_instance_seekable(p_instance, psz_name, i_instance): '''Is libvlc instance seekable ? @param p_instance: a libvlc instance. @param psz_name: name of vlm media instance. @param i_instance: instance id. @return: 1 if seekable, 0 if not, -1 if media does not exist. @bug: will always return 0. ''' f = _Cfunctions.get(‚libvlc_vlm_get_media_instance_seekable‘, None) or \ _Cfunction(‚libvlc_vlm_get_media_instance_seekable‘, ((1,), (1,), (1,),), None, ctypes.c_int, Instance, ctypes.c_char_p, ctypes.c_int) return f(p_instance, psz_name, i_instance) def libvlc _vlm _get _event manager(p_instance): '''Get libvlc_event_manager from a vlm media. The p_event_manager is immutable, so you don't have to hold the lock. @param p_instance: a libvlc instance. @return: libvlc_event_manager. ''' f = _Cfunctions.get(‚libvlc_vlm_get_event_manager‘, None) or \ _Cfunction(‚libvlc_vlm_get_event_manager‘, ((1,),), class_result(EventManager), ctypes.c_void_p, Instance) return f(p_instance) def libvlc_media_new_location(p_instance, psz_mrl): '''Create a media with a certain given media resource location, for instance a valid URL. @note: To refer to a local file with this function, the file://... URI syntax B{must} be used (see IETF RFC3986) . We recommend using L{libvlc_media_new_path}() instead when dealing with local files. See L{libvlc_media _release}. @param p_instance: the instance. @param psz_mrl: the media location. @return: the newly created media or None on error. ''' f = _Cfunctions.get(‚libvlc_media_new_location‘, None) or \ _Cfunction(‚libvlc_media_new_location‘, ((1,), (1,),), class_result(Media), ctypes.c_void_p, Instance, ctypes.c_char_p) return f(p_instance, psz_mrl) def libvlc_media_new_path(p_instance, path): '''Create a media for a certain file path. See L{libvlc_media_release}. @param p_instance: the instance. @param path: local filesystem path. @return: the newly created media or None on error. ''' f = _Cfunctions.get(‚libvlc_media_new_path‘, None) or \ _Cfunction(‚libvlc_media_new_path‘, ((1,), (1,),), class_result(Media), ctypes.c_void_p, Instance, ctypes.c_char_p) return f(p_instance, path) def libvlc_media_new_fd(p_instance, fd): '''Create a media for an already open file descriptor. The file descriptor shall be open for reading (or reading and writing). Regular file descriptors, pipe read descriptors and character device descriptors (including TTYs) are supported on all platforms. Block device descriptors are supported where available. Directory descriptors are supported on systems that provide fdopendir(). Sockets are supported on all platforms where they are file descriptors, i.e. all except Windows. @note: This library will B{not} automatically close the file descriptor under any circumstance. Nevertheless, a file descriptor can usually only be rendered once in a media player. To render it a second time, the file descriptor should probably be rewound to the beginning with lseek(). See L{libvlc_media_release}. @param p_instance: the instance. @param fd: open file descriptor. @return: the newly created media or None on error. @version: LibVLC 1.1.5 and later. ''' f = _Cfunctions.get(‚libvlc_media_new_fd‘, None) or \ _Cfunction(‚libvlc_media_new_fd‘, ((1,), (1,),), class_result(Media), ctypes.c_void_p, Instance, ctypes.c_int) return f(p_instance, fd) def libvlc_media_new_as_node(p_instance, psz_name): '''Create a media as an empty node with a given name. See L{libvlc_media _release}. @param p_instance: the instance. @param psz_name: the name of the node. @return: the new empty media or None on error. ''' f = _Cfunctions.get(‚libvlc_media_new_as_node‘, None) or \ _Cfunction(‚libvlc_media_new_as_node‘, ((1,), (1,),), class_result(Media), ctypes.c_void_p, Instance, ctypes.c_char_p) return f(p_instance, psz_name) def libvlc_media_add_option(p_md, psz_options): '''Add an option to the media. This option will be used to determine how the media_player will read the media. This allows to use VLC's advanced reading/streaming options on a per-media basis. @note: The options are listed in ‚vlc --long-help‘ from the command line, e.g. „-sout-all“. Keep in mind that available options and their semantics vary across LibVLC versions and builds. @warning: Not all options affects L{Media} objects: Specifically, due to architectural issues most audio and video options, such as text renderer options, have no effects on an individual media. These options must be set through L{libvlc_new}() instead. @param p_md: the media descriptor. @param psz_options: the options (as a string). ''' f = _Cfunctions.get(‚libvlc_media_add_option‘, None) or \ _Cfunction(‚libvlc_media_add_option‘, ((1,), (1,),), None, None, Media, ctypes.c_char_p) return f(p_md, psz_options) def libvlc_media_add_option_flag(p_md, psz_options, i_flags): '''Add an option to the media with configurable flags. This option will be used to determine how the media_player will read the media. This allows to use VLC's advanced reading/streaming options on a per-media basis. The options are detailed in vlc --long-help, for instance „--sout-all“. Note that all options are not usable on medias: specifically, due to architectural issues, video-related options such as text renderer options cannot be set on a single media. They must be set on the whole libvlc instance instead. @param p_md: the media descriptor. @param psz_options: the options (as a string). @param i_flags: the flags for this option. ''' f = _Cfunctions.get(‚libvlc_media_add_option_flag‘, None) or \ _Cfunction(‚libvlc_media_add_option_flag‘, ((1,), (1,), (1,),), None, None, Media, ctypes.c_char_p, ctypes.c_uint) return f(p_md, psz_options, i_flags) def libvlc_media_retain(p_md): '''Retain a reference to a media descriptor object (libvlc_media_t). Use L{libvlc_media_release}() to decrement the reference count of a media descriptor object. @param p_md: the media descriptor. ''' f = _Cfunctions.get(‚libvlc_media_retain‘, None) or \ _Cfunction(‚libvlc_media_retain‘, ((1,),), None, None, Media) return f(p_md) def libvlc_media_release(p_md): '''Decrement the reference count of a media descriptor object. If the reference count is 0, then L{libvlc_media _release}() will release the media descriptor object. It will send out an libvlc_MediaFreed event to all listeners. If the media descriptor object has been released it should not be used again. @param p_md: the media descriptor. ''' f = _Cfunctions.get(‚libvlc_media_release‘, None) or \ _Cfunction(‚libvlc_media_release‘, ((1,),), None, None, Media) return f(p_md) def libvlc_media_get_mrl(p_md): '''Get the media resource locator (mrl) from a media descriptor object. @param p_md: a media descriptor object. @return: string with mrl of media descriptor object. ''' f = _Cfunctions.get(‚libvlc_media_get_mrl‘, None) or \ _Cfunction(‚libvlc_media_get_mrl‘, ((1,),), string_result, ctypes.c_void_p, Media) return f(p_md) def libvlc_media_duplicate(p_md): '''Duplicate a media descriptor object. @param p_md: a media descriptor object. ''' f = _Cfunctions.get(‚libvlc_media_duplicate‘, None) or \ _Cfunction(‚libvlc_media_duplicate‘, ((1,),), class_result(Media), ctypes.c_void_p, Media) return f(p_md) def libvlc_media_get_meta(p_md, e_meta): '''Read the meta of the media. If the media has not yet been parsed this will return None. This methods automatically calls L{libvlc_media_parse_async}(), so after calling it you may receive a libvlc_MediaMetaChanged event. If you prefer a synchronous version ensure that you call L{libvlc_media_parse}() before get_meta(). See L{libvlc_media_parse} See L{libvlc_media_parse_async} See libvlc_MediaMetaChanged. @param p_md: the media descriptor. @param e_meta: the meta to read. @return: the media's meta. ''' f = _Cfunctions.get(‚libvlc_media_get_meta‘, None) or \ _Cfunction(‚libvlc_media_get_meta‘, ((1,), (1,),), string_result, ctypes.c_void_p, Media, Meta) return f(p_md, e_meta) def libvlc_media_set_meta(p_md, e_meta, psz_value): '''Set the meta of the media (this function will not save the meta, call L{libvlc_media_save_meta} in order to save the meta). @param p_md: the media descriptor. @param e_meta: the meta to write. @param psz_value: the media's meta. ''' f = _Cfunctions.get(‚libvlc_media_set_meta‘, None) or \ _Cfunction(‚libvlc_media_set_meta‘, ((1,), (1,), (1,),), None, None, Media, Meta, ctypes.c_char_p) return f(p_md, e_meta, psz_value) def libvlc_media_save_meta(p_md): '''Save the meta previously set. @param p_md: the media desriptor. @return: true if the write operation was successful. ''' f = _Cfunctions.get(‚libvlc_media_save_meta‘, None) or \ _Cfunction(‚libvlc_media_save_meta‘, ((1,),), None, ctypes.c_int, Media) return f(p_md) def libvlc_media_get_state(p_md): '''Get current state of media descriptor object. Possible media states are defined in libvlc _structures.c ( libvlc_NothingSpecial=0, libvlc_Opening, libvlc_Buffering, libvlc_Playing, libvlc_Paused, libvlc_Stopped, libvlc_Ended, libvlc_Error). See libvlc_state_t. @param p_md: a media descriptor object. @return: state of media descriptor object. ''' f = _Cfunctions.get(‚libvlc_media_get_state‘, None) or \ _Cfunction(‚libvlc_media_get_state‘, ((1,),), None, State, Media) return f(p_md) def libvlc_media_get_stats(p_md, p_stats): '''Get the current statistics about the media. @param p_md:: media descriptor object. @param p_stats:: structure that contain the statistics about the media (this structure must be allocated by the caller). @return: true if the statistics are available, false otherwise \libvlc_return_bool. ''' f = _Cfunctions.get(‚libvlc_media_get_stats‘, None) or \ _Cfunction(‚libvlc_media_get_stats‘, ((1,), (1,),), None, ctypes.c_int, Media, ctypes.POINTER(MediaStats) ) return f(p_md, p_stats) def libvlc_media_subitems(p_md): '''Get subitems of media descriptor object. This will increment the reference count of supplied media descriptor object. Use L{libvlc_media _list _release}() to decrement the reference counting. @param p_md: media descriptor object. @return: list of media descriptor subitems or None. ''' f = _Cfunctions.get(‚libvlc_media_subitems‘, None) or \ _Cfunction(‚libvlc_media_subitems‘, ((1,),), class_result(MediaList), ctypes.c_void_p, Media) return f(p_md) def libvlc_media_event_manager(p_md): '''Get event manager from media descriptor object. NOTE: this function doesn't increment reference counting. @param p_md: a media descriptor object. @return: event manager object. ''' f = _Cfunctions.get(‚libvlc_media_event_manager‘, None) or \ _Cfunction(‚libvlc_media_event_manager‘, ((1,),), class_result(EventManager), ctypes.c_void_p, Media) return f(p_md) def libvlc_media_get_duration(p_md): '''Get duration (in ms) of media descriptor object item. @param p_md: media descriptor object. @return: duration of media item or -1 on error. ''' f = _Cfunctions.get(‚libvlc_media_get_duration‘, None) or \ _Cfunction(‚libvlc_media_get_duration‘, ((1,),), None, ctypes.c_longlong, Media) return f(p_md) def libvlc_media_parse(p_md): '''Parse a media. This fetches (local) meta data and tracks information. The method is synchronous. See L{libvlc_media_parse_async} See L{libvlc_media_get_meta} See L{libvlc_media_get_tracks_info}. @param p_md: media descriptor object. ''' f = _Cfunctions.get(‚libvlc_media_parse‘, None) or \ _Cfunction(‚libvlc_media_parse‘, ((1,),), None, None, Media) return f(p_md) def libvlc_media_parse_async(p_md): '''Parse a media. This fetches (local) meta data and tracks information. The method is the asynchronous of L{libvlc_media_parse} () . To track when this is over you can listen to libvlc MediaParsedChanged event. However if the media was already parsed you will not receive this event. See L{libvlc_media_parse} See libvlc_MediaParsedChanged See L{libvlc_media_get_meta} See L{libvlc_media_get_tracks_info}. @param p_md: media descriptor object. ''' f = _Cfunctions.get(‚libvlc_media_parse_async‘, None) or \ _Cfunction(‚libvlc_media_parse_async‘, ((1,),), None, None, Media) return f(p_md) def libvlc_media_is_parsed(p_md): '''Get Parsed status for media descriptor object. See libvlc_MediaParsedChanged. @param p_md: media descriptor object. @return: true if media object has been parsed otherwise it returns false \libvlc_return_bool. ''' f = _Cfunctions.get(‚libvlc_media_is_parsed‘, None) or \ _Cfunction(‚libvlc_media_is_parsed‘, ((1,),), None, ctypes.c_int, Media) return f(p_md) def libvlc_media_set_user_data(p_md, p_new_user_data): '''Sets media descriptor's user_data. user_data is specialized data accessed by the host application, VLC.framework uses it as a pointer to an native object that references a L{Media} pointer. @param p_md: media descriptor object. @param p_new_user_data: pointer to user data. ''' f = _Cfunctions.get(‚libvlc_media_set_user_data‘, None) or \ _Cfunction(‚libvlc_media_set_user_data‘, ((1,), (1,),), None, None, Media, ctypes.c_void_p) return f(p_md, p_new_user_data) def libvlc_media_get_user_data(p_md): '''Get media descriptor's user_data. user_data is specialized data accessed by the host application, VLC.framework uses it as a pointer to an native object that references a L{Media} pointer. @param p_md: media descriptor object. ''' f = _Cfunctions.get(‚libvlc_media_get_user_data‘, None) or \ _Cfunction(‚libvlc_media_get_user_data‘, ((1,),), None, ctypes.c_void_p, Media) return f(p_md) def libvlc_media_get_tracks_info(p_md): '''Get media descriptor's elementary streams description Note, you need to call L{libvlc_media_parse}() or play the media at least once before calling this function. Not doing this will result in an empty array. \deprecated Use L{libvlc_media_tracks_get} instead. @param p_md: media descriptor object. @param tracks: address to store an allocated array of Elementary Streams descriptions (must be freed by the caller) [OUT] . @return: the number of Elementary Streams. ''' f = _Cfunctions.get(‚libvlc_media_get_tracks_info‘, None) or \ _Cfunction(‚libvlc_media_get_tracks_info‘ , ((1,), (2,),), None, ctypes.c_int, Media, ctypes.POINTER(ctypes.c_void_p)) return f(p_md) def libvlc_media_tracks_get(p_md, tracks): '''Get media descriptor's elementary streams description Note, you need to call L{libvlc_media_parse}() or play the media at least once before calling this function. Not doing this will result in an empty array. @param p_md: media descriptor object. @param tracks: address to store an allocated array of Elementary Streams descriptions (must be freed with L{libvlc_media_tracks_release}. @return: the number of Elementary Streams (zero on error). @version: LibVLC 2.1.0 and later. ''' f = _Cfunctions.get(‚libvlc_media_tracks_get‘, None) or \ _Cfunction(‚libvlc_media_tracks_get‘, ((1,), (1,),), None, ctypes.c_uint, Media, ctypes.POINTER(ctypes.POINTER(MediaTrack))) return f(p_md, tracks) def libvlc_media_tracks_release(p_tracks, i_count): '''Release media descriptor's elementary streams description array. @param p_tracks: tracks info array to release. @param i_count: number of elements in the array. @version: LibVLC 2.1.0 and later. ''' f = _Cfunctions.get(‚libvlc_media_tracks_release‘, None) or \ _Cfunction(‚libvlc_media_tracks_release‘, ((1,), (1,),), None, None, ctypes.POINTER(MediaTrack), ctypes.c_uint) return f(p_tracks, i_count) def libvlc_media_list_new(p_instance): '''Create an empty media list. @param p_instance: libvlc instance. @return: empty media list, or None on error. ''' f = _Cfunctions.get(‚libvlc_media_list_new‘, None) or \ _Cfunction(‚libvlc_media_list_new‘, ((1,),), class_result(MediaList), ctypes.c_void_p, Instance) return f(p_instance) def libvlc media _list _release(pml): '''Release media list created with L{libvlc_media _list _new}(). @param p_ml: a media list created with L{libvlc_media_list_new}(). ''' f = _Cfunctions.get(‚libvlc_media_list_release‘, None) or \ _Cfunction(‚libvlc_media_list_release‘, ((1,),), None, None, MediaList) return f(p_ml) def libvlc_media_list_retain(p_ml): '''Retain reference to a media list. @param p_ml: a media list created with L{libvlc_media_list_new}(). ''' f = _Cfunctions.get(‚libvlc_media_list_retain‘, None) or \ _Cfunction(‚libvlc_media_list_retain‘, ((1,),), None, None, MediaList) return f(p_ml) def libvlc_media_list_set_media(p_ml, p_md): '''Associate media instance with this media list instance. If another media instance was present it will be released. The L{libvlc_media_list_lock} should NOT be held upon entering this function. @param p_ml: a media list instance. @param p_md: media instance to add. ''' f = _Cfunctions.get(‚libvlc_media_list_set_media‘, None) or \ _Cfunction(‚libvlc_media_list_set_media‘, ((1,), (1,),), None, None, MediaList, Media) return f(p_ml, p_md) def libvlc_media_list_media(p_ml): '''Get media instance from this media list instance. This action will increase the refcount on the media instance. The L{libvlc_media_list_lock} should NOT be held upon entering this function. @param p_ml: a media list instance. @return: media instance. ''' f = _Cfunctions.get(‚libvlc_media_list_media‘, None) or \ _Cfunction(‚libvlc_media_list_media‘, ((1,),), class_result(Media), ctypes.c_void_p, MediaList) return f(p_ml) def libvlc_media_list_add_media(p_ml, p_md): '''Add media instance to media list The L{libvlc_media_list_lock} should be held upon entering this function. @param p_ml: a media list instance. @param p_md: a media instance. @return: 0 on success, -1 if the media list is read-only. ''' f = _Cfunctions.get(‚libvlc_media_list_add_media‘, None) or \ _Cfunction(‚libvlc_media_list_add_media‘, ((1,), (1,),), None, ctypes.c_int, MediaList, Media) return f(p_ml, p_md) def libvlc_media_list_insert_media(p_ml, p_md, i_pos): '''Insert media instance in media list on a position The L{libvlc_media_list_lock} should be held upon entering this function. @param p_ml: a media list instance. @param p_md: a media instance. @param i_pos: position in array where to insert. @return: 0 on success, -1 if the media list is read-only. ''' f = _Cfunctions.get(‚libvlc_media_list_insert_media‘, None) or \ _Cfunction(‚libvlc_media_list_insert_media‘, ((1,), (1,), (1,),), None, ctypes.c_int, MediaList, Media, ctypes.c_int) return f(p_ml, p_md, i_pos) def libvlc_media_list_remove_index(p_ml, i_pos): '''Remove media instance from media list on a position The L{libvlc_media_list_lock} should be held upon entering this function. @param p_ml: a media list instance. @param i_pos: position in array where to insert. @return: 0 on success, -1 if the list is read-only or the item was not found. ''' f = _Cfunctions.get(‚libvlc_media_list_remove_index‘, None) or \ _Cfunction(‚libvlc_media_list_remove_index‘, ((1,), (1,),), None, ctypes.c_int, MediaList, ctypes.c_int) return f(p_ml, i_pos) def libvlc_media_list_count(p_ml): '''Get count on media list items The L{libvlc_media_list_lock} should be held upon entering this function. @param p_ml: a media list instance. @return: number of items in media list. ''' f = _Cfunctions.get(‚libvlc_media_list_count‘, None) or \ _Cfunction(‚libvlc_media_list_count‘, ((1,),), None, ctypes.c_int, MediaList) return f(p_ml) def libvlc_media_list_item_at_index(p_ml, i_pos): '''List media instance in media list at a position The L{libvlc_media_list_lock} should be held upon entering this function. @param p_ml: a media list instance. @param i_pos: position in array where to insert. @return: media instance at position i_pos, or None if not found. In case of success, L{libvlc_media_retain}() is called to increase the refcount on the media. ''' f = _Cfunctions.get(‚libvlcmedia_list_item _at_index‘, None) or \ _Cfunction(‚libvlc_media_list_item_at_index‘, ((1,), (1,),), class_result(Media), ctypes.c_void_p, MediaList, ctypes.c_int) return f(p_ml, i_pos) def libvlc_media_list_index_of_item(p_ml, p_md): '''Find index position of List media instance in media list. Warning: the function will return the first matched position. The L{libvlc_media_list_lock} should be held upon entering this function. @param p_ml: a media list instance. @param p_md: media instance. @return: position of media instance or -1 if media not found. ''' f = _Cfunctions.get(‚libvlc_media_list_index_of_item‘, None) or \ _Cfunction(‚libvlc_media_list_index_of_item‘, ((1,), (1,),), None, ctypes.c_int, MediaList, Media) return f(p_ml, p_md) def libvlc_media_list_is_readonly(p_ml): '''This indicates if this media list is read-only from a user point of view. @param p_ml: media list instance. @return: 1 on readonly, 0 on readwrite \libvlc _return _bool. ''' f = _Cfunctions.get(‚libvlc_media_list_is_readonly‘, None) or \ _Cfunction(‚libvlc_media_list_is_readonly‘, ((1,),), None, ctypes.c_int, MediaList) return f(p_ml) def libvlc_media_list_lock(p_ml): '''Get lock on media list items. @param p_ml: a media list instance. ''' f = _Cfunctions.get(‚libvlc_media_list_lock‘, None) or \ _Cfunction(‚libvlc_media_list_lock‘, ((1,),), None, None, MediaList) return f(p_ml) def libvlc_media_list_unlock(p_ml): '''Release lock on media list items The L{libvlc_media_list_lock} should be held upon entering this function. @param p_ml: a media list instance. ''' f = _Cfunctions.get(‚libvlc_media_list_unlock‘, None) or \ _Cfunction(‚libvlc_media_list_unlock‘, ((1,),), None, None, MediaList) return f(p_ml) def libvlc_media_list_event_manager(p_ml): '''Get libvlc_event_manager from this media list instance. The p_event_manager is immutable, so you don't have to hold the lock. @param p_ml: a media list instance. @return: libvlc_event_manager. ''' f = _Cfunctions.get(‚libvlc_media_list_event_manager‘, None) or \ _Cfunction(‚libvlc_media_list_event_manager‘, ((1,),), class_result(EventManager), ctypes.c_void_p, MediaList) return f(p_ml) def libvlc_playlist_play(p_instance, i_id, i_options, ppsz_options): '''Start playing (if there is any item in the playlist). Additionnal playlist item options can be specified for addition to the item before it is played. @param p_instance: the playlist instance. @param i_id: the item to play. If this is a negative number, the next item will be selected. Otherwise, the item with the given ID will be played. @param i_options: the number of options to add to the item. @param ppsz_options: the options to add to the item. ''' f = _Cfunctions.get(‚libvlc_playlist_play‘, None) or \ _Cfunction (‚libvlc_playlist_play‘, ((1,), (1,), (1,), (1,),), None, None, Instance, ctypes.c_int, ctypes.c_int, ListPOINTER(ctypes.c_char_p)) return f(p_instance, i_id, i_options, ppsz_options) def libvlc_media_player_new(p_libvlc_instance): '''Create an empty Media Player object. @param p_libvlc_instance: the libvlc instance in which the Media Player should be created. @return: a new media player object, or None on error. ''' f = _Cfunctions.get(‚libvlc_media_player_new‘, None) or \ _Cfunction(‚libvlc_media_player_new‘, ((1,),), class_result(MediaPlayer), ctypes.c_void_p, Instance) return f(p_libvlc_instance) def libvlc_media_player_new_from_media(p_md): '''Create a Media Player object from a Media. @param p_md: the media. Afterwards the p_md can be safely destroyed. @return: a new media player object, or None on error. ''' f = _Cfunctions.get(‚libvlc_media_player_new_from_media‘, None) or \ _Cfunction(‚libvlc_media_player_new_from_media‘, ((1,),), class_result(MediaPlayer), ctypes.c_void_p, Media) return f(p_md) def libvlc_media_player_release(p_mi): '''Release a media_player after use Decrement the reference count of a media player object. If the reference count is 0, then L{libvlc_media_player_release}() will release the media player object. If the media player object has been released, then it should not be used again. @param p_mi: the Media Player to free. ''' f = _Cfunctions.get(‚libvlc_media_player_release‘, None) or \ _Cfunction(‚libvlc_media_player_release‘, ((1,),), None, None, MediaPlayer) return f(p_mi) def libvlc_media_player_retain(p_mi): '''Retain a reference to a media player object. Use L{libvlc_media_player_release}() to decrement reference count. @param p_mi: media player object. ''' f = _Cfunctions.get(‚libvlc_media_player_retain‘, None) or \ _Cfunction(‚libvlc_media_player_retain‘, ((1,),), None, None, MediaPlayer) return f(p_mi) def libvlc_media_player_set_media(p_mi, p_md): '''Set the media that will be used by the media_player. If any, previous md will be released. @param p_mi: the Media Player. @param p_md: the Media. Afterwards the p_md can be safely destroyed. ''' f = _Cfunctions.get(‚libvlc_media_player_set_media‘, None) or \ _Cfunction(‚libvlc_media_player_set_media‘, ((1,), (1,),), None, None, MediaPlayer, Media) return f(p_mi, p_md) def libvlc_media_player_get_media(p_mi): '''Get the media used by the media_player. @param p_mi: the Media Player. @return: the media associated with p_mi, or None if no media is associated. ''' f = _Cfunctions.get(‚libvlc_media_player_get_media‘, None) or \ _Cfunction(‚libvlc_media_player_get_media‘, ((1,),), class_result(Media), ctypes.c_void_p, MediaPlayer) return f(p_mi) def libvlc_media_player_event_manager(p_mi): '''Get the Event Manager from which the media player send event. @param p_mi: the Media Player. @return: the event manager associated with p_mi. ''' f = _Cfunctions.get(‚libvlc_media_player_event_manager‘, None) or \ _Cfunction(‚libvlc_media_player_event_manager‘, ((1,),), class_result(EventManager), ctypes.c_void_p, MediaPlayer) return f(p mi) def libvlc_media_player_is_playing(p_mi): '''is_playing. @param p_mi: the Media Player. @return: 1 if the media player is playing, 0 otherwise \libvlc_return_bool. ''' f = _Cfunctions.get(‚libvlc_media_player_is_playing‘, None) or \ _Cfunction(‚libvlc_media_player_is_playing‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p_mi) def libvlc_media_player_play(p_mi): '''Play. @param p_mi: the Media Player. @return: 0 if playback started (and was already started), or -1 on error. ''' f = _Cfunctions.get(‚libvlc_media_player_play‘, None) or \ _Cfunction(‚libvlc_media_player_play‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p_mi) def libvlc_media_player_set_pause(mp, do_pause): '''Pause or resume (no effect if there is no media). @param mp: the Media Player. @param do_pause: play/resume if zero, pause if non-zero. @version: LibVLC 1.1.1 or later. ''' f = _Cfunctions.get(‚libvlc_media_player_set_pause‘, None) or \ Cfunction(‚libvlc media player set pause‘, ((1,), (1,),), None, None, MediaPlayer, ctypes.c_int) return f(mp, do_pause) def libvlc_media_player_pause(p_mi): '''Toggle pause (no effect if there is no media). @param p_mi: the Media Player. ''' f = _Cfunctions.get(‚libvlc_media_player_pause‘, None) or \ _Cfunction(‚libvlc_media_player_pause‘, ((1,),), None, None, MediaPlayer) return f(p_mi) def libvlc_media_player_stop(p_mi): '''Stop (no effect if there is no media). @param p_mi: the Media Player. ''' f = _Cfunctions.get(‚libvlc_media_player_stop‘, None) or \ _Cfunction(‚libvlc_media_player_stop‘, ((1,),), None, None, MediaPlayer) return f(p_mi) def libvlc_video_set_callbacks(mp, lock, unlock, display, opaque): '''Set callbacks and private data to render decoded video to a custom area in memory. Use L{libvlc_video_set_format}() or L{libvlc _video _set _format _callbacks}() to configure the decoded format. @param mp: the media player. @param lock: callback to lock video memory (must not be None). @param unlock: callback to unlock video memory (or None if not needed). @param display: callback to display video (or None if not needed). @param opaque: private pointer for the three callbacks (as first parameter). @version: LibVLC 1.1.1 or later. ''' f = _Cfunctions.get(‚libvlc_video_set_callbacks‘, None) or \ _Cfunction(‚libvlc_video_set_callbacks‘, ((1,), (1,), (1,), (1,), (1,),), None, None, MediaPlayer, VideoLockCb, VideoUnlockCb, VideoDisplayCb, ctypes.c_void_p) return f(mp, lock, unlock, display, opaque) def libvlc_video_set_format(mp, chroma, width, height, pitch): '''Set decoded video chroma and dimensions. This only works in combination with L{libvlc_video_set_callbacks}(), and is mutually exclusive with L{libvlc _video _set _format _callbacks}(). @param mp: the media player. @param chroma: a four-characters string identifying the chroma (e.g. „RV32“ or „YUYV“). @param width: pixel width. @param height: pixel height. @param pitch: line pitch (in bytes). @version: LibVLC 1.1.1 or later. @bug: All pixel planes are expected to have the same pitch. To use the YCbCr color space with chrominance subsampling, consider using L{libvlc_video_set_format_callbacks}() instead. ''' f = _Cfunctions.get(‚libvlc_video_set_format‘, None) or \ _Cfunction(‚libvlc_video_set_format‘, ((1,), (1,), (1,), (1,), (1,),), None, None, MediaPlayer, ctypes.c_char_p, ctypes.c_uint, ctypes.c_uint, ctypes.c_uint) return f(mp, chroma, width, height, pitch) def libvlc_video_set_format_callbacks(mp, setup, cleanup): '''Set decoded video chroma and dimensions. This only works in combination with L{libvlc _video _set _callbacks} () . @param mp: the media player. @param setup: callback to select the video format (cannot be None). @param cleanup: callback to release any allocated resources (or None). @version: LibVLC 2.0.0 or later. ''' f = _Cfunctions.get(‚libvlc_video_set_format_callbacks‘, None) or \ _Cfunction(‚libvlc _video _set _format _callbacks‘, ((1,), (1,), (1,),), None, None, MediaPlayer, VideoFormatCb, VideoCleanupCb) return f(mp, setup, cleanup) def libvlc_media_player_set_nsobject(p_mi, drawable): '''Set the NSView handler where the media player should render its video output. Use the vout called „macosx“. The drawable is an NSObject that follow the VLCOpenGLVideoViewEmbedding protocol: @begincode \@protocol VLCOpenGLVideoViewEmbedding <NSObject> - (void)addVoutSubview: (NSView *)view; - (void)removeVoutSubview:(NSView *)view; \@end @endcode Or it can be an NSView object. If you want to use it along with Qt4 see the QMacCocoaViewContainer. Then the following code should work: @begincode NSView *video = [[NSView alloc] init]; QMacCocoaViewContainer *container = new QMacCocoaViewContainer(video, parent); L{libvlc_media_player_set_nsobject}(mp, video); [video release]; @endcode You can find a live example in VLCVideoView in VLCKit.framework. @param p_mi: the Media Player. @param drawable: the drawable that is either an NSView or an object following the VLCOpenGLVideoViewEmbedding protocol. ''' f = _Cfunctions.get(‚libvlc_media_player_set_nsobject‘, None) or \ _Cfunction(‚libvlc_media_player_set_nsobject‘ , ((1,), (1,),), None, None, MediaPlayer, ctypes.c_void_p) return f(p_mi, drawable) def libvlc_media_player_get_nsobject(p_mi): '''Get the NSView handler previously set with L{libvlc_media_player_set_nsobject} () . @param p_mi: the Media Player. @return: the NSView handler or 0 if none where set. ''' f = _Cfunctions.get(‚libvlc_media_player_get_nsobject‘, None) or \ _Cfunction(‚libvlc_media_player_get_nsobject‘, ((1,),), None, ctypes.c_void_p, MediaPlayer) return f(p_mi) def libvlc_media_player_set_agl(p_mi, drawable): '''Set the agl handler where the media player should render its video output. @param p_mi: the Media Player. @param drawable: the agl handler. ''' f = _Cfunctions.get(‚libvlc_media_player_set_agl‘, None) or \ _Cfunction(‚libvlc_media_player_set_agl‘, ((1,), (1,),), None, None, MediaPlayer, ctypes.c_uint32) return f(p_mi, drawable) def libvlc_media_player_get_agl(p_mi): '''Get the agl handler previously set with L{libvlc_media_player_set_agl}(). @param p_mi: the Media Player. @return: the agl handler or 0 if none where set. ''' f = _Cfunctions.get(‚libvlc_media_player_get_agl‘, None) or \ _Cfunction(‚libvlc_media_player_get_agl‘, ((1,),), None, ctypes.c_uint32, MediaPlayer) return f(p_mi) def libvlc_media_player_set_xwindow(p_mi, drawable): '''Set an X Window System drawable where the media player should render its video output. If LibVLC was built without X11 output support, then this has no effects. The specified identifier must correspond to an existing Input/Output class X11 window. Pixmaps are B{not} supported. The caller shall ensure that the X11 server is the same as the one the VLC instance has been configured with. This function must be called before video playback is started; otherwise it will only take effect after playback stop and restart. @param p_mi: the Media Player. @param drawable: the ID of the X window. ''' f = _Cfunctions.get(‚libvlc_media_player_set_xwindow‘, None) or \ _Cfunction(‚libvlc_media_player_set_xwindow‘, ((1,), (1,),), None, None, MediaPlayer, ctypes.c_uint32) return f(p_mi, drawable) def libvlc_media_player_get_xwindow(p_mi): '''Get the X Window System window identifier previously set with L{libvlc_media_player_set_xwindow}(). Note that this will return the identifier even if VLC is not currently using it (for instance if it is playing an audio-only input). @param p_mi: the Media Player. @return: an X window ID, or 0 if none where set. ''' f = _Cfunctions.get(‚libvlc_media_player_get_xwindow‘, None) or \ _Cfunction(‚libvlc_media _player _get _xwindow‘, ((1,),), None, ctypes.c_uint32, MediaPlayer) return f(p_mi) def libvlc_media_player_set_hwnd(p_mi, drawable): '''Set a Win32/Win64 API window handle (HWND) where the media player should render its video output. If LibVLC was built without Win32/Win64 API output support, then this has no effects. @param p_mi: the Media Player. @param drawable: windows handle of the drawable. ''' f = _Cfunctions.get(‚libvlc_media_player_set_hwnd‘, None) or \ _Cfunction(‚libvlc_media_player_set_hwnd‘, ((1,), (1,),), None, None, MediaPlayer, ctypes.c_void_p) return f(p_mi, drawable) def libvlc_media_player_get_hwnd(p_mi): '''Get the Windows API window handle (HWND) previously set with L{libvlc_media_player_set_hwnd}(). The handle will be returned even if LibVLC is not currently outputting any video to it. @param p_mi: the Media Player. @return: a window handle or None if there are none. ''' f = _Cfunctions.get(‚libvlc_media_player_get_hwnd‘, None) or \ _Cfunction(‚libvlc_media_player_get_hwnd‘, ((1,),), None, ctypes.c_void_p, MediaPlayer) return f(p mi) def libvlc_audio_set_callbacks(mp, play, pause, resume, flush, drain, opaque): '''Set callbacks and private data for decoded audio. Use L{libvlc_audio_set_format}() or L{libvlc_audio_set_format_callbacks}() to configure the decoded audio format. @param mp: the media player. @param play: callback to play audio samples (must not be None). @param pause: callback to pause playback (or None to ignore). @param resume: callback to resume playback (or None to ignore). @param flush: callback to flush audio buffers (or None to ignore). @param drain: callback to drain audio buffers (or None to ignore). @param opaque: private pointer for the audio callbacks (as first parameter). @version: LibVLC 2.0.0 or later. ''' f = _Cfunctions.get(‚libvlc_audio_set_callbacks‘, None) or \ _Cfunction(‚libvlc_audio_set_callbacks‘, ((1,), (1,), (1,), (1,), (1,), (1,), (1,),), None, None, MediaPlayer, AudioPlayCb, AudioPauseCb, AudioResumeCb, AudioFlushCb, AudioDrainCb, ctypes.c_void_p) return f(mp, play, pause, resume, flush, drain, opaque) def libvlc audio set volume callback(mp, set_volume): '''Set callbacks and private data for decoded audio. This only works in combination with L{libvlc_audio_set_callbacks}(). Use L{libvlc_audio_set_format}() or L{libvlc_audio_set_format_callbacks}() to configure the decoded audio format. @param mp: the media player. @param set_volume: callback to apply audio volume, or None to apply volume in software. @version: LibVLC 2.0.0 or later. ''' f = _Cfunctions.get(‚libvlc_audio_set_volume_callback‘, None) or \ _Cfunction(‚libvlc_audio_set_volume_callback‘ , ((1,), (1,),), None, None, MediaPlayer, AudioSetVolumeCb) return f(mp, set_volume) def libvlc_audio_set_format_callbacks(mp, setup, cleanup): '''Set decoded audio format. This only works in combination with L{libvlc _audio _set _callbacks}(). @param mp: the media player. @param setup: callback to select the audio format (cannot be None). @param cleanup: callback to release any allocated resources (or None). @version: LibVLC 2.0.0 or later. ''' f = _Cfunctions.get(‚libvlc_audio_set_format_callbacks‘, None) or \ _Cfunction(‚libvlc_audio_set_format_callbacks‘, ((1,), (1,), (1,),), None, None, MediaPlayer, AudioSetupCb, AudioCleanupCb) return f(mp, setup, cleanup) def libvlc_audio_set_format(mp, format, rate, channels): '''Set decoded audio format. This only works in combination with L{libvlc_audio_set_callbacks}(), and is mutually exclusive with L{libvlc_audio_set_format_callbacks}(). @param mp: the media player. @param format: a four-characters string identifying the sample format (e.g. „S16N“ or „FL32“). @param rate: sample rate (expressed in Hz). @param channels: channels count. @version: LibVLC 2.0.0 or later. ''' f = _Cfunctions.get(‚libvlc_audio_set_format‘, None) or \ _Cfunction (‚libvlc_audio_set_format‘, ((1,), (1,), (1,), (1,),), None, None, MediaPlayer, ctypes.c_char_p, ctypes.c_uint, ctypes.c_uint) return f(mp, format, rate, channels) def libvlc _media _player _get _length(pmi): '''Get the current movie length (in ms). @param p_mi: the Media Player. @return: the movie length (in ms), or -1 if there is no media. ''' f = _Cfunctions.get(‚libvlc_media_player_get_length‘, None) or \ _Cfunction(‚libvlc_media_player_get_length‘, ((1,),), None, ctypes.c_longlong, MediaPlayer) return f(p_mi) def libvlc_media_player_get_time(p_mi): '''Get the current movie time (in ms). @param p_mi: the Media Player. @return: the movie time (in ms), or -1 if there is no media. ''' f = _Cfunctions.get(‚libvlc_media_player_get_time‘, None) or \ _Cfunction(‚libvlc_media_player_get_time‘, ((1,),), None, ctypes.c_longlong, MediaPlayer) return f(p_mi) def libvlc_media_player_set_time(p_mi, i_time): '''Set the movie time (in ms). This has no effect if no media is being played. Not all formats and protocols support this. @param p_mi: the Media Player. @param i_time: the movie time (in ms). ''' f = _Cfunctions.get(‚libvlc_media_player_set_time‘, None) or \ _Cfunction(‚libvlc_media_player_set_time‘, ((1,), (1,),), None, None, MediaPlayer, ctypes.c_longlong) return f(p_mi, i_time) def libvlc_media_player_get_position(p_mi): '''Get movie position as percentage between 0.0 and 1.0. @param p_mi: the Media Player. @return: movie position, or -1. in case of error. ''' f = _Cfunctions.get(‚libvlc_media_player_get_position‘, None) or \ _Cfunction(‚libvlc_media_player_get_position‘, ((1,) ,), None, ctypes.c_float, MediaPlayer) return f(p_mi) def libvlc_media_player_set_position(p_mi, f_pos): '''Set movie position as percentage between 0.0 and 1.0. This has no effect if playback is not enabled. This might not work depending on the underlying input format and protocol. @param p_mi: the Media Player. @param f_pos: the position. ''' f = _Cfunctions.get(‚libvlc_media_player_set_position‘, None) or \ _Cfunction(‚libvlc_media_player_set_position‘, ((1,), (1,),), None, None, MediaPlayer, ctypes.c_float) return f(p_mi, f_pos) def libvlc_media_player_set_chapter(p_mi, i_chapter): '''Set movie chapter (if applicable). @param p_mi: the Media Player. @param i_chapter: chapter number to play. ''' f = _Cfunctions.get(‚libvlc_media_player_set_chapter‘, None) or \ _Cfunction(‚libvlc_media_player_set_chapter‘, ((1,), (1,),), None, None, MediaPlayer, ctypes.c_int) return f(p_mi, i_chapter) def libvlc_media_player_get_chapter(p_mi): '''Get movie chapter. @param p_mi: the Media Player. @return: chapter number currently playing, or -1 if there is no media. ''' f = _Cfunctions.get(‚libvlc_media_player_get_chapter‘, None) or \ _Cfunction(‚libvlc_media_player_get_chapter‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p_mi) def libvlc_media_player_get_chapter_count(p_mi): '''Get movie chapter count. @param p_mi: the Media Player. @return: number of chapters in movie, or -1. ''' f = _Cfunctions.get(‚libvlc_media_player_get_chapter_count‘, None) or \ _Cfunction(‚libvlc_media_player_get_chapter_count‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p_mi) def libvlc_media_player_will_play(p_mi): '''Is the player able to play. @param p_mi: the Media Player. @return: boolean \libvlc _return _bool. ''' f = _Cfunctions.get(‚libvlc_media_player_will_play‘, None) or \ _Cfunction(‚libvlc_media_player_will_play‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p_mi) def libvlc_media_player_get_chapter_count_for_title(p_mi, i_title): '''Get title chapter count. @param p_mi: the Media Player. @param i_title: title. @return: number of chapters in title, or -1. ''' f = _Cfunctions.get(‚libvlc_media_player_get_chapter_count_for_ti tle‘, None) or \ _Cfunction(‚libvlc_media_player_get_chapter_count_for-title‘, ((1,), (1,),), None, ctypes.c_int, MediaPlayer, ctypes.c_int) return f(p_mi, i_title) def libvlc_media_player_set_title(p_mi, i_title): '''Set movie title. @param p_mi: the Media Player. @param i_title: title number to play. ''' f = _Cfunctions.get(‚libvlc_media_player_set_title‘, None) or \ _Cfunction(‚libvlc_media_player_set_title‘, ((1,), (1,),), None, None, MediaPlayer, ctypes.c_int) return f(p_mi, i_title) def libvlc_media_player_get_title(p_mi): '''Get movie title. @param p_mi: the Media Player. @return: title number currently playing, or -1. ''' f = _Cfunctions.get(‚libvlc_media_player_get_title‘, None) or \ _Cfunction(‚libvlc_media_player_get_title‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p_mi) def libvlc_media_player_get_title_count(p_mi): '''Get movie title count. @param p_mi: the Media Player. @return: title number count, or -1. ''' f = _Cfunctions.get(‚libvlc_media_player_get_title_count‘, None) or \ _Cfunction(‚libvlc_media_player_get_title_count‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p_mi) def libvlc_media_player_previous_chapter(p_mi): '''Set previous chapter (if applicable). @param p_mi: the Media Player. ''' f = _Cfunctions.get(‚libvlc_media_player_previous_chapter‘ None) or \ _Cfunction(‚libvlc_media_player_previous_chapter‘, ((1,),), None, None, MediaPlayer) return f(p_mi) def libvlc_media_player_next_chapter(p_mi): '''Set next chapter (if applicable). @param p_mi: the Media Player. ''' f = _Cfunctions.get(‚libvlc_media_player_next_chapter‘, None) or \ _Cfunction(‚libvlc_media_player_next_chapter‘,, ((1,),), None, None, MediaPlayer) return f(p_mi) def libvlc_media_player_get_rate(p_mi): '''Get the requested movie play rate. @warning: Depending on the underlying media, the requested rate may be different from the real playback rate. @param p_mi: the Media Player. @return: movie play rate. ''' f = _Cfunctions.get(‚libvlc_media_player_get_rate‘, None) or \ _Cfunction(‚libvlc_media_player_get_rate‘, ( (1,),), None, ctypes.c_float, MediaPlayer) return f(p_mi) def libvlc_media_player_set_rate(p_mi, rate): '''Set movie play rate. @param p_mi: the Media Player. @param rate: movie play rate to set. @return: -1 if an error was detected, 0 otherwise (but even then, it might not actually work depending on the underlying media protocol). ''' f = _Cfunctions.get(‚libvlc_media_player_set_rate‘, None) or \ _Cfunction(‚libvlc_media_player_set_rate‘, ((1,), (1,),), None, ctypes.c_int, MediaPlayer, ctypes.c_float) return f(p_mi, rate) def libvlc_media_player_get_state(p_mi): '''Get current movie state. @param p_mi: the Media Player. @return: the current state of the media player (playing, paused, ...) See libvlc_state_t. ''' f = _Cfunctions.get(‚libvlc_media_player_get_state‘, None) or \ _Cfunction(‚libvlc_media_player_get_state‘, ((1,),), None, State, MediaPlayer) return f(p_mi) def libvlc_media_player_get_fps(p_mi): '''Get movie fps rate. @param p_mi: the Media Player. @return: frames per second (fps) for this playing movie, or 0 if unspecified. ''' f = _Cfunctions.get(‚libvlc_media_player_get_fps‘, None) or \ _Cfunction(‚libvlc_media_player_get_fps‘, ((1,),), None, ctypes.c_float, MediaPlayer) return f(p_mi) def libvlc_media_player_has_vout(p_mi): '''How many video outputs does this media player have? @param p_mi: the media player. @return: the number of video outputs. ''' f = _Cfunctions.get(‚libvlc_media_player_has_vout‘, None) or \ _Cfunction(‚libvlc_media_player_has_vout‘, ((1,),), None, ctypes.c_uint, MediaPlayer) return f(p_mi) def libvlc_media_player_is_seekable(p_mi): '''Is this media player seekable? @param p_mi: the media player. @return: true if the media player can seek \libvlc_return_bool. ''' f = _Cfunctions.get(‚libvlc_media_player_is_seekable‘, None) or \ _Cfunction(‚libvlc_media_player_is_seekable‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p_mi) def libvlc_media_player_can_pause(p_mi): '''Can this media player be paused? @param p_mi: the media player. @return: true if the media player can pause \libvlc _return _bool. ''' f = _Cfunctions.get(‚libvlc_media_player_can_pause‘, None) or \ _Cfunction(‚libvlc_media_player_can_pause‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p_mi) def libvlc media _player _program _scrambled(pmi): '''Check if the current program is scrambled. @param p_mi: the media player. @return: true if the current program is scrambled \libvlc_return_bool. @version: LibVLC 2.2.0 or later. ''' f = _Cfunctions.get(‚libvlc_media_player_program_scrambled‘, None) or \ _Cfunction(‚libvlc_media_player_program_scrambled‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p_mi) def libvlc_media_player_next_frame(p_mi): '''Display the next frame (if supported). @param p_mi: the media player. ''' f = _Cfunctions.get(‚libvlc_media_player_next_frame‘, None) or \ _Cfunction(‚libvlc_media_player_next_frame‘, ((1,),), None, None, MediaPlayer) return f(p_mi) def libvlc_media_player_navigate(p_mi, navigate): '''Navigate through DVD Menu. @param p_mi: the Media Player. @param navigate: the Navigation mode. @version: libVLC 2.0.0 or later. ''' f = _Cfunctions.get(‚libvlc_media_player_navigate‘, None) or \ _Cfunction(‚libvlc_media_player_navigate‘, ((1,), (1,),), None, None, MediaPlayer, ctypes.c_uint) return f(p_mi, navigate) def libvlc_media_player_set_video_title_display(p_mi, position, timeout): '''Set if, and how, the video title will be shown when media is played. @param p_mi: the media player. @param position: position at which to display the title, or libvlc_position_disable to prevent the title from being displayed. @param timeout: title display timeout in milliseconds (ignored if libvlc_position_disable). @version: libVLC 2.1.0 or later. ''' f = _Cfunctions.get(‚libvlc_media_player_set_video_title_display‘ , None) or \ _Cfunction(‚libvlc_media_player_set_video_title_display‘, ((1,), (1,), (1,),), None, None, MediaPlayer, Position, ctypes.c_int) return f(p_mi, position, timeout) def libvlc_track_description_list_release(p_track_description): '''Release (free) L{TrackDescription}. @param p_track_description: the structure to release. ''' f = _Cfunctions.get(‚libvlc_track_description_list_release‘, None) or \ _Cfunction(‚libvlc_track_description_list_release‘, ((1,),), None, None, ctypes.POINTER(TrackDescription)) return f(p_track_description) def libvlc_track_description_release(p_track_description): '''\deprecated Use L{libvlc_track_description_list_release} instead. ''' f = _Cfunctions.get(‚libvlc_track_description_release‘, None) or \ _Cfunction(‚libvlc_track_description_release‘, ((1,),), None, None, ctypes.POINTER(TrackDescription)) return f(p_track_description) def libvlc_toggle_fullscreen(p_mi): '''Toggle fullscreen status on non-embedded video outputs. @warning: The same limitations applies to this function as to L{libvlc_set_fullscreen} (). @param p_mi: the media player. ''' f = _Cfunctions.get(‚libvlc_toggle_fullscreen‘, None) or \ _Cfunction(‚libvlc_toggle_fullscreen‘, ((1,),), None, None, MediaPlayer) return f(p mi) def libvlc_set_fullscreen(p_mi, b_fullscreen): '''Enable or disable fullscreen. @warning: With most window managers, only a top-level windows can be in full-screen mode. Hence, this function will not operate properly if L{libvlc_media_player_set_xwindow} () was used to embed the video in a non-top-level window. In that case, the embedding window must be reparented to the root window B{before} fullscreen mode is enabled. You will want to reparent it back to its normal parent when disabling fullscreen. @param p_mi: the media player. @param b_fullscreen: boolean for fullscreen status. ''' f = _Cfunctions.get(‚libvlc_set_fullscreen‘, None) or \ _Cfunction(‚libvlc_set_fullscreen‘, ((1,), (1,),), None, None, MediaPlayer, ctypes.c_int) return f(p_mi, b_fullscreen) def libvlc_get_fullscreen(p_mi): '''Get current fullscreen status. @param p_mi: the media player. @return: the fullscreen status (boolean) \libvlc _return _bool. ''' f = _Cfunctions.get(‚libvlc_get_fullscreen‘, None) or \ _Cfunction(‚libvlc_get_fullscreen‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p_mi) def libvlc_video_set_key_input(p_mi, on): '''Enable or disable key press events handling, according to the LibVLC hotkeys configuration. By default and for historical reasons, keyboard events are handled by the LibVLC video widget. @note: On X11, there can be only one subscriber for key press and mouse click events per window. If your application has subscribed to those events for the X window ID of the video widget, then LibVLC will not be able to handle key presses and mouse clicks in any case. @warning: This function is only implemented for X11 and Win32 at the moment. @param p_mi: the media player. @param on: true to handle key press events, false to ignore them. ''' f = _Cfunctions.get(‚libvlc_video_set_key_input‘, None) or \ _Cfunction(‚libvlc_video_set_key_input‘, ((1,), (1,),), None, None, MediaPlayer, ctypes.c_uint) return f(p_mi, on) def libvlc _video _set mouse _input(p_mi, on): '''Enable or disable mouse click events handling. By default, those events are handled. This is needed for DVD menus to work, as well as a few video filters such as „puzzle“. See L{libvlc_video_set_key_input}(). @warning: This function is only implemented for X11 and Win32 at the moment. @param p_mi: the media player. @param on: true to handle mouse click events, false to ignore them. ''' f = _Cfunctions.get(‚libvlc_video_set_mouse_input‘, None) or \ _Cfunction(‚libvlc_video_set_mouse_input‘, ((1,), (1,),), None, None, MediaPlayer, ctypes.c_uint) return f(p_mi, on) def libvlc_video_get_size(p_mi, num): '''Get the pixel dimensions of a video. @param p_mi: media player. @param num: number of the video (starting from, and most commonly 0). @return: px pixel width, py pixel height. ''' f = _Cfunctions.get(‚libvlc_video_get_size‘, None) or \ _Cfunction(‚libvlc_video_get_size‘, ((1,), (1,), (2,), (2,),), None, ctypes.c_int, MediaPlayer, ctypes.c_uint, ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint)) return f(p_mi, num) def libvlc_video_get_height(p_mi): '''Get current video height. \deprecated Use L{libvlc_video_get_size} () instead. @param p_mi: the media player. @return: the video pixel height or 0 if not applicable. ''' f = _Cfunctions.get(‚libvlc_video_get_height‘, None) or \ _Cfunction(‚libvlc_video_get_height‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p_mi) def libvlc_video_get_width(p_mi): '''Get current video width. \deprecated Use L{libvlc_video_get_size}() instead. @param p_mi: the media player. @return: the video pixel width or 0 if not applicable. ''' f = _Cfunctions.get(‚libvlc_video_get_width‘, None) or \ _Cfunction(‚libvlc_video_get_width‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p_mi) def libvlc_video_get_cursor(p_mi, num): '''Get the mouse pointer coordinates over a video. Coordinates are expressed in terms of the decoded video resolution, B{not} in terms of pixels on the screen/viewport (to get the latter, you can query your windowing system directly). Either of the coordinates may be negative or larger than the corresponding dimension of the video, if the cursor is outside the rendering area. @warning: The coordinates may be out-of-date if the pointer is not located on the video rendering area. LibVLC does not track the pointer if it is outside of the video widget. @note: LibVLC does not support multiple pointers (it does of course support multiple input devices sharing the same pointer) at the moment. @param p_mi: media player. @param num: number of the video (starting from, and most commonly 0). @return: px abscissa, py ordinate. ''' f = _Cfunctions.get(‚libvlc_video_get_cursor‘, None) or \ _Cfunction(‚libvlc_video_get_cursor‘, ((1,), (1,), (2,), (2,),), None, ctypes.c_int, MediaPlayer, ctypes.c_uint, ctypes.POINTER(ctypes.c_int), ctypes.POINTER(ctypes.c_int)) return f(p_mi, num) def libvlc_video_get_scale(p_mi): '''Get the current video scaling factor. See also L{libvlc_video_set_scale}(). @param p_mi: the media player. @return: the currently configured zoom factor, or 0. if the video is set to fit to the output window/drawable automatically. ''' f = _Cfunctions.get(‚libvlc_video_get_scale‘, None) or \ _Cfunction(‚libvlc_video_get_scale‘, ((1,),), None, ctypes.c_float, MediaPlayer) return f(p_mi) def libvlc_video_set_scale(p_mi, f_factor): '''Set the video scaling factor. That is the ratio of the number of pixels on screen to the number of pixels in the original decoded video in each dimension. Zero is a special value; it will adjust the video to the output window/drawable (in windowed mode) or the entire screen. Note that not all video outputs support scaling. @param p_mi: the media player. @param f_factor: the scaling factor, or zero. ''' f = _Cfunctions.get(‚libvlc_video_set_scale‘, None) or \ _Cfunction(‚libvlc_video_set_scale‘, ((1,), (1,),), None, None, MediaPlayer, ctypes.c_float) return f(p_mi, f_factor) def libvlc_video_get_aspect_ratio(p_mi): '''Get current video aspect ratio. @param p_mi: the media player. @return: the video aspect ratio or None if unspecified (the result must be released with free() or L{libvlc_free}()). ''' f = _Cfunctions.get(‚libvlc_video_get_aspect_ratio‘, None) or \ _Cfunction(‚libvlc_video_get_aspect_ratio‘, ((1,),), string_result, ctypes.c_void_p, MediaPlayer) return f(p_mi) def libvlc_video_set_aspect_ratio(p_mi, psz_aspect): '''Set new video aspect ratio. @param p_mi: the media player. @param psz_aspect: new video aspect-ratio or None to reset to default @note Invalid aspect ratios are ignored. ''' f = _Cfunctions.get(‚libvlc_video_set_aspect_ratio‘, None) or \ _Cfunction(‚libvlc_video_set_aspect_ratio‘, ((1,), (1,),), None, None, MediaPlayer, ctypes.c_char_p) return f(p_mi, psz_aspect) def libvlc_video_get_spu(p_mi): '''Get current video subtitle. @param p_mi: the media player. @return: the video subtitle selected, or -1 if none. ''' f = _Cfunctions.get(‚libvlc_video_get_spu‘, None) or \ _Cfunction(‚libvlc_video_get_spu‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p_mi) def libvlc_video_get_spu_count(p_mi): '''Get the number of available video subtitles. @param p_mi: the media player. @return: the number of available video subtitles. ''' f = _Cfunctions.get(‚libvlc_video_get_spu_count‘, None) or \ _Cfunction(‚libvlc_video_get_spu_count‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p_mi) def libvlc_video_get_spu_description(p_mi): '''Get the description of available video subtitles. @param p_mi: the media player. @return: list containing description of available video subtitles. ''' f = _Cfunctions.get(‚libvlc_video_get_spu_description‘, None) or \ _Cfunction(‚libvlc_video_get_spu_description‘, ((1,),), None, ctypes.POINTER(TrackDescription) , MediaPlayer) return f(p_mi) def libvlc_video_set_spu(p_mi, i_spu): '''Set new video subtitle. @param p_mi: the media player. @param i_spu: video subtitle track to select (i_id from track description). @return: 0 on success, -1 if out of range. ''' f = _Cfunctions.get(‚libvlc_video_set_spu‘, None) or \ _Cfunction(‚libvlc_video_set_spu‘, ((1,), (1,),), None, ctypes.c_int, MediaPlayer, ctypes.c_int) return f(p_mi, i_spu) def libvlc_video_set_subtitle_file(p_mi, psz_subtitle): '''Set new video subtitle file. @param p_mi: the media player. @param psz_subtitle: new video subtitle file. @return: the success status (boolean). ''' f = _Cfunctions.get(‚libvlc_video_set_subtitle_file‘, None) or \ _Cfunction(‚libvlc_video_set_subtitle_file‘, ((1,), (1,),), None, ctypes.c_int, MediaPlayer, ctypes.c_char_p) return f(p_mi, psz_subtitle) def libvlc_video_get_spu_delay(p_mi): '''Get the current subtitle delay. Positive values means subtitles are being displayed later, negative values earlier. @param p_mi: media player. @return: time (in microseconds) the display of subtitles is being delayed. @version: LibVLC 2.0.0 or later. ''' f = _Cfunctions.get(‚libvlc_video_get_spu_delay‘, None) or \ _Cfunction(‚libvlc_video_get_spu_delay‘, ((1,),), None, ctypes.c_int64, MediaPlayer) return f(p_mi) def libvlc_video_set_spu_delay(p_mi, i_delay): '''Set the subtitle delay. This affects the timing of when the subtitle will be displayed. Positive values result in subtitles being displayed later, while negative values will result in subtitles being displayed earlier. The subtitle delay will be reset to zero each time the media changes. @param p_mi: media player. @param i_delay: time (in microseconds) the display of subtitles should be delayed. @return: 0 on success, -1 on error. @version: LibVLC 2.0.0 or later. ''' f = _Cfunctions.get(‚libvlc_video_set_spu_delay‘, None) or \ _Cfunction(‚libvlc_video_set_spu_delay‘, ((1,), (1,),), None, ctypes.c_int, MediaPlayer, ctypes.c_int64) return f(p_mi, i_delay) def libvlc_video_get_title_description(p_mi): '''Get the description of available titles. @param p_mi: the media player. @return: list containing description of available titles. ''' f = _Cfunctions.get(‚libvlc_video_get_title_description‘, None) or \ _Cfunction(‚libvlc_video_get_title_description‘,, ((1,),), None, ctypes.POINTER(TrackDescription), MediaPlayer) return f(p_mi) def libvlc_video_get_chapter_description(p_mi, i_title): '''Get the description of available chapters for specific title. @param p_mi: the media player. @param i_title: selected title. @return: list containing description of available chapter for title i_title. ''' f = _Cfunctions.get(‚libvlc_video_get_chapter_description‘, None) or \ _Cfunction(‚libvlc_video_get_chapter_description‘, ( (1, ), (1,),), None, ctypes.POINTER(TrackDescription) , MediaPlayer, ctypes.c_int) return f(p_mi, i_title) def libvlc_video_get_crop_geometry(p_mi): '''Get current crop filter geometry. @param p_mi: the media player. @return: the crop filter geometry or None if unset. ''' f = _Cfunctions.get(‚libvlc_video_get_crop_geometry‘, None) or \ _Cfunction(‚libvlc_video_get_crop_geometry‘ , ((1,),), string result, ctypes.c_void_p, MediaPlayer) return f(p_mi) def libvlc_video_set_crop_geometry(p_mi, psz_geometry): '''Set new crop filter geometry. @param p_mi: the media player. @param psz_geometry: new crop filter geometry (None to unset) . ''' f = _Cfunctions.get(‚libvlc_video_set_crop_geometry‘, None) or \ _Cfunction(‚libvlc_video_set_crop_geometry‘, ((1,), (1,),), None, None, MediaPlayer, ctypes.c_char_p) return f(p_mi, psz_geometry) def libvlc_video_get_teletext(p_mi): '''Get current teletext page requested. @param p_mi: the media player. @return: the current teletext page requested. ''' f = _Cfunctions.get(‚libvlc_video_get_teletext‘, None) or \ _Cfunction(‚libvlc_video_get_teletext‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p_mi) def libvlc_video_set_teletext(p_mi, i_page): '''Set new teletext page to retrieve. @param p_mi: the media player. @param i_page: teletex page number requested. ''' f = _Cfunctions.get(‚libvlc_video_set_teletext‘, None) or \ _Cfunction(‚libvlc_video_set_teletext‘, ((1,), (1,),), None, None, MediaPlayer, ctypes.c_int) return f(p_mi, i_page) def libvlc_toggle_teletext(p_mi): '''Toggle teletext transparent status on video output. @param p_mi: the media player. ''' f = _Cfunctions.get(‚libvlc_toggle_teletext‘, None) or \ _Cfunction(‚libvlc_toggle_teletext‘, ((1,),), None, None, MediaPlayer) return f(p_mi) def libvlc_video_get_track_count(p_mi): '''Get number of available video tracks. @param p_mi: media player. @return: the number of available video tracks (int). ''' f = _Cfunctions.get(‚libvlc_video_get_track_count‘, None) or \ _Cfunction(‚libvlc_video_get_track_count‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p_mi) def libvlc_video_get_track_description(p_mi): '''Get the description of available video tracks. @param p_mi: media player. @return: list with description of available video tracks, or None on error. ''' f = _Cfunctions.get(‚libvlc_video_get_track_description‘, None) or \ _Cfunction(‚libvlc_video_get_track_description‘, ((1,),), None, ctypes.POINTER(TrackDescription) , MediaPlayer) return f(p_mi) def libvlc_video_get_track(p_mi): '''Get current video track. @param p_mi: media player. @return: the video track ID (int) or -1 if no active input. ''' f = _Cfunctions.get(‚libvlc_video_get_track‘, None) or \ _Cfunction(‚libvlc_video_get_track‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p mi) def libvlc_video_set_track(p_mi, i_track): '''Set video track. @param p_mi: media player. @param i track: the track ID (i_id field from track description). @return: 0 on success, -1 if out of range. ''' f = _Cfunctions.get(‚libvlc_video_set_track‘, None) or \ _Cfunction(‚libvlc_video_set_track‘, ((1,), (1,),), None, ctypes.c_int, MediaPlayer, ctypes.c_int) return f(p_mi, i_track) def libvlc_video_take_snapshot(p_mi, num, psz_filepath, i_width, i_height): '''Take a snapshot of the current video window. If i_width AND i_height is 0, original size is used. If i_width XOR i_height is 0, original aspect-ratio is preserved. @param p_mi: media player instance. @param num: number of video output (typically 0 for the first/only one). @param psz_filepath: the path where to save the screenshot to. @param i_width: the snapshot's width. @param i_height: the snapshot's height. @return: 0 on success, -1 if the video was not found. ''' f = _Cfunctions.get(‚libvlc_video_take_snapshot‘, None) or \ _Cfunction(‚libvlc_video_take_snapshot‘, ((1,), (1,), (1,), (1,), (1,),), None, ctypes.c_int, MediaPlayer, ctypes.c_uint, ctypes.c_char_p, ctypes.c_int, ctypes.c_int) return f(p_mi, num, psz_filepath, i_width, i_height) def libvlc_video_set_deinterlace(p_mi, psz_mode): '''Enable or disable deinterlace filter. @param p_mi: libvlc media player. @param psz_mode: type of deinterlace filter, None to disable. ''' f = _Cfunctions.get(‚libvlc_video_set_deinterlace‘, None) or \ _Cfunction(‚libvlc_video_set_deinterlace‘, ((1,), (1,),), None, None, MediaPlayer, ctypes.c_char_p) return f(p_mi, psz_mode) def libvlc_video_get_marquee_int(p_mi, option): '''Get an integer marquee option value. @param p_mi: libvlc media player. @param option: marq option to get See libvlc_video_marquee_int_option_t. ''' f = _Cfunctions.get(‚libvlc_video_get_marquee_int‘, None) or \ _Cfunction(‚libvlc_video_get_marquee_int‘, ((1,), (1,),), None, ctypes.c_int, MediaPlayer, ctypes.c_uint) return f(p_mi, option) def libvlc_video_get_marquee_string(p_mi, option): '''Get a string marquee option value. @param p_mi: libvlc media player. @param option: marq option to get See libvlc_video_marquee_string_option_t. ''' f = _Cfunctions.get(‚libvlc_video_get_marquee_string‘, None) or \ _Cfunction(‚libvlc_video_get_marquee_string‘, ((1,), (1,),), string_result, ctypes.c_void_p, MediaPlayer, ctypes.c_uint) return f(p_mi, option) def libvlc_video_set_marquee_int(p_mi, option, i_val): '''Enable, disable or set an integer marquee option Setting libvlc_marquee_Enable has the side effect of enabling (arg !0) or disabling (arg 0) the marq filter. @param p_mi: libvlc media player. @param option: marq option to set See libvlc_video_marquee_int_option_t. @param i_val: marq option value. ''' f = _Cfunctions.get(‚libvlc_video_set_marquee_int‘, None) or \ _Cfunction(‚libvlc_video_set_marquee_int‘, ((1,), (1,), (1,),), None, None, MediaPlayer, ctypes.c_uint, ctypes.c_int) return f(p_mi, option, i_val) def libvlc_video_set_marquee_string(p_mi, option, psz_text): ' ' 'Set a marquee string option. @param p_mi: libvlc media player. @param option: marq option to set See libvlc_video_marquee_string_option_t. @param psz_text: marq option value. ‘ ‚ '‘ f = _Cfunctions.get(‚libvlc_video_set_marquee_string‘, None) or \ _Cfunction(‚libvlc_video_set_marquee_string‘ , ((1,), (1,), (1,),), None, None, MediaPlayer, ctypes.c_uint, ctypes.c_char_p) return f(p_mi, option, psz_text) def libvlc_video_get_logo_int(p_mi, option): '''Get integer logo option. @param p_mi: libvlc media player instance. @param option: logo option to get, values of libvlc_video_logo_option_t. ''' f = _Cfunctions.get(‚libvlc_video_get_logo_int‘, None) or \ _Cfunction(‚libvlc_video_get_logo_int‘, ((1,), (1,),), None, ctypes.c_int, MediaPlayer, ctypes.c_uint) return f(p_mi, option) def libvlc_video_set_logo_int(p_mi, option, value): '''Set logo option as integer. Options that take a different type value are ignored. Passing libvlc_logo _enable as option value has the side effect of starting (arg !0) or stopping (arg 0) the logo filter. @param p_mi: libvlc media player instance. @param option: logo option to set, values of libvlc_video_logo_option_t. @param value: logo option value. ‘ ‚ '‘ f = _Cfunctions.get(‚libvlc_video_set_logo_int‘, None) or \ _Cfunction (' libvlc_video_set_logo_int', ((1,), (1,), (1,),), None, None, MediaPlayer, ctypes.c_uint, ctypes.c_int) return f(p_mi, option, value) def libvlc_video_set_logo_string(p_mi, option, psz_value): ' ' ‚Set logo option as string. Options that take a different type value are ignored. @param p_mi: libvlc media player instance. @param option: logo option to set, values of libvlc_video_logo_option_t. @param psz_value: logo option value. ‘ ‚ '‘ f = _Cfunctions.get(‚libvlc_video_set_logo_string‘, None) or \ _Cfunction(‚libvlc_video_set_logo_string‘, ((1,), (1,), (1,),), None, None, MediaPlayer, ctypes.c_uint, ctypes.c_char_p) return f(p_mi, option, psz_value) def libvlc_video_get_adjust_int(p_mi, option): '''Get integer adjust option. @param p_mi: libvlc media player instance. @param option: adjust option to get, values of libvlc_video_adjust_option_t. @version: LibVLC 1.1.1 and later. ''' f = _Cfunctions.get(‚libvlc_video_get_adjust_int‘, None) or \ _Cfunction(‚libvlc_video_get_adjust_int‘ , ((1,), (1,),), None, ctypes.c_int, MediaPlayer, ctypes.c_uint) return f(p_mi, option) def libvlc_video_set_adjust_int(p_mi, option, value): ' ' 'Set adjust option as integer. Options that take a different type value are ignored. Passing libvlc_adjust_enable as option value has the side effect of starting (arg !0) or stopping (arg 0) the adjust filter. @param p_mi: libvlc media player instance. @param option: adust option to set, values of libvlc_video_adjust_option_t. @param value: adjust option value. @version: LibVLC 1.1.1 and later. ''' f = _Cfunctions.get(‚libvlc_video_set_adjust_int‘, None) or \ _Cfunction(‚libvlc_video_set_adjust_int‘, ((1,), (1,), (1,),), None, None, MediaPlayer, ctypes.c_uint, ctypes.c_int) return f(p_mi, option, value) def libvlc_video_get_adjust_float(p_mi, option): '''Get float adjust option. @param p_mi: libvlc media player instance. @param option: adjust option to get, values of libvlc_video_adjust_option_t. @version: LibVLC 1.1.1 and later. ''' f = _Cfunctions.get(‚libvlc_video_get_adjust_float‘, None) or \ _Cfunction(‚libvlc_video_get_adjust_float‘, ((1,), (1,),), None, ctypes.c_float, MediaPlayer, ctypes.c_uint) return f(p_mi, option) def libvlc_video_set_adjust_float(p_mi, option, value): ' ' 'Set adjust option as float. Options that take a different type value are ignored. @param p_mi: libvlc media player instance. @param option: adust option to set, values of libvlc_video_adjust_option_t. @param value: adjust option value. @version: LibVLC 1.1.1 and later. ''' f = _Cfunctions.get(‚libvlc_video_set_adjust_float‘, None) or \ _Cfunction(‚libvlc_video_set_adjust_float‘, ((1,), (1,), (1,),), None, None, MediaPlayer, ctypes.c_uint, ctypes.c_float) return f(p_mi, option, value) def libvlc_audio_output_list_get(p_instance): '''Gets the list of available audio output modules. @param p_instance: libvlc instance. @return: list of available audio outputs. It must be freed it with In case of error, None is returned. ''' f = _Cfunctions.get(‚libvlc_audio_output_list_get‘, None) or \ _Cfunction(‚libvlc_audio_output_list_get‘, ((1,),), None, ctypes.POINTER(AudioOutput), Instance) return f(p_instance) def libvlc_audio_output_list_release(p_list): '''Frees the list of available audio output modules. @param p_list: list with audio outputs for release. ''' f = _Cfunctions.get(‚libvlc_audio_output_list_release‘, None) or \ _Cfunction(‚libvlc_audio_output_list_release‘, ((1,),), None, None, ctypes.POINTER(AudioOutput)) return f(p_list) def libvlc_audio_output_set(p_mi, psz_name): '''Selects an audio output module. @note: Any change will take be effect only after playback is stopped and restarted. Audio output cannot be changed while playing. @param p_mi: media player. @param psz_name: name of audio output, use psz_name of See L{AudioOutput}. @return: 0 if function succeded, -1 on error. ''' f = _Cfunctions.get(‚libvlc_audio_output_set‘, None) or \ _Cfunction(‚libvlc_audio_output_set‘, ((1,), (1,),), None, ctypes.c_int, MediaPlayer, ctypes.c_char_p) return f(p_mi, psz_name) def libvlc_audio_output_device_count(p_instance, psz_name): '''Backward compatibility stub. Do not use in new code. Use L{libvlc_audio_output_device_list_get} () instead. @return: always 0. ''' f = _Cfunctions.get(‚libvlc_audio_output_device_count‘, None) or \ _Cfunction(‚libvlc_audio_output_device_count‘, ((1,), (1,),), None, ctypes.c_int, Instance, ctypes.c_char_p) return f(p_instance, psz_name) def libvlc_audio_output_device_longname(p_instance, psz_name, i_device): '''Backward compatibility stub. Do not use in new code. Use L{libvlc_audio_output_device_list_get}() instead. @return: always None. ''' f = _Cfunctions.get(‚libvlc_audio_output_device_longname‘, None) or \ _Cfunction(‚libvlc_audio_output_device_longname‘, ((1,), (1,), (1,),), string_result, ctypes.c_void_p, Instance, ctypes.c_char_p, ctypes.c_int) return f(p_instance, psz_name, i_device) def libvlc_audio_output_device_id(p_instance, psz_name, i_device): '''Backward compatibility stub. Do not use in new code. Use L{libvlc_audio_output_device_list_get}() instead. @return: always None. ''' f = _Cfunctions.get(‚libvlc_audio_output_device_id‘, None) or \ _Cfunction(‚libvlc_audio_output_device_id‘, ((1,), (1,), (1,),), string_result, ctypes.c_void_p, Instance, ctypes.c_char_p, ctypes.c_int) return f(p_instance, psz_name, i_device) def libvlc_audio_output_device_enum(mp): '''Gets a list of potential audio output devices, See L{libvlc_audio_output_device_set}(). @note: Not all audio outputs support enumerating devices. The audio output may be functional even if the list is empty (None). @note: The list may not be exhaustive. @warning: Some audio output devices in the list might not actually work in some circumstances. By default, it is recommended to not specify any explicit audio device. @param mp: media player. @return: A None-terminated linked list of potential audio output devices. It must be freed it with L{libvlc_audio_output_device_list_release}(). @version: LibVLC 2.2.0 or later. ''' f = _Cfunctions.get(‚libvlc_audio_output_device_enum‘, None) or \ _Cfunction(‚libvlc_audio_output_device_enum‘, ((1,),), None, ctypes.POINTER(AudioOutputDevice), MediaPlayer) return f(mp) def libvlc_audio_output_device_list_get(p_instance, aout): '''Gets a list of audio output devices for a given audio output module, See L{libvlc_audio_output_device_set}(). @note: Not all audio outputs support this. In particular, an empty (None) list of devices does B{not} imply that the specified audio output does not work. @note: The list might not be exhaustive. @warning: Some audio output devices in the list might not actually work in some circumstances. By default, it is recommended to not specify any explicit audio device. @param p_instance: libvlc instance. @param psz_aout: audio output name (as returned by L{libvlc_audio_output_list_get}()). @return: A None-terminated linked list of potential audio output devices. It must be freed it with L{libvlc_audio_output_device_list_release}(). @version: LibVLC 2.1.0 or later. ''' f = _Cfunctions.get(‚libvlc_audio_output_device_list_get‘, None) or \ _Cfunction(‚libvlc_audio_output_device_list_get‘, ((1,), (1,),), None, ctypes.POINTER(AudioOutputDevice), Instance, ctypes.c_char_p) return f(p_instance, aout) def libvlc_audio_output_device_list_release(p_list): '''Frees a list of available audio output devices. @param p_list: list with audio outputs for release. @version: LibVLC 2.1.0 or later. ''' f = _Cfunctions.get(‚libvlc_audio_output_device_list_release‘, None) or \ _Cfunction(‚libvlc_audio_output_device_list_release‘, ((1,),), None, None, ctypes.POINTER(AudioOutputDevice)) return f(p_list) def libvlc_audio_output_device_set(mp, module, device_id): '''Configures an explicit audio output device. If the module paramater is None, audio output will be moved to the device specified by the device identifier string immediately. This is the recommended usage. A list of adequate potential device strings can be obtained with L{libvlc_audio_output_device_enum}(). However passing None is supported in LibVLC version 2.2.0 and later only; in earlier versions, this function would have no effects when the module parameter was None. If the module parameter is not None, the device parameter of the corresponding audio output, if it exists, will be set to the specified string. Note that some audio output modules do not have such a parameter (notably MMDevice and PulseAudio). A list of adequate potential device strings can be obtained with L{libvlc_audio_output_device_list_get}(). @note: This function does not select the specified audio output plugin. L{libvlc_audio_output_set}() is used for that purpose. @warning: The syntax for the device parameter depends on the audio output. Some audio output modules require further parameters (e.g. a channels map in the case of ALSA). @param mp: media player. @param module: If None, current audio output module. if non-None, name of audio output module. @param device_id: device identifier string. @return: Nothing. Errors are ignored (this is a design bug) . ''' f = _Cfunctions.get(‚libvlc_audio_output_device_set‘, None) or \ _Cfunction(‚libvlc_audio_output_device_set‘, ((1,), (1,), (1,),), None, None, MediaPlayer, ctypes.c_char_p, ctypes.c_char_p) return f(mp, module, device_id) def libvlc_audio_toggle_mute(p_mi): '''Toggle mute status. @param p_mi: media player @warning Toggling mute atomically is not always possible: On some platforms, other processes can mute the VLC audio playback stream asynchronously. Thus, there is a small race condition where toggling will not work. See also the limitations of L{libvlc_audio_set_mute}(). ''' f = _Cfunctions.get(‚libvlc_audio_toggle_mute‘, None) or \ _Cfunction(‚libvlc_audio_toggle_mute‘, ((1,),), None, None, MediaPlayer) return f(p_mi) def libvlc_audio_get_mute(p_mi): '''Get current mute status. @param p_mi: media player. @return: the mute status (boolean) if defined, -1 if undefined/unapplicable. ''' f = _Cfunctions.get(‚libvlc_audio_get_mute‘, None) or \ _Cfunction(‚libvlc_audio_get_mute‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p_mi) def libvlc_audio_set_mute(p_mi, status): ' ' 'Set mute status. @param p_mi: media player. @param status: If status is true then mute, otherwise unmute @warning This function does not always work. If there are no active audio playback stream, the mute status might not be available. If digital pass-through (S/PDIF, HDMI...) is in use, muting may be unapplicable. Also some audio output plugins do not support muting at all. @note To force silent playback, disable all audio tracks. This is more efficient and reliable than mute. ‘'' f = _Cfunctions.get(‚libvlc_audio_set_mute‘, None) or \ _Cfunction(‚libvlc_audio_set_mute‘, ((1,), (1,),), None, None, MediaPlayer, ctypes.c_int) return f(p_mi, status) def libvlc_audio_get_volume(p_mi): '''Get current software audio volume. @param p_mi: media player. @return: the software volume in percents (0 = mute, 100 = nominal / 0dB). ''' f = _Cfunctions.get(‚libvlc_audio_get_volume‘, None) or \ _Cfunction(‚libvlc_audio_get_volume‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p_mi) def libvlc_audio_set_volume(p_mi, i_volume): ' ' 'Set current software audio volume. @param p_mi: media player. @param i_volume: the volume in percents (0 = mute, 100 = 0dB) . @return: 0 if the volume was set, -1 if it was out of range. ''' f = Cfunctions.get(‚libvlc audio set volume‘, None) or \ _Cfunction(‚libvlc_audio_set_volume‘, ((1,), (1,),), None, ctypes.c_int, MediaPlayer, ctypes.c_int) return f(p_mi, i_volume) def libvlc_audio_get_track_count(p_mi): '''Get number of available audio tracks. @param p_mi: media player. @return: the number of available audio tracks (int), or - 1 if unavailable. ''' f = _Cfunctions.get(‚libvlc_audio_get_track_count‘, None) or \ _Cfunction(‚libvlc_audio_get_track_count‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p_mi) def libvlc_audio_get_track_description(p_mi): '''Get the description of available audio tracks. @param p_mi: media player. @return: list with description of available audio tracks, or None. ''' f = _Cfunctions.get(‚libvlc_audio_get_track_description‘, None) or \ _Cfunction(‚libvlc_audio_get_track_description‘, ((1,),), None, ctypes.POINTER(TrackDescription), MediaPlayer) return f(p_mi) def libvlc_audio_get_track(p_mi): '''Get current audio track. @param p_mi: media player. @return: the audio track ID or -1 if no active input. ''' f = _Cfunctions.get(‚libvlc_audio_get_track‘, None) or \ _Cfunction(‚libvlc_audio_get_track‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p mi) def libvlc_audio_set_track(p_mi, i_track): ' ' 'Set current audio track. @param p_mi: media player. @param i_track: the track ID (i_id field from track description). @return: 0 on success, -1 on error. ‘ ‚ '‘ f = _Cfunctions.get(‚libvlc_audio_set_track‘, None) or \ _Cfunction(‚libvlc_audio_set_track‘, ((1,), (1,),), None, ctypes.c_int, MediaPlayer, ctypes.c_int) return f(p_mi, i_track) def libvlc_audio_get_channel(p_mi): '''Get current audio channel. @param p_mi: media player. @return: the audio channel See libvlc_audio_output_channel_t. ''' f = _Cfunctions.get(‚libvlc_audio_get_channel‘, None) or \ _Cfunction(‚libvlc_audio_get_channel‘, ((1,),), None, ctypes.c_int, MediaPlayer) return f(p_mi) def libvlc_audio_set_channel(p_mi, channel): ' ' 'Set current audio channel. @param p_mi: media player. @param channel: the audio channel, See libvlc_audio_output_channel_t. @return: 0 on success, -1 on error. ‘'‘ f = _Cfunctions.get(‚libvlc_audio _set _channel‘, None) or \ _Cfunction(‚libvlc_audio_set_channel‘, ((1,), (1,),), None, ctypes.c_int, MediaPlayer, ctypes.c_int) return f(p_mi, channel) def libvlc_audio_get_delay(p_mi): '''Get current audio delay. @param p_mi: media player. @return: the audio delay (microseconds). @version: LibVLC 1.1.1 or later. ''‘ f = _Cfunctions.get(‚libvlc_audio_get_delay‘, None) or \ Cfunction(‚libvlc audio get delay‘, ((1,),), None, ctypes.c_int64, MediaPlayer) return f(p_mi) def libvlc_audio_set_delay(p_mi, i_delay): ' ' 'Set current audio delay. The audio delay will be reset to zero each time the media changes. @param p_mi: media player. @param i_delay: the audio delay (microseconds). @return: 0 on success, -1 on error. @version: LibVLC 1.1.1 or later. ‘'‘ f = _Cfunctions.get(‚libvlc_audio_set_delay‘, None) or \ _Cfunction(‚libvlc_audio_set_delay‘, ((1,), (1,),), None, ctypes.c_int, MediaPlayer, ctypes.c_int64) return f(p_mi, i_delay) def libvlc_audio_equalizer_get_preset_count(): '''Get the number of equalizer presets. @return: number of presets. @version: LibVLC 2.2.0 or later. ''‘ f = _Cfunctions.get(‚libvlc_audio_equalizer_get_preset_count‘, None) or \ _Cfunction(‚libvlc_audio_equalizer_get_preset_count‘, (), None, ctypes.c_uint) return f() def libvlc_audio_equalizer_get_preset_name(u_index): '''Get the name of a particular equalizer preset. This name can be used, for example, to prepare a preset label or menu in a user interface. @param u_index: index of the preset, counting from zero. @return: preset name, or None if there is no such preset. @version: LibVLC 2.2.0 or later. ''‘ f = _Cfunctions.get(‚libvlc_audio_equalizer_get_preset_name‘, None) or \ _Cfunction(‚libvlc_audio_equalizer_get_preset_name‘, ((1,),), None, ctypes.c_char_p, ctypes.c_uint) return f(u_index) def libvlc_audio_equalizer_get_band_count(): '''Get the number of distinct frequency bands for an equalizer. @return: number of frequency bands. @version: LibVLC 2.2.0 or later. ''' f = _Cfunctions.get(‚libvlc_audio_equalizer_get_band_count‘, None) or \ _Cfunction(‚libvlc_audio_equalizer_get_band_count‘, (), None, ctypes.c_uint) return f() def libvlc_audio_equalizer_get_band_frequency(u_index): '''Get a particular equalizer band frequency. This value can be used, for example, to create a label for an equalizer band control in a user interface. @param u_index: index of the band, counting from zero. @return: equalizer band frequency (Hz), or -1 if there is no such band. @version: LibVLC 2.2.0 or later. ''‘ f = _Cfunctions.get(‚libvlc_audio_equalizer_get_band_frequency‘, None) or \ _Cfunction(‚libvlc_audio_equalizer_get_band_frequency‘, ((1,),), None, ctypes.c_float, ctypes.c_uint) return f(u_index) def libvlc_audio_equalizer_new(): '''Create a new default equalizer, with all frequency values zeroed. The new equalizer can subsequently be applied to a media player by invoking L{libvlc_media_player_set_equalizer}(). The returned handle should be freed via L{libvlc_audio_equalizer_release}() when it is no longer needed. @return: opaque equalizer handle, or None on error. @version: LibVLC 2.2.0 or later. ''‘ f = _Cfunctions.get(‚libvlc_audio_equalizer_new‘, None) or \ _Cfunction(‚libvlc_audio_equalizer_new‘, (), None, ctypes.c_void_p) return f() def libvlc_audio_equalizer_new_from_preset(u_index): '''Create a new equalizer, with initial frequency values copied from an existing preset. The new equalizer can subsequently be applied to a media player by invoking L{libvlc_media_player_set_equalizer}(). The returned handle should be freed via L{libvlc_audio_equalizer_release} () when it is no longer needed. @param u_index: index of the preset, counting from zero. @return: opaque equalizer handle, or None on error. @version: LibVLC 2.2.0 or later. ''‘ f = _Cfunctions.get(‚libvlc_audio_equalizer_new_from_preset‘, None) or \ _Cfunction(‚libvlc_audio_equalizer_new_from_preset‘, ((1,),), None, ctypes.c_void_p, ctypes.c_uint) return f(u_index) def libvlc_audio_equalizer_release(p_equalizer): '''Release a previously created equalizer instance. The equalizer was previously created by using L{libvlc_audio_equalizer_new}() or L{libvlc_audio_equalizer_new_from_preset}(). It is safe to invoke this method with a None p_equalizer parameter for no effect. @param p_equalizer: opaque equalizer handle, or None. @version: LibVLC 2.2.0 or later. ''‘ f = _Cfunctions.get(‚libvlc_audio_equalizer_release‘, None) or \ _Cfunction(‚libvlc_audio_equalizer_release‘, ((1,),), None, None, ctypes.c_void_p) return f(p_equalizer) def libvlc_audio_equalizer_set_preamp(p_equalizer, f_preamp): '''Set a new pre-amplification value for an equalizer. The new equalizer settings are subsequently applied to a media player by invoking L{libvlc_media_player_set_equalizer} () . The supplied amplification value will be clamped to the - 20.0 to +20.0 range. @param p_equalizer: valid equalizer handle, must not be None. @param f_preamp: preamp value (-20.0 to 20.0 Hz). @return: zero on success, -1 on error. @version: LibVLC 2.2.0 or later. ''‘ f = _Cfunctions.get(‚libvlc_audio_equalizer_set_preamp‘, None) or \ _Cfunction(‚libvlc_audio_equalizer_set_preamp‘, ((1,), (1,),), None, ctypes.c_int, ctypes.c_void_p, ctypes.c_float) return f(p_equalizer, f_preamp) def libvlc_audio_equalizer_get_preamp(p_equalizer): '''Get the current pre-amplification value from an equalizer. @param p_equalizer: valid equalizer handle, must not be None. @return: preamp value (Hz). @version: LibVLC 2.2.0 or later. ''‘ f = _Cfunctions.get(‚libvlc_audio_equalizer_get_preamp‘, None) or \ _Cfunction(‚libvlc_audio_equalizer_get_preamp‘, ((1,),), None, ctypes.c_float, ctypes.c_void_p) return f(p_equalizer) def libvlc_audio_equalizer_set_amp_at_index(p_equalizer, f_amp, u_band): ' ' 'Set a new amplification value for a particular equalizer frequency band. The new equalizer settings are subsequently applied to a media player by invoking L{libvlc_media_player_set_equalizer}(). The supplied amplification value will be clamped to the - 20.0 to +20.0 range. @param p_equalizer: valid equalizer handle, must not be None. @param f_amp: amplification value (-20.0 to 20.0 Hz). @param u_band: index, counting from zero, of the frequency band to set. @return: zero on success, -1 on error. @version: LibVLC 2.2.0 or later. ‘ ‚ '‘ f = _Cfunctions.get(‚libvlc_audio_equalizer_set_amp_at_index‘, None) or \ _Cfunction(‚libvlc_audio_equalizer_set_amp_at_index‘, ((1,), (1,), (1,),), None, ctypes.c_int, ctypes.c_void_p, ctypes.c_float, ctypes.c_uint) return f(p_equalizer, f_amp, u_band) def libvlc_audio_equalizer_get_amp_at_index(p_equalizer, u_band): '''Get the amplification value for a particular equalizer frequency band. @param p_equalizer: valid equalizer handle, must not be None. @param u_band: index, counting from zero, of the frequency band to get. @return: amplification value (Hz); NaN if there is no such frequency band. @version: LibVLC 2.2.0 or later. ''' f = _Cfunctions.get(‚libvlc_audio_equalizer_get_amp_at_index‘, None) or \ _Cfunction(‚libvlc_audio_equalizer_get_amp_at_index‘, ((1,), (1,),), None, ctypes.c_float, ctypes.c_void_p, ctypes.c_uint) return f(p_equalizer, u_band) def libvlc_media_player_set_equalizer(p_mi, p_equalizer): '''Apply new equalizer settings to a media player. The equalizer is first created by invoking L{libvlc_audio_equalizer_new}() or L{libvlc_audio_equalizer_new_from_preset}(). It is possible to apply new equalizer settings to a media player whether the media player is currently playing media or not. Invoking this method will immediately apply the new equalizer settings to the audio output of the currently playing media if there is any. If there is no currently playing media, the new equalizer settings will be applied later if and when new media is played. Equalizer settings will automatically be applied to subsequently played media. To disable the equalizer for a media player invoke this method passing None for the p_equalizer parameter. The media player does not keep a reference to the supplied equalizer so it is safe for an application to release the equalizer reference any time after this method returns. @param p_mi: opaque media player handle. @param p_equalizer: opaque equalizer handle, or None to disable the equalizer for this media player. @return: zero on success, -1 on error. @version: LibVLC 2.2.0 or later. ' ‚ '‘ f = _Cfunctions.get(‚libvlc_media_player_set_equalizer‘, None) or \ _Cfunction(‚libvlc_media_player_set_equalizer‘, ((1,), (1,),), None, ctypes.c_int, MediaPlayer, ctypes.c_void_p) return f(p_mi, p_equalizer) def libvlc_media_list_player_new(p_instance): '''Create new media_list_player. @param p_instance: libvlc instance. @return: media list player instance or None on error. ''‘ f = _Cfunctions.get(‚libvlc_media_list_player_new‘, None) or \ _Cfunction(‚libvlc_media_list_player_new‘, ((1,),), class_result(MediaListPlayer), ctypes.c_void_p, Instance) return f(p_instance) def libvlc media_list_player_release(pmlp): '''Release a media_list_player after use Decrement the reference count of a media player object. If the reference count is 0, then L{libvlc_media_list_player_release}() will release the media player object. If the media player object has been released, then it should not be used again. @param p_mlp: media list player instance. ''‘ f = _Cfunctions.get(‚libvlc_media_list_player_release‘, None) or \ _Cfunction(‚libvlc_media_list_player_release‘ , ((1,),), None, None, MediaListPlayer) return f(p_mlp) def libvlc_media_list_player_retain(p_mlp): '''Retain a reference to a media player list object. Use L{libvlc_media_list_player_release}() to decrement reference count. @param p_mlp: media player list object. ''‘ f = _Cfunctions.get(‚libvlc_media_list_player_retain‘, None) or \ _Cfunction(‚libvlc_media_list_player_retain‘, ((1,),), None, None, MediaListPlayer) return f(p_mlp) def libvlc media_list_player_event manager(p_mlp): '''Return the event manager of this media_list_player. @param p_mlp: media list player instance. @return: the event manager. ''' f = _Cfunctions.get(‚libvlc_media_list_player_event_manager‘, None) or \ _Cfunction(‚libvlc_media_list_player_event_manager‘, ((1,),), class_result(EventManager), ctypes.c_void_p, MediaListPlayer) return f(p_mlp) def libvlc_media_list_player_set_media_player(p_mlp, p_mi): '''Replace media player in media_list_player with this instance. @param p_mlp: media list player instance. @param p_mi: media player instance. ''' f = _Cfunctions.get(‚libvlc_media_list_player_set_media_player‘, None) or \ _Cfunction(‚libvlc_media_list_player_set_media_player‘, ((1,), (1,),), None, None, MediaListPlayer, MediaPlayer) return f(p_mlp, p_mi) def libvlc_media_list_player_set_media_list(p_mlp, p_mlist): ' ' 'Set the media list associated with the player. @param p_mlp: media list player instance. @param p_mlist: list of media. ‘'' f = _Cfunctions.get(‚libvlc_media_list_player_set_media_list‘, None) or \ _Cfunction(‚libvlc_media_list_player_set_media_list‘ , ((1,), (1,),), None, None, MediaListPlayer, MediaList) return f(p_mlp, p_mlist) def libvlc_media_list_player_play(p_mlp): '''Play media list. @param p_mlp: media list player instance. ''‘ f = _Cfunctions.get(‚libvlc_media_list_player_play‘, None) or \ _Cfunction(‚libvlc_media_list_player_play‘, ((1,),), None, None, MediaListPlayer) return f(p_mlp) def libvlc_media_list_player_pause(p_mlp): '''Toggle pause (or resume) media list. @param p_mlp: media list player instance. ''‘ f = _Cfunctions.get(‚libvlc_media_list_player_pause‘, None) or \ _Cfunction(‚libvlc_media_list_player_pause‘, ((1,),), None, None, MediaListPlayer) return f(p_mlp) def libvlc_media_list_player_is_playing(p_mlp): '''Is media list playing? @param p_mlp: media list player instance. @return: true for playing and false for not playing \libvlc_return_bool. ''' f = _Cfunctions.get(‚libvlc_media_list_player_is_playing‘, None) or \ _Cfunction(‚libvlc_media_list_player_is_playing‘, ((1,),), None, ctypes.c_int, MediaListPlayer) return f(p_mlp) def libvlc_media_list_player_get_state(p_mlp): '''Get current libvlc_state of media list player. @param p_mlp: media list player instance. @return: libvlc_state_t for media list player. ''' f = _Cfunctions.get(‚libvlc_media_list_player_get_state‘, None) or \ _Cfunction(‚libvlc_media_list_player_get_state‘, ((1,),), None, State, MediaListPlayer) return f(p_mlp) def libvlc_media_list_player_play_item_at_index(p_mlp, i_index): '''Play media list item at position index. @param p_mlp: media list player instance. @param i_index: index in media list to play. @return: 0 upon success -1 if the item wasn't found. ''' f = _Cfunctions.get(‚libvlc_media_list_player_play_item_at_index‘ , None) or \ _Cfunction(‚libvlc_media_list_player_play_item_at_index‘, ((1,), (1,),), None, ctypes.c_int, MediaListPlayer, ctypes.c_int) return f(p_mlp, i_index) def libvlc_media_list_player_play_item(p_mlp, p_md): '''Play the given media item. @param p_mlp: media list player instance. @param p_md: the media instance. @return: 0 upon success, -1 if the media is not part of the media list. ''' f = _Cfunctions.get(‚libvlc_media_list_player_play_item‘, None) or \ _Cfunction(‚libvlc_media_list_player_play_item‘, ((1,), (1,),), None, ctypes.c_int, MediaListPlayer, Media) return f(p_mlp, p_md) def libvlc_media_list_player_stop(p_mlp): '''Stop playing media list. @param p_mlp: media list player instance. ''‘ f = _Cfunctions.get(‚libvlc_media_list_player_stop‘, None) or \ _Cfunction(‚libvlc_media_list_player_stop‘, ((1,),), None, None, MediaListPlayer) return f(p_mlp) def libvlc_media_list_player_next(p_mlp): '''Play next item from media list. @param p_mlp: media list player instance. @return: 0 upon success -1 if there is no next item. ''‘ f = _Cfunctions.get(‚libvlc_media_list_player_next‘, None) or \ _Cfunction(‚libvlc_media_list_player_next‘, ((1,),), None, ctypes.c_int, MediaListPlayer) return f(p_mlp) def libvlc_media_list_player_previous(p_mlp): '''Play previous item from media list. @param p_mlp: media list player instance. @return: 0 upon success -1 if there is no previous item. ''' f = _Cfunctions.get(‚libvlc_media_list_player_previous‘, None) or \ _Cfunction(‚libvlc_media_list_player_previous‘, ((1,),), None, ctypes.c_int, MediaListPlayer) return f(p_mlp) def libvlc_media_list_player_set_playback_mode(p_mlp, e_mode): '''Sets the playback mode for the playlist. @param p_mlp: media list player instance. @param e_mode: playback mode specification. ''‘ f = _Cfunctions.get(‚libvlc_media_list_player_set_playback_mode‘, None) or \ _Cfunction(‚libvlc_media_list_player_set_playback_mode‘, ((1,), (1,),), None, None, MediaListPlayer, PlaybackMode) return f(p_mlp, e_mode) # 4 function(s) blacklisted: # libvlc_audio_output_get_device_type # libvlc_audio_output_set_device_type # libvlc_printerr # libvlc _set_exit_handler # 32 function(s) not wrapped as methods: # libvlc_audio_equalizer_get_amp_at_index # libvlc_audio_equalizer_get_band_count # libvlc_audio_equalizer_get_band_frequency # libvlc_audio_equalizer_get_preamp # libvlc_audio_equalizer_get_preset_count # libvlc_audio_equalizer_get_preset_name # libvlc_audio_equalizer_new # libvlc_audio_equalizer_new_from_preset # libvlc_audio_equalizer_release # libvlc_audio_equalizer_set_amp_at_index # libvlc_audio_equalizer_set_preamp # libvlc_audio_output_device_list_release # libvlc_audio_output_list_release # libvlc_clearerr # libvlc_clock # libvlc_event_type_name # libvlc_free # libvlc_get_changeset # libvlc_get_compiler # libvlc_get_version # libvlc_log_clear # libvlc_log_close # libvlc_log_count # libvlc_log_get_context # libvlc_log_get_iterator # libvlc_log_get_object # libvlc_media_tracks_release # libvlc_module_description_list_release # libvlc_new # libvlc_track_description_list_release # libvlc_track_description_release # libvlc_vprinterr # Start of footer.py # # Backward compatibility def callbackmethod(callback): " " "Now obsolete @callbackmethod decorator." " " return callback # libvlc_free is not present in some versions of libvlc. If it is not # in the library, then emulate it by calling libc.free if not hasattr(dll, ‚libvlc_free‘): # need to find the free function in the C runtime. This is # platform specific. # For Linux and MacOSX libc_path = find_library(‚c‘) if libc_path: libc = ctypes.CDLL(libc_path) libvlc_free = libc.free else: # On win32, it is impossible to guess the proper lib to call # (msvcrt, mingw...). Just ignore the call: it will memleak, # but not prevent to run the application. def übvlc_free (p) : pass # ensure argtypes is right, because default type of int won't # work on 64-bit systems libvlc_free.argtypes = [ctypes.c_void_p] # Version functions def_dot2int(v): ''' (INTERNAL) Convert ‚i.i.i[.i]‘ str to int. ''‘ t = [int(i) for i in v.split(‚.'‘)] if len(t) == 3: t.append(0) elif len (t) != 4: raise ValueError(' „i.i.i[.i]“: %r' % (v,)) if min(t) < 0 or max(t) > 255: raise ValueError(‚[0..255]: %r‘ % (v,)) i = t.pop(0) while t: i = (i << 8) + t.pop(0) return i def hex_version(): " " "Return the version of these bindings in hex or 0 if unavailable. " “ “ try: return_dot2int(_version_) except (NameError, ValueError): return 0 def libvlc_hex_version(): " " "Return the libvlc version in hex or 0 if unavailable. " “ “ try: return _dot2int (bytes_to_str(libvlc_get_version()).split()[0]) except ValueError: return 0 def debug_callback(event, *args, **kwds): '''Example callback, useful for debugging. ''' 1 = [‚event %s‘ % (event.type,)] if args: 1.extend(map(str, args)) if kwds: 1.extend(sorted(‚%s=%s‘ % t for t in kwds.items())) print(‚Debug callback (%s)‘ % ', .join (1)) if __name__ == ' __main__ ': try: from msvcrt import getch except ImportError: import termios import tty def getch(): # getchar(), getc(stdin) #PYCHOK flake fd = sys.stdin.fileno() old = termios.tcgetattr(fd) try: tty.setraw(fd) ch = sys.stdin.read(1) finally: termios.tcsetattr(fd, termios.TCSADRAIN, old) return ch def end_callback(event): print(‚End of media stream (event %s)‘ % event.type) sys.exit(0) echo_position = False def pos_callback(event, player): if echo_position: sys.stdout.write(‚\r%s to %.2f%% (%.2f%%)‘ % (event.type, event.u.new_position * 100, player.get_position() * 100)) sys.stdout.flush() def print_version(): " " "Print version of this vlc.py and of the libvlc" " " try: print(‚Build date: %s (%#x)‘ % (build_date, hex_version())) print(‚LibVLC version: %s (%#x)‘ % (bytes_to_str(libvlc_get_version()), libvlc_hex_version())) print(‚LibVLC compiler: %s‘ % bytes_to_str(libvlc_get_compiler())) if plugin_path: print(‚Plugin path: %s‘ % plugin_path) except: print (‚Error : %s‘ % sys.exc_info() [1]) if sys.argv[1:] and ‚-h‘ not in sys.argv[1:] and ‚--help‘ not in sys.argv[1:]: movie = os.path.expanduser(sys.argv.pop()) if not os.access(movie, os.R_OK): print(‚Error: %s file not readable‘ % movie) sys.exit(1) # Need --sub-source=marq in order to use marquee below instance = Instance([„--sub-source=marq“] + sys.argv[1:]) try: media = instance.media_new(movie) except (AttributeError, NameError) as e: print(‚%s: %s (%s %s vs LibVLC %s)‘ % (e.__class__.__name__, e, sys.argv[0],__version__, libvlc_get_version())) sys.exit(1) player = instance.media_player_new() player.set_media(media) player.play() # Some marquee examples. Marquee requires ‚--sub- source marq‘ in the # Instance() call above, see <http://www.videolan.org/doc/play-howto/en/ch04.html> player.video_set_marquee_int(VideoMarqueeOption.Enable, 1) player.video_set_marquee_int(VideoMarqueeOption.Size, 24) # pixels player.video_set_marquee_int(VideoMarqueeOption.Position, Position.Bottom) if False: # only one marquee can be specified player.video_set_marquee_int(VideoMarqueeOption.Timeout, 5000) # millisec, 0==forever t = media.get_mrl() # movie else: # update marquee text periodically player.video_set_marquee_int(VideoMarqueeOption.Timeout, 0) # millisec, 0==forever player.video_set_marquee_int(VideoMarqueeOption.Refresh, 1000) # millisec (or sec?) ##t = ‚$L / $D or $P at $T‘ t = ‚%Y-%m-%d %H:%M:%S‘ player.video_set_marquee_string(VideoMarqueeOption.Text, str_to_bytes(t)) # Some event manager examples. Note, the callback can be any Python # callable and does not need to be decorated. Optionally, specify # any number of positional and/or keyword arguments to be passed # to the callback (in addition to the first one, an Event instance). event_manager = player.event_manager() event_manager.event_attach(EventType.MediaPlayerEndReached, end_callback) event_manager.event_attach(EventType.MediaPlayerPositionChang ed, pos_callback, player) def mspf(): " " "Milliseconds per frame" " " return int(1000 // (player.get_fps() or 25)) def print_info(): " " “Print information about the media“ „ “ try: print_version() media = player.get_media() print(‚State: %s‘ % player.get_state()) print(‚Media: %s‘ % bytes_to_str(media.get_mrl())) print(‚Track: %s/%s‘ % (player.video_get_track(), player.video_get_track_count())) print(‚Current time: %s/%s‘ % (player.get_time(), media.get_duration())) print(‚Position: %s‘ % player.get_position()) print(‚FPS: %s (%d ms)‘ % (player.get_fps(), mspf ( ) ) ) print(‚Rate: %s‘ % player.get_rate()) print(‚Video size: %s‘ % str(player.video_get_size(0))) # num=0 print(‚Scale: %s‘ % player.video_get_scale()) print(‚Aspect ratio: %s‘ % player.video_get_aspect_ratio()) #print(‚Window:‘ % player.get_hwnd() except Exception: print(‚Error: %s‘ % sys.exc_info()[1]) def sec_forward(): " " “Go forward one sec“ “ “ player.set_time(player.get_time() + 1000) def sec_backward(): " " "Go backward one sec" " " player.set_time(player.get_time() - 1000) def frame_forward(): " “ “ Go forward one frame" “ “ player.set_time(player.get_time() + mspf()) def frame_backward(): " " "Go backward one frame" " " player.set_time(player.get_time() - mspf()) def print_help(): " " “Print help“ “ “ print(‚Single-character commands:‘) for k, m in sorted(keybindings.items()): m = (m.__doc__ or m.__ name__ ) .splitlines() [0] print(' %s: %s.' % (k, m.rstrip(‚.'‘))) print(‚0-9: go to that fraction of the movie‘) def quit_app(): " " "Stop and exit" " " sys.exit(0) def toggle_echo_position(): " " "Toggle echoing of media position" " " global echo_position echo_position= not echo_position keybindings = { ' ': player.pause, '+': sec_forward, '-': sec_backward, '.': frame_forward, ',': frame_backward, 'f': player.toggle_fullscreen, 'i': print_info, 'p': toggle_echo_position, 'q': quit_app, '?': print_help, } print(‚Press q to quit, ? to get help.%s‘ % os.linesep) while True: k = getch() print(' > %s' % k) if k in keybindings: keybindings[k]() elif k.isdigit(): # jump to fraction of the movie. player.set position(float(‚0.‘+k)) else: print(‚Usage: %s [options] <movie filename>‘ % sys.argv[0]) print(‚Once launched, type ? for help.‘) print( '' ) print_version()
PHP-Scripte Beschreibung:
Die gesamte Programmierung und Konfiguration der Zeitschaltuhr erfolgt über eine grafische Benutzeroberfläche (Graphical User Interface / GUI). Dabei ist es egal, ob die Bedienung der Eingabemasken, Symbole und Steuerelemente per Maus und Tastatur von einem PC, Notebook, oder durch Berührung eines Sensorbildschirmes von einem beliebigen Smartphone oder Tablet erfolgt. Die programmierten PHP-Scripte werden durch einen installierten Webserver an die verbundenen Geräte (Clients) der Zeitschaltuhr zur Verfügung gestellt.
Sämtliche zeitbezogenen Aufgaben und Befehle eines Scripts werden durch Cronjobs (Jobsteuerung) regelmäßig, zu einem bestimmten Zeitpunkt (Datum und Uhrzeit) oder nach dem Reboot / Systemstart ausgeführt. Die Cronjobs werden als Hintergrunddienst durch einen Cron-Daemon ausgeführt. Die Cronjobs werden in die Datei /var/spool/cron/crontabs/schaltzeiten.txt durch das php-Script „schaltzeiten.php“ eingetragen. Die Zeiten werden komfortabel über den Webbrowser eingegeben und als Variable übergeben und schließlich im richtigen Format als Cronjob eingetragen.
Über die GUI ist es für jeden einzelnen Ausgang möglich, diesen auf High- oder Low-Pegel zu schalten (zum Beispiel ein extern angeschlossener Relaiskontakt ist bei Neustart durch Spannungswiederkehr betätigt.
Der Errichter bzw. Bediener der Zeitschaltuhr kann somit über den Webbrowser eines entsprechenden Endgerätes die Ein- und Ausgänge der Zeitschaltuhr individuell programmieren.
Beispielsweisesoll von einem Eingang ein kurzer Impuls (Tasterschaltung oder ähnliches),ein Dauersignal (manueller Schalter, Automatikschalter für Dämmerung, Bewegung oder Präsenz, etc.)ausgewertet und ein Ausgang zeitabhängig geschalten werden, ein Ausgang nur zeitabhängig geschalten werden, soll ein Dimm- oder Schaltbefehl über den DALI-Bus gesendet werden, usw.
Die Einstellungen können benutzerabhängig freigegeben werden, z.B. Elektrofachkraft als Errichter der Zeitschaltuhr darf alle Einstellungen vornehmen und der Bediener, z.B. Hausmeister darf nur die Schaltzeiten bestimmter Ausgänge verändern.
zeitschaltuhr.php
startverhalten.php
Durch dieses PHP Script wird das Startverhalten der Ausgänge bei einem Neustart der elektronischen Zeitschaltuhr festgelegt. Die Zustände beim Systemstart können auf High-Pegel, Low-Pegel oder den letzten Zustand des jeweiligen Ausgangs eingestellt werden.
<?php function kanal ($reboot_dec, $ch, $inhalt, $zeile, $zeile_neu) { if (isset($_POST[‚speichern‘]) && $_POST[‚speichern‘] == ' speichern' ) { $ch = file(‚/var/www/cgi-bin/reboot_pi.txt‘); if (isset($_POST[‚speichern‘])) {if ($_POST[‚ausgang_1‘] == „aus_1“) { } $zeile[0]=„0“; if ($_POST[‚ausgang_1‘] == „ein_1“) { }$zeile[0]= „1“; else { $zeile[0]=„0“; } if ($_POST[‚ausgang_1‘] == „letzter_1“) { }$z[0]=„1“; else { $z [ 0 ] = "0" ; } if ($_POST[‚ausgang_2‘] == „aus_2“) { $zeile[1]= „0“; } if ($_POST[‚ausgang_2‘] == „ein_2“) { $zeile[1]=„1“; } else { }$zeile[1]=„0“; if ($_POST[‚ausgang_2‘] == „letzter _2“) { }$z [1]=„1“; else { $z [1]=„0“; } if ($_POST[‚ausgang_3‘] == „aus_3“) { }$zeile[2]=„0“; if ($_POST[‚ausgang_3‘] == „ein_3“) { $zeile[2]=„1“; } else { $zeile[2]=„0“; } if ($_POST[‚ausgang_3‘] == „letzter_3“) { $z [2]=„1“; } else { }$z[2]=„0“; if ($_POST[‚ausgang_4‘] == „aus_4“) { }$zeile[3]=„0“; if ($_POST[‚ausgang_4‘] == „ein_4“) { $zeile[3]=„1“; } else { }$zeile[3]=„0“; if ($_POST[‚ausgang_4‘] == „letzter_4“) { $z[3]=„1“; } else { $z[3]=„0“; } if ($_POST[‚ausgang_5‘] == „aus_5“) { $zeile[4]=„0“; if ($_POST[‚ausgang_5‘] == „ein_5“) { } } $zeile[4]=„1“; else { $zeile[4]=„0“; } if ($_POST[‚ausgang_5‘] == „letzter_5“) { $z[4]=„1“; } else { }$z[4]=„0“; if ($_POST[‚ausgang_6‘] == „aus 6“) { $zeile[5]=„0“; } if ($_POST[‚ausgang_6‘] == „ein_6“) { $zeile[5]=„1“; } else { $zeile[5]=„0“; } if ($_POST[‚ausgang_6‘] == „letzter_6“) { } $z[5]=„1“; else { }$z[5]=„0“; if ($_POST[‚ausgang_7‘] == „aus_7“) { zeile[6]=„0“; } if ($_POST[‚ausgang_7‘] == „ein_7“) { }$zeile[6]=„1“; else { $zeile[6]=„0“; } if ($_POST[‚ausgang_7‘] == „letzter_7“) { $z[6]=„1“; } else { $z[6]=„0“; } if ($_POST[‚ausgang_8‘] == „aus_8“) { }$zeile[7]=„0“; if ($_POST[‚ausgang_8‘] == „ein_8“) { $zeile[7]=„1“; } else { $zeile[7]=„0“; } if ($_POST[‚ausgang_8‘] == „letzter_8“) {$z[7]=„1“; } else { $z[7]=„0“; } $zeile neu = ($zeile[7]."\n".$zeile[6]."\n".$zeile[5]."\n".$zeile[4]."\n". $zeile [3] ."\n".$zeile[2] ."\n".$zeile[1] ."\n".$zeile[0] ."\n"); $reboot_dec = bindec($zeile_neu); $z_neu = ($z[7]."\n".$z[6]."\n".$z[5]."\n".$z[4]."\n".$z[3]."\n".$z[2] ."\n".$z[1]."\n".$z[0]."\n"); $reboot_dec_1 = bindec($z_neu); } $ch = fopen ('/var/www/cgi-bin/reboot_pi.txt`, ‚w‘); // reboot_pi.txt anlegen / aktualisieren fwrite($ch, $reboot_dec); fclose ($ch); $ch_1 = fopen (‚/var/www/cgi-bin/reboot_pi_1.txt‘, ‚w‘); // reboot_pi_1.txt anlegen / aktualisieren fwrite($ch_1, $reboot_dec_1); fclose ($ch_1); } } kanal(); ?> <html> <style> body { background-color: yellow; color: black; font:80px Arial; font-weight: bold; font-size: 120%; border: black 10px solid; } input[type=radio] { transform: scale(5); } </style> <style type=„text/css“> .Abfrage { color: #000000; font:80px Arial; font-size:80px; width: 750px; } </style> <title></title> <body onselectstart=„return false“ ondragstart=„return false“ oncontextmenu=„return false“ oncontext=„return false“> <form method=„post“> <table style=„width: 900px; text-align: left; margin-left: auto; margin-right: auto;“ border=„0“ cellpadding=„2“ cellspacing=„2“> <try> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <th style=„font-size:50pt; text-align: center;“>Zeitschaltuhr ZSU88I2C</th> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <th style=„font-size:20pt; text-align: center;“>Copyright: Peter Perl / 12.05.2017 / Version 2.1</th><tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <th style=„font-size:35pt; text-align: center;“>Wählen Sie das Verhalten der Ausgänge bei Systemstart oder Reboot aus</th><tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„text-align: center;“><input type=„submit“ style=„font-size:35pt; width:650px;“ name=„speichern“ value=„speichern“> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„text-align: center;“><input type=„button“ value=„Einstellungen anzeigen“ style=„font-size:35pt; width:650px;“ onClick=„self.location.href='ausgaenge- systemstart.php'“> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„text-align: center;“><input type=„button“ value=„Hauptmenü“ style=„font-size:35pt; width:650px;“ onClick=„self.location.href='zeitschaltuhr.php'“> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; color: blue; text-align: left;“> Ausgang 1: <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„aus_1“ name=„ausgang_1“ value=„aus_1“> aus <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„ein _1“ name=„ausgang_1“ value=„ein_1“> ein <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„letzter_1“ name=„ausgang_1“ value=„letzter_1“> letzter Zustand <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; color: blue; text-align: left;“> Ausgang 2: <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„aus_2“ name=„ausgang_2“ value=„aus_2“> aus <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„ein _2“ name=„ausgang_2“ value=„ein_2“> ein <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„letzter_2“ name="ausgang_2"value=„letzter_2“> letzter Zustand <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; color: blue; text-align: left;“> Ausgang 3: <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„aus_3“ name=„ausgang_3“ value=„aus_3“> aus <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„ein_3“ name=„ausgang_3“ value=„ein_3“> ein <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„letzter_3“ name=„ausgang_3“ value=„letzter_3“> letzter Zustand <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; color: blue; text-align: left;“> Ausgang 4: <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„aus_4“ name=„ausgang_4“ value=„aus_4“> aus <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„ein_4“ name=„ausgang_4“ value=„ein_4“> ein <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„letzter_4“ name=„ausgang_4“ value=„letzter_4“> letzter Zustand <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; color: blue; text-align: left;“> Ausgang 5: <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„aus_5“ name=„ausgang_5“ value=„aus_5“> aus <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„ein_5“ name=„ausgang_5“ value=„ein_5“> ein <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„letzter_5“ name=„ausgang_5“ value=„letzter_5“> letzter Zustand <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; color: blue; text-align: left;“> Ausgang 6: <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„aus_6“ name=„ausgang_6“ value=„aus_6“> aus <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„ein_6“ name=„ausgang_6“ value=„ein_6“> ein <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„letzter_6“ name=„ausgang_6“ value=„letzter_6“> letzter Zustand <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; color: blue; text-align: left;“> Ausgang 7: <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„aus_7“ name=„ausgang_7“ value=„aus_7“> aus <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„ein_7“ name=„ausgang_7“ value=„ein_7“> ein <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„letzter_7“ name=„ausgang_7“ value=„letzter_7“> letzter Zustand <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; color: blue; text-align: left;“> Ausgang 8: <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„aus_8“ name=„ausgang_8“ value=„aus_8“> aus <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„ein_8“ name=„ausgang_8“ value=„ein_8“> ein <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; text-align: left;“> <input type=„radio“ id=„letzter_8“ name=„ausgang_8“ value=„letzter_8“> letzter Zustand </table> </form> </body> </html>
ausgaenge-systemstart.php
ausgaenge-schalten.php
automatik-schaltkanal.php
kanal_ein-aus.php
ein-aus.php
ein-ausschaltzeit.php
Das PHP Script ist das dritte Script zur Programmierung einer Schaltzeit der elektronischen Zeitschaltuhr. Der Bediener gibt die Stunde 0-23 / * für jede Stunde, die Minute 0-59 / * für jede Minute, den Tag 1-31 / * für jeden Tag, den Monat 1-12 / * für jeden Monat und den Wochentag 1-7 / * für jeden Wochentag ein. Beim Wochentag sind auch bei der Eingabe ein Bindestrich (-) oder ein Komma (,) möglich, um einen Zeitraum von mehreren Wochentagen definieren zu können.
schalten-extern-Ox.php
Mit diesem Script gibt der Bediener vor, wie sich Ein- und Ausgänge verhalten sollen. Im Beispiel-Script stehen folgende Funktionen zur Verfügung:
- - Stromstoßschalter
- - Impulseingang mit elektromechanischen Relais und Wechselkontakt
- - Treppenlichtzeitschalter
- - keine Funktion
schalten-extern-lesen.php
Mit diesem Script wird dem Bediener angezeigt, welche Funktionen für die Eingänge Zugehörigen Ausgängen eingestellt sind.
<?php function kanal ($ch, $inhalt, $zeile, $v, $z, $status) { $ch = file(‚/var/www/htdocs/schalten-extern.txt‘); { unset($inhalt, $zeile); for ($v=0;$v<count($ch)+1;$v++) { // gesamte Datei in Variable $inhalt einlesen $inhalt .=„$ch[$v]“; } $zeile=explode(„\n“, $inhalt); // Array erzeugen - $zeile[0] ist der erste Eintrag usw. global $status; for ($z=0; $z <= 7; $z+=1) if ($zeile[$z] == „1“) {$status[$z] = „StromstoÄYschalter“; } elseif ($zeile[$z] == „2“) { $status[$z] = „Impulseingang mit elektromechanischen Relais und Wechselkontakt“; } elseif ($zeile[$z] == „3“) { $status[$z] = „Treppenlicht- Zeitschalter“; } elseif ($zeile[$z] == „0“) { $status[$z] = „keine Funktion“; } } } kanal(); ?> <html> <style> body { background-color: yellow; color: black; font:80px Arial; font-weight: bold; font-size: 120%; border: black 10px solid; } input[type=checkbox] { transform: scale(5); } </style> <style type=„text/css“> .Abfrage { color:#000000; font:80px Arial; font-size:80px; width: 750px; } </style> <title></title> <body onselectstart=„return false“ ondragstart=„return false“ oncontextmenu=„return false“ oncontext=„return false“> <form method=„post“> <table style=„width: 900px; text-align: left; margin-left: auto; margin-right: auto;“ border=„0“ cellpadding=„2“ cellspacing=„2“> <try> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <th style=„font-size:50pt; text-align: center;“>Zeitschaltuhr ZSU8812C</th> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <th style=„font-size:20pt; text-align: center;“>Copyright: Peter Perl / 26.11.2016 / Version 1.9</th><tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <th style=„font-size:35pt; text-align: center;“>Folgende Eingangsfunktionen sind festgelegt:</th><tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; color: black; text-align: left;“>Eingang 1: <font color=„#0000FF“><?php echo $status[0] ?> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; color: black; text-align: left;“>Eingang 2: <font color=„#0000FF“><?php echo $status[1] ?> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; color: black; text-align: left;“>Eingang 3: <font color=„#0000FF“><?php echo $status[2] ?> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; color: black; text-align: left;“>Eingang 4: <font color=„#0000FF“><?php echo $status[3] ?> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; color: black; text-align: left;“>Eingang 5: <font color=„#0000FF“><?php echo $status[4] ?> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; color: black; text-align: left;“>Eingang 6: <font color=„#0000FF“><?php echo $status[5] ?> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; color: black; text-align: left;“>Eingang 7: <font color=„#0000FF“><?php echo $status[6] ?> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„font-size:40pt; color: black; text-align: left;“>Eingang 8: <font color=„#0000FF“><?php echo $status[7] ?> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„text-align: center;“><input type=„button“ value=„zurück“ style=„font-size:35pt; width:650px;“ onClick=„history.go(-1);return true;“> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <tr></tr> <td style=„text-align: center;“><input type=„button“ value=„Hauptmenü“ style=„font-size:35pt; width:650px;“ onClick="self.location.href=‚zeitschaltuhr.php‘ "> </table> </form> </body> </html>
schaltzeiten_anzeigen.php
Das Script zeigt die programmierten Schaltzeiten an. Mit einem „sortieren“ Button lassen sich die Schaltzeiten chronologisch sortieren, damit diese auch in der richtigen Reihenfolge von der elektronischen Zeitschaltuhr abgearbeitet werden. Mit dem „übertragen“ Button werden die Schaltzeiten als Cronjob übergeben.
schaltzeiten_loeschen.php
Schaltzeit_anzeigen-uebertragen.php
Das PHP Script ist das vierte Script zur Programmierung einer Schaltzeit der elektronischen Zeitschaltuhr. Der Bediener kontrolliert die eingegebenen Daten und hat die Möglichkeit diese zu speichern (Zwischenspeicherung in die Datei schaltzeiten.txt) bevor diese noch sortiert werden müssen und schließlich als Cronjob übernommen werden. Sollte die Eingabe der Schaltzeit nicht korrekt sein, so hat der Bediener die Möglichkeit in die Scripte für die Eingaben einer Schaltzeit zurück zu kehren.
Beschreibung sonstige Scripte:
Die Scripte smbus.service und mosquito.service sind bereits weiter vorne beschrieben worden. Ansonsten finden noch folgende Scripte Anwendung:
dhtml.js
Das Java Script erzeugt eine laufende Datums- und Uhrzeitanzeige, die beliebig mit dem PHP Script „zeitschaltuhr.php“ per Eingabe oder durch einen angeschlossenen GPS-Empfänger und/oder der internen Echtzeituhr formatiert werden kann. Umgesetzt wird das Ganze durch eine eingebundene DHTML-Bibliothek. Der zugehörige HTML-Teil befindet sich im PHP Script „zeitschaltuhr.php“.
/* DHTML-Bibliothek */ var DHTML = false, DOM = false, MSIE4 = false, NS4 = false, OP = false; if (document.getElementById) { DHTML = true; DOM = true; } else { if (document.all) { DHTML = true; MSIE4 = true; } else { if (document.layers) { DHTML = true; NS4 = true; } } } if (window.opera) { OP = true; } function getElement (Mode, Identifier, ElementNumber) { var Element; if (DOM) { if (Mode.toLowerCase() == „id“) { if (typeof document.getElementById(Identifier) == "object") { Element = document.getElementById(Identifier); } else { Element = false; } return Element; } if (Mode.toLowerCase() == „name“) { var ElementList = document.getElementsByName(Identifier); if (typeof ElementList == „object“ | | (OP && typeof ElementList == „function“)) { Element = ElementList[ElementNumber]; } else { Element = false; } return Element; } if (Mode.toLowerCase() == „tagname“) { var ElementList = document.getElementsByTagName(Identifier); if (typeof ElementList == „object“ | | (OP && typeof ElementList == „function“)) { Element = ElementList[ElementNumber]; } else { Element = false; } return Element; } return null; } if (MSIE4) { if (Mode.toLowerCase() == „id“) { if (typeof document.all[Identifier] == „object“) { Element = document.all[Identifier]; } else { Element = false; } return Element; } if (Mode.toLowerCase() == „tagname“) { if (typeof document.all.tags(Identifier) == „object“) { Element = document.all.tags(Identifier)[ElementNumber]; } else { Element = false; } return Element; } if (Mode.toLowerCase() == „name“) { if (typeof document[Identifier] == „object“) { Element = document[Identifier]; } else { Element = false; } return Element; } return false; } if (NS4) { if (Mode.toLowerCase() == „id“ | | Mode.toLowerCase() == "name") { if (typeof document[Identifier] == „object“) { Element = document[Identifier]; } else { Element = false; } return Element; } if (Mode.toLowerCase() == „index“) { if (typeof document.layers[Identifier] == „object“) { Element = document.layers[Identifier]; } else { Element = false; } return Element; } return false; } return false; } function getContent (Mode, Identifier, ElementNumber) { var Content; var Element = getElement(Mode, Identifier, ElementNumber); if (!Element) { return false; } if (DOM && Element.firstChild) { if (Element.firstChild.nodeType == 3) { Content = Element.firstChild.nodeValue; } else { Content = „ “; } return Content; } if (MSIE4) { Content = Element.innerText; return Content; } return false; } function getAttribute (Mode, Identifier, ElementNumber, AttributeName) { var Attribute; var Element = getElement(Mode, Identifier, ElementNumber); if (!Element) { return false; } if (DOM | | MSIE4) { Attribute = Element.getAttribute(AttributeName); return Attribute; } if (NS4) { if (typeof Element[ElementNumber] == „object“) { Attribute = Element[ElementNumber][AttributeName]; } else { Attribute = Element[AttributeName] } return Attribute; } return false; } function setContent (Mode, Identifier, ElementNumber, Text) { var Element = getElement(Mode, Identifier, ElementNumber); if (!Element) { return false; } if (DOM && Element.firstChild) { Element.firstChild.nodeValue = Text; return true; } if (MSIE4) { Element.innerText = Text; return true; } if (NS4) { Element.document.open() ; Element.document.write(Text) ; Element.document.close() ; return true; } }
Eth0_down.sh
Das Bash Script besteht lediglich aus zwei Zeilen und kann dazu verwendet werden, die Ethernetschnittstelle bedarfsweise ausser Funktion zu setzen. Dies kann z.B. gewünscht sein, um den Sicherheitsstandard der elektronischen Zeitschaltuhr zu erhöhen, da die Zeitschaltuhr auch ohne LAN / www voll funktionsfähig bleibt. Das Script kann zum Beispiel als Cronjob bei jedem Systemstart ausgeführt werden. Der Cronjob zur Ausführung dieses Bash Scripts kann in die GUI des Web Interfaces integriert werden.
#!/bin/bash sudo ip link set eth0 down
Textdateien, die zur Speicherung von Zuständen verwendet werden:
- Die in den Textdateien gespeicherten Werte sind Binärzahlen (1/0), in der Regel als 8 Bit zeilenweise abgespeichert oder als Dezimalwert, der einen Byte entspricht, abgespeichert. Die gespeicherten Werte werden von verschiedenen Scripten geschrieben und gelesen um untereinander interaktiv operieren zu können.
Bezugszeichenliste
- 1.1, 1.2
- Computer-Zeitschaltuhr
- 2
- Stift- oder Buchsenleiste, 40-polig
- 3
- Platine für Ein- und Ausgänge
- 4
- Echtzeituhrmodul
- 5.1, 5.2
- Ein-/Ausgangsports
- 6.1
- DALI-Master-Modul
- 6.2
- Pegelwandler
- 7
- Einplatinencomputer
- 8
- USV Platine mit Weitbereichsspannungseingang
- 9
- GPIO Ports
- A0, A1, A2
- I2C-Adressierung
- K1 bis K35
- Printklemmenanschlüsse
Claims (10)
- Elektronische Zeitschaltuhr (1.1, 1.2) bestehend aus einem Einplatinencomputer (7), einer USV-Platine mit Weitbereichsspannungseingang (8), einem Pegelwandler (6.2), einem Echtzeituhrmodul (4), Ein-/Ausgangsports bestehend aus einem 16-Bit Port-Expander und einer Treiberstufe (5.1, 5.2), einer 40-poligen Stift- und Buchsenleiste (2), einer I2C-Bus-Adressierung (A0, A1, A2) angeordnet auf einer Ein- und Ausgangsplatine (3), einer Funkantenne mit einem Funksender und einem Funkempfänger und einem DALI-Mastermodul (6.1), wobei die elektronische Zeitschaltuhr (1.1, 1.2) einen Wireless-Access-Point ausbildet, wobei die elektronische Zeitschaltuhr (1.1, 1.2) auf ein auf dem Einplatinencomputer (7) lauffähiges, auf einer Speichereinheit abgespeichertes, eigenes Betriebssystem zugreift, das die Grundfunktionen der elektronischen Zeitschaltuhr (1.1, 1.2) und die Zugriffe auf externe und interne Daten bereitstellt und eine eigene GUI bzw. ein Web-Interface aufweist, wobei die elektronische Zeitschaltuhr (1.1, 1.2) ein Gehäuse besitzt, das von zwei zusammensteckbaren Gehäuseschalen gebildet ist dadurch gekennzeichnet, dass eine der Gehäuseschalen auf einer HUT-Schiene angeordnet ist, wobei auf einer Ein- und Ausgangsplatine (3) innerhalb des Gehäuses fünfunddreißig Printklemmen (K1 bis K35) zur Bereitstellung von Ein- und Ausgängen, seriellen Schnittstellen und Busanschlüssen angeordnet sind und wobei das Gehäuse ein DIN-Hutschienenleergehäuse mit integriertem Schnappfuß ist und die Innenseiten des Gehäuses mit einem EMV-Schutzlack überzogen sind.
- Elektronische Zeitschaltuhr (1.1, 1.2) nach
Patentanspruch 1 , dadurch gekennzeichnet, dass die elektronische Zeitschaltuhr (1.1, 1.2) via WLAN mit WPA2-Verschlüsselung kommuniziert und als DHCP-Server IP-Adressen für Clients vergibt. - Elektronische Zeitschaltuhr (1.1, 1.2) nach
Patentanspruch 1 oder2 , dadurch gekennzeichnet, dass die elektronische Zeitschaltuhr (1.1, 1.2) mindestens eine UART-Schnittstelle und mindestens eine SPI-Schnittstelle und/oder eine Schnittstelle zum Anschluss eines GPS-Empfängers, und/oder eine Schnittstelle zum Anschluss eines Funksende/- empfangsmoduls und/oder eine KNX-Busschnittstelle und/oder eine I2C-Busschnittstelle und/oder eine CAN-Busschnittstelle und/oder mindestens zwei USB-Port-Anschlüsse zur Speichererweiterung und/oder eine HDMI-Schnittstelle zur Ausgabe von Audio- und/oder Videosignalen aufweist. - Elektronische Zeitschaltuhr (1.1, 1.2) nach einem der vorangehenden Patentansprüche, dadurch gekennzeichnet, dass der Einplatinencomputer (7) als Mastergerät betreibbar ist.
- Elektronische Zeitschaltuhr (1.1, 1.2) nach einem der vorangehenden Patentansprüche, dadurch gekennzeichnet, dass der Einplatinencomputer (7) als Embedded-System realisiert ist.
- Elektronische Zeitschaltuhr (1.1, 1.2) nach einem der vorangehenden Patentansprüche, dadurch gekennzeichnet, dass die elektronische Zeitschaltuhr (1.1, 1.2) einen Hardware-Watchdogdienst zur permanenten Systemüberwachung besitzt.
- Elektronische Zeitschaltuhr (1.1, 1.2) nach einem der vorangehenden Patentansprüche, dadurch gekennzeichnet, dass von der elektronischen Zeitschaltuhr (1.1, 1.2) als DALI-Master autonom DALI-Betriebsgeräte zeitsteuerbar sind und/oder diese manuell via angeschlossene Taster ansteuerbar sind, wobei die Anzahl von DALI-Kanälen der elektronischen Zeitschaltuhr (1.1, 1.2) erweiterbar sind.
- Elektronische Zeitschaltuhr (1.1, 1.2) nach einem der vorangehenden Patentansprüche, dadurch gekennzeichnet, dass durch die elektronische Zeitschaltuhr (1.1, 1.2) herkömmliche Fernschalter als Stromstoßschalter, Treppenlichtschalter und alle Arten von Multifunktionsrelais ersetzbar sind, indem an den Eingängen Taster mit Schließer- und/oder, Öffner- und/oder Wechselkontakten und an den Ausgängen externe Solid-State-Relais und/oder halbelektronische bistabile Relais und/oder Schütze mit 24 V DC-Versorgungsspannung angeschlossen sind.
- Elektronische Zeitschaltuhr (1.1, 1.2) nach einem der vorangehenden Patentansprüche, dadurch gekennzeichnet, dass durch die elektronische Zeitschaltuhr (1.1, 1.2) durch Anschluss von Tastern mit Schließer- und/oder, Öffner- und/oder Wechselkontakten manuell und/oder automatisch zeitgesteuert Audio- und/oder Videosignale über einen HDMI-Ausgang zu- oder abschaltbar sind, die auszugebende Lautstärke regulierbar und/oder alle weiteren Bedienfunktionen eines in der elektronischen Zeitschaltuhr (1.1, 1.2) implementierten Multimediaplayers bereitstellbar sind.
- Elektronische Zeitschaltuhr (1.1, 1.2) nach einem der vorangehenden Patentansprüche, dadurch gekennzeichnet, dass die elektronische Zeitschaltuhr (1.1, 1.2) mit externen netzwerkfähigen Geräten, auch WIFI-Mikrokontrollern, via WLAN bidirektional kommuniziert.
Priority Applications (1)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
DE102017116258.5A DE102017116258B4 (de) | 2017-07-19 | 2017-07-19 | Computer-Zeitschaltuhr |
Applications Claiming Priority (1)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
DE102017116258.5A DE102017116258B4 (de) | 2017-07-19 | 2017-07-19 | Computer-Zeitschaltuhr |
Publications (2)
Publication Number | Publication Date |
---|---|
DE102017116258A1 DE102017116258A1 (de) | 2019-01-24 |
DE102017116258B4 true DE102017116258B4 (de) | 2021-03-25 |
Family
ID=64951749
Family Applications (1)
Application Number | Title | Priority Date | Filing Date |
---|---|---|---|
DE102017116258.5A Active DE102017116258B4 (de) | 2017-07-19 | 2017-07-19 | Computer-Zeitschaltuhr |
Country Status (1)
Country | Link |
---|---|
DE (1) | DE102017116258B4 (de) |
Families Citing this family (1)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
EP4127865A1 (de) * | 2020-04-03 | 2023-02-08 | Cautech Mühendislik Ve Bilisim Sanayi Ticaret Limited Sirketi | Integration einer unterbrechungsfreien stromversorgung mit himbeer-pi |
-
2017
- 2017-07-19 DE DE102017116258.5A patent/DE102017116258B4/de active Active
Non-Patent Citations (6)
Title |
---|
Benutzerhandbuch S.USV pi solutions, Olmatic GmbH, Nagold, Revision 2.0 15.03.2017 URL: https://www.s-usv.de/files/pdf/SUSV_Manual_Rev2_0_GER.pdf [abgerufen am 10.4.2018] * |
Communication in building automation, Siemens Switzerland, 2014 URL: http://www.siemens.com/bt/file?soi=A6V10209534 [abgerufen am 10.4.2018] * |
HEIK, Andreas: WLAN-Accesspoint mit dem Raspberry Pi, 2013, URL: https://www-user.tu-chemnitz.de/~anhe/VORTRAG/RASPI_WLAN/raspi_wlan.pdf [abgerufen am 9.4.2018] * |
Mehr-Kanal-Zeitschaltuhr (PIPS - Pi-Power Switch). URL: https://www.raspberrypi.org/forums/viewtopic.php?t=72302 [abgerufen am 9.4.2018] * |
PiPS - der etwas andere π -Power-Switch. aufgerufen über URL: http://pips.tgd-consulting.de/index.cgi [abgerufen am 6.4.2018] * |
PiPS-It! Management Software Release Notes. URL: http://www.tgd-consulting.de/ChangeLog-PiPSIt-ReleaseNotes.txt [abgerufen am 6.4.2018] * |
Also Published As
Publication number | Publication date |
---|---|
DE102017116258A1 (de) | 2019-01-24 |
Similar Documents
Publication | Publication Date | Title |
---|---|---|
Dickey et al. | Home automation using Cloud Network and mobile devices | |
US7822934B2 (en) | Multipurpose semiconductor integrated circuit device | |
DE60019750T2 (de) | Allgemeines api zur gerätefernsteuerung | |
CN105187266B (zh) | 信息监控方法和装置 | |
DE112013005104T5 (de) | Hochleistungsverdrahtungs-Bitübertragungsschicht | |
US20140266592A1 (en) | Network gateway system and method | |
US20190034195A1 (en) | Systems and methods for providing patchable rom firmware | |
US10833914B2 (en) | Device or vendor independent network switch management via embedded management controller stack | |
Yamanoue et al. | A m2m system using arduino, android and wiki software | |
DE102017116258B4 (de) | Computer-Zeitschaltuhr | |
DE102008048649A1 (de) | System und Verfahren zum Synchronisieren einer simultanen Medienstromwiedergabe über nichtsynchronisierte Netzsynchronisations-/-Taktinseln | |
Joshi et al. | IOT application for real-time monitor of PLC data using EPICS | |
CN106850418A (zh) | 一种智能家居网络的网关 | |
DE102020113964A1 (de) | Elektronische peripheriegeräte mit synchronisiertenenergiemodi | |
Machidon et al. | Remote SoC/FPGA platform configuration for cloud applications | |
CN104360983A (zh) | 一种兼容HTML5的Web网络单片机 | |
CN105049338B (zh) | 一种基于即时通讯的智能设备的接口生成方法和装置 | |
Hanafi et al. | Embedded web server for real-time remote control and monitoring of an FPGA-based on-board computer system | |
Wright et al. | Internet of Things in the Cloud | |
CN112953947A (zh) | 一种单片机安全网关的单向数据透明传输方法 | |
CN105630492B (zh) | 一种应用的周期任务封装的方法以及装置 | |
CN103929671A (zh) | 一种机顶盒定时录制方法及系统 | |
Duval et al. | Common Device Interface 2.0 | |
SS et al. | Smart Home Automation System | |
Reuter | Case study: building an out of the box Raspberry Pi modular synthesizer |
Legal Events
Date | Code | Title | Description |
---|---|---|---|
R012 | Request for examination validly filed | ||
R016 | Response to examination communication | ||
R016 | Response to examination communication | ||
R018 | Grant decision by examination section/examining division | ||
R020 | Patent grant now final |