Dokumentation
Benachrichtigungen
Benachrichtigungen bezeichnen die verschiedenen Wege, wie Symcon sich bei einem Nutzer melden und diesen informieren kann. Dies bezeichnet den Umfang von Audiovisuell bis hin zu monatlichen Reports via E-Mail.
Alarmierung
Löst einen Alarm aus, wenn eine der Sensorenvariablen aktiv wird.
| ARM_GetLastAlertID | Gibt die ID der Variable zurück, die als letztes einen Alarm ausgelöst hat. |
| ARM_SetActive | Schaltet das Alarmierungsmodul mit der InstanzID __InstanzID__ auf den Wert __Value__ (true = An; false = Aus). |
| ARM_SetAlert | Schaltet den Alarm mit der InstanzID __InstanzID__ auf den Wert __Value__ (true = An; false = Aus). |
Benachrichtigung
Ermöglicht eine mehrstufige Benachrichtigung, wobei die Stufe sich nach einer definierten Zeit erhöht und bei einer Quittierung zurückgesetzt wird.
| BN_IncreaseLevel | Erhöht die Stufe und führt die Aktion aus |
| BN_Reset | Setzt die Benachrichtigungsstufe zurück und deaktiviert die Kette |
| BN_SetNotifyLevel | Setzt die Benachichtigung auf eine vorgegebene Stufe |
Durchsage
Das Durchsage Modul bietet die Möglichkeit von AWS Polly erzeugte Audiodaten über Sonos oder den Media Player wiederzugeben.
| DS_Play | Spielt den Text als Durchsage ab. |
Dynamische E-Mail
Versendet eine E-Mail mit einem dynamischen Text.
| DM_SendMail | Nutzt den Betreff und Text um eine E-Mail zu versenden. |
FertigMelder
Meldet nach einer Totzeit, nachdem ein Gerät einen gewissen Verbrauch unterschritten hat.
IMAP
Funktionen zum IMAP-Modul zur Abfrage von E-Mails
| IMAP_DeleteMail | löscht eine Mail mit einer bestimmten E-Mail(UID) |
| IMAP_GetCachedMails | gibt ein Array zu den gecachten E-Mails zurück |
| IMAP_GetMailEx | liefert ein Array mit Informationen zu einer bestimmten E-Mail(UID) wieder |
MediaPlayer
Funktionen zur Ansteuerung von Mediaplayer-Instanzen
| WAC_AddFile | fügt Musikdatei zur Playlist hinzu |
| WAC_ClearPlaylist | löscht die Playlist |
| WAC_GetPlaylistLength | löscht die Playlist |
| WAC_GetPlaylistPosition | löscht die Playlist |
| WAC_Next | spielt den nächsten Titel der Playlist ab |
| WAC_Pause | pausiert die Wiedergabe |
| WAC_Play | spielt die Playlist ab |
| WAC_PlayFile | spielt eine Musikdatei direkt ab |
| WAC_Prev | spielt den vorherigen Titel der Playlist ab |
| WAC_SetPlaylistPosition | löscht die Playlist |
| WAC_SetPosition | setzt den Positionsmarker auf eine bestimmte Sekunde |
| WAC_SetRepeat | schaltet die Wiederholung der Playlist ein/aus |
| WAC_SetShuffle | schaltet die Zufallswiedergabe ein/aus |
| WAC_SetVolume | setzt die Lautstärke |
| WAC_Stop | stoppt die Wiedergabe |
POP3
Funktionen zum POP3-Modul zur Abfrage von E-Mails
| POP3_DeleteMail | löscht eine Mail mit einer bestimmten E-Mail(UID) |
| POP3_GetCachedMails | gibt ein Array zu den gecachten E-Mails zurück |
| POP3_GetMailEx | liefert ein Array mit Informationen zu einer bestimmten E-Mail(UID) wieder |
Popup Modul
Stilistisches Modul zur Darstellung
SMS
Funktionen zum Versenden von SMS via SMS-Modul
| SMS_Send | versendet eine E-Mail an die Standardadresse |
SMTP
Funktionen zum SMTP-Modul zur Versendung von E-Mails
| SMTP_SendMail | versendet eine E-Mail an die Standardadresse |
| SMTP_SendMailAttachment | versendet eine E-Mail mit Anhang an die Standardadresse |
| SMTP_SendMailAttachmentEx | versendet eine E-Mail mit Anhang an eine beliebige Adresse |
| SMTP_SendMailEx | versendet eine E-Mail an eine beliebige Adresse |
| SMTP_SendMailMedia | versendet eine E-Mail mit Anhang eines Medienobjekts vom Typ "Bild/Ton" an die Standardadresse |
| SMTP_SendMailMediaEx | versendet eine E-Mail mit Anhang eines Medienobjekts vom Typ "Bild/Ton" an eine beliebige Adresse |
Spotify
Steuert die Wiedergabe von Spotify
| SPO_MakeAPIRequest | Stellt eine Anfrage an die Spotify Web-API mit den angegebenen Parametern |
| SPO_NextTrack | Existiert eine aktuelle Wiedergabe, so wird der nächste Song abgespielt. |
| SPO_Pause | Existiert eine aktuelle Wiedergabe, so wird diese pausiert. |
| SPO_Play | Existiert eine aktuelle, möglicherweise pausierte, Wiedergabe, so wird diese fortgesetzt. |
| SPO_PlayURI | Spielt die Spotify-Resource mit der URI __URI__ auf dem aktuell ausgewähltem Gerät ab. |
| SPO_PreviousTrack | Existiert eine aktuelle Wiedergabe, so wird der vorherige Song abgespielt. |
| SPO_ResetToken | Setzt die OAuth-Token und somit die Verknüpfung mit dem Spotify-Konto zurück. |
| SPO_SetRepeat | Setzt die Wiederholung auf den Wert Repeat. |
| SPO_SetShuffle | Ist Shuffle true, so wird die zufällige Wiedergabe aktiviert, ansonsten deaktiviert. |
Störungsmanager
Zeigt an, wenn ausgewählte Variablen aktiv sind und kann diese je nach Einstellung quittieren.
SymconReport
Erstellt je nach Module ein Report als CSV oder PDF
| MailReport | Erstellt einen CSV-Report von Archivwerten und sendet diesen per E-Mail(SMTP) | ||||
| |||||
| PDFReport (Energie) | Erstellt ein Report von Archivwerten zweier Variablen einer Zeitspanne als PDF | ||||
| |||||
| PDFReport (Multi) | Erstellt einen Report von Archivwerten mehrerer Variablen einer Zeitspanne als PDF | ||||
| |||||
| PDFReport (Multi Energie) | |||||
| PDFReport (Single) | Erstellt einen Report von Archivwerten einer Variable mit Min/Max/Avg einer Zeitspanne als PDF | ||||
| |||||
Telefonansage
Das Telefonansage-Modul ermöglicht die komfortable Verknüpfung einer VoIP-Instanz und einer Text-to-Speech-Instanz (AWS Polly) um eine Telefonnummer anzurufen und bei Annahme des Anrufs einen Text auszugeben. Darüber hinaus, kann das Modul auf DTMF-Töne reagieren und weitere Texte ausgeben.
| TA_StartCall | Startet einen Anruf auf Basis der aktuellen Einstellung. |
| TA_StartCallEx | Startet einen Anruf an eine Telefonnummer und gibt den Text aus |
Telefonkette
Das Telefonkette-Modul ermöglicht es eine Liste von Telefonnummern nacheinander anzurufen.
TelegramBot
Erlaubt das Versenden von Nachrichten an angegebene Personen und Ausführen von Aktionen
Text to Speech
Funktionen zum Ansteuern eines TTS-Moduls
| TTS_GenerateFile | generiert eine WAV Datei mit dem gewünschten Text |
| TTS_Speak | spricht einen beliebigen Text auf der gewählten Soundkarte |
TTSAWSPolly
Kann Sounddaten/-dateien in verschiedenen Formaten erzeugen
| TTSAWSPOLLY_GenerateData | Fragt über AWS den Text an und liefert die Sprachdaten in der Rückgabe zurück. |
| TTSAWSPOLLY_GenerateFile | Fragt über AWS den Text an und liefert den Dateinamen zu den Sprachdaten zurück. |
VerbrauchsAlarm
Überwacht eine Zähler-Variable auf unnatürlichen Verbrauch.
| VBA_CheckAlert | Kontrolliert ob ein Grenzwert überschritten wird |
Wasser-Alarm
Überwacht eine Zähler-Variable auf unnatürlichen Wasserverbrauch (Leck/Bruch).
| WAA_CheckAlert | Kontrolliert ob die Grenzwerte überschritten wurden |
Watchdog
Überwacht Variablen und löst einen Alarm aus, wenn diese zu lange nicht aktualisiert oder geändert wurden.
| WD_GetAlertTargets | gibt ein Array mit den überfälligen Variablen zurück |
| WD_SetActive | De-/aktiviert die Instanz |