PRODUCTS
 

Main Page   Data Structures   File List   Data Fields   Globals  

TeleoEasy.h File Reference

Sets up the Teleo SDK and provides a TeleoDeviceManager. More...

#include "TeleoInterface.h"
#include "TeleoDeviceManager.h"

Go to the source code of this file.

Functions

TeleoError TeleoEasy_Init (cchar *interfaceName, TI_InterfaceType interfaceTypeId, TeleoDeviceManager **tdm)
 Initializes the system.

TeleoError TeleoEasy_destroy ()
TeleoError TeleoEasy_InterfaceAdd (cchar *interfaceName, TI_InterfaceType interfaceTypeId)
 Adds additional interfaces.

TeleoModuleManager * TeleoEasy_TeleoModuleManagerGet ()
 Returns the Module Manager in case any lower level calls need to be made.

void TeleoEasy_Start ()
 Starts the system.

void TeleoEasy_Continue ()
 Waits for the library to exit.

void TeleoEasy_Lock ()
 Locks access to the library.

void TeleoEasy_Unlock ()
 Unlocks access to the library.

Detailed Description

Sets up the Teleo SDK and provides a TeleoDeviceManager.

Provides functions for the connection of all the layers of the SDK. Used in several example apps.

Designed to be linked with the version of TeleoEasyXXX.c that is appropriate for the target OS.

Provides a TeleoDeviceManager* from which it is possible to create devices, or device proxies.

Note that code called in callbacks from the lower system levels will have been initiated in one of either the timer or input threads which are (conservatively) protected by mutex locks.

Code called from the main program thread is not thread safe, so all calls into the Teleo SDK should be protected with TeleoEasy_LibraryLock( ) / Unlock( ) calls.

Definition in file TeleoEasy.h.

Function Documentation

void TeleoEasy_Continue (    ) 
 

Waits for the library to exit.

Definition at line 146 of file TeleoEasyLinux.c.

TeleoError TeleoEasy_destroy (    ) 
 

Definition at line 110 of file TeleoEasyWin32.c.

References running, TC_destroy(), TDM_destroy(), TELEO_OK, TeleoEasy_Continue(), TeleoError, TI_destroy(), and TMM_destroy().

TeleoError TeleoEasy_Init (  cchar *    interfaceName,
TI_InterfaceType    interfaceTypeId,
TeleoDeviceManager **    tdm
) 
 

Initializes the system.

Parameters:
interfaceName the device name - can be NULL for default
interfaceTypeId the interface type (i.e. TI_USB, TI_SERIAL, etc.)
tdm the Device Manager return value
Returns:
TELEO_OK (0) or appropriate error

Definition at line 61 of file TeleoEasyLinux.c.

References cchar, running, TC_channelNameSet(), TC_Create(), TC_dummySend(), TC_outputCallbackSet(), TC_sendQueueEnable(), TDM_Create(), TDM_moduleManagerSet(), TELEO_OK, teleoDeviceManager, TeleoError, TI_blockingSet(), TI_Create(), TI_open(), TI_typeGet(), TMM_channelAdd(), and TMM_Create().

Referenced by main().

TeleoError TeleoEasy_InterfaceAdd (  cchar *    interfaceName,
TI_InterfaceType    interfaceTypeId
) 
 

Adds additional interfaces.

Parameters:
interfaceName the device name - can be NULL for default
interfaceTypeId the interface type (i.e. TI_USB, TI_SERIAL, etc.)

Definition at line 123 of file TeleoEasyLinux.c.

References TELEO_E_UNIMPLEMENTED, and TeleoError.

void TeleoEasy_Lock (    ) 
 

Locks access to the library.

Definition at line 187 of file TeleoEasyLinux.c.

void TeleoEasy_Start (    ) 
 

Starts the system.

Definition at line 134 of file TeleoEasyLinux.c.

References running, TELEO_INPUT_THREAD, TELEO_TIMER_THREAD, and teleoThreads.

TeleoModuleManager* TeleoEasy_TeleoModuleManagerGet (    ) 
 

Returns the Module Manager in case any lower level calls need to be made.

Definition at line 129 of file TeleoEasyLinux.c.

References teleoModuleManager.

void TeleoEasy_Unlock (    ) 
 

Unlocks access to the library.

Definition at line 192 of file TeleoEasyLinux.c.

 

copyright © 2002, 2003 MakingThings LLC