Skip to content

Export dptlib #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
evekto wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Export dptlib #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b4ae20b
Use require only with static paths
evekto Feb 2, 2026
6975e0c
Export dptlib
evekto Feb 2, 2026
a4b5ace
types: Export populateAPDU
evekto Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,4 +116,59 @@ declare module "knx" {
write(value: KnxValue): void;
read(callback?: (src: KnxDeviceAddress, value: KnxValue) => void): void;
}

export interface DatapointSubtype {
scalar_range?: [number, number]
name: string
use?: string
desc: string
force_encoding?: string
unit?: string
enc?: Record<number, string>
range?: [number, number] | [undefined, undefined]
}

export interface DatapointType {
basetype: {
bitlength: number
signedness?: string
range?: [number, number]
valuetype: string
desc?: string
}
subtypes: Record<string, DatapointSubtype>
formatAPDU?: (value: any) => Buffer | void
fromBuffer?: (buf: Buffer) => KnxValue
}

export class dptlib {
static DPT1: DatapointType
static DPT2: DatapointType
static DPT3: DatapointType
static DPT4: DatapointType
static DPT5: DatapointType
static DPT6: DatapointType
static DPT7: DatapointType
static DPT8: DatapointType
static DPT9: DatapointType
static DPT10: DatapointType
static DPT11: DatapointType
static DPT12: DatapointType
static DPT13: DatapointType
static DPT14: DatapointType
static DPT15: DatapointType
static DPT16: DatapointType
static DPT17: DatapointType
static DPT18: DatapointType
static DPT19: DatapointType
static DPT20: DatapointType
static DPT21: DatapointType
static DPT232: DatapointType
static DPT237: DatapointType
static DPT238: DatapointType

static fromBuffer: (buf: Buffer, dpt: DatapointType, subtype?: DatapointSubtype) => KnxValue

static populateAPDU: (value: KnxValue, apdu: Object, dptid: string) => void
}
}
11 changes: 1 addition & 10 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,8 @@
* (C) 2016-2017 Elias Karakoulakis
*/

const path = require('path');
const util = require('util');
const log = require('log-driver').logger;

const knx_path = path.join(__dirname, 'package.json');
const pkginfo = require(knx_path);

log.info(util.format('Loading %s: %s, version: %s',
pkginfo.name, pkginfo.description, pkginfo.version));

exports.Connection = require('./src/Connection.js');
exports.Datapoint = require('./src/Datapoint.js');
exports.Devices = require('./src/devices');
exports.Log = require('./src/KnxLog.js');
exports.dptlib = require('./src/dptlib/index.js');
47 changes: 29 additions & 18 deletions src/dptlib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,26 +33,34 @@ Unlimited string 8859_1 . DPT 24 DPT 24
List 3-byte value 3 Byte DPT 232 DPT 232 RGB[0,0,0]...[255,255,255]
*/

const fs = require('fs');
const path = require('path');
const util = require('util');
const log = require('log-driver').logger;

const dpts = {};
for (const entry of fs.readdirSync(__dirname)) {
const matches = entry.match(/(dpt.*)\.js/);
if (!matches) continue;
const dptid = matches[1].toUpperCase(); // DPT1..DPTxxx
const mod = require(__dirname + path.sep + entry);
if (
!mod.hasOwnProperty('basetype') ||
!mod.basetype.hasOwnProperty('bitlength')
)
throw 'incomplete ' + dptid + ', missing basetype and/or bitlength!';
mod.id = dptid;
dpts[dptid] = mod;
//log.trace('DPT library: loaded %s (%s)', dptid, dpts[dptid].basetype.desc);
}
dpts.DPT1 = require('./dpt1.js');
dpts.DPT2 = require('./dpt2.js');
dpts.DPT3 = require('./dpt3.js');
dpts.DPT4 = require('./dpt4.js');
dpts.DPT5 = require('./dpt5.js');
dpts.DPT6 = require('./dpt6.js');
dpts.DPT7 = require('./dpt7.js');
dpts.DPT8 = require('./dpt8.js');
dpts.DPT9 = require('./dpt9.js');
dpts.DPT10 = require('./dpt10.js');
dpts.DPT11 = require('./dpt11.js');
dpts.DPT12 = require('./dpt12.js');
dpts.DPT13 = require('./dpt13.js');
dpts.DPT14 = require('./dpt14.js');
dpts.DPT15 = require('./dpt15.js');
dpts.DPT16 = require('./dpt16.js');
dpts.DPT17 = require('./dpt17.js');
dpts.DPT18 = require('./dpt18.js');
dpts.DPT19 = require('./dpt19.js');
dpts.DPT20 = require('./dpt20.js');
dpts.DPT21 = require('./dpt21.js');
dpts.DPT232 = require('./dpt232.js');
dpts.DPT237 = require('./dpt237.js');
dpts.DPT238 = require('./dpt238.js');

// a generic DPT resolution function
// DPTs might come in as 9/"9"/"9.001"/"DPT9.001"
Expand Down Expand Up @@ -154,7 +162,7 @@ dpts.populateAPDU = (value, apdu, dptid) => {
* - or by this generic version, which:
* -- 1) checks if the value adheres to the range set from the DPT's bitlength
*/
dpts.fromBuffer = (buf, dpt) => {
dpts.fromBuffer = (buf, dpt, subtype) => {
// sanity check
if (!dpt) throw util.format('DPT %s not found', dpt);
// get the raw APDU data for the given JS value
Expand All @@ -179,10 +187,13 @@ dpts.fromBuffer = (buf, dpt) => {
dpt.hasOwnProperty('subtype') &&
dpt.subtype.hasOwnProperty('scalar_range')
) {
subtype = dpt.subtype;
}
if (subtype && subtype.hasOwnProperty('scalar_range')) {
const [r_min, r_max] = dpt.basetype.hasOwnProperty('range')
? dpt.basetype.range
: [0, Math.pow(2, dpt.basetype.bitlength) - 1];
const [s_min, s_max] = dpt.subtype.scalar_range;
const [s_min, s_max] = subtype.scalar_range;
// convert value from its scalar representation
// e.g. in DPT5.001, 50(%) => 0x7F , 100(%) => 0xFF
const a = (s_max - s_min) / (r_max - r_min);
Expand Down