Kurzweil K2500 - PERFORMANCE GUIDE REV F PART NUMBER 910252 CHAP 11 User Manual

System Exclusive Protocol
K2500 System Exclusive Implementation
11-1
Chapter 11
System Exclusive Protocol
K2500 System Exclusive Implementation
The MIDI System Exclusive capabilities of the K2500 allow you to manipulate objects in the
K2500’s memory from a computer system, another K2500, or a MIDI data recorder. The
following is a reference to the SysEx protocol used by the K2500. This information can be used
to build a simple object librarian software program. A word of advice—before you begin
experimenting with SysEx, make sure you have saved anything of value in RAM to disk.
NOTE: To support new features and changes in the K2500 line of products, the internal program
structure has been changed from that of the K2000. Due to these changes, you cannot transfer a K2000
program to a K2500, or a K2500 program to a K2000 via MIDI system exclusive. The K2500 software
will continue to be enhanced, and in the future the K2500 will be capable of accepting K2000 programs
over MIDI. As a result of this, computer based K2000 editor/librarians will not currently work with the
K2500, unless they have been revised to accommodate the changes.
Common Format
In the following discussion, the fields of the K2500 System Exclusive Protocol messages are
notated as…
field(length)
…where ‘field’ is the name of the particular information field in the message, and ‘length’ is
either 1, 2, 3, or n, representing the number of sequential MIDI bytes that make up the field. A
length of ‘n’ means that the field is of a variable length that is determined by its contents or sub-
fields.
All K2500 SysEx messages have the common format:
sox(1) kid(1) dev-id(1) pid(1) msg-type(1) message(n) eox(1)
‘sox’ is always F0h, and represents start of System Exclusive.
‘kid’ must be 07h, and is the Kurzweil Manufacturer ID.
‘dev-id’ is Device ID. The K2500 will recognize a SysEx message if the ‘dev-id’ is the same is the
SysX ID parameter from the MIDI Receive page (from the top level, press the MIDI mode
button and the RECV soft button.) If the K2500’s SysX ID parameter is set to 127, it will
recognize SysEx messages no matter what the ‘dev-id’ is.
‘pid’ is the Product Identifier, and must be 78h (120 decimal), indicating the SysEx message is
for the K2500.
‘msg-type’ is the identifier of one of the K2500 SysEx messages defined below, and ‘message’ is
the variable-length message contents.
‘eox’ is always F7h, for end of System Exclusive.
Data Formats
K2500 SysEx messages are subdivided into fields that contain data in different formats. The
various fields are shown in the Messages section below. Within a message, any fields for values
that can be bigger than 7 bits are broken into 7 bit chunks. Thus two MIDI bytes gives 14 bits,
three bytes gives 21 bits. The significant bits are right justified in the field. All bytes in a field
must be present no matter what the value is. For example, an object type of 132 would be split
into two MIDI bytes in a ‘type’ field as 01 04:

Kurzweil K2500 - PERFORMANCE GUIDE REV F PART NUMBER 910252 CHAP 11 Specifications

General

Brand	Kurzweil
Model	K2500 - PERFORMANCE GUIDE REV F PART NUMBER 910252 CHAP 11
Category	Synthesizer
Language	English

Summary

System Exclusive Protocol

Common Format

Defines the standard structure of K2500 SysEx messages, including fields like SOX, KID, DEV-ID, PID, MSG-TYPE, MESSAGE, EOX.

Data Formats

Explains how data is transmitted in SysEx messages, including nibble and bit-stream formats, and 7-bit chunking.

Messages Overview

Core Object Messages

DUMP Message

Requests the K2500 to send a data dump of an object or portion thereof.

LOAD Message

Writes data into a specified object in the K2500's memory.

DACK and DNAK Messages

Acknowledge load success (DACK) or indicate load failure with a code (DNAK).

DIR and INFO Messages

DIR requests object information; INFO is the response providing object details.

NEW and DEL Messages

NEW creates an object; DEL deletes an existing object.

Data Transfer and Read Messages

CHANGE Message

Modifies an existing object's name and/or ID number.

WRITE Message

Writes an entire object's data directly into the database.

READ Message

Requests the K2500 to send a WRITE message for a given object.

READBANK Message

Requests WRITE messages for multiple objects within one or all banks.

Bank and Memory Management Messages

DIRBANK Message

Requests INFO messages for objects matching type and bank specifications.

ENDOFBANK Message

Indicates the completion of READBANK or DIRBANK operations.

DELBANK Message

Deletes banks of objects (of specified types) from RAM.

MOVEBANK Message

Moves RAM objects from one bank to another, optionally by object type.

Macro and Panel Control Messages

LOADMACRO and MACRODONE Messages

LOADMACRO loads memory macro; MACRODONE acknowledges macro loading status.

PANEL Message

Simulates front-panel button presses by sending button codes and event types.

Object Types

Defines object types and their IDs used in K2500 SysEx protocol.

Parameter and Button Mapping

Master Parameters

Describes access to Master parameters using type 100 and ID 16.

Button Press Equivalence Table

Maps physical buttons on the K2500 to their hexadecimal SysEx codes.

Screen Interaction Messages

Screen Text and Parameter Access

Requests for screen text, parameter values, names, and graphics layers.

SCREENREPLY Message

The reply message for screen text, parameter value, name, and graphics requests.