background image

56

Docklight V2.2 User Manual 07/2016                                                                                                                                             Copyright 2016 Flachmann und Heggelbacher GbR

Reference

On a half duplex line (e.g. 2 wire RS485), changes in data direction are difficult to detect.
Still, in most applications there will be a pause on the communication bus before a new
device starts sending. Use the 

Pause  detection... 

option to introduce additional time

stamps and make the pauses visible in your communication log.

Date/Time Format

Docklight offers time stamps with a resolution of up to 1/1000 seconds (1 millisecond).
For compatibility to earlier Docklight versions (V1.8 and smaller), 1/100 seconds is
available,  too. 

NOTE: The resulting time tagging accuracy can be considerably different, e.g. 10-20
milliseconds only. The actual accuracy depends on your serial communications
equipment, your PC configuration, the Docklight Display Settings (see above) and the
Docklight 

Expert Options

. See the section 

How to Obtain Best Timing Accuracy

 for

details.

Control Characters Shortcuts

Here you can define your own keyboard shortcuts for ASCII Control Characters (ASCII
code < 32), or for any character code > 126. Keyboard shortcuts can be used within the
following Docklight dialogs and functions

·

Dialog: Edit Send Sequence

·

Dialog: Edit Receive Sequence

·

Dialog: Find Sequence

·

Dialog: Send Sequence Parameter

·

Keyboard Console

For each character from decimal code 0 to 31 and from 127 to 255, you can define a
keyboard combination to insert this character into a sequence (

Shortcut

). You may also

define a letter which is used to display this control character when editing a sequence in
ASCII mode (

Editor

). 

Double click to change the value of a 

Shortcut

 or 

Editor

 field.

Predefined shortcuts are:

Ctrl+Enter

 for carriage return / <CR> / decimal code 13

Ctrl+Shift+Enter 

for line feed / <LF> / decimal code 10

8.11 Dialog: Customize HTML Output

This dialog allows you to change the appearance of the HTML log files, by modifying the
HTML template code that Docklight uses when generating the HTML log file data.

You need some basic understanding of HTML documents and CSS style attributes. We
recommend 

http://www.htmldog.com

 (English)  or 

http://www.selfhtml.org

 (German and

French) for a quick overview on these topics.

HTML Header Template

The HTML document header. Here you can change the font applied to the log file data,
using the following CSS style attributes:

CSS Style Attribute

Description and Example

Содержание Docklight V2.2

Страница 1: ...Docklight V2 2 User Manual 07 2016 Copyright 2016 Flachmann und Heggelbacher GbR...

Страница 2: ...Snapshot of the Communication 23 5 5 Logging and Analyzing a Test 23 5 6 Checking for Sequences With Random Characters Receive Sequence Wildcards 24 5 7 Saving and Loading Your Project Data 26 6 Work...

Страница 3: ...Settings Communication Filter 54 8 10 Dialog Options 55 8 11 Dialog Customize HTML Output 56 8 12 Dialog Expert Options 58 8 13 Keyboard Console 59 8 14 Checksum Specification 59 9 Support 62 9 1 Web...

Страница 4: ...MODBUS 79 11 10 Multidrop Bus MDB 80 11 11 Receive Sequence 80 11 12 RS232 80 11 13 RS422 81 11 14 RS485 81 11 15 Send Sequence 81 11 16 Sequence 82 11 17 Sequence Index 82 11 18 Serial Device Server...

Страница 5: ...Copyright...

Страница 6: ...to these trademarks Microsoft and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States and or other countries Disclaimer While every precaution has been...

Страница 7: ...Introduction...

Страница 8: ...ithin the RS232 data that indicates a problem condition Docklight manages a list of such data sequences for you and is able to perform user defined actions after detecting a sequence e g taking a snap...

Страница 9: ...ossibility of a hardware fault must be considered in most systems Imagine you have a device that sends an error message in the case of a hardware fault A second device should receive this error messag...

Страница 10: ...Additional requirements For RS232 testing or simulation Minimum one COM port available Two COM ports for monitoring communication between two serial devices For low latency monitoring using Docklight...

Страница 11: ...User Interface...

Страница 12: ...he small lock icon in the top left corner When unlocked the list can be changed by dragging a sequence to a new position with the left mouse button pressed 3 Receive Sequences Define edit and manage y...

