iobroker.zigbee 3.0.0 → 3.0.1

package/README.md

@@ -68,13 +68,18 @@ At first start, it is vital to set up the adapter settings. These include:
 - the network parameters PanID (a number between 0 and 65565), extended PanID (a 16 digit HEX number) and the zigbee Channel **important: Do not run the adapter without changing the values for PanID (6754) and Extended PanID (DDDDDDDDDDDDDDDD) to unique values for your Zigbee Installation.**
 
 
-![](docs/de/img/Zigbee_config_de.png)
+![](docs/en/img/Zigbee_config_en.png)
+
+The *Test Port* and *Star/Stop* buttons are provided to test the settings.
+
+**Once the settings are verified the adapter can be prepared for automatic start by setting the CheckBox *start the zigbee network automatically* and saving the parameters.**
+
 Please refer to the [in depth documentation](docs/en/readme.md) ([german version](docs/de/readme.md), [russian version](docs/ru/readme.md)) for a detailed explanation on how to configure the adapter.
 
 Once the adapter is up and running, the desired devices need to be integrated into the network. This requires for both the adapter and the device to be in pairing mode. Most new devices will be in pairing-mode when they are powered up for the first time, but some will require a special procedure for this. Please refer to the device manual for information on this.
 
 The adapter is placed in pairing mode by pressing the pairing button:
-![](docs/de/img/Bild12.png)
+![](docs/en/img/Zigbee_pairing_en.png)
 
 A dialog showing a pairing countdown appears. When a new device is discovered, interviewed and paired with the network, messages will be shown in this dialog, and the device will show up in the grid of active devices. Any known device should show up with an image and the correct device name, as well as a number of changable settings. Any unknown device will show up with a device name and a ? as icon, while devices which failed the pairing will show up as 'unknown' with the same ? icon. These should be removed from the network to be paired again. Please refer to the documentation linked above for more details.
 
@@ -152,8 +157,16 @@ You can thank the authors by these links:
 
 -----------------------------------------------------------------------------------------------------
 ## Changelog
+### 3.0.1 (2025-04-25)
+* (AlexHaxe)  Fix for Ikea SOMRIG configuration raising 'definition.endpoint is not a function' error.
+* (asgothian) Access to 'zigbee2mqtt options as settings in zigbee adapter (ALPHA Stage !)
+* (asgothian) Fix for 'error: zigbee.0 (1118300) zigbee.0 already running' at adapter start (Alpha Stage)
+* (asgothian) Updated hardware configuration panel - exchanged text buttons for buttons with icons.
+* (asgothian) Limited states on device tiles to states which are read only or which can be modified sensibly via the device tile.
+*
+
 ### 3.0.0 (2025-04-08)
-* (asgothian) Breaking change: Start of zigbee subsystem requires configuration entry !!!
+* (asgothian) Breaking change: Start of zigbee subsystem requires checking the 'start the Zigbee network automatically' checkbox. !!!
 * (asgothian) Hardware configuration panel
 * (asgothian) Update for external converter - detect /dist/ subfolder
 * (asgothian) Update device image: use of icons defined in external converter (beta)

package/admin/admin.js

@@ -429,7 +429,81 @@ function EndPointIDfromEndPoint(ep) {
     return 'unidentified';
 }
 
