The SharKNX assistant answers questions about your ETS project and runs tasks on the bus from a chat. This guide shows what you can ask, with prompts that work. For how it works, see The SharKNX Assistant.
Before you start
- Open the assistant with the ✦ button in the top bar.
- Load your ETS project to use names, rooms, and project questions - see Load an ETS Project. Without a project, use literal addresses such as
1/2/3and1.1.5. - Connect to a gateway for bus tasks - from the chat with connect, or see Connect to a Gateway.
- Write in English. Short, direct requests work best: read 1/2/3, is 1.1.5 alive, list devices on line 1.2.
Ask about your project
The assistant answers from the loaded ETS project - exact counts and lists, not estimates.
| To find | Try |
|---|---|
| Project details | show project info, who created the project, when was the project last modified |
| Devices | list devices, list couplers, show devices with an ip address, registered devices on line 1.2 |
| Where a device is | where is 1.1.6, examine 1.1.5, what is the line of 1.1.1 |
| Group addresses | list secure group addresses, which group addresses have dpt 9, list group ranges |
| Who uses a group address | who uses 1/2/3, who sends 1/1/1 |
| What a device talks to | devices linked to 1.1.5, what does 1.1.2 talk to |
| Rooms and buildings | which devices are in room 101, how many rooms are there, list floors |
| Functions | list functions, list dimmable light functions, which group addresses belong to function Lighting |
| Communication objects | com objects with dpt 1, which com objects have the read flag |
| Kinds of things | list all blinds, find all sensors, list all actuators |
| An overview | project stats, which manufacturers are there, which devices are unassigned |
Names come from your project, so "what does the dimmer talk to" works if your project has one dimmer. If several match, the assistant asks which one.
Read and write group addresses
| To | Try | Confirmation |
|---|---|---|
| Read the current value | read 1/2/3, current value of 2/1/9, read the sunset lights |
None |
| Send a read request only | send read 1/2/3 |
None |
| Write a value | 1/2/3 on, 1/2/3 50%, set 12/0/0 to heat, turn off the corridor light |
Confirm |
| Write several values | turn 1/2/3 on and 1/2/4 off, turn 1/2/3 on then off |
Strong |
| Write to many at once | turn off all the lights in suite 001, or a group alias |
Strong |
Values are checked against each group address's datapoint type from the project. read waits for the answer and shows it; send read only sends the request - see the answer on the Monitor.
Check and manage devices
| To | Try | Confirmation |
|---|---|---|
| Check a device answers | ping 1.1.5, is 1.1.1 alive |
None |
| Restart a device | restart 1.1.5, reboot the actuator |
Confirm |
| Switch programming mode | put device 1.1.5 in prog mode, turn on prog mode for 1.1.2 |
Confirm |
| Find devices in programming mode | prog mode scan, scan for programming button |
None |
| Program an individual address | Press the device's programming button, then assign address 1.1.7 |
Strong |
| Scan a line | scan line 1.1, line scan for line 1.1 |
None |
Device tasks and scans need a subscription on Android, iOS, and macOS. Found devices from a line scan are listed in the chat - see Scan a KNX Bus Line for what a scan shows.
Gateways, monitor, and network
| To | Try |
|---|---|
| Find gateways | find gateways, discover |
| Connect | connect, connect 192.168.2.1 |
| Check the connection | are we connected, /status |
| Disconnect | disconnect |
| Start, stop, or restart the monitor | start monitoring, stop the monitor, restart monitor |
| Check the monitor | is the monitor running |
| Show this device's IP address | my ip |
| Load an ETS project | load project |
connect uses your selected gateway; if none is selected, the assistant offers your configured and discovered gateways. Telegrams from a monitor started in the chat appear on the Monitor page.
Combine steps
Join simple requests with then or and:
connect then start monitorturn 1/2/3 on and 1/2/4 off
They run as a plan, one step after another. For conditions - write this only if that reads above 22 - use exact commands: see Assistant Commands. Up to 4 separate commands fit in one request - see Limits.
Follow up
The assistant remembers what you were just working on. After examine 1.1.5, you can say ping it; after a clarification, answer with just the choice.
Tips
- Use exact commands when you know the address and value -
sharknx write 1/2/3 onis never interpreted, only parsed. See Assistant Commands. - Teach it your names. If your project names are cryptic, give things your own names with aliases.
- Ask for help - what can you do? or sharknx help.
Troubleshooting
| Problem | What to check |
|---|---|
| It doesn't recognise the request | Rephrase shorter, name the address directly, or try a suggestion under Try one of these:. Only English is understood. |
| I couldn't find anything matching ... | The name isn't in the loaded project. Check the spelling, use the address, or add an alias. |
| It asks which one you mean | The name matches several project entries. Pick one, use a more specific name, or use the address. |
| No ETS project is loaded | Load the project, or use literal addresses. |
| No gateway is selected / Could not connect to the gateway | Connect first - find gateways then connect - or check the gateway on the Connect page. |
| Device operations and scans require Premium | These tasks need a subscription on Android, iOS, and macOS - see Subscription Plans. |
| No response received within 1 second | The group address has no device that answers reads - check its R flag in ETS. |
