Maxim-integrated 78M6612 M-API Library Manuel d'utilisateur

A Maxim Integrated Products Brand 78M6612 M-API Library User Guide September 30, 2010 Rev. 1.00 UG_6612_0

78M6612 M-API Library User Guide UG_6612_036 10 Rev. 1.00 3 Build Environment and Software/Firmware Configurations The Metrology Application Prog

UG_6612_036 78M6612 M-API Library User Guide Rev. 1.00 11 3.2.2 RAM/Data Memory The 78M6612 has 2K bytes of Data Memory for exclusive use by the e

78M6612 M-API Library User Guide UG_6612_036 12 Rev. 1.00 Metering 6K Metrology functions (alarms, power factor, RMS, etc.) Measurement 2K Met

UG_6612_036 78M6612 M-API Library User Guide Rev. 1.00 13 3.3.3 Library Assignment The firmware application source code, as shipped with this

78M6612 M-API Library User Guide UG_6612_036 14 Rev. 1.00 3.3.4 Module’s Selection within a Library The M-API libraries are organized into se

UG_6612_036 78M6612 M-API Library User Guide Rev. 1.00 15 Table 6: MAPI Feature/Module Selections Module Optional (O)/Mandatory (M) Description ?C

78M6612 M-API Library User Guide UG_6612_036 16 Rev. 1.00 The following figure shows the Keil IDE/UV4 IDE menu where the module can be selected or

UG_6612_036 78M6612 M-API Library User Guide Rev. 1.00 17 4 MAPI Libraries The following sections describe the available MAPI calls supported by t

78M6612 M-API Library User Guide UG_6612_036 18 Rev. 1.00 4.2 Library Inputs and Outputs 4.2.1 MAPI_GetSetRegister() Purpose Get or Set the val

UG_6612_036 78M6612 M-API Library User Guide Rev. 1.00 19 Parameters Operation Input parameter. WRITE(1) – Set Operation, READ(0) – Get Operatio

78M6612 M-API Library User Guide UG_6612_036 Maxim cannot assume responsibility for use of any circuitry other than circuitry entirely embodied in a

78M6612 M-API Library User Guide UG_6612_036 20 Rev. 1.00 4.2.1.1 Auto-Scaling When retrieving measurement data using the MAPI_GetSetRegister() c

UG_6612_036 78M6612 M-API Library User Guide Rev. 1.00 21 4.2.1.3 MPU Library Inputs The following inputs can be modified (and saved to Flash) usi

78M6612 M-API Library User Guide UG_6612_036 22 Rev. 1.00 4.2.1.4 CE Library Inputs The following inputs can only be modified (and saved to Flas

UG_6612_036 78M6612 M-API Library User Guide Rev. 1.00 23 4.3 CE and MPU Control 4.3.1 MAPI_CEOn() Purpose Turn CE on. After calling MAPI_Init(

78M6612 M-API Library User Guide UG_6612_036 24 Rev. 1.00 4.3.5 MAPI_HardReset() Purpose Reset the MPU, this includes stopping the CE, and setti

UG_6612_036 78M6612 M-API Library User Guide Rev. 1.00 25 4.4 Calibration and Power Measurement 4.4.1 MAPI_CalSetGet() Purpose Set or Get Calibr

78M6612 M-API Library User Guide UG_6612_036 26 Rev. 1.00 Parameters SetData Input parameter. TRUE(1) – Set calibration data as specified in MP

UG_6612_036 78M6612 M-API Library User Guide Rev. 1.00 27 4.4.2 MAPI_Calibrate() Purpose Calibrate the part using referenced meter values and tol

78M6612 M-API Library User Guide UG_6612_036 28 Rev. 1.00 Outlets Input parameter Bit representations of outlet # to be calibrated. For ex

UG_6612_036 78M6612 M-API Library User Guide Rev. 1.00 29

UG_6612_036 78M6612 M-API Library User Guide Rev. 1.00 3 Table of Contents 1 Introduction ...

78M6612 M-API Library User Guide UG_6612_036 30 Rev. 1.00 4.4.4 MAPI_TimeToAverage() Purpose Set/Get the time increment (in seconds) in which th

UG_6612_036 78M6612 M-API Library User Guide Rev. 1.00 31 4.4.6 MAPI_GetVoltageCurrent() Purpose Get the current values of Voltage and Current .

78M6612 M-API Library User Guide UG_6612_036 32 Rev. 1.00 4.5 Zero Crossing and Relay Control 4.5.1 MAPI_RelayConfig() Purpose Read/Write relay

UG_6612_036 78M6612 M-API Library User Guide Rev. 1.00 33 4.5.2 MAPI_RelayControl () Purpose Turning Relay ON/OFF (close/open circuit) on all cha

78M6612 M-API Library User Guide UG_6612_036 34 Rev. 1.00 4.6 Soft-Timers There are eight soft-timers in the 8051 Timer 0. Only six of these tim

UG_6612_036 78M6612 M-API Library User Guide Rev. 1.00 35 4.7 DIO Configuration (future release) 4.7.1 MAPI_DIOConfig() Purpose Configure the

78M6612 M-API Library User Guide UG_6612_036 36 Rev. 1.00 4.7.2 MAPI_DIORW() Purpose Perform the Read/Write operation of/to the DIO. Synopsis

UG_6612_036 78M6612 M-API Library User Guide Rev. 1.00 37 4.8 Flash Management 4.8.1 Memcpy_rx() Purpose Write to Flash the content data from a

78M6612 M-API Library User Guide UG_6612_036 38 Rev. 1.00 4.8.2 Memcpy_xr() Purpose Use to write to Flash the content data to a specific RAM loc

UG_6612_036 78M6612 M-API Library User Guide Rev. 1.00 39 4.9 Serial/RS232 Interface 4.9.1 MAPI_UARTInit() Purpose Configure the communication s

78M6612 M-API Library User Guide UG_6612_036 4 Rev. 1.00 4.7 DIO Configuration (future release) ...

78M6612 M-API Library User Guide UG_6612_036 40 Rev. 1.00 4.9.3 MAPI_TxLen() Purpose Number of bytes transmitted thus far. Synopsis Unsigned

UG_6612_036 78M6612 M-API Library User Guide Rev. 1.00 41 5 Default Values The following default values are used to build the MAPI library: struc

78M6612 M-API Library User Guide UG_6612_036 42 Rev. 1.00 6 Contact Information For more information about Maxim products or to check the avail

UG_6612_036 78M6612 M-API Library User Guide Rev. 1.00 43 Revision History Revision Date Description 1.00 09/30/2010 First publication.

UG_6612_036 78M6612 M-API Library User Guide Rev. 1.00 5 1 Introduction This document describes the Metrology Application Programming Interface (M

78M6612 M-API Library User Guide UG_6612_036 6 Rev. 1.00 1.2 Library Measurement Equations The integrated Compute Engine (CE) accumulates the raw

UG_6612_036 78M6612 M-API Library User Guide Rev. 1.00 7 1.3 Library Parameters This section describes critical constants and variable parameters

78M6612 M-API Library User Guide UG_6612_036 8 Rev. 1.00 1.3.3 Example Calculation of Sensor Parameters This example demonstrates the calculation

UG_6612_036 78M6612 M-API Library User Guide Rev. 1.00 9 2 Firmware Partitions The 78M6612 firmware provided by Teridian is partitioned into three