+
+
 function editName(id, name) {
+
+    const device_options = {};
+    const received_options = {};
+
+    function removeOption(k) {
+        if (k && device_options.hasOwnProperty(k)) delete device_options[k];
+    }
+
+    function addOption() {
+        let idx=1;
+        let key = '';
+        do {
+            key = `o${idx++}`;
+        }
+        while (device_options.hasOwnProperty(key));
+        device_options[key] = {key:`option_${idx++}`, value:''};
+    }
+
+    function updateOptions() {
+        const html_options=[];
+
+        console.warn(`device_options is ${JSON.stringify(device_options)}`)
+
+        for (const k in device_options) {
+            html_options.push(`<div class="row">`);
+            html_options.push(`<div class="input-field suffix col s5 m5 l5"><input id="option_key_${k}" type="text" class="value" /><label for="option_key_${k}">Option</label></div>`)
+            html_options.push(`<div class="input-field suffix col s5 m5 l5"><input id="option_value_${k}" type="text" class="value" /><label for="option_value_${k}">Value</label></div>`)
+            html_options.push(`<div class="col"><a id="option_rem_${k}" class='btn' ><i class="material-icons">remove_circle</i></a></div>`);
+            html_options.push(`</div>`)
+        }
+        console.warn(`html is ${$('#modaledit').find('.options_grid').html()}`)
+        $('#modaledit').find('.options_grid').html(html_options.join(''));
+        console.warn(`html is now ${$('#modaledit').find('.options_grid').html()}`)
+        if (html_options.length > 0) {
+            $('#modaledit').find('.options_available').removeClass('hide');
+            for (const k of Object.keys(device_options)) {
+                $(`#option_key_${k}`).val(device_options[k].key);
+                $(`#option_value_${k}`).val(device_options[k].value);
+                $(`#option_rem_${k}`).unbind('click');
+                $(`#option_rem_${k}`).click(() => { removeOption(k); updateOptions() });
+            }
+        }
+        else {
+            $('#modaledit').find('.options_available').addClass('hide');
+        }
+    }
+
+    function getOptionsFromUI(_do, _so) {
+        const _no = {};
+        let changed = false;
+        for (const k in _do) {
+            const key =  $(`#option_key_${k}`).val();
+            _do[k].key = key;
+            const val = $(`#option_value_${k}`).val();
+            try {
+                _do[k].value = JSON.parse(val);
+            }
+            catch {
+                _do[k].value = val;
+            }
+            if (device_options[k].key.length > 0) {
+                _no[key] = device_options[k].value;
+                changed |= _no[key] != _so[key];
+            }
+        }
+        changed |= (Object.keys(_no).length != Object.keys(_so).length);
+        if (changed) return _no;
+        return undefined;
+    }
+
+
+
     console.warn('editName called with ' + id + ' and ' + name);
     const dev = devices.find((d) => d._id == id);
     $('#modaledit').find('input[id=\'d_name\']').val(name);
@@ -442,14 +516,16 @@ function editName(id, name) {
         }
     }
     const numEP = groupables.length;
-    $('#modaledit').find('.row.epid0').addClass('hide');
-    $('#modaledit').find('.row.epid1').addClass('hide');
-    $('#modaledit').find('.row.epid2').addClass('hide');
-    $('#modaledit').find('.row.epid3').addClass('hide');
-    $('#modaledit').find('.row.epid4').addClass('hide');
-    $('#modaledit').find('.row.epid5').addClass('hide');
-    $('#modaledit').find('.row.epid6').addClass('hide');
+
     if (numEP > 0) {
+        $('#modaledit').find('.groups_available').removeClass('hide');
+        $('#modaledit').find('.row.epid0').addClass('hide');
+        $('#modaledit').find('.row.epid1').addClass('hide');
+        $('#modaledit').find('.row.epid2').addClass('hide');
+        $('#modaledit').find('.row.epid3').addClass('hide');
+        $('#modaledit').find('.row.epid4').addClass('hide');
+        $('#modaledit').find('.row.epid5').addClass('hide');
+        $('#modaledit').find('.row.epid6').addClass('hide');
         // go through all the groups. Find the ones to list for each groupable
         if (numEP == 1) {
             $('#modaledit').find('.endpointid').addClass('hide');
@@ -479,7 +555,37 @@ function editName(id, name) {
             list2select('#d_groups_ep' + i, groups, groupables[i].memberOf || []);
         }
     }
+    else
+    {
+        $('#modaledit').find('.groups_available').addClass('hide');
+    }
+    sendTo(namespace, 'getLocalConfigItems', { target:id, global:false, key:'options' }, function (msg) {
+        if (msg) {
+            if (msg.error) showMessage(msg.error, '_Error');
+            console.warn(`return is ${msg}`)
+            Object.keys(device_options).forEach(key => delete device_options[key]);
+            Object.keys(received_options).forEach(key => delete received_options[key]);
+            if (typeof msg.options === 'object') {
+
+                let cnt = 1;
+                for (const key in msg.options)
+                {
+                    received_options[key]=msg.options[key];
+                    device_options[`o${cnt}`] = { key:key, value:msg.options[key]}
+                    cnt++;
+                }
+            }
+            updateOptions();
+
+        } else showMessage('callback without message');
+    });
     $('#modaledit a.btn[name=\'save\']').unbind('click');
+    $('#modaledit a.btn[name=\'add_options\']').unbind('click');
+    $('#modaledit a.btn[name=\'add_options\']').click(() => {
+        getOptionsFromUI(device_options, received_options);
+        addOption();
+        updateOptions()
+    });
     $('#modaledit a.btn[name=\'save\']').click(() => {
         const newName = $('#modaledit').find('input[id=\'d_name\']').val();
         const groupsbyid = {};
@@ -490,8 +596,21 @@ function editName(id, name) {
                     groupsbyid[groupables[i].ep.ID] = GenerateGroupChange(groupables[i].memberOf, ng);
             }
         }
-        console.log('grpid ' + JSON.stringify(groupsbyid));
+        // read device_options from UI
+        const co = getOptionsFromUI(device_options, received_options)
+        console.warn(`options have ${co ? 'changed' : 'not changed'} : ${JSON.stringify(co)} vs ${JSON.stringify(received_options)} , saving them`);
+        if (co) {
+            sendTo(namespace, 'updateLocalConfigItems', {
+                target: id,
+                global:false,
+                data: { options:co }
+            },
+            function (msg) {
+                if (msg && msg.error) showMessage(msg.error, '_Error');
+            });
+        }
         updateDev(id, newName, groupsbyid);
+
     });
     $('#modaledit').modal('open');
     Materialize.updateTextFields();
