This node lets you control a KNX Group Address, this is the most used node.

Here you'll find some samples

Configuration

You can use Javascript to modify the behaviour of the input msg coming from the flow and the output telegram sent to the KNX bus.
The embedded code editor provides useful objects and functions to retrieve the value of all group addresses, both with the imported ETS file and without (specifying the datapoint).
The script is called everytime the node receives a msg from the flow or a telegram from the KNX BUS.
If enabled, "f(x)" indication will be added to node's name.

In this sample, we'll send the input msg to the KNX BUS only if another GA has opposite value.
We'll turn on the light only if it's status GA is off, and vice versa.

const statusGA = getGAValue('0/0/09','1.001');
if (msg.payload !== statusGA){ // "!==" means "not equal"
    return msg;
}else{
    // Both values are identical, so i don't send the msg.
    return;
}

Here, if someone switches on the light, we turn on another light 0/1/8 and after 2 seconds we switch off the lamp connected to the node.

if (msg.payload){ 
    setGAValue('0/1/8',true)
    setTimeout(function() {
        self(off);
    }, 2000);
}
return msg;

In this sample, we'll emit the msg object to the flow, by appending the value of another GA to the output msg.
The ouput msg to the flow will have also the external temp in the property msg.externalTemperature

// The current msg contains the internal temperature in the "msg.payload" property, but we want to emit the external temperature as well.
msg.externalTemperature = getGAValue('0/0/10'); // In case the ETS file is missing, you must specify the dpt as well: getGAValue('0/0/10','9.001')
return msg;

In this other sample, we'll not emit a msg to the flow, in case msg.payload and another GA value are both false.

if (msg.payload === false && getGAValue('0/0/11','1.001') === false){
    // Both false, don't emit the msg to the flow.
    return;
}else{
    // Ok, emit it.
    return msg;
}

destination (string) : the destination group address, for example 1/1/0. Only 3-level is allowed.
payload (any) : the payload to be sent. Can be for example true or false, or an object.
event (string) : can be GroupValue_Write to write the telegram to the KNX BUS, GroupValue_Response to send a response telegram to the KNX BUS, Update_NoWrite. Update_NoWrite sends nothings to the KNX BUS, just updates the internal value of the KNX-Ultimate node. This is useful if you wanna only store the value into the node and read it later with a read request.
readstatus (boolean) : issue a read request to the KNX bus. Pass true everytime (msg.readstatus = true).
dpt (string) : For example "1.001". Sets the Datapoint.
writeraw (buffer) : is used to send a value to the KNX bus, as buffer. Use in conjunction with bitlenght.
bitlenght (int) : specifies the lenght of the writeraw buffer. Use in conjunction with writeraw.
resetRBE (boolean) : resets the internal RBE filters (use msg.resetRBE = true).
setConfig (json) : programmatically change the KNX-Ultimate Device node Group Address and Datapoint. See details.

msg.setConfig: It's possible to programmatically change the KNX-Ultimate node configuration, by sending msg.setConfig object to the node. The new configuration will be retained until next msg.setConfig or until restart/redeploy. All properties (setGroupAddress and setDPT) are mandatory..
Use it like that, in a functon node:

Set both GA and DPT

// Change the node properties as follows:
// setGroupAddress: set the new group address.
// setDPT: set the new Datapoint, as you can see in the dropdown list (the numeric part, for example "1.001", "237.600", etc...). If set to **auto**, the datapoint will be read from the ETS file (if present).
var config= {
    setGroupAddress: "0/1/2",
    setDPT: "1.001"
};
msg.setConfig = config;
return msg;

Set GA and read the datapoint from the ETS file

// Change the node properties as follows:
// setGroupAddress: set the new group address.
// setDPT: set the new Datapoint, as you can see in the dropdown list (the numeric part, for example "1.001", "237.600", etc...). If set to "auto", the datapoint will be read from the ETS file (if present).
var config= {
    setGroupAddress: "0/1/2",
    setDPT: "auto"
};
msg.setConfig = config;
return msg;

1. Standard output : payload (string|number|object)** : Pin 1 is the standard output of the command.

2. Errors : error (object)** : Pin 2 Contains the detailed error message.

msg.payload is used as the payload of the group address (the group address value). This is, instead, an example of the complete msg object.

