Saved new screenshots for help file, modified some help files to reflect current version of the program.

This commit is contained in:
Collin Kidder
2017-11-26 16:47:21 -05:00
parent 8cbea00c4c
commit 0ce41ecac1
30 changed files with 55 additions and 34 deletions
+36
View File
@@ -0,0 +1,36 @@
Connection Window
=============================
**Connection Management Window**
.. image:: ./images/ConnectionWindow.png
The connection window is used to add, remove, and modify connections. At the moment it is possible to use any SocketCAN compatible device (in LINUX) and any GVRET compatible device in any of the supported operating systems.
At this time GVRET compatible devices are: EVTVDue, EVTV CANDue (1.3/2/2.1/2.2), Teensy 3.1-3.6, Macchina M2.
Connecting To A Dongle
=============================
SavvyCAN is able to connect to GVRET compatible devices to capture new traffic. These devices will present as serial ports on the connected PC.
To connect to a dongle select the proper serial port and click "Create New Connection". If a valid device is found on that serial port the first
statusbar section will update and the currently set canbus speeds will show in the table at the left of the window. These speeds can then
be changed by clicking on the speed (or otherwise selecting the cell in the table) and typing in a new value. Leaving the cell will update the speed to the new value. GVRET devices also support
setting "listen only" on each bus. This mode causes the device to not acknowledge any traffic or try to modify the bus at all. It is as it says, a mode where you can only listen to whatever traffic
is found on the bus. Some older GVRET devices supported a mode where you could change the second bus between single wire CAN and normal CAN. This is deprecated. However, newer GVRET devices have
dedicated single wire CAN buses and the relevant bus will show the checkbox.
SavvyCAN can also connect to SocketCAN devices in LINUX. Select "SocketCAN" as the connection type and then type in the device name. This should be just the same as you would provide to the can-utils
programs. That is, do not enter /dev/can0 but rather can0. Then push "Create New Connection" and you should see the new connection in the table on the left of the window. Note that SocketCAN devices don't
support changing the baud rate within a program. You must do this when you set up the connection via console commands. This is outside the scope of this documentation. Consult the SocketCAN documentation
for details on configuring such devices.
Debugging Connection Problems
=============================
GVRET devices present as serial ports and have significant configuration options. However, the ability to configure so many things and the ability to compile the firmware yourself both come as a
double edged sword. They present many opportunities for things to go wrong. Because of this there is a debugging console present on the connection window. Click a bus in the table then click "Enable Console"
to cause it to start logging serial traffic. From this console you can see what is going on. It shows what SavvyCAN is sending and what it is getting back. It has extended status messages that might help to narrow down
what is going wrong. Additionally, if you're feeling adventurous you can send traffic to the serial device from the Send line. "Send Hex" accepts a set of hex values separated by spaces. "Send Text" will send the raw
text you type on the line. GVRET traffic is ordinarily binary so "Send Text" won't work very well for that. But, there is also a text console possible on GVRET devices. If you connect to them with a serial program you can
configure things via a text console. Type ? and follow it up with some form of line ending (Cr, Lf, CrLf, any will work).
-4
View File
@@ -1,4 +0,0 @@
Firmware Uploader Window
========================
Uploading new firmware to CANBus connected devices
Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 134 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 70 KiB

After

Width:  |  Height:  |  Size: 159 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 136 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 95 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

