iobroker.alarm 3.1.1 → 3.2.0

package/.github/workflows/test-and-release.yml

@@ -28,9 +28,9 @@ jobs:
         node-version: [16.x]
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -44,8 +44,8 @@ jobs:
 #          CI: true
       # - name: Lint TypeScript code
       #   run: npm run lint
-#      - name: Test package files
-#        run: npm run test:package
+      - name: Test package files
+        run: npm run test:package
 
   # Runs adapter tests on all supported node versions and OSes
   adapter-tests:
@@ -56,29 +56,29 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        node-version: [12.x, 14.x, 16.x]
+        node-version: [14.x, 16.x, 18.x]
         os: [ubuntu-latest, windows-latest, macos-latest]
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
 
       - name: Install Dependencies
         run: npm ci
 
-      - name: Run local tests
-        run: npm test
-#      - name: Run unit tests
-#        run: npm run test:unit
-#      - name: Run integration tests # (linux/osx)
-#        if: startsWith(runner.OS, 'windows') == false
-#        run: DEBUG=testing:* npm run test:integration
-#      - name: Run integration tests # (windows)
-#        if: startsWith(runner.OS, 'windows')
-#        run: set DEBUG=testing:* & npm run test:integration
+#      - name: Run local tests
+#        run: npm test
+      - name: Run unit tests
+        run: npm run test:unit
+      - name: Run integration tests # (linux/osx)
+        if: startsWith(runner.OS, 'windows') == false
+        run: DEBUG=testing:* npm run test:integration
+      - name: Run integration tests # (windows)
+        if: startsWith(runner.OS, 'windows')
+        run: set DEBUG=testing:* & npm run test:integration
 
   # Deploys the final package to NPM
   deploy:
@@ -96,10 +96,10 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -139,3 +139,18 @@ jobs:
           # Prerelease versions create prereleases on Github
           prerelease: ${{ contains(steps.extract_release.outputs.VERSION, '-') }}
           body: ${{ steps.extract_release.outputs.BODY }}
+
+      - name: Notify Sentry.io about the release
+        run: |
+          npm i -g @sentry/cli
+          export SENTRY_AUTH_TOKEN=${{ secrets.SENTRY_AUTH_TOKEN }}
+          export SENTRY_URL=https://sentry.iobroker.net
+          export SENTRY_ORG=iobroker
+          export SENTRY_PROJECT=iobroker-backitup
+          export SENTRY_VERSION=iobroker.backitup@${{ steps.extract_release.outputs.VERSION }}
+          sentry-cli releases new $SENTRY_VERSION
+          sentry-cli releases set-commits $SENTRY_VERSION --auto
+          sentry-cli releases finalize $SENTRY_VERSION
+
+        # Add the following line BEFORE finalize if sourcemap uploads are needed
+        # sentry-cli releases files $SENTRY_VERSION upload-sourcemaps build/

package/README.md