msg = {
    topic: "0/1/2" // (Contains the node's topic, for example "MyTopic". If the node's topic is not set, contains the Group Address, for example "0/1/2")
    payload: false 
    previouspayload: true // Previous node payload value.
    payloadmeasureunit: "%" // Payload's measure unit.
    payloadsubtypevalue: "Start" // Subtype's decoded value, for exampe, On/Off, Ramp/NoRamp, Start/Stop, Alarm/NoAlarm
    devicename: "Dinning table lamp" // If the node is in **universal mode**, it contains the full path (main, middle,name) of the group address name, otherwise, the node name.
    gainfo: { // Contains the details about the group address name and number. This object is only present if the node is set in **universal mode** and with the **ETS file** been imported. If something wrong, it contains the string **unknown**.
        maingroupname:"Light actuators"
        middlegroupname:"First flow lights"
        ganame:"Table Light"
        maingroupnumber:"1"
        middlegroupnumber:"1"
        ganumber:"0"
    },
    echoed:true, // True if the msg is coming from the input PIN, otherwise false if the msg is coming form the KNX BUS.
    knx: { // This is a representation of the KNX BUS telegram, coming from BUS
        event: "GroupValue_Write" // (or "GroupValue_Response", or "GroupValue_Read")
        dpt: "1.001"
        dptdesc: "Humidity" // Payload's measure unit description
        source: "15.15.22"
        destination: "0/1/2" // Contains the Group Address
        rawValue: buffer[1]raw // (or null, if "GroupValue_Read")
            0: 0x0 // (This is the RAW undecoded value)
    }
}

Payload sample

: destination (string)** : the destination group address, for example 1/1/0. Only 3-level is allowed.
: payload (any)** : the payload to be sent. Can be for example true or false, or an object. : event (string)** : can be GroupValue_Write to write the telegram to the KNX BUS, GroupValue_Response to send a response telegram to the KNX BUS, Update_NoWrite. Update_NoWrite sends nothings to the KNX BUS, just updates the internal value of the KNX-Ultimate node. This is useful if you wanna only store the value into the node and read it later with a read request. : readstatus (boolean)** : issue a read request to the KNX bus. Pass true everytime (msg.readstatus = true). : dpt (string)** : For example "1.001". Sets the Datapoint. : writeraw (buffer): is used to send a value to the KNX bus, as buffer. Use in conjunction with bitlenght. : bitlenght (int): specifies the lenght of the writeraw buffer. Use in conjunction with writeraw. : resetRBE (boolean)** : resets the internal RBE filters (use msg.resetRBE = true). : setConfig (json)** : programmatically change the KNX-Ultimate Device node Group Address and Datapoint. See details.

msg.setConfig: It's possible to programmatically change the KNX-Ultimate node configuration, by sending msg.setConfig object to the node. The new configuration will be retained until next msg.setConfig or until restart/redeploy. All properties (setGroupAddress and setDPT) are mandatory..
Use it like that, in a functon node:

Set both GA and DPT

// Change the node properties as follows:
// setGroupAddress: set the new group address.
// setDPT: set the new Datapoint, as you can see in the dropdown list (the numeric part, for example "1.001", "237.600", etc...). If set to **auto**, the datapoint will be read from the ETS file (if present).
var config= {
    setGroupAddress: "0/1/2",
    setDPT: "1.001"
};
msg.setConfig = config;
return msg;

Set GA and read the datapoint from the ETS file

// Change the node properties as follows:
// setGroupAddress: set the new group address.
// setDPT: set the new Datapoint, as you can see in the dropdown list (the numeric part, for example "1.001", "237.600", etc...). If set to "auto", the datapoint will be read from the ETS file (if present).
var config= {
    setGroupAddress: "0/1/2",
    setDPT: "auto"
};
msg.setConfig = config;
return msg;

1. Standard output : payload (string|number|object)** : Pin 1 is the standard output of the command.

2. Errors : error (object)** : Pin 2 Contains the detailed error message.

msg.payload is used as the payload of the group address (the group address value). This is, instead, an example of the complete msg object.

