Kinesys K2 User manual

© 2010 Kinesys
K2
Manual Version 1.2.0
Product Manual

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.
Products that are referred to in this document may be either trademarks and/or registered trademarks of the
respective owners. The publisher and the author make no claim to these trademarks.
While every precaution has been taken in the preparation of this document, the publisher and the author assume no
responsibility for errors or omissions, or for damages resulting from the use of information contained in this document
or from the use of programs and source code that may accompany it. In no event shall the publisher and the author be
liable for any loss of profit or any other commercial damage caused or alleged to have been caused directly or
indirectly by this document.
Printed: April 2010
K2
© 2010 Kinesys
Publisher
Technical Editors
Kinesys Projects Ltd
Dave Weatherhead
Martin Honeywill
Andy Hicks

3Contents
© 2010 Kinesys
Table of Contents
Part 1 Introduction 6
Part 2 Safety Notice 7
Part 3 Whats New 8
Part 4 Version and Legal Information 9
Part 5 Application Modes 10
Part 6 Scaling conventions 11
Part 7 Logging In and Out of K2 12
Part 8 Live and Offline Modes 13
Part 9 Exiting the Application 14
Part 10 The Patch Browser 15
Part 11 The Visualiser 16
Part 12 Channel Alignment 17
Part 13 Console 18
Part 14 Setting up a Show 19
Part 15 Show Properties 20
...................................................................................................................................211Properties
...................................................................................................................................22
2Environment Variables
...................................................................................................................................23
3Wing Configuration
...................................................................................................................................24
4Advanced Settings
Part 16 Construct Building and Editing 25
...................................................................................................................................261Adding Constructs
...................................................................................................................................27
2Selecting a Construct Type
......................................................................................................................................................... 28Identification
......................................................................................................................................................... 28
Origin ......................................................................................................................................................... 29
Safety ......................................................................................................................................................... 30
Parameters

K24
© 2010 Kinesys
......................................................................................................................................................... 32
Model ......................................................................................................................................................... 33
Links ......................................................................................................................................................... 34
Finish
...................................................................................................................................353Editing Constructs
...................................................................................................................................36
4Drawing Construct and Stage Models in CAD
Part 17 Channel Creation and Editing 37
...................................................................................................................................381Adding Channels
...................................................................................................................................39
2Channel Properties
......................................................................................................................................................... 40Setup ......................................................................................................................................................... 41
Motor Settings
......................................................................................................................................................... 42
Drive Parameters
...................................................................................................................................433Patching
...................................................................................................................................44
4Channel Details
......................................................................................................................................................... 44Status Descriptions
......................................................................................................................................................... 45
Alarm Descriptions
Part 18 Working with Cues 46
...................................................................................................................................471Cue Selection and Display
...................................................................................................................................50
2Programming Cues
......................................................................................................................................................... 50Construct Selection
.................................................................................................................................................. 51
3D Visualiser
.................................................................................................................................................. 52
Programmer Spreadsheet
.................................................................................................................................................. 53
Programmer Spreadsheet Headings
.................................................................................................................................................. 55
Outputting the Programmer
.................................................................................................................................................. 55
Rewinding the Programmer
.................................................................................................................................................. 55
Recording the Programmer
.................................................................................................................................................. 56
Updating Cues
......................................................................................................................................................... 56
Cue Triggers
......................................................................................................................................................... 57
Playback Controls
......................................................................................................................................................... 59
Locking and Releasing Constructs
......................................................................................................................................................... 59
Playback Lookahead
......................................................................................................................................................... 60
Construct Details
...................................................................................................................................613Programming Effects
......................................................................................................................................................... 61Presetting Constructs
......................................................................................................................................................... 62
Delaying Effects
......................................................................................................................................................... 63
Stopping Effects
...................................................................................................................................644Pages
...................................................................................................................................65
5Keyboard Shortcuts
Part 19 Action 66
Part 20 User Management 69
Part 21 Direct Motor Control 70
...................................................................................................................................721Channel Buttons
...................................................................................................................................73
2Status Descriptions