@@ -14,144 +14,26 @@
 
 [![paypal](https://www.paypalobjects.com/en_US/DK/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ZYHW84XXF5REJ&source=url)
 
-**[English description](https://github.com/misanorot/ioBroker.alarm/blob/master/lib/Readme_en.md)**
+## Alarmanlage für ioBroker
 
-## ioBroker Alarm
+**[Deutsche Beschreibung](docs/de/alarm.md)**
 
+## Alarmsystem for ioBroker
 
-Dies ist ein Adapter, mit dem sich eine kleine Alarmanlage ohne große programmiertechnische Vorkenntnisse realisieren lässt.
-Er bietet die Möglichkeit 3 Sicherheitskreise zu konfigurieren und diese z. B. bei Nachtruhe oder De- und Aktivierung zu überwachen. Des Weiteren ist
-eine direkte Verknüpfung der jeweiligen Instanz "states", auf andere "states" möglich. Diese Verknüpfungen werden im Reiter Verknüpfungen angelegt.
+**[English description](docs/en/alarm_en.md)**
 
-----------------------------------------------------------------------------------------------------------------------
-
-### Tab Haupteinstellungen
-
-Hier werden die Einstellungen wie die Zeiten der Nachtruhe, Sirenezeit, Stiller-Alarm und Passwort vorgenommen.
-
-
-- Aktivierzeit -> Zeitverzögerung bis zu Aktivierung wenn man einen delay Datenpunkt benutzt
-- Sirenenzeit bei Einbruch -> Bei Einbruch wird der Datenpunkt alarm.0.status.siren / siren_inside für die Zeit auf true gesetzt
-- Alarmverzögerung -> Verzögerungszeit bis Einbruch ausgelöst wird (während dieser Zeit wird der Stille Alarm ausgelöst)  
-
-
-----------------------------------------------------------------------------------------------------------------------
-
-### Tab Benachrichtigungen
-
-Benachrichtigungen über Andere Adapter wie z. B. Telegramm, Email oder andere.
-[Probleme](#Probleme)
-
-Bei Benachrichtigungen an den Telegram Adapter, ist es möglich User- oder Chat IDs zu benutzen.
-
-----------------------------------------------------------------------------------------------------------------------
-
-### Tab Überwachung
-
-Hier werden die Kreise der Anlage konfiguriert.
-*die Namen der states lassen sich ändern*
-
-Der Alarmkreis hat die Priorität „hoch" und hat bei aktivierter Anlage (scharf) Vorrang vor allen anderen Kreisen. Er dient zur eigentlichen Überwachung der Anlage. Dies entspricht den Vollschutz  einer Alarmanlage. Der scharf intern Kreis wird überwacht, wenn die Anlage sich im Zustand scharf intern befindet, dies entspricht einem Außenhautschutz einer Alarmanlage. Der Meldekreis dient nur zur Meldung während der Zustände scharf, scharf intern und bei der Nachtruhe.
-*Es ist durchaus möglich, dass man für einem state, den Haken bei allen drei Kreisen macht.*
-
-Sollte man einen Kontakt haben, der den Alarmkreis nicht sofort auslösen soll, kann man das Häkchen bei "stiller Alarm" aktivieren, dadurch wird nach Ablauf der eingestellten Zeit (Haupteinstellungen), der Alarm ausgelöst.
-
-Sollte es erforderlich sein die Einzelnen States nicht auf *true*, sondern auf *false* zu triggern (z.B. Drahtbruchsichere Sensoren), so kann man das Häkchen bei "negieren" setzen.
-
-Sollte man im Tab Haupteinstellungen die Option "verlassen" aktiviert haben, kann man unter dem entsprechenden Datenpunkt "verlassen" anwählen. Dies bewirkt, dass bei verzögerte Aktivierung, der Countdown nicht ablaufen muss, sondern es reicht z. B. die Tür zu schließen.
-
-
-Die Kreise werden folgendermaßen überwacht:
-
-#### Alarmkreis:
-Alarmanlage lässt sich nicht aktivieren (scharf schalten) wenn ein konfigurierter state aktiv ist. Bei aktivierter Alarmanlage führt eine Veränderung sofort zur Auslösung der Anlage.
-
-#### Scharf intern Kreis:
-Alle hier konfigurierten states werden beim Zustand scharf intern überwacht und lösen unter anderem den internen Alarm aus.
-
-#### Meldekreis:
-Der überwacht die konfigurierten states auf Veränderungen und meldet dies.
-
-
-----------------------------------------------------------------------------------------------------------------------
-
-### Tab Sprachausgabe
-
-Ist eine gewünschte Sprachausgabe z. B. bei Änderung des Zustandes gewünscht, lässt sich das hier mit den gewünschten Sätzen konfigurieren.
-*Man muss sich sicher sein, das der ausgewählte Datenpunkt, mit einem Text beschrieben werden kann! Z.B. "sayit.0.tts"*
-
-Möchte man sich die Ausgabe von Namen mit Ansagen lassen, kann man diese Option anwählen.
-
-----------------------------------------------------------------------------------------------------------------------
-
-### Tab Verknüpfungen
-
-Hier ist es möglich Adapter interne states direkt mit externen states zu verknüpfen. Somit ist ein Umweg über ein Skript oder ähnlichen nicht erforderlich.
-Es lässt sich somit z. B. bei Beginn der Nachtruhe, eine Verriegelung des Türschlosses realisieren.
-![Logo](admin/img/short.png)
-
-#### Eingabeverknüpfungen
-
-Trigger--> any = es wird bei jeder Änderung getriggert
-					 ne = es wird nur getriggert, wenn der Wert sich geändert
-
-Auslösewert--> Ist der Wert, auf welchen getriggert werden soll
-
-----------------------------------------------------------------------------------------------------------------------
-
-### Tab Andere Alarme
-
-Es stehen einen zwei frei konfigurierbare Überwachungskreise zu Verfügung, diese werden bei Benutzung unabhängig dem Zustand der Alarmanlage ständig überwacht!
-Als Voreinstellung sind diese als Feuer- und Wasseralarm beschriftet. In der ganzen Konfiguration sind diese als Kreise 1 und 2 beschriftet und an den Nummern zu erkennen.
-
-Sollte es erforderlich sein die Einzelnen States nicht auf *true*, sondern auf *false* zu triggern (z.B. Drahtbruchsichere Sensoren), so kann man das Häkchen bei "negieren" setzen.
-
-####Es ist darauf zu achten, dass keine States aus dem eigentlichen Hauptüberwachungskreisen benutzt werden!
-
-----------------------------------------------------------------------------------------------------------------------
-
-Der Adapter liefert eine ganze Anzahl an states:
-
-#### "alarm.x.use.....".
-Das sind die eigentlichen states um die Alarmanlage zu bedienen.
-
-- use.activate_nightrest -> Aktivierung der Nachtruhe
-- use.activate_sharp_inside_circuit -> Aktivierung der Überwachung des Warnkreises (intern scharf)
-- use.disable -> Deaktivierung der Anlage (Alarmkreis)
-- use.enable -> Aktivierung der Anlage (Alarmkreis)
-- use.enable_with_delay -> Aktivierung der Anlage (Alarmkreis) mit Verzögerungszeit
-- use.list -> Deaktivierung/Aktivierung/Warnkreis/Aktivierung mit Verzögerungszeit
-- use.quit_changes -> Rücksetzen der states *info.notification_circuit_changes, info.sharp_inside_siren, status.activation_failed, other_alarms.one_changes, other_alarms.two_changes*
-- use.toggle_password -> Deaktivierung/Aktivierung der Anlage (Alarmkreis) mit Passwort
-- use.toggle_with_delay -> Deaktivierung/Aktivierung der Anlage (Alarmkreis) mit Verzögerungszeit
-- use.toggle_with_delay_and_password -> Deaktivierung/Aktivierung der Anlage (Alarmkreis) mit Passwort und Verzögerungszeit
-- use.panic -> Händische Auslösung der Alarmanlage(Einbruch), auch wenn diese deaktiviert ist
-
-
-
-#### "alarm.x.status...."
-Hier lässte sich der Zustand der Anlage ablesen.
-
-- status.sleep -> Signalisiert den Zustand der automatischen Nachtruhe
-
-#### "alarm.x.info...."
-Liefert zusätzliche Informationen wie z.B. welche "Türen offen sind" oder einen Log state.
-Der log_today state wird um Mitternacht geleert.
-
-#### "alarm.x.other_alarms...."
-Beinhaltet die Informationen für die "anderen" Alarmkreise 1 + 2.
-
-----------------------------------------------------------------------------------------------------------------------
-
-## Probleme
-	- wenn man eine Telegram oder ähnliches über das + hinzufügt, kann man nur ein state der Instanz auswählen und  man muss bis auf *telegram.0* alles löschen.
-
-
-#### Wichtig, die Benutzung dieses Adapters geschieht auf eigene Gefahr, für etwaige Fehlfunktionen wird keine Haftung übernommen!
+******************************************************************************************
 
+## Changelog
 
+#### 3.2.0 (15.10.2022)
+* (misanorot) fixed enableable
+* (misanorot) added presence simulation
+* (misanorot) added zones
+* (misanorot) fixed set number states
 
-## Changelog
+#### 3.1.1 (29.06.2022)
+* (MK-2001) added speech delay
 
 #### 3.1.0 (26.04.2022)
 * (misanorot) added speech delay