msg = {
    topic: "0/1/2" // (Contains the node's topic, for example "MyTopic". If the node's topic is not set, contains the Group Address, for example "0/1/2")
    payload: false 
    previouspayload: true // Previous node payload value.
    payloadmeasureunit: "%" // Payload's measure unit.
    payloadsubtypevalue: "Start" // Subtype's decoded value, for exampe, On/Off, Ramp/NoRamp, Start/Stop, Alarm/NoAlarm
    devicename: "Dinning table lamp" // If the node is in **universal mode**, it contains the full path (main, middle,name) of the group address name, otherwise, the node name.
    gainfo: { // Contains the details about the group address name and number. This object is only present if the node is set in **universal mode** and with the **ETS file** been imported. If something wrong, it contains the string **unknown**.
        maingroupname:"Light actuators"
        middlegroupname:"First flow lights"
        ganame:"Table Light"
        maingroupnumber:"1"
        middlegroupnumber:"1"
        ganumber:"0"
    }
    knx: { // This is a representation of the KNX BUS telegram, coming from BUS
        event: "GroupValue_Write" // (or "GroupValue_Response", or "GroupValue_Read")
        dpt: "1.001"
        dptdesc: "Humidity" // Payload's measure unit description
        source: "15.15.22"
        destination: "0/1/2" // Contains the Group Address
        rawValue: buffer[1]raw // (or null, if "GroupValue_Read")
            0: 0x0 // (This is the RAW undecoded value)
    }
}

Here you have 2 options: import ETS cvs file or not.
Importing your ETS file is the aboslute suggested method. If you import your ETS file, the node will do the datapoint decoding automatically and gives you the device name as well.
If you do not import the ETS, the node will output the RAW telegram and it tries to decode it as well.

msg = {
    topic: "0/1/2" // (Contains the Group Address of the incoming telegram)
    payload: false // (Automatically decoded telegram. If you've <b>not imported the ETS file</b>, the node will try to decode the telegram <b>but you can obtain an erroneus value</b>)
    payloadmeasureunit: "%" // (payload's measure unit)
    payloadsubtypevalue: "Start" // (Subtype's decoded value, for exampe, On/Off, Ramp/NoRamp, Start/Stop, Alarm/NoAlarm.)
    devicename: "(First Floor->Dinning Room) Dinning table lamp" // (the node will output the complete path of your house, including the device name, or the node's name in case you've <b>not imported the ETS file</b> )) 
    knx: 
        event: "GroupValue_Write" // (or "GroupValue_Response", or "GroupValue_Read")
        dpt: "1.001" // (If you've <b>not imported the ETS file</b>, this represents the datapoint used to try to decode the telegram)
        dptdesc: "Humidity" // (payload's measure unit description)
        source: "15.15.22"
        destination: "0/1/2" // (Contains the Group Address of the incoming telegram, same as topic)
        rawValue: buffer[1]raw // (or null, if "GroupValue_Read")
            0: 0x0 // (This is the RAW undecoded value)
    }}
 

Here you'll find a sample of Virtual Device

 {
   topic: '5/0/1',
   payload: true,
   devicename: 'Light Status',
   event: 'Update_NoWrite',
   eventdesc: "The value has been updated from another node and hasn't been received from KNX BUS",
   previouspayload: true
 }
 

The node accepts msg from the flow to be sent out to KNX bus and send out msg to the flow as soon KNX message arrive from the bus.
Supposing you provided a Group Address and a Datapoint to the node, either manually or with auto populating fields by selecting your device from the device's list after you've importet the ETS file.
You can also override one or more parameters set in the KNX-Ultimate config window.
All properties below are optional, except for the payload.

msg.destination
For example, "0/0/1". Set the 3-level Group Address you wanna update.

msg.payload
For example, true/false/21/"Hello". Set the payload you want to send to the KNX BUS.

msg.event
"GroupValue_Write": writes the telegram to the KNX BUS.
"GroupValue_Response": sends a response telegram to the KNX BUS.
"Update_NoWrite": sends nothings to the KNX BUS, just updates the internal value of the KNX-Ultimate node. This is useful if you wanna only store the value into the node and read it later with a read request.
CAUTION: in case of msg.event = "Update_NoWrite" all nodes with the same group address will emit to the flow a msg like this:

{
  topic: '5/0/1',
  payload: true,
  devicename: 'Light Status',
  event: 'Update_NoWrite',
  eventdesc: "The value has been updated from another node and hasn't been received from KNX BUS",
  previouspayload: true
}

If you wish to issua a "read" command, please use "readstatus" instead (see below).

msg.readstatus = true
Issue a "Read" command to the BUS.

msg.dpt
For example "1.001". Sets the Datapoint. (You can write it in these formats: 9 , "9" , "9.001" or "DPT9.001")

msg.writeraw
msg.bitlenght
Writes RAW data to the KNX BUS. Please see below an example.

msg.resetRBE
pass msg.resetRBE = true to a device node, to reset both input and output RBE filter on that particular node.

It's possible to programmatically change the KNX-Ultimate node configuration, by sending msg.setConfig object to the node.
Please see here the sample page.

