Merge branch 'develop'

Author: dynasticorpheus

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,62 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [develop]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [develop]
+  schedule:
+    - cron: '0 17 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        # Override automatic language detection by changing the below list
+        # Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python']
+        language: ['python']
+        # Learn more...
+        # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        # We must fetch at least the immediate parents so that if this is
+        # a pull request then we can checkout the head.
+        fetch-depth: 2
+
+    # If this run was triggered by a pull request event, then checkout
+    # the head of the pull request instead of the merge commit.
+    - run: git checkout HEAD^2
+      if: ${{ github.event_name == 'pull_request' }}
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+         languages: ${{ matrix.language }}
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

README.rst

@@ -1,15 +1,14 @@
 Gigaset Elements API command-line interface
 ===========================================
 
+|Version status| |Github stars| |Github forks| |CodeQL| |Quality Gate Status| |Downloads| |BuyMeCoffee|
+
 gigasetelements-cli is a python based program which allows you to control your Gigaset Elements home security system.
 It comes with an easy to use CLI (command-line interface) suitable for direct use or cron jobs.
 
-.. image:: https://weblog.bol.com/wp-content/uploads/2015/04/gigaset-elements.jpg
+.. image:: https://asset.conrad.com/media10/isa/160267/c1/-/nl/1650392_BB_00_FB/image.jpg
     :target: https://www.gigaset-elements.com
 
-.. image:: https://lh3.googleusercontent.com/k8pmHPby3b76PmNXTyhhK26fp64xJjGwjVo4PmTpp4FotIcE12Na6eRBNgdKFhvlx-uI=w1920-h1080-rw-no
-    :target: https://plus.google.com/communities/108042802009267082650
-
 Installation
 ------------
 
