feat: ts rewrite and DPT 22, 28 29, 213, 235, 242, 249, 251, 275, 99, 60001 support

.eslintignore

@@ -0,0 +1,6 @@
+/typescript-sample/
+/manualtest/
+/build/
+
+
+*.js

.eslintrc.js

@@ -0,0 +1,48 @@
+module.exports = {
+	parser: '@typescript-eslint/parser',
+	plugins: ['@typescript-eslint/eslint-plugin'],
+	env: {
+		node: true,
+	},
+	extends: [
+		'airbnb-base',
+		'airbnb-typescript/base',
+		'plugin:prettier/recommended',
+		'plugin:@typescript-eslint/recommended'
+	],
+	parserOptions: {
+		project: 'tsconfig.json',
+		sourceType: 'module',
+		tsconfigRootDir: __dirname
+	},
+	rules: {
+		'global-require': 'off',
+		'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
+		'no-unused-vars': 'off',
+		'no-underscore-dangle': 'off',
+		'no-param-reassign': 'off',
+		'no-restricted-syntax': 'off',
+		camelcase: 'off',
+		'default-case': 'off',
+		'consistent-return': 'off',
+		'import/order': 'off',
+		'max-classes-per-file': 'off',
+		'no-plusplus': 'off',
+		'guard-for-in': 'off',
+		'no-bitwise': 'off',
+		'class-methods-use-this': 'off',
+		'no-continue': 'off',
+		'prefer-destructuring': 'off',
+		'no-use-before-define': 'off',
+		'no-restricted-globals': 'off',
+		'radix': 'off',
+		'func-names': 'off',
+		// Typescript rules
+		'@typescript-eslint/explicit-function-return-type': 'off',
+		'@typescript-eslint/no-explicit-any': 'off',
+		'@typescript-eslint/no-unused-vars': 'off',
+		'@typescript-eslint/naming-convention': 'off',
+		'@typescript-eslint/dot-notation': 'off',
+		'@typescript-eslint/no-use-before-define': 'off',
+	}
+}

.github/workflows/ci.yml

@@ -25,11 +25,11 @@ jobs:
     - name: Install Dependencies
       run: npm ci
 
-    # - name: Lint
-    #   if: matrix.node-version == '20.x'
-    #   # only run on latest node version, no reason to run on all
-    #   run: |
-    #     npm run lint
+    - name: Lint
+      if: matrix.node-version == '20.x'
+      # only run on latest node version, no reason to run on all
+      run: |
+        npm run lint
 
     - name: Test NodeJS
       run: npm run test

.gitignore

@@ -1,2 +1,3 @@
 .tags*
 node_modules
+build

.npmignore

@@ -3,4 +3,3 @@ manualtest
 bitbucket-pipelines.yml
 README*.md
 typescript-sample
-run-wired-tests.sh

.prettierignore

@@ -0,0 +1,7 @@
+
+/typescript-sample/
+/manualtest/
+/build/
+
+*.md
+README.md

.prettierrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+  semi: false,
+  singleQuote: true,
+  useTabs: true,
+  tabWidth: 4,
+  endOfLine: "lf",
+};

.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+    "eslint.format.enable": true,
+    "eslint.lintTask.enable": true,
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.codeActionsOnSave": {
+        "source.fixAll.eslint": "explicit",
+        "source.fixAll.markdownlint": "explicit"
+    },
+}

README-API.md

@@ -2,9 +2,10 @@
 
 By default *you only need to specify a 'handlers' object* containing your functions to handle KNX events. All the other options have defaults that can be overridden according to your needs.
 
-
 ```js
-var connection = new knx.Connection( {
+var { KnxClient, DataPoint } = require('knx');
+
+var connection = new KnxClient( {
   // ip address and port of the KNX router or interface
   ipAddr: '127.0.0.1', ipPort: 3671,
   // in case you need to specify the multicast interface (say if you have more than one)
@@ -83,13 +84,15 @@ you start defining datapoints (and devices as we'll see later), your code
 *needs to ensure that the connection has been established*, usually by declaring them in the 'connected' handler:
 
 ```js
