Cyclone Automated Control Package
3
CONTENTS
1 Introduction ........................................................................................................ 5
1.1 Introduction to Cyclone Launch ................................................................... 5
1.2 Introduction to the Cyclone Control DLL ...................................................... 6
1.3 Introduction to RS232 / Ethernet Communication Protocols........................ 6
1.4 Library Files Included .................................................................................. 7
1.5 P&E Compatible Hardware.......................................................................... 7
1.6 Versions ...................................................................................................... 8
2 Software License ............................................................................................... 9
2.1 License for Basic and Professional Editions ................................................ 9
2.2 License for Enterprise Edition .................................................................... 10
2.3 P&E Software Licensing System ............................................................... 11
3 Getting Started with the Cyclone Control DLL.................................................. 12
3.1 Example Programs .................................................................................... 12
3.2 Starting your own project ........................................................................... 12
3.3 Initialization................................................................................................ 14
3.4 Finalization ................................................................................................ 15
3.5 Initial Cyclone Setup .................................................................................. 15
3.6 Typical Usage ............................................................................................ 16
3.7 External Memory Storage Support ............................................................ 17
4 Application Programming Interface (API) ......................................................... 18
4.1 Constants .................................................................................................. 18
4.2 DLL Loading / Unloading Calls .................................................................. 19
4.2.1
load_dll .......................................................................................... 19
4.2.2
unload_dll ...................................................................................... 19
4.2.3
enumerate_all_ports ...................................................................... 20
4.2.4
close_all_ports............................................................................... 20
4.2.5
version ........................................................................................... 20
4.3 Cyclone Connecting / Disconnecting Calls ................................................ 21
4.3.1
connect_to_cyclonepromax ........................................................... 21
4.3.2
connect_to_cyclonepromax_by_ip ................................................ 23
4.3.3
disconnect_from_cyclonepromax .................................................. 24
4.3.4
set_local_machine_ip_number ...................................................... 24
4.3.5
set_COM_port ............................................................................... 25
4.4 Controlling Cyclone Programming ............................................................. 26
4.4.1
START_execute_all_commands ................................................... 26
4.4.2
START_dynamic_program_bytes.................................................. 27
4.4.3
check_STARTED_cyclonepromax_status ..................................... 28
4.4.4
dynamic_read_bytes ..................................................................... 29
4.4.5
get_last_error_code....................................................................... 30
4.4.6
get_last_error_addr ....................................................................... 30
4.4.7
pro_set_active_security_code ....................................................... 31
4.5 Configuration / Image Maintenance Calls .................................................. 32