5Contents
© 2010 Kinesys
...................................................................................................................................743Alarm Descriptions
Part 22 Working with Presets 75
Part 23 Working with Spreadsheets 77
Part 24 Working with the Command Line 79
Part 25 Window 82
...................................................................................................................................831Browser
......................................................................................................................................................... 83Constructs
......................................................................................................................................................... 84
Channels
...................................................................................................................................852Channel Alignment
...................................................................................................................................86
3Channel Schedule
...................................................................................................................................87
4Cuelist/Preset Directory
...................................................................................................................................88
5 Cuelists
...................................................................................................................................90
6Cue/Preset Editor
...................................................................................................................................91
7Direct Motor Control
...................................................................................................................................93
8Launch Show
...................................................................................................................................94
9Log
...................................................................................................................................95
10 Page Directory
...................................................................................................................................96
11 Playback Controls
...................................................................................................................................99
12 Programmer
...................................................................................................................................102
13 Status Bar
...................................................................................................................................103
14 Visualiser
Part 26 Toolbar 105
...................................................................................................................................1061File Operations
...................................................................................................................................108
2Show Setup
...................................................................................................................................111
3Motion Control
...................................................................................................................................113
4Show Contents
...................................................................................................................................116
5Windowing
...................................................................................................................................117
6Views Toolbar
...................................................................................................................................118
7User Management
...................................................................................................................................119
8Logout
...................................................................................................................................120
9Quit
Part 27 Contact Information 121
...................................................................................................................................1221Feedback

6K2
© 2010 Kinesys
1 Introduction
K2 is a powerful, graphically based, control solution for automation and motion control.
It employs a brand new approach to automation programming using the concept of
click and drag to position the items you wish to move in precisely the positions they
need to be.
All programming and Cue playback can be seen real-time using the built-in 3D viewers.
3D worlds can be created in graphics and CAD packages and exported into a
compatible format to work with K2. Constructs, the actual moving elements, are
imported as 3D CAD files also, allowing seamless integration with the 3D worlds.
The ability to move the Constructs in real world axes, X, Y, Z, pitch, tilt and rotate makes
programming very intuitive with the K2 shielding the user from the complex
multi-dimensional calculations required and instead presenting them with easy to use
programming parameters. This concept of True Axis Programming also makes the
application of effects to one or several parameters within a Cue very simple. Previously
impossible to program effects are now just a few clicks away with the results being
instantly available via the visualiser windows.
This manual has been written to guide you intuitively through the K2 software package.
It has been laid out in such a way to make understanding K2 as simple as possible. The
fundamental principles are explained at the start of each section with the more in depth
and advanced features being towards the rear of each section. If you are uncertain of
the function of a particular control within the program refer to the Windows section,
which lists each window that is displayed within the software and includes an
explanation of the controls on the window, what they do and how to navigate them.

7Safety Notice
© 2010 Kinesys
2 Safety Notice
K2 is a highly sophisticated motion control software package, however, circumstances
beyond the control of the software e.g. faulty computer equipment or 3rd party programs
running on the same computer always offer the possibility for unexpected behaviour.
As in all motion control applications the control software should never be relied upon as
the sole means of stopping motion. Alternative, software independent, means of bring all
movement to a halt must be provided including a hardware emergency stop system that
is compliant with all local regulations.
It is the responsibility of the user to perform a risk assessment for the whole system and
to take appropriate action as a consequence of that assessment.
Although K2 provides realistic 3D feedback of the movement of objects a line of sight
view of the actual moving pieces should always be ensured. Where necessary additional
observers should be employed utilising clear lines of communication to be able to
advise the operator of any issues that may arise during the movement of objects.
If in doubt about any aspect of moving objects always seek professional advice.
SAFETY MUST ALWAYS BE THE FIRST PRIORITY!

