knxultimate/src/dptlib/dpt7.ts

KNX IP protocol implementation for Node. This is the ENGINE of Node-Red KNX-Ultimate node.

/**
 * Provides KNX Data Point Type 7 encoding and decoding helpers.
 *
 * Written in Italy with love, sun and passion, by Massimo Saccani.
 *
 * Released under the MIT License.
 * Use at your own risk; the author assumes no liability for damages.
 */

/**
 * KNXEngine - a KNX protocol stack in Javascript
 * (C) 2020 Supergiovane
 */

//
// DPT7: 16-bit unsigned integer value
//

import { module } from '../KnxLog'
import type { DatapointConfig } from '.'

const logger = module('DPT7')

const config: DatapointConfig = {
	id: 'DPT7',
	formatAPDU: (value) => {
		const apdu_data = Buffer.alloc(2)
		if (!isFinite(value)) {
			logger.warn('cannot write non-numeric or undefined value')
		} else {
			if (value < 0 || value > 65535) {
				logger.warn(
					'value must be between 0 and 65535. Auto adjousting.',
				)
				if (value < 0) value = 0
				if (value > 65535) value = 65535
			}
			apdu_data[0] = value >> 8
			apdu_data[1] = value & 0xff
		}
		return apdu_data
	},

	fromBuffer: (buf) => {
		if (buf.length !== 2) {
			logger.warn(
				'fromBuffer: buf should be 2 bytes long (got %d bytes)',
				buf.length,
			)
			return null
		}
		return buf[0] * 256 + buf[1]
	},

	basetype: {
		bitlength: 16,
		signedness: 'unsigned',
		valuetype: 'basic',
		desc: '16-bit unsigned value',
		help: `// Send 16-bit unsigned value. If you use time, please be careful in selecting the correct datapoint (ms, 10ms, 100ms, ecc..).
msg.payload = 22;
return msg;`,
	},

	// DPT subtypes info
	subtypes: {
		// 7.001 pulses
		'001': {
			use: 'G',
			name: 'Pulses',
			desc: 'pulses',
			unit: 'pulses',
		},

		// 7.002 time(ms)
		'002': {
			use: 'G',
			name: 'Time (ms)',
			desc: 'time (ms)',
			unit: 'milliseconds',
		},

		// 7.003 time (10ms)
		'003': {
			use: 'G',
			name: 'Time (10ms)',
			desc: 'time (10ms)',
			unit: 'centiseconds',
		},

		// 7.004 time (100ms)
		'004': {
			use: 'G',
			name: 'Time (100ms)',
			desc: 'time (100ms)',
			unit: 'deciseconds',
		},

		// 7.005 time (sec)
		'005': {
			use: 'G',
			name: 'Time (s)',
			desc: 'time (s)',
			unit: 'seconds',
		},

		// 7.006 time (min)
		'006': {
			use: 'G',
			name: 'Time (min)',
			desc: 'time (min)',
			unit: 'minutes',
		},

		// 7.007 time  (hour)
		'007': {
			use: 'G',
			name: 'Time (hrs)',
			desc: 'time (hrs)',
			unit: 'hours',
		},

		// 7.010 PropDataType
		// not to be used in runtime communications!
		'010': {
			use: 'FB',
			name: 'Property data type',
			desc: 'Identifier Interface Object Property data type ',
		},

		// 7.011
		'011': {
			use: 'FB SAB',
			name: 'Length_mm',
			desc: 'Length in mm',
			unit: 'mm',
		},

		// 7.012
		'012': {
			use: 'FB',
			name: 'Current (mA)',
			desc: 'bus power supply current (mA)',
			unit: 'mA',
		},

		// 7.013
		'013': {
			use: 'FB',
			name: 'Brightness (lux)',
			desc: 'interior brightness',
			unit: 'lux',
		},

		// 7.600 Kelvin
		600: {
			use: 'FB',
			name: 'Absolute colour temperature (K)',
			desc: 'absolute colour temperature (K).',
			unit: 'K',
			range: [0, 65535],
		},
	},
}

export default config