diff --git a/CHANGELOG.md b/CHANGELOG.md index bf6ef192..218c00fd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,14 +1,61 @@ # Changelog +## Version 2018.1.9.1 + +### Known Issues + +* A capture that starts in the middle of message fragmentation may result in a + series of packets being incorrectly interpreted and possibly marked as invalid. + To workaround this, the user can place a marker past this fragmentation and + instruct the plugin to start analysis after this point. +* Due to a bug in the Saleae Logic software, the decoded results that indicate + the packet ID may occasionally display an invalid value of 0xFFFFFFFFFFFFFFFF + instead of the packet's actual ID. +* Settings window's "Advanced Settings" option is suppose to have a browse + filesystem button. Saleae has acknowledged that this interface was never + fully developed and should be resolved in a future release. +* Error markers are not given display priority. This is a limitation of the + Logic software itself. + +### Changes + +* Switched plugin's versioning to year.month.day.build notation +* Updated lookup tables to include latest ABP headers including new support for + OPCUA, PNAM, EME, etc. +* Added advanced settings XML-file option. This file contains additional options + that may be useful in special cases. Currently, two options are available: + "4-wire-on-3-channels" and "3-wire-on-4-channels". "4-wire-on-3-channels" can + be useful when limited on logic analyzer channels and would like to omit the + SPI enable (chip/slave select) signal and use that channel for some other purpose. + This provides added flexibility over normal 3-wire analysis since it will ignore + timing requirements and permit "clock-idle-low" configurations (which the + ABCC does not support in 3-wire mode and consequently this analyzer). + "3-wire-on-4-channels" is useful when there is an extra channel on the analyzer + that could be used to gain the analyzer "markers" that are normally drawn on the + SPI enable channel. Using this mode will continue to treat the SPI channels in + 3-wire mode and enforcing timing requirements and clock-idle-high configuration. +* Added network specific instance names (i.e. Network configuration object instances) +* Changed decoded result's command extension, source ID, and instance to always + use a combined decimal and hex notation (when no name is found) for consistency. +* Other minor changes + +### Fixes + +* Last packet in capture may be missing a frame that will result in an + uncommitted packet. This means that when exporting messages to a CSV, the last + packet may be lost. +* Resolved various cases where the plugin would crash the software. + ## Revision 1.0.0.0 (RC1) ### Known Issues * Last packet in capture may be missing a frame that will result in an - uncomitted packet. This means that when exporting messages to a CSV, the last + uncommitted packet. This means that when exporting messages to a CSV, the last packet may be lost. * A message's Source ID and Instance tabular text entries do not respect display - format settings. + format settings while command extension does. A change should be made to improve + consistency. * Opening multiple saved captures will often lead to the currently opened Logic windows to crash. * Assigning severely misbehaving logic signals to the analyzer plugin may result diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 00000000..56e0909a --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,41 @@ +# Licenses + +## Copyright © 2015-2018 HMS Industrial Networks, Inc. + +THE CODE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. HMS DOES NOT +WARRANT THAT THE FUNCTIONS OF THE CODE WILL MEET YOUR REQUIREMENTS, OR +THAT THE OPERATION OF THE CODE WILL BE UNINTERRUPTED OR ERROR-FREE, OR +THAT DEFECTS IN IT CAN BE CORRECTED. + +## Third-Party Licenses + +This software uses the following 3rd Party software/licenses listed below. +A copy of this file should be provided in each release of this software DLL. + +### RapidXml (Version: 1.13) License + - Website: http://rapidxml.sourceforge.net/ + +``` +The MIT License +=============================================================================== + +Copyright (c) 2006, 2007 Marcin Kalicinski + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL +THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +IN THE SOFTWARE. +``` diff --git a/README.md b/README.md index e12be765..5e8b068a 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ THAT DEFECTS IN IT CAN BE CORRECTED. * [OS X](#os-x) 4. [Documentation](#documentation) 5. [Changelog](#changelog) +6. [Licenses](#licenses) --- @@ -101,5 +102,9 @@ For complete details regarding this plugin's functionality please consult the ## [Changelog](#table-of-contents) -Please see [CHANGELOG.md](CHANGELOG.md) provided within this repository for details on the -changelog history. +Please see [CHANGELOG.md](CHANGELOG.md) provided within this repository for details on the changelog history. + +## [Licenses](#table-of-contents) + +Please see [LICENSE.md](LICENSE.md) provided within this repository for details on the software licensing. + diff --git a/doc/AbccSpiAnalyzer_Plugin_QSG.pdf b/doc/AbccSpiAnalyzer_Plugin_QSG.pdf index c1517eb9..c6fd1f22 100644 Binary files a/doc/AbccSpiAnalyzer_Plugin_QSG.pdf and b/doc/AbccSpiAnalyzer_Plugin_QSG.pdf differ diff --git a/project/vs2012/AbccSpiAnalyzer.rc b/project/vs2012/AbccSpiAnalyzer.rc index d2be2709..a18c16bc 100644 Binary files a/project/vs2012/AbccSpiAnalyzer.rc and b/project/vs2012/AbccSpiAnalyzer.rc differ diff --git a/project/vs2015/AbccSpiAnalyzer.rc b/project/vs2015/AbccSpiAnalyzer.rc index d2be2709..a18c16bc 100644 Binary files a/project/vs2015/AbccSpiAnalyzer.rc and b/project/vs2015/AbccSpiAnalyzer.rc differ diff --git a/project/vs2017/AbccSpiAnalyzer.rc b/project/vs2017/AbccSpiAnalyzer.rc index e86ee967..2e0cac78 100644 Binary files a/project/vs2017/AbccSpiAnalyzer.rc and b/project/vs2017/AbccSpiAnalyzer.rc differ