Update documentation to match the new features.

2019-02-20 21:51:31 -05:00
parent b54777d1aa
commit b4b87afee3
6 changed files with 17 additions and 4 deletions
@@ -1,4 +1,4 @@
 make qthelp
-~/Qt/5.11.2/gcc_64/bin/qcollectiongenerator build/qthelp/SavvyCAN.qhcp
-~/Qt/5.11.2/gcc_64/bin/assistant -collectionFile build/qthelp/SavvyCAN.qhc
+~/Qt/5.12.1/gcc_64/bin/qcollectiongenerator build/qthelp/SavvyCAN.qhcp
+~/Qt/5.12.1/gcc_64/bin/assistant -collectionFile build/qthelp/SavvyCAN.qhc

@@ -8,4 +8,12 @@ Frame Details Window
 The Purpose of Frame Details Window
 ===================================

-This window is used to get detailed statistics about frames. It provides information about a given frame ID across all frames with that ID. You can get such information as the number of frames, the number of data bytes that frame ID has, the average interval between frames with that ID, and the minimum and maximum interval. Also listed are detailed statistics for each data byte in that frame. Each byte has listed which bits changed, the range of values found, and a histogram both graphically (at the bottom of the window) and textually. The textual representation shows the number of times a specific value occurred. Also listed at the bottom is a histogram of each bit and how many times it was set. The graph is a histogram of all the bits and the number of times each bit was set. This can be used to quickly visually see where data has changed. All information can be saved to a text file for later analysis.
+This window is used to get detailed statistics about frames. 
+
+It provides information about a given frame ID across all frames with that ID. You can get such information as the number of frames, the number of data bytes that frame ID has, the average interval between frames with that ID, and the minimum and maximum interval. 
+
+Also listed are detailed statistics for each data byte in that frame. Each byte has listed which bits changed, the range of values found, and a histogram both graphically (at the righthand side of the window) and textually. The textual representation shows the number of times a specific value occurred. 
+
+The top right graph is a histogram of all the bits and the number of times each bit was set. This can be used to quickly visually see where data has changed. 
+
+The bottom right graph is of each individual byte as its value varies over time. All textual information can be saved to a text file for later analysis.
@@ -34,7 +34,7 @@ reset and thus all changes will be colored once again.
 Advanced Options
 ==================

-All of the above was valid if you do not check any of the three checkboxes. With the checkboxes
+All of the above was valid if you do not check any of the four checkboxes. With the checkboxes
 unchecked this window is very close to cansniffer on the command line. But, what fun is that?
 These checkboxes modify the way the window works in a variety of ways.

@@ -64,3 +64,8 @@ This can be used with mute or without but has a similar purpose. When this is ch
 that haven't updated recently will begin to fade away to white. They never quite get all the way
 to disappearing but will fade to be very light. In this way only data which is actively changing will
 be very visible. This drastically aids in helping you to ignore any bytes that are not changing.
+
+View Bits
+==========
+
+This option changes the view very starkly. This is the view shown in the picture associated with this topic. When View Bits is selected the display will change to show each bit within the bytes as separate blocks that each can separately be black when set and unchanged, white when unset and unchanged, red when freshly unset, and green when freshly set. This allows for a very fine grained view. Fade inactive, and never expire still work as usual. This mode might be a bit "busy" and lowers the number of IDs you can see at once. But, the choice is yours. You give up some density in exchange for verbosity.