appl.h File Reference


Detailed Description

This file includes the eWicht application module API.

Software License
See the MBCSL for details.
Author:
Sven Schlender (kontakt at mobacon dot de)
Date:
2009-04-30

Definition in file appl.h.

Go to the source code of this file.

Data Structures

struct  SPAPPLDATA
 This typedef defines the peristent structure for common application settings. More...

Defines

#define TOGGLEDIRMODE_CLICK   FALSE
 Loco direction changes on encoder button click.
#define TOGGLEDIRMODE_ZERO   TRUE
 Loco direction automatically changes on crossing the zero mark.

Enumerations

enum  _SEARCH_MODES { SEARCH_UNKNOWN = 0, SEARCH_IP, SEARCH_NAME, SEARCH_SERVICE }
 This typedef defines the different ways to find and connect a server. More...

Functions

void ApplInit (void)
 Call this function to initialize the application module.
void ApplMain (void)
 Call this function periodically to execute the application module.
IP_ADDR * ApplGetServerIP (void)
 Call this function to determine the IP address of the configured server for this device.
NODE_INFOApplGetServerNodeInfo (void)
 Call this function to determine the node info (MAC and IP address) of the configured server for this device.
WORD_VAL ApplGetServerPort (void)
 Call this function to determine the port (TCP/UDP) of the configured server for this device.
BOOL ApplIsConnected (void)
 This proxy function delivers the connect state of the current project.
void ApplResetToFactory (BOOL KeepBootup)
 This function restores the EEPROM content to a well known state.
void ApplShutDown (void)
 The function initiates the shut down sequence while the application is still running.
BOOL ApplIsRunning (void)
 The function is the indicator for the running application.
void ApplStop (void)
 This function finally stops the application, i.e.
void ApplChangeLocoDirMode (BOOL Mode)
 Call this function to change the current mode for changing the direction of a controlled loco.
void ApplRestart (BOOL ResetToFactory)
 This function initiate a restart of the device.

Variables

SPAPPLDATA sPApplConfig
 The persistent data field for common application data.
BYTE u8ApplTimer
 The application timer runs backwards in units of 10 ms if different from zero.


Generated on Sun Nov 27 20:02:39 2011 for eWicht by  doxygen 1.5.5