User Manual - Sütron electronic GmbH
Contents
1. uint CP3Enablelnts void Description Enable Interrupts Supported prod S Line uct lines M Line P Line Parameter Return value Always TRUE uint CP3Disablelnts void Description Disable Interrupts Supported prod S Line uct lines M Line P Line Parameter Return value Always TRUE void CP30EMResetTerminal Description Restart operating device Supported prod S Line uct lines M Line P Line Parameter Return value bool CP3OEMRestoreDefaultRegistry Description Restore default registry Supported prod S Line uct lines M Line P Line Parameter Return value Success TRUE Error FALSE S 2 7 SUTRON CP3Api bool CP30EMinterruptinitialize dword dwSysintr handle hHwintEvent Description Calls kernel function Interruptinitialize Supported prod uct lines M Line Parameter dwSysintr Interrupt number hHwintEvent Handle to event Return value Success TRUE Error FALSE bool CP3OEMInterruptDone dword dwSysintr Description Calls kernel function InterruptDone Supported prod uct lines M Line Parameter dwSysintr Interrupt number Return value Success TRUE Error FALSE bool CP30EMinterruptDisable dword dwSysintr Description Calls kernel function InterruptDisable Supported prod uct lines2. n 2 2 2 Memory CP3GetRamSelection HardwareAccessMethods REM RAM SEL ramSel HardwareAccessMethods CP3GetRamSelection amp ramSel string RamSize ramSel dwRamSize ToString string PLCRam ramSel dwPLCRam ToString string VisuRam ramSel dwVisuRam ToString string ResRam ramSel dwReservedRam ToString string PLCSize ramSel dwPLCSize ToString string VisuSize ramSel dwVisuSize ToString string ResSize ramSel dwReservedSize ToString PLC Pointer Size uint Size uint pData HardwareAccessMethods CP3GetPLCDataPointer amp Size if pData null pData Oxa5a5a5a5 string PLCDataSize Size ToString 2 2 3 Display private unsafe void numUpDown_Bright_ValChanged object sender EventArgs e use NumericUpDown control byte bdata byte numUpDown_Bright Value HardwareAccessMethods CP3SetBrightness amp bdata A 2 SUTRON CP3Api SUTRON D S TRON
3. 2 17 2 2 3 EI EE 2 17 i Overall Table of Contents SUTRON Important Notes 1 Important Notes al BB gt 1 1 Symbols The symbols in this manual are used to draw your attention on notes and dangers This is the safety alert symbol It is used to alert you to potential personal injury haz ards Obey all safety messages that follow this symbol to avoid possible injury or death DANGER This indicates a hazardous situation which if not avoided will result in death or seri ous injury WARNING This indicates a hazardous situation which if not avoided could result in death or se rious injury CAUTION This indicates a hazardous situation which if not avoided could result in minor or moderate injury NOTICE This symbol together with the signal word NOTE and the accompanying text alert the reader to a situation which may cause damage or malfunction to the device hard ware software or surrounding property Reference to source of information This symbol and the accompanying text provide the reader with additional informa tion or refer to detailed sources of information 1 2 Safety Notes Read this manual carefully before using the software Keep this manual in a place where it is always accessible to all users The user manual in particular the safety notes must be observed by all person nel working with the software and the programmed device Observe the accident prevention rul
4. M Line Parameter dwSysintr Interrupt number Return value Success TRUE Error FALSE bool CP3OEMReleaseSysintr dword dwSysintr Description Calls kernel function ReleaseSysintr Supported prod uct lines M Line Parameter dwSysintr Interrupt number Return value Success TRUE Error FALSE 2 8 S SUTRON CP3Api 2 1 5 Sound void CP3Buzzer ushort Buzzerstate Description Activate deactivate beeper Supported prod S Line uct lines M Line P Line Parameter Buzzerstate 0 Off 1 On Return value uint CP3SetHornState byte State Description Activates deactivates the beeper at maritime operating de vices Supported prod S Line uct lines M Line Parameter Buzzerstate 0 Off 1 On Return value Success TRUE Error FALSE 2 1 6 System bool CP3BattLow void Description Read battery state Supported prod S Line uct lines M Line Parameter Return value TRUE Battery weak or not available FALSE Battery OK ushort CP3TempHigh void Description Read CPU temperature Supported prod M Line uct lines P Line Parameter Return value Success Temperature in degree centigrade Error O or 1 S 2 9 SUTRON CP3Api ushort CP3VoltageHighLow void Description Re
5. Return value Always TRUE 2 1 9 Bus modules uint CP3BusModulPointer uint pSize Description Read bus module memory size Supported prod S Line uct lines M Line Parameter pSize Uint pointer contains size of allocated memory Return value Success Start address of allocated memory Error NULL uint CP3SetHalfDuplexMode bool bOn Description Half full duplex mode Supported prod M Line uct lines Parameter bOn 0 Full duplex 1 Half duplex Return value Success TRUE Error FALSE S 2 15 SUTRON CP3Api bool CP30EMGetIntNumber pdword pdwSysintr Description Interrupt number of bus module Supported prod M Line uct lines Parameter pdwSysintr Dword pointer contains interrupt number Return value Always TRUE 2 16 SUTRON CP3Api 2 2 Examples 2 2 1 System CP3ReadIds HardwareAccessMethods READIDS readIDs HardwareAccessMethods CP3ReadIds amp readIDs tring GruplaRev readIDs GruplaRev ToString tring IBRev readIDs IBRev ToString tring DisplId readIDs DisplId ToString tring IbsId readIDs IbsId ToString tring BatOk readIDs BatOk ToString Hn HH DN CP3TempHigh CP3VoltageHighLow tring TempHigh HardwareAccessMethods CP3TempHigh ToString tring Vin HardwareAccessMethods CP3VoltageHighLow ToString n
6. pointer with new value Return value Success TRUE Error FALSE bool CP3SetBrightnessNR LPBYTE pbWriteData Description Set brightness Valid range from 1 dark 31 bright Registry will not be saved Supported prod S Line uct lines M Line P Line Parameter pbWriteData Byte pointer with new value Return value Success TRUE Error FALSE uint CP3GetBrightness LPBYTE pbReadData Description Read brightness Valid range from 1 dark 31 bright Supported prod S Line uct lines M Line P Line Parameter pbReadData Byte pointer with read value Return value Success TRUE Error FALSE void CP30EMBacklight bool bBackLight Description Switch backlight on off Supported prod S Line uct lines M Line P Line Parameter bBackLight 0 Off 1 On Return value S 2 3 SUTRON CP3Api bool CP30EMGetColorDepth PDWORD pdwColorDepth Description Read color depth in bpp Supported prod S Line uct lines M Line P Line Parameter pdwColorDepth Dword pointer with read value Return value Success TRUE Error FALSE bool CP3O0EMSetColorDepth PDWORD pdwColorDepth Description Set color depth in bpp Supported prod S Line uct lines M Line Parameter pdwColorDepth Dword pointer with color depth Return value Success TRUE Error FALSE bool
7. CP3AlarmBrightness BYTE State Description Set brightness in case of alarms Supported prod S Line uct lines M Line Parameter State 1 Brightness is set to value 15 0 Brightness is set to initial value Return value Success TRUE Error FALSE bool CP30EMChangeDisplayMode DWORD displayOrientation Description Set display orientation Restart required Supported prod S Line uct lines M Line P Line Parameter displayOrientation Possible values are 0 90 180 270 Return value Success TRUE Error FALSE 2 4 SUTRON CP3Api uint CP3GetDisplayMode PBYTE pbMode Description Read display orientation Supported prod S Line uct lines M Line P Line Parameter pbMode Pointer to current orientation 0 90 180 270 Return value Success TRUE Error FALSE 2 1 3 Screensaver bool CP30EMGetUserldle PDWORD pdwidleTime Description Gets user idle time no user input Supported prod S Line uct lines M Line Parameter pdwldleTime Dword pointer on idle time Return value Success TRUE Error FALSE bool CP3OEMResetUserldle Description Set user idle time to 0 Supported prod S Line uct lines M Line Parameter Return value Success TRUE Error FALSE bool CP30EMDimBacklight bool active dword time dword value Description The backl
8. SSS GS SUTRON P User Manual CP3Api Functions Part Number 80860 796 Version 1 Date 2012 02 07 Valid for CP3Api Functions Version Date Modifications 1 2012 02 07 First edition This manual including all illustrations contained herein is copyright protected Use of this manual by any third party in departure from the copyright provision is forbidden No part of this manual may be reproduced trans lated or electronically or photographically archived or altered without the express written consent from S tron electronic GmbH Violations shall be cause for damage liability S tron electronic reserves the right to make any changes that contribute to technical improvement S SUTRON Overall Table of Contents Overall Table of Contents D S TRON 1 ageet A eu 1 1 1 1 SYMPOIS sacer inania tana aeiae ire danse E aaa tn re eeee hee sert e ent 1 1 1 2 Safety Notes putain in alse RANE wie 1 1 1 3 Intended Use sissanta EDER nde 1 1 1 4 Target Group sisi 1 2 2 Cb nt nerne nn rn ner n rn re renere nerne nerne rer rree 2 1 2 1 FUNCIONS ES TR Ee E eege 2 1 2 1 1 MOMON ES 2 1 2 1 2 DISplA V5 ene piv ET eee ES Sege SSR REE ES E EDEN ES 2 3 2 1 3 SCTEENSAVET ind nerne E tennene 2 5 2 1 4 Central Processing Unit 2 7 2 1 5 SOUNG WT 2 9 2 1 6 SYSTE e M ii do tin ds ne 2 9 2 1 7 Watchdog TEE 2 14 2 1 8 ITA eil 2 15 2 1 9 BUS le e DU 2 15 2 2 EXAMPISS 5 eme te mnt een 2 17 2 2 1 EE 2 17 2 2 0 TO el E
9. ad input voltage Supported prod M Line uct lines Parameter Return value Success Input voltage in volt Error 0 uint CP3ReadKeySwitch Ipbyte pbReadData Description Read key switch optional Supported prod S Line uct lines M Line Parameter pbReadData Pointer to 1 byte Possible values 0x07 Reset OxOE Stop Ox0D Run OxOB Prog Return value Always TRUE bool CP30EMGetMacAddress pword pwMACAddress Description Read MAC Address Supported prod S Line uct lines M Line P Line Parameter pwMACAddress Pointer to word 3 array contains MAC Return value Success TRUE Error FALSE bool CP30EMGetSerNumber Ipcwstr serNumber Description Read serial number Supported prod S Line uct lines M Line P Line Parameter serNumber Pointer to tchar 16 array contains serial number Return value Success TRUE Error FALSE 2 10 SUTRON CP3Api bool CP30EMGetSWBundleVersion Ipcwstr swBundleVersion dword BundleSize Description Read bundle version Supported prod S Line uct lines M Line P Line Parameter swBundleVersion Pointer to string buffer BundleSize Pointer to buffer size Contains the required size in fault case return value False if the buffer is too small Return value Success TRUE Error FALSE bool CP3OEMGetHWFWVersion Ipcwstr hwfwVersion dwo
10. ds Pointer to READIDS structure Return value Always TRUE READIDS uchar GruplaRev uchar IBRev S TRON 2 13 CP3Api READIDS uchar Displld Display IDs OxC 5 7 STN OxB 5 7 TFT OxA 10 4 TFT 0x9 5 7 Mono 0x8 3 8 Mono 0x7 160x80 Mono 0x6 3 8 Mono 0x5 5 7 Mono 0x4 7 TFT 0x3 3 5 TFT 0x2 12 1 TFT 0x1 15 1 TFT uchar Ibsid uchar BatOk 0 Battery weak or not available 1 Battery OK 2 1 7 Watchdog void CP3OEMSetWatchDog bool bEnable Description Enable disable watchdog Supported prod uct lines S Line M Line P Line Parameter bEnable 0 Disabled 1 Enabled Return value void CP3OEMTriggerWatchDog Description Watchdog must at least be triggered once per second Supported prod uct lines S Line M Line P Line Parameter Return value 2 14 SUTRON CP3Api 2 1 8 In Outputs uint CP3ReadlO Ipbyte pbReadData Description Read in outputs Supported prod M Line uct lines Parameter pbReadData Pointer to 1 Byte Each bit corresponds to one in output Return value Always TRUE uint CP3WritelO Ipbyte pbWriteData Description Write to in outputs Supported prod M Line uct lines Parameter pbWriteData Pointer to 1 Byte Each bit corresponds to one in output
11. er touchFlag Pointer to flag 1 Operating device has a touch 0 Operating device does not have a touch Return value Success TRUE Error FALSE bool CP30EMGetTouchType pword pwTouchType Description Read touch type Supported prod S Line uct lines Parameter pwTouchType Pointer to type 1 External USB touch 0 Internal touch Return value Success TRUE Error FALSE bool CP30EMGetKeyFlag pword pdwKeyFlag Description Read key flag Supported prod M Line uct lines Parameter pdwKeyFlag Pointer to flag 1 Operating device has keys 0 Operating device does not have keys Return value Success TRUE Error FALSE 2 12 SUTRON CP3Api bool CP3OEMGetProfinetFlag pword pwProfinetFlag Description Read PROFINET flag Supported prod M Line uct lines Parameter pwProfinetFlag Pointer to flag 1 Operating device supports PROFINET 0 Operating device does not support PROFINET Return value Always TRUE bool CP3OEMGetFlashSize pword pdwFlashSize Description Read flash size Supported prod S Line uct lines M Line Parameter pdwFlashSize Dword pointer contains flash size in byte Return value Success TRUE Error FALSE uint CP3Readids READIDS psReadids Description Read system IDs Supported prod M Line uct lines S Line Parameter psReadl
12. es and regulations that apply to the operating site Installation and operation must only be carried out by qualified and trained per sonnel 1 3 Intended Use The software has to be used for programming operating devices exclusively Ev ery other use is not permitted 1 1 S TRON Important Notes 1 4 Target Group All configuration and programming work in connection with the automation system must be performed by trained personnel only e g qualified electricians electrical en gineers The configuration and programming personnel must be familiar with the safety con cepts of automation technology 1 2 S SUTRON CP3Api 2 CP3Api The CP3Api functions can be used on operating devices with the operating system Windows CE 6 0 2 1 Functions 2 1 1 Memory uint CP3GetRemMemorySize void Description Size of the complete RAM memory NVRAM SRAM Supported prod M Line uct lines S Line Parameter Return value Success Memory size in bytes Error 0 void CP3GetRamSelection PT_REM_RAM_SEL psNVSRam Description Size of the available RAM memory Supported prod M Line uct lines S Line Parameter psNVSRam Pointer to REM RAM SEL structure Return value RAM memory allocation REM_RAM_SEL dword dwRamSize Total size of remanent memory in bytes dword dwPLCRam Size of the PLC RAM in percent dw
13. ight can be dimmed after an idle timeout of the user inputs Supported prod S Line uct lines M Line Parameter active 1 Dimming enabled 0 Dimming disabled time User idle timeout to dimm backlight value Dimming to this value Return value Success TRUE Error FALSE S 2 5 SUTRON CP3Api bool CP3O0EMBacklightOff bool active dword time Description The backlight can be switched off after an idle timeout of the user inputs Supported prod S Line uct lines M Line Parameter active 1 Dimming enabled 0 Dimming disabled time Idle timeout of the user inputs until backlight is switched off Return value Success TRUE Error FALSE bool CP3O0EMScreensaver bool active dword time Description The screensaver can be activated after an idle time of the user inputs Supported prod S Line uct lines M Line Parameter active 1 Screensaver enabled 0 Screensaver disabled time Idle time of user inputs till screensaver gets active Return value Success TRUE Error FALSE bool CP3O0EMRetriggerScreensaver Description Reset screen saver time on initial value Using after the call of CP30EMDimBacklight CP3OEMBacklightOff Supported prod S Line uct lines M Line Parameter Return value Success TRUE Error FALSE 2 6 SUTRON CP3Api 2 1 4 Central Processing Unit
14. ord dwPLCSize Size of the PLC RAM in bytes dword dwVisuRam Size of the Visu RAM in percent dword dwVisuSize Size of the Visu RAM in bytes dword dwReservedRam Size of the reserved RAM in percent dword dwReservedSize Size of the reserved RAM in bytes 2 1 S TRON CP3Api uint CP3GetPLCDataPointer uint pSize Description Pointer to memory area for the PLC Supported prod M Line uct lines S Line Parameter pSize Uint pointer with size of allocated memory Return value Success Start address of allocated PLC memory Error NULL uint CP3GetVisuDataPointer uint pSize Description Pointer to memory area for the visualization Supported prod M Line uct lines S Line Parameter pSize Uint pointer with size of allocated memory Return value Success Start address of allocated Visu memory Error NULL bool CP3FreeMemory uint pMem Description Release PLC visualization memory PLCDataPointer VisuDataPointer Supported prod S Line uct lines Parameter pMem Uint pointer to memory to be released Return value Success TRUE Error FALSE 2 2 SUTRON CP3Api 2 1 2 Display bool CP3SetBrightness LPBYTE pbWriteData Description Set brightness Valid range from 1 dark 31 bright Registry will be saved Supported prod S Line uct lines M Line P Line Parameter pbWriteData Byte
15. rd HWFWSize Description Read firmware version Supported prod S Line uct lines M Line P Line Parameter hwfwVersion Pointer to string buffer HWFWSize Pointer to buffer size Contains the required size in fault case return value False if the buffer is too small Return value Success TRUE Error FALSE bool CP30EMGetConfigBlockVersion Ipcwstr configBlockVerson Description Read config block version Supported prod M Line uct lines Parameter configBlockVerson Pointer to word 16 array contains version Return value Always TRUE bool CP30EMGetimageName Ipcwsir imageName dword nameSize Description Read name of the Windows CE image including version Supported prod S Line uct lines M Line P Line Parameter imageName Pointer to string buffer nameSize Pointer to buffer size Contains the required size in fault case return value False if the buffer is too small Return value Success TRUE Error FALSE S 2 11 SUTRON CP3Api bool CP30EMGetDeviceName Ipcwstr deviceName Description Read device name Supported prod S Line uct lines M Line P Line Parameter configBlockVerson Pointer to tchar 16 array contains name Return value Always TRUE bool CP30EMGetTouchFlag pword touchFlag Description Read touch flag Supported prod S Line uct lines M Line Paramet
Download Pdf Manuals
Related Search