Kickstart Setup and control software for motors with integrated drive electronics
Kickstart User Manual Status: Kickstart V1.9.40 Doc Rev 1.0.12 – 31.01.2014 Copyright 2013 ebm-papst 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. Trademarks Products that are referred to in this document may be either trademarks and/or registered trademarks of the respective owners.
Table of Contents 1 2 About This Manual 4 1.1 Symbols Used 1.2 Terms Used UI Panel 27 4 6.6.1 UI Panel - Getting Started 27 4 6.6.2 UI Format Definition 27 Safety 6 6.6.3 Node IDs and Multi-Node Panels 30 2.1 Intended Use 6 6.6.4 Project and UI Files / 2.2 Safety Notices 6 3 Overview 7 4 Installation 9 5 Using Kickstart 10 5.1 Getting started 10 5.2 Main Screen and Toolbar 11 5.3 User Level 12 5.4 Projects and Templates 13 5.
1 About This Manual 1.1 Symbols Used The following symbols are used in this document: As defined by these operating instructions and the danger notices on the products, death, severe bodily injury or considerable damage to property could result if the appropriate safety measures are not taken. WARNiNG Important information about the product or part of the operating instructions. Notice 1.
1 About This Manual SDO Service Data Object CANopen SDO transfers are used for low priority reading and writing of device parameters and objects. SDO Upload (read from device) and SDO Download (write to device) specifications define different standard methods of reading and writing different types of data, including optimized transfers for large blocks of data. PDO Process Data Object CANopen devices produce or consume PDO CAN frames. They are used for fast data transfer of critical process data.
2 Safety 2.1 Intended Use This software is intended for the commissioning and service of position drives and other motionoriented machine control units. This software accesses the devices via a multi-layer application protocol, such as the CANopen application or the RS485 protocol. 2.2 Safety Notices For all commissioning and service tasks, please refer to the technical documentation of your drive unit or automation device controlled by this software.
3 Overview K5 motor K4 motor Kickstart software Start screen RS485 CAN-Bus Kickstart K4 Kickstart K5 Start interface Start interface Kickstart is a modular PC software platform that can be used for a variety of configuration, commissioning and service tasks. It is highly flexible and uses application-specific project and template files to present the user with exactly the functions and controls needed for a specific task.
3 Overview Kickstart projects are made up of standard modules which are used as blocks. For example, the "CAN (USB) Interface" or "Drive01 / CANopen Drive" modules. Additional project templates containing other modules are available for specialised applications (scope, UI panels, etc.).
4 Installation The Kickstart application software is usually distributed in a .exe self extracting archive file. Double-click the .exe file to copy the application to a directory on your computer, or a removable media, e.g. a disk-on-key USB memory stick. Then start the Kickstart software by double-clicking on Kickstart.exe. No installation (setup) is required, but please make sure you extracted all files and folders from the original .zip archive Notice to a location on your PC or removable media.
5 Using Kickstart 5.1 Getting started Do not operate Kickstart within an automation network where any of the Kickstart CAN or CANopen communication could possibly disrupt the normal operation. WARNiNG Incorrect wiring or wrong cabling can damage electronic components, including the USB-CAN-RS485 adapter, the CAN-RS485 interface and the PC connected with the CAN Interface.
5 Using Kickstart 5.2 Main Screen and Toolbar The Kickstart main screen is divided into three sections: Kickstart Main Screen Layout Menu and Toolbar Area The menu and toolbar area stays the same for all Kickstart project. Main Toolbar Functions New Project Opens the Kickstart Home Project template. Usually, it is a project selector that allows you to pick your specific application. Open Project Opens an existing Kickstart project (.kickzip or .kickpro) or template (.kicktpl).
5 Using Kickstart Stop Drives Resets all drive units listed in the module area and communication between the drive and the computer back to the idle state. The Stop Drives function is not an emergency stop device. It cannot perform any safety or emergency functionality for your drive application. Please ensure that external emergency stop functions are effective, according to the safety WARNiNG regulations and requirements of your drive application.
5 Using Kickstart 5.4 Projects and Templates Everything you see in the modules and content area of Kickstart is defined in a Kickstart template or project file. The following file formats are used: .kickpro Uncompressed Project Files A Kickstart .kickpro file defines everything you can see in the Modules and Content area of Kickstart: CAN Interfaces, CANopen Drive units, Scope modules, a.s.o. The .kickpro file is a standard XML file that can be edited by experienced users to build specific applications (e.
5 Using Kickstart .kicktpl Template Files A Kickstart installation comes with a number of predefined projects for specific tasks, stored as .kicktpl template files. The Project Selector and the projects defined in Getting started are examples for such templates. Opening a .kicktpl file is no different to opening a .kickzip file, except that no file name for saving the project is chosen.
6 Kickstart Modules 6.1 CAN Interface Depending on the template, different modules / module names are available, i.e. the modules do not always have all the functions described here. CAN Interface module controls the communication interface to the CAN network. This is usually a The CAN-USB interface with the following parameters: • Communication Port The default setting (first found) should work fine for most applications. If you need to choose a COM port manually (e.g.
6 Kickstart Modules Inverting your filter Starting your filter with the keyword exclude will hide anything that matches the filter condition, e.g. exclude id = 581h, index=606c, index=6041 – show only SDO traffic for object 606c and 6041 for CANopen node 1 Comments Use a # to add additional free text comments about your filter, e.g. id != 81-ff # hide emergency msg Auto Filter Pressing Auto Filter will add a filter condition to suppress the CAN frame type with the most frequent appearance.
6 Kickstart Modules Example: wait 581h,8,4b 41 60 00 ?? ?4 *,1000 (waits for a status word where the highest four bits are “4”.
6 Kickstart Modules 6.2.1 Setup Setup panel is used for various configuration and simple testing tasks: The Use initial setup functions with care. It is strongly recommended to perform initial setup functions with only one drive unit Notice connected to Kickstart, and not within a full CANopen installation with several drive nodes. Initial Setup Assign or change the CAN Node ID or CAN Baud Rate.
6 Kickstart Modules Store Store the written parameters permanently. I.e. the CANopen device will continue to use these values after a voltage reset. This function is used after writing modified values using the Write function. Reset Reset all device parameters to the factory settings. Synch Mode Read read-only parameters periodically. Writable parameters are read once. After that, every modification entered by the user will be downloaded to the device immediately.
6 Kickstart Modules 6.3 Motor Access / CANopen Node Depending on the template, different modules / module names are available, i.e. the modules do not always have all the functions described here. The CANopen Node module offers a basic configuration screen for any type of CANopen node, e.g. a third-party servo drive, I/O module or sensor device. The Parameter Editor table contains a list of CANopen objects and their values, similar to the Object Editor.
6 Kickstart Modules 6.3.1 CANopen Node – Edit Mode The Edit Mode affects the appearance and behavior of the CANopen Node module. It can be modified from Design Mode. User Level 2 is required to switch to Design Mode. Notice Name Description 0 – Standard 1 – List Read 2 – List Read/Write 3 – Auto Store The read / write behavior is similar to the Object Editor, Read / Write works on the currently selected object only.
6 Kickstart Modules range Defines the minimum and maximum values. For example: range:0,100 range:-100,100 options Used with type:combo. This specifies a list of available options and their corresponding values. Format: options:,|, | ... (etc.
6 Kickstart Modules Node Monitor You can use the Node Monitor for a simple network overview which displays some basic information on every Node ID that is listed in the Scanned Node IDs text field. • Make sure the Scanned Node IDs list is the list of nodes you want to monitor. • Click the Node Mon. Config to display a list of parameters that should be read for every node. You can drag additional Data Objects from the Object Editor module, and drop them on the Node Monitoring Configuration table.
6 Kickstart Modules 6.5.2 Configuration After dragging a Data Object from the Object Editor and dropping it on the configuration table, you can use the following fields to configure the data processing within the Scope module. Sampling and Rate This defines how the values for the data logging and scope are obtained. Sampling Description Off Sampling is disabled or inactive Software Kickstart sends out SDO Upload requests to the node ID, using the fixed time interval of Rate milliseconds.
6 Kickstart Modules 6.5.3 Recording Data Use the Record toolbar button to start and stop recording of all monitored data into a .csv file. To make the filename contain the date and time of the recording’s start, use the placeholder DATETIME, which will be replaced with the proper timestamp. For example: the filename measurements_DATETIME.csv will be stored as measurements_2012-02-16T15-01- 32.csv. To view the recorded data, use Open.
6 Kickstart Modules Examples for the Value / Div Scale Scaling Methode Normalized (Standart) Format Shorthand Format Description Auto automatic a Scale will be automatically adjusted based on the current values displayed. min=0 max=100 0m100 The displayed scale will be between 0 and 100 min=0.25 max=0.75 .25max0.75 The displayed scale will be between 0.25 and 0.75 100/div offset=0 100 The displayed scale will start at offset 0, with 100 units between each div. 0.1/div offset=-20 0.
6 Kickstart Modules 6.6 UI Panel Depending on the template, different modules / module names are available, i.e. the modules do not always have all the functions described here. The UI Panel module can display data objects in configurable dynamic user interfaces, making use of Qt Quick / QML technology. You can build personalized interfaces, suitable for different users and scenarios. Data Objects can be represented by graphic controls (dial, slider, option box) on a canvas.
6 Kickstart Modules shape Defines the type of control will be created when the Data Object is dropped on the UI Panel canvas.
6 Kickstart Modules range Defines the allowed range for input controls. It is only used by the slider and dial controls. Examples: range:0,100 range:-100,100 When dragging an object from the Object Dictionary (Device Description) of the Object Editor module, the range is Notice calculated from the original .xdd / .xdc device description file, if available. If no value range was specified in the device description file, a default range value is chosen.
6 Kickstart Modules Example UI Format Definitions UI Format Description shape:label; updates:r A read-only label. The control’s value will be read from the device only upon initialization. shape:label; updates:r200 A read-only label. The control’s value will be read from the device upon initialization and then periodically, every 200 milliseconds. shape:text; updates:r,w A user-modifiable textbox, value is read from the device upon initialization.
6.6.4 Project and UI Files / Advanced User Interfaces After composing your UI Panel, you can store the user interface created using the Save Project function from the Kickstart main toolbar. If you created your UI Panel by starting with one of the Kickstart templates provided, the saved file is a Kickstart Compressed Project file (.kickzip) by default. For many advanced applications it is necessary to directly work on the uncompressed files stored inside the .
www.ebmpapst.com ebm-papst St. Georgen GmbH & Co. KG Hermann-Papst-Straße 1 78112 St. Georgen Germany Phone +49 7724 81-0 Fax +49 7724 81-1309 info2@de.ebmpapst.
