Cookie Consent by Privacy Policies Generator website Shelly Scanner Manual

Manual

The use of Shelly Scanner is quite intuitive however there is also some "hidden" feature, so reading this small manual can be valuable.
Here you find the list of all buttons in the toolbar:
  • Re-scans the network looking for connected Shelly devices.
  • Immediately Refresh all devices status.
  • Opens a window showing the full information set of the selected device in json (native) format.
  • Opens a window showing the logs of the selected device. First generation devices only allow the viewing of one or two log files (logs must be enabled from the web interface of the devices); on the contrary second generation devices send logs on a streaming channel and it is possible to enable / disable logs, temporarily block (until the window is closed) Shelly Scanner refreshes for the device (in order to stop generation of related logs), select the log level.
  • Opens the web UI of the selected device on the system browser.
  • Backs up the configuration of one or more devices. if more than one device is selected, the application asks to select a folder where all files are saved; in this case files get a default name. If you need to change information before restoring, note that backup files, with the sbk extension, are actually a set of zipped json text files; backups of second generation devices also include scripts which, however, are not restored at this time.
  • Restores the configuration of the selected device. Restore can be performed from a file generated by a different device as long as it is of the same type; in this case, confirmation will be requested. During the restore process, the application, if applicable for recovery, can ask for the passwords of: restricted login, wi-fi1, wi-fi2, mqtt server. It should be noted that not all parameters are restored; new parametrs are added on new releases.
  • Opens a window from which is possible to manage some parameters of several devices at the same time; changes are applied on every selected device on confirmation. Two buttons are available at the bottom-right of the status bar (main view) to select all the devices; for obvious reasons the changes have no effect on offline devices. You can manage:
    • Firmware update to stable or beta version (note that tooltip on version number shows the full version identifier);
    • WI-FI 2 (static IP option is active if only one device is selected);
    • Restricted login
      If some second generation devices is selected the username must be "admin";
    • MQTT configuration
      Blank fields in this section do not affect device configuration.
  • Script management (Generation 2 devices only). A window opens listing existing scripts on the selected device and allowing you to rename or enable/disable them. The following operations can also be performed from here:
    • Delete;
    • Creation;
    • Run / Stop;
    • Download and upload (even for large scripts).
    You can observe the output of the scripts on the log window which can be opened concurrently. The scripts log level is below 0 (error) therefore, for this purpose, I recommend setting the log level to 0.
  • Reboot (after confirmation) all selected devices.
  • Toggle to "full view" mode: all informative columns are displayed; the window enlarges, or remains unchanged, according to one of the criteria defined in the application settings. When this mode is active the button icon changes to .
  • Export the table content to a file in CSV format.
  • Print the table.
  • Application settings. This section allows, for example, to choose which columns to display, to select the network scan mode or to define the default values (user and PIN) for access to protected devices (warning: using this function the password is stored in an insecure way on the disk).
  • Provides information about the application (you will also find the link to load this page).

The contents of the columns shown by the table have a generally obvious meaning, however some further explanation may be useful:
  • Symbols appearing in the Satus column have the following meaning:
    • On line;
    • Updating data;
    • Protected device, you need to log in (from the context menu - right mouse button);
    • Off line;
    • Error (in most cases the cause is due to an application malfunction probably caused by an outdated device firmware).
  • Cloud (En/com) contains have a double value: cloud enable / actual connection to the cloud;
  • Uptime (s) is the time elapsed since the last restart (or firmware update) expressed in seconds; the tooltip, which appears by holding the pointer for a few moments on the uptime box, gives the same in days, hours, minutes and seconds;
  • The tootip of the Command column also inform on the event that caused the last change of state if the Source column is not visible; the information, as always, is provided by every single device but my feeling is that it is not always reliable.

Hereafters some details that may be not obvious at a first glance:
  1. If the application does not find all the devices at startup (consider that some battery-powered devices such as: Button 1, Flood, D&W,... are discovered only at the time they temporarily activate) probably the computer on which Shelly Scanner runs and the devices are not exactly on the same network. In this case it is necessary to configure the application settings from the appropriate dialog (warning: the changes of these parameters are active only on the next application execution).
    In case your computer has more than one physical or virtual network interface (VPN) you must configure the application to perform "full mDNS scan". Compared to the simpler "local mDNS scan" the search for devices will be somehow slower. If the devices are on a separate network (it is, for example, the case of a subnet dedicated to home automation devices) it is necessary to set the "scan by IP" option which, however, inhibits the discovery of some battery-powered Shellyes such as Button 1, Flood or D&W.
    Alternatively you can run the application from a terminal ignoring stored scan settings with the following command line: java -jar <full path>\shellyscan-x.x.x.jar adding -fullscan to perform "full scan" search or -localscan for "local scan" or -ipscan x.y.z.a-b where x.y.z is the network IP prefix, a and b are the lower and higher addresses to check for respectively (e.g. -ipscan 192.168.1.1-254).
  2. Double clicking on a row in the table (but not on the "Command" column) shows the detailed information for the corresponding device (this is equivalent to click the button on the toolbar or on contextual menu) or open the web page of the device on the system browser ; this behavior is defined by the application settings.
  3. Some actions from the toolbar can be performed on a single device only while others affect all selected devices. Buttons on the toolbar that work on multiple devices are active when multiple devices are selected. This also applies to the "settigs" function.
  4. Clicking on a row of the table with the right mouse button, the corresponding device is selected and a contextual menu is activated which reproduces part of the toolbar buttons.
  5. The table row filter can be edited with keyboard shortcuts: ctrl-S cycles through the combo values that allows you to choose which column to search from; ctrl-F focuses the input text field in which to type the characters sequance to search; ctrl-E select the text field and clear it.
  6. From application settings you can choose which table columns are shown. The order of the columns can be altered by dragging each header with the pointer. The new column location is later remembered by Scelly Scanner. CSV export keeps same visibilities and positions settings.
  7. If you want to report an application error (for which I would be grateful) please activate the logs running the application from a terminal with the following command line: java -D"org.slf4j.simpleLogger.log.it.usna=debug"-D"org.slf4j.simpleLogger.showDateTime=true" -jar <full path>\shellyscan-x.x.x.jar, produce the error and attach to the report the terminal content.