-var connection = knx.Connection({
+var { KnxClient, DataPoint } = require('knx');
+
+var connection = new KnxClient({
   handlers: {
     connected: function() {
       console.log('----------');
       console.log('Connected!');
       console.log('----------');
-      var dp = new knx.Datapoint({ga: '1/1/1'}, connection);
+      var dp = new Datapoint({ga: '1/1/1'}, connection);
       // Now send off a couple of requests:
       dp.read((src, value) => {
         console.log("**** RESPONSE %j reports current value: %j", src, value);

README-resilience.md

@@ -18,7 +18,6 @@ This library is, to the best of my knowledge, the only one that can handle the *
 27 Oct 15:45:36 - [info] [knx-in:input] GroupValue_Read {"srcphy":"15.15.15","dstgad":"0/0/15"}
 ```
 
-
 ## A note on resilience
 
 There are basically *two* ways to talk to KNX via UDP/IP:
@@ -30,7 +29,7 @@ There are basically *two* ways to talk to KNX via UDP/IP:
 - Finally, this library allows a **hybrid** approach, that's taking the best of the two methods above: You can use **multicast** transport with a **tunnelling** connection to ensure reliable communication. *Unfortunately this deviates from the official KNXnet/IP spec*, and is therefore not compatible with some IP routers. You can enable this "hybrid mode" by enabling the `forceTunneling` option when constructing a new Connection object as follows:
 
 ```js
-var connection = new knx.Connection( {
+var connection = new knx.KnxClient( {
   // use tunneling with multicast - this is NOT supported by all routers!
   forceTunneling: true,
 ...

README.md

@@ -22,8 +22,8 @@ Make sure your machine has Node.JS (version 4.x or greater) and do:
 At last, here's a **reliable** KNX connection that simply works without any configs. To get a basic KNX monitor, you just need to run this in Node:
 
 ```js
-var knx = require('knx');
-var connection = knx.Connection({
+var { KnxClient } = require('knx');
+var connection = new KnxClient({
  handlers: {
   connected: function() {
     console.log('Connected!');
@@ -49,8 +49,8 @@ Ahhh, KNX telegrams, what a joy:
 
 ## Development documentation
 
-- [Basic API usage](../master/README-API.md)
-- [List of supported datapoints](../master/README-datapoints.md)
-- [List of supported events](../master/README-events.md)
-- [eibd/knxd compatibility](../master/README-knxd.md)
-- [On resilience](../master/README-resilience.md)
+* [Basic API usage](../master/README-API.md)
+* [List of supported datapoints](../master/README-datapoints.md)
+* [List of supported events](../master/README-events.md)
+* [eibd/knxd compatibility](../master/README-knxd.md)
+* [On resilience](../master/README-resilience.md)

manualtest/test-toggle.js → manualtest/test-toggle.ts

@@ -3,27 +3,27 @@
 * (C) 2016-2017 Elias Karakoulakis
 */
 
-var knx = require('knx');
+import { Datapoint, KnxClient } from "../src";
 
 if (process.argv.length < 3) {
 	console.log('usage: %s <ga> <optional: status_ga> to toggle a light on & off',
 		process.argv[1]);
 	process.exit(1);
 }
-var connection = knx.Connection({
+const connection = new KnxClient({
 	debug: true,
 	handlers: {
 		connected: function() {
 			console.log('----------');
 			console.log('Connected!');
 			console.log('----------');
 			// define a datapoint:
-			var dp = new knx.Datapoint({
+			const dp = new Datapoint({
 				ga: process.argv[2],
 				dpt: 'DPT1.001'
 			}, connection);
 			if (process.argv[3]) {
-				var status_ga = new knx.Datapoint({
+				const status_ga = new Datapoint({
 					ga: process.argv[3],
 					dpt: 'DPT1.001'
 				}, connection);
@@ -36,14 +36,13 @@ var connection = knx.Connection({
 			console.log('\n\n\n');
 			console.log('PRESS ANY KEY TO TOGGLE %s AND "q" TO QUIT.', process.argv[2]);
 			console.log('\n\n\n');
-			var dpVal = false;
+			let dpVal = false;
 			process.stdin.setRawMode(true);
 			process.stdin.resume();
 			process.stdin.on('data', (data) => {
 				console.log(JSON.stringify(data));
 				if (data[0] === 113) {
 					process.exit(0);
-					return;
 				}
 				dpVal = !dpVal;
 				console.log("Sending " + dpVal);