8K2
© 2010 Kinesys
3 Whats New
The new version of K2 includes many new features and updates. For ease of reference
they are all listed here and are also identified in the rest of the manual by the New icon
(shown above).
Auto Alignment
There is now an Auto Align button on the toolbar of K2. This button aligns the virtual
objects in K2 to the real world positions of the objects, allowing K2 to realign itself
without any movement in the real world. For more information see the Channel
Alignment section.
Construct Values in Percentages
Users now have the ability to specify percentages instead of a figure in millimeters when
controlling a construct. This is setup on a construct by construct basis via the
Parameters section when creating a new construct. You can also invert the percentages
so that 100% is the minimum and 0% is the maximum. See the Parameters section for
more information.
DMX on a Construct by Construct Basis
DMX control can now be setup on a construct by construct basis, enabling remote
operation of cues or movement of those constructs by lighting desk or other DMX
enabled devices. This granular level of control means that only those constructs that
have been specifically setup to be DMX controlled are capable of doing so. The only
information that K2 needs is the DMX universe and starting address. You can find this
new feature when creating a new construct in the Parameters section.
Log File Location
Log files can now be saved in a user specified location. By default they save in the
Documents and Settings/All Users/Application Data/Kinesys/K2/log file folder. Users can
specify another location on the computer running K2, an external drive or another
machine or server on the same network. This feature is located in the Show Properties
window.
State Multicast
K2 has the ability to multicast its positional information out over the network, enabling
other services such as media servers to know the exact position of objects on stage. As
part of this broadcast it is also possible to "listen in" on just one construct and one
parameter of that constructs movement. This feature is located in the Parameters
section.

9Version and Legal Information
© 2010 Kinesys
4 Version and Legal Information
For information on which version of K2 software you are running, click on Show Setup
and then About. All copyright and legal information is also contained in this window.

10 K2
© 2010 Kinesys
5 Application Modes
The application mode that K2 runs in is determined by the licence code that is supplied
by Kinesys. There are three modes in total, each offering different functions to the user.
Full
Full mode is the top level mode for K2. In this mode all features are available to the user,
there are no restrictions on moving devices.
Demonstration
In Demonstration mode K2 is not capable of issuing motion commands to control
Channels. Full editing, programming and visualisation is possible and show files created
in Demonstration mode are fully compatible with a Full version of K2 and vice versa. No
login or password is required when in Demonstration mode and Channel Alignment is
not required at any stage as there are no external Channels to align with. Direct Channel
Control is disabled for the same reason.
Active Backup
Active Backup mode provides a tracking backup facility to K2. This mode is designed for
systems that require a backup system to supplement the master K2 system. The Active
Backup system is designed to share an Ethernet network with the K2 master running in
Full licence mode. In this mode K2 will track the positions of all the Constructs and
Channels being controlled by the master K2 system. Current show and Cue and Cuelist
information is also passed to the Active Backup system to allow it track the master
successfully.
The Active Backup system is not capable of issuing motion commands while in
communication with the master K2 system. If communications are lost with the master
system the Active Backup system will automatically ‘go live’ and will take over
communications with the control Channels and will become capable of issuing live
motion commands. The automatic 'upgrade' from Tracking Backup licence to Live
licence lasts 2 days. After that the Tracking Backup will either need to be upgraded to a
Full licence (time-limited or unlimited) or it will need reconnected to a fully licensed K2
program in order to reset its full licence timer.
For completeness this manual is written for use with a Full version of K2, sections that
are not relevant when running in other modes should simply be ignored.

11Scaling conventions
© 2010 Kinesys
6 Scaling conventions
All World and Construct models should be scaled in millimeters. All movement within K2
is recorded and displayed in whole millimeters. Meters and the decimal point are not
used so ten meters would be entered and displayed as 10000.

12 K2
© 2010 Kinesys
7 Logging In and Out of K2
All users of fully licensed versions of K2 must enter a username and password before
the application will start. The application comes with two default passwords that will
have been supplied to the owner of the software as a separate document. They should
supply all users with an access password to the software. Contact the software owner
or rental company for a password to access K2.
Once logged in all the features are available with the exception of full user management
which is only available to users who log in with the top level password. User
management for all other users simply allows them to change their own individual
password.
You can log out of K2 without exiting the application. This leaves the application in a
safe state where a username and password must be entered before access to K2 is
available again. To log out click on File on the main toolbar and then Logout. You will be
asked if you wish to save changes. When the application is next logged into you will
asked to select a file to load so any unsaved changes will be lost if they are not saved
when logging off.

