1. Manuals
  2. Brands
  3. Flachmann und Heggelbacher Manuals
  4. Docking Station
  5. Docklight V2.2
  6. User manual

Flachmann und Heggelbacher Docklight V2.2 User Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

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

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the Docklight V2.2 and is the answer not in the manual?

Questions and answers

Summary of Contents for Flachmann und Heggelbacher Docklight V2.2

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

  • Page 2: Table Of Contents

    Testing a Modem - Sample Project: ModemDiagnostics.ptp ........42 Reacting to a Receive Sequence - Sample Project: PingPong.ptp ......43 MODBUS RTU With CRC checksum - Sample Project: ModbusRtuCrc.ptp ....44 Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 3: Table Of Contents

    11.2 Break ..........................78 11.3 Character ........................78 11.4 CRC ..........................78 11.5 DCE ..........................79 11.6 DTE ..........................79 11.7 Flow Control ......................... 79 11.8 LIN ..........................79 Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 4 11.18 Serial Device Server ..................... 82 11.19 Snapshot ........................82 11.20 Trigger ........................... 82 11.21 UART ..........................83 11.22 Virtual Null Modem ..................... 83 11.23 Wildcard ........................83 Index Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 5: Copyright

    Copyright...
  • Page 6 Copyright Copyright Copyright 2016 Flachmann und Heggelbacher GbR All rights reserved. No parts of this work may be reproduced in any form or by any means - graphic, electronic, or mechanical, including photocopying, recording, taping, or information storage and retrieval systems - without the written permission of the publisher.

  • Page 7: Introduction

    Introduction...

  • Page 8: Docklight - Overview

    This manual only refers to RS232 serial connections in detail, since this is the basis for other serial connections mentioned above. TIP: For getting started, have a look at the Docklight sample projects, which demonstrate some of the basic Docklight functions. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 9: Typical Applications

    Detect faulty communication sequences or special error conditions within the monitored communication. Take a snapshot of the communication when such an error condition has occurred. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 10: System Requirements

    Additional cables or software drivers may be required for connecting the equipment to be tested. See the sections on Docklight Tap, Docklight Monitoring Cable RS232 SUB Standard RS232 Cables virtual null modem drivers. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 11 User Interface...

  • Page 12: User Interface Main Window

    You may also search for specific sequences using the Find Sequence function. See Serial Data is Processed and Displayed for more information. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 13: Clipboard - Cut, Copy & Paste

    NOTE: Closing the notepad window does not delete your notes. They will be still available when you press F12 again. To remove all notes, empty the text box using Ctrl +A (Select All) and the DEL key. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 14 Features and Functions...

  • Page 15: Features And Functions How Serial Data Is Processed And Displayed

    3. when creating a new sequence by double-clicking on the blank field at the end of a list (or pressing Ctrl + E). 4. when pasting a new sequence into the sequence list. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 16 (e.g. wildcard "?" as a placeholder for one arbitrary character) within Receive Sequences and Send Sequences. See the sections sending commands with parameters checking for sequences with random characters for details and examples. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 17: Working With Docklight

    Working with Docklight...

  • Page 18: Testing A Serial Device Or A Protocol Implementation

    After clicking the OK button the new sequence will be added to the Send Sequence lists. Repeat steps 1 - 4 to define the other Send Sequences needed to perform your test. D) Defining the Receive Sequences used Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 19: Simulating A Serial Device

    (F12 key / menu Tools > Show Notepad), you can easily take additional notes, or copy & paste parts of the communication log for further documentation. Simulating a Serial Device Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 20 "status cmd - answer ok", "status cmd - answer battery failure", "status cmd - answer mains failure") and assign different Send Sequences as an action. In the example, you Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 21: Monitoring Serial Communications Between Two Devices

    USB drivers (FTDI drivers), as available on our Docklight Download page. · Device 1 and Device 2 must be ready to operate. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 22 Before running the actual test, it is recommended to store the communication settings and sequences defined. This is done using the menu File > Save Project. E) Running the test Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 23: Catching A Specific Sequence And Taking A Snapshot Of The Communication

    Docklight will then stop communication and position the cursor at the trigger sequence. Logging and Analyzing a Test Preconditions · Docklight is ready to run a test as described in the previous use cases, e.g. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 24: Checking For Sequences With Random Characters (Receive Sequence Wildcards)

    CRCs. There are no wildcards required for checksum areas, instead use some default character values, e.g. "00 00" in HEX representation. Preconditions Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 25 Edit Receive Sequence > 3 - Action > Comment text box, to create Docklight comment texts with dynamic data, e.g. the actual data received. Macro Is Replaced By Line break Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 26: Saving And Loading Your Project Data

    New Temp = 85 °F 10/30/2012 10:24:12.087 [RX] - temperature=93F<CR> New Temp = 93 °F Saving and Loading Your Project Data The project data includes: · Send Sequences Receive Sequences · Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 27 If you want to save a log of the communication during a test run, see section logging and analyzing a test. Loading a project is done using the File > Open Project... menu. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 28: Working With Docklight (Advanced)

    Working with Docklight (Advanced)

  • Page 29: Sending Commands With Parameters (Send Sequence Wildcards)

    63), the wildcard is shown on a different background color within the sequence editor. C) Sending a command to the serial device Use the Send button to open the serial communication port and send one command to the serial device. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 30: How To Increase The Processing Speed And Avoid "Input Buffer Overflow" Messages

    - If you are using ASCII mode, disable the Control Characters Description option Log the communication data to a plain text file instead of using the communication window(s): - Use the "plain text" Log File Format Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 31: How To Obtain Best Timing Accuracy

    Administrator. Please make sure you understood the remarks and warning in the documentation. Calculating and Validating Checksums Many communication protocols include additional checksum fields to ensure data integrity and detect transmission errors. A common algorithm is the (Cyclic Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 32 00 placeholder is overwritten with the checksum result. If we use 05 as a parameter when sending the sequence, the data sent by Docklight will look like this: Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 33: Controlling And Monitoring Rs232 Handshake Signals

    The following section describes how to use the Function Character '!' (F11 key) to change the RTS and DTR signals temporarily within a Send Sequence, or detect changes for the CTS, DSR, DCD or RI lines using a Receive Sequence. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 34 However, in the above example the DTR is set and reset very quickly, so the DTR indicator will probably not give any visual feedback. If you want to actually "see" the DTR behavior, try introducing a small inter-character delay. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 35 Using the function character '!' you can make these changes visible, and/or define an action after detecting such changes. The function character '!' supports the following parameter values for this purpose: Character Value Handshake Signal (Decimal Mode) Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 36 See below for examples. ^ | 0F | 05 Is a match, when for the next character the following is true: Bit 0 = 1 Bit 1 = 0 Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 37: Creating And Detecting Inter-Character Delays

    F9, or open the context menu using the right mouse button, and choose Function character '&' (delay..The example sequence now reads: 103 | & | 101 | 116 | 013 Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 38 Receive Sequence that contains a delay/pause definition only, and no actual serial data. This can be very useful for implementing timing constraints, e.g. resetting the telegram detection after a pause occurred. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 39: Setting And Detecting A "Break" State

    This behavior cannot be controlled by Docklight, it depends on how the serial UART of your PC's COM port interpretes the break state. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 40 The resulting Receive Sequence could look like this: % | # | # | # | # | # | # | # | # | T | e | s | t Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 41: Examples And Tutorials

    Examples and Tutorials...

  • Page 42: Testing A Modem - Sample Project: Modemdiagnostics.ptp

    The response will vary with the modem model. After sending several sequences, the Docklight communication window could look like this: 07.02.2013 18:17:54.083 [TX] - ATQ0V1E0<CR><LF> Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 43: Reacting To A Receive Sequence - Sample Project: Pingpong.ptp

    Project Settings... dialog and choose a COM port. · Apply a simple loopback to this COM port: Connect Pin 2 (RX) with Pin 3 (TX). See RS232 SUB D9 Pinout. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 44: Modbus Rtu With Crc Checksum - Sample Project: Modbusrtucrc.ptp

    The Docklight project file ModbusRtuCrc.ptp demonstrates how to automatically calculate the CRC value required to send a valid MODBUS RTU frame. The project file uses the communication settings listed below, according to the MODBUS implementation class "Basic". Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 45 · If you do not have any MODBUS slave devices available, you can use a software simulator. See http://www.modbus.org, "Modbus Technical Resources", "MODBUS Serial RTU Simulator". This simulator was used to produce the sample data shown above. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 46: Reference

    Reference...

  • Page 47: Menu And Toolbar

    Clear Communication Window Delete the contents of the communications window. This applies to all four representations (ASCII, HEX, Decimal, Binary) of the communication window. Run Menu Start communication Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 48: Dialog: Edit Send Sequence

    Unique name for this sequence (e.g. "Set modem speaker volume"). This name is for referencing the sequence. It is not the data that will be sent out through the serial port. See "2 - Sequence" below. 2 - Sequence Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 49: Dialog: Edit Receive Sequence

    You may choose from the following actions: · Answer - After receiving the sequence, transmit one of the Send Sequences. Only Send Sequences that do not contain wildcards can be used as an automatic answer. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 50: Dialog: Start Logging / Create Log File(S)

    Choose the directory and base file name for the log file(s) here. The actual file path used for the individual log file representations are displayed in the text boxes within the "Log file representation" frame. Overwrite / append mode Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 51: Dialog: Find Sequence

    Parameter No. A Send Sequence can contain any number of wildcards. Each set of consecutive wildcards is considered a separate parameter. The value for each parameter is entered separately. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 52: Dialog: Project Settings - Communication

    TAPx The channel is connected to one of the Docklight Tap monitoring data directions. The TAP connections are only TAP0 available if Communication Mode is set to 'Monitoring', the Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 53 Docklight should preserve all incoming characters, even when the parity bit is wrong. This is useful for applications where a 9th bit is used for addressing purposes and not for error checking. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 54: Dialog: Project Settings - Flow Control

    This allows you to re-label the two Docklight data directions according to your specific use case. E.g. [Docklight] / [Device] instead of [TX] / [RX]. Or [Master] / [Slave] instead of [TAP0] / [TAP1]. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 55: Dialog: Options

    For applications where the data flow direction does not change very often, you may want to have additional date/time stamps at regular time intervals. For this, activate the Clock - additional date/time stamp... option then and choose a time interval. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 56: Dialog: Customize Html Output

    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 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 57 The text color to apply for %DATA%, as selected in the Display Settings When generating a log file, Docklight replaces the wildcards with the current display settings and the actual communication data. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 58: Dialog: Expert Options

    (e.g. using Communication Channel TAP0 / TAP1), the 'Data Forwarding' setting has no effect. The Docklight Tap is accessed in read-only mode always, and no data is forwarded. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 59: Keyboard Console

    16 bit width CRC as used in IBM Bisynch, ARC. Same as: CRC:16,8005,0000,0000,Yes,Yes CRC-MODBUS 16 bit width CRC as used in MODBUS. Similar to CRC-16, but with a different init value. Same as: CRC:16,8005,FFFF,0000,Yes,Yes Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 60 Optional. Little Endian - the resulting checksum value is stored with the least significant byte (LSB) first. Default is Big Endian / MSB first. @ targetPos Optional. Specifies the first character position for storing the resulting checksum value. e.g. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 61 CRC-MODBUS A @ -5 # MODBUS ASCII checksum returned as text (1,3) CRC-16 @ 10 # CRC-16 checksum over the first 3 bytes. (2, -5) CRC:8,07,00,00,No,Yes # CRC with custom, non-standard spec. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 62: Support

    Support...

  • Page 63: Web Support And Troubleshooting

    We provide individual e-mail support to our registered customers. Please include your Docklight license key number in your request. We will contact you as soon as possible to find a solution to your problem. Send your support request to docklight@fuh-edv.de Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 64: Appendix

    Appendix...

  • Page 65: Ascii Character Set Tables

    End of transmission block Cancel End of medium substitute/end of file Escape File separator Group separator Record separator Unit separator Printing Characters ASCII Char. Meaning ==================================== Space " " & & Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 66 Appendix Zero Three Four Five Seven Eight Nine < < > > Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 67: Hot Keys

    · Edit Send Sequence dialog / Edit Receive Sequence dialog · Docklight Notepad Function Hot Key Context-specific help Ctrl+X Copy Ctrl+C Paste Ctrl+V Delete Select all Ctrl+A Context-specific Hot Keys Docklight menu Menu Function Hot Key Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 68: Rs232 Connectors / Pinout

    Ctrl+D 10.3 RS232 Connectors / Pinout The most common connectors for RS232 communication are · 9-pole SUB D9 (EIA/TIA 574 standard). Introduced by IBM and widely used. See below. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 69 Request To Send Clear To Send Data Set Ready SGND Signal Ground Data Carrier Detect Reserved Reserved Unassigned SDCD Secondary Data Carrier Detect SCTS Secondary Clear To Send Secondary Transmit Data Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 70: Standard Rs232 Cables

    Overview of RS232 SUB D9 (D-Sub DB9) interconnections serial device 1 serial device 2 flow control recommended cable (handshaking) (Data no handshake simple null modem cable Terminal signals Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 71 Communication with hardware flow control using additional handshake signals. SUB D9 Simple Null Modem Cable without Handshaking Area of Application: DTE-DTE Communication where no additional handshake signals are used. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 72 Appendix SUB D9 Null Modem Cable with Full Handshaking Area of Application: DTE-DTE Communication with DTE/DCE compatible hardware flow control. Works also when no handshake signals are used. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 73: Docklight Monitoring Cable Rs232 Sub D9

    TIP: An inexpensive and quick solution for basic monitoring can be making your own Monitoring Cable using a flat ribbon cable and SUB D9 insulation displacement connectors, available at any electronic parts supplier. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 74: Docklight Tap

    Docklight Monitoring Mode and Receive Channel settings TAP0 / TAP1. See the Docklight Project Settings How to Obtain Best Timing Accuracy for details. Please also see our product overview pages for more information about the Docklight Tap. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 75: Docklight Tap Pro / Tap 485

    Docklight Project Settings more details. Please also see our product overview pages for more information about the Docklight Tap Pro and Docklight Tap 485. Docklight Tap Pro Docklight Tap RS485 Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...
  • Page 76 Appendix Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 77: Glossary / Terms Used

    Glossary / Terms Used...

  • Page 78: Action

    A very popular article about CRCs is "Easier said than done (Michael Barr) - A guide to CRC calculation": http://www.netrino.com/Connecting/2000-01/ Docklight Scripting's CRC functionality (DL.CalcChecksum) was inspired by the above article and the proposed Boost CRC library: http://www.boost.org/libs/crc/index.html Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 79: Dce

    It is commonly used as "MODBUS over Serial Line" in RS422/485 networks, but can be implemented using TCP over Ethernet as well ("MODBUS TCP"). Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 80: Multidrop Bus (Mdb)

    +5V to +15V +3V to +25V Undefined -5V to +5V -3V to +3V The physical characteristics of the RS232 standard are described in the section RS232 Connectors / Pinout Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 81: Rs422

    There are two ways to make Docklight send a sequence: · Sending a sequence can be triggered manually by pressing the send button in the Send Sequences list (see Main Window). Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 82: Sequence

    Docklight will not produce any output until a trigger sequence has been detected in the serial communication data. Catching a specific sequence and taking a snapshot... for more information. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

  • Page 83: Uart

    Function Character '!' (F12): Bitwise comparison. This is useful if there are one or several bits within a character which should be tested for a certain value. See Function character '^' (F12) - bitwise comparisons for details and an example. Docklight V2.2 User Manual 07/2016 Copyright 2016 Flachmann und Heggelbacher GbR...

Table of Contents