Страница 13: ...by pasting it into the Receive Sequence window TIP Try the right mouse button to display a context menu for Cut Copy and Paste operations 3 3 Notepad The Docklight Notepad is a separate window for wr...

Страница 14: ...Features and Functions...

Страница 15: ...tamps Docklight is able to process serial data streams containing any ASCII code 0 255 decimal Since there are non printing control characters ASCII code 32 and different encodings for ASCII code 127...

Страница 16: ...tures and Functions Docklight supports the use of wildcards e g wildcard as a placeholder for one arbitrary character within Receive Sequences and Send Sequences See the sections sending commands with...

Страница 17: ...Working with Docklight...

Страница 18: ...te and all other COM Port Settings required 5 Confirm the settings and close the dialog by clicking the OK button C Defining the Send Sequences to be used You will probably test your serial device by...

Страница 19: ...light stops communications 4 Click the OK button to add the new sequence to the list Repeat steps 1 4 to define the other Receive Sequences you need to perform your test E Storing the project Before r...

Страница 20: ...Settings 2 Choose communication mode Send Receive 3 At Send Receive on comm channel set the COM Port where your serial device is connected 4 Set the baud rate and all other COM Port Settings required...

Страница 21: ...the communications flow All protocol information can be logged to a text file for further analysis See section Logging and analyzing a test TIP Using the notepad window F12 key menu Tools Show Notepa...

Страница 22: ...TAP1 is selected automatically 4 Set the baud rate and all other communication parameters for the protocol being used NOTE Make sure your PC s serial interfaces port works properly at the baud rate a...

Страница 23: ...haracteristic error sequence This could mean storing and analyzing several MB of data when you are actually just looking for a few bytes though if they appeared at all As an alternative you can use th...

Страница 24: ...the serial device consists of a fixed part e g temperature and a variable part which is the actual value e g 65F To detect all these responses correctly in the serial data stream you can define Receiv...

Страница 25: ...and the terminating CR character You can use the default control character shortcut Ctrl Enter to enter the CR ASCII code 13 The sequence is now t e m p e r a t u r e F r 5 Specify an Action to perfor...

Страница 26: ...n _B Same as _A but in Binary representation _A 1 4 Extended syntax Insert only the first 4 characters of this Receive Sequence start with Character No 1 sequence length 4 _H 3 1 Extended Syntax Inser...

Страница 27: ...is saved in a Docklight project file ptp file using the menu File Save Project or File Save Project As It is generally recommended to save your project before starting a test run NOTE Saving your pro...

Страница 28: ...Working with Docklight Advanced...

Страница 29: ...h parameters A Preparing the project Create a new Docklight project and set up all communication parameters B Defining the commands used 1 Create a new Send Sequence Enter a Name for the sequence 2 En...

Страница 30: ...es Docklight cannot control the amount of incoming data Since Docklight applies a number of formatting and conversion rules on the serial data only a limited number of bytes per seconds can be process...

Страница 31: ...iming inaccuracies can be introduced by The COM device s chipset e g the internal FIFO First In First Out data buffer The USB bus transfer for USB to Serial converters The serial device driver for Win...

Страница 32: ...message in the Sequence section For example here we use a very simple HEX message as our sequence 01 02 03 04 Use the context menu via right mouse button or F7 to create the wildcard NOTE See also th...

Страница 33: ...hanges B Running the test 6 Start communications and send some data telegrams to your Docklight application COM port The Communication Window output could look like this 15 02 2016 17 43 28 072 RX 01...

Страница 34: ...d DTR signals The example sequence now reads 084 101 115 116 4 Add the new RTS DTR state as a decimal parameter value see below In our example we need the DTR signal set to high We choose 002 as the p...

Страница 35: ...RX side The parity is switched back to the original Communication Settings after the Send Sequence has been completely transmitted NOTE The most useful parameters for this function character are the...

Страница 36: ...character CTS DSR DCD RI changes 4 Add the handshake state as a decimal parameter value see above In our example we want to detect when CTS is high while all other signals are low This means we need t...

Страница 37: ...ide a Receive Sequence to specify a minimum silent time where no further characters should be received This is useful for detecting pauses in the data stream that indicate the beginning end of a teleg...

Страница 38: ...Docklight s accuracy for delay timing is limited because it has no control over the UART s internal TX FiFo buffer The specified delay times for the delay function character are minimum values Measure...