13Live and Offline Modes
© 2010 Kinesys
8 Live and Offline Modes
K2 can operate in two main modes, Live and Offline. In Live mode all motion commands
are outputted onto the network for action by the external control Channels and their
respective machines. Unaligned Constructs and inhibited Channels are the only reasons
that motion commands will be not be outputted. Live mode is the default mode on
program startup and is the mode that must be used whenever movement is to be
initiated.
The system is switched in and out of Offline mode by clicking on Setup on the main
toolbar and then Offline. In Offline mode all motion commands are blocked from being
output on to the network and therefore onto the control Channels and their machines.
Full programming is possible in Offline mode and all Cues can be run and viewed within
the Programmer and Visualiser window.

14 K2
© 2010 Kinesys
9 Exiting the Application
To exit K2 click on File on the main toolbar and then Quit. You will be prompted to save
changes, click on the appropriate button and you will exit the application.

15The Patch Browser
© 2010 Kinesys
10 The Patch Browser
The Patch Browser contains a summary of all the Constructs, Channels, Links and
patching in your show. It is divided up into two areas. The left hand pane contains all
the Constructs in the show. Within each Construct are six icons representing the six
possible parameters of motion; X, Y, Z, P(pitch), T(tilt) and R(rotate). If a Construct has a
parameter enabled then the letter is in black, if it does not have access to a parameter
then the letter is in grey. To view the properties of an individual parameter either
double-click the letter or right-click and select Properties. To view properties for the
whole Construct double-click in the main Construct box or right-click and select
Properties.
Links for each Construct are shown on the right hand side of the Construct box. Patched
Channels are displayed as white boxes containing the Channel name, un-patched Links
are shown as grey boxes with a dashed outline.
In the right hand pane are a list of all the Channels in the show. Patched Channels are
shown as grey boxes while un-patched Channels are shown in white. The properties of
an individual Channel patched or un-patched can be viewed by double-clicking an a
Channel’s box or by right-clicking and selecting Properties. To view the properties of
several Channels left-click on the relevant Channels while holding down the Ctrl key on
the keyboard then right-click one of the Channels and select Properties.
To patch a Channel to a Link on a Construct drag and drop the Channel onto the
dashed box beside the Construct box. To replace an existing Channel drop the new
Channel on top of the existing one. A confirmation box will appear, click Yes to finish the
patch or No to cancel the operation.

16 K2
© 2010 Kinesys
11 The Visualiser
On the Main Toolbar, press Visualiser to open the Visualiser. This allows you to see the
position of the Constructs in 3D space.
To move the camera in perspective view, click and drag the mouse left and right to
rotate about the origin of the stage, and drag up and down to vary the height above the
stage that you are viewing from. In the orthographic views, Front, Side and Top, the
mouse moves the viewpoint around the plane of projection. In all views the mouse wheel
will zoom the camera in and out.
Use the toolbar buttons to toggle between the perspective view and orthographic
elevations, or to display them all. The projections are XY (front elevation), YZ (side
elevation) and XZ (top elevation). In all but the Perspective view, rulers are displayed at
the side of the viewer to help with approximating position. To show the world origin click
on Toggle Datum in the Visualiser toolbar. The Front, Side and Top views allow a grid to
be superimposed onto the Visualiser window. This makes using the rulers to
approximate position much simpler, to turn the grid on and off use the Toggle Grid
button on the Visualiser toolbar.

