EDU05D.DLL - Smarthome

EDU05D.DLL
Technical Guide
Introduction
General
The EDU05 USB tutor module has 8 digital input/output channels, five analog input channels and two PWM outputs.
There on the board is also 16 character LCD display.
All communication routines are contained in a Dynamic Link Library EDU05D.DLL.
In this manual we will describe each of these functions provided by the DLL in detail. Calling the functions exported by
the DLL, you can write custom Windows applications in Visual Basic or any other 32-bit Windows application
development tool that supports calls to a DLL.
A complete overview of the procedures and functions that are exported by the EDU05D.DLL follows.
Note that all the examples in the function description section are written in C++.
EDU05 examples folder includes examples written in Visual Basic 2008 Express, Visual C# 2008 Express and Visual
C++ 2008 Express.
Readers should have an understanding of the basic data types as well as basic knowledge of the Microsoft Windows
operating system.
Microsoft Visual Studio users please note: The EDU05D.DLL is a standard Windows DLL, you cannot reference it.
Calling convention
A calling convention is a scheme for how functions receive parameters from their caller and how they return a result.
Different programming languages use different calling conventions, so it is important to know which calling convention
is used by your programming language and which calling convention is used by the EDU05D.DLL.
The most common calling convention is the stdcall calling convention, and this is also the one we have used for our
DLL.
If you are using .NET (VB.NET or C#) you do not need to worry about this since the calling convention in .NET is also
stdcall. However if you are using C to import the functions provided by the DLL, you will need to pay special attention
to this.

Overview of the Functions
General functions
int OpenDevice()
void CloseDevice()
int Connected()
void InOutMode(int IOMode)
Opens the communication link to the EDU05 device
Closes the link to the EDU05 device
Checks that the USB connection to the card is valid
Set the digital terminals either inputs or outputs
Analog to Digital converter function
int ReadAnalogChannel(int Channel) Reads the status of one analog input-channel
PWM Output function
void SetPWM(int Channel, int Data) Sets the status the PWM output
Digital Output functions
void OutputAllDigital(int Data)
Sets the digital outputs according to the data
void ClearDigitalChannel(int Channel) Clears the output channel
void ClearAllDigital()
Clears all output channels
void SetDigitalChannel(int Channel) Sets the output channel
void SetAllDigital()
Sets all output channels
Digital Input functions
int ReadAllDigital()
Reads the status of all the input channels
LCD functions
void LCDInit()
Initializes the LCD display module
void LCDClear()
Clears the text on the LCD display
void void LCDWriteString(String^ Data, int Position);
Writes text on the LCD display

Function List
OpenDevice
Syntax
int OpenDevice();
Result
int: If succeeded the return value 1 indicates that EDU05 card was found.
Return value 0 indicates that no EDU05 card found.
Description
Opens the communication link to the EDU05 card. Loads the drivers needed to communicate via the USB port. This
procedure must be performed before any attempts to communicate with the EDU05 card.
Example
int h = OpenDevice();
switch (h)
{
case 0:
Label1->Text = "EDU05 not found";
break;
case 1:
Label1->Text = "EDU05 connected";
IOMode = 1;
InOutMode(IOMode);
RadioButton3->Checked = true;
Timer1->Enabled = true;
break;
}
CloseDevice
Syntax
void CloseDevice();
Description
Unloads the communication routines for EDU05 card and unloads the driver needed to communicate via the USB port.
This is the last action of the application program before termination.
Example
private: System::Void Form1_FormClosed(System::Object^ sender,
System::Windows::Forms::FormClosedEventArgs^ e)
{
CloseDevice();
}
ReadAnalogChannel
Syntax
int ReadAnalogChannel(int Channel);
Parameter
Channel: Value between 1 and 5 which corresponds to the AD channel whose status is to be read.
Result
int: The corresponding Analog to Digital Converter data is read.
Description
The input voltage of the selected 10-bit Analog to Digital converter channel is converted to a value which lies between
0 and 1023.

Example
int Buffer[5];
int i;
for (i=0; i

InOutMode(0);
ClearAllDigital(CardAddress);
SetDigitalChannel
Syntax
void SetDigitalChannel(int Channel);
Parameter
Channel: Value between 1 and 8 which corresponds to the output channel that is to be set.
Description
The selected digital output channel is set.
Example
if (CheckBox3->Checked)
SetDigitalChannel(3);
else
ClearDigitalChannel(3);
SetAllDigital
Syntax
void SetAllDigital();
Description
All the digital output channels are set.
Example
InOutMode(0);
SetAllDigital(CardAddress);
SetPWM
Syntax
void SetPWM(int Channel, int Data);
Parameters
Channel: The PWM output channel 1 or 2.
Data: Value between 0 and 255 which is to be sent to the PWM output of the card. The duty cycle of the PWM output
corresponds to the data value: 0 = 0%, 255 = 100% duty cycle.
Example
SetPWM(1, 128); // The duty cycle of the PWM output #1 is set to 50%
Connected
Syntax
bool Connected();
Result
bool: true if the card is connected, false if not connected.
Description
Checks that USB connection to the cards is valid.
Example
if (Connected())
Label1->Text = "EDU05 connected";
else

Label1->Text = "EDU05 not connected";
LCDInit
Syntax
void LCDInit();
Description
Initializes the LCD display module.
Example
InOutMode(0);
LCDInit();
LCDClear
Syntax
void LCDClear();
Description
Clears the LCD display.
Example
InOutMode(0);
LCDClear();
LCDWriteString
Syntax
void LCDWriteString(String^ Data, int Position);
Parameters
Data: Pointer to the text string.
Position: Text position (0...15) on the LCD display.
Example
InOutMode(0);
LCDWriteString(textBox1->Text,Convert::ToInt32(textBox2->Text));

Function declarations in other programming languages
Visual Basic 2008 Express
Private Declare Function OpenDevice Lib "edu05d.dll" () As Integer
Private Declare Sub CloseDevice Lib "edu05d.dll" ()
Private Declare Function Connected Lib "edu05d.dll" () As Boolean
Private Declare Function ReadAnalogChannel Lib "edu05d.dll" (ByVal Channel As Integer) As Integer
Private Declare Function ReadAllDigital Lib "edu05d.dll" () As Integer
Private Declare Sub SetPWM Lib "edu05d.dll" (ByVal Channel As Integer, ByVal Data As Integer)
Private Declare Sub InOutMode Lib "edu05d.dll" (ByVal IOMode As Integer)
Private Declare Sub OutputAllDigital Lib "edu05d.dll" (ByVal Data As Integer)
Private Declare Sub ClearAllDigital Lib "edu05d.dll" ()
Private Declare Sub SetAllDigital Lib "edu05d.dll" ()
Private Declare Sub ClearDigitalChannel Lib "edu05d.dll" (ByVal Channel As Integer)
Private Declare Sub SetDigitalChannel Lib "edu05d.dll" (ByVal Channel As Integer)
Private Declare Sub LCDInit Lib "edu05d.dll" ()
Private Declare Sub LCDClear Lib "edu05d.dll" ()
Private Declare Sub LCDWriteString Lib "edu05d.dll" (ByVal Data As String, ByVal Position As Integer)
Visual C# 2008 Express
[DllImport("edu05d.dll")]
public static extern int OpenDevice();
[DllImport("edu05d.dll")]
public static extern void CloseDevice();
[DllImport("edu05d.dll")]
public static extern bool Connected();
[DllImport("edu05d.dll")]
public static extern int ReadAnalogChannel(int Channel);
[DllImport("edu05d.dll")]
public static extern int ReadAllDigital();
[DllImport("edu05d.dll")]
public static extern void SetPWM(int Channel, int Data);
[DllImport("edu05d.dll")]
public static extern void InOutMode(int IOMode);
[DllImport("edu05d.dll")]
public static extern void OutputAllDigital(int Data);
[DllImport("edu05d.dll")]
public static extern void ClearAllDigital();
[DllImport("edu05d.dll")]
public static extern void SetAllDigital();
[DllImport("edu05d.dll")]
public static extern void ClearDigitalChannel(int Channel);
[DllImport("edu05d.dll")]
public static extern void SetDigitalChannel(int Channel);
[DllImport("edu05d.dll")]
public static extern void LCDInit();
[DllImport("edu05d.dll")]
public static extern void LCDClear();
[DllImport("edu05d.dll")]
public static extern void LCDWriteString(string Data, int Position);