@@ -19,13 +18,17 @@ For easy installation including dependencies simply run below command (with elev
 
 [-] *pip install gigasetelements-cli*
 
-**GITHUB** - [https://github.com/dynasticorpheus/gigaset-elements]
+**GITHUB** - [https://github.com/dynasticorpheus/gigasetelements-cli]
+
+[1] *git clone -b develop https://github.com/dynasticorpheus/gigasetelements-cli*
 
-[1] *git clone https://github.com/dynasticorpheus/gigaset-elements.git*  
+[2] install *dependencies*, pip install -r requirements.txt (with elevated privileges if needed)
 
-[2] install *dependencies*, see requirements.txt
+[3] *python setup.py install --force* (or run from source using wrapper ./gigasetelements-cli.py)
 
-[3] *python setup.py install* (or run from source using wrapper ./gigasetelements-cli.py)
+**GITHUB** - [https://github.com/dynasticorpheus/gigasetelements-cli] [RECOMMENDED]
+
+[1] *pip install git+https://github.com/dynasticorpheus/gigasetelements-cli@develop*
 
 
 Features
@@ -43,7 +46,6 @@ Features
  * Show custom rules (button/plug)
  * Switch plug on/off
  * Set alarm trigger delay
- * Domoticz home automation system support
 
 Usage
 -----
@@ -128,15 +130,14 @@ To do
 * Improve overall code
 * Replicate all functionality from app and/or website ... a long list
 * Support for gigaset elements button
-* Support for domoticz home automation system
 
 
 Notes
 -----
 Been ages since I have coded and python is new for me so in other words be kind :)
 
 
-Donate
+Donation Hall of Fame
 ------
 A lot of time & effort goes into making gigasetelements-cli so if you like it you might want to consider buying me a :beer: :)
 
@@ -151,7 +152,26 @@ A lot of time & effort goes into making gigasetelements-cli so if you like it yo
 * *Joshua T*
 * *Auke C*
 * *RPC B*
+* *Silke H*
+* *Frank M*
+* *Max G*
+* *Andreas G*
 
 License
 -------
 GPL2
+
+.. |Version status| image:: https://img.shields.io/pypi/v/gigasetelements-cli.svg
+   :target: https://pypi.python.org/pypi/gigasetelements-cli/
+.. |Downloads| image:: https://img.shields.io/pypi/dm/gigasetelements-cli.svg
+   :target: https://pypi.python.org/pypi/gigasetelements-cli/
+.. |CodeQL| image:: https://github.com/dynasticorpheus/gigasetelements-cli/actions/workflows/codeql-analysis.yml/badge.svg
+   :target: https://github.com/dynasticorpheus/gigasetelements-cli/actions/workflows/codeql-analysis.yml
+.. |Github forks| image:: https://img.shields.io/github/forks/dynasticorpheus/gigasetelements-cli.svg
+   :target: https://github.com/dynasticorpheus/gigasetelements-cli/network/members/
+.. |Github stars| image:: https://img.shields.io/github/stars/dynasticorpheus/gigasetelements-cli.svg
+   :target: https://github.com/dynasticorpheus/gigasetelements-cli/stargazers/
+.. |BuyMeCoffee| image:: https://camo.githubusercontent.com/cd005dca0ef55d7725912ec03a936d3a7c8de5b5/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6275792532306d6525323061253230636f666665652d646f6e6174652d79656c6c6f772e737667
+   :target: https://buymeacoffee.com/dynasticorpheus/
+.. |Quality Gate Status| image:: https://sonarcloud.io/api/project_badges/measure?project=dynasticorpheus_gigasetelements-cli&metric=alert_status
+   :target: https://sonarcloud.io/summary/new_code?id=dynasticorpheus_gigasetelements-cli/

gigasetelements-cli.conf.template

@@ -2,62 +2,44 @@
 #
 # Note: command-line options override below values  
 #
-# On POSIX configuration file is automatically read from below locations:
-# ~/.gigasetelements-cli
+# The configuration file is automatically read from below locations:
+#
+# POSIX
+# ~/.gigasetelements-cli/gigasetelements-cli.conf
 # /etc/gigasetelements-cli.conf
 # /usr/etc/gigasetelements-cli.conf
 # /usr/local/etc/gigasetelements-cli.conf
 # /opt/etc/gigasetelements-cli.conf
+#
+# OS X
+# ~/Library/Application Support/gigasetelements-cli/gigasetelements-cli.conf
+#
+# WINDOWS
+# %APPDATA%\gigasetelements-cli\gigasetelements-cli.conf
+
 
 [accounts]
 
 # username (email) in use with my.gigaset-elements.com
-username: first.last@domain.com
+username=first.last@domain.com
 
 # password in use with my.gigaset-elements.com
-password: mybigsecret
+password=mybigsecret
 
-# add token to enable pushbullet notification (optional)
-pbtoken: z9FaKeSCKQDi2cmPUSHB62aiXx5I57eiujTOKENfS34
+# access token to enable pushbullet notifications (optional)
+# notify=z9FaKeSCKQDi2cmPUSHB62aiXx5I57eiujTOKENfS34
 
 
 [options]
 
 # set modus {home,away,custom} (optional)
-modus: home
-
-# suppress urllib3 warnings {true,false} (optional)
-nowarning: true
-
-[domoticz]
-
-# domoticz server ip address (required)
-ip: 127.0.0.1
-
-# domoticz server port (required)
-port: 8080
-
-# domoticz user name (optional)
-username:
-
-# domoticz password (optional)
-password:
-
-# domoticz idx sensor pairing (required)
-
-# 1. Go to Domoticz GUI
-# 2. Add hardware - dummy
-# 3. Create a virtual sensor - type Alert for basestation (remember the idx number)
-# 4. Create a virtual sensor - type Manual Light/Switch for each motion/door/window/siren/plug/button/camera (remember their idx numbers)
-# 5. Set Off Delay to 2 seconds for virtual sensors linked to motion, button or camera
-# 6. Run "gigasetelements-cli -ss" to get sensor ids and match them with the their respective idx in domoticz
-# 7. Run "gigasetelements-cli -a" to get camera sensor id. Use the 12 uppercase digits in stream url. This MAC address can also be found on the back of the camera.
+# modus=home
 
-# example motion/door/window/siren/plug
-# 123FC4577H: 99
+# disable SSL/TLS certificate verification {yes,no} (optional)
+# insecure=no
 
-# example basestation id
-# F32A76C4DHJ1B743A0E0D74EFD2375D1: 98
+# suppress urllib3 warnings {yes,no} (optional)
+# silent=no
 
-# example camera id
-# 7C2G30873SED: 97
+# Don't periodically check PyPI to determine whether a new version of gigasetelements-cli is available for download {yes,no} (optional)
+# noupdate=no