You can more samples here

TURN ON A LAMP

// Example of a function that sends a message to the KNX-Ultimate
msg.payload = true; // issues a write or response (based on the options <b>Telegram type</b> above) to the KNX bus
return msg;

ABSOLUTE DIM A LAMP

// Example of a function that sends a message to the KNX-Ultimate
msg.payload = 30; // issues a write or response (based on the options <b>Telegram type</b> above) to the KNX bus
return msg;

SEND TEXT TO A DISPLAY

// Example of a function that sends a message to the KNX-Ultimate
msg.payload = "Output Tem. 35°C"; // issues a write or response (based on the options <b>Telegram type</b> above) to the KNX bus
return msg;

READ THE STATUS OF THE WASHING MACHINE

// Example of a function that sends a read status message to the KNX-Ultimate
// Issues a read request to the KNX bus. You'll expect a 'response' from the bus. You need to select the **React to response telegrams** option.
// The node will react to the KNX Response telegram coming from the BUS.
msg.readstatus = true; // issues a write or response (based on the options <b>Telegram type</b> above) to the KNX bus
return msg;

SEND RAW VALUE TO THE BUS

To send a RAW buffer value to the KNX bus, use the writeraw and bitlenght properties of the msg input.
In this case, the Datapoint you set in the property window will be ignored.
Slap a function node in front of knx-ultimate and paste his code:

//  If you encode the values by yourself, you can write raw buffers with writeraw.
// The bitlenght is necessary for datapoint types where the bitlenght does not equal the buffers bytelenght * 8. This is the case for dpt 1 (bitlength 1), 2 (bitlenght 2) and 3 (bitlenght 4).
// Write raw buffer to a groupaddress with dpt 1 (e.g light on = value true = Buffer<01>) with a bitlength of 1
msg.writeraw = Buffer.from('01', 'hex'); // Put '00' instead of '01' to switch off the light.
msg.bitlenght = 1;
return msg;

// Temperature sample (uncomment below and comment above)
// Write raw buffer to a groupaddress with dpt 9 (e.g temperature 18.4 °C = Buffer<0730>) without bitlength
// msg.writeraw = Buffer.from('0730', 'hex');
// msg.bitlenght = 1;
// return msg;

UPDATE THE NODE VALUE WITHOUT SENDING IT TO THE BUS

msg.event = "Update_NoWrite";
msg.payload = true;
return msg;

Here you have 2 options: import ETS cvs file or not.
Importing your ETS file is the aboslute suggested method. If you import your ETS file, you only need to set the payload to be transmitted. The node will do the datapoint encoding automatically.
If you do not import the ETS csv, you need to pass the datapoint type to the node as well.

TURN OFF A LAMP WITH ETS FILE IMPORTED

// Example of a function that sends a message to the KNX-Ultimate
msg.event = "GroupValue_Write";
msg.destination = "0/0/1"; // Set the destination 
msg.payload = false; // issues a write or response (based on the options <b>Telegram type</b> above) to the KNX bus
return msg;

TURN OFF A LAMP WITHOUT ETS FILE IMPORTED

// Example of a function that sends a message to the KNX-Ultimate
msg.event = "GroupValue_Write";
msg.destination = "0/0/1"; // Set the destination 
msg.dpt = "1.001"; 
msg.payload = false; // issues a write or response (based on the options <b>Telegram type</b> above) to the KNX bus
return msg;

READ THE STATUS OF ALL KNX DEVICES WITH ETS FILE IMPORTED
You cannot issue a read request to all groups if you doesn't import your ETS file, because the node cannot know to wich devices to send the read request.

// Example of a function that sends a read status message to the KNX-Ultimate
// Issues a read request to the KNX bus. You'll expect a 'response' from the bus. You need to select the **React to response telegrams** option.
// The node will react to the KNX Response telegram coming from the BUS.
msg.readstatus = true; // issues a write or response (based on the options <b>Telegram type</b> above) to the KNX bus
return msg;

• Gateway Configuration
• CIRCULAR REFERENCE PROTECTION and FLOOD PROTECTION
• SAMPLES
  • Samples

Node status colors explanation
	React to write telegrams
	Circular reference protection. See this page.
	React to response telegrams.
	Auto send node value as response to the BUS. See Virtual Device.
	React to read telegrams.
	RBE filter: no telegrams has been sent.
	Error or disconnected.
	Node DISABLED due to a circulare reference. See this page.