@@ -848,8 +967,8 @@ async function toggleDebugDevice(id) {
     });
 }
 
-function updateDeviceData(device, data, global) {
-    sendTo(namespace, 'updateDeviceData', {target: device, data:data, global:global}, function(msg) {
+function updateLocalConfigItems(device, data, global) {
+    sendTo(namespace, 'updateLocalConfigItems', {target: device, data:data, global:global}, function(msg) {
         if (msg && msg.hasOwnProperty.error) {
             showMessage(msg.error, _('Error'));
         }
@@ -898,7 +1017,7 @@ async function selectImageOverride(id) {
                 const data = {};
                 if (image != 'current') data.icon= image;
                 if (name != dev.common.name) data.name = name;
-                updateDeviceData(id, data, global);
+                updateLocalConfigItems(id, data, global);
             });
             $('#chooseimage').modal('open');
             Materialize.updateTextFields();
@@ -1022,6 +1141,7 @@ function displayDebugMessages(msg) {
             Html.push('</tbody></table></li>')
             for (const devID of Object.keys(dbgData)) {
                 const dev = devices.find((d) => d._id.endsWith(devID.slice(-16)));
+                if (!dev) continue;
                 const type_url = (dev && dev.common && dev.common.type ? sanitizeModelParameter(dev.common.type) : 'unknown');
                 const image = `<img src="${dev.common.icon || dev.icon}" width="40px" onerror="this.onerror=null;this.src='img/unavailable.png';">`
                 const modelUrl = (type_url === 'unknown') ? 'unknown' : `<a href="https://www.zigbee2mqtt.io/devices/${type_url}.html" target="_blank" rel="noopener noreferrer">${image}</a>`;
@@ -3358,6 +3478,7 @@ function getDashCard(dev, groupImage, groupstatus) {
             let options;
             if (typeof stateDef.states == 'string') {
                 const sts = stateDef.states.split(';');
+                if (sts.length < 2) return '';
                 options = sts.map((item) => {
                     const v = item.split(':');
                     return `<option value="${v[0]}" ${(val == v[0]) ? 'selected' : ''}>${v[1]}</option>`;
@@ -3368,9 +3489,14 @@ function getDashCard(dev, groupImage, groupstatus) {
                     options.push(`<option value="${key}" ${(val == key) ? 'selected' : ''}>${key}</option>`);
                 }
             }
+            if (options.length < 2) return '';
             val = `<select class="browser-default enum" style="color : white; background-color: grey; height: 16px; padding: 0; width: auto; display: inline-block">${options.join('')}</select>`;
-        } else {
-            val = `<span class="dash value">${val} ${(stateDef.unit) ? stateDef.unit : ''}</span>`;
+        } else if (stateDef.write) {
+            return;
+            // val = `<span class="input-field dash value"><input class="dash value" id="${stateDef.name}" value="${val}"></input></span>`;
+        }
+        else {
+            val = `<span class="dash value">${val ? val : '(null)'} ${(stateDef.unit) ? stateDef.unit : ''}</span>`;
         }
         return `<li><span class="label dash truncate">${stateDef.name}</span><span id=${sid} oid=${id} class="state">${val}</span></li>`;
     }).join('') : '';
@@ -3536,7 +3662,7 @@ function validateConfigData(key, val) {
     }
     if (nvRamBackup[key]) {
         console.warn(`value of ${key} is ${val} (${nvRamBackup[key]})`);
-        if (val == nvRamBackup[key])
+        if ((typeof val == 'string' && typeof nvRamBackup[key] == 'string' && val.toLowerCase == nvRamBackup[key].toLowerCase) || val == nvRamBackup[key])
         {
             console.warn(`ok set for ${key} (${val})`)
             $(`#${key}_OK`).removeClass('hide')

package/admin/index_m.html

@@ -480,6 +480,10 @@
         .m .navbar-fixed {
             z-index: unset;
         }
+        .img-btn {
+            padding: 2px;
+            height: 100%;
+        }
 
         @keyframes blinking-icon {
           0%    { opacity: 0; }
@@ -920,7 +924,7 @@
                     </label>
                 </div>
                 <div class="input-field col s12 m6 l8">
-                    <a id="scan" class='btn' data-target='channel_a'><i class="material-icons">graphic_eq</i></a>
+                    <a id="scan" class="waves-effect waves-light btn" data-target='channel_a'><img class="img-btn" src="img/channel_scan.png" title="scan zigbee channels" ></a>
                     <p class="translate">ChannelChangeText</p>
                 </div>
             </div>
@@ -938,27 +942,21 @@
                 </div>
             </div>
             <div class="row">
-                <h6>Verification</h6>
+                <h6>Test and Verification</h6>
             </div>
             <div class="row">
-                <div class="input-field col s9 m4 l3">
-                    <a id="test-btn" class="waves-effect waves-light white-text btn-large translate">Test Port</a>
-                </div>
-                <div class="input-field col s9 m4 l3">
-                    <a id="show_test_run" class="waves-effect waves-light white-text btn-large translate">Start / Stop</a>
-                </div>
-                <div class="input-field col s9 m4 l3">
-                    <a id="readNVRam-btn" class="waves-effect waves-light white-text btn-large translate">Read NVBackup</a>
-                </div>
-                <div class="input-field col s9 m4 l3">
-                    <a id="deleteNVRam-btn" class="waves-effect waves-light white-text btn-large translate">remove NVBackup</a>
-                </div>
-                <div class="input-field col s9 m4 l3">
-                    <a id="reset-btn" class="waves-effect waves-light white-text btn-large translate">Reset...</a>
+                <div class="col">
+                    <a id="test-btn" class="waves-effect waves-light white-text btn"><img class="img-btn" src="img/test_port.png" title="test port"></a>&nbsp;
+                    <a id="show_test_run" class="waves-effect waves-light blue btn"><img class="img-btn" src="img/start_stop.png" title="start / stop" ></a>&nbsp;
+                    <a id="readNVRam-btn" class="waves-effect waves-light btn"><img class="img-btn" src="img/nvram_read.png" title="read nvram backup" ></a>&nbsp;
+                    <a id="deleteNVRam-btn" class="waves-effect waves-light btn"><img class="img-btn" src="img/nvram_delete.png" title="remove nvram backup" ></a>&nbsp;
+                    <a id="reset-btn" class="waves-effect waves-light white-text btn translate"><img class="img-btn" src="img/reset.png" title="reset..." ></a>&nbsp;
                 </div>
             </div>
             <div class="row textarea">
-                <textarea class="monospaced" id="stdout_t" disabled="disabled" cols="120" rows="20" style="height: calc(50% - 115px)"></textarea>
+                <div class="col">
+                    <textarea class="monospaced" id="stdout_t" disabled="disabled" cols="120" rows="20" style="height: calc(50% - 115px)"></textarea>
+                </div>
             </div>
         </div>
         <div id="tab-expos" class="col s12 page">
@@ -1232,115 +1230,129 @@
                     </div>
                 </div>
             </div>
-            <div class="row epid0">
-                <div class="col">
-                    <div class=endpointid>
-                        <p class="translate device_with_endpoint">Main Endpoint</p>
-                    </div>
-                </div>
-                <div class="col1">
-                    <div class="input-field groups">
-                        <select id="d_groups_ep0" class="materialSelect" multiple>
-                            <option value="1">select</option>
-                        </select>
-                        <label for="d_groups_ep0" class="translate">Groups</label>
-                    </div>
-                </div>
-            </div>
-            <div class="row epid1">
-                <div class="col epid">
-                    <div class=endpointid>
-                        <p class="translate device_with_endpoint">Sub Endpoint 1</p>
-                    </div>
-                </div>
-                <div class="col">
-                    <div class="input-field groups">
-                        <select id="d_groups_ep1" class="materialSelect" multiple>
-                            <option value="1">select</option>
-                        </select>
-                        <label for="d_groups_ep1" class="translate">Groups</label>
-                    </div>
-                </div>
-            </div>
-            <div class="row epid2">
-                <div class="col epid">
-                    <div class=endpointid>
-                        <p class="translate device_with_endpoint">Sub Endpoint 2</p>
-                    </div>
-                </div>
-                <div class="col">
-                    <div class="input-field groups">
-                        <select id="d_groups_ep2" class="materialSelect" multiple>
-                            <option value="1">select</option>
-                        </select>
-                        <label for="d_groups_ep2" class="translate">Groups</label>
-                    </div>
-                </div>
-            </div>
-            <div class="row epid3">
-                <div class="col epid">
-                    <div class=endpointid>
-                        <p class="translate device_with_endpoint">Sub Endpoint 3</p>
-                    </div>
-                </div>
-                <div class="col">
-                    <div class="input-field groups">
-                        <select id="d_groups_ep3" class="materialSelect" multiple>
-                            <option value="1">select</option>
-                        </select>
-                        <label for="d_groups_ep3" class="translate">Groups</label>
-                    </div>
-                </div>
-            </div>
-            <div class="row epid4">
-                <div class="col epid">
-                    <div class=endpointid>
-                        <p class="translate device_with_endpoint">Sub Endpoint 4</p>
-                    </div>
-                </div>
-                <div class="col">
-                    <div class="input-field groups">
-                        <select id="d_groups_ep4" class="materialSelect" multiple>
-                            <option value="1">select</option>
-                        </select>
-                        <label for="d_groups_ep4" class="translate">Groups</label>
-                    </div>
-                </div>
+            <div class="groups_available">
+            <div class="row">
+              <h6>Groups</h6>
             </div>
-            <div class="row epid5">
-                <div class="col epid">
-                    <div class=endpointid>
-                        <p class="translate device_with_endpoint">Sub Endpoint 5</p>
-                    </div>
-                </div>
-                <div class="col">
-                    <div class="input-field groups">
-                        <select id="d_groups_ep5" class="materialSelect" multiple>
-                            <option value="1">select</option>
-                        </select>
-                        <label for="d_groups_ep5" class="translate">Groups</label>
-                    </div>
-                </div>
+              <div class="row epid0">
+                  <div class="col">
+                      <div class=endpointid>
+                          <p class="translate device_with_endpoint">Main Endpoint</p>
+                      </div>
+                  </div>
+                  <div class="col1">
+                      <div class="input-field groups">
+                          <select id="d_groups_ep0" class="materialSelect" multiple>
+                              <option value="1">select</option>
+                          </select>
+                          <label for="d_groups_ep0" class="translate">Groups</label>
+                      </div>
+                  </div>
+              </div>
+              <div class="row epid1">
+                  <div class="col epid">
+                      <div class=endpointid>
+                          <p class="translate device_with_endpoint">Sub Endpoint 1</p>
+                      </div>
+                  </div>
+                  <div class="col">
+                      <div class="input-field groups">
+                          <select id="d_groups_ep1" class="materialSelect" multiple>
+                              <option value="1">select</option>
+                          </select>
+                          <label for="d_groups_ep1" class="translate">Groups</label>
+                      </div>
+                  </div>
+              </div>
+              <div class="row epid2">
+                  <div class="col epid">
+                      <div class=endpointid>
+                          <p class="translate device_with_endpoint">Sub Endpoint 2</p>
+                      </div>
+                  </div>
+                  <div class="col">
+                      <div class="input-field groups">
+                          <select id="d_groups_ep2" class="materialSelect" multiple>
+                              <option value="1">select</option>
+                          </select>
+                          <label for="d_groups_ep2" class="translate">Groups</label>
+                      </div>
+                  </div>
+              </div>
+              <div class="row epid3">
+                  <div class="col epid">
+                      <div class=endpointid>
+                          <p class="translate device_with_endpoint">Sub Endpoint 3</p>
+                      </div>
+                  </div>
+                  <div class="col">
+                      <div class="input-field groups">
+                          <select id="d_groups_ep3" class="materialSelect" multiple>
+                              <option value="1">select</option>
+                          </select>
+                          <label for="d_groups_ep3" class="translate">Groups</label>
+                      </div>
+                  </div>
+              </div>
+              <div class="row epid4">
+                  <div class="col epid">
+                      <div class=endpointid>
+                          <p class="translate device_with_endpoint">Sub Endpoint 4</p>
+                      </div>
+                  </div>
+                  <div class="col">
+                      <div class="input-field groups">
+                          <select id="d_groups_ep4" class="materialSelect" multiple>
+                              <option value="1">select</option>
+                          </select>
+                          <label for="d_groups_ep4" class="translate">Groups</label>
+                      </div>
+                  </div>
+              </div>
+              <div class="row epid5">
+                  <div class="col epid">
+                      <div class=endpointid>
+                          <p class="translate device_with_endpoint">Sub Endpoint 5</p>
+                      </div>
+                  </div>
+                  <div class="col">
+                      <div class="input-field groups">
+                          <select id="d_groups_ep5" class="materialSelect" multiple>
+                              <option value="1">select</option>
+                          </select>
+                          <label for="d_groups_ep5" class="translate">Groups</label>
+                      </div>
+                  </div>
+              </div>
+              <div class="row epid6">
+              <div class="col epid">
+                  <div class=endpointid>
+                      <p class="translate device_with_endpoint">Sub Endpoint 6</p>
+                  </div>
+              </div>
+              <div class="col">
+                  <div class="input-field groups">
+                      <select id="d_groups_ep6" class="materialSelect" multiple>
+                          <option value="1">select</option>
+                      </select>
+                      <label for="d_groups_ep6" class="translate">Groups</label>
+                      </div>
+                  </div>
+              </div>
             </div>
-            <div class="row epid6">
-                <div class="col epid">
-                    <div class=endpointid>
-                        <p class="translate device_with_endpoint">Sub Endpoint 6</p>
-                    </div>
-                </div>
-                <div class="col">
-                    <div class="input-field groups">
-                        <select id="d_groups_ep6" class="materialSelect" multiple>
-                            <option value="1">select</option>
-                        </select>
-                        <label for="d_groups_ep6" class="translate">Groups</label>
-                    </div>
-                </div>
+            <div class="options_available">
+              <div class="row">
+                  <h6>Options</h6>
+              </div>
+              <div class="row options">
+
+              </div>
             </div>
         </div>
         <div class="modal-footer">
-            <a name="save" href="#!"
-               class="modal-action modal-close waves-effect waves-green btn green translate">Save</a>
+            <a name="remove_options" class="waves-effect waves-green btn green translate"><i class="material-icons large">remove_circle</i></a>
+            <a name="add_options" class="waves-effect waves-green btn green translate"><i class="material-icons large">add_circle</i></a>
+            <a name="save" href="#!" class="modal-action modal-close waves-effect waves-green btn green translate">Save</a>
             <a href="#!" class="modal-action modal-close waves-effect waves-red btn-flat translate">Cancel</a>
         </div>
     </div>