17Channel Alignment
© 2010 Kinesys
12 Channel Alignment
Channel alignment is the process of connecting the virtual Channels to the physical
Channels. K2 knows where the Construct is in its 3D world and it knows where it thinks
that the Channels should be in order to achieve that position. The process of alignment
confirms that the two match and can therefore be controlled. Channels are considered
to be aligned when the physical position of the moving item on the stage matches the
position displayed within K2. If there is a difference between the two positions then
either the 3D representation must be moved to match the real world or the physical
object must be moved to match the position that K2 is displaying.
Once the two worlds are aligned the relevant Channels can be enabled and K2 can take
control of the moving object.
Channel Alignment is always required when a show is loaded into K2, it is also required
whenever movement has been initiated through the Direct MotorControl window.
To enable a Channel either double click on ‘No’ in the Enabled column or click on the
cell and press Insert. If you wish to enable all Channels then click on the Enable All
button at the bottom of the window.
There may be occasions where you wish to disable the Channel Alignment so that you
can move objects in the real world without affecting the virtual one or vice versa. To
access the Channel Alignment window, click the Channels button on the main toolbar.
From the Channels window click on the Channel Alignment button. This window will only
appear if you have linked Channels in your show and if those Channel controllers are
connected to the system.
Auto Alignment
There is now an Auto Align button on the toolbar of K2. This button aligns the virtual
objects in K2 to the real world positions of the objects, allowing K2 to realign itself
without any movement in the real world. If you are using K2 with Constructs that only
have a Z axis movement, this is especially useful. Dealing with Constructs that have
more than one axis makes the Auto Alignment harder to achieve, as there are obviously
far more variables, but K2 will still do it's best to auto align. The Auto Align feature uses
the information that K2 has about the real world positions of Constructs and Channels to
match the virtual positions to them. Once this alignment has been achieved, K2 will
allow movement to continue
For more information on the functions of this window see the Channel Alignment section
of the Window chapter.

18 K2
© 2010 Kinesys
13 Console
K2 is available as self contained console, which contains the computer hardware that
runs K2 as well as providing a control surface, keyboard and mouse. The console offers
a whole range of selection and programming possibilities that are not available through
the keyboard and mouse alone. Although this manual primarily concerns itself with the
K2 software, where appropriate the wing commands and shortcuts will also be listed.
To adjust settings relating to a connected K2 console click on Show Properties from the
Setup toolbar and then click on the Wing tab. From here the brightness of the desklight,
bargraph indicators and illuminated keys can be set. The serial number and firmware
revision of the console can also be read from here. Finally firmware can be reloaded to
the wing from this tab. Click on the Reload Firmware button to have K2 reload the latest
version of the firmware to the console.

19Setting up a Show
© 2010 Kinesys
14 Setting up a Show
The following areas outline the steps to take when setting up, saving and backing up a
show. For further information on the properties of a show see the Show Properties
section.
Creating a New Show
On the main toolbar click on File then New Show. You will be prompted to select a
filename for the show and a folder to store the show in. Once both of these have been
entered click on OK.
Loading an Existing Show
On the main toolbar press File then Load Show. Select a show from the dialog and then
click on OK.
Once the show has been loaded you will be asked to align the Channels. This process
locks the position of the physical machines (motors, winches, rams etc.) to the virtual
Channels within K2. See Channel Alignment for more details.
Saving a Show
On the main toolbar click on File then Save Show. This will save all changes to disk.
Backing up a Show
Use Backup to save a copy of the existing show for archiving purposes. On the main
toolbar click on File then Backup. You will prompted to enter a new filename and/or new
folder for the backup file. Click on OK to save the backup copy. Subsequent saves will
use the current filename and location. Backup purely saves a snapshot copy of the file.
Automatic Backup
Automatic backup performs background saves of the show so that should the
application stop running for any reason a minimal amount of programming will be lost.
The Auto Backup feature is turned on and off in the Show Properties window which is
accessed by clicking on Setup and then Show Properties. Select the check box to turn
Auto Backup on and then choose how many generations of backup file you wish to
maintain as well as the frequency of the automatic saves.
Advanced Properties
The advanced tab contains variables relating to the low-level running of the motion and
communications software engines. These should not be adjusted unless you are
specifically requested to do so by a member of the Kinesys support team or one of their
approved K2 partners.

20 K2
© 2010 Kinesys
15 Show Properties
The show properties are global settings that apply to the whole show and are applied to
all data. This window allows you to choose the world model, define the security settings
for the show and adjust properties relating to the wing. For full details of the contents of
this window refer to Show Properties in the Window chapter of this manual.
To access the Show Properties window click on Show Setup and then Show Properties.