Fendi 0.4 Developper Documentation

The principle

The Fendi graphical interface communicate with the simulations engine with 2 files :

The datas.tmp file discribe the network. It is generated by the Fendi graphical interface and sended to the simulation engine.
The results.tmp file containts all the simulation results with the given network. It is generated by the the simulation engine and sended to the Fendi graphical interface to be displayed.

The simulation plugins are dynamic libraries (dll).

These files are XML file.

The datas.tmp file

This file contains 3 main parts :

The XML header : <?xml version='1.0' encoding='UTF16' standalone='yes'?>. It never change
The network node list
The lines list

Component fields are placed beween the tags <component> and </component>

Between these tags, you will find the 3 fixed fields :

The component type number of the component between the tags <type> and </type>. The componenet type number is defined in the CompoConst.lst file used in both the source code of the Fendi graphical interface and in the source code of the simulations engines. It is an integer.
The system name of the component between the tags <systemname> and </systemname>. It is a string.
The measure flag between the tags <measure> and </measure>. It is a boolean with false and true as valid values. This field is not used.

After these fixed, you will find a list of paramerters. This list begins with the number of parameter beetwen the tags <parameternumber> and </parameternumber>. It is an integer.
After this parameter you will find the parameter list with 3 fields for each parameter :

The parameter name between the tags <parametername> and </parametername>. It is a string.
The parameter type between the tags <parametertype> and </parametertype>. The parameter type number is defined in the ParameterConst.lst file used in both the source code of the Fendi graphical interface and in the source code of the simulations engines. It is an integer.
The parameter value between the tags <parametervalue> and </parametervalue>. Its type depend of the value of the parameter type :

ptReal (0) : A floating point number.
ptComplex (1) : Not used now for parameter value. See result value below.
ptTable (2) : A table of floating point values with colums separated by # and column separated by |
ptBoolean (3) : A boolean.
ptInteger (4) : An integer.

Each network node field is placed between the tags <netnode> and </netnode>
Between these tags, you will find a list of component nodes connected to this network node.
Each component node field is placed between the tags <node> and </node>
Between these tags, you will find 2 fixed fields :

The name of the component which own this node between the tags <component> and </component>. It is a string.
The index number of this node in the component between the tags <index>and</index>. It is an integer.

For example, for the Exemple1AC.sch very simple network :

Here is the datas.tmp file generated :

<?xml version='1.0' encoding='UTF16' standalone='yes'?>

<component>

<type>9</type>
<systemname>SourceAC0</systemname>
<measure>False</measure>
<parameternumber>2</parameternumber>
<parametername>Tension</parametername>
<parametertype>0</parametertype>
<parametervalue>1</parametervalue>
<parametername>Phase</parametername>
<parametertype>0</parametertype>
<parametervalue>0</parametervalue>

</component>

<component>

<type>5</type>
<systemname>Resistor0</systemname>
<measure>False</measure>
<parameternumber>1</parameternumber>
<parametername>resistance</parametername>
<parametertype>0</parametertype>
<parametervalue>1</parametervalue>

</component>

<component>

<type>7</type>
<systemname>Ground0</systemname>
<measure>False</measure>
<parameternumber>0</parameternumber>

</component>

<netnode>

<node>

<component>SourceAC0</component>
<index>0</index>

</node>
<node>

<component>Resistor0</component>
<index>0</index>

</node>

</netnode>

<netnode>

<node>

<component>SourceAC0</component>
<index>1</index>

</node>
<node>

<component>Ground0</component>
<index>0</index>

</node>
<node>

<component>Resistor0</component>
<index>1</index>

</node>

</netnode>

The results.tmp file

This file contains 3 main parts :

The XML header : <?xml version='1.0' encoding='UTF16' standalone='yes'?>. It never change
Components simulation results.
The network nodes simulation results

Component simulation results are placed between the tags <component> and </component>.
Between these tags, you will find the fixed fields :

The component type between the tags <type> and </type>.
The componenet system name between the tags <systemname> and </systemname>.