Страница 39: ...using the right mouse button and choose Function character break signal The example sequence now reads T e s t 3 Click OK to confirm the changes 4 Send the test sequence using the Send button The TX l...

Страница 40: ...t cannot tell the exact position of the break signal within the data stream The break signal will sometimes show up earlier in the data stream but never later than the actual position To define a Rece...

Страница 41: ...Examples and Tutorials...

Страница 42: ...settings listed below This should work for most standard modems Communication Mode Send Receive COM Port Settings 9600 Baud No parity 8 Data Bits 1 Stop Bit Getting started Use the Windows Device Man...

Страница 43: ...all modems AT FCLASS Fax classes supported by the modem if any AT CLS Shows whether the modem supports the Rockwell voice command set ATI n Displays manufacturer s information for n 1 through 7 This...

Страница 44: ...25 44 268 RX o Pong Pong received 3 8 2009 16 25 44 271 TX o Ping 3 8 2009 16 25 44 286 RX o Ping Ping received 3 8 2009 16 25 44 289 TX o Pong 3 8 2009 16 25 44 303 RX o Pong Pong received 3 8 2009...

Страница 45: ...92 RX 02 04 02 27 10 E7 0C 5 29 2015 18 45 43 237 TX 03 04 00 00 00 01 30 28 5 29 2015 18 45 43 392 RX 03 04 02 00 00 C0 F0 5 29 2015 18 45 58 724 TX 04 04 00 00 00 01 31 9F 5 29 2015 18 45 58 870 RX...

Страница 46: ...Reference...

Страница 47: ...The representation may be chosen using the Options dialog window Print Communication Print the contents of the communication window The communication data is printed in the same representation that i...

Страница 48: ...ble the keyboard console to send keyboard input directly Keyboard Console Off Disable the keyboard console Show Notepad Show the notepad window Project Settings Select the current project settings com...

Страница 49: ...at contains both printing characters letters A z digits 0 9 and non printing control characters ASCII code 0 to 31 Predefined shortcuts are Ctrl Enter for carriage return CR decimal code 13 Ctrl Shift...

Страница 50: ...ing values e g measurement or status values See section Checking for sequences with random characters for details and examples Control Character Shortcuts Using keyboard shortcuts is a great help when...

Страница 51: ...ow The Find Sequence function searches the contents of the communication window The search is performed in the communication window tab that is currently selected ASCII HEX Decimal or Binary You may h...

Страница 52: ...1 the data from device 2 is Channel 2 Communication Channels Serial COM ports or Docklight TAP VTP A communication channel can be configured as Serial COM port RS232 RS422 or RS485 TAP port for Dockli...

Страница 53: ...require any of the RS232 communication parameters In some cases such COM port drivers even return an error when trying to set the RS232 parameters so Docklight would fail to open the COM channel Use...

Страница 54: ...Some RS232 to RS485 converters require manual RTS control i e the RS232 device PC tells the converter when it should enable its RS485 driver for transmission If you choose RS485 Transceiver Control t...

Страница 55: ...g ASCII text as well as non printing control characters it is sometimes helpful to see the names of the occurring control characters in the ASCII mode display window Docklight provides an optional dis...

Страница 56: ...acter code 126 Keyboard shortcuts can be used within the following Docklight dialogs and functions Dialog Edit Send Sequence Dialog Edit Receive Sequence Dialog Find Sequence Dialog Send Sequence Para...

Страница 57: ...utes e g font family sans serif font size small NOTE Docklight will insert additional u underline i italic and b bold HTML tags if such formatting options are activated in the Display Settings You do...

Страница 58: ...as an Administrator Otherwise the data collection process will run with the maximum permitted priority but not Realtime class External High Priority Process mode must be used with care especially when...

Страница 59: ...as CR ASCII 13 plus LF ASCII 10 The ESC key sends ESC ASCII 27 Use control character shortcuts to send other ASCII control characters 8 14 Checksum Specification Checksum specifications are used in E...

Страница 60: ...are a lot of CRC variations and algorithms around and choosing not to mention understanding the right CRC flavor can be a rather difficult job A good way to make sure your CRC calculation makes sense...

Страница 61: ...of the sequence and not relative to the start of the sequence Examples startPos is 4 start calculating at the 4th character from the end len is 1 use everything until the end of the sequence targetPos...

Страница 62: ...Support...

Страница 63: ...eshooting information see our online support pages available at http www docklight de support 9 2 E Mail Support We provide individual e mail support to our registered customers Please include your Do...

