Plugin SDK v1.2.5.0 Release Notes

This release contains changes to the way IDs are processed as well as some new methods and changes to existing ones.

  • Change ID handling for plugins and JUI views. (PSDK-140) (GitHub Issue 178)
    • !"#$%&'()*+,/:;<=>?@[]^`{|}~ and space are all considered special characters that should not be used.
    • The existence of certain special characters in plugin IDs is causing undesired behavior. This includes previously accepted characters like '_' (underscores). We will be updating the list of restricted characters over time to ensure that all plugins can shift if needed. We understand that this is not easy to handle if your plugin manages devices or events, and we are working on additional tools for you to use if you do need to make changes to your IDs. This change starts with warnings written to the HS logs if a special character is detected in a plugin ID only while in developer mode. At a future date, this will change to stop plugins from running if they are using a special character in their ID.
    • JUI view IDs with special characters like '.' may cause javascript errors during runtime. To reduce the likelihood of these errors, all JUI javascript code has been adjusted to use '-' in place of '.' and you will now receive a warning in the HS logs (while in developer mode) if a special character is detected in a view ID.
  • Add methods and fields to allow access to the legacy Code field on devices. HS3 supported an Address and Code field, but the Code field has been deprecated. The Address and Code fields used to also be combined into a single string with the format of ADDRESS-CODE. The pseudocode for this is "${ADDRESS}-${CODE}".Trim('-'); To maintain backwards compatibility support, the Address field will be overloaded with the Code for devices created using HS3. (PSDK-22) (GitHub Issue 59)
  • Update cross-plugin functionality. (PSDK-77) (PSDK-78) (GitHub Issue 79)