+19 -30
View File
@@ -6,8 +6,7 @@ Main / Start Up Screen
.. image:: ./images/MainScreen.png .. image:: ./images/MainScreen.png
This screen embodies the core of the program. Here you will find the master list of all frames. Also, here you can navigate to the other aspects This screen embodies the core of the program. Here you will find the master list of all frames. Also, here you can navigate to the other aspects
of the program. You can have multiple sub-windows open at once - in fact, quite often this is very beneficial. This screen is also used to of the program. You can have multiple sub-windows open at once - in fact, quite often this is very beneficial.
connect to a GVRET compatible device. But, one thing at a time.
The Main Frame List The Main Frame List
@@ -17,10 +16,11 @@ The main frame list takes up the majority of the main screen. This list consists
- Timestamp: The timestamp is either in microseconds or seconds. This is a setting in preferences. Either way, the timestamp can have - Timestamp: The timestamp is either in microseconds or seconds. This is a setting in preferences. Either way, the timestamp can have
microsecond resolution. The difference is just whether there is a decimal point or not. GVRET has the ability to maintain full microsecond microsecond resolution. The difference is just whether there is a decimal point or not. GVRET has the ability to maintain full microsecond
resolution for timestamping purposes. resolution for timestamping purposes. There is a third timing mode where the timestamp can be customized and is based upon the actual "clock" time.
- ID: The ID is specified either in hexadecimal or decimal (a preference you can set). This is the message identifier sent over the CAN bus. - ID: The ID is specified either in hexadecimal or decimal (a preference you can set). This is the message identifier sent over the CAN bus.
- Ext: 0 = Standard message (11 bit ID). 1 = Extended message (29 bit ID) - Ext: 0 = Standard message (11 bit ID). 1 = Extended message (29 bit ID)
- Bus: SavvyCAN was meant for use with GVRET compatible capture devices. GVRET supports two buses labeled 0 and 1. The bus a frame came in on - Dir: Either "Rx" or "Tx" to show whether SavvyCAN has received or sent this message.
- Bus: SavvyCAN supports a variety of capture hardware. GVRET compatible devices can support more than one bus. The bus a frame came in on
is specified here. Many file formats do not specify bus and thus all frames will be loaded as bus 0. is specified here. Many file formats do not specify bus and thus all frames will be loaded as bus 0.
- Len: The number of data bytes that were sent with this frame. It can range from 0 to 8. - Len: The number of data bytes that were sent with this frame. It can range from 0 to 8.
- Data: All of the data bytes separated by spaces. Can be in either hexadecimal or decimal (preference). If "Interpet Frames" is checked you will - Data: All of the data bytes separated by spaces. Can be in either hexadecimal or decimal (preference). If "Interpet Frames" is checked you will
@@ -31,28 +31,16 @@ The main frame list takes up the majority of the main screen. This list consists
The Bottom Statusbar The Bottom Statusbar
==================== ====================
At the very bottom of the main screen is a status bar with three sections. At the very bottom of the main screen is a status bar with two sections.
* The first section shows the connection status. If you are connected to a GVRET compatible dongle you will see the * The first section shows the connection status. You will see the number of currently connected buses here.
version of the connected device here.
* The second second section shows which file is currently loaded. This is updated by loading or saving. * The second second section shows which file is currently loaded. This is updated by loading or saving.
* The third section shows whether a DBC file is currently loaded and which one. DBC files are used to interpret messages.
Connecting To A Dongle
======================
SavvyCAN is able to connect to GVRET compatible devices to capture new traffic. These devices will present as serial ports on the connected PC.
To connect to a dongle select the proper serial port and click "Connect to GVRET". If a valid device is found on that serial port the first
statusbar section will update and the currently set canbus speeds will show in the drop down lists below the button. These speeds can then
be changed. Changes to canbus speed will only take effect when you click "Set CANBUS Speeds". The program will let you know if the connection
was not successful.
The Rest of the Main Window The Rest of the Main Window
=========================== ===========================
Below the dongle configuration is an area that shows the total number of captured frames and the frames per second. Total frames might not match To the right of the main frames list is an area that shows the total number of captured frames and the frames per second. Total frames might not match
the number of shown frames. If you've deselected any IDs in the filter list then fewer frames will be shown. Frames per second is calculated as the number of shown frames. If you've deselected any IDs in the filter list then fewer frames will be shown. Frames per second is calculated as
an average and so will wind up or down when there is a sudden change. an average and so will wind up or down when there is a sudden change.
@@ -75,25 +63,27 @@ this off for performance reasons (interpreting takes some extra processor power
The "Overwrite Mode" checkbox is used to ensure that only the newest frame for each message ID is shown. That is, if 100 messages with ID 0x105 come in you The "Overwrite Mode" checkbox is used to ensure that only the newest frame for each message ID is shown. That is, if 100 messages with ID 0x105 come in you
will see only the newest one. This is generally used along side "Interpret Frames" to interpret frames and always see the up-to-date information. will see only the newest one. This is generally used along side "Interpret Frames" to interpret frames and always see the up-to-date information.
"Frame Filtering" provides a list of all the frame IDs seen so far. Any ID which is checked will be shown in the main list. Any ID which is unchecked will not.
This can be used to hone in on frames of importance while hiding frames that are currently of no interest. The filtered list can be saved as well.
Loading And Saving Frames Loading And Saving Frames
========================= =========================
What CANBus analysis tool would be complete without an easy way to load and save frames? What CANBus analysis tool would be complete without an easy way to load and save frames?
SavvyCAN can load and save in several formats: SavvyCAN can load and save in several formats (a few of which are listed below):
- CRTD: This format was made by Mark Webb-Johnson for OVMS (open vehicle monitoring system) and other related tools. It is a reasonably - CRTD: This format was made by Mark Webb-Johnson for OVMS (open vehicle monitoring system) and other related tools. It is a reasonably
readable and compact format. GVRET defaults to saving in this format. One reason one might not want to use CRTD is if knowing which bus readable and compact format. One reason one might not want to use CRTD is if knowing which bus a frame originated on is important. CRTD does not save that information.
a frame originated on is important. CRTD does not save that information. - GVRET: This is the native format for GVRET and SavvyCAN. The GVRET format saves more information such as the bus a frame originated on. This format is in CSV
- GVRET: This is the native format for GVRET and SavvyCAN. One might then ask why CRTD is the default. Well, for compatibility with
OVMS tools. Otherwise, the GVRET format saves more information such as the bus a frame originated on. This format is in CSV
(comma delimited) format and as such can easily be loaded into your favorite spreadsheet program as well. (comma delimited) format and as such can easily be loaded into your favorite spreadsheet program as well.
- Generic ID/DATA - Another CSV format. This is a very cut down format with limited information. - Generic ID/DATA - Another CSV format. This is a very cut down format with limited information.
- BusMaster - This is the format output by the BusMaster CANBus program. BusMaster is an open source Windows-only somewhat clone - BusMaster - This is the format output by the BusMaster CANBus program. BusMaster is an open source Windows-only somewhat clone
of CANAlyzer (the 800lb gorilla in the analysis space). The ability to load and save in this format makes SavvyCAN fully capable of CANAlyzer (the 800lb gorilla in the analysis space). The ability to load and save in this format makes SavvyCAN fully capable
of swapping data with BusMaster should you need to do so. of swapping data with BusMaster should you need to do so.
- Microchip - Format output by Microchip CANBus tools. Perhaps you have logs that were - Microchip - Format output by Microchip CANBus tools. Perhaps you have logs that were captured with a $100 Microchip dongle? You can load them in SavvyCAN.
captured with a $100 Microchip dongle? You can load them in SavvyCAN.
There are many other formats supported. Some are only supported for writing, some only for reading. The list of supported formats is expanded every so often.
Filters Filters
@@ -126,7 +116,6 @@ to figure out the actual details of that signal.
How DBC interacts with the main screen: How DBC interacts with the main screen:
======================================= =======================================
First of all, one can load and save DBC files from the File menu. Also, one can edit the currently loaded DBC file (or start working on First of all, one can load and save DBC files from the "DBC File Manager" found in the File menu. Also in the File menu it is possible to save the currently
one if one is not loaded). It is also possible to save the currently loaded frames but with DBC decoding. This is somewhat like the normal loaded frames but with DBC decoding. This is somewhat like the normal saving functionality with a two differences: there is only one output format
saving functionality with a two differences: there is only one output format and that format has all signals contained in each message listed and that format has all signals contained in each message listed and decoded.
and decoded.