Documentation
Notifications
Alerting
Triggers an alarm when one of the sensor variables becomes active.
| ARM_GetLastAlertID | Returns the ID of the variable that last triggered an alarm. |
| ARM_SetActive | Switches the alarming module with the InstanceID __InstanceID__ to the value __Value__ (true = On; false = Off). |
| ARM_SetAlert | Switches the alarm with the InstanceID __InstanceID__ to the value __Value__ (true = On; false = Off). |
Notification
Enables multi-level notification, with the level increasing after a defined time and resetting when acknowledged.
| BN_IncreaseLevel | Increases the level and performs the action |
| BN_Reset | Resets the notification level and disables the chain |
| BN_SetNotifyLevel | Sets the notification to a specified level |
Announcement
The 'Announcement' Module provides the ability to play audio generated by AWS Polly through Sonos or Media Player.
| DS_Play | Plays the text as an announcement. |
Dynamic Mail
Sends an e-mail with a dynamic text.
| DM_SendMail | Use the subject and text to send an e-mail. |
Done Notifier
Reports after a dead time, after a device has fallen below a certain consumption.
IMAP
Funktionen zum IMAP-Modul zur Abfrage von E-Mails
| IMAP_DeleteMail | deletes a mail with a specific e-mail(UID) |
| IMAP_GetCachedMails | The command returns an array containing information about the cached emails of an IMAP instance with ID __InstanceID__. Should the instance not exist, an alert is generated. |
| IMAP_GetMailEx | This command loads an email with the UID __UID__ from the IMAP instance with ID __InstanceID__ and returns an array containing the data of the e-mail. Should the instance or an e-mail with the given UID not exist, an alert is generated. |
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 | Sets the position marker in the media player with the ID __InstanceID__ to the specified __Seconds__. The title must be played at execution time already. |
| 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 | deletes a mail with a specific e-mail(UID) |
| POP3_GetCachedMails | The command returns an array containing information about the cached e-mails of a POP3 instance with ID __InstanceID__. Should the instance not exist, an alert is generated. |
| POP3_GetMailEx | returns an array with information for a specific e-mail (UID) |
Popup Module
Stylistic module for display in Visualization
SMS
Functions for sending SMS via SMS module
| SMS_Send | versendet eine E-Mail an die Standardadresse |
SMTP
Functions for the SMTP module for sending e-mails
| SMTP_SendMail | versendet eine E-Mail an die Standardadresse |
| SMTP_SendMailAttachment | sends an e-mail with attachment to the default address |
| SMTP_SendMailAttachmentEx | sends an email with an attachment to any address |
| SMTP_SendMailEx | versendet eine E-Mail an eine beliebige Adresse |
| SMTP_SendMailMedia | sends an email with an attachment of a media object of type "image/sound" to the default address |
| SMTP_SendMailMediaEx | sends an e-mail with an attachment of a media object of the "image/sound" type to any address |
Spotify
Controls the playback of Spotify
| SPO_MakeAPIRequest | Makes a request to the Spotify web API with the specified parameters |
| SPO_NextTrack | If a current playback exists, the next song will be played. |
| SPO_Pause | If a current playback exists, it will be paused. |
| SPO_Play | If a current, possibly paused, playback exists, it will be continued. |
| SPO_PlayURI | Plays the Spotify resource with the URI __URI__ on the currently selected device. |
| SPO_PreviousTrack | If a current playback exists, the previous song will be played. |
| SPO_ResetToken | Resets the OAuth-token and thus the link to the Spotify account. |
| SPO_SetRepeat | Sets the repeat to the value Repeat. |
| SPO_SetShuffle | If Shuffle is true, random playback is enabled, otherwise disabled. |
Fault Manager
Indicates when selected variables are active and can acknowledge them depending on the setting.
SymconReport
Creates a report as CSV or PDF depending on the modules
| MailReport | Creates a CSV report of archive values and sends it by e-mail(SMTP) | ||||
| |||||
| PDFReport (Energy) | Creates a report of archive values of two variables of a time span as PDF | ||||
| |||||
| PDFReport (Multi) | Creates a report of archive values of several variables of a time span as PDF | ||||
| |||||
| PDFReport (Multi Energy) | |||||
| PDFReport (Single) | Creates a report of archive values of a variable with min/max/avg of a time span as PDF | ||||
| |||||
Phone Announcement
The Telephone Announcement Module enables the convenient linking of a VoIP instance and a text-to-speech instance (AWS Polly) to call a phone number and output a text when the call is answered. In addition, the module can respond to DTMF tones and output other texts.
| TA_StartCall | Starts a call based on the current setting. |
| TA_StartCallEx | Starts a call to a phone number and outputs the text |
Phone Chain
The 'Phone Chain' module allows to call a list of telephone numbers one after another.
TelegramBot
Allows to send messages and perform actions
Text to Speech
Functions for controlling a TTS module
| TTS_GenerateFile | generiert eine WAV Datei mit dem gewünschten Text |
| TTS_Speak | spricht einen beliebigen Text auf der gewählten Soundkarte |
TTSAWSPolly
Can generate sound files in various formats
| TTSAWSPOLLY_GenerateData | Queries the text via AWS and returns the speech data in the return. |
| TTSAWSPOLLY_GenerateFile | Queries the text via AWS and returns the file name to the vocie data. |
Consumption Alert
Monitors a counter variable for unusual consumption.
| VBA_CheckAlert | Checks whether a limit value is exceeded |
Water Alert
Monitors a meter variable for unnatural water consumption (leak/break).
| WAA_CheckAlert | Checks whether the limit values have been exceeded |
Watchdog
Monitors variables and triggers an alarm if they have not been updated or changed for too long.
| WD_GetAlertTargets | returns an array with the overdue variables |
| WD_SetActive | de-/activate the instance |