german readme needed?
german readme
This adapter can detect by means of measurement sockets whether a device is switched on, in operation or has been switched off and react to it. Messages can then be issued automatically via Telegram, whatsapp, alexa, sayit, pushover and email (multiple selection per device possible). It is also possible to automatically turn off the outlet after the process is completed (also time delayed). With given runtime it is possible to output an alarm per datapoint (with external script, the datapoint delivers only true/false or as display in the vis). For this it is sufficient to enter the pre-gating time simply in minutes into the datapoint 'device-reminder.X.XXX.config.runtime max'.
The refresh interval of the "live consumption value (is called "_energy ")" for most devices should not be more than 10 seconds, otherwise it can lead to very delayed messages. The adapter itself polls the values every 10 seconds and uses new values event-based. This saves the system
Command in the Tasmota console : TelePeriod 10
- Notification at device start
- Notification at the end of the process of the respective device
- Telegram notification (multiple IDs are possible)
- Alexa notification (multiple IDs are possible)
- WhatsApp notification (multiple IDs are possible)
- Pushover notification (multiple IDs are possible)
- Email notification (multiple IDs are possible)
- Notifications can be created freely or also specified by an external script
- Data points with current status, live consumption and last sent status message to use values from this adapter in other scripts
- Devices can be switched off on demand (also time delayed), if process was detected finished
- Voice assistants can be temporarily disabled per datapoint
- Runtime monitoring in minutes: If the time is exceeded, an alarm is sent to all selected messengers
For each group of devices, alexa etc. there is a button "Check input". If this button is clicked, the existing entries are checked for plausibility and you get an immediate response whether all entries are correct. If you have made changes, this button must always be clicked!
- device name: Freely selectable name
- device type: here you have to select which device it is, so that the calculations in the adapter can be carried out correctly.
- consumption: Click on the button with the three white dots to open your object management. The data point that displays the current live consumption must be selected.
- total consumption: Click on the button with the three white dots to open your object management. The data point that displays the total consumption must be selected. (not mandatory)
- switch on/off: Clicking on the button with the three white dots opens your object management. The data point that switches your socket on/off must be selected. (not mandatory)
- Start text: Notification to be sent when the device is started (special characters are also possible)
- End text: Notification to be sent when the unit has finished its operation (special characters are also possible)
With Start text and End text you can also get a message from an external data point. This message is read from the data point with a delay of 1 second after the status of the unit has changed. In this way, you can have a message created by an external script. The adapter automatically recognises whether a message comes from a data point or whether it was simply entered manually. To select a data point, simply click on the button with the three white dots and then select the corresponding data point. Please note: only either a data point or a manually entered message can be used!
- total consumption: If the data point returns Wh, use the placeholder {consumption in Wh}, otherwise {consumption}. There is always a conversion to kWh
An example of the end text: 'The washing machine is ready. Consumption: {consumption in Wh} kWh'
- Runtime output: {runtime}
An example of the end text: 'The washing machine is ready. Running time: {runtime}'
- alexa name: Freely selectable name, special characters are also possible.
- alexa "announcement"/"speak ": The data point that lets your Alexa speak must be selected here. To select the data point, simply click on the button with the three small white dots.
- Volume 0-100: Volume at which your Alexa should speak (from 0 - 100%). The last 4 fields can be used to create a time period in which your Alexa is allowed to speak. By default, the period from 00:00 - 23:59 is active.
- active from hour: Start time in hours
- active from minutes: Start time in minutes
- inactive from hour: End time in hours
- inactive from minutes: End time in minutes
- sayit name: Freely selectable name, special characters are also possible.
- sayit path "sayit/../text ": Select the data point "text" in the respective sayIt device folder. The text output is sent here.
- volume 0-100: Volume with which your sayIt device should speak (from 0 - 100%).
- active from hour: Start time in hours
- active from minutes: Start time in minutes
- inactive from hour: End time in hours
- inactive from minutes: End time in minutes
- name: Freely selectable name, special characters are also possible.
- pushover instance ": the instance to send to
- priority: The priority with which the message is to be sent
- sound: The sound to play when Pushover receives the message.
- name: Freely selectable name, special characters are also possible.
- sender address: Email address from which the email is sent
- receiver address: Email address that is to receive the message
These values were determined over a period of several months and with the help of numerous testers. Changes to the values can lead to devices no longer being recorded correctly, resulting in false reports.
These values can be customised by the user and then used. The following is the explanation:
- Threshold 'Start' (Watt): Start value in watts that must be exceeded for the device to be recognized as started.
- Threshold value 'End' (Watt): End value in watts that must be undershot for the device to be recognized as terminated.
- Threshold 'Standby' (Watt): Threshold value to indicate device as "OFF" or "IN STANDBY". If the currently calculated value is below the Standy threshold, the device is recognized as switched off.
- Number of start values: This specifies how often the "start value" must be exceeded in succession. Falling below this value once will result in a start abort. The average of these values must be above the start value for the device to be recognized as started.
Example: The value should be 10W and exceeded 3 times in a row. 1. 15W, 2. 1W, 15W => start phase was aborted because the second value was below 10.. - Number of final values: This specifies how many values are to be recorded before calculating whether the device is ready. The fewer values here, the less accurate the result and the risk of false alarms increases. The higher the value, the more accurate the recording. The disadvantage, however, is that the finished message is sent with a strong delay. End is only detected when "Number of end values" is reached and the average consumption is below the "Threshold value 'End' (Watt)".
Short example calculation:
Consumption values come in every 10 seconds. Threshold 'end' (Watt) is set to 50, Number of end values is set to 100. After the device has been recognized as started, 100 values (takes 100values x 10 seconds = 1000 seconds) are recorded and only then the average value is formed. If this is below 50, after approx. 16.5 minutes (we remember number of end values = 100 values) finished is recognized and a message (if configured) goes out. If the value is above 50, nothing happens, because the device is still in operation. Each additional value now replaces the oldest and a new average is calculated after each new value.
-
active: Is activated by default. Here you can temporarily deactivate a device so that it no longer sends notifications.
-
device: is created automatically
-
Alexa: all previously created Alexas are listed here and can be added by click
-
sayit: all previously created sayit devices are listed here and can be added by clicking on them.
-
whatsapp: all automatically detected whatsapp users are listed here
-
pushover: all previously created pushover users are listed here and can be added by clicking on them.
-
email: all previously created email users will be listed here and can be added by click
-
Telegram**: All available Telegram users are listed here and can be assigned to the device by clicking on them. The respective instance is indicated in the [square] brackets.
If no names are displayed: Check whether the entry under "telegram.X.communicate.users" (the X stands for the respective instance, e.g. 0) contains the following structure: "{"ID IN NUMBERS":{"firstName": "User1"}}", if not, this can simply be adapted. The adapter searches for firstName as well as userName. You can then decide which name to send to. Only either the firstName or the userName can be selected!
-
switch off: If selected, the socket switches off automatically after the process has been completed.
-
switch off after minutes: A timeout in minutes can optionally be entered here. After the timeout has expired, the socket is switched off if auto off is activated. However, the end notification of the device remains unaffected by a timeout!
-
abort detection**: If activated, the adapter tries to detect whether a unit has already been switched off manually before the notification and then no longer notifies.
After clicking on "Save and close", a folder is created under Objects -> device-reminder for each newly created device.
- do not disturb (if activated, no messages will be sent by voice-reminder)
- runtime max
- the current state of the device
- runtime alarm
- averageConsumption (can be used as an aid to determine your own thresholds)
- the last runs in JSON format
- the last runtime in hh:mm:ss
- the current live consumption
- the message to the messengers
- the current runtime in hh:mm:ss
- the current runtime in milliseconds
is displayed.
If you like my work :
- (xenon-s) bugfix: error catching JSON last operations doesn't work
- (xenon-s) bugfix: incorrect JSON format
- (xenon-s) bugfix: issue #76 messages from datapoint were not displayed
- (xenon-s) bugfix: issue #75 "undefined is not a valid state"
- (xenon-s) Adapter structure redesigned to classes
- (xenon-s) Admin UI design and inputs made more user friendly
- (xenon-s) Telegram bug fixed
- (xenon-s) Fix for js-controller 3.3.*
- (xenon-s) new datapoints added (runtime max, last runs as JSON, last runtime, runtime max, runtime alert)
- (xenon-s) add: runtime-alert
- (xenon-s) initial commit version 1.0
- (xenon-s) bugfix: telegram instance was not recognised correctly
- (xenon-s) bugfix: abort detection prevented sending of notifications
- (xenon-s) fix telegram bug
- (xenon-s) Deleted incorrect version numbers in the io package
- (xenon-s) Data is now queried cyclically
- (xenon-s) bugfix index_m
- (xenon-s) bugfix: alexa speak-volume when input is empty
- (xenon-s) bugfix: telegram now shows both names, otherwise there were errors in the notifications
- (xenon-s) add: Device status can now be configured yourself
- (xenon-s) calculation optimised, custom / default values may have to be adjusted if they have been changed by the user
- (xenon-s) bugfix: volume sayit
- (xenon-s) add: volume alexa
- (xenon-s) DP runtime in milliseconds
- (xenon-s) bugfix main.js
- (xenon-s) config page revised to simplify the input of devices
- (xenon-s) inserted a break, so that it is recognized, if a device is switched off prematurely at the device switch
- (xenon-s) bugfix: telegram users are not always recognized correctly and displayed incorrectly
- (xenon-s) adjustable values inserted at "Type
- (xenon-s) readme extended and adapted
- (xenon-s) standby detection, even if the power outlet should not be switched off
- (xenon-s) It is now possible to get messages from an external data point and send them as start / end message
- (xenon-s) device "microwave" added
- (xenon-s) readme adapted
- (xenon-s) update to version 0.2: index_m completely revised and whatsapp added
- (xenon-s) beta release
- (xenon-s) initial commit
MIT License
Copyright (c) 2021 xenon-s ente_s@hotmail.de
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.