After these fixed, you will find a list of information to display. This list begins with the number of informations beetwen the tags <infosnumber> and </infosnumber>. It is an integer.
After this parameter you will find the informations list with 3 fields for each parameter :

The information name between the tags <infoname> and </infoname>.
The information type number between the tags <infotype> and </infotype>. The information type number, as then parameter type number is defined in the ParameterConst.lst file used in both the source code of the Fendi graphical interface and in the source code of the simulations engines. It is an integer.
The information unit between the tags <infounit> and </infounit>.
The information value between the tags <infovalue> and </infovalue>. Its type depend of the value of the parameter type :

ptReal (0) : A floating point number.
ptComplex (1) : A complex number defined with 2 floating point numbers. One for the real part and the other for the complex part. Each one is placed between its own <infovalue> and </infovalue> tags.
ptTable (2) : Not used now for information value.
ptBoolean (3) : Not used now for information value.
ptIntreger (4) : Not used now for information value.

Network node simulation results are placed beween the tags <netnode> and </netnode>. The fields are the same as the components except for the type and system name which are not given.

For example, here is the results.tmp file generated for the Exemple1AC.sch very simple network :

<?xml version='1.0' encoding='UTF16' standalone='yes'?>

<component>

<type>9</type>
<systemname>SourceAC0</systemname>
<infosnumber>1</infosnumber>
<infoname>Current</infoname>
<infotype>1</infotype>
<infounit>A</infounit>
<infovalue>1</infovalue>
<infovalue>0</infovalue>

</component>

<component>

<type>5</type>
<systemname>Resistor0</systemname>
<infosnumber>1</infosnumber>
<infoname>Current</infoname>
<infotype>1</infotype>
<infounit>A</infounit>
<infovalue>1</infovalue>
<infovalue>0</infovalue>

</component>

<netnode>

<infosnumber>1</infosnumber>
<infoname>Voltage</infoname>
<infotype>1</infotype>
<infounit>V</infounit>
<infovalue>1</infovalue>
<infovalue>0</infovalue>

</netnode>

<netnode>

<infosnumber>1</infosnumber>
<infoname>Voltage</infoname>
<infotype>1</infotype>
<infounit>V</infounit>
<infovalue>0</infovalue>
<infovalue>0</infovalue>

</netnode>

You can see these results in the graphical interface :

Simulation plugin format

The simulation plugins are dynamic libraries (dll). The must contain 8 functions. 3 main functions :

Execute : The main simulation function. Read the datas.tmp file, run the simulation and save the results.tmp file. It is called by the Fendi graphical interface when the user clic on the Simulate button.
AllowedComponent : Check the compatibilty of the component with the plugin.
GetErrorMsg : When the Execute function fails, this function is called to get the error message.

5 function used by the Fendi graphical interface to build the engine parameters window :

GetParamCount : Used by the plugin to give the number of parameters to the interface.
GetParamName : Used by the plugin to give the name of parameters to the interface.
GetParamUnit : Used by the plugin to give the unit of parameters to the interface.
GetParamDefaultValue : Used by the plugin to give the default value of parameters to the interface.

And one function to set the simulation engine parameters

SetParamValue : Used by the inteface to give the value of parameters to the plugin.

The function are now detailed below :

The execute function

The syntax of the function is :

function Execute:Boolean;
begin

end;

It return true if the function succeed and false if not.

The AllowedComponent function

The syntax of the function is :

function AllowedComponent(Number:Integer):Boolean;
begin

end

The input integer Number is the type number of a component (See the list below). If the plugin can simulate this component, you must return true and false of not.

The GetErrorMsg function

The syntax of the function is :

function GetErrorMsg:PChar;
begin

end

When the execute function fail, this function must return the corresponding error message.

The GetParamCount function

The syntax of the function is :

function GetParamCount:Integer;
begin

end

It return the number of parameters needed by the simulation engine.

The GetParamName function

The syntax of the function is :

function GetParamName(i:Integer):PChar;
begin

end

It return the name of parameter number i needed by the simulation engine. For the first parameter i is equal to 0.

The GetParamUnit function

The syntax of the function is :

function GetParamUnit(i:Integer):PChar;
begin

end

