/******************** (C) COPYRIGHT 2006 STMicroelectronics **********************
* File Name          : Readme.txt
* Author             : MPA Systems Lab
* Date First Issued  : 04/13/2006 :  V1.0
* Description        : Description of the I2C emulation firmware for ST7MC
                       in slave mode.
                       ( POW Code : DO.APN0004.01 )
**********************************************************************************
* History:
* Date          Version     Description
* 04/13/2006 :  V1.0        First issue of firmware
*********************************************************************************
 THE PRESENT SOFTWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS WITH
 CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE TIME.
 AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY DIRECT, INDIRECT
 OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE CONTENT
 OF SUCH SOFTWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING INFORMATION
 CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
**********************************************************************************

Firmware description
====================
The source code provided will be used as addendum of standard motor control libraries to perform software emulation of I2C protocol using ST7MC Starter Kit as slave device in motor control application. This software contemplate also an Hardware modification to connect the starter kit to the I2C bus. 


Tools/Environment
=================

1. Compiler : Cosmic compiler compliant only. 

2. Compiler version : ver. 4.5c 

3. Tool Chain version : No workspaces has been provided, only source code to be used with motor control libraries.
             
4. Hardware : The project is tested on Softec ST7MC starter kit. 


Documents
=========

1. AN2030

2. 

3. 


How to use it
=============
At the moment is released the following standard libraries for ST7MC Starter Kit (Motor Control application) and they are dedicated to specific kind of motor. The libraries are:

Library Name	Description
AC_1PH_SR_2.0	Induction mono phase motors sensored
AC_2PH_SR_2.0	Induction bi phases motors sensored
AC_3PH_SR_2.0	Induction three phases motor sensored
BLDC_3PH_SL_2.0	Brushless or permanent magnet motors drive in trapezoidal mode (6 Step) sensorless
BLDC_3PH_SR_2.0	Brushless or Permanent Magnet motors drive in trapezoidal mode (6 Step) sensored
PMAC_3PH_SR_2.0	Brushless or Permanent Magnet motors drive in sinusoidal mode sensored

The following steps are required to modify the standard libraries to emulate the I2C using SPI:

- Configure first the libraries using the configuration tools AK-ST7FMC Control Panel see the related manual.
- Copy the two provided modules (I2C.c, I2C.h, ProtoSup.c, ProtoSup.h) in the project folder.
- Copy the vector.c file provided inside the project folder overwriting old vector.c file.
- Copy the main.c file provided inside the project folder overwriting old main.c file.

- Open the workspace using Softec STVD7 v.3.10 Integrated Development Environment.
- Add the two files I2C.c and ProtoSup.c in the Source Files folder of the workspace and the two files I2C.h and ProtoSup.c in the Include Files folder of the workspace.

- Inside the I2C.h file select the kind of motor defining the correspondent MOTOR_TYPE constant PMAC, BLDC or AC:

#define MOTOR_TYPE PMAC   
or
#define MOTOR_TYPE BLDC
or
#define MOTOR_TYPE AC

Then follow the instruction written in the AN2038


******************* (C) COPYRIGHT 2006 STMicroelectronics *****END OF FILE****
