PM-213x-CAN with I-8120W_SDK_UserManual_En
Contents
1. OK I8120PM_SlotNumberError 10003 Slot No is error I8120PM_PMIDNotExist 1000 The ID of the power meter does not exist in the I 8120W PMError_NoSetCMD 1030 No Set New ID command was sent PMError_NoResp 1031 There is no response message from the power meter 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 47 3 4 The Flow Chart of the Development 3 4 1 The Flow Chart of the Fast Development The users can use PAC_CAN_Power_Meter software utility to configure the response time and other parameters After configuring those parameters the settings would be saved into the I 8120W Then the users can use your familiar development tools to collect all power meter information We illustrate the steps described previously The Flow Chart of the Fast Development After configuring by PAC_CAN_Power_Meter You can save the setting into the I 8120W 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 48 3 4 2 The Flow Chart of the General Development The users can design your own software including the configuration of the automatic response time and those parameters The users can design your own interface and operation method We show the flow chart of the general development as below General Operation 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 49 d PAC_CAN_Power_Meter Software Utility DAC2. the CAN bus occurs some errors 1 ERR LED twinkle It represents the CAN in error situation This error sometime caused by the following reasons a Check if the baud rate between I 8120W and power meters is unequal b Check if the terminal resistances only added on both the end of the CAN bus c Check if the CAN High and CAN Low has wrong connection d Check if the CAN bus is connecting with the power meters I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 13 2 6 Update the I 8120W s Firmware l 8120W module should be loaded the power meter management firmware PMPAC_xx exe This module will manage and collect the data of the power meter When first time using I 8120W or upgrade the power meter firmware the module need to update the firmware You can follow the simple instructions below You will complete updating the firmware A Prepare the I 8120W software utility 18120W_UTILITY exe You can download it from the FTP site of ICP DAS as below ftp ftp icodas com pub cd fieldbus cd can slotmodule i_8120w tools wince5 B Prepare the power meter management firmware PMPAC_xx exe xx is the version number You can download it form the FTP site of ICP DAS as below ftp ftp icodas com pub cd fieldbus cd can slotmodule i_8120w powermeter firm ware C Change the Jumper of the I 8120W You need to disable the Flash protection functionality as shown below CAN Port
3. CAN Power Meier manages CAN bus power meters The utility need to work with the I 8120W module which has loaded power meter management firmware The utility interface looks like the following picture when it has started GAN Power Meter GES v1 2 Power Meter a Parameter CAN bus Status WI 2 gi a CAN Power Meter CE5 w1 2 131 2 41 PM m E I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 50 4 1 Activate I 8120W Module Please check the slot No which the I 8120W is plugged in The users can select the correct number in the field of Slot No And then click the Active button to active the I 8120W The following picture shows the detail steps CAN Power Meter GES ie bal Gm gaz Gm ox03 o 0x04 Gm oxos Gm 0x06 w 0x07 Gm oag o oac Gm oan Gm oxae Gm oxar kvarh 537366800 00000 Gm OxBO kvah 0 00001 kV Ah 2048 00000 Faj CAN Power Meter CES v1 1 ven Lt 2 14 PM A E I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 51 4 2 Reset the Firmware in the I 8120W When changing the important setting the users need to restart the firmware to make the new setting enable The users can click the Reset button to reset the firmware Here shows the detail steps CAN Power Meter CES yi 1 I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 1
4. I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 14 D Update the firmware within the I 8120W 1 Run the I 8120W software utility I8120W_UTILITY exe HE MBE BSW HBG az 2 XM By i8120 i8120w_u I 8120W Utility Yer 1 00 Filter Setting Hex Baud Setting Hex Slot NO v SE g Hex Msg Format Acc Code jooo00000 125K bps Baud Care Gre Dec Update Firmware Acc Mask FFFFFFFF evo FF enk O asc Enable Sys Ms CAN Status Se g CAN Status Hex zum Clear Status Pause Rx Msg Buffer Disab Rx Msg Cnt tet Roset Counter Tx Msg Buffer Time 100us Show message on the list SaveToFile Send CAN Message 11 bit 1p __1D Hex Len Data Hex separated by space 20 bit 1p BI RTR E FF FF FF FF FF FF FF FF Send 2 Select the slot number of the l 8120W 1 8120W Utility Ver 1 00 Filter Setting Acc Code f Slot NO Slot 0 Acc Mask f CAN Status CAN Status Rx Msg Cnt Firmware cm1s107 exe Modified 2010 2 11 10 4 22 Size 112182 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 15 4 Click the Update button and select the firmware PMPAC_xx exe xx is the version number Open 9 Ki OK X BJ System_Disk Demo Eaoco ze 148139 bytes Type Execution Files exe M 5 After clicking the OK button it will load the firmware automatically TT Firmw
5. ID fold ID 0x02 Change to New ID v New Power Meter ID ee ps e Step 2 Click the Change to New ID button to change to the new ID Advanced Parameter Power Meter Parameter Change ter 1D J HH 1 2 Pin 5 ON and Pin 6 ON CAN Baud Rate 500 kbps Old Power Meter ID ES ID 0x02 v Change to New ID New Power Meter ID NeWID QAK e I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 62
6. if the command has been sent successfully or not Users can use the 18120PM_SetNewPMIDResp function to read the response replied from the power meter Syntax DWORD 18120PM_SetNewPMIDCMD BYTE SlotNo BYTE OldPMID BYTE NewPMID Parameter SlotNo input The slot number which the I 8120W is plugged in OIdPMID input The original ID of the power meter NewPMID input The desired new ID of the power meter Return 1I8120PM_NoError 0 OK I8120PM_SlotNumberError 10003 Slot No is error I8120PM_PMIDNotExist 1000 The ID of the power meter does not exist in the I 8120W I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 46 3 3 27 18120PM_SetNewPMIDResp e Description After calling 18120PM_SetNewPMIDCMD the specific power meter will reply the result of the processed command This response will be kept in the I 8120W Therefore calling the function 18120PM_SetNewPMIDResp can read the response stored in the I 8120W to confirm if the setting is ok or not Before using this function users need to call the function 18120PM_SetNewPMIDCMD first Syntax DWORD 18120PM_SetNewPMIDResp BYTE SlotNo BYTE NewPMID DWORD RespValue Parameter SlotNo input The slot number which the I 8120W is plugged in NewPMID input The new ID of the power meter RespValue output Return the response value which has been replied from the power meter Return I8120PM_NoError 0
7. listed as below Industrial Control Farming Machine Aircraft electricity Vehicle Monitoring Semiconductor equipment Biotechnology and medical industry Reservoir and bridge safety Military industry Factory automation 10 HVAC System and equipment D OO d DA FWD gt 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 5 1 2 CAN bus Power Meter Applications Power Management in Bui Iding Q ka ICP DAS CO LTD http Awww icpdas com ss ICP DAS CO LTD http www icpdas com I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 6 1 3 Features of the CAN bus and Power Meter CAN bus Power Meter Features NXP TJA1042 CAN transceiver Follow CiA CAN 2 0B specification Support Auto Response mode and Polling mode Support baud rate 125 kbps 250 kbps and 500 kbps Support up to 255 nodes on the CAN network 2500 Vrms isolation on CAN port 4 kV ESD protection on CAN port CAN bus provides better capability in noise suppression Support arbitration mechanism to avoid collision Support error detection and error correction on CAN bus Operating Temperature is 10 C 70 C Illustration of the Polling mode Response Response 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 7 I 8120W Power Meter Firmware Features Philip SJA1000 CAN controller NXP 82C250 CAN tran
8. 03 Slot No is error I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 30 3 3 12 18120PM_GetAutoRespTime e Description This function could help to obtain the value of the automatic response time in the I 8120W e Syntax DWORD 18120PM_GetAutoRespTime BYTE SlotNo DWORD AutoRespTime e Parameter SlotNo input The slot number which the I 8120W is plugged in AutoRespTime output Return the automatic response time in millisecond e Return I8120PM_NoError 0 OK 1I8120PM_SlotNumberError 10003 Slot No is error 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 31 3 3 13 18120PM_StartAutoResp e Description This function could make all power meters to response power information automatically When calling this function the I 8120W will send command to all power meters If the power meter is responding information automatically the power meter will response information with new frequency e Syntax DWORD 18120PM_StartAutoResp BYTE SlotNo e Parameter SlotNo input The slot number which the I 8120W is plugged in e Return I8120PM_NoError 0 OK I8120PM_SlotNumberError 10003 Slot No is error I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 32 3 3 14 18120PM_StopAutoResp e Description This function would make all the power meters stopping to response information
9. 7 52 4 3 Start Stop Automatic Response When completing the wire connection of power meter the users can make all power meters to reply information automatically The users can click the Start button to achieve this functionality The picture below shows the detail steps CAN Power Meter CES v1 1 If pausing to reply is necessary the users can click the Stop button to make all the power meters break off The following picture shows the detail steps CAN Power Meter CES y1i 1 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 53 4 4 Parameter Configuration of Power Meter The users can configure the list of power meters and automatic response time by Parameter Configuration At the same time the users can check the version of the firmware and the DLL The users can click the Parameter button to show up the Parameter Configuration dialog Here shows the detail steps CAN Power Meter CES y1i 1 Selected Power Meter 40 Meters Selected Firmware Version DLL Version CAN Baud Rate Auto Response Time I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 54 4 4 1 CAN bus Baud Rate After clicking the Parameter button the users can see the following picture and select the desired baud rate After selecting the baud rate the users can click Set Baud Rate button to save the setting into the I 8120W T
10. 98 2 spec each terminal resistance is 120Q or between 1080 132Q 120Q GOZI CAN_L Figure 2 6 CAN bus network topology Moreover to minimize the voltage drop over long distances the terminal resistance should be higher than the value defined in the ISO 11898 2 The following table can be used as a good reference Bus Cable Parameters f Besten Terminal uS Ser Length Related meter SE Cross Section e Resistance Q Type mQ m 0 40 70 0 25 23AWG 124 0 1 0 34mm7 22AWG 40 300 lt 60 0 34 22AWG 127 0 1 0 6mm7 20AWG 300 600 lt 40 0 5 0 6mm 150 300 20AWG 600 1K lt 20 0 75 0 8mm 150 300 18AWG Table 2 4 Relationship between cable characteristics and terminal resistance I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 12 2 5 Indicator LED 2 5 1 PWR LED After the I 8120W powering on the PWR LED will also turn on 2 5 2 Tx Rx LED Tx Rx LED represents the status of the remote power meters 1 Tx Rx LED solid on It represents that all remote power meters are normal 2 Tx Rx LED twinkle It represents that at least one power meters occur errors This situation sometime represents that the power meter has no response or is out of order You can use l 8120W function call to realize what happens with those power meters 2 5 3 ERR LED ERR LED represents the CAN bus status When it turns on or twinkling
11. Description This function can set the CAN bus baud rate of the I 8120W After calling this function you must call 18120PM_ResetFirmware to reset the firmware to make change enabled e Syntax DWORD 1I8120PM_SetBaudRate BYTE SlotNo BYTE BaudRate e Parameter SlotNo input The slot number which the I 8120W is plugged in BaudRate input The baud rate of the CAN bus BaudRate 0 means that the baud rate is 125 kbps BaudRate 1 means that the baud rate is 250 kbps BaudRate 2 means that the baud rate is 500 kbps e Return I8120PM_NoError 0 OK I8120PM_SlotNumberError 10003 Slot No is error PMXS_BaudRateError 1051 Baud rate parameter is error I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 29 3 3 11 18120PM_SetAutoRespTime e Description This function is use to set the automatic response time of the power meter The users can change the frequency of the automatic response After setting new response time the users should call 1I8120PM_StartAutoResp or 18120PM_ResetFirmware to make the new setting enable The I 8120W will send command to all power meter for this new setting Syntax DWORD 18120PM_SetAutoRespTime BYTE SlotNo DWORD AutoRespTime Parameter SlotNo input The slot number which the I 8120W is plugged in AutoRespTime input The automatic response time in millisecond Return I8120PM_NoError 0 OK I8120PM_SlotNumberError 100
12. I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 60 4 6 2 The firmware version of the Power Meter After clicking the Advanced button the users can see the following picture You can select the desired power meter s ID to read the firmware version of the power meter The following picture shows the detail steps Advanced Parameter Power Meter Parameter Change Power Meter ID Power Meter ID ID 0x02 v Meter PT CT Ratio Meter Rati Dec Units 1 PT Ratio Dec Units 0 01 CT Rati Dec Unis 1 Read From Power Meter Write to Power Meter Firmware Version of the Power Meter Firmware Ver 0002 0 I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 61 4 6 3 Change the ID of the Power Meter After clicking the Advanced button and select the Change Power Meter ID page the dialog is popped up as below Before setting the ID of the power meter you should change the bit 5 and bit 6 of the DIP switch to be on first Then you can configure the ID of this power meter with the 500 kbps baud and the original software ID or the hardware ID set by DIP switch bit 1 bit 4 if you forget the original software ID The following picture shows the detail steps Step 1 Change to the page as below Advanced Parameter Baud Rate TERHERE 5 6 Pin 5 ON and Pin 6 ON CAN Baud Rate 500 kbps Old Power Meter
13. ID After selecting the power meter s ID the users need to click the Set Power Meter button to save the setting into the 8120W The following picture shows the detail steps Parameter Configuration ID 0x00 ID 0x01 ID 0x02 DLL Version 1 01 ID 0x03 ID 0x04 CAN Baud Rate 1125K bps v ID 0x05 ID 0x06 Set Baud Rate ID 0x07 ID 0x08 Auto Response Time 2500 ID 0x09 ID 0x04 ID 0x08 ID 0x0C ID 0x0D ID OxOE Set Power Meter Firmware Version In op 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 57 4 5 Display the Real Time Power Information If the users have never configured any power meter within the I 8120W you would not see the following picture If connecting and configuring the power meter please select any one power meter in the Power Meter filed The dialog on the right hand side would show the all power information The picture below shows the operation CAN Power Meter CE5 y1 1 Fad CAN Power Meter CES v1 1 8 vn Ar Zeta pn fi S 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 58 4 6 Advanced Parameter of Power Meter The users can configure the advanced ratio parameters in the power meter by Advanced Parameter At the same time the users can check the firmware version of the power meter The users can click the Advanced button to show up the Advanced Parameter
14. If needing to re start response information automatically the users can call 18120PM_StartAutoResp again e Syntax DWORD 18120PM_StopAutoResp BYTE SlotNo e Parameter SlotNo input The slot number which the I 8120W is plugged in e Return I8120PM_NoError 0 OK 1I8120PM_SlotNumberError 10003 Slot No is error I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 33 3 3 15 18120PM GetCANStatus e Description This function is used to get the current status of the I 8120W e Syntax DWORD 18120PM_GetCANStatus BYTE SlotNo BYTE CANStatus e Parameter SlotNo input The slot number which the I 8120W is plugged in CANStatus output Return the status of the I 8120W The data would be the following value CANSTA_NoError 0x00 CAN bus is OK CANSTA_BusOff 0x01 The wrong CAN baud rate or wrong wire connection causes this error CANSTA_Error 0x02 The transmission and reception is failure CANSTA_DataOverRun 0x03 Too much reception causes the buffer overwriting CANSTA_TxIncomplete 0x04 The transmission is incomplete CANSTA_TxLocked 0x05 The transmission is locked e Return I8120PM_NoError 0 OK 1I8120PM_SlotNumberError 10003 Slot No is error I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 34 3 3 16 18120PM_ GetPowerMeterStatus e Description This function is used to get the communication status of certa
15. The 8120W s Application for PM 213x CAN Power Meter SDK User Manual Warranty All products manufactured by ICP DAS are under warranty regarding defective materials for a period of one year beginning from the date of delivery to the original purchaser Warning ICP DAS assumes no liability for any damage resulting from the use of this product ICP DAS reserves the right to change this manual at any time without notice The information furnished by ICP DAS is believed to be accurate and reliable However no responsibility is assumed by ICP DAS for its use not for any infringements of patents or other rights of third parties resulting from its use Copyright Copyright 2009 by ICP DAS Co Ltd All rights are reserved Trademark The names used for identification only may be registered trademarks of their respective companies Contact US If you have any problem please feel free to contact us You can count on us for quick response Email service icpdas com 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 1 Revision Manual Firmware Date Author Content Version Version 2011 First Version 1 0 1 0 11 17 Johney 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 2 Table of Contents A0 Te BEE 1 THE CAN BUS POWER METER OVERVIEW eessessessoescossessoesoossessossooesossoseose hal GA BUS INTRODUCTION eege 1 2 CAN B
16. US POWER METER APPLICATIONS vii sszicisianciaaraseniaccssnescnsantesanevaussactessniad tadestaannes 1 3 FEATURES OF THE CAN BUS AND POWER Mert 2 1 8120W HARDWARE CONFIGURATION e ssesooesesssesooesocsossooesosssesoossossseso EE EEN 10 ZS GAIN BUS IN ASSIGNMENT geheegt ege Eggs 11 2 4 CAN BUS WIRE CONNECTION wsisszesdsassuscasabedextcvasasasgisdasedoa suasadeaseaeeuenssecadtisdeeateeuecease 12 ZJ INDICATOR DED selec ahaa Sahl Scan Bice Rack ach aba la EE 13 Did PW Ue GED EE 13 2 I2 TARIE EDR E 13 20 ERR LEED 2 tates UG RG Ee aa R SEO A Ee 13 2 6 UPDATE THE I 8120W S FIRMWARE EE 14 A I 8120W POWER METER SDK DESCRIPTION oeseessessoesosssesoossosssessossossse 17 3 1 DLL LIBRARY DEFINITION AND DESCRIPTION ccsssssceesessececesssececessuscecesscaeeeesssesess 17 GENEE EE E EEE 18 3 3 POWER METER MANAGEMENT SDK DrecRipmOoN 20 3 3 1 I8T20PM Total Mod le srianan iana aa 20 3 3 2 IBI20PM ActiveMod le sperii otata a a a t 21 3 3 3 IST20PM E TE 22 3 3 4 I8120PM GetDLLVerS1On osier haas n Eege E A EA iia 23 3 3 5 STOEN erbei 24 3 210 AS TZOPM Resethirim Wate naciana a a a 25 3 91 EE eege He 3 3 8 IST20PM ZeetEMTDReteetedeeiien Seege Eet ed dessa 27 3 3 9 ES EE EEN 28 5 50 SE Seth aid Rate asneira a d et 29 3 3 11 TBI QOPM SerAuto Resp Tine ee eer ge ee Edel See 30 3 3 12 I8120PM_GetAutoRespTime siisisaceccsssessscsiseecadsassevaatatevsnccetsaveevascavsavadeovacts 31 33137 LH Start A toRE EE 32 3 3 14 I8120PM_StopAutoRes
17. _NoResp There is no response message 1020 FirmError_ NoGetCMD No GetFirm command was sent 1021 FirmError_NoResp There is no response message 1030 PMError_NoSetCMD No SetNewlD command was sent 1031 PMError_NoResp There is no response message I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 18 Table 3 2 2 Hardware Return Code Return Code Error ID Comment 10003 18120PM _SlotNumberError Slot No error 10007 18120PM_lnitError Initialize error 10021 18120PM_SoftBufferlsEmpty CAN buffer is empty 10022 18120PM_SoftBufferlsFull CAN buffer is full 10023 18120PM_TimeOut Firmware responses timeout 10024 18120PM_SetCyclicMsgFailure Cyclic Message fail 10025 18120PM_DpramOverRange DPRAM out of range 10026 18120PM_NoDpramCmd DPRAM has no command 10027 18120PM_ModeError Firmware is not running 10030 18120PM_NoFilelnside Firmware does not exist 10031 18120PM_DownloadFailure Loading firmware is fail 10032 18120PM_EEPROMDamage EEPROM is out of order 10033 18120PM_NotEnoughSpace EEPROM is full 10034 18120PM_StillDownloading It is downloading firmware 10035 18120PM_BoardModeError The module is under download mode 10036 18120PM_SetDateTimeFailure Setting date is fail 10040 18120PM_SlotNotConfig Module does not configure 10041 18120PM_SlotNotlnit Module does not initialize 10042 18120PM_ReplyError Firmware replies er
18. ame_I_a 0x0001 The current of the channel A DataName_kW_a 0x0002 The kW of the channel A DataName_kvar_a 0x0003 The kvar of the channel A DataName_kVA_a 0x0004 The kVA of the channel A Dataname_PF_a 0x0005 The power factor of the channel A DataName_kWh_a 0x0006 The kWh of the channel A DataName_kvarh_a 0x0007 The kvarh of the channel A DataName_kVAh_a 0x0008 The kVAh of the channel A DataName_V_b 0x0009 The voltage of the channel B DataName_I_b Ox000A The current of the channel B I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 36 DataName_kW_b 0x000B The kW of the channel B DataName_kvar_b Ox000C The kvar of the channel B DataName_kVA_b 0x000D The kVA of the channel B Dataname_PF_b Ox000E The power factor of the channel B DataName_kWh_b 0x000F The kWh of the channel B DataName_kvarh_b 0x0010 The kvarh of the channel B DataName_kVAh_b 0x0011 The kVAh of the channel B DataName_V_c 0x0012 The voltage of the channel C DataName_l _c 0x0013 The current of the channel C DataName_kW_c 0x0014 The kW of the channel C DataName_kvar_c 0x0015 The kvar of the channel C DataName_kVA_c 0x0016 The kVA of the channel C Dataname_PF_c 0x0017 The power factor of the channel C DataName_kWh_c 0x0018 The kWh of the channel C DataName_kvarh_c 0x0019 The kvarh of the channel C DataName_kVAh_c 0x001A The kVAh o
19. are 8124V10 EXE Modified 2010 2 23 12 39 15 Size 239376 E Chang the Jumper of the I 8120W again You need to enable the Flash protection functionality It would protect the firmware against illegal writing It illustrate as below Pi ps E E Ea l 8120W Connector I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 16 3 I 8120W Power Meter SDK Description 3 1 DLL Library Definition and Description All the functions provided in the I812W_PM DLL or 1I8120PM_DotNET DLL have detail description in CH3 3 However in order to make the descriptions more simply and clearly the attributes for the both input and output parameter functions are given as input and output respectively as shown in the following table Keyword et parameter by user before Get the data from this parameter calling this function after calling this function input Yes No output No I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 17 3 2 Function Return Code Table 3 2 1 Firmware Return Code Return Gg Error ID Comment 0 18120PM_NoError No Error 18120PM_PMIDNotExist Power Meter ID does not exist 18120PM_DataNameError Data Name is error PMXS_BaudRateError Baud Rate is error RatioError_NoGetCMD No GetRatio command was sent 1011 RatioError_ NoSetCMD No SetRatio command was sent 1012 RatioError
20. cation for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 44 3 3 25 18120PM_GetPMFirmVerValue e Description After calling the function 18120PM_GetPMFirmVerCMD the specific power meter will reply the result of the processed command This response will be kept in the I 8120W Therefore calling the function 1I8120PM_GetPMFirmVerValue can read the response stored in the l 8120W to confirm if the setting is ok or not Before using this function users need to call the function 18120PM_GetPMFirmVerCMD first Then users can get the firmware version of the specific power meter correctly e Syntax DWORD 18120PM_GetPMFirmVerValue BYTE SlotNo BYTE PMID WORD PMFirmVer e Parameter SlotNo input The slot number which the I 8120W is plugged in PMID input The ID of the power meter PMFirmVer output Return the firmware version of the power meter e Return I8120PM_NoError 0 OK I8120PM_SlotNumberError 10003 Slot No is error I8120PM_PMIDNotExist 1000 The ID of the power meter does not exist in the I 8120W FirmError_NoGetCMD 1020 No Get Firm Ver command was sent FirmError_NoResp 1021 There is no response message from the power meter I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 45 3 3 26 18120PM_SetNewPMIDCMD e Description This function will send a Change ID command to the specific power meter The returned value of this function indicates
21. dialog Here shows the detail steps CAN Power Meter GES y1 2 Power Meter ID ID 0x00 v Meter PT CT Ratio Meter rato 0 exy units PT Ratio o Dec Units 0 01 creato 0 fein 1 Read From Power Meter Write to Power Meter Firmware Version of the Power Meter Firmware Ver No Information Read Firmware Version of the Power Meter 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 59 4 6 1 The Ratio Parameters of the Power Meter After clicking the Advanced button the following dialog is popped up You can select the desired power meter s ID to read or write the ratio parameters Note that the ratio parameters would affect the information of the power measurement The following picture shows the detail steps Step 1 Select the correct ID of the power meter Advanced Parameter pu 0x02 ue a oxo tnt 00 cr ato 0 x this Read From Power Meter Write to Power Meter Firmware Version of the Power Meter Firmware Ver No Information Read Firmware Version of the Power Meter Step 2 Read or write the ratio parameters of the power meter Advanced Parameter Power Meter Parameter Change Power Meter ID Power Meter ID jo 0x02 v Meter PT CT Ratio Meter Rato 5 ec nits me ing aunts sa Firmware Version of the Power Meter Firmware Ver No Information Read Firmware Version of the Power Meter
22. e 4 5 DISPLAY THE REAL TIME POWER INFORMATION 4 6 ADVANCED PARAMETER OF POWER MEIER 4 6 1 The Ratio Parameters of the Power Meter 4 6 2 The firmware version of the Power Meter 4 6 3 Change the ID of the Power Meter 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 eoce 4 1 The CAN bus Power Meter Overview 1 1 CAN bus Introduction The Controller Area Network CAN is a serial communication way which efficiently supports distributed real time control with a very high level of security It provides the error process mechanisms and message priority concepts These features can improve the network reliability and transmission efficiency Furthermore CAN supplies the multi master capabilities and is especially suited for networking intelligent devices as well as sensors and actuators within a system or sub system The CAN bus has perfect superiority over other serial communication buses Here shows the features Physical layer with fault tolerance and anti noise Hardware built in five fast and stable error detecting mechanisms The arbitration guarantees the prioritization of collided messages Support Multi master communication mechanism The CAN bus has longer communication distance Good ability in integrating different CAN protocol S 28 ee eS Based on the superior features those industries focusing on higher safety apply a lot of CAN bus systems The common industries are
23. eter SDK User Manual V1 0 2011 11 17 24 3 3 6 18120PM_ResetFirmware e Description The function is used to reset the I 8120W module When users have changed the baud rate of CAN bus or changed other settings the function must be called to make the modification enable e Syntax DWORD 18120PM_ResetFirmware BYTE SlotNo e Parameter SlotNo input The slot number which the I 8120W is plugged in e Return 1I8120PM_NoError 0 OK 1I8120PM_SlotNumberError 10003 Slot No is error I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 25 3 3 7 18120PM_GetPMIDs e Description This function is used to get the ID list of all the power meters which are in I 8120W The users can use this function to know which power meters are in the I 8120W e Syntax DWORD 18120PM_GetPMIDs BYTE SlotNo BYTE PMIDCount BYTE PMIDArray e Parameter SlotNo input The slot number which the I 8120W is plugged in PMIDCount output Return the amount of all power meter in the I 8120W PMIDArray output Return the ID array of all power meter in the I 8120W e Return 1I8120PM_NoError 0 OK 1I8120PM_SlotNumberError 10003 Slot No is error I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 26 3 3 8 18120PM_SetPMIDs e Description This function is used to set the power meters into the I 8120W The users can save certain power meters
24. f the channel C DataName_V_d 0x001B The voltage of the channel D DataName_I _d 0x001C The current of the channel D DataName_kW_d 0x001D The kW of the channel D DataName_kvar_d 0x001E The kvar of the channel D DataName_kVA_d 0x001F The kVA of the channel D Dataname_PF_d 0x0020 The power factor of the channel D DataName_kWh_d 0x0021 The kWh of the channel D DataName_kvarh_d 0x0022 The kvarh of the channel D DataName_kVAh_d 0x0023 The kVAh of the channel D I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 37 3 3 18 18120PM_ReadAllData_BYTE e Description This function is used to read all power information in byte format e Syntax DWORD 18120PM_ReadAllData_BYTE BYTE SlotNo BYTE PMID WORD DataLen BYTE DataArray e Parameter SlotNo input The slot number which the I 8120W is plugged in PMID input The ID of the power meter DataLen output Return the size of all power meter information in byte At present the value is always 144 Bytes DataArray output Return all power meter information Please refer to the following illustration for the arrangement of all the data e Return I8120PM_NoError 0 OK I8120PM_SlotNumberError 10003 Slot No is error I8120PM_PMIDNotExist 1000 The ID of the power meter does not exist in the I 8120W e The Arrangement of all power data in byte 0x00 0x04 0x08 Ox0C 0x00 0x10 0x20 E
25. he I 8120W can t work normally Set this jumper to reset status until the green and yellow LEDs of 1 8120W interlace flash once per second Then set this jumper to normal status Afterwards the 8120W is in download mode Users can overwrite the old firmware with the new one by using Utility tool CAN Port 1200 terminal resistor Table 2 1 8120W Jumper selections I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 10 2 3 CAN bus Pin Assignment The I 8120W is equipped with one 5 pin screwed terminal connector for wire connection of the CAN bus The connector s pin assignment is specified as follows The 5 pin screwed terminal connector of the CAN bus interface is shown in Figure 2 5 and the corresponding pin assignments are given in Table 2 2 Pin 1 Pin 2 Pin 3 Pin 4 Pin 5 Figure2 5 5 pin terminal connector Pin No Signal Description 1 N A No use 2 CAN_H CAN High bus line dominant high 3 N A No use 4 CAN_L CAN Low bus line dominant low 5 CAN_GND Ground Table 2 2 Pin assignment of the 5 pin screwed terminal connector I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 11 2 4 CAN bus Wire Connection In order to minimize the reflection effects on the CAN bus line the CAN bus line has to be terminated at both ends by two terminal resistances as in the following figure According to the ISO 118
26. he following picture shows the detail steps Parameter Gonfiguration Selected Power Meter 40 Meters Selected ID 0x00 ID 0x01 ID 0x02 DLL Version ff ID 0x03 z ID 0x04 CAN Baud Rate ID 0x05 ID 0x06 ID 0x07 ID 0x08 Auto Response Time ID 0x09 ID 0x04 ID 0x0B ID 0x0C ID 0x0D ID 0x0E Set Power Meter Firmware Version 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 55 4 4 2 The Time of Automatic Response After clicking the Parameter button the users can see the following picture and input the desired time value Notice that the input value must be decimal format in millisecond After inputting the time value the users can click the Set Time button to save the setting into the I 8120W The picture below shows the detail steps Parameter Configuration Selected Power Meter 40 Meters Selected ID 0x00 ID 0x01 ID 0x02 DLL Version Io ID 0x03 ID 0x04 CAN Baud Rate zer bps v ID 0x05 ID 0x06 ID 0x07 ID 0x08 Auto Response Time ID 0x09 ID Ox0A ID 0x08 ID 0x0C ID DND ID Ox0E Set Power Meter Firmware Version In op I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 56 4 4 3 The List of the Power Meter After clicking the Parameter button the users can see the following picture and select the desired power meter s
27. in power meter e Syntax DWORD 18120PM_GetPowerMeterStatus BYTE SlotNo BYTE PMID BYTE Status e Parameter SlotNo input The slot number which the I 8120W is plugged in PMID input The ID of the power meter Status output Return the status of the power meter The data would be the following value PMSTA_NoError 0x00 The communication of this power meter is OK PMSTA_Timeout 0x01 The communication of this power meter is timeout e Return I8120PM_NoError 0 OK 1I8120PM_SlotNumberError 10003 Slot No is error 1I8120PM_PMIDNotExist 1000 The ID of the power meter does not exist in the I 8120W 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 35 3 3 17 18120PM ReadData e Description This function is used to read certain power information e Syntax DWORD 1I8120PM_ReadData BYTE SlotNo BYTE PMID WORD DataName float fData e Parameter SlotNo input The slot number which the I 8120W is plugged in PMID input The ID of the power meter DataName input The power meter data name Please refer to the following description fData output Return the value of the power information e Return I8120PM_NoError 0 OK 1I8120PM_SlotNumberError 10003 Slot No is error I8120PM_PMIDNotExist 1000 The ID of the power meter does not exist in the I 8120W e Power Meter Data Name DataName_V_a 0x0000 The voltage of the channel A DataN
28. into the EEPROM of the I 8120W The setting does not lose when power is off One I 8120W could manage at most 45 power meters If the array is larger than 45 elements this function would retrieve the forefront 45 elements e Syntax DWORD 18120PM_SetPMIDs BYTE SlotNo BYTE PMIDCount BYTE PMIDArray e Parameter SlotNo input The slot number which the I 81 20W is plugged in PMIDCount input The amount of power meter which will be saved into the I 8120W PMIDArray input The ID array of all power meter which will be saved into the I 8120W e Return 1I8120PM_NoError 0 OK 1I8120PM_SlotNumberError 10003 Slot No is error I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 27 3 3 9 18120PM_GetBaudRate e Description This function can help you to get the CAN bus baud rate information of the I 8120W e Syntax DWORD 18120PM_GetBaudRate BYTE SlotNo BYTE BaudRate e Parameter SlotNo input The slot number which the I 8120W is plugged in BaudRate output Return the baud rate of the CAN bus BaudRate 0 means that the baud rate is 125 kbps BaudRate 1 means that the baud rate is 250 kbps BaudRate 2 means that the baud rate is 500 kbps e Return 1I8120PM_NoError 0 OK 1I8120PM_SlotNumberError 10003 Slot No is error I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 28 3 3 10 18120PM SetBaudRate e
29. nce to release the resource before exiting the user s application program e Syntax DWORD 18120PM_CloseModule BYTE SIotNo e Parameter SlotNo input The slot number which the I 8120W is plugged in e Return I8120PM_NoError 0 OK 1I8120PM_SlotNumberError 10003 Slot No is error I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 22 3 3 4 18120PM_GetDLLVersion e Description By using this function the user can query the version thel8120W_PM DLL e Syntax DWORD 18120PM_GetDLLVersion void e Parameter None e Return Return the DLL version information For example If 100 hex is returned it means DLL version is 1 00 If 123 hex is returned it means DLL version is 1 23 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 23 3 3 5 18120PM_GetFirmwareVersion e Description The function can obtain the version information of the firmware inside the I 8120W module e Syntax DWORD 18120PM_GetFirmwareVersion BYTE SlotNo e Parameter SlotNo input The slot number which the I 8120W is plugged in e Return Return the firmware version information For example If 100 hex is returned it means firmware version is 1 00 If 123 hex is returned it means firmware version is 1 23 e Error Return 1I8120PM_SlotNumberError 10003 Slot No is error I 8120W s Application for PM 213x CAN Power M
30. p sseesessseseeeeessseesseesseesseeesseeesseesseesseressessseessresse 33 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 3 3 315 I8I2OPM GetCA N Status nsan nanana ete ansi 3 3 16 TST2OPMi errereen ee reese Se Gre TA soyi intier e dates ev a ira i 3 3 18 NEIE CA ei KEE 3 3 19 18120PM_ReadAllData_FLOAT cee cccecccecsceceteceseceeeeeseecnaeeeeeeeenes 39 2018 NEE OC NUD E 3 33 21 IS1QOPM GetRauiG ET 333 22 18120PM SetRatioCMD EE 3 329 IS TZOPM SctRatioRe sp 2 cs sesesssccdeianisseaecssuadaa as EAR Ed deg 3 3 24 AS 20PM GetPM Pirin EM eege egen 3 3 25 181 20PM Get PMBirm Ver Value lt ssaitucsszsagescennacccsestqoadsenesacsuvedsednnnesens 3 3 26 181 20PM_SetNewPMIDCM D i a 55s css sscradptacscoaadeavtdeaiessisenseanotasoeeseas 3 3 27 I8I2ZO0PM_SetNewPMIDRESpyiisissscsicssvseasciseecadeaspavaaveseusndcessnccdvastevedeedens 3 4 THE FLOW CHART OF THE DEVELOPMENT ciccss ss cuh vslessanchs se Gone vdsSecsd ss ie ineedawcea ved 3 4 1 The Flow Chart of the Fast Development 3 4 2 The Flow Chart of the General Development 4 PAC_CAN_POWER_METER SOFTWARE UT ILITY s sssssssssssessesssesseess 4I ACTIVATE FS POW TE 4 2 RESET THE FIRMWARE IN THE I 81 ZOU 4 3 START STOP AUTOMATIC EEN edel 4 4 PARAMETER CONFIGURATION OF POWER Mer 4 4 1 CAN b s Baud EEN 4 4 2 The Time of Automatic Response ssssssesssesesseeessresseessersseresseeesseesseesse 4 4 3 The List of the Power Meter ee eege e
31. ror 10043 18120PM_WaitForReply Waiting for reply I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 19 3 3 Power Meter Management SDK Description 3 3 1 18120PM_TotalModule e Description The function can get the count of total 8120W modules in the user s WP 8000 or XPAC 8000 series MCU e Syntax DWORD 18120PM_TotalModule BYTE TotalModules BYTE SlotNoList e Parameter TotalModules output Return the amount of total modules SlotNoList output Return the list of all slot No of each modules e Return I8120PM_NoError 0 OK I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 20 3 3 2 18120PM_ActiveModule e Description The function is used to activate the entire 8120W module gt It must be called once before using the other functions of I 8120W APIs e Syntax DWORD 18120PM_ActiveModule BYTE SlotNo e Parameter SlotNo input The slot number which the I 8120W is plugged in e Return 18120PM_NoError 0 OK I8120PM_SlotNumberError 10003 Slot No is error 18120PM_InitError 10007 8120W initialization is fail 1I8120PM_NoFilelnside 10030 No firmware inside the I 8120W 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 21 3 3 3 18120PM_CloseModule e Description The function is used to stop and close the I 8120W driver This method must be called o
32. sceiver 2500 Vrms photo isolation protection on CAN side Support both PM 2133 CAN and PM 2134 CAN series power meter Support programmable baud rate 125 kbps 250 kbps and 500 kbps Managing up to 45 power meters with single I 8120W Collecting power information of all power meters automatically The scan time of 45 power meters is only 368ms 500Kbps Monitoring the communicating status of the power meters CAN bus provides better capability in noise suppression Support arbitration mechanism to avoid collision Support error detection and error correction on CAN bus 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 8 2 l 8120W Hardware Configuration This section will describe the hardware settings of the I 8120W This information includes the wire connection and terminal resistance configuration 2 1 I 8120W Board Layout JP4 LS E JP1 Pi ps E ss Ea l 8120W Connector Figure2 1 1 8120W Board Layout I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 9 2 2 Jumper Selection The following table shows the definition of jumpers Users need to refer to this table to configure the I 8120W hardware Description Status Flash Protection If you need to update the firmware you should unlock it before you download the firmware The i default is lock Lock unlock When users download the firmware which is not proper for l 8120W so that t
33. sent RatioError_NoResp 1012 There is no response message from the power meter 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 41 3 3 22 18120PM_SetRatioCMD e Description This function will send a Set Ratio command to the specific power meter The returned value of this function indicates if the command has been sent successfully or not Users can use the 18120PM_SetRatioResp function to read the response replied from the power meter to confirm if the setting is ok or not e Syntax DWORD 18120PM_SetRatioCMD BYTE SlotNo BYTE PMID WORD MeterRatio WORD PTRatio WORD CTRatio e Parameter SlotNo input The slot number which the I 8120W is plugged in PMID input The ID of the power meter MeterRatio input The meter ratio value of the power meter PTRatio input The PT ratio value of the power meter CTRatio input The CT ratio value of the power meter e Return I8120PM_NoError 0 OK I8120PM_SlotNumberError 10003 Slot No is error I8120PM_PMIDNotExist 1000 The ID of the power meter does not exist in the I 8120W I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 42 3 3 23 18120PM_SetRatioResp e Description After calling I18120PM_SetRatioCMD the function can read the response values which have been replied from the power meter Before using this function users need to call 18120PM_SetRatioCMD first Then the
34. ue function to read the ratio value replied from the power meter Syntax DWORD 18120PM_GetRatioCMD BYTE SlotNo BYTE PMID Parameter SlotNo input The slot number which the I 8120W is plugged in PMID input The ID of the power meter Return I8120PM_NoError 0 OK 1I8120PM_SlotNumberError 10003 Slot No is error I8120PM_PMIDNotExist 1000 The ID of the power meter does not exist in the I 8120W I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 40 3 3 21 18120PM_GetRatioValue e Description The function can read the ratio values which have been replied from the power meter Before using this function users need to call the function 18120PM_GetRatioCMD first Then users can get the last ratio values correctly e Syntax DWORD 18120PM_GetRatioValue BYTE SlotNo BYTE PMID WORD MeterRatio WORD PTRatio WORD CTRatio e Parameter SlotNo input The slot number which the I 8120W is plugged in PMID input The ID of the power meter MeterRatio output Return the meter ratio value of the power meter PTRatio output Return the PT ratio value of the power meter CTRatio output Return the CT ratio value of the power meter e Return 18120PM_NoError 0 OK 1I8120PM_SlotNumberError 10003 Slot No is error I8120PM_PMIDNotExist 1000 The ID of the power meter does not exist in the I 8120W RatioError_NoGetCMD 1010 No Get Ratio command was
35. users can get the last response correctly e Syntax DWORD 1I8120PM_SetRatioResp BYTE SlotNo BYTE PMID WORD RespValue e Parameter SlotNo input The slot number which the I 8120W is plugged in PMID input The ID of the power meter RespValue output The meter ratio value of the power meter e Return 1I8120PM_NoError 0 OK 1I8120PM_SlotNumberError 10003 Slot No is error I8120PM_PMIDNotExist 1000 The ID of the power meter does not exist in the Il 8120W RatioError_NoSetCMD 1011 No Set Ratio command was sent RatioError_NoResp 1012 There is no response message from the power meter I 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 43 3 3 24 18120PM_GetPMFirmVerCMD e Description This function will send a Get Firmware Version command to the specific power meter The returned value of this function indicates if the command has been sent successfully or not Users can use the 1I8120PM_GetPMFirmVerValue function to read the response firmware version replied from the power meter Syntax DWORD 18120PM_GetPMFirmVerCMD BYTE SlotNo BYTE PMID Parameter SlotNo input The slot number which the I 8120W is plugged in PMID input The ID of the power meter Return I8120PM_NoError 0 OK 1I8120PM_SlotNumberError 10003 Slot No is error 1I8120PM_PMIDNotExist 1000 The ID of the power meter does not exist in the I 8120W I 8120W s Appli
36. vi b lex 0x30 kvar b kvAb lees kWhb 0x40 ak kvAhb ve Ge 0x50 kw e f kvare jf kvAc PFe Gent kWh_c Kvarhe kvAhc 0x70 0x80 0x90 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 38 3 3 19 18120PM_ReadAllData_FLOAT e Description This function is used to read all power information in float format e Syntax DWORD 18120PM_ReadAllData_FLOAT BYTE SlotNo BYTE PMID WORD DataLen float fDataArray e Parameter SlotNo input The slot number which the I 8120W is plugged in PMID input The ID of the power meter DataLen output Return the size of all power meter information in float At present the value is always 36 floats fDataArray output Return all power meter information Please refer to the following illustration for the arrangement of all the data e Return I8120PM_NoError 0 OK 18120PM_SlotNumberError 10003 Slot No is error I8120PM_PMIDNotExist 1000 The ID of the power meter does not exist in the I 8120W e The Arrangement of all power data in float 0x00 0x01 0x02 0x03 1 8120W s Application for PM 213x CAN Power Meter SDK User Manual V1 0 2011 11 17 39 3 3 20 18120PM_GetRatioCMD e Description This function will send a Get Ratio command to the specific power meter The returned value of this function indicates if the command has been sent successfully or not The users can use the 18120PM_GetRatioVal
Download Pdf Manuals
Related Search