Differences

This shows you the differences between two versions of the page.

--- current [2020/03/30 13:51] – 9.4.30 James Sentman
+++ current [2023/07/30 17:34] – James Sentman
@@ Line 1: / Line 1: @@
-=====XTension Version 9.4.30=====
+=====Download XTension 9.5.3=====
-Released: 3/30/2020\\
-\\
-Download for Mohave and Earlier: [[https://www.machomeautomation.com/files/xtension/xtension_9.4.30.zip|XTension v9.4.30 (build 1021) 3/30/2020]]\\
-Download for Catalina Only: [[https://www.machomeautomation.com/files/xtension/xtension_9.4.30.dmg|XTension v9.4.30 (build 1021) for Catalina Only 3/25/2020]]\\
-\\
-**NOTE: the catalina download is a notarized disk image file but does not contain the entirety of the plugins as not all are updated to run on Catalina yet. See the Catalina note below or more info. Please do not use this image on a 10.14 (Mohave) or earlier version, use the zip file above.**
-====Important Info====
+Released 7/30/2023\\
-**Minimum System Version** for this release is OSX 10.10\\
 \\
-**Mac OSX Catalina** As of this moment I do not recommend that anyone update to OSX Catalina. Changes in Catalina have disabled several of the older plugins and the newer ones are not fully tested with it yet. As of this moment I do not recommend running Catalina on your house server. I don’t see any advantages and there are many potential issues not just with XTension. I can provide an Apple notarized DMG file of the subset of plugins that do work properly if this is something that you need. Otherwise do not update to Catalina yet for your house server.\\
+Download Universal Binary for all Supported OS versions; [[https://www.machomeautomation.com/files/xtension/xtension_9_5_3.dmg|XTension. v 9.5.3 (build 1084)]]\\
-\\
-**Mac OSX Mojave** has changed the requirements for scripting of other applications. You MUST force any script to run that contacts a different application when you upgrade and click “OK” when it asks for permission or your scripts will silently fail when they run later. See the [[tech_notes:mojave|Mojave Support Page]] for more info.\\
+**Minimum System Version** for this release is OSX 10.10 but not all plugins will function properly prior to 10.13. Please start the necessary work to upgrade to at least 10.13 or recommended 10.15 or newer. At some point in the near future it will no longer be possible for me to support anything prior to 10.13 and the video plugins will never work prior to Catalina.
+**Rosetta Note:** While the entirety of the main app and all more recent plugins are Universal and run natively on Intel or Apple Silicon there are a few older plugins including the W800 and CM11 that are still Intel only. They run fine under Rosetta and you’ll never notice the difference. The only issue is that Rosetta is not included by default on the new Apple Silicon Macs. You’ll need to first run any Intel app, or do a get info on any app at all and select “open using Rosetta” then the OS will tell you that you need Rosetta and would you like to install it now. Once you complete that those plugins will run normally.
-====9.4.30 Change Log:====
+====9.5.3 Change Log:====
-  * Fix for encryption library failures with the Home Kit Plugin
-  * Fix for shared units not updating in the plugin database. This affected Home Kit, Alexa, the Shared Database plugins and the WebSocket plugin.
-\\
-This release was a hot patch to fix problems with Home Kit and shared databases. No other changes or additions were made since 9.4.28. The 9.4.28 changelog is included below.
+  * **Amcrest Camera API:**
+    * Fixed an issue that caused some cameras not to work with the event system. If you find that any cameras still do not send you events but also dont log any other communication or connection errors please let me know we can gather some more info.
+    * Added a check to the enableEvents() command so that it will not try to enable events that the plugin does not recognize as valid. This keeps you from either getting nothing, or getting an error message each time the unknown events is sent. If there are events that I am not handling that you know about and would like to get please let me know we can gather more info about them and set them up.
+    * Added support for specific Units to link to Object Detection if your camera supports it. You can now create a Unit to get an ON when a human is detected, or when a vehical is detected and so forth.
+    * Amcrest API New Status and Display commands:
+      * setFontScale(0.1..2.0) control the size of the text displayed over the image.
+      * setChannelTitleVisible( true|false)
+      * setChannelTitleLocation( 34, 12)
+      * setChannelTitleColor( R, G, B, A)
+      * setChannelTitleBackColor( R, G, B, A)
+      * setUserDisplayVisible( index, true|false)
+      * setUserDisplayText( index, “the info to display”)
+      * setUserDisplayLocation( index, xloc, yloc)
+      * setUserDisplayColor( R, G, B, A)
+      * setUserDisplayBackColor( R, G, B, A)
+      * setLogoVisible( true|false) hide or show the Amcrest logo image overlay
+      * setLogoLocation( xLoc, yLoc)
+      * setLogoFilename( “osd.bmp”) your camera must support allowing you to change this or it will do nothing.
+      * setTimeDisplayVisible( true|false)
+      * setTimeDisplayLocation( xLoc, yLoc)
+      * setTimeDisplayColor( R, G, B, A)
+      * setTimeDisplayBackColor( R, G, B, A)
+      * setTimeDisplayFormat( “yyyy-M-dd hh:mm:ss t”) see the wiki link above for a table of valid format string entities.
+      * note that there is a limit to the number of overlays the camera can “blend” into the encoding video. Check the capabilities below to find out what the limit is for your camera. They may all be different. My doorbell cam can only do 2 at once.
+    * changed the logEvents() command to be showEvents() and it now shows the info in a window rather than just writing it to the log.
+    * changed logMotionRegions() showMotionRegions() which also shows the list in a separate window rather than just writing it to the log.
+    * showCapabilities() opens a window with most, but not all, of the capabilities of the camera listed. There are still some more to add
+    * There are a LOT of other things I can add to this plugin that could be controlled.  If you know of something else you’d like to be able to tweak in the cameras programmatically please let me know.
+  * **Last Activity:** A change to the Last Activity date handling. Previously if a Unit had never had any activity after being created it would show a last activity date of the time the program was last started. This caused confusion in list windows when sorted by date and is something I’ve been meaning to deal with forever. Now if a Unit has no last activity date it will display as “Never” in the list window, but be sorted as if the date had a total seconds property of 0. In other interfaces or via the scripting commands it will return a date with the earliest date/time that the normal unix date can hold so something like 1/7/1903 or whatever that is. So it will sort properly and no longer be confusing.
+  * **Home Kit:**
+    * Updated the Home Kit libraries some but not all the way to current. They have made some significant changes in the most recent builds that break it completely for us in the short term though I”ll keep working on that. This is unlikely to either cause or cure any problems people may be having with it as the only changes were to the handling of Thermostats. Home Kit now always sets the Mode of the HVAAC to Auto. This is not due to anything that I can do anything about easily and is a decision that Apple has made. I may be able to override some of this handling to not accept those changes from the thermostat but only send them from XTension or something like that if it is a problem.
+  * **Hue Plugin:**
+    * Hue Plugin: Fixed an issue where it could send continual updates for a sensor value even if the value had not changed.
+    * Hue Plugin: Fixed an issue where the temperature format was not saved, sticking all readings in F.
+  * **Video System:**
+    * Video Encoder Plugin: Added a checkbox so you can suppress logging of video encoding times if you wish.
+    * Video: Removed error logging for stalled streams as this would fill the log if the camera was offline for any length of time. To log this information please implement the stalled script handler in the Interface Script and write to the log whatever information is helpful.
+    * Video: “Orphaned” recordings that may have been left unencoded when the app quit are now properly encoded and managed when you next startup the app.
+  * **Sysinfo Plugin:**
+    * System Info Plugin: no longer claims in it’s startup log message to be the Disk Space plugin.
+    * Fixed an incorrect default link to the boot volume so that this will work without having to edit it each time.
+  * **Internal Python:**
+    * Python: A symlink to the built in python3 version is now added to /usr/local/bin/pythonxt so if you wish to use the built in version for your own script you can just execute it via that command.
+    * Python: XTension changes many environment variables in order to use it’s internal version of python. If you are running a system version of python in your own script from a shell in XTension this may cause errors or make it unable to find installed modules. You can now use a scripting command “revertENV()” in your script before invoking your shell script to reset the environment to the system default just before launching it which will solve most, but probably not all of these issues. Note that you should do this immediately before starting any shell script as XTension will change it again as needed when launching plugins.
+  * **Web Remote:**
+    * Web Remote: New documentation of the hashing of web remote links to immediately go to a specific page or view. This can be useful if you are saving specific links as iOS shortcuts, or creating a Kiosk type application. This is not a new feature, but was never properly documented. [[webremote:kioskview|Kiosk View and Hash Linking Info]]
+    * Web Remote: Added several new scripting commands to control sessions in the web remote. This lets you programmatically change the view on a specific device to say, a video page or a View in response to motion or other event. Additionally you can script a popup alert or timed message in any color to display on all active sessions or only on specific ones. [[webremote:scripting|Scripting Web Remote]]
+    * Web Remote: Added support for a resource folder that will be served as regular files through the web remote built in web server. This way if custom controls or other features you are adding need to load a specific image or other support file they can do so if you put it in the resources directory inside your XTension Database. [[webremote:resourceserver|Resource Server]]
+    * Note that these changes have not been rolled into the mobile web remote plugin, only the desktop version.
+  * **Plugin API:**
+    * A new key for the info.json file that will allow a plugin to receive any scripting command the user issues. This simplifies some kinds of plugin tasks at the expense that users script will not know if the command succeeded or not, all commands will just be sent and forgot. This does not affect regular using the app, only plugin developers.
+    * Added the capability for plugins to display information in new text windows and to append to or change the display of one without opening a new window each time. This mostly affects plugin developers but I used it in the new and changed show info commands in the Amcrest API plugin above.
+    * All plugins now log their version number in the startup message from the information stored in their info.json file. This will keep them from always being wrong as I forget to update it in 2 places instead of just 1.
+  * **Hubitat Plugin:**
+    * Hubitat: Added entries to the “insert” toolbar menu for the central scene Held, and Released events to make it easier to script these without having to visit the wiki to look up the specifics.
+    * Hubitat: Added support for Energy and Usage units. If a device reports these values a Unit will be created for them.
+    * More updates and changes to the new handling of “string” data types.If there is a number at the beginning of the String value then that is parsed and sent to Xtension as the value for the Unit. The description is no longer changed to the raw value but rather a new Unit Property called "Raw Value" is added and kept updated to the full text of the string. If there is no number in the string, or if it just does not begin with a number, then the value of the Unit is set to 0 and the default label for the unit is set to the raw value string as well as the same unit property. No default label is set if there is a number at the beginning of the string so that user formatting and suffix will be honored normally
+    * Hubitat: Some devices from the Hubitat will now have more descriptive, or less long winded names when created by default. This will mostly effect the Thermostat units but some others can be made better with this too. This does not affect Units already created, and you can always manually edit the unit’s name once it’s created to be whatever you like in either case.
+    * Hubitat: The list of supported commands for each Unit is now saved to a [[dictionary:unitinformation:getunitproperty|Unit Property]] so  you can see all the commands the device supports directly. You may still have to discover what parameters are required, if any, but this will make it easier to do things to the Units via the [[https://www.machomeautomation.com/doku.php/supported_hardware/hubitat#sending_device_specific_commandsm|sendDeviceCommand()]]
+    * Hubitat: Push messages from the Hubitat that are sent when a software update is started, or when the device is about to reboot to install a software update will now just log that information rather than generate an “unknown push message” error in the log.
+  * **Software Defined Radio Plugin:** Fixed the incorrect wiki link in the interface and added a link to the github pages for more documentation if desired.
+  * **Scripting Dictionary:**
+    * NEW: the [[dictionary:unitinformation:enumeratedvalue|Enumerated Value]] verb now accepts an optional parameter “for” and will return the correct enumeration for the value that you pass or an error if the enumeration is out of range. This is especially useful in the ON script of a unit as you can now check the enumeration for the future value to see what it is going to be when the script is done running. The direct parameter of unit name is now also made optional and if you dont specify it then it will use the value for thisUnit making it easier to script these in a units on or off script. For example: **write log enumerated value for (future value)** would write the enumerated value for the new value being passed to the On script.
+    * NEW: The [[dictionary:unitinformation:changefuturevalue|change future value]] verb now also accepts enumerations just like the regular set value verbs so you can issue a change future value to “high” instead of just knowing what the numerical value is.
+  * **Xtension UI:**
+    * New: Each unit will get a new Unit Property called Created with the date the unit was created. You can add this to any List view by control clicking in the headers and selecting create custom column. Then you can sort lists by the date the Unit was created and not just the last activity date. For new Units this is set as they are created and then never changed. For existing Units the date is taken from the creation date of their folder within the database. This seems to work pretty well for most units most of the time, but there may be a date in the past where you restored a database or otherwise performed an action on it that would have reset those dates. This is still the best I can do but keep in mind that older Units may not show the date they were actually created, but the last time you zipped and moved the database or something like that.
+  * **XTdb:** XTdb “meta” units now set their “thisUnit” value properly when being updated so that you can filter the log by them like any other Unit.
+  * **Control By Web Plugin:**
+    * Added support for sending user/password info to devices that have this level of security turned on.
+    * Added a checkbox for “Automatically Create New Units In XTension” so that you can disable this after you have gotten the Units you desire and not have to keep the ones you are not using at this time.
+    * Added a checkbox for “Ignore VIN Values” the control by web devices all send their input voltage. This might be useful or it might just be a value that is constantly updated as the value shifts by a tenth of a volt causing extra load and log spam. You can check this to ignore those values and neither create a Unit to hold it nor send updates for it’s changing.
+    * I’ve added some checks and trimming of the unit names as they are being changed into addresses to try to fix some potential issues with creating units in XTension. This is not an issue I can duplicate so am just throwing stuff at the wall to see what happens.
-====9.4.28 Change Log:====
+-----
-  * NEW: The Return Of Alexa! This version has newer plugin versions that can get around the recent changes that Amazon added to their Alexa firmware. **There are several install requirements and configuration changes that are necessary before they will run.** Please have a look at the the [[supported_hardware:alexa|Original Alexa Plugin page]] and the new [[supported_hardware:alexasudo|Alexa Sudo page]]. The changes from Amazon make it impossible to run more than one instance of an Alexa plugin on the same machine and so I have also [[supported_hardware:alexapi|ported the code to the Raspberry pi]] so that you can run as many on those devices as necessary if you need to share more than the allowed 20 unit limit.
-  * NEW: The first pass at a Catalina capable RFX plugin for the newer RFX devices. This plugin is in alpha at the moment and incomplete. It does not try to transmit and does not yet support the lighting device types. It is limited to receiving the receive only sensors from Oregon and others. Please do not actually convert your existing plugin to this yet as things may change. Please do disable the current plugin and create a new one using the new plugin to test it. See if the devices you have are properly received and that new units are created in XTension. If you see any errors in the log when receiving them please forward those log entries to me. If you have other problems please also email me that. I will be adding support for the lighting and other transmit capable devices soon.
-  * NEW: Added the [[supported_hardware:serverevents|Server Events plugin]] for receiving unit updates or events from a standard HTTP Server Events Stream.
-  * Icons in the Select Unit Icon window are now always presented in alphabetical order.
-  * FIX: The [[supported_hardware:tplink|TP-Link plugin]] now better recovers from a connection error or a refused connection to devices that might refuse a connection once in a while due to their own internal issues or dropping temporarily off wifi. It is still a little chatty with error messages while this happens as I’m still collecting more info to fully understand why they sometimes refuse connections while everything appears to be working fine. I will reduce the logging in a future version.
-  * FIX: The xBee plugin will not get shutdown for failing to return pings on very quite networks. Previously if you didn’t receive or send at least some command every few minutes XTension would think the interface had hung up and would restart it.
-  * FIX: Fixed a problem that cause the master log window to not be restored if you had quit the program with a log filter set to an interface or plugin instance.
-  * FIX: Fixed a timing problem with the [[supported_hardware:databasesharing|Shared Databases]] new 2 way sharing of Unit Properties that could cause changes to bounce back and forth forever if you changed a unit property and then changed it again before the ack had bounced back to the originating server.
-  * FIX: Another issue with shared databases if you set a unit property from the on propertyChanged event those messages could also bounce back and forth forever. This is now properly supported.
-  * FIX: Fixed a problem in the [[supported_hardware:hue|Hue plugin]] that would cause many errors to be written to the log if a remote control device or keypad was not fully configured and was returning invalid button numbers.
-  * FIX: Fixed a problem in the [[supported_hardware:hue|Hue plugin]] that could cause it to stop receiving changes to lights made from other clients of the hue hub. The polling of both lights and sensors should be reliable now. Additionally the last beta version still had the problem with sensors not being reliably polled. This is fixed for the release version.
-  * FIX: In all plugin configuration and unit configuration windows and dialogs the tab order of controls will be correct, or at least sensible, regardless of the order they are created in within the plugin configuration files. Some of the plugin setup windows were actually tabbing backwards which has always driven me crazy but I’ve never gotten motivated to fix. If you see windows in XTension that still have incorrect or non-sensical tab order please let me know.
-  * FIX: Fixed a potential issue with sending emails that could cause timeouts to be logged instead of the email being sent.
-  * FIX: Fixed a minor issue where the transmitted packet count was not updated for a shared database connection.
-  * Added support for radio button groups in the plugin configuration windows.
-  * Added support for the barometer/temperature/humidity Oregon combo units to the Legacy RFX device plugin. The nomenclature for these is confusing and when I move all the existing RFX plugins to legacy status it will be more clear. Here I mean the currently supported plugin for the older RFX devices which was not able to receive these particular sensors.
-  * Changed the plugin interface for the current RFX plugin for the legacy RFX devices to not offer to receive the newer RFX device protocol. The two devices are now served by 2 separate plugin.
-  * Added the ability for a custom column in a unit list to also look into the lower level database of the unit for it’s value. You just need to use the actual database key rather than the name of a unit property. This will be of limited usefulness to the majority of you but has already come in handy for me in debugging things.
+NOTE: This disk image no longer includes the older legacy plugins that will not be updated for newer OS versions. If you still need to run the [[supported_hardware:cm19]], [[supported_hardware:cm15a]], [[supported_hardware:zwave]] or the various Smarthome X10 interfaces please download [[tech_notes:catalina|the legacy plugins package from here]] and install the ones you need via the “Install Plugin” menu item of the “Database” menu.
 =====Previous Releases=====
 {{indexmenu>:current#2|js#doku}}
-=== Older Versions ===
-[[beta|The Changelog and Download links for builds between 763 and version 9.1 can be found here]]