Страница 64: ...Appendix...

Страница 65: ...d 13 0D CR Carriage return 14 0E SO Shift out 15 0F SI Shift in XON resume output 16 10 DLE Data link escape 17 11 DC1 XON Device control character 1 18 12 DC2 Device control character 2 19 13 DC3 XOF...

Страница 66: ...6 6 Six 55 37 7 Seven 56 38 8 Eight 57 39 9 Nine 58 3A 59 3B 60 3C 61 3D 62 3E 63 3F 64 40 65 41 A A 66 42 B B 67 43 C C 68 44 D D 69 45 E E 70 46 F F 71 47 G G 72 48 H H 73 49 I I 74 4A J J 75 4B K K...

Страница 67: ...15 73 s s 116 74 t t 117 75 u u 118 76 v v 119 77 w w 120 78 x x 121 79 y y 122 7A z z 123 7B 124 7C 125 7D 126 7E Tilde 127 7F DEL Delete 10 2 Hot Keys General Hot Keys Applies to Communication windo...

Страница 68: ...unction Hot Key Find a Sequence Ctrl F Clear All Communication Windows Ctrl W Toggle Between ASCII HEX Decimal and Binary Representation Ctrl Tab Send Sequences Receive Sequences List Function Hot Key...

Страница 69: ...cription DTE in out 1 DCD Data Carrier Detect Input 2 RX Receive Data Input 3 TX Transmit Data Output 4 DTR Data Terminal Ready Output 5 SGND Signal Ground 6 DSR Data Set Ready Input 7 RTS Request To...

Страница 70: ...o Signal Name Description 1 DSR RI Data Set Ready Ring Indicator 2 DCD Data Carrier Detect 3 DTR Data Terminal Ready 4 SGND Signal Ground 5 RX Receive Data 6 TX Transmit Data 7 CTS Clear To Send 8 RTS...

Страница 71: ...l modem cable but with SUB D9 male connectors on both ends DCE DCE hardware flow control null modem cable with partial handshaking but with SUB D9 male connectors on both ends SUB D9 Simple Straight C...

Страница 72: ...6 Copyright 2016 Flachmann und Heggelbacher GbR Appendix SUB D9 Null Modem Cable with Full Handshaking Area of Application DTE DTE Communication with DTE DCE compatible hardware flow control Works als...

Страница 73: ...re details see our product overview pages and the Docklight Monitoring Cable datasheet NOTE Our Docklight Tap or Tap Pro Tap RS485 data taps offer superior monitoring characteristics and do not requir...

Страница 74: ...mmunications between two devices Docklight has built in support for the Docklight Tap It recognizes the dual port USB serial converter and offers high speed low latency access to the monitoring data U...

Страница 75: ...for the USB port They are supported by Docklight in a similar way as the Docklight Tap Docklight has built in support for Tap Pro and Tap 485 Use Docklight Monitoring Mode and Receive Channel settings...

Страница 76: ...76 Docklight V2 2 User Manual 07 2016 Copyright 2016 Flachmann und Heggelbacher GbR Appendix...

Страница 77: ...Glossary Terms Used...

Страница 78: ...bset of the 256 possible 8 bit characters will be used but the characters will still be stored and processed using an 8 bit format 11 4 CRC Cyclic Redundancy Code A CRC is a method to detect whether a...

Страница 79: ...busy or for some reason cannot further communicate The DTE and DCE must agree on the flow control mechanism used for a communication session There are two types of flow control hardware and software...

Страница 80: ...2 a character sequence e g 6F 6B 13 10 in HEX format 3 an action that is triggered when Docklight receives the defined sequence 11 12 RS232 The RS232 standard is defined by the EIA TIA Electronic Indu...

Страница 81: ...erence to signal ground 7V to 7V 11 14 RS485 The RS485 standard defines a balanced two wire transmission line which may be shared as a bus line by up to 32 driver receiver pairs Many characteristics o...

Страница 82: ...ive Sequence List The Sequence Index is displayed in the upper left corner of the Edit Send Sequence or Edit Receive Sequence dialog 11 18 Serial Device Server A Serial Device Server is a network devi...

Страница 83: ...sion using a predefined baud rate Any data packet sent on the first COM port will appear in the second COM port s receive buffer almost immediately For most debugging and simulation purposes this limi...

Отзывы: