FHEMWiki - Benutzerbeiträge [de]

TRAFFIC

2018-09-07T07:44:17Z

Jmike: Google pricing Hinweis hinzugefügt

{{Infobox Modul
|ModPurpose=Verkehrsdaten zu fest definierten Routen ermitteln
|ModType=d
|ModForumArea=Unterstützende Dienste
|ModTechName=98_TRAFFIC.pm
|ModOwner=jmike ({{Link2Forum|Topic=56045|LinkText=Forum}} / [[Benutzer:Jmike|Wiki]])
}}

Dieses Modul erfasst Fahrzeiten in aktueller Verkehrslage mittels Google Maps Directions API.

== Features / Funktionen ==
* Distanz einer Route
* Fahrzeit ohne Verkehr
* Fahrzeit mit Verkehr
* Verzögerung der geplanten Route
* Waypoints definieren
* Ausgabesprache festlegen
* Outputs in Sekunden / Meter (raw)
* Ausgabe als Text, in Minuten, Sekunden oder als Durchschnitt
* Device STATE frei wählbar
* einstellbares Update Interval
* update-burst für Stosszeiten
* Strecke kann zusätzlich in gegengesetzte Richtung ausgelesen werden
* Ankunfszeit bei Abfahrt zum Update-Zeitpunkt
* verschiedene Travel Modes (driving, walking, bicycling und transit)
* flexibler Update Schedule für Stosszeiten
* integrierte, konfigurierbare Google Map zum Visualisieren der konfigurierten Route
* Kurzbeschreibung der Alternativen Routen und Anzeige auf der Karte (optional)
* DBLog Integration

== Voraussetzungen ==
Erstmal muss ein eigener API Key angefordert werden.
Das geht über Googles [https://console.developers.google.com/apis/ API Manager] 
Dort "Google Maps Directions API" suchen und ein neues Projekt erstellen, anschliessend API aktivieren.
Für die Karte ist zusätzlich der "Google Maps JavaScript API" notwendig und sollte an dieser Stelle auch aktiviert werden.

[[Wichtig!]]
Google stellt die API nicht mehr unbegrenzt kostenlos zur Verfügung (https://cloud.google.com/maps-platform/pricing/) sondern nur noch über ein gratis Kontingent, welches derzeit 300€ auf 365 Tage ist. Ist das Kontingent aufgebraucht, werden die Abfragen Seitens Google gedrosselt (bis zu 1x pro Tag) solange man keine kostenpflichtige Abrechnung einrichtet. 
Weiteres dazu im Foreneintrag ab hier: https://forum.fhem.de/index.php/topic,56045.msg830728.html#msg830728
 

Je nach FHEM Installation zusätzlich die Perl Module LWP::Simple, JSON und MIME::Base64 nach installieren: 
<code>sudo apt-get install libwww-perl</code> 
<code>sudo apt-get install libjson-perl</code> 
oder 
<code>sudo cpan -i LWP::Simple</code> 
<code>sudo cpan -i JSON</code> 
<code>sudo cpan -i MIME::Base64</code>

== Definition ==
<code> define <devicename> TRAFFIC <API-KEY> [update-interval] </code>

'''Beispiel:''' 
<code>define muc2berlin TRAFFIC ABCDEFGHIJKLMNOPQRSTVWYZ 600</code>

Der API Key muss selbstverständlich mit dem eigenen Key aus dem API Manager ersetzt werden. 
Das Intervall in Sekunden ist optional, der default beträgt 3600 (1 Stunde). 
Attribute start_address und end_address definieren.

== Readings ==
* [alternatives]
* average_delay_min
* average_duration_in_traffic_min
* average_duration_min
* delay
* delay_min
* distance
* duration
* duration_in_traffic
* duration_in_traffic_min
* duration_in_traffic_sec
* duration_min
* duration_sec
* [error_message]
* eta
* state
* status
* summary

== Befehle ==

==== update [burst-update-count] [burst-update-interval] ====
Readings manuell aktualisieren, der optionale Burst kann wie folgt genutzt werden: 
- erster Wert gibt an wie viele Updates abgearbeitet werden 
- zweiter Wert gibt an wie viele Sekunden zwischen den Updates gewartet wird 

Beispiel um für 1 Stunde alle 5 Minuten zu aktualisieren: 
<code>set <device> update 12 300</code>

== STATE ==
* Initialized - modul initialisiert
* OK - update war erfolgreich
* incomplete configuration - Konfigurationsfehler (start_address oder end_address leer)
* <APIRETURN> - Fehlermeldung von Google Maps, falls vorhanden (siehe Reading error_message)
* <Reading> - der Wert des Readings welches mit Attribut stateReading ausgewählt wurde
* disabled - das Device wurde über das Attribut disable deaktiviert

== Attribute ==

{| class="wikitable"
!Attribut
!Default Wert
!mögliche Werte
!Beschreibung
!Beispiel
|-
!align="right" |start_address
|
|<text>
|die vollständige Startadresse (erforderlich!)
|Startstr 1, 12345 Startcity
|-
!align="right" |end_address
|
|<text>
|die vollständige Zieladresse (erforderlich!)
|Zielstr 99, 99099 Zielstadt
|-
!align="right" |raw_data
|0
|0:1
|legt Readings an mit allen unbearbeiteten Werten
|
|-
!align="right" |language
|
|de, en, etc.
|Google ermittelt die Sprache automatisch, falls nicht fest definiert
|de
|-
!align="right" |waypoints
|
|lat, long<nowiki>|</nowiki>lat, long
|fixe Wegpunkte auf der Strecke, mehrere Werte per pipe <nowiki>(|)</nowiki> trennen, LAT, LONG Koordinaten angeben
|48.187918, 11.590514
|-
!align="right" |returnWaypoints
|
|lat, long<nowiki>|</nowiki>lat, long
|fixe Wegpunkte für den Rückweg, mehrere Werte per pipe <nowiki>(|)</nowiki> trennen, LAT, LONG Koordinaten angeben, wenn leer werden "waypoints" in umgekehrter Reihenfolge verwendet
|48.187918, 11.590514
|-
!align="right" |disable
|0
|0:1
|Modul deaktivieren
|1
|-
!align="right" |stateReading
|
|<beliebiges-Reading>
|Name eines Readings, dessen Wert in den STATE des Devices geschrieben wird
|delay_min
|-
!align="right" |outputReadings
|text
|text,min,sec,average
|Konfiguration, welche Readings erstellt werden sollen, eine oder mehrere möglich
|text min
|-
!align="right" |includeReturn
|0
|0:1
|aktiviert/deaktiviert, ob die gleiche Strecke in umgekehrter Richtung hinzugefügt werden soll Readings werden mit return_* angegeben
|1
|-
!align="right" |verbose
|1
|0:1:2:3:4:5
|gibt vor, wie ausführlich geloggt wird
|5
|-
!align="right" |travelMode
|driving
|driving:walking:bicycling:transit
|Fortbewegungsmethode für Kalkulation
|walking
|-
!align="right" |updateSchedule
|
|<Beginn-volle-Stunde>-<Ende-volle-Stunde> [<Tag>] <update-Intervall-in-Sekunden>
|definiert einen flexiblen Zeitraum für feinere Updates, Tag als Zahl (Sonntag 0, Montag 1 etc.), mehrere Definitionen per <nowiki>(|)</nowiki> getrennt
| 6-8 1 60|6-8 2 60|6-8 3 60|6-8 4 60|6-8 5 60
|-
!align="right" |GoogleMapsStyle
|default
|default,silver,dark,night
|definiert einen der vorgegebenen Map Styles
|dropdown
|-
!align="right" |GoogleMapsSize
|800,600
|<Breite>,<Höhe>
|definiert die Breite und Höhe der Karte
| 600,300
|-
!align="right" |GoogleMapsCenter
|auto-generiert
|<lat>,<lang>
|definiert den Mittelpunkt der Karte
| 48.2322157,11.6867434
|-
!align="right" |GoogleMapsZoom
|10
|<Zoom wert>
|definiert den Zoom Wert der Karte
| 14
|-
!align="right" |GoogleMapsStroke
|#4cde44,6,100,#FF0000,1,100
|<#-6-digit-hex-code>,[<weight>[,<opacity>],]<#-6-digit-hex-code>,[<weight>,[<opacity>]]
|definiert die Farbe der Wegstrecken im HEX Format, Dicke der Linie und Transparenz. Getrennte Angabe von Hin- und Rückweg sind möglich.
| #019cdf,#ffeb19 #019cdf,15,50,#ffeb19,15,50 #019cdf,20,80,#ffeb19
|-
!align="right" |GoogleMapsTrafficLayer
|0
|0:1
|schaltet den Standard Google Maps Traffic Overlay ein/aus
| 1
|-
!align="right" |GoogleMapsDisableUI
|0
|0:1
|Dropdown um die Map Controls zu deaktivieren
| 1
|-
!align="right" |GoogleMapsFixedMap
|0
|0:1
|verhindert das verschieben/zoomen der Karte
| 1
|-
!align="right" | alternatives
|0
|0:1
|aktiviert das Reading alternatives, welches Alternative Routen (Kurzbeschreibung + Wegzeit) anzeigt
| 1
|-
|}

== Integrierte Karte ==
* Zum Überprüfen der verwendeten Wegstrecke können der Hin- und Rückweg für ein TRAFFIC-Device auf einer Karte angezeigt werden.
* Um die Karte anzuzeigen einfach oben auf "toggle Map" klicken
* Für Einbindung in andere Anwendungen (TabletUI z.b) kann die Karte zusätzlich über den eingeblendeten Link erreicht werden: <nowiki>http://fhem-ip:port/fhem/TRAFFIC?name=<TRAFFIC-DEVICE></nowiki>
* Karte anpassen:
** Die Karte lässt sich über folgende Attribute anpassen:
** GoogleMapsStyle, GoogleMapsSize, GoogleMapsCenter, GoogleMapsZoom, GoogleMapsStroke, GoogleMapsTrafficLayer und GoogleMapsFixedMap
** GoogleMapsZoom und GoogleMapsCenter können direkt in der Kartenansicht gespeichert werden. Dazu die Karte verschieben/zoomen und anschliessend auf die Buttons "save Zoom" bzw. "save Center" klicken
** weitere Beispiele bitte dem Forum entnehmen

== Bekannte Probleme ==
* STATE: "REQUEST DENIED"
* Reading error_message: "This API project is not authorized to use this API"
** => API Key ist nicht aktiviert. Google API > API Manager > Google Maps Directions API > AKTIVIEREN

* STATE: "UNKNOWN_ERROR"
** => Es liegt ein Fehler bei Google vor.
** => "UNKNOWN_ERROR indicates a directions request could not be processed due to a server error. The request may succeed if you try again." [https://developers.google.com/maps/documentation/javascript/directions?hl=de]

* STATE: "OVER_QUERY_LIMIT"
** Es wurden mehr als 2500 requests pro Tag abgesetzt. Abhilfe: Update Intervalle der TRAFFIC Devices erhöhen und "burst" zu den Stosszeiten nutzen.

* STATE: "ZERO_RESULTS"
** Die Waypoint Definition kann Google nicht realisieren. Statt Städtenamen besser exakte Koordinaten verwenden.

* Karte zeigt nur ein graues Bild "Ops..."
** checkt eure Javascript Konsole nach dem exakten Fehler
** Google Maps API error: ApiNotActivatedMapError https://developers.google.com/maps/documentation/javascript/error-messages#api-not-activated-map-error
** => Google Maps JavaScript API aktivieren

== Tips ==
* täglicher Burst Update zum Feierabend, 1 Stunde alle 5 Minuten updaten:
** <code>define FeierabendCheck AT *17:00 set <device> update 12 300</code>

* komplette Reisezeit, also Hin- und Rückweg, im STATE anzeigen:
** <code>attr <device> stateFormat {int(ReadingsVal($name,"delay_min",0)) + int(ReadingsVal($name,"return_delay_min",0))}</code>

* updateSchedule einsetzen um default update Intervall zu verfeinern
** Montag bis Freitag von 6 bis 8 Uhr alle 60 Sekunden
** <code>attr <device> updateSchedule 6-8 1 60|6-8 2 60|6-8 3 60|6-8 4 60|6-8 5 60</code>
** jeden Tag von 17 bis 19 Uhr alle 2 Minuten
** <code>attr <device> updateSchedule 17-19 120</code>

* Waypoints definieren (Tip von erdo_king)
** In Google-Maps die gewünschte Route auswählen (am PC)
** Auf eine signifikante Stelle der Route klicken - hierbei auf die Fahrtrichtung achten!
** Hier auf die Koordinaten klicken, diese können dann aus dem Suchfeld kopiert werden
** Im Browser zurückgehen, bis die Route wieder sichtbar ist (zum späteren Datenabgleich)
** Waypoints in FHEM deklarieren, Daten aktualisieren (set <device> update)
** distance + duration mit den Daten von Google-Maps am PC abgleichen

== to Do ==
* deutsche Commandref

== Weblinks ==
* {{Link2Forum|Topic=56045|LinkText=Modul Vorstellung und Diskussionen}}
* {{Link2CmdRef|Anker=#TRAFFIC}}
* [https://console.developers.google.com/apis Google API Manager]

TRAFFIC

2018-01-26T09:00:36Z

Jmike: update für version 1.3.3

{{Infobox Modul
|ModPurpose=Verkehrsdaten zu fest definierten Routen ermitteln
|ModType=d
|ModForumArea=Unterstützende Dienste
|ModTechName=98_TRAFFIC.pm
|ModOwner=jmike ({{Link2Forum|Topic=56045|LinkText=Forum}} / [[Benutzer:Jmike|Wiki]])
}}

Dieses Modul erfasst Fahrzeiten in aktueller Verkehrslage mittels Google Maps Directions API.

== Features / Funktionen ==
* Distanz einer Route
* Fahrzeit ohne Verkehr
* Fahrzeit mit Verkehr
* Verzögerung der geplanten Route
* Waypoints definieren
* Ausgabesprache festlegen
* Outputs in Sekunden / Meter (raw)
* Ausgabe als Text, in Minuten, Sekunden oder als Durchschnitt
* Device STATE frei wählbar
* einstellbares Update Interval
* update-burst für Stosszeiten
* Strecke kann zusätzlich in gegengesetzte Richtung ausgelesen werden
* Ankunfszeit bei Abfahrt zum Update-Zeitpunkt
* verschiedene Travel Modes (driving, walking, bicycling und transit)
* flexibler Update Schedule für Stosszeiten
* integrierte, konfigurierbare Google Map zum Visualisieren der konfigurierten Route
* Kurzbeschreibung der Alternativen Routen und Anzeige auf der Karte (optional)
* DBLog Integration

== Voraussetzungen ==
Erstmal muss ein eigener API Key angefordert werden.
Das geht über Googles [https://console.developers.google.com/apis/ API Manager] 
Dort "Google Maps Directions API" suchen und ein neues Projekt erstellen, anschliessend API aktivieren.
Für die Karte ist zusätzlich der "Google Maps JavaScript API" notwendig und sollte an dieser Stelle auch aktiviert werden.

Je nach FHEM Installation zusätzlich die Perl Module LWP::Simple, JSON und MIME::Base64 nach installieren: 
<code>sudo apt-get install libwww-perl</code> 
<code>sudo apt-get install libjson-perl</code> 
oder 
<code>sudo cpan -i LWP::Simple</code> 
<code>sudo cpan -i JSON</code> 
<code>sudo cpan -i MIME::Base64</code>

== Definition ==
<code> define <devicename> TRAFFIC <API-KEY> [update-interval] </code>

'''Beispiel:''' 
<code>define muc2berlin TRAFFIC ABCDEFGHIJKLMNOPQRSTVWYZ 600</code>

Der API Key muss selbstverständlich mit dem eigenen Key aus dem API Manager ersetzt werden. 
Das Intervall in Sekunden ist optional, der default beträgt 3600 (1 Stunde). 
Attribute start_address und end_address definieren.

== Readings ==
* [alternatives]
* average_delay_min
* average_duration_in_traffic_min
* average_duration_min
* delay
* delay_min
* distance
* duration
* duration_in_traffic
* duration_in_traffic_min
* duration_in_traffic_sec
* duration_min
* duration_sec
* [error_message]
* eta
* state
* status
* summary

== Befehle ==

==== update [burst-update-count] [burst-update-interval] ====
Readings manuell aktualisieren, der optionale Burst kann wie folgt genutzt werden: 
- erster Wert gibt an wie viele Updates abgearbeitet werden 
- zweiter Wert gibt an wie viele Sekunden zwischen den Updates gewartet wird 

Beispiel um für 1 Stunde alle 5 Minuten zu aktualisieren: 
<code>set <device> update 12 300</code>

== STATE ==
* Initialized - modul initialisiert
* OK - update war erfolgreich
* incomplete configuration - Konfigurationsfehler (start_address oder end_address leer)
* <APIRETURN> - Fehlermeldung von Google Maps, falls vorhanden (siehe Reading error_message)
* <Reading> - der Wert des Readings welches mit Attribut stateReading ausgewählt wurde
* disabled - das Device wurde über das Attribut disable deaktiviert

== Attribute ==

{| class="wikitable"
!Attribut
!Default Wert
!mögliche Werte
!Beschreibung
!Beispiel
|-
!align="right" |start_address
|
|<text>
|die vollständige Startadresse (erforderlich!)
|Startstr 1, 12345 Startcity
|-
!align="right" |end_address
|
|<text>
|die vollständige Zieladresse (erforderlich!)
|Zielstr 99, 99099 Zielstadt
|-
!align="right" |raw_data
|0
|0:1
|legt Readings an mit allen unbearbeiteten Werten
|
|-
!align="right" |language
|
|de, en, etc.
|Google ermittelt die Sprache automatisch, falls nicht fest definiert
|de
|-
!align="right" |waypoints
|
|lat, long<nowiki>|</nowiki>lat, long
|fixe Wegpunkte auf der Strecke, mehrere Werte per pipe <nowiki>(|)</nowiki> trennen, LAT, LONG Koordinaten angeben
|48.187918, 11.590514
|-
!align="right" |returnWaypoints
|
|lat, long<nowiki>|</nowiki>lat, long
|fixe Wegpunkte für den Rückweg, mehrere Werte per pipe <nowiki>(|)</nowiki> trennen, LAT, LONG Koordinaten angeben, wenn leer werden "waypoints" in umgekehrter Reihenfolge verwendet
|48.187918, 11.590514
|-
!align="right" |disable
|0
|0:1
|Modul deaktivieren
|1
|-
!align="right" |stateReading
|
|<beliebiges-Reading>
|Name eines Readings, dessen Wert in den STATE des Devices geschrieben wird
|delay_min
|-
!align="right" |outputReadings
|text
|text,min,sec,average
|Konfiguration, welche Readings erstellt werden sollen, eine oder mehrere möglich
|text min
|-
!align="right" |includeReturn
|0
|0:1
|aktiviert/deaktiviert, ob die gleiche Strecke in umgekehrter Richtung hinzugefügt werden soll Readings werden mit return_* angegeben
|1
|-
!align="right" |verbose
|1
|0:1:2:3:4:5
|gibt vor, wie ausführlich geloggt wird
|5
|-
!align="right" |travelMode
|driving
|driving:walking:bicycling:transit
|Fortbewegungsmethode für Kalkulation
|walking
|-
!align="right" |updateSchedule
|
|<Beginn-volle-Stunde>-<Ende-volle-Stunde> [<Tag>] <update-Intervall-in-Sekunden>
|definiert einen flexiblen Zeitraum für feinere Updates, Tag als Zahl (Sonntag 0, Montag 1 etc.), mehrere Definitionen per <nowiki>(|)</nowiki> getrennt
| 6-8 1 60|6-8 2 60|6-8 3 60|6-8 4 60|6-8 5 60
|-
!align="right" |GoogleMapsStyle
|default
|default,silver,dark,night
|definiert einen der vorgegebenen Map Styles
|dropdown
|-
!align="right" |GoogleMapsSize
|800,600
|<Breite>,<Höhe>
|definiert die Breite und Höhe der Karte
| 600,300
|-
!align="right" |GoogleMapsCenter
|auto-generiert
|<lat>,<lang>
|definiert den Mittelpunkt der Karte
| 48.2322157,11.6867434
|-
!align="right" |GoogleMapsZoom
|10
|<Zoom wert>
|definiert den Zoom Wert der Karte
| 14
|-
!align="right" |GoogleMapsStroke
|#4cde44,6,100,#FF0000,1,100
|<#-6-digit-hex-code>,[<weight>[,<opacity>],]<#-6-digit-hex-code>,[<weight>,[<opacity>]]
|definiert die Farbe der Wegstrecken im HEX Format, Dicke der Linie und Transparenz. Getrennte Angabe von Hin- und Rückweg sind möglich.
| #019cdf,#ffeb19 #019cdf,15,50,#ffeb19,15,50 #019cdf,20,80,#ffeb19
|-
!align="right" |GoogleMapsTrafficLayer
|0
|0:1
|schaltet den Standard Google Maps Traffic Overlay ein/aus
| 1
|-
!align="right" |GoogleMapsDisableUI
|0
|0:1
|Dropdown um die Map Controls zu deaktivieren
| 1
|-
!align="right" |GoogleMapsFixedMap
|0
|0:1
|verhindert das verschieben/zoomen der Karte
| 1
|-
!align="right" | alternatives
|0
|0:1
|aktiviert das Reading alternatives, welches Alternative Routen (Kurzbeschreibung + Wegzeit) anzeigt
| 1
|-
|}

== Integrierte Karte ==
* Zum Überprüfen der verwendeten Wegstrecke können der Hin- und Rückweg für ein TRAFFIC-Device auf einer Karte angezeigt werden.
* Um die Karte anzuzeigen einfach oben auf "toggle Map" klicken
* Für Einbindung in andere Anwendungen (TabletUI z.b) kann die Karte zusätzlich über den eingeblendeten Link erreicht werden: <nowiki>http://fhem-ip:port/fhem/TRAFFIC?name=<TRAFFIC-DEVICE></nowiki>
* Karte anpassen:
** Die Karte lässt sich über folgende Attribute anpassen:
** GoogleMapsStyle, GoogleMapsSize, GoogleMapsCenter, GoogleMapsZoom, GoogleMapsStroke, GoogleMapsTrafficLayer und GoogleMapsFixedMap
** GoogleMapsZoom und GoogleMapsCenter können direkt in der Kartenansicht gespeichert werden. Dazu die Karte verschieben/zoomen und anschliessend auf die Buttons "save Zoom" bzw. "save Center" klicken
** weitere Beispiele bitte dem Forum entnehmen

== Bekannte Probleme ==
* STATE: "REQUEST DENIED"
* Reading error_message: "This API project is not authorized to use this API"
** => API Key ist nicht aktiviert. Google API > API Manager > Google Maps Directions API > AKTIVIEREN

* STATE: "UNKNOWN_ERROR"
** => Es liegt ein Fehler bei Google vor.
** => "UNKNOWN_ERROR indicates a directions request could not be processed due to a server error. The request may succeed if you try again." [https://developers.google.com/maps/documentation/javascript/directions?hl=de]

* STATE: "OVER_QUERY_LIMIT"
** Es wurden mehr als 2500 requests pro Tag abgesetzt. Abhilfe: Update Intervalle der TRAFFIC Devices erhöhen und "burst" zu den Stosszeiten nutzen.

* STATE: "ZERO_RESULTS"
** Die Waypoint Definition kann Google nicht realisieren. Statt Städtenamen besser exakte Koordinaten verwenden.

* Karte zeigt nur ein graues Bild "Ops..."
** checkt eure Javascript Konsole nach dem exakten Fehler
** Google Maps API error: ApiNotActivatedMapError https://developers.google.com/maps/documentation/javascript/error-messages#api-not-activated-map-error
** => Google Maps JavaScript API aktivieren

== Tips ==
* täglicher Burst Update zum Feierabend, 1 Stunde alle 5 Minuten updaten:
** <code>define FeierabendCheck AT *17:00 set <device> update 12 300</code>

* komplette Reisezeit, also Hin- und Rückweg, im STATE anzeigen:
** <code>attr <device> stateFormat {int(ReadingsVal($name,"delay_min",0)) + int(ReadingsVal($name,"return_delay_min",0))}</code>

* updateSchedule einsetzen um default update Intervall zu verfeinern
** Montag bis Freitag von 6 bis 8 Uhr alle 60 Sekunden
** <code>attr <device> updateSchedule 6-8 1 60|6-8 2 60|6-8 3 60|6-8 4 60|6-8 5 60</code>
** jeden Tag von 17 bis 19 Uhr alle 2 Minuten
** <code>attr <device> updateSchedule 17-19 120</code>

* Waypoints definieren (Tip von erdo_king)
** In Google-Maps die gewünschte Route auswählen (am PC)
** Auf eine signifikante Stelle der Route klicken - hierbei auf die Fahrtrichtung achten!
** Hier auf die Koordinaten klicken, diese können dann aus dem Suchfeld kopiert werden
** Im Browser zurückgehen, bis die Route wieder sichtbar ist (zum späteren Datenabgleich)
** Waypoints in FHEM deklarieren, Daten aktualisieren (set <device> update)
** distance + duration mit den Daten von Google-Maps am PC abgleichen

== to Do ==
* deutsche Commandref

== Weblinks ==
* {{Link2Forum|Topic=56045|LinkText=Modul Vorstellung und Diskussionen}}
* [http://fhem.de/commandref.html#TRAFFIC Commandref]
* [https://console.developers.google.com/apis Google API Manager]

TRAFFIC

2017-04-24T08:16:38Z

Jmike: v.1.3.2 update

{{Infobox Modul
|ModPurpose=Verkehrsdaten zu fest definierten Routen ermitteln
|ModType=d
|ModForumArea=Unterstützende Dienste
|ModTechName=98_TRAFFIC.pm
|ModOwner=jmike ({{Link2Forum|Topic=56045|LinkText=Forum}} / [[Benutzer:Jmike|Wiki]])
}}

Dieses Modul erfasst Fahrzeiten in aktueller Verkehrslage mittels Google Maps Directions API.

== Features / Funktionen ==
* Distanz einer Route
* Fahrzeit ohne Verkehr
* Fahrzeit mit Verkehr
* Verzögerung der geplanten Route
* Waypoints definieren
* Ausgabesprache festlegen
* Outputs in Sekunden / Meter (raw)
* Ausgabe als Text, in Minuten, Sekunden oder als Durchschnitt
* Device STATE frei wählbar
* einstellbares Update Interval
* update-burst für Stosszeiten
* Strecke kann zusätzlich in gegengesetzte Richtung ausgelesen werden
* Ankunfszeit bei Abfahrt zum Update-Zeitpunkt
* verschiedene Travel Modes (driving, walking, bicycling und transit)
* flexibler Update Schedule für Stosszeiten
* integrierte, konfigurierbare Google Map zum Visualisieren der konfigurierten Route

== Voraussetzungen ==
Erstmal muss ein eigener API Key angefordert werden.
Das geht über Googles [https://console.developers.google.com/apis/ API Manager] 
Dort "Google Maps Directions API" suchen und ein neues Projekt erstellen, anschliessend API aktivieren.
Für die Karte ist zusätzlich der "Google Maps JavaScript API" notwendig und sollte an dieser Stelle auch aktiviert werden.

Je nach FHEM Installation zusätzlich die Perl Module LWP::Simple, JSON und MIME::Base64 nach installieren: 
<code>sudo apt-get install libwww-perl</code> 
<code>sudo apt-get install libjson-perl</code> 
oder 
<code>sudo cpan -i LWP::Simple</code> 
<code>sudo cpan -i JSON</code> 
<code>sudo cpan -i MIME::Base64</code>

== Definition ==
<code> define <devicename> TRAFFIC <API-KEY> [update-interval] </code>

'''Beispiel:''' 
<code>define muc2berlin TRAFFIC ABCDEFGHIJKLMNOPQRSTVWYZ 600</code>

Der API Key muss selbstverständlich mit dem eigenen Key aus dem API Manager ersetzt werden. 
Das Intervall in Sekunden ist optional, der default beträgt 3600 (1 Stunde). 
Attribute start_address und end_address definieren.

== Readings ==
* average_delay_min
* average_duration_in_traffic_min
* average_duration_min
* delay
* delay_min
* distance
* duration
* duration_in_traffic
* duration_in_traffic_min
* duration_in_traffic_sec
* duration_min
* duration_sec
* [error_message]
* eta
* state
* status

== Befehle ==

==== update [burst-update-count] [burst-update-interval] ====
Readings manuell aktualisieren, der optionale Burst kann wie folgt genutzt werden: 
- erster Wert gibt an wie viele Updates abgearbeitet werden 
- zweiter Wert gibt an wie viele Sekunden zwischen den Updates gewartet wird 

Beispiel um für 1 Stunde alle 5 Minuten zu aktualisieren: 
<code>set <device> update 12 300</code>

== STATE ==
* Initialized - modul initialisiert
* OK - update war erfolgreich
* incomplete configuration - Konfigurationsfehler (start_address oder end_address leer)
* <APIRETURN> - Fehlermeldung von Google Maps, falls vorhanden (siehe Reading error_message)
* <Reading> - der Wert des Readings welches mit Attribut stateReading ausgewählt wurde
* disabled - das Device wurde über das Attribut disable deaktiviert

== Attribute ==

{| class="wikitable"
!Attribut
!Default Wert
!mögliche Werte
!Beschreibung
!Beispiel
|-
!align="right" |start_address
|
|<text>
|die vollständige Startadresse (erforderlich!)
|Startstr 1, 12345 Startcity
|-
!align="right" |end_address
|
|<text>
|die vollständige Zieladresse (erforderlich!)
|Zielstr 99, 99099 Zielstadt
|-
!align="right" |raw_data
|0
|0:1
|legt Readings an mit allen unbearbeiteten Werten
|
|-
!align="right" |language
|
|de, en, etc.
|Google ermittelt die Sprache automatisch, falls nicht fest definiert
|de
|-
!align="right" |waypoints
|
|lat, long<nowiki>|</nowiki>lat, long
|fixe Wegpunkte auf der Strecke, mehrere Werte per pipe <nowiki>(|)</nowiki> trennen, LAT, LONG Koordinaten angeben
|48.187918, 11.590514
|-
!align="right" |returnWaypoints
|
|lat, long<nowiki>|</nowiki>lat, long
|fixe Wegpunkte für den Rückweg, mehrere Werte per pipe <nowiki>(|)</nowiki> trennen, LAT, LONG Koordinaten angeben, wenn leer werden "waypoints" in umgekehrter Reihenfolge verwendet
|48.187918, 11.590514
|-
!align="right" |disable
|0
|0:1
|Modul deaktivieren
|1
|-
!align="right" |stateReading
|
|<beliebiges-Reading>
|Name eines Readings, dessen Wert in den STATE des Devices geschrieben wird
|delay_min
|-
!align="right" |outputReadings
|text
|text,min,sec,average
|Konfiguration, welche Readings erstellt werden sollen, eine oder mehrere möglich
|text min
|-
!align="right" |includeReturn
|0
|0:1
|aktiviert/deaktiviert, ob die gleiche Strecke in umgekehrter Richtung hinzugefügt werden soll Readings werden mit return_* angegeben
|1
|-
!align="right" |verbose
|1
|0:1:2:3:4:5
|gibt vor, wie ausführlich geloggt wird
|5
|-
!align="right" |travelMode
|driving
|driving:walking:bicycling:transit
|Fortbewegungsmethode für Kalkulation
|walking
|-
!align="right" |updateSchedule
|
|<Beginn-volle-Stunde>-<Ende-volle-Stunde> [<Tag>] <update-Intervall-in-Sekunden>
|definiert einen flexiblen Zeitraum für feinere Updates, Tag als Zahl (Sonntag 0, Montag 1 etc.), mehrere Definitionen per <nowiki>(|)</nowiki> getrennt
| 6-8 1 60|6-8 2 60|6-8 3 60|6-8 4 60|6-8 5 60
|-
!align="right" |GoogleMapsStyle
|default
|default,silver,dark,night
|definiert einen der vorgegebenen Map Styles
|dropdown
|-
!align="right" |GoogleMapsSize
|800,600
|<Breite>,<Höhe>
|definiert die Breite und Höhe der Karte
| 600,300
|-
!align="right" |GoogleMapsCenter
|auto-generiert
|<lat>,<lang>
|definiert den Mittelpunkt der Karte
| 48.2322157,11.6867434
|-
!align="right" |GoogleMapsZoom
|10
|<Zoom wert>
|definiert den Zoom Wert der Karte
| 14
|-
!align="right" |GoogleMapsStroke
|#019cdf,#ffeb19 #019cdf,15,50,#ffeb19,15,50 #019cdf,20,80,#ffeb19
|<#-6-digit-hex-code>,[<weight>[,<opacity>],]<#-6-digit-hex-code>,[<weight>,[<opacity>]]
|definiert die Farbe der Wegstrecken im HEX Format, Dicke der Linie und Transparenz
| #4cde44,6,100,#FF0000,1,100
|-
!align="right" |GoogleMapsTrafficLayer
|0
|0:1
|schaltet den Standard Google Maps Traffic Overlay ein/aus
| 1
|-
!align="right" |GoogleMapsDisableUI
|0
|0:1
|Dropdown um die Map Controls zu deaktivieren
| 1
|-
|}

== Integrierte Karte ==
* Zum Überprüfen der verwendeten Wegstrecke können der Hin- und Rückweg für ein TRAFFIC-Device auf einer Karte angezeigt werden.
* Um die Karte anzuzeigen einfach oben auf "toggle Map" klicken
* Für Einbindung in andere Anwendungen (TabletUI z.b) kann die Karte zusätzlich über den eingeblendeten Link erreicht werden: <nowiki>http://fhem-ip:port/fhem/TRAFFIC?name=<TRAFFIC-DEVICE></nowiki>
* Karte anpassen:
** Die Karte lässt sich über folgende Attribute anpassen:
** GoogleMapsStyle, GoogleMapsSize, GoogleMapsCenter, GoogleMapsZoom, GoogleMapsStroke und GoogleMapsTrafficLayer
** GoogleMapsZoom und GoogleMapsCenter können direkt in der Kartenansicht gespeichert werden. Dazu die Karte verschieben/zoomen und anschliessend auf die Buttons "save Zoom" bzw. "save Center" klicken
** weitere Beispiele bitte dem Forum entnehmen

== Bekannte Probleme ==
* STATE: "REQUEST DENIED"
* Reading error_message: "This API project is not authorized to use this API"
** => API Key ist nicht aktiviert. Google API > API Manager > Google Maps Directions API > AKTIVIEREN

* STATE: "UNKNOWN_ERROR"
** => Es liegt ein Fehler bei Google vor.
** => "UNKNOWN_ERROR indicates a directions request could not be processed due to a server error. The request may succeed if you try again." [https://developers.google.com/maps/documentation/javascript/directions?hl=de]

* STATE: "OVER_QUERY_LIMIT"
** Es wurden mehr als 2500 requests pro Tag abgesetzt. Abhilfe: Update Intervalle der TRAFFIC Devices erhöhen und "burst" zu den Stosszeiten nutzen.

* STATE: "ZERO_RESULTS"
** Die Waypoint Definition kann Google nicht realisieren. Statt Städtenamen besser exakte Koordinaten verwenden.

* Karte zeigt nur ein graues Bild "Ops..."
** checkt eure Javascript Konsole nach dem exakten Fehler
** Google Maps API error: ApiNotActivatedMapError https://developers.google.com/maps/documentation/javascript/error-messages#api-not-activated-map-error
** => Google Maps JavaScript API aktivieren

== Tips ==
* täglicher Burst Update zum Feierabend, 1 Stunde alle 5 Minuten updaten:
** <code>define FeierabendCheck AT *17:00 set <device> update 12 300</code>

* komplette Reisezeit, also Hin- und Rückweg, im STATE anzeigen:
** <code>attr <device> stateFormat {int(ReadingsVal($name,"delay_min",0)) + int(ReadingsVal($name,"return_delay_min",0))}</code>

* updateSchedule einsetzen um default update Intervall zu verfeinern
** Montag bis Freitag von 6 bis 8 Uhr alle 60 Sekunden
** <code>attr <device> updateSchedule 6-8 1 60|6-8 2 60|6-8 3 60|6-8 4 60|6-8 5 60</code>
** jeden Tag von 17 bis 19 Uhr alle 2 Minuten
** <code>attr <device> updateSchedule 17-19 120</code>

* Waypoints definieren (Tip von erdo_king)
** In Google-Maps die gewünschte Route auswählen (am PC)
** Auf eine signifikante Stelle der Route klicken - hierbei auf die Fahrtrichtung achten!
** Hier auf die Koordinaten klicken, diese können dann aus dem Suchfeld kopiert werden
** Im Browser zurückgehen, bis die Route wieder sichtbar ist (zum späteren Datenabgleich)
** Waypoints in FHEM deklarieren, Daten aktualisieren (set <device> update)
** distance + duration mit den Daten von Google-Maps am PC abgleichen

== to Do ==
* Reading error_message löschen wenn update erfolgreich
* deutsche Commandref

== Weblinks ==
* {{Link2Forum|Topic=56045|LinkText=Modul Vorstellung und Diskussionen}}
* [http://fhem.de/commandref.html#TRAFFIC Commandref]
* [https://console.developers.google.com/apis Google API Manager]

TRAFFIC

2017-04-21T15:19:01Z

Jmike: Troubleshooting erweitert

{{Infobox Modul
|ModPurpose=Verkehrsdaten zu fest definierten Routen ermitteln
|ModType=d
|ModForumArea=Unterstützende Dienste
|ModTechName=98_TRAFFIC.pm
|ModOwner=jmike ({{Link2Forum|Topic=56045|LinkText=Forum}} / [[Benutzer:Jmike|Wiki]])
}}

Dieses Modul erfasst Fahrzeiten in aktueller Verkehrslage mittels Google Maps Directions API.

== Features / Funktionen ==
* Distanz einer Route
* Fahrzeit ohne Verkehr
* Fahrzeit mit Verkehr
* Verzögerung der geplanten Route
* Waypoints definieren
* Ausgabesprache festlegen
* Outputs in Sekunden / Meter (raw)
* Ausgabe als Text, in Minuten, Sekunden oder als Durchschnitt
* Device STATE frei wählbar
* einstellbares Update Interval
* update-burst für Stosszeiten
* Strecke kann zusätzlich in gegengesetzte Richtung ausgelesen werden
* Ankunfszeit bei Abfahrt zum Update-Zeitpunkt
* verschiedene Travel Modes (driving, walking, bicycling und transit)
* flexibler Update Schedule für Stosszeiten
* integrierte, konfigurierbare Google Map zum Visualisieren der konfigurierten Route

== Voraussetzungen ==
Erstmal muss ein eigener API Key angefordert werden.
Das geht über Googles [https://console.developers.google.com/apis/ API Manager] 
Dort "Google Maps Directions API" suchen und ein neues Projekt erstellen, anschliessend API aktivieren.
Für die Karte ist zusätzlich der "Google Maps JavaScript API" notwendig und sollte an dieser Stelle auch aktiviert werden.

Je nach FHEM Installation zusätzlich die Perl Module LWP::Simple, JSON und MIME::Base64 nach installieren: 
<code>sudo apt-get install libwww-perl</code> 
<code>sudo apt-get install libjson-perl</code> 
oder 
<code>sudo cpan -i LWP::Simple</code> 
<code>sudo cpan -i JSON</code> 
<code>sudo cpan -i MIME::Base64</code>

== Definition ==
<code> define <devicename> TRAFFIC <API-KEY> [update-interval] </code>

'''Beispiel:''' 
<code>define muc2berlin TRAFFIC ABCDEFGHIJKLMNOPQRSTVWYZ 600</code>

Der API Key muss selbstverständlich mit dem eigenen Key aus dem API Manager ersetzt werden. 
Das Intervall in Sekunden ist optional, der default beträgt 3600 (1 Stunde). 
Attribute start_address und end_address definieren.

== Readings ==
* average_delay_min
* average_duration_in_traffic_min
* average_duration_min
* delay
* delay_min
* distance
* duration
* duration_in_traffic
* duration_in_traffic_min
* duration_in_traffic_sec
* duration_min
* duration_sec
* [error_message]
* eta
* state
* status

== Befehle ==

==== update [burst-update-count] [burst-update-interval] ====
Readings manuell aktualisieren, der optionale Burst kann wie folgt genutzt werden: 
- erster Wert gibt an wie viele Updates abgearbeitet werden 
- zweiter Wert gibt an wie viele Sekunden zwischen den Updates gewartet wird 

Beispiel um für 1 Stunde alle 5 Minuten zu aktualisieren: 
<code>set <device> update 12 300</code>

== STATE ==
* Initialized - modul initialisiert
* OK - update war erfolgreich
* incomplete configuration - Konfigurationsfehler (start_address oder end_address leer)
* <APIRETURN> - Fehlermeldung von Google Maps, falls vorhanden (siehe Reading error_message)
* <Reading> - der Wert des Readings welches mit Attribut stateReading ausgewählt wurde
* disabled - das Device wurde über das Attribut disable deaktiviert

== Attribute ==

{| class="wikitable"
!Attribut
!Default Wert
!mögliche Werte
!Beschreibung
!Beispiel
|-
!align="right" |start_address
|
|<text>
|die vollständige Startadresse (erforderlich!)
|Startstr 1, 12345 Startcity
|-
!align="right" |end_address
|
|<text>
|die vollständige Zieladresse (erforderlich!)
|Zielstr 99, 99099 Zielstadt
|-
!align="right" |raw_data
|0
|0:1
|legt Readings an mit allen unbearbeiteten Werten
|
|-
!align="right" |language
|
|de, en, etc.
|Google ermittelt die Sprache automatisch, falls nicht fest definiert
|de
|-
!align="right" |waypoints
|
|lat, long<nowiki>|</nowiki>lat, long
|fixe Wegpunkte auf der Strecke, mehrere Werte per pipe <nowiki>(|)</nowiki> trennen, LAT, LONG Koordinaten angeben
|48.187918, 11.590514
|-
!align="right" |returnWaypoints
|
|lat, long<nowiki>|</nowiki>lat, long
|fixe Wegpunkte für den Rückweg, mehrere Werte per pipe <nowiki>(|)</nowiki> trennen, LAT, LONG Koordinaten angeben, wenn leer werden "waypoints" in umgekehrter Reihenfolge verwendet
|48.187918, 11.590514
|-
!align="right" |disable
|0
|0:1
|Modul deaktivieren
|1
|-
!align="right" |stateReading
|
|<beliebiges-Reading>
|Name eines Readings, dessen Wert in den STATE des Devices geschrieben wird
|delay_min
|-
!align="right" |outputReadings
|text
|text,min,sec,average
|Konfiguration, welche Readings erstellt werden sollen, eine oder mehrere möglich
|text min
|-
!align="right" |includeReturn
|0
|0:1
|aktiviert/deaktiviert, ob die gleiche Strecke in umgekehrter Richtung hinzugefügt werden soll Readings werden mit return_* angegeben
|1
|-
!align="right" |verbose
|1
|0:1:2:3:4:5
|gibt vor, wie ausführlich geloggt wird
|5
|-
!align="right" |travelMode
|driving
|driving:walking:bicycling:transit
|Fortbewegungsmethode für Kalkulation
|walking
|-
!align="right" |updateSchedule
|
|<Beginn-volle-Stunde>-<Ende-volle-Stunde> [<Tag>] <update-Intervall-in-Sekunden>
|definiert einen flexiblen Zeitraum für feinere Updates, Tag als Zahl (Sonntag 0, Montag 1 etc.), mehrere Definitionen per <nowiki>(|)</nowiki> getrennt
| 6-8 1 60|6-8 2 60|6-8 3 60|6-8 4 60|6-8 5 60
|-
!align="right" |GoogleMapsStyle
|default
|default,silver,dark,night
|definiert einen der vorgegebenen Map Styles
|dropdown
|-
!align="right" |GoogleMapsSize
|800,600
|<Breite>,<Höhe>
|definiert die Breite und Höhe der Karte
| 600,300
|-
!align="right" |GoogleMapsCenter
|auto-generiert
|<lat>,<lang>
|definiert den Mittelpunkt der Karte
| 48.2322157,11.6867434
|-
!align="right" |GoogleMapsZoom
|10
|<Zoom wert>
|definiert den Zoom Wert der Karte
| 14
|-
!align="right" |GoogleMapsStroke
|#4cde44,#FF0000
|<Farbcode-Hinweg>,<Farbcode-Rückweg>
|definiert die Farbe der Wegstrecken im HEX Format
| #08eca7,#ec9c08
|-
!align="right" |GoogleMapsTrafficLayer
|0
|0:1
|schaltet den Standard Google Maps Traffic Overlay ein/aus
| 1
|-
!align="right" |GoogleMapsDisableUI
|0
|0:1
|Dropdown um die Map Controls zu deaktivieren
| 1
|-
|}

== Integrierte Karte ==
* Zum Überprüfen der verwendeten Wegstrecke können der Hin- und Rückweg für ein TRAFFIC-Device auf einer Karte angezeigt werden.
* Um die Karte anzuzeigen einfach oben auf "toggle Map" klicken
* Für Einbindung in andere Anwendungen (TabletUI z.b) kann die Karte zusätzlich über den eingeblendeten Link erreicht werden: <nowiki>http://fhem-ip:port/fhem/TRAFFIC?name=<TRAFFIC-DEVICE></nowiki>
* Karte anpassen:
** Die Karte lässt sich über folgende Attribute anpassen:
** GoogleMapsStyle, GoogleMapsSize, GoogleMapsCenter, GoogleMapsZoom, GoogleMapsStroke und GoogleMapsTrafficLayer
** GoogleMapsZoom und GoogleMapsCenter können direkt in der Kartenansicht gespeichert werden. Dazu die Karte verschieben/zoomen und anschliessend auf die Buttons "save Zoom" bzw. "save Center" klicken
** weitere Beispiele bitte dem Forum entnehmen

== Bekannte Probleme ==
* STATE: "REQUEST DENIED"
* Reading error_message: "This API project is not authorized to use this API"
** => API Key ist nicht aktiviert. Google API > API Manager > Google Maps Directions API > AKTIVIEREN

* STATE: "UNKNOWN_ERROR"
** => Es liegt ein Fehler bei Google vor.
** => "UNKNOWN_ERROR indicates a directions request could not be processed due to a server error. The request may succeed if you try again." [https://developers.google.com/maps/documentation/javascript/directions?hl=de]

* STATE: "OVER_QUERY_LIMIT"
** Es wurden mehr als 2500 requests pro Tag abgesetzt. Abhilfe: Update Intervalle der TRAFFIC Devices erhöhen und "burst" zu den Stosszeiten nutzen.

* STATE: "ZERO_RESULTS"
** Die Waypoint Definition kann Google nicht realisieren. Statt Städtenamen besser exakte Koordinaten verwenden.

* Karte zeigt nur ein graues Bild "Ops..."
** checkt eure Javascript Konsole nach dem exakten Fehler
** Google Maps API error: ApiNotActivatedMapError https://developers.google.com/maps/documentation/javascript/error-messages#api-not-activated-map-error
** => Google Maps JavaScript API aktivieren

== Tips ==
* täglicher Burst Update zum Feierabend, 1 Stunde alle 5 Minuten updaten:
** <code>define FeierabendCheck AT *17:00 set <device> update 12 300</code>

* komplette Reisezeit, also Hin- und Rückweg, im STATE anzeigen:
** <code>attr <device> stateFormat {int(ReadingsVal($name,"delay_min",0)) + int(ReadingsVal($name,"return_delay_min",0))}</code>

* updateSchedule einsetzen um default update Intervall zu verfeinern
** Montag bis Freitag von 6 bis 8 Uhr alle 60 Sekunden
** <code>attr <device> updateSchedule 6-8 1 60|6-8 2 60|6-8 3 60|6-8 4 60|6-8 5 60</code>
** jeden Tag von 17 bis 19 Uhr alle 2 Minuten
** <code>attr <device> updateSchedule 17-19 120</code>

* Waypoints definieren (Tip von erdo_king)
** In Google-Maps die gewünschte Route auswählen (am PC)
** Auf eine signifikante Stelle der Route klicken - hierbei auf die Fahrtrichtung achten!
** Hier auf die Koordinaten klicken, diese können dann aus dem Suchfeld kopiert werden
** Im Browser zurückgehen, bis die Route wieder sichtbar ist (zum späteren Datenabgleich)
** Waypoints in FHEM deklarieren, Daten aktualisieren (set <device> update)
** distance + duration mit den Daten von Google-Maps am PC abgleichen

== to Do ==
* Reading error_message löschen wenn update erfolgreich
* deutsche Commandref

== Weblinks ==
* {{Link2Forum|Topic=56045|LinkText=Modul Vorstellung und Diskussionen}}
* [http://fhem.de/commandref.html#TRAFFIC Commandref]
* [https://console.developers.google.com/apis Google API Manager]

TRAFFIC

2017-04-21T13:58:54Z

Jmike: neues Attribut GoogleMapsZoom

{{Infobox Modul
|ModPurpose=Verkehrsdaten zu fest definierten Routen ermitteln
|ModType=d
|ModForumArea=Unterstützende Dienste
|ModTechName=98_TRAFFIC.pm
|ModOwner=jmike ({{Link2Forum|Topic=56045|LinkText=Forum}} / [[Benutzer:Jmike|Wiki]])
}}

Dieses Modul erfasst Fahrzeiten in aktueller Verkehrslage mittels Google Maps Directions API.

== Features / Funktionen ==
* Distanz einer Route
* Fahrzeit ohne Verkehr
* Fahrzeit mit Verkehr
* Verzögerung der geplanten Route
* Waypoints definieren
* Ausgabesprache festlegen
* Outputs in Sekunden / Meter (raw)
* Ausgabe als Text, in Minuten, Sekunden oder als Durchschnitt
* Device STATE frei wählbar
* einstellbares Update Interval
* update-burst für Stosszeiten
* Strecke kann zusätzlich in gegengesetzte Richtung ausgelesen werden
* Ankunfszeit bei Abfahrt zum Update-Zeitpunkt
* verschiedene Travel Modes (driving, walking, bicycling und transit)
* flexibler Update Schedule für Stosszeiten
* integrierte, konfigurierbare Google Map zum Visualisieren der konfigurierten Route

== Voraussetzungen ==
Erstmal muss ein eigener API Key angefordert werden.
Das geht über Googles [https://console.developers.google.com/apis/ API Manager] 
Dort "Google Maps Directions API" suchen und ein neues Projekt erstellen, anschliessend API aktivieren.

Je nach FHEM Installation zusätzlich die Perl Module LWP::Simple, JSON und MIME::Base64 nach installieren: 
<code>sudo apt-get install libwww-perl</code> 
<code>sudo apt-get install libjson-perl</code> 
oder 
<code>sudo cpan -i LWP::Simple</code> 
<code>sudo cpan -i JSON</code> 
<code>sudo cpan -i MIME::Base64</code>

== Definition ==
<code> define <devicename> TRAFFIC <API-KEY> [update-interval] </code>

'''Beispiel:''' 
<code>define muc2berlin TRAFFIC ABCDEFGHIJKLMNOPQRSTVWYZ 600</code>

Der API Key muss selbstverständlich mit dem eigenen Key aus dem API Manager ersetzt werden. 
Das Intervall in Sekunden ist optional, der default beträgt 3600 (1 Stunde). 
Attribute start_address und end_address definieren.

== Readings ==
* average_delay_min
* average_duration_in_traffic_min
* average_duration_min
* delay
* delay_min
* distance
* duration
* duration_in_traffic
* duration_in_traffic_min
* duration_in_traffic_sec
* duration_min
* duration_sec
* [error_message]
* eta
* state
* status

== Befehle ==

==== update [burst-update-count] [burst-update-interval] ====
Readings manuell aktualisieren, der optionale Burst kann wie folgt genutzt werden: 
- erster Wert gibt an wie viele Updates abgearbeitet werden 
- zweiter Wert gibt an wie viele Sekunden zwischen den Updates gewartet wird 

Beispiel um für 1 Stunde alle 5 Minuten zu aktualisieren: 
<code>set <device> update 12 300</code>

== STATE ==
* Initialized - modul initialisiert
* OK - update war erfolgreich
* incomplete configuration - Konfigurationsfehler (start_address oder end_address leer)
* <APIRETURN> - Fehlermeldung von Google Maps, falls vorhanden (siehe Reading error_message)
* <Reading> - der Wert des Readings welches mit Attribut stateReading ausgewählt wurde
* disabled - das Device wurde über das Attribut disable deaktiviert

== Attribute ==

{| class="wikitable"
!Attribut
!Default Wert
!mögliche Werte
!Beschreibung
!Beispiel
|-
!align="right" |start_address
|
|<text>
|die vollständige Startadresse (erforderlich!)
|Startstr 1, 12345 Startcity
|-
!align="right" |end_address
|
|<text>
|die vollständige Zieladresse (erforderlich!)
|Zielstr 99, 99099 Zielstadt
|-
!align="right" |raw_data
|0
|0:1
|legt Readings an mit allen unbearbeiteten Werten
|
|-
!align="right" |language
|
|de, en, etc.
|Google ermittelt die Sprache automatisch, falls nicht fest definiert
|de
|-
!align="right" |waypoints
|
|lat, long<nowiki>|</nowiki>lat, long
|fixe Wegpunkte auf der Strecke, mehrere Werte per pipe <nowiki>(|)</nowiki> trennen, LAT, LONG Koordinaten angeben
|48.187918, 11.590514
|-
!align="right" |returnWaypoints
|
|lat, long<nowiki>|</nowiki>lat, long
|fixe Wegpunkte für den Rückweg, mehrere Werte per pipe <nowiki>(|)</nowiki> trennen, LAT, LONG Koordinaten angeben, wenn leer werden "waypoints" in umgekehrter Reihenfolge verwendet
|48.187918, 11.590514
|-
!align="right" |disable
|0
|0:1
|Modul deaktivieren
|1
|-
!align="right" |stateReading
|
|<beliebiges-Reading>
|Name eines Readings, dessen Wert in den STATE des Devices geschrieben wird
|delay_min
|-
!align="right" |outputReadings
|text
|text,min,sec,average
|Konfiguration, welche Readings erstellt werden sollen, eine oder mehrere möglich
|text min
|-
!align="right" |includeReturn
|0
|0:1
|aktiviert/deaktiviert, ob die gleiche Strecke in umgekehrter Richtung hinzugefügt werden soll Readings werden mit return_* angegeben
|1
|-
!align="right" |verbose
|1
|0:1:2:3:4:5
|gibt vor, wie ausführlich geloggt wird
|5
|-
!align="right" |travelMode
|driving
|driving:walking:bicycling:transit
|Fortbewegungsmethode für Kalkulation
|walking
|-
!align="right" |updateSchedule
|
|<Beginn-volle-Stunde>-<Ende-volle-Stunde> [<Tag>] <update-Intervall-in-Sekunden>
|definiert einen flexiblen Zeitraum für feinere Updates, Tag als Zahl (Sonntag 0, Montag 1 etc.), mehrere Definitionen per <nowiki>(|)</nowiki> getrennt
| 6-8 1 60|6-8 2 60|6-8 3 60|6-8 4 60|6-8 5 60
|-
!align="right" |GoogleMapsStyle
|default
|default,silver,dark,night
|definiert einen der vorgegebenen Map Styles
|dropdown
|-
!align="right" |GoogleMapsSize
|800,600
|<Breite>,<Höhe>
|definiert die Breite und Höhe der Karte
| 600,300
|-
!align="right" |GoogleMapsCenter
|auto-generiert
|<lat>,<lang>
|definiert den Mittelpunkt der Karte
| 48.2322157,11.6867434
|-
!align="right" |GoogleMapsZoom
|10
|<Zoom wert>
|definiert den Zoom Wert der Karte
| 14
|-
!align="right" |GoogleMapsStroke
|#4cde44,#FF0000
|<Farbcode-Hinweg>,<Farbcode-Rückweg>
|definiert die Farbe der Wegstrecken im HEX Format
| #08eca7,#ec9c08
|-
!align="right" |GoogleMapsTrafficLayer
|0
|0:1
|schaltet den Standard Google Maps Traffic Overlay ein/aus
| 1
|-
!align="right" |GoogleMapsDisableUI
|0
|0:1
|Dropdown um die Map Controls zu deaktivieren
| 1
|-
|}

== Integrierte Karte ==
* Zum Überprüfen der verwendeten Wegstrecke können der Hin- und Rückweg für ein TRAFFIC-Device auf einer Karte angezeigt werden.
* Um die Karte anzuzeigen einfach oben auf "toggle Map" klicken
* Für Einbindung in andere Anwendungen (TabletUI z.b) kann die Karte zusätzlich über den eingeblendeten Link erreicht werden: <nowiki>http://fhem-ip:port/fhem/TRAFFIC?name=<TRAFFIC-DEVICE></nowiki>
* Karte anpassen:
** Die Karte lässt sich über folgende Attribute anpassen:
** GoogleMapsStyle, GoogleMapsSize, GoogleMapsCenter, GoogleMapsZoom, GoogleMapsStroke und GoogleMapsTrafficLayer
** GoogleMapsZoom und GoogleMapsCenter können direkt in der Kartenansicht gespeichert werden. Dazu die Karte verschieben/zoomen und anschliessend auf die Buttons "save Zoom" bzw. "save Center" klicken
** weitere Beispiele bitte dem Forum entnehmen

== Bekannte Probleme ==
* STATE: "REQUEST DENIED"
* Reading error_message: "This API project is not authorized to use this API"
** => API Key ist nicht aktiviert. Google API > API Manager > Google Maps Directions API > AKTIVIEREN

* STATE: "UNKNOWN_ERROR"
** => Es liegt ein Fehler bei Google vor.
** => "UNKNOWN_ERROR indicates a directions request could not be processed due to a server error. The request may succeed if you try again." [https://developers.google.com/maps/documentation/javascript/directions?hl=de]

* STATE: "OVER_QUERY_LIMIT"
** Es wurden mehr als 2500 requests pro Tag abgesetzt. Abhilfe: Update Intervalle der TRAFFIC Devices erhöhen und "burst" zu den Stosszeiten nutzen.

* STATE: "ZERO_RESULTS"
** Die Waypoint Definition kann Google nicht realisieren. Statt Städtenamen besser exakte Koordinaten verwenden.

== Tips ==
* täglicher Burst Update zum Feierabend, 1 Stunde alle 5 Minuten updaten:
** <code>define FeierabendCheck AT *17:00 set <device> update 12 300</code>

* komplette Reisezeit, also Hin- und Rückweg, im STATE anzeigen:
** <code>attr <device> stateFormat {int(ReadingsVal($name,"delay_min",0)) + int(ReadingsVal($name,"return_delay_min",0))}</code>

* updateSchedule einsetzen um default update Intervall zu verfeinern
** Montag bis Freitag von 6 bis 8 Uhr alle 60 Sekunden
** <code>attr <device> updateSchedule 6-8 1 60|6-8 2 60|6-8 3 60|6-8 4 60|6-8 5 60</code>
** jeden Tag von 17 bis 19 Uhr alle 2 Minuten
** <code>attr <device> updateSchedule 17-19 120</code>

* Waypoints definieren (Tip von erdo_king)
** In Google-Maps die gewünschte Route auswählen (am PC)
** Auf eine signifikante Stelle der Route klicken - hierbei auf die Fahrtrichtung achten!
** Hier auf die Koordinaten klicken, diese können dann aus dem Suchfeld kopiert werden
** Im Browser zurückgehen, bis die Route wieder sichtbar ist (zum späteren Datenabgleich)
** Waypoints in FHEM deklarieren, Daten aktualisieren (set <device> update)
** distance + duration mit den Daten von Google-Maps am PC abgleichen

== to Do ==
* Reading error_message löschen wenn update erfolgreich
* deutsche Commandref

== Weblinks ==
* {{Link2Forum|Topic=56045|LinkText=Modul Vorstellung und Diskussionen}}
* [http://fhem.de/commandref.html#TRAFFIC Commandref]
* [https://console.developers.google.com/apis Google API Manager]

TRAFFIC

2017-04-21T09:09:11Z

Jmike: update für version 1.3

{{Infobox Modul
|ModPurpose=Verkehrsdaten zu fest definierten Routen ermitteln
|ModType=d
|ModForumArea=Unterstützende Dienste
|ModTechName=98_TRAFFIC.pm
|ModOwner=jmike ({{Link2Forum|Topic=56045|LinkText=Forum}} / [[Benutzer:Jmike|Wiki]])
}}

Dieses Modul erfasst Fahrzeiten in aktueller Verkehrslage mittels Google Maps Directions API.

== Features / Funktionen ==
* Distanz einer Route
* Fahrzeit ohne Verkehr
* Fahrzeit mit Verkehr
* Verzögerung der geplanten Route
* Waypoints definieren
* Ausgabesprache festlegen
* Outputs in Sekunden / Meter (raw)
* Ausgabe als Text, in Minuten, Sekunden oder als Durchschnitt
* Device STATE frei wählbar
* einstellbares Update Interval
* update-burst für Stosszeiten
* Strecke kann zusätzlich in gegengesetzte Richtung ausgelesen werden
* Ankunfszeit bei Abfahrt zum Update-Zeitpunkt
* verschiedene Travel Modes (driving, walking, bicycling und transit)
* flexibler Update Schedule für Stosszeiten
* integrierte, konfigurierbare Google Map zum Visualisieren der konfigurierten Route

== Voraussetzungen ==
Erstmal muss ein eigener API Key angefordert werden.
Das geht über Googles [https://console.developers.google.com/apis/ API Manager] 
Dort "Google Maps Directions API" suchen und ein neues Projekt erstellen, anschliessend API aktivieren.

Je nach FHEM Installation zusätzlich die Perl Module LWP::Simple, JSON und MIME::Base64 nach installieren: 
<code>sudo apt-get install libwww-perl</code> 
<code>sudo apt-get install libjson-perl</code> 
oder 
<code>sudo cpan -i LWP::Simple</code> 
<code>sudo cpan -i JSON</code> 
<code>sudo cpan -i MIME::Base64</code>

== Definition ==
<code> define <devicename> TRAFFIC <API-KEY> [update-interval] </code>

'''Beispiel:''' 
<code>define muc2berlin TRAFFIC ABCDEFGHIJKLMNOPQRSTVWYZ 600</code>

Der API Key muss selbstverständlich mit dem eigenen Key aus dem API Manager ersetzt werden. 
Das Intervall in Sekunden ist optional, der default beträgt 3600 (1 Stunde). 
Attribute start_address und end_address definieren.

== Readings ==
* average_delay_min
* average_duration_in_traffic_min
* average_duration_min
* delay
* delay_min
* distance
* duration
* duration_in_traffic
* duration_in_traffic_min
* duration_in_traffic_sec
* duration_min
* duration_sec
* [error_message]
* eta
* state
* status

== Befehle ==

==== update [burst-update-count] [burst-update-interval] ====
Readings manuell aktualisieren, der optionale Burst kann wie folgt genutzt werden: 
- erster Wert gibt an wie viele Updates abgearbeitet werden 
- zweiter Wert gibt an wie viele Sekunden zwischen den Updates gewartet wird 

Beispiel um für 1 Stunde alle 5 Minuten zu aktualisieren: 
<code>set <device> update 12 300</code>

== STATE ==
* Initialized - modul initialisiert
* OK - update war erfolgreich
* incomplete configuration - Konfigurationsfehler (start_address oder end_address leer)
* <APIRETURN> - Fehlermeldung von Google Maps, falls vorhanden (siehe Reading error_message)
* <Reading> - der Wert des Readings welches mit Attribut stateReading ausgewählt wurde
* disabled - das Device wurde über das Attribut disable deaktiviert

== Attribute ==

{| class="wikitable"
!Attribut
!Default Wert
!mögliche Werte
!Beschreibung
!Beispiel
|-
!align="right" |start_address
|
|<text>
|die vollständige Startadresse (erforderlich!)
|Startstr 1, 12345 Startcity
|-
!align="right" |end_address
|
|<text>
|die vollständige Zieladresse (erforderlich!)
|Zielstr 99, 99099 Zielstadt
|-
!align="right" |raw_data
|0
|0:1
|legt Readings an mit allen unbearbeiteten Werten
|
|-
!align="right" |language
|
|de, en, etc.
|Google ermittelt die Sprache automatisch, falls nicht fest definiert
|de
|-
!align="right" |waypoints
|
|lat, long<nowiki>|</nowiki>lat, long
|fixe Wegpunkte auf der Strecke, mehrere Werte per pipe <nowiki>(|)</nowiki> trennen, LAT, LONG Koordinaten angeben
|48.187918, 11.590514
|-
!align="right" |returnWaypoints
|
|lat, long<nowiki>|</nowiki>lat, long
|fixe Wegpunkte für den Rückweg, mehrere Werte per pipe <nowiki>(|)</nowiki> trennen, LAT, LONG Koordinaten angeben, wenn leer werden "waypoints" in umgekehrter Reihenfolge verwendet
|48.187918, 11.590514
|-
!align="right" |disable
|0
|0:1
|Modul deaktivieren
|1
|-
!align="right" |stateReading
|
|<beliebiges-Reading>
|Name eines Readings, dessen Wert in den STATE des Devices geschrieben wird
|delay_min
|-
!align="right" |outputReadings
|text
|text,min,sec,average
|Konfiguration, welche Readings erstellt werden sollen, eine oder mehrere möglich
|text min
|-
!align="right" |includeReturn
|0
|0:1
|aktiviert/deaktiviert, ob die gleiche Strecke in umgekehrter Richtung hinzugefügt werden soll Readings werden mit return_* angegeben
|1
|-
!align="right" |verbose
|1
|0:1:2:3:4:5
|gibt vor, wie ausführlich geloggt wird
|5
|-
!align="right" |travelMode
|driving
|driving:walking:bicycling:transit
|Fortbewegungsmethode für Kalkulation
|walking
|-
!align="right" |updateSchedule
|
|<Beginn-volle-Stunde>-<Ende-volle-Stunde> [<Tag>] <update-Intervall-in-Sekunden>
|definiert einen flexiblen Zeitraum für feinere Updates, Tag als Zahl (Sonntag 0, Montag 1 etc.), mehrere Definitionen per <nowiki>(|)</nowiki> getrennt
| 6-8 1 60|6-8 2 60|6-8 3 60|6-8 4 60|6-8 5 60
|-
!align="right" |GoogleMapsStyle
|default
|default,silver,dark,night
|definiert einen der vorgegebenen Map Styles
|dropdown
|-
!align="right" |GoogleMapsSize
|800,600
|<Breite>,<Höhe>
|definiert die Breite und Höhe der Karte
| 600,300
|-
!align="right" |GoogleMapsLocation
|auto-generiert
|<lat>,<lang>
|definiert den Mittelpunkt der Karte
| 48.2322157,11.6867434
|-
!align="right" |GoogleMapsStroke
|#4cde44,#FF0000
|<Farbcode-Hinweg>,<Farbcode-Rückweg>
|definiert die Farbe der Wegstrecken im HEX Format
| #08eca7,#ec9c08
|-
!align="right" |GoogleMapsTrafficLayer
|0
|0:1
|schaltet den Standard Google Maps Traffic Overlay ein/aus
| 1
|-
!align="right" |GoogleMapsDisableUI
|0
|0:1
|Dropdown um die Map Controls zu deaktivieren
| 1
|-
|}

== Integrierte Karte ==
* Zum Überprüfen der verwendeten Wegstrecke können der Hin- und Rückweg für ein TRAFFIC-Device auf einer Karte angezeigt werden.
* Um die Karte anzuzeigen einfach oben auf "toggle Map" klicken
* Für Einbindung in andere Anwendungen (TabletUI z.b) kann die Karte zusätzlich über den eingeblendeten Link erreicht werden: <nowiki>http://fhem-ip:port/fhem/TRAFFIC?name=<TRAFFIC-DEVICE></nowiki>
* Karte anpassen:
** Die Karte lässt sich über folgende Attribute anpassen:
** GoogleMapsStyle, GoogleMapsSize, GoogleMapsLocation, GoogleMapsStroke und GoogleMapsTrafficLayer
** weitere Beispiele bitte dem Forum entnehmen

== Bekannte Probleme ==
* STATE: "REQUEST DENIED"
* Reading error_message: "This API project is not authorized to use this API"
** => API Key ist nicht aktiviert. Google API > API Manager > Google Maps Directions API > AKTIVIEREN

* STATE: "UNKNOWN_ERROR"
** => Es liegt ein Fehler bei Google vor.
** => "UNKNOWN_ERROR indicates a directions request could not be processed due to a server error. The request may succeed if you try again." [https://developers.google.com/maps/documentation/javascript/directions?hl=de]

* STATE: "OVER_QUERY_LIMIT"
** Es wurden mehr als 2500 requests pro Tag abgesetzt. Abhilfe: Update Intervalle der TRAFFIC Devices erhöhen und "burst" zu den Stosszeiten nutzen.

* STATE: "ZERO_RESULTS"
** Die Waypoint Definition kann Google nicht realisieren. Statt Städtenamen besser exakte Koordinaten verwenden.

== Tips ==
* täglicher Burst Update zum Feierabend, 1 Stunde alle 5 Minuten updaten:
** <code>define FeierabendCheck AT *17:00 set <device> update 12 300</code>

* komplette Reisezeit, also Hin- und Rückweg, im STATE anzeigen:
** <code>attr <device> stateFormat {int(ReadingsVal($name,"delay_min",0)) + int(ReadingsVal($name,"return_delay_min",0))}</code>

* updateSchedule einsetzen um default update Intervall zu verfeinern
** Montag bis Freitag von 6 bis 8 Uhr alle 60 Sekunden
** <code>attr <device> updateSchedule 6-8 1 60|6-8 2 60|6-8 3 60|6-8 4 60|6-8 5 60</code>
** jeden Tag von 17 bis 19 Uhr alle 2 Minuten
** <code>attr <device> updateSchedule 17-19 120</code>

* Waypoints definieren (Tip von erdo_king)
** In Google-Maps die gewünschte Route auswählen (am PC)
** Auf eine signifikante Stelle der Route klicken - hierbei auf die Fahrtrichtung achten!
** Hier auf die Koordinaten klicken, diese können dann aus dem Suchfeld kopiert werden
** Im Browser zurückgehen, bis die Route wieder sichtbar ist (zum späteren Datenabgleich)
** Waypoints in FHEM deklarieren, Daten aktualisieren (set <device> update)
** distance + duration mit den Daten von Google-Maps am PC abgleichen

== to Do ==
* Reading error_message löschen wenn update erfolgreich
* deutsche Commandref

== Weblinks ==
* {{Link2Forum|Topic=56045|LinkText=Modul Vorstellung und Diskussionen}}
* [http://fhem.de/commandref.html#TRAFFIC Commandref]
* [https://console.developers.google.com/apis Google API Manager]

TRAFFIC

2016-12-19T21:06:57Z

Jmike:

{{Infobox Modul
|ModPurpose=Verkehrsdaten zu fest definierten Routen ermitteln
|ModType=d
|ModForumArea=Unterstützende Dienste
|ModTechName=98_TRAFFIC.pm
|ModOwner=jmike ([https://forum.fhem.de/index.php/topic,56045.0.html Forum] / [[Benutzer:Jmike|Wiki]])
}}

Dieses Modul erfasst Fahrzeiten in aktueller Verkehrslage mittels Google Maps Directions API.

== Features / Funktionen ==
* Distanz einer Route
* Fahrzeit ohne Verkehr
* Fahrzeit mit Verkehr
* Verzögerung der geplanten Route
* Waypoints definieren
* Ausgabesprache festlegen
* Outputs in Sekunden / Meter (raw)
* Ausgabe als Text, in Minuten, Sekunden oder als Durchschnitt
* Device STATE frei wählbar
* einstellbares Update Interval
* update-burst für Stosszeiten
* Strecke kann zusätzlich in gegengesetzte Richtung ausgelesen werden
* Ankunfszeit bei Abfahrt zum Update-Zeitpunkt
* verschiedene Travel Modes (driving, walking, bicycling und transit)
* flexibeler Update Schedule für "Stosszeiten"
* integrierte Google Map zum visualisieren der konfigurierten Route

== Voraussetzungen ==
Erstmal muss ein eigener API Key angefordert werden.
Das geht über Googles [https://console.developers.google.com/apis/ API Manager] 
Dort "Google Maps Directions API" suchen und ein neues Projekt erstellen, anschliessend API aktivieren.

Je nach FHEM Installation zusätzlich die Perl Module LWP::Simple, JSON und MIME::Base64 nach installieren: 
<code>sudo apt-get install libwww-perl</code> 
<code>sudo apt-get install libjson-perl</code> 
oder 
<code>sudo cpan -i LWP::Simple</code> 
<code>sudo cpan -i JSON</code> 
<code>sudo cpan -i MIME::Base64</code>

== Definition ==
<code> define <devicename> TRAFFIC <API-KEY> [update-interval] </code>

'''Beispiel:''' 
<code>define muc2berlin TRAFFIC ABCDEFGHIJKLMNOPQRSTVWYZ 600</code>

Der API Key muss selbstverständlich mit dem eigenen Key aus dem API Manager ersetzt werden. 
Das Interval in Sekunden ist optional, der default beträgt es 3600 (1 Stunde). 
Attribute start_address und end_address definieren.

== Readings ==
* average_delay_min
* average_duration_in_traffic_min
* average_duration_min
* delay
* delay_min
* distance
* duration
* duration_in_traffic
* duration_in_traffic_min
* duration_in_traffic_sec
* duration_min
* duration_sec
* [error_message]
* eta
* state
* status

== Befehle ==

==== update [burst-update-count] [burst-update-interval] ====
Readings manuell aktualisieren, der optionale Burst kann wie folgt genutzt werden: 
- erster Wert gibt an wie viele Updates abgearbeitet werden 
- zweiter Wert gibt an wie viele Sekunden zwischen den Updates gewartet wird 

Beispiel um für 1 Stunde alle 5min zu aktualisieren: 
<code>set <device> update 12 300</code>

== STATE ==
* Initialized - modul initialisiert
* OK - update war erfolgreich
* incomplete configuration - Konfigurationsfehler (start_address oder end_address leer)
* <APIRETURN> - Fehlermeldung von Google Maps, falls vorhanden (siehe Reading error_message)
* <Reading> - der Wert des Readings welches mit Attribut stateReading ausgewählt wurde
* disabled - das Device wurde über das Attribut disable deaktiviert

== Attribute ==

{| class="wikitable"
!Attribut
!Default Wert
!mögliche Werte
!Beschreibung
!Beispiel
|-
!align="right" |start_address
|
|<text>
|die vollständige Startadresse (erforderlich!)
|Startstr 1, 12345 Startcity
|-
!align="right" |end_address
|
|<text>
|die vollständige Zieladresse (erforderlich!)
|Zielstr 99, 99099 Zielstadt
|-
!align="right" |raw_data
|0
|0:1
|legt Readings an mit allen unbearbeiteten Werten
|
|-
!align="right" |language
|
|de, en, etc.
|Google ermittelt die Sprache automatisch falls nicht fest definiert
|de
|-
!align="right" |waypoints
|
|lat, long<nowiki>|</nowiki>lat, long
|fixe Wegpunkte auf der Strecke, mehrere Werte per pipe <nowiki>(|)</nowiki> trennen, LAT, LONG Koordinaten angeben
|48.187918, 11.590514
|-
!align="right" |returnWaypoints
|
|lat, long<nowiki>|</nowiki>lat, long
|fixe Wegpunkte für den Rückweg, mehrere Werte per pipe <nowiki>(|)</nowiki> trennen, LAT, LONG Koordinaten angeben, wenn leer werden "waypoints" in umgekehrter Reihenfolge verwendet
|48.187918, 11.590514
|-
!align="right" |disable
|0
|0:1
|Modul deaktivieren
|1
|-
!align="right" |stateReading
|
|<beliebiges-Reading>
|Name eines Readings dessen wert in den STATE des Devices geschrieben wird.
|delay_min
|-
!align="right" |outputReadings
|text
|text,min,sec,average
|konfiguration welche Readings erstellt werden sollen, eine oder mehrere Möglich.
|text min
|-
!align="right" |includeReturn
|0
|0:1
|aktiviert/deaktiviert ob die gleiche Strecke in umgekehrter Richtung hinzugefügt werden soll. Readings werden mit return_* angegeben.
|1
|-
!align="right" |verbose
|1
|0:1:2:3:4:5
|gibt vor wie ausführlich geloggt wird.
|5
|-
!align="right" |travelMode
|driving
|driving:walking:bicycling:transit
|Fortbewegungsmethode für Kalkulation
|walking
|-
!align="right" |updateSchedule
|
|<Beginn-volle-Stunde>-<Ende-volle-Stunde> [<Tag>] <update-Intervall-in-Sekunden>
|definiert einen flexiblen Zeitraum für feinere Updates, Tag als Zahl (Sonntag 0, Montag 1 etc), mehrere Definitionen per <nowiki>(|)</nowiki> getrennt
| 6-8 1 60|6-8 2 60|6-8 3 60|6-8 4 60|6-8 5 60
|-
|}

== Integrierte Karte ==
* über eine integrierte Karte kann die Hin- und Rückroute für ein Traffic Device visualisert werden
* Die Karte ist verfügbar unter: <nowiki>http://fhem-ip:port/fhem/TRAFFIC_debug?name=<TRAFFIC-DEVICE></nowiki>
* Alternativ kann "verbose" auf 5 gesetzt werden, was dazu führt, dass ein Weblink auf die jeweilige Karte im Room "TRAFFIC_debug" angelegt wird
** <code>attr <DEVICE> verbose 5</code>
** <code>set <DEVICE> update</code>
** Room / Link öffnen
*** grün visualisiert den Hinweg
*** rot visualisiert den konfigurierten Rückweg
* der Weblink (und ggf. der Room) wird entfernt sobald verbose < 5 ist

== Bekannte Probleme ==
* STATE: "REQUEST DENIED"
* Reading error_message: "This API project is not authorized to use this API"
** => API Key ist nicht aktiviert. Google API > API Manager > Google Maps Directions API > AKTIVIEREN

* STATE: "UNKNOWN_ERROR"
** => Es liegt ein Fehler bei Google vor.
** => "UNKNOWN_ERROR indicates a directions request could not be processed due to a server error. The request may succeed if you try again." [https://developers.google.com/maps/documentation/javascript/directions?hl=de]

* STATE: "OVER_QUERY_LIMIT"
** Es wurden mehr als 2500 requests pro Tag abgesetzt, update Intervalle der TRAFFIC Devices erhöhen und "burst" zu den Stosszeiten nutzen.

* STATE: "ZERO_RESULTS"
** Die Waypoint definition kann Google nicht realisieren. Statt Städtenamen besser exakte Koordinaten verwenden.

== Tips ==
* täglicher Burst Update zum Feierabend, 1 Stunde alle 5 Minuten updaten:
** <code>define FeierabendCheck AT *17:00 set <device> update 12 300</code>

* komplette Reisezeit, also Hin- und Rückweg, im STATE anzeigen:
** <code>attr <device> stateFormat {int(ReadingsVal($name,"delay_min",0)) + int(ReadingsVal($name,"return_delay_min",0))}</code>

* updateSchedule einsetzen um default update Intervall zu verfeinern
** Montag bis Freitag von 6-8 Uhr alle 60 Sekunden
** <code>attr <device> updateSchedule 6-8 1 60|6-8 2 60|6-8 3 60|6-8 4 60|6-8 5 60</code>
** jeden Tag von 17 bis 19 Uhr alle 2 Minuten
** <code>attr <device> updateSchedule 17-19 120</code>

* Waypoints definieren (Tip von erdo_king)
** In Google-Maps die gewünschte Route auswählen. (PC)
** Auf eine signifikante Stelle der Route klicken - hierbei auf die Fahrtrichtung achten!
** Hier auf die Koordinaten klicken, diese können dann aus dem Suchfeld kopiert werden
** Im Browser zurück bis die Route wieder sichtbar ist (zum späteren Datenabgleich)
** Waypoints in FHEM deklarieren, Daten aktualisieren (set <device> update)
** distance + duration mit den Daten von Google-Maps am PC abgleichen

== to Do ==
* Reading error_message löschen wenn update erfolgreich
* deutsche Commandref

== Weblinks ==
* [https://forum.fhem.de/index.php/topic,56045.0.html Modul Vorstellung und Diskussionen]
* [http://fhem.de/commandref.html#TRAFFIC Commandref]
* [https://console.developers.google.com/apis Google API Manager]

TRAFFIC

2016-12-13T07:57:31Z

Jmike:

TRAFFIC

2016-10-09T01:33:39Z

Jmike: neutrale Ausdrucksweise

TRAFFIC

2016-10-08T12:39:17Z

Jmike: neue Seite erstellt für Modul 98_TRAFFIC

{{Infobox Modul
|ModPurpose=Verkehrsdaten zu fest definierten Routen ermitteln
|ModType=d
|ModForumArea=Unterstützende Dienste
|ModTechName=98_TRAFFIC.pm
|ModOwner=jmike ([https://forum.fhem.de/index.php/topic,56045.0.html Forum] / [[Benutzer:Jmike|Wiki]])
}}

Mit diesem Modul könnt ihr eure eigenen Wegstrecken, und deren Verkehr, über Google Maps Directions API erfassen.

== Features / Funktionen ==
* Distanz einer Route
* Fahrzeit ohne Verkehr
* Fahrzeit mit Verkehr
* Verzögerung der geplanten Route
* Waypoints definieren
* Ausgabesprache festlegen
* Outputs in Sekunden / Meter (raw)
* Ausgabe als Text, in Minuten, Sekunden oder als Durchschnitt
* Device STATE frei wählbar
* einstellbares Update Interval
* update-burst für Stosszeiten
* Strecke kann zusätzlich in gegengesetzte Richtung ausgelesen werden
* Ankunfszeit bei Abfahrt zum Update-Zeitpunkt

== Voraussetzungen ==
Erstmal muss ein eigener API Key angefordert werden.
Das geht über Googles [https://console.developers.google.com/apis/ API Manager] 
Dort sucht ihr "Google Maps Directions API" und erstellt ein neues Projekt. Anschliessend stellt ihr sicher, dass die API aktiviert ist.

Eventuell müssen auch die Perl Module LWP::Simple und JSON nach installiert werden (apt-get / CPAN).

== Definition ==
<code> define <devicename> TRAFFIC <API-KEY> [update-interval] </code>

'''Beispiel:''' 
<code>define muc2berlin TRAFFIC ABCDEFGHIJKLMNOPQRSTVWYZ 600</code>

Der API Key muss selbstverständlich mit dem Key von aus dem API Manager ersetzt werden. 
Das Interval in Sekunden ist optional, der default beträgt es 3600 (1 Stunde).

== Readings ==
* average_delay_min
* average_duration_in_traffic_min
* average_duration_min
* delay
* delay_min
* distance
* duration
* duration_in_traffic
* duration_in_traffic_min
* duration_in_traffic_sec
* duration_min
* duration_sec
* [error_message]
* eta
* state
* status

== Befehle ==

==== update [burst-update-count] [burst-update-interval] ====
Readings manuell aktualisieren, der optionale Burst kann wie folgt genutzt werden: 
- erster Wert gibt an wie viele Updates abgearbeitet werden 
- zweiter Wert gibt an wie viele Sekunden zwischen den Updates gewartet wird 

Beispiel um für 1 Stunde alle 5min zu aktualisieren: 
<code>set <device> update 12 300</code>

== STATE ==
* Initialized - modul initialisiert
* OK - update war erfolgreich
* incomplete configuration - Konfigurationsfehler (start_address oder end_address leer)
* <APIRETURN> - Fehlermeldung von Google Maps, falls vorhanden (siehe Reading error_message)
* <Reading> - der Wert des Readings welches mit Attribut stateReading ausgewählt wurde
* disabled - das Device wurde über das Attribut disable deaktiviert

== Attribute ==

{| class="wikitable"
!Attribut
!Default Wert
!mögliche Werte
!Beschreibung
!Beispiel
|-
!align="right" |start_address
|
|<text>
|die vollständige Startadresse (erforderlich!)
|Startstr 1, 12345 Startcity
|-
!align="right" |end_address
|
|<text>
|die vollständige Zieladresse (erforderlich!)
|Zielstr 99, 99099 Zielstadt
|-
!align="right" |raw_data
|0
|0:1
|legt Readings an mit allen unbearbeiteten Werten
|
|-
!align="right" |language
|
|de, en, etc.
|Google ermittelt die Sprache automatisch falls nicht fest definiert
|de
|-
!align="right" |waypoints
|
|lat, long<nowiki>|</nowiki>lat, long
|fixe Wegpunkte auf der Strecke, mehrere Werte per pipe <nowiki>(|)</nowiki> trennen, LAT, LONG Koordinaten angeben
|48.187918, 11.590514
|-
!align="right" |disable
|0
|0:1
|Modul deaktivieren
|1
|-
!align="right" |stateReading
|
|<beliebiges-Reading>
|Name eines Readings dessen wert in den STATE des Devices geschrieben wird.
|delay_min
|-
!align="right" |outputReadings
|text
|text,min,sec,average
|konfiguration welche Readings erstellt werden sollen, eine oder mehrere Möglich.
|text min
|-
!align="right" |includeReturn
|0
|0:1
|aktiviert/deaktiviert ob die gleiche Strecke in umgekehrter Richtung hinzugefügt werden soll. Readings werden mit return_* angegeben.
|1
|-
!align="right" |verbose
|1
|0:1:2:3:4:5
|gibt vor wie ausführlich geloggt wird.
|5
|-
|}

== Bekannte Probleme ==
* STATE: "REQUEST DENIED"
* Reading error_message: "This API project is not authorized to use this API"
** => Aktiviere deinen API Key, Google API > API Manager > Google Maps Directions API > AKTIVIEREN anklicken

* STATE: "UNKNOWN_ERROR"
** => Es liegt ein Fehler bei Google vor.
** => "UNKNOWN_ERROR indicates a directions request could not be processed due to a server error. The request may succeed if you try again." [https://developers.google.com/maps/documentation/javascript/directions?hl=de]

* STATE: "OVER_QUERY_LIMIT"
** Du hast mehr als 2500 requests pro Tag abgesetzt, erhöhe die Intervalle der TRAFFIC Devices und nutze "burst" zu den Stosszeiten.

== Tips ==
* täglicher Burst Update zum Feierabend, 1 Stunde alle 5 Minuten updaten:
<code>define FeierabendCheck AT *17:00 set <device> update 12 300</code>

* komplette Reisezeit, also Hin- und Rückweg, im STATE anzeigen:
<code>attr <device> stateFormat {int(ReadingsVal($name,"delay_min",0)) + int(ReadingsVal($name,"return_delay_min",0))}</code>

* Waypoints definieren (Tip von erdo_king)
** In Google-Maps die gewünschte Route auswählen. (PC)
** Auf eine signifikante Stelle der Route klicken - hierbei auf die Fahrtrichtung achten!
** Hier auf die Koordinaten klicken, diese können dann aus dem Suchfeld kopiert werden
** Im Browser zurück bis die Route wieder sichtbar ist (zum späteren Datenabgleich)
** Waypoints in FHEM deklarieren, Daten aktualisieren (set update)
** distance + duration mit den Daten von Google-Maps am PC vergleichen, dann kann man sicher sein, dass die Strecke dieselbe ist!

== to Do ==
* Reading error_message löschen wenn update erfolgreich
* deutsche Commandref

== Weblinks ==
* [https://forum.fhem.de/index.php/topic,56045.0.html Modul Vorstellung und Diskussionen]
* [http://fhem.de/commandref.html#TRAFFIC Commandref]
* [https://console.developers.google.com/apis Google API Manager]