It return the unit of parameter number i needed by the simulation engine. For the first parameter i is equal to 0.

The SetParamValue function

The syntax of the function is :

procedure SetParamValue(i:Integer;Value:Double);
begin

end

It get the value of parameter number i needed by the simulation engine. For the first parameter i is equal to 0.

The GetParamDefault function

The syntax of the function is :

function GetParamDefaultValue(i:Integer):Double;
begin

end

It return the default value of parameter number i needed by the simulation engine. For the first parameter i is equal to 0.

See the plugins DC.dll and AC.dll as examples.

List of the components

Type number	Component	Parameters
4	Capacitor	Capacitance (Farads)
5	Resistor	Resistance (Ohms)
6	DC Source	Voltage (Volts)
7	Ground
8	Comment
9	AC Source 2 nodes (1 Phase)	Voltage (Volts) Phase (Degrees)
10	Inductor	Inductance (Henry)
11	Transformer	Ratio (No units)
12	Inductive line	Xd=Xi (MilliHenry) X0 (MilliHenry)
13	6 phases multipole	Resistance (Ohms) 6x6 table Inductance (Ohms) 6x6 table
14	12 phases multipole	Resistance (Ohms) 12x12 table Inductance (Ohms) 12x12 table
15	AC source 6 nodes (3 Phases)	Voltage (Volts) Phase (Degrees)
16	Fault	Resistance (Ohms) Fault present (No units) boolean
17	Impedance measure	K0 (No units)
18	3 phases impedance	Rd (Ohms) Xd (MilliHenry) Ri (Ohms) Xi (MilliHenry) R0 (Ohms) X0 (MilliHenry)
19	3 phase fault	R1 (Ohms) R2 (Ohms) R3 (Ohms) Rg (Ohms) Fault present (No units) boolean
20	Resistive line	Xd=Xi (MilliHenry) Rd=Ri (Ohms) X0 (MilliHenry) R0 (Ohms)
21	3 phases Transfer Function	Real part 6x6 table Complex part 6x6 table
22	N phases Transfer Function	Number of phases Real part NxN table Complex part NxN table
23	3 phase shift transformer	Angle (Degrees)
24	3 phases breaker	Open (No units) boolean
25	3 winding transformer	Ratio (No units)
26	Single phase shift transformer	Angle (Degrees)
27	3 phase shift transformer with impedances	Angle (Degrees) Rd (Ohms) Xd (MilliHenry) Ri (Ohms) Xi (MilliHenry) R01 (Ohms) X01 (MilliHenry) R02 (Ohms) X02 (MilliHenry) R03 (Ohms) X03 (MilliHenry)
28	Load	Active Power (W) Reactive Power (Var)
29	2 Nodes Line	Resistance (pu) Inductance (pu) Capacitance (pu)
30	1 Node Source	Voltage (pu) Phase (Degrees)

Add a new component

To add a new component in the interface, follow the steps :

Open the file CompoConst.lst. This file contains the list of all the component type constants. It is shared between the interface and the simulation engines thanks to the code line : {$I 'CompoConst.lst'}. Add a new component type to this list and increment the number of component NbComponents. The name od the new type must begin with nc.
Cut and paste one of the component and rename it.
Change the name of the component in all the WriteLog calls.
Change the size of the component Sx:=64; Sy:=16; in the Create (Sx=Width, Sy=Height).
Choose a new type and change the line SetType('xxxxxxx') in the Create function.
Change the number of nodes and their position in the Create. Be carefull of the order, it will be the same in the DC and AC simulation engines.
Choose a new generic name and change it in the GetGenericName function.
Change the drawing in the Create.
Change the parameters number, types, names and units in the Create.
If the drawing must change according to the parameters value, add this changes in the Update procedure.
Add the new component creation in the Image1MouseDown procedure.
Update the AllowedComponent procedure in the simulation engine that uses the component.
Add the new component creation in the Charger1Click procedure.
Write simulation part in the engines.

In the parameters, the tables sizes can be linked to an integer. You just have put the integer parameter number in parameter link value of the tables. This feature is used in the N phases Transfer Function.