Merge pull request #119 from MiSchroe/MiSchroe/issue77

MiSchroe/issue77
MiSchroe · Oct 18, 2023 · 99eac24 · 99eac24
2 parents 240d589 + f16a5c0
commit 99eac24
Show file tree

Hide file tree

Showing 9 changed files with 560 additions and 5,197 deletions.
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -2,10 +2,9 @@
 
 # ioBroker.klf200
 
-![Number of Installations](http://iobroker.live/badges/klf200-installed.svg) ![Stable version](http://iobroker.live/badges/klf200-stable.svg)
-[![Travis CI](https://travis-ci.org/MiSchroe/ioBroker.klf200.svg?branch=master)](https://travis-ci.org/MiSchroe/ioBroker.klf200)
-[![Build status](https://ci.appveyor.com/api/projects/status/t28nlps5c99jy5v7/branch/master?svg=true)](https://ci.appveyor.com/project/MiSchroe/iobroker-klf200/branch/master)
-[![GitHub issues](https://img.shields.io/github/issues/MiSchroe/ioBroker.klf200.svg)](https://github.com/MiSchroe/ioBroker.klf200/issues)
+![Number of Installations](https://iobroker.live/badges/klf200-installed.svg) ![Stable version](https://iobroker.live/badges/klf200-stable.svg)
+[![Known Vulnerabilities](https://snyk.io//test/github/MiSchroe/iobroker.klf200/badge.svg?targetFile=package.json)](https://snyk.io//test/github/MiSchroe/iobroker.klf200?targetFile=package.json)
+[![Build Status](https://dev.azure.com/michaelschroeder-github/GitHub%20projects/_apis/build/status%2FMiSchroe.ioBroker.klf200?branchName=master)](https://dev.azure.com/michaelschroeder-github/GitHub%20projects/_build/latest?definitionId=3&branchName=master)[![GitHub issues](https://img.shields.io/github/issues/MiSchroe/ioBroker.klf200.svg)](https://github.com/MiSchroe/ioBroker.klf200/issues)
 [![GitHub license](https://img.shields.io/github/license/MiSchroe/ioBroker.klf200.svg)](https://github.com/MiSchroe/ioBroker.klf200/blob/master/LICENSE)
 
 [![NPM version](https://img.shields.io/npm/v/iobroker.klf200.svg)](https://www.npmjs.com/package/iobroker.klf200)
@@ -182,6 +181,10 @@ The following devices are defined:
         writable, only.
     -   subType - Depending on the category the sub type defines special kinds or
         capabilities, e.g. for a window a '1' means that the window has a rain sensor.
+    -   targetFP1Raw - Setting this state to a value different to 54272 (0xD400) lets the product
+        include this functional parameter when setting a new target position. See below for further details.
+    -   targetFP2Raw, targetFP3Raw, targetFP4Raw - Same as targetFP1Raw, but for the different
+        functional parameters.
     -   targetPosition - Set this state to a value between 0% and 100% to move a
         window or to dim a light. This state is writable.
     -   targetPositionRaw - This state reflects the target position converted to a
@@ -195,6 +198,24 @@ The following devices are defined:
         identify a device, e.g. a window will move its handle, a roller shutter
         will move up and down a little bit. This state is writable, only.
 
+##### Functional parameters
+
+The functional parameters control further aspects of the product while moving.
+Mostly they are used for controlling the speed, but they can be used for different other aspects.
+
+To use the functional parameters you have to set the values according to your need before
+you change the targetPosition state.
+
+The values of the state provide multiple manipulation modes:
+| Access method | Description | Range (Decimal) | Range (Hex) | Notes |
+|-|-|-|-|-|
+| Relative | 0% - 100% | 0 - 51200 | 0x0000 - 0xC800 | Each percent step equals 512. The product moves to that relative value, e.g. 50% open. |
+| +/- | -100% - +100% | 51456 - 53456 | ß0xC900 - 0xD0D0 | Each percent step equals 10. The product advances its position by the provided value, e.g. open the window for addition 10%. Not every product supports this method. |
+| Target | The target value for the parameter. | 53504 | 0xD100 | In case of an already running command the target value could be different to the current value. |
+| Current | The current value of the parameter. | 53760 | 0xD200 | You can use this value to stop a movement if applicable. |
+| Default | The default value for the parameter. | 54016 | 0xD300 | Sets the parameter to its default value. |
+| Ignore | The parameter won't be provided. | 54272 | 0xD400 | The parameter won't be set for the command. |
+
 #### Scenes
 
 -   scenesFound - Number of scenes found in the interface
@@ -218,7 +239,9 @@ The following devices are defined:
 -   (Michael Schroeder) [#12](https://github.com/MiSchroe/ioBroker.klf200/issues/12) Support silent mode in scenes
 -   (Michael Schroeder) [#44](https://github.com/MiSchroe/ioBroker.klf200/issues/44) Add advanced SSL configuration settings
 -   (Michael Schroeder) [#98](https://github.com/MiSchroe/ioBroker.klf200/issues/98) Fix default values
+-   (Michael Schroeder) [#77](https://github.com/MiSchroe/ioBroker.klf200/issues/77) Add silent mode to products using functional parameters
 -   (Michael Schroeder) Upgrade dependencies
+-   (Michael Schroeder) [#55](https://github.com/MiSchroe/ioBroker.klf200/issues/55) Support functional parameters FP1-4
 
 ### 1.0.1 (2020-07-20)
 

diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -0,0 +1,83 @@
+# Node.js
+# Build a general Node.js project with npm.
+# Add steps that analyze code, save build artifacts, deploy, and more:
+# https://docs.microsoft.com/azure/devops/pipelines/languages/javascript
+
+trigger:
+    - master
+
+strategy:
+    matrix:
+        linux_node16:
+            imageName: "ubuntu-latest"
+            versionName: "16.x"
+        linux_node18:
+            imageName: "ubuntu-latest"
+            versionName: "18.x"
+        linux_node20:
+            imageName: "ubuntu-latest"
+            versionName: "20.x"
+        mac_node16:
+            imageName: "macos-latest"
+            versionName: "16.x"
+        mac_node18:
+            imageName: "macos-latest"
+            versionName: "18.x"
+        mac_node20:
+            imageName: "macos-latest"
+            versionName: "20.x"
+        windows_node16:
+            imageName: "windows-latest"
+            versionName: "16.x"
+        windows_node18:
+            imageName: "windows-latest"
+            versionName: "18.x"
+        windows_node20:
+            imageName: "windows-latest"
+            versionName: "20.x"
+    maxParallel: "10"
+
+pool:
+    vmImage: $(imageName)
+
+steps:
+    - task: NodeTool@0
+      inputs:
+          versionSpec: $(versionName)
+      displayName: "Install Node.js"
+
+    - script: |
+          npm install
+      displayName: "npm install"
+
+    - script: |
+          npm run build
+      displayName: "npm build"
+
+    - script: |
+          npm run test:packagejunit
+      displayName: "npm test:package"
+
+    - script: |
+          npm run test:integrationjunit
+      displayName: "npm test:integration"
+
+    - script: |
+          npm run test:tsjunit
+      displayName: "npm test:ts"
+
+    - task: PublishTestResults@2
+      condition: succeededOrFailed()
+      inputs:
+          testRunner: JUnit
+          testResultsFiles: "**/test-results.xml"
+
+    - script: |
+          npm run coveragejunit
+      displayName: "Run code coverage"
+
+    - task: PublishCodeCoverageResults@1
+      inputs:
+          codeCoverageTool: Cobertura
+          summaryFileLocation: "$(System.DefaultWorkingDirectory)/**/*coverage.xml"
+          reportDirectory: "$(System.DefaultWorkingDirectory)/**/coverage"