improved docu

Author: En3rGy

README.md

@@ -26,6 +26,80 @@ From KNX point of view:
 * Services are usually devices providing multiple functions (e.g. on/off, dimm).
 * Characteristics are the smallest unit und realsied by one or few group addresses (e.g. on/off with get GA and set GA)
 
+# Available Servies and Characteristics Configuration
+Check [Homebridge.io docuemntation](https://developers.homebridge.io/#/service) for descriptions of Homebridge _Services_ and **required** or **optional** _Characteristics_. The following services and characteristics are implemented in this plug-in. 
+
+## Services
+### Garage Door Opener
+#### Characteristics
+- [Current Door State](#current-door-state)
+- [Target Door State](#target-door-state)
+- [Obstruction Detection](#obstruction-detected)
+
+### Lightbulb
+#### Characteristics
+- [On](#on)
+- [Brightness](#brightness) 
+
+### Outlet
+#### Characteristics
+- [On](#on)
+
+### Switch
+#### Characteristics
+- [On](#on)
+
+### Temperature Sensor
+#### Characterisitcs
+- [Current Temperature](#current-temperature)
+
+### Window
+#### Characterisitcs
+- [Current Door State](#current-door-state)
+- [Target Door State](#target-door-state)
+- [Obstruction Detected](#obstruction-detected)
+
+
+## Characteristics
+
+### Brightness
+- Endpoint 1: Set URL Endpoint
+- Endpoint 2: Get URL Endpoint
+
+### Current Door State
+- Endpoint 1: Get URL endpoint
+
+### Current Position
+- Endpoint 1: Get URL Endpoint
+
+### Current Temperature
+- Endpoint 1: Get URL endpoint
+
+### Lock Current State
+- Endpoint 1: Set URL Endpoint
+- Endpoint 2: Get URL Endpoint
+
+### Lock Target State
+- Endpoint 1: Set URL Endpoint
+- Endpoint 2: Get URL Endpoint
+
+### Obstruction Detected
+- Endpoint 1: Get URL endpoint
+
+### On
+- Endpoint 1: Set URL Endpoint
+- Endpoint 2: Get URL Endpoint
+
+### Position State
+- Endpoint 1: Get URL endpoint
+
+### Target Door State
+- Endpoint 1: Set URL endpoint
+- Endpoint 2: Get URL endpoint
+
+### Target Position
+- Endpoint 1: Set URL endpoint
+- Endpoint 2: Get URL endpoint
 
 # Background
 

package.json

@@ -2,7 +2,7 @@
   "private": true,
   "displayName": "Homebridge Gira Homeserver URL-Endpoint",
   "name": "homebridge-hsd",
-  "version": "1.0.8",
+  "version": "1.1.0",
   "description": "Plugin to access KNX bus via Gira Homeserver",
   "license": "MIT",
   "repository": {
@@ -12,6 +12,16 @@
   "bugs": {
     "url": "https://github.com/En3rGy/homebridge-hsd/issues"
   },
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/En3rGy/homebridge-hsd"
+    },
+    {
+      "type": "buymeacoffee",
+      "url": "https://www.buymeacoffee.com/en3rgy"
+    }
+  ],
   "engines": {
     "node": ">=18.17.0",
     "homebridge": ">=1.6.0"
@@ -24,7 +34,9 @@
     "prepublishOnly": "npm run lint && npm run build"
   },
   "keywords": [
-    "homebridge-plugin"
+    "homebridge-plugin",
+    "KNX",
+    "Gira Homeserver"
   ],
   "devDependencies": {
     "@types/jest": "^29.5.6",

src/hs.ts

@@ -28,6 +28,11 @@ export class HomeServerConnector {
   private requestPromiseRejecter: Map<string, (reason?: any) => void> = new Map();
   private lastSet: Map<string, string> = new Map();
 
+  private _hsIp = '';
+  private _hsPort = 0;
+  private _user = '';
+  private _pw = '';
+
   /**
    *
    */
@@ -51,10 +56,12 @@ export class HomeServerConnector {
    * @param pw
    */
   connect(hsIp: string, hsPort: number, user: string, pw: string) {
-    const hostname = hsIp;
-    const port = hsPort;
+    this._hsIp = hsIp;
+    this._hsPort = hsPort;
+    this._user = user;
+    this._pw = pw;
     const prot = 'wss';
-    const url = prot + '://' + hostname + ':' + port + '/endpoints/ws?authorization=' + encodeURIComponent(btoa(user + ':' + pw));
+    const url = prot + '://' + this._hsIp + ':' + this._hsPort + '/endpoints/ws?authorization=' + encodeURIComponent(btoa(user + ':' + pw));
     this._ws = new WebSocket.WebSocket(url, { rejectUnauthorized: false });
     this._connState = CONNECTION_STATE.CONNECTING;
 
@@ -205,6 +212,7 @@ export class HomeServerConnector {
     // Create a promise to wait for the response
 
     if (this.getConnState() !== CONNECTION_STATE.OPEN) {
+      this.connect(this._hsIp, this._hsPort, this._user, this._pw);
       if (retries > 0) {
         setTimeout(() => {
           this.sendJson(msg, retries - 1);
@@ -239,7 +247,7 @@ export class HomeServerConnector {
       }
 
       const smsg = JSON.stringify(msg);
-      this.logger.info('hs.ts | Send message: ' + smsg);
+      this.logger.debug('hs.ts | Send message: ' + smsg);
       this._ws.send(smsg);
 
     }

src/service/characteristic/TargetDoorState.ts

@@ -16,7 +16,6 @@ export const addTargetDoorStateCharacteristic = (api: API,
 
   targetDoorState.onGet(async () => {
     const ret = hsd.getCo(getEndpoint);
-    console.log('"%s"', ret);
     if (typeof(ret) === 'object') {
       return 99;
     }