SmartKeyProgrammer - UserGuide
SmartKeyProgrammer - UserGuide
User Guide
Index
Index ............................................................................................................................ 2
1 Introduction ................................................................................................ 3
5 Tab ............................................................................................................ 11
5.1 Startup ........................................................................................................ 11
5.2 Configuration ............................................................................................... 12
5.3 Kit Definition ................................................................................................ 13
5.3.1 App file.......................................................................................................................... 13
5.3.2 Autorun file .................................................................................................................... 16
5.3.3 Zip file .......................................................................................................................... 18
2
1 Introduction
The SmartKey Program is used to program the new Carel programmable SmartKey (PCOS00AKY00).
In addition to the key itself, the pCO SmartKey USB adapter (PCOS00AKC00) is also required, and
must be connected to the USB port on the computer.
For the hardware characteristics of the key and the adapter, see the corresponding instruction
sheets.
To be able to use the program, the VCP driver needs to be installed; this is same driver used by the
USB-RS485 converter (CVSTDUTLF0 or CVSTDUMOR0).
First connect the pCO SmartKey USB adapter (PCOS00AKC00), then the key to be programmed
and/or checked.
This program can also be used without the key, obviously with limited functions.
2 Work Area
The Work Area is made up of a series of panels indicated by tabs, which are enabled depending on the
operating mode selected by the user, and the type of key set.
4
3 Menu Area
This item is used to enable a guided system of steps for loading data to the key;
File / Guided
UpLoad
when each dialogue box is displayed, the ">>" button will appear at the bottom
right, to move to the next step
This item is used to enable a guided system of steps for downloading data from
File / Guided
DownLoad
the key; when each dialogue box is displayed, the ">>" button will appear at the
bottom right, to move to the next step
This item is used to set the serial port that the pCO SmartKey USB adapter is
connected to, in the following dialogue box:
Options / Config
Serial Port
The selection field lists the VCPs (Virtual Com Ports) available on the PC.
This item is used to set the program interface language, in the following dialogue
box:
Options /
Language
This item is used to set the default directory for downloading the Kits, in the
following dialogue box:
Options /
DownLoad Kit
Default Dir
Selecting "…" button opens the following dialogue box for selecting and/or
creating the desired directory:
5
This item is used to set the default directory for downloading the Logs, in the
following dialogue box:
Selecting "…" button opens the following dialogue box for selecting and/or
Options / creating the desired directory:
DownLoad Logs
Default Dir
Properties / This item is used to open a dialogue box showing information on the key
Firmware Info firmware, in the following dialogue box:
6
This item is used to open a dialogue box showing information on the key
memory, in the following dialogue box:
Properties /
Memory Info
This item is used to open a dialogue box showing information on the key
firmware:
Properties /
Advanced /
Upgrade Firmware
7
Selecting "…" button opens the following dialogue box, which already shows the
file where the program expects to find the firmware update (*.hex)
This item is used open a dialogue box for deleting the key memory:
Properties /
Advanced / Erase
memory
Properties / This item is used to open a dialogue box with all the information on the key FAT,
Advanced / Fat
Info
in the following dialogue box:
8
? / Help This item is used to open this Help document
This item is used to open the dialogue box that identifies the program currently
? / About
being used
9
4 File Kit
The file kit is the list of the files required for the operation of a pCO, and that are compressed and
suitably converted for transfer to a SmartKey.
The kit also contains information on the type of pCO that the kit will be downloaded onto, and on the
list of pLAN addresses that the application has been prepared for.
10
5 Tab
5.1 Startup
This is the first panel displayed by the program, and is used to set the port for communication between
the program and the SmartKey, to select the language so as to better understand the messages shown
in the program, and to set the program for operation with or without the key inserted.
The "Select Language" drop-down list is used to select the language for the messages displayed by the
program, so as to notify the user of the various settings or problems.
The "Select Serial Port" drop-down list is used to select the port for communication between the key
and the computer. The program only lists the Virtual Com ports connected to the various Carel devices.
The "Key Set" options are used to establish whether the program communicates directly with a key,
"With Key", or alternatively it operates without a key connected, "Without Key".
The first time that the program is run, the language and the serial port need to be set; after this, the
values set previously will be loaded by default. These values can still be modified at any time.
The "Go" button sets the parameters shown on the panel and opens the "Config" panel.
11
5.2 Configuration
This panel is used to change the type of key, so as to completely reprogram it, enable and set the
password to access the key from the PC, and set or modify the password required for the key to access
the pCO.
The "Smart Key Type" options are used to modify the type of key connected.
1. Read Software - only reads data from the key, loading applications or Bios files
2. Write Software - only writes applications to the key
3. Read/write - Software; reads from the key and writes applications or Bios to the key
4. Read Logs - reads the log files downloaded from a pCO
5. Read Logs/Software - reads the log files downloaded from a pCO and the application files
6. Read Logs Microchiller 3 - reads the log files downloaded from a Microchiller 3
7. Read/Write SW - Read logs; reads the log files downloaded from a pCO and reads and/or writes
the application files from/to the key
12
5.3 Kit Definition
This panel is used to create 3 types of files:
Selecting APP checkBox in the "Export" section, you can create an App file that is compatible with
uploading an application to the controller via SmartKey.
13
In the "pCO Settings" section, the "pCO Type" drop-down list is used to select the type of pCO terminal
that the file kit is to be loaded onto and the "pCO Model" drop-down list is used to select the pCO model
of the current pCO Type.
In the "pCO Settings" section, checking the "pLan Address" box activates the "Select" button, which is
used to set the addresses of the terminal that the file kit is to be loaded onto, using the following
dialogue box:
Select the numbers of the terminal that the file kit is to be loaded onto, and then select "Ok"
If the "pLan Enable" check box is not selected, the kit is not to be used on a pCO in the network.
Into the BIOS region, you can add a BIOS file to the App file. This allows you to load application and
BIOS into the pCO.
The "Directory" field is used to enter the name of the directory for selecting the files to be included in
the Kit; the directory can also be selected using the "..." button, which opens the following dialogue
box:
The "Directory content" list shows the files located in the previously selected directory and that can be
included in the Kit.
14
The "<<" and ">>" buttons can be used to add or remove selected file to/from the Kit.
The "<<<" and ">>>" buttons can be used to add or remove all files in list to/from the Kit.
The "File Selected" list shows the files that have been added to the Kit.
Selecting the "Save Kit" button saves the kit with the corresponding settings.
15
5.3.2 Autorun file
Selecting Autorun checkbox in the "Export" section, you can export an 'Autorun.txt' file and a folder
containing all files that are compatible with the USB key.
In the "pCO Settings" section, the "pCO Type" drop-down list is used to select the type of pCO terminal
that the file kit is to be loaded onto and the "pCO Model" drop-down list is used to select the pCO model
of the current pCO Type.
In the "Setting" section, the "Mode" drop-down list can take two values: Upload or Download.
With Mode = "Upload", you can choose between two functions: "Upload Application" and "Upload DEV".
The first loads the entire application while the second function only loads the DEV file.
In "Upload Application" mode, you can add a BIOS file to the Autorun. This allows you to load
application and BIOS into the pCO.
With Mode = "Download", you can choose between three functions: "Download Application", "Download
Logs" and "Download DEV". The first download the entire application, the second download only the
logs and the third function only download the DEV file from the pCO.
16
The "Directory" field is used to enter the name of the directory for selecting the files to be included in
the Kit; the directory can also be selected using the "..." button, which opens the following dialogue
box:
The "Directory content" list shows the files located in the previously selected directory and that can be
included in the Kit.
The "<<" and ">>" buttons can be used to add or remove selected file to/from the Kit.
The "<<<" and ">>>" buttons can be used to add or remove all files in list to/from the Kit.
The "File Selected" list shows the files that have been added to the Kit.
Selecting the "Export" button saves the Autorun and the folder within the files, with the corresponding
settings.
The pCO, when a USB key is connected, reads the key and if it finds a file called "Autorun.txt", it
interprets it and performs the operations written inside it, which can be either Upload or Download
functions.
17
5.3.3 Zip file
Selecting Zip File checkBox in the "Export" section, you can generate a zip file compatible with pCOWeb
or tERABox.
In the "pCO Settings" section, the "pCO Type" drop-down list is used to select the type of pCO terminal
that the file kit is to be loaded onto and the "pCO Model" drop-down list is used to select the pCO model
of the current pCO Type.
In the "Setting" section, the drop-down list "Destination" is used to indicate which will be the final
destination of the package you are going to create.
With Destination = "pCOWeb" the final destination will be pCOWeb and with Destination = "tERABox"
the final destination will be tERABox.
The "Directory" field is used to enter the name of the directory for selecting the files to be included in
the Kit; the directory can also be selected using the "..." button, which opens the following dialogue
box:
18
The "Directory content" list shows the files located in the previously selected directory and that can be
included in the Kit.
The "<<" and ">>" buttons can be used to add or remove selected file to/from the Kit.
The "<<<" and ">>>" buttons can be used to add or remove all files in list to/from the Kit.
The "File Selected" list shows the files that have been added to the Kit.
Selecting the "Export" button saves the Autorun and the folder within the files, with the corresponding
settings.
If the size of all the selected files exceeds the maximum limit provided by pCOWeb and/or tERABox, an
error (in red) or a warning (in yellow) will be reported that will alert the user of the overrun.
19
5.4 Kit Upload
This panel is used to load one or more kits onto the key.
The "Directory" field is used to enter the name of the directory for selecting the kit to be saved to the
key; the directory can also be selected using the "Browse" button, which opens the following dialogue
box
20
The "Available kits" list shows the kits available in the previously selected directory.
The "<<" and ">>" buttons are used to add the files selected from the list of kits in the directory to the
list of kits to be loaded to the key.
The "Selected kits" list is used to show the kits selected for the key.
21
5.5 Kit Download
This panel is used to download the contents of the key to the hard disk.
In the "Directory" field, enter the name of the directory where the kits downloaded from the key are
saved; the directory can also be selected using the "..." button, which opens the following dialogue box
22
The "Key content" list displays the kits contained on the key.
The "<<" and ">>" buttons can be used to select the kits to be downloaded to the hard disk on the PC.
The "<<<" and ">>>" buttons can be used to add or remove all files in list to/from the Kit.
The "Selected kits" list shows the kits selected on the key to be copied to the previously set directory.
The "Download" button then downloads the selected kits to the hard disk on the PC.
The "Kit erase" button is used to delete the Kits in the "Selected Kits" list from the key.
The "All files" check box selects all the files in the "Key content" list and adds them to the "Selected
Kits" list.
23
5.6 Logs
This panel is used to download the log files from the key to the hard disk.
The "Directory" field is used to enter the name of the directory where the Logs downloaded from the
key are saved; the directory can also be selected using the "..." button, which opens the following
dialogue box:
24
The "Key Log Content" list shows all the Logs loaded on the key.
The ">>" and "<<" buttons select or deselect the files to be downloaded to the hard disk.
The "<<<" and ">>>" buttons can be used to add or remove all files in list to/from the log.
The "Selected Log Files" list shows all the Logs selected to be downloaded.
The "All Files" check box is used to select all the Logs on the key.
The "Download" button is used to physically download the selected Logs to the hard disk.
The "Log Erase" button is used to physically delete the selected Logs from the key.
25
5.7 DWL Converter
This feature allows to split files contained within a DWL file (eg BLB, IUP, GRP) from downloading an
application via the SmartKey.
“Source file” is the path of the DWL file downloaded through SmartKey to be split into the various files
contained within it.
“Destination Folder” is the destination folder path where the various files in the selected DWL will be
extracted.
After clicking “Convert” you will be notified via message box of the result of the performed operation.
26
6 LEDs and Buttons
The different operating modes described in the table below can be configured using the program
running on the PC. This program can also be used to load the software to the key, or alternatively
transfer the logs from the pCO or chiller3 to hard disk.
Copy software from pCO to pCO (bios, application, Switches the key from
C*
parameters,…) write mode to read mode
*: Default mode
The key is factory-set in read/write mode (type C), allowing it to be used immediately to transfer the
software from one controller to another.
When the key is connected to the personal computer, the symbols have the following meanings:
The programming key is compatible starting from Bios version 3.43 and Boot version 3.01. For more
detailed information on programming the key, see the pCO Manager program manual.
27
6.2 Using the Smart Key with the pCO
Switch off the pCO, remove any peripherals connected in the pLAN and plug the key into the telephone
connector on the controller. When switching on again, all the symbols light up momentarily and the
buzzer emits a beep.
A few seconds later the key becomes operational. During this period the symbols will flash.
The controller then enters programming mode and the start button lights up steadily.
Press the button to start data transfer.
Important: If the key is type B, C or G (in write mode) pressing the start button will immediately delete
the software already loaded on the pCO.
Important: Do not remove the key while data is being transferred to the key itself, as the fi le being
transferred will be lost and the corresponding space will not be restored.
To restore the original capacity all the fi les will need to be deleted. If the key is type “C” or “G”, simply
perform a new application read operation.
Flashing: the key is connecting to the pCO. During this phase, which may last
a few seconds, the start button is disabled.
start Flashing: the key has detected the pCO and is checking the access permission.
start + On steady: pressing the start button will start writing the software to the pCO.
On steady: pressing the start button will start reading the software from the
start +
pCO.
On steady: pressing the start button will start reading the logs from the pCO.
start +
If the key is type C of G, pressing the “mode” button for 1 second switches between read, read logs (G
only) and write modes. The symbols (write to pCO), (read from pCO), (read logs) identify the
selected status. If the key is not type “C” or “G”, the “mode” button is disabled and off.
The “start” button starts the read or write operation, indicated by the flashing of the corresponding
symbol ( or ), at an interval proportional to the progress of the operation.
When the operation is completed, the buzzer will sound intermittently for 2 seconds. Pressing the
“start” button again will make the buzzer sound without repeating the operation. To repeat the
operation, the key must first be unplugged.
In case of error, the symbol comes on, together with the other LEDs.
The table below lists the causes of the problems.
28
Errors before pressing the START button:
Communication error: no
response from the pCO.
+ + flashing
Or: Key